✨ Upgrade to ACA-Py 0.10.1 (#127)

* version bump

* generate client for 0.10.1

* 🎨 remove workaround for faulty revocation response

* ✨ new field for presentation models: auto_remove

* ✨ new model: V10PresentationSendRequest

* ✨ new model: V10CredentialExchangeAutoRemoveRequest

* ✨ new model: DIDXRejectRequest

* ✨ new model: ConfigurableWriteLedgers

* 🚚 model renamed

* ✨ empty ServiceDecorator fixed in aca-py PR 2362

* expanded regex validation for DIDXRequest did field

* adds new models

* ✨ new field in `accept_request`: use_public_did

* ✨ new method: post didexchange_conn_id_reject with DIDXRejectRequest

* ✨ new body in send_request: V10CredentialExchangeAutoRemoveRequest

* 💥 renamed return type (`WriteLedgerRequest` -> `WriteLedger`) and renamed ledger methods: removed `multiple` from names

* ✨ new method in ledgerApi: `Fetch list of available write ledgers` and `Set write ledger`

* 💥 renamed model in send_presentation: `IndyPresSpec` to `V10PresentationSendRequest`

* latest version 0.10.1

* 🐛 OobRecord can still return a ServiceDecorator with missing fields 🤷‍♂️

* version bump

* 🎨 Update README

* 🎨 Update example

* 🎨

* 🎨

* 🎨

* 🔥

* Set version to 0.10.1-rc0

* 🎨

* ⚡ Remove `@validate_call` decorator - fixes memory leak! At the cost of validation

* 0.10.1-rc1

* 0.10.1-beta2

* v0.10.1

* 🎨 Update README

Author: ff137

.coverage

@@ -1,4 +1,4 @@
-## How to contribute
+# How to Contribute
 
 You are encouraged to contribute to the repository by **forking the repo, making your changes and then submitting a pull request back to this repo**.
 

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-                  Apache License
+                                Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
 

LICENSE

@@ -6,15 +6,11 @@
     height="250px"
   />
 </p>
-<h1 align="center"><b>Aries Cloud Controller Python</b></h1>
+<h1 align="center"><b>Aries CloudController Python</b></h1>
 <p align="center">
-  <img
-    alt="Pipeline Status"
-    src="https://github.com/didx-xyz/aries-cloudcontroller-python/actions/workflows/python-publish.yml/badge.svg?branch=main"
-  />
-        <a href="https://pypi.org/project/aries-cloudcontroller/">
-        <img alt="aries-cloudcontroller version" src="https://badge.fury.io/py/aries-cloudcontroller.svg"/>
-      </a>
+  <a href="https://pypi.org/project/aries-cloudcontroller/">
+    <img alt="aries-cloudcontroller version" src="https://badge.fury.io/py/aries-cloudcontroller.svg"/>
+  </a>
   <a
     href="https://raw.githubusercontent.com/didx-xyz/aries-cloudcontroller-python/main/LICENSE"
     ><img
@@ -34,42 +30,39 @@
   <a href="#usage">Usage</a> &nbsp;|&nbsp;
   <a href="#available-apis">Available APIs</a> &nbsp;|&nbsp;
   <a href="#contributing">Contributing</a> &nbsp;|&nbsp;
-  <a href="#license">License</a> 
+  <a href="#license">License</a>
 </p>
 
-The Aries CloudController is a client library, written in Python, for interacting with an [Aries Cloud Agent](https://github.com/hyperledger/aries-cloudagent-python) instance. It is generated based on the OpenAPI definition provided by ACA-Py, giving a fully-typed, rich API for interacting with the cloud agent.
+The Aries CloudController is a Python-based client library for interacting with an instance of [Aries Cloud Agent](https://github.com/hyperledger/aries-cloudagent-python) (ACA-Py). It leverages the OpenAPI definition from ACA-Py to provide a fully-typed, rich API experience for cloud agent interaction.
+
+**Versioning Update:**
+As of version 0.8.0, the Aries CloudController has aligned its versioning with ACA-Py. This means that each new version of ACA-Py will correspond directly to the same version of the Aries CloudController. This change ensures a more straightforward and predictable upgrade path for users.
 
-Each Cloud Controller version maps to a specific ACA-Py version, which is outlined in the table below. Although not strictly adhered to in the past, a new ACA-Py version will result in a new Minor version bump for the Cloud Controller, as there are often times breaking changes.
+In other words, CloudController 0.8.0 is compatible with ACA-Py 0.8.0, CloudController 0.9.0 is compatible with ACA-Py 0.9.0, etc.
 
-| Aries Cloud Controller Version | Aries Cloud Agent Python Version |
-| ------------------------------ | -------------------------------- |
-| 0.5.1-0.5.2                    | 0.7.3                            |
-| 0.6.0-0.6.3                    | 0.7.4                            |
-| 0.7.0                          | 0.7.5                            |
-| 0.8.0                          | 0.8.0                            |
-| 0.8.1                          | 0.8.1                            |
-| 0.8.2                          | 0.8.2                            |
-| 0.9.0                          | 0.9.0                            |
+For legacy versions, please review our release history to found the version compatible with ACA-Py pre-0.8.0.
 
 ## Features
 
-Aries Cloud Controller Python is a fully featured client for interacting with ACA-Py.
+Aries CloudController Python provides a robust client for interacting with Aries Cloud Agents (ACA-Py).
 
-- Fully Typed wrapper around Aries Cloud Agent Python
-- Supports latest ACA-Py version (0.9.0)
-- Client is auto generated based on OpenAPI definitions, allowing us to keep up to date with new releases.
-- Supports multi-tenant APIs and authentication
-- Async API
+- **Fully Typed**: Offers a strongly-typed wrapper around the Aries Cloud Agent Python, enhancing developer experience and reducing errors.
+- **Up-to-Date Support**: Compatible with the latest ACA-Py version (0.10.1), ensuring access to the most recent features and improvements.
+- **Auto-Generated Client**: Utilizes OpenAPI definitions for automatic generation, ensuring timely updates in line with new ACA-Py releases.
+- **Multi-Tenancy and Authentication Support**: Facilitates working with multi-tenant APIs and integrates various authentication mechanisms.
+- **Asynchronous API**: Supports asynchronous operations, enabling efficient handling of I/O-bound tasks.
 
 ## Usage
 
-Aries Cloud Controller Python is published to PyPi and can be installed using pip:
+Install Aries Cloud Controller Python via pip:
 
 ```sh
 pip install aries-cloudcontroller
 ```
 
-### Creating a client
+### Creating a Client
+
+Easily initialize the AcaPyClient:
 
 ```python
 from aries_cloudcontroller import AcaPyClient
@@ -80,21 +73,16 @@ client = AcaPyClient(
 )
 ```
 
-**Admin insecure mode**
-
-If you are running ACA-Py with the admin insecure flag and don't have the API key, you must set the `admin_insecure` property:
+**Admin Insecure Mode**: If running ACA-Py with the `--admin-insecure-mode` flag and without an API key:
 
 ```python
 client = AcaPyClient(
     base_url="http://localhost:8000",
-    # Explicitly mark that no api key is used
-    admin_insecure=True
+    admin_insecure=True  # No API key needed
 )
 ```
 
-**Multitenancy**
-
-To provision the agent in the context of specific tenant of the agent, the `tenant_jwt` property must be set:
+**Multitenancy**: For specific tenant contexts:
 
 ```python
 client = AcaPyClient(
@@ -103,23 +91,23 @@ client = AcaPyClient(
 )
 ```
 
-### Interacting with the client
+### Interacting with the Client
 
-Once you have the client set up, you're ready to interact with it. Because the API is fully typed, the best way to know what is available is by looking at the ACA-Py swagger UI, and the available properties on the client.
+The API, being fully typed, is best explored through the ACA-Py Swagger UI, which mirrors the available client properties.
 
-For example to create and receive an invitation the following methods can be called:
+**Example**: Creating and receiving an invitation:
 
 ```python
 invitation = await client.connection.create_invitation(
     body=CreateInvitationRequest(my_label="Cloud Controller")
 )
 
-connection = await client.connection.receive_invitation(body=result.invitation)
+connection = await client.connection.receive_invitation(body=invitation.invitation)
 ```
 
 ## Available APIs
 
-Currently the following top-level APIs are available in the client. Each api maps to the topics as used by the ACA-Py swagger UI.
+The client encompasses various APIs, each corresponding to ACA-Py Swagger UI topics:
 
 - `action_menu`
 - `basicmessage`
@@ -151,8 +139,8 @@ Currently the following top-level APIs are available in the client. Each api map
 
 ## Contributing
 
-If you would like to contribute to the framework, please read [CONTRIBUTING](/CONTRIBUTING.md) guidelines. These documents will provide more information to get you started!
+Contributions are welcome! Please see our [CONTRIBUTING](/CONTRIBUTING.md) guidelines for more information on how to get involved.
 
 ## License
 
-Aries Cloud Controller Python is licensed under the [Apache License Version 2.0 (Apache-2.0)](/LICENSE).
+This project is licensed under the [Apache License Version 2.0 (Apache-2.0)](/LICENSE).

README.md

@@ -16,4 +16,4 @@ Security bugs can be reported via email. The process is as follows:
 Email us at: [info at didx.co.za](mailto:info@didx.co.za)
 
 *Note. It is not necessary to include the type of bug if you are not sure how to classify it.*
-*A detailed description will be adequate.*
+*A detailed description will be adequate.*

SECURITY.md

@@ -7,14 +7,14 @@
 
     No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-    The version of the OpenAPI document: v0.9.0
+    The version of the OpenAPI document: v0.10.1
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
 """  # noqa: E501
 
 
-__version__ = "0.9.0"
+__version__ = "0.10.1"
 
 from aries_cloudcontroller.acapy_client import AcaPyClient
 
@@ -82,6 +82,7 @@
     AttributeMimeTypesResult,
     ClaimFormat,
     ClearPendingRevocationsRequest,
+    ConfigurableWriteLedgers,
     ConnectionInvitation,
     ConnectionList,
     ConnectionMetadata,
@@ -120,6 +121,7 @@
     DIDEndpointWithType,
     DIDList,
     DIDResult,
+    DIDXRejectRequest,
     DIDXRequest,
     DIFField,
     DIFHolder,
@@ -273,6 +275,7 @@
     V10CredentialConnFreeOfferRequest,
     V10CredentialCreate,
     V10CredentialExchange,
+    V10CredentialExchangeAutoRemoveRequest,
     V10CredentialExchangeListResult,
     V10CredentialFreeOfferRequest,
     V10CredentialIssueRequest,
@@ -287,6 +290,7 @@
     V10PresentationExchangeList,
     V10PresentationProblemReportRequest,
     V10PresentationProposalRequest,
+    V10PresentationSendRequest,
     V10PresentationSendRequestRequest,
     V10PresentationSendRequestToProposal,
     V20CredAttrSpec,
@@ -342,6 +346,6 @@
     WalletListWithGroups,
     WalletRecord,
     WalletRecordWithGroups,
-    WriteLedgerRequest,
+    WriteLedger,
 )
 from aries_cloudcontroller.util import DEFAULT_PYDANTIC_MODEL_CONFIG

aries_cloudcontroller/__init__.py

@@ -5,7 +5,7 @@
 
     No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-    The version of the OpenAPI document: v0.9.0
+    The version of the OpenAPI document: v0.10.1
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
     Do not edit the class manually.
@@ -14,7 +14,7 @@
 
 from typing import Any, Dict, List, Optional, Tuple, Union
 
-from pydantic import Field, StrictFloat, StrictInt, StrictStr, validate_call
+from pydantic import Field, StrictFloat, StrictInt, StrictStr
 
 try:
     from typing import Annotated
@@ -46,7 +46,6 @@ def __init__(self, api_client=None) -> None:
             api_client = ApiClient.get_default()
         self.api_client = api_client
 
-    @validate_call
     async def close_active_menu(
         self,
         conn_id: Annotated[StrictStr, Field(description="Connection identifier")],
@@ -107,7 +106,6 @@ async def close_active_menu(
             response_types_map=_response_types_map,
         ).data
 
-    @validate_call
     async def close_active_menu_with_http_info(
         self,
         conn_id: Annotated[StrictStr, Field(description="Connection identifier")],
@@ -168,7 +166,6 @@ async def close_active_menu_with_http_info(
             response_types_map=_response_types_map,
         )
 
-    @validate_call
     async def close_active_menu_without_preload_content(
         self,
         conn_id: Annotated[StrictStr, Field(description="Connection identifier")],
@@ -275,7 +272,6 @@ def _close_active_menu_serialize(
             _request_auth=_request_auth,
         )
 
-    @validate_call
     async def fetch_active_menu(
         self,
         conn_id: Annotated[StrictStr, Field(description="Connection identifier")],
@@ -336,7 +332,6 @@ async def fetch_active_menu(
             response_types_map=_response_types_map,
         ).data
 
-    @validate_call
     async def fetch_active_menu_with_http_info(
         self,
         conn_id: Annotated[StrictStr, Field(description="Connection identifier")],
@@ -397,7 +392,6 @@ async def fetch_active_menu_with_http_info(
             response_types_map=_response_types_map,
         )
 
-    @validate_call
     async def fetch_active_menu_without_preload_content(
         self,
         conn_id: Annotated[StrictStr, Field(description="Connection identifier")],
@@ -504,7 +498,6 @@ def _fetch_active_menu_serialize(
             _request_auth=_request_auth,
         )
 
-    @validate_call
     async def perform_action(
         self,
         conn_id: Annotated[StrictStr, Field(description="Connection identifier")],
@@ -569,7 +562,6 @@ async def perform_action(
             response_types_map=_response_types_map,
         ).data
 
-    @validate_call
     async def perform_action_with_http_info(
         self,
         conn_id: Annotated[StrictStr, Field(description="Connection identifier")],
@@ -634,7 +626,6 @@ async def perform_action_with_http_info(
             response_types_map=_response_types_map,
         )
 
-    @validate_call
     async def perform_action_without_preload_content(
         self,
         conn_id: Annotated[StrictStr, Field(description="Connection identifier")],
@@ -758,7 +749,6 @@ def _perform_action_serialize(
             _request_auth=_request_auth,
         )
 
-    @validate_call
     async def request_active_menu(
         self,
         conn_id: Annotated[StrictStr, Field(description="Connection identifier")],
@@ -819,7 +809,6 @@ async def request_active_menu(
             response_types_map=_response_types_map,
         ).data
 
-    @validate_call
     async def request_active_menu_with_http_info(
         self,
         conn_id: Annotated[StrictStr, Field(description="Connection identifier")],
@@ -880,7 +869,6 @@ async def request_active_menu_with_http_info(
             response_types_map=_response_types_map,
         )
 
-    @validate_call
     async def request_active_menu_without_preload_content(
         self,
         conn_id: Annotated[StrictStr, Field(description="Connection identifier")],
@@ -987,7 +975,6 @@ def _request_active_menu_serialize(
             _request_auth=_request_auth,
         )
 
-    @validate_call
     async def send_menu(
         self,
         conn_id: Annotated[StrictStr, Field(description="Connection identifier")],
@@ -1052,7 +1039,6 @@ async def send_menu(
             response_types_map=_response_types_map,
         ).data
 
-    @validate_call
     async def send_menu_with_http_info(
         self,
         conn_id: Annotated[StrictStr, Field(description="Connection identifier")],
@@ -1117,7 +1103,6 @@ async def send_menu_with_http_info(
             response_types_map=_response_types_map,
         )
 
-    @validate_call
     async def send_menu_without_preload_content(
         self,
         conn_id: Annotated[StrictStr, Field(description="Connection identifier")],