| Name | uma-auth-api JSON |
| Version |
0.0.10
JSON |
| download |
| home_page | None |
| Summary | This API allows you to authenticate with the UMA server to take actions on a user's wallet. It's the exposed communication layer between the NWC server and the main UMA server. |
| upload_time | 2024-09-26 07:37:27 |
| maintainer | None |
| docs_url | None |
| author | Lightspark Group, Inc. |
| requires_python | None |
| license | Apache-2.0 |
| keywords |
openapi
uma
auth
api
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# UMA Auth OpenAPI-generated Python Pydantic Models
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.1
- Generator version: 7.7.0
- Build package: org.openapitools.codegen.languages.PythonFastAPIServerCodegen
## Requirements
Python >= 3.7
## Installation & Usage
To install the library, simply run:
```bash
pip install uma-auth-api
```
When handling a request, you can do something like:
```python
from uma_auth.models.pay_invoice_request import PayInvoiceRequest
from uma_auth.models.pay_invoice_response import PayInvoiceResponse
def handle_pay_invoice():
try:
request_data = PayInvoiceRequest.from_dict(request.get_json())
except Exception as e:
abort_with_error(400, f"Invalid request: {e}")
invoice = request_data.invoice
amount = request_data.amount
# ... actually pay the invoice ...
return PayInvoiceResponse(preimage=payment_result.preimage).to_dict()
```
Note that this library only contains request and response model types to help with type safety and encoding/decoding of requests and responses.
If you want something more custom for a specific API framework, you can generate your own code using the
[OpenAPI Generator CLI](https://openapi-generator.tech/docs/generators). There are generators for the following server frameworks:
- [aiohttp](https://openapi-generator.tech/docs/generators/python-aiohttp)
- [blueplanet](https://openapi-generator.tech/docs/generators/python-blueplanet)
- [fastapi](https://openapi-generator.tech/docs/generators/python-fastapi)
- [flask](https://openapi-generator.tech/docs/generators/python-flask)
Raw data
{
"_id": null,
"home_page": null,
"name": "uma-auth-api",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "OpenAPI UMA Auth API",
"author": "Lightspark Group, Inc.",
"author_email": "info@lightspark.com",
"download_url": "https://files.pythonhosted.org/packages/bd/6f/35bb82de62a600bcabf11b7f102839b0f21f93ad82b743b6a763ca3aed38/uma_auth_api-0.0.10.tar.gz",
"platform": null,
"description": "# UMA Auth OpenAPI-generated Python Pydantic Models\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.1\n- Generator version: 7.7.0\n- Build package: org.openapitools.codegen.languages.PythonFastAPIServerCodegen\n\n## Requirements\n\nPython >= 3.7\n\n## Installation & Usage\n\nTo install the library, simply run:\n\n```bash\npip install uma-auth-api\n```\n\nWhen handling a request, you can do something like:\n\n```python\nfrom uma_auth.models.pay_invoice_request import PayInvoiceRequest\nfrom uma_auth.models.pay_invoice_response import PayInvoiceResponse\n\ndef handle_pay_invoice():\n try:\n request_data = PayInvoiceRequest.from_dict(request.get_json())\n except Exception as e:\n abort_with_error(400, f\"Invalid request: {e}\")\n\n invoice = request_data.invoice\n amount = request_data.amount\n\n # ... actually pay the invoice ...\n\n return PayInvoiceResponse(preimage=payment_result.preimage).to_dict()\n```\n\nNote that this library only contains request and response model types to help with type safety and encoding/decoding of requests and responses.\nIf you want something more custom for a specific API framework, you can generate your own code using the\n[OpenAPI Generator CLI](https://openapi-generator.tech/docs/generators). There are generators for the following server frameworks:\n\n- [aiohttp](https://openapi-generator.tech/docs/generators/python-aiohttp)\n- [blueplanet](https://openapi-generator.tech/docs/generators/python-blueplanet)\n- [fastapi](https://openapi-generator.tech/docs/generators/python-fastapi)\n- [flask](https://openapi-generator.tech/docs/generators/python-flask)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "This API allows you to authenticate with the UMA server to take actions on a user's wallet. It's the exposed communication layer between the NWC server and the main UMA server.",
"version": "0.0.10",
"project_urls": {
"Documentation": "https://docs.uma.me/",
"Source Code": "https://github.com/uma-universal-money-address/uma-auth-api/"
},
"split_keywords": [
"openapi",
"uma",
"auth",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "02c35c65532840a5484d20ed897bd8136ec08314508f97cfe5792144f5d69c48",
"md5": "4d9d248135fa622b8f501a6a516ea5a6",
"sha256": "0fae8f7327a77b9d5e663a1460893e41d60bf358a1763c0fd1bc36f067770344"
},
"downloads": -1,
"filename": "uma_auth_api-0.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4d9d248135fa622b8f501a6a516ea5a6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 45001,
"upload_time": "2024-09-26T07:37:26",
"upload_time_iso_8601": "2024-09-26T07:37:26.508315Z",
"url": "https://files.pythonhosted.org/packages/02/c3/5c65532840a5484d20ed897bd8136ec08314508f97cfe5792144f5d69c48/uma_auth_api-0.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bd6f35bb82de62a600bcabf11b7f102839b0f21f93ad82b743b6a763ca3aed38",
"md5": "335b823a5ba4bcc07c34fc481e8597e2",
"sha256": "2ac1c51df5e95c72369df7d779703ce0bd9c83b81a436b020d473771718e8c26"
},
"downloads": -1,
"filename": "uma_auth_api-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "335b823a5ba4bcc07c34fc481e8597e2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 19914,
"upload_time": "2024-09-26T07:37:27",
"upload_time_iso_8601": "2024-09-26T07:37:27.803283Z",
"url": "https://files.pythonhosted.org/packages/bd/6f/35bb82de62a600bcabf11b7f102839b0f21f93ad82b743b6a763ca3aed38/uma_auth_api-0.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-26 07:37:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "uma-universal-money-address",
"github_project": "uma-auth-api",
"github_not_found": true,
"lcname": "uma-auth-api"
}
