affinidi_tdk_wallets_client 1.61.0
CloudWalletEssentials
License: Apache-2.0
Requires Python: <4.0,>=3.8
Keywords: OpenAPI, OpenAPI-Generator, CloudWalletEssentials

# affinidi_tdk_wallets_client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

For more information, please visit [https://www.affinidi.com](https://www.affinidi.com)

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.                 |
| _RevocationApi_ | [**revoke_credentials**](docs/RevocationApi.md#revoke_credentials)                             | **POST** /v2/wallets/{walletId}/credentials/revoke                                 | Revoke Credentials.                |
| _WalletApi_     | [**create_wallet**](docs/WalletApi.md#create_wallet)                                           | **POST** /v1/wallets                                                               |
| _WalletApi_     | [**create_wallet_v2**](docs/WalletApi.md#create_wallet_v2)                                     | **POST** /v2/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_credentials_jwt**](docs/WalletApi.md#sign_credentials_jwt)                             | **POST** /v2/wallets/{walletId}/credentials/jwt/sign                               |
| _WalletApi_     | [**sign_credentials_ldp**](docs/WalletApi.md#sign_credentials_ldp)                             | **POST** /v2/wallets/{walletId}/credentials/ldp/sign                               |
| _WalletApi_     | [**sign_credentials_sd_jwt**](docs/WalletApi.md#sign_credentials_sd_jwt)                       | **POST** /v2/wallets/{walletId}/credentials/sd-jwt/sign                            |
| _WalletApi_     | [**sign_jwt_token**](docs/WalletApi.md#sign_jwt_token)                                         | **POST** /v1/wallets/{walletId}/sign-jwt                                           |
| _WalletApi_     | [**sign_presentations_ldp**](docs/WalletApi.md#sign_presentations_ldp)                         | **POST** /v2/wallets/{walletId}/presentations/ldp/sign                             |
| _WalletApi_     | [**update_wallet**](docs/WalletApi.md#update_wallet)                                           | **PATCH** /v1/wallets/{walletId}                                                   |

## Documentation For Models

- [AuthcryptMessageInput](docs/AuthcryptMessageInput.md)
- [AuthcryptMessageResultDto](docs/AuthcryptMessageResultDto.md)
- [CreateWalletInput](docs/CreateWalletInput.md)
- [CreateWalletResponse](docs/CreateWalletResponse.md)
- [CreateWalletV2Input](docs/CreateWalletV2Input.md)
- [CreateWalletV2Response](docs/CreateWalletV2Response.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)
- [RevokeCredentialsInput](docs/RevokeCredentialsInput.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)
- [SignCredentialsDm1LdInputDto](docs/SignCredentialsDm1LdInputDto.md)
- [SignCredentialsDm1LdResultDto](docs/SignCredentialsDm1LdResultDto.md)
- [SignCredentialsDm2SdJwtInputDto](docs/SignCredentialsDm2SdJwtInputDto.md)
- [SignCredentialsDm2SdJwtResultDto](docs/SignCredentialsDm2SdJwtResultDto.md)
- [SignCredentialsJwtInputDto](docs/SignCredentialsJwtInputDto.md)
- [SignCredentialsJwtResultDto](docs/SignCredentialsJwtResultDto.md)
- [SignCredentialsLdpInputDto](docs/SignCredentialsLdpInputDto.md)
- [SignCredentialsLdpResultDto](docs/SignCredentialsLdpResultDto.md)
- [SignJwtToken](docs/SignJwtToken.md)
- [SignJwtTokenOK](docs/SignJwtTokenOK.md)
- [SignMessageInput](docs/SignMessageInput.md)
- [SignMessageResultDto](docs/SignMessageResultDto.md)
- [SignPresentationLdpInputDto](docs/SignPresentationLdpInputDto.md)
- [SignPresentationLdpResultDto](docs/SignPresentationLdpResultDto.md)
- [SigningFailedError](docs/SigningFailedError.md)
- [TooManyRequestsError](docs/TooManyRequestsError.md)
- [UnpackMessageInput](docs/UnpackMessageInput.md)
- [UnpackMessageResultDto](docs/UnpackMessageResultDto.md)
- [UpdateWalletInput](docs/UpdateWalletInput.md)
- [WalletDto](docs/WalletDto.md)
- [WalletDtoKeysInner](docs/WalletDtoKeysInner.md)
- [WalletV2Dto](docs/WalletV2Dto.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