# affinidi_tdk_wallets_client
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
For more information, please visit [https://github.com/affinidi/affinidi-tdk](https://github.com/affinidi/affinidi-tdk)
Documentation is available at [https://docs.affinidi.com/dev-tools/affinidi-tdk/clients/wallets](https://docs.affinidi.com/dev-tools/affinidi-tdk/clients/wallets)
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install affinidi_tdk_wallets_client
```
Then import the package:
```python
import affinidi_tdk_wallets_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
Then import the package:
```python
import affinidi_tdk_wallets_client
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
import affinidi_tdk_wallets_client
from affinidi_tdk_wallets_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://apse1.api.affinidi.io/cwe
# See configuration.py for a list of all supported configuration parameters.
configuration = affinidi_tdk_wallets_client.Configuration(
host = "https://apse1.api.affinidi.io/cwe"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ProjectTokenAuth
configuration.api_key['ProjectTokenAuth'] = os.environ["API_KEY"]
# Configure a hook to auto-refresh API key for your personal access token (PAT), if expired
import affinidi_tdk_auth_provider
stats = {
apiGatewayUrl,
keyId,
passphrase,
privateKey,
projectId,
tokenEndpoint,
tokenId,
}
authProvider = affinidi_tdk_auth_provider.AuthProvider(stats)
configuration.refresh_api_key_hook = lambda api_client: authProvider.fetch_project_scoped_token()
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ProjectTokenAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with affinidi_tdk_wallets_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = affinidi_tdk_wallets_client.RevocationApi(api_client)
project_id = 'project_id_example' # str | Description for projectId.
wallet_id = 'wallet_id_example' # str | Description for walletId.
status_id = 'status_id_example' # str | Description for statusId.
try:
api_response = api_instance.get_revocation_credential_status(project_id, wallet_id, status_id)
print("The response of RevocationApi->get_revocation_credential_status:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling RevocationApi->get_revocation_credential_status: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://apse1.api.affinidi.io/cwe*
| Class | Method | HTTP request | Description |
| --------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------- |
| _RevocationApi_ | [**get_revocation_credential_status**](docs/RevocationApi.md#get_revocation_credential_status) | **GET** /v1/projects/{projectId}/wallets/{walletId}/revocation-statuses/{statusId} |
| _RevocationApi_ | [**get_revocation_list_credential**](docs/RevocationApi.md#get_revocation_list_credential) | **GET** /v1/wallets/{walletId}/revocation-list/{listId} | Return revocation list credential. |
| _RevocationApi_ | [**revoke_credential**](docs/RevocationApi.md#revoke_credential) | **POST** /v1/wallets/{walletId}/revoke | Revoke Credential. |
| _WalletApi_ | [**create_wallet**](docs/WalletApi.md#create_wallet) | **POST** /v1/wallets |
| _WalletApi_ | [**delete_wallet**](docs/WalletApi.md#delete_wallet) | **DELETE** /v1/wallets/{walletId} |
| _WalletApi_ | [**get_wallet**](docs/WalletApi.md#get_wallet) | **GET** /v1/wallets/{walletId} |
| _WalletApi_ | [**list_wallets**](docs/WalletApi.md#list_wallets) | **GET** /v1/wallets |
| _WalletApi_ | [**sign_credential**](docs/WalletApi.md#sign_credential) | **POST** /v1/wallets/{walletId}/sign-credential |
| _WalletApi_ | [**sign_jwt_token**](docs/WalletApi.md#sign_jwt_token) | **POST** /v1/wallets/{walletId}/sign-jwt |
| _WalletApi_ | [**update_wallet**](docs/WalletApi.md#update_wallet) | **PATCH** /v1/wallets/{walletId} |
## Documentation For Models
- [CreateWalletInput](docs/CreateWalletInput.md)
- [CreateWalletResponse](docs/CreateWalletResponse.md)
- [DidKeyInputParams](docs/DidKeyInputParams.md)
- [DidWebInputParams](docs/DidWebInputParams.md)
- [EntityNotFoundError](docs/EntityNotFoundError.md)
- [GetRevocationCredentialStatusOK](docs/GetRevocationCredentialStatusOK.md)
- [GetRevocationListCredentialResultDto](docs/GetRevocationListCredentialResultDto.md)
- [InvalidDidParameterError](docs/InvalidDidParameterError.md)
- [InvalidParameterError](docs/InvalidParameterError.md)
- [KeyNotFoundError](docs/KeyNotFoundError.md)
- [NotFoundError](docs/NotFoundError.md)
- [OperationForbiddenError](docs/OperationForbiddenError.md)
- [RevokeCredentialInput](docs/RevokeCredentialInput.md)
- [ServiceErrorResponse](docs/ServiceErrorResponse.md)
- [ServiceErrorResponseDetailsInner](docs/ServiceErrorResponseDetailsInner.md)
- [SignCredential400Response](docs/SignCredential400Response.md)
- [SignCredentialInputDto](docs/SignCredentialInputDto.md)
- [SignCredentialInputDtoUnsignedCredentialParams](docs/SignCredentialInputDtoUnsignedCredentialParams.md)
- [SignCredentialResultDto](docs/SignCredentialResultDto.md)
- [SignCredentialResultDtoSignedCredential](docs/SignCredentialResultDtoSignedCredential.md)
- [SignJwtToken](docs/SignJwtToken.md)
- [SignJwtTokenOK](docs/SignJwtTokenOK.md)
- [SigningFailedError](docs/SigningFailedError.md)
- [UpdateWalletInput](docs/UpdateWalletInput.md)
- [WalletDto](docs/WalletDto.md)
- [WalletDtoKeysInner](docs/WalletDtoKeysInner.md)
- [WalletsListDto](docs/WalletsListDto.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="ProjectTokenAuth"></a>
### ProjectTokenAuth
- **Type**: API key
- **API key parameter name**: authorization
- **Location**: HTTP header
## Author
info@affinidi.com
Raw data
{
"_id": null,
"home_page": "https://github.com/affinidi/affinidi-tdk",
"name": "affinidi_tdk_wallets_client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, CloudWalletEssentials",
"author": "Affinidi",
"author_email": "info@affinidi.com",
"download_url": "https://files.pythonhosted.org/packages/41/a4/28eb315c63562559d1cf03521a3d799290332de8f5a613d7fcfd87a66f05/affinidi_tdk_wallets_client-1.33.0.tar.gz",
"platform": null,
"description": "# affinidi_tdk_wallets_client\n\nNo description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)\n\nFor more information, please visit [https://github.com/affinidi/affinidi-tdk](https://github.com/affinidi/affinidi-tdk)\n\nDocumentation is available at [https://docs.affinidi.com/dev-tools/affinidi-tdk/clients/wallets](https://docs.affinidi.com/dev-tools/affinidi-tdk/clients/wallets)\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install affinidi_tdk_wallets_client\n```\n\nThen import the package:\n\n```python\nimport affinidi_tdk_wallets_client\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n\nThen import the package:\n\n```python\nimport affinidi_tdk_wallets_client\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport affinidi_tdk_wallets_client\nfrom affinidi_tdk_wallets_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://apse1.api.affinidi.io/cwe\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = affinidi_tdk_wallets_client.Configuration(\n host = \"https://apse1.api.affinidi.io/cwe\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure API key authorization: ProjectTokenAuth\nconfiguration.api_key['ProjectTokenAuth'] = os.environ[\"API_KEY\"]\n\n# Configure a hook to auto-refresh API key for your personal access token (PAT), if expired\nimport affinidi_tdk_auth_provider\n\nstats = {\n apiGatewayUrl,\n keyId,\n passphrase,\n privateKey,\n projectId,\n tokenEndpoint,\n tokenId,\n}\nauthProvider = affinidi_tdk_auth_provider.AuthProvider(stats)\nconfiguration.refresh_api_key_hook = lambda api_client: authProvider.fetch_project_scoped_token()\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['ProjectTokenAuth'] = 'Bearer'\n\n\n# Enter a context with an instance of the API client\nwith affinidi_tdk_wallets_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = affinidi_tdk_wallets_client.RevocationApi(api_client)\n project_id = 'project_id_example' # str | Description for projectId.\n wallet_id = 'wallet_id_example' # str | Description for walletId.\n status_id = 'status_id_example' # str | Description for statusId.\n\n try:\n api_response = api_instance.get_revocation_credential_status(project_id, wallet_id, status_id)\n print(\"The response of RevocationApi->get_revocation_credential_status:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling RevocationApi->get_revocation_credential_status: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://apse1.api.affinidi.io/cwe*\n\n| Class | Method | HTTP request | Description |\n| --------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------- |\n| _RevocationApi_ | [**get_revocation_credential_status**](docs/RevocationApi.md#get_revocation_credential_status) | **GET** /v1/projects/{projectId}/wallets/{walletId}/revocation-statuses/{statusId} |\n| _RevocationApi_ | [**get_revocation_list_credential**](docs/RevocationApi.md#get_revocation_list_credential) | **GET** /v1/wallets/{walletId}/revocation-list/{listId} | Return revocation list credential. |\n| _RevocationApi_ | [**revoke_credential**](docs/RevocationApi.md#revoke_credential) | **POST** /v1/wallets/{walletId}/revoke | Revoke Credential. |\n| _WalletApi_ | [**create_wallet**](docs/WalletApi.md#create_wallet) | **POST** /v1/wallets |\n| _WalletApi_ | [**delete_wallet**](docs/WalletApi.md#delete_wallet) | **DELETE** /v1/wallets/{walletId} |\n| _WalletApi_ | [**get_wallet**](docs/WalletApi.md#get_wallet) | **GET** /v1/wallets/{walletId} |\n| _WalletApi_ | [**list_wallets**](docs/WalletApi.md#list_wallets) | **GET** /v1/wallets |\n| _WalletApi_ | [**sign_credential**](docs/WalletApi.md#sign_credential) | **POST** /v1/wallets/{walletId}/sign-credential |\n| _WalletApi_ | [**sign_jwt_token**](docs/WalletApi.md#sign_jwt_token) | **POST** /v1/wallets/{walletId}/sign-jwt |\n| _WalletApi_ | [**update_wallet**](docs/WalletApi.md#update_wallet) | **PATCH** /v1/wallets/{walletId} |\n\n## Documentation For Models\n\n- [CreateWalletInput](docs/CreateWalletInput.md)\n- [CreateWalletResponse](docs/CreateWalletResponse.md)\n- [DidKeyInputParams](docs/DidKeyInputParams.md)\n- [DidWebInputParams](docs/DidWebInputParams.md)\n- [EntityNotFoundError](docs/EntityNotFoundError.md)\n- [GetRevocationCredentialStatusOK](docs/GetRevocationCredentialStatusOK.md)\n- [GetRevocationListCredentialResultDto](docs/GetRevocationListCredentialResultDto.md)\n- [InvalidDidParameterError](docs/InvalidDidParameterError.md)\n- [InvalidParameterError](docs/InvalidParameterError.md)\n- [KeyNotFoundError](docs/KeyNotFoundError.md)\n- [NotFoundError](docs/NotFoundError.md)\n- [OperationForbiddenError](docs/OperationForbiddenError.md)\n- [RevokeCredentialInput](docs/RevokeCredentialInput.md)\n- [ServiceErrorResponse](docs/ServiceErrorResponse.md)\n- [ServiceErrorResponseDetailsInner](docs/ServiceErrorResponseDetailsInner.md)\n- [SignCredential400Response](docs/SignCredential400Response.md)\n- [SignCredentialInputDto](docs/SignCredentialInputDto.md)\n- [SignCredentialInputDtoUnsignedCredentialParams](docs/SignCredentialInputDtoUnsignedCredentialParams.md)\n- [SignCredentialResultDto](docs/SignCredentialResultDto.md)\n- [SignCredentialResultDtoSignedCredential](docs/SignCredentialResultDtoSignedCredential.md)\n- [SignJwtToken](docs/SignJwtToken.md)\n- [SignJwtTokenOK](docs/SignJwtTokenOK.md)\n- [SigningFailedError](docs/SigningFailedError.md)\n- [UpdateWalletInput](docs/UpdateWalletInput.md)\n- [WalletDto](docs/WalletDto.md)\n- [WalletDtoKeysInner](docs/WalletDtoKeysInner.md)\n- [WalletsListDto](docs/WalletsListDto.md)\n\n<a id=\"documentation-for-authorization\"></a>\n\n## Documentation For Authorization\n\nAuthentication schemes defined for the API:\n<a id=\"ProjectTokenAuth\"></a>\n\n### ProjectTokenAuth\n\n- **Type**: API key\n- **API key parameter name**: authorization\n- **Location**: HTTP header\n\n## Author\n\ninfo@affinidi.com\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "CloudWalletEssentials",
"version": "1.33.0",
"project_urls": {
"Homepage": "https://github.com/affinidi/affinidi-tdk",
"Repository": "https://github.com/affinidi/affinidi-tdk"
},
"split_keywords": [
"openapi",
" openapi-generator",
" cloudwalletessentials"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e38c6250a86189a165495aa42fa37efec1f096bd22ac52562a4b914c1f4218b7",
"md5": "a0a5fa5313cc37f455a2634e2dd7ef06",
"sha256": "86a99162a67fbca1220ecc26837f2fdaf8b37bbac133378e9b9724369f371d22"
},
"downloads": -1,
"filename": "affinidi_tdk_wallets_client-1.33.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a0a5fa5313cc37f455a2634e2dd7ef06",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 66928,
"upload_time": "2024-12-18T08:51:55",
"upload_time_iso_8601": "2024-12-18T08:51:55.465569Z",
"url": "https://files.pythonhosted.org/packages/e3/8c/6250a86189a165495aa42fa37efec1f096bd22ac52562a4b914c1f4218b7/affinidi_tdk_wallets_client-1.33.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "41a428eb315c63562559d1cf03521a3d799290332de8f5a613d7fcfd87a66f05",
"md5": "b5d99c194548691f51798f0a6cd4e55f",
"sha256": "385e5ac97a3234bf49276e14ebfa72cd8e49141738f36c2de3ca7232db158076"
},
"downloads": -1,
"filename": "affinidi_tdk_wallets_client-1.33.0.tar.gz",
"has_sig": false,
"md5_digest": "b5d99c194548691f51798f0a6cd4e55f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 31798,
"upload_time": "2024-12-18T08:51:57",
"upload_time_iso_8601": "2024-12-18T08:51:57.857162Z",
"url": "https://files.pythonhosted.org/packages/41/a4/28eb315c63562559d1cf03521a3d799290332de8f5a613d7fcfd87a66f05/affinidi_tdk_wallets_client-1.33.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 08:51:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "affinidi",
"github_project": "affinidi-tdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "affinidi_tdk_wallets_client"
}
JSON
