circle-developer-controlled-wallets 6.1.0__py3-none-any.whl → 6.2.0__py3-none-any.whl

circle/web3/developer_controlled_wallets/__init__.py

@@ -10,7 +10,7 @@
 """  # noqa: E501
 
 
-__version__ = "6.1.0"
+__version__ = "6.2.0"
 
 # import apis into sdk package
 from circle.web3.developer_controlled_wallets.api.signing_api import SigningApi

circle/web3/developer_controlled_wallets/api/signing_api.py

@@ -16,7 +16,9 @@ import functools
 from pydantic import validate_arguments, ValidationError
 from typing_extensions import Annotated
 
-from pydantic import Field
+from pydantic import Field, StrictStr
+
+from typing import Optional
 
 from circle.web3.developer_controlled_wallets.models.sign_delegate_action_request import SignDelegateActionRequest
 from circle.web3.developer_controlled_wallets.models.sign_delegate_action_response import SignDelegateActionResponse
@@ -64,18 +66,20 @@ class SigningApi(object):
 
     @auto_fill
     @validate_arguments
-    def sign_delegate_action(self, sign_delegate_action_request : Annotated[SignDelegateActionRequest, Field(..., description="Schema for the request payload to sign a delegate action.")], **kwargs) -> SignDelegateActionResponse:  # noqa: E501
+    def sign_delegate_action(self, sign_delegate_action_request : Annotated[SignDelegateActionRequest, Field(..., description="Schema for the request payload to sign a delegate action.")], x_request_id : Annotated[Optional[StrictStr], Field(description="Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.")] = None, **kwargs) -> SignDelegateActionResponse:  # noqa: E501
         """Sign delegate action  # noqa: E501
 
         Sign a delegate action from a specific developer-controlled wallet.  NOTE: This endpoint is only available for NEAR and NEAR-TESTNET.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.sign_delegate_action(sign_delegate_action_request, async_req=True)
+        >>> thread = api.sign_delegate_action(sign_delegate_action_request, x_request_id, async_req=True)
         >>> result = thread.get()
 
         :param sign_delegate_action_request: Schema for the request payload to sign a delegate action. (required)
         :type sign_delegate_action_request: SignDelegateActionRequest
+        :param x_request_id: Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
+        :type x_request_id: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _request_timeout: timeout setting for this request. If one
@@ -90,22 +94,24 @@ class SigningApi(object):
         kwargs['_return_http_data_only'] = True
         if '_preload_content' in kwargs:
             raise ValueError("Error! Please call the sign_delegate_action_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data")
-        return self.sign_delegate_action_with_http_info(sign_delegate_action_request, **kwargs)  # noqa: E501
+        return self.sign_delegate_action_with_http_info(sign_delegate_action_request, x_request_id, **kwargs)  # noqa: E501
 
     @auto_fill
     @validate_arguments
-    def sign_delegate_action_with_http_info(self, sign_delegate_action_request : Annotated[SignDelegateActionRequest, Field(..., description="Schema for the request payload to sign a delegate action.")], **kwargs) -> ApiResponse:  # noqa: E501
+    def sign_delegate_action_with_http_info(self, sign_delegate_action_request : Annotated[SignDelegateActionRequest, Field(..., description="Schema for the request payload to sign a delegate action.")], x_request_id : Annotated[Optional[StrictStr], Field(description="Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.")] = None, **kwargs) -> ApiResponse:  # noqa: E501
         """Sign delegate action  # noqa: E501
 
         Sign a delegate action from a specific developer-controlled wallet.  NOTE: This endpoint is only available for NEAR and NEAR-TESTNET.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.sign_delegate_action_with_http_info(sign_delegate_action_request, async_req=True)
+        >>> thread = api.sign_delegate_action_with_http_info(sign_delegate_action_request, x_request_id, async_req=True)
         >>> result = thread.get()
 
         :param sign_delegate_action_request: Schema for the request payload to sign a delegate action. (required)
         :type sign_delegate_action_request: SignDelegateActionRequest
+        :param x_request_id: Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
+        :type x_request_id: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the ApiResponse.data will
@@ -134,7 +140,8 @@ class SigningApi(object):
         _params = locals()
 
         _all_params = [
-            'sign_delegate_action_request'
+            'sign_delegate_action_request',
+            'x_request_id'
         ]
         _all_params.extend(
             [
@@ -167,6 +174,9 @@ class SigningApi(object):
         _query_params = []
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))
+        if _params['x_request_id']:
+            _header_params['X-Request-Id'] = _params['x_request_id']
+
         # process the form parameters
         _form_params = []
         _files = {}
@@ -215,18 +225,20 @@ class SigningApi(object):
 
     @auto_fill
     @validate_arguments
-    def sign_message(self, sign_message_request : Annotated[SignMessageRequest, Field(..., description="Schema for the request payload to sign a message.")], **kwargs) -> SignatureResponse:  # noqa: E501
+    def sign_message(self, sign_message_request : Annotated[SignMessageRequest, Field(..., description="Schema for the request payload to sign a message.")], x_request_id : Annotated[Optional[StrictStr], Field(description="Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.")] = None, **kwargs) -> SignatureResponse:  # noqa: E501
         """Sign message  # noqa: E501
 
         Sign a message from a specified developer-controlled wallet. This endpoint supports message signing for both Ethereum-based blockchains (using EIP-191) and Solana (using Ed25519 signatures). Note that Smart Contract Accounts (SCA) are specific to Ethereum and EVM-compatible chains. The difference between Ethereum's EOA and SCA can be found in the [account types guide](https://developers.circle.com/w3s/docs/programmable-wallets-account-types). You can also check the list of Ethereum Dapps that support SCA: https://eip1271.io/.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.sign_message(sign_message_request, async_req=True)
+        >>> thread = api.sign_message(sign_message_request, x_request_id, async_req=True)
         >>> result = thread.get()
 
         :param sign_message_request: Schema for the request payload to sign a message. (required)
         :type sign_message_request: SignMessageRequest
+        :param x_request_id: Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
+        :type x_request_id: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _request_timeout: timeout setting for this request. If one
@@ -241,22 +253,24 @@ class SigningApi(object):
         kwargs['_return_http_data_only'] = True
         if '_preload_content' in kwargs:
             raise ValueError("Error! Please call the sign_message_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data")
-        return self.sign_message_with_http_info(sign_message_request, **kwargs)  # noqa: E501
+        return self.sign_message_with_http_info(sign_message_request, x_request_id, **kwargs)  # noqa: E501
 
     @auto_fill
     @validate_arguments
-    def sign_message_with_http_info(self, sign_message_request : Annotated[SignMessageRequest, Field(..., description="Schema for the request payload to sign a message.")], **kwargs) -> ApiResponse:  # noqa: E501
+    def sign_message_with_http_info(self, sign_message_request : Annotated[SignMessageRequest, Field(..., description="Schema for the request payload to sign a message.")], x_request_id : Annotated[Optional[StrictStr], Field(description="Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.")] = None, **kwargs) -> ApiResponse:  # noqa: E501
         """Sign message  # noqa: E501
 
         Sign a message from a specified developer-controlled wallet. This endpoint supports message signing for both Ethereum-based blockchains (using EIP-191) and Solana (using Ed25519 signatures). Note that Smart Contract Accounts (SCA) are specific to Ethereum and EVM-compatible chains. The difference between Ethereum's EOA and SCA can be found in the [account types guide](https://developers.circle.com/w3s/docs/programmable-wallets-account-types). You can also check the list of Ethereum Dapps that support SCA: https://eip1271.io/.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.sign_message_with_http_info(sign_message_request, async_req=True)
+        >>> thread = api.sign_message_with_http_info(sign_message_request, x_request_id, async_req=True)
         >>> result = thread.get()
 
         :param sign_message_request: Schema for the request payload to sign a message. (required)
         :type sign_message_request: SignMessageRequest
+        :param x_request_id: Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
+        :type x_request_id: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the ApiResponse.data will
@@ -285,7 +299,8 @@ class SigningApi(object):
         _params = locals()
 
         _all_params = [
-            'sign_message_request'
+            'sign_message_request',
+            'x_request_id'
         ]
         _all_params.extend(
             [
@@ -318,6 +333,9 @@ class SigningApi(object):
         _query_params = []
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))
+        if _params['x_request_id']:
+            _header_params['X-Request-Id'] = _params['x_request_id']
+
         # process the form parameters
         _form_params = []
         _files = {}
@@ -366,18 +384,20 @@ class SigningApi(object):
 
     @auto_fill
     @validate_arguments
-    def sign_transaction(self, sign_transaction_request : Annotated[SignTransactionRequest, Field(..., description="Schema for the request payload to sign a transaction.")], **kwargs) -> SignTransactionResponse:  # noqa: E501
+    def sign_transaction(self, sign_transaction_request : Annotated[SignTransactionRequest, Field(..., description="Schema for the request payload to sign a transaction.")], x_request_id : Annotated[Optional[StrictStr], Field(description="Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.")] = None, **kwargs) -> SignTransactionResponse:  # noqa: E501
         """Sign transaction  # noqa: E501
 
         Sign a transaction from a specific developer-controlled wallet.  NOTE: This endpoint is only available for the following chains: `SOL`, `SOL-DEVNET`, `NEAR`, `NEAR-TESTNET`, `EVM`, `EVM-TESTNET`. Each chain defines its own standard, please refer to [Signing APIs doc](https://learn.circle.com/w3s/signing-apis).  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.sign_transaction(sign_transaction_request, async_req=True)
+        >>> thread = api.sign_transaction(sign_transaction_request, x_request_id, async_req=True)
         >>> result = thread.get()
 
         :param sign_transaction_request: Schema for the request payload to sign a transaction. (required)
         :type sign_transaction_request: SignTransactionRequest
+        :param x_request_id: Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
+        :type x_request_id: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _request_timeout: timeout setting for this request. If one
@@ -392,22 +412,24 @@ class SigningApi(object):
         kwargs['_return_http_data_only'] = True
         if '_preload_content' in kwargs:
             raise ValueError("Error! Please call the sign_transaction_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data")
-        return self.sign_transaction_with_http_info(sign_transaction_request, **kwargs)  # noqa: E501
+        return self.sign_transaction_with_http_info(sign_transaction_request, x_request_id, **kwargs)  # noqa: E501
 
     @auto_fill
     @validate_arguments
-    def sign_transaction_with_http_info(self, sign_transaction_request : Annotated[SignTransactionRequest, Field(..., description="Schema for the request payload to sign a transaction.")], **kwargs) -> ApiResponse:  # noqa: E501
+    def sign_transaction_with_http_info(self, sign_transaction_request : Annotated[SignTransactionRequest, Field(..., description="Schema for the request payload to sign a transaction.")], x_request_id : Annotated[Optional[StrictStr], Field(description="Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.")] = None, **kwargs) -> ApiResponse:  # noqa: E501
         """Sign transaction  # noqa: E501
 
         Sign a transaction from a specific developer-controlled wallet.  NOTE: This endpoint is only available for the following chains: `SOL`, `SOL-DEVNET`, `NEAR`, `NEAR-TESTNET`, `EVM`, `EVM-TESTNET`. Each chain defines its own standard, please refer to [Signing APIs doc](https://learn.circle.com/w3s/signing-apis).  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.sign_transaction_with_http_info(sign_transaction_request, async_req=True)
+        >>> thread = api.sign_transaction_with_http_info(sign_transaction_request, x_request_id, async_req=True)
         >>> result = thread.get()
 
         :param sign_transaction_request: Schema for the request payload to sign a transaction. (required)
         :type sign_transaction_request: SignTransactionRequest
+        :param x_request_id: Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
+        :type x_request_id: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the ApiResponse.data will
@@ -436,7 +458,8 @@ class SigningApi(object):
         _params = locals()
 
         _all_params = [
-            'sign_transaction_request'
+            'sign_transaction_request',
+            'x_request_id'
         ]
         _all_params.extend(
             [
@@ -469,6 +492,9 @@ class SigningApi(object):
         _query_params = []
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))
+        if _params['x_request_id']:
+            _header_params['X-Request-Id'] = _params['x_request_id']
+
         # process the form parameters
         _form_params = []
         _files = {}
@@ -517,18 +543,20 @@ class SigningApi(object):
 
     @auto_fill
     @validate_arguments
-    def sign_typed_data(self, sign_typed_data_request : Annotated[SignTypedDataRequest, Field(..., description="Schema for the request payload to sign typed data.")], **kwargs) -> SignatureResponse:  # noqa: E501
+    def sign_typed_data(self, sign_typed_data_request : Annotated[SignTypedDataRequest, Field(..., description="Schema for the request payload to sign typed data.")], x_request_id : Annotated[Optional[StrictStr], Field(description="Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.")] = None, **kwargs) -> SignatureResponse:  # noqa: E501
         """Sign typed data  # noqa: E501
 
         Sign the EIP-712 typed structured data from a specified developer-controlled wallet. This endpoint only supports Ethereum and EVM-compatible blockchains. Please note that not all Dapps currently support Smart Contract Accounts (SCA); the difference between Ethereum's EOA and SCA can be found in the [account types guide](https://developers.circle.com/w3s/docs/programmable-wallets-account-types). You can also check the list of Ethereum Dapps that support SCA: https://eip1271.io/.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.sign_typed_data(sign_typed_data_request, async_req=True)
+        >>> thread = api.sign_typed_data(sign_typed_data_request, x_request_id, async_req=True)
         >>> result = thread.get()
 
         :param sign_typed_data_request: Schema for the request payload to sign typed data. (required)
         :type sign_typed_data_request: SignTypedDataRequest
+        :param x_request_id: Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
+        :type x_request_id: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _request_timeout: timeout setting for this request. If one
@@ -543,22 +571,24 @@ class SigningApi(object):
         kwargs['_return_http_data_only'] = True
         if '_preload_content' in kwargs:
             raise ValueError("Error! Please call the sign_typed_data_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data")
-        return self.sign_typed_data_with_http_info(sign_typed_data_request, **kwargs)  # noqa: E501
+        return self.sign_typed_data_with_http_info(sign_typed_data_request, x_request_id, **kwargs)  # noqa: E501
 
     @auto_fill
     @validate_arguments
-    def sign_typed_data_with_http_info(self, sign_typed_data_request : Annotated[SignTypedDataRequest, Field(..., description="Schema for the request payload to sign typed data.")], **kwargs) -> ApiResponse:  # noqa: E501
+    def sign_typed_data_with_http_info(self, sign_typed_data_request : Annotated[SignTypedDataRequest, Field(..., description="Schema for the request payload to sign typed data.")], x_request_id : Annotated[Optional[StrictStr], Field(description="Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.")] = None, **kwargs) -> ApiResponse:  # noqa: E501
         """Sign typed data  # noqa: E501
 
         Sign the EIP-712 typed structured data from a specified developer-controlled wallet. This endpoint only supports Ethereum and EVM-compatible blockchains. Please note that not all Dapps currently support Smart Contract Accounts (SCA); the difference between Ethereum's EOA and SCA can be found in the [account types guide](https://developers.circle.com/w3s/docs/programmable-wallets-account-types). You can also check the list of Ethereum Dapps that support SCA: https://eip1271.io/.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.sign_typed_data_with_http_info(sign_typed_data_request, async_req=True)
+        >>> thread = api.sign_typed_data_with_http_info(sign_typed_data_request, x_request_id, async_req=True)
         >>> result = thread.get()
 
         :param sign_typed_data_request: Schema for the request payload to sign typed data. (required)
         :type sign_typed_data_request: SignTypedDataRequest
+        :param x_request_id: Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.
+        :type x_request_id: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the ApiResponse.data will
@@ -587,7 +617,8 @@ class SigningApi(object):
         _params = locals()
 
         _all_params = [
-            'sign_typed_data_request'
+            'sign_typed_data_request',
+            'x_request_id'
         ]
         _all_params.extend(
             [
@@ -620,6 +651,9 @@ class SigningApi(object):
         _query_params = []
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))
+        if _params['x_request_id']:
+            _header_params['X-Request-Id'] = _params['x_request_id']
+
         # process the form parameters
         _form_params = []
         _files = {}