compass_api_sdk 0.9.51__py3-none-any.whl → 0.9.52__py3-none-any.whl

compass_api_sdk/erc_4626_vaults.py

@@ -9,10 +9,10 @@ from typing import Any, Mapping, Optional, Union
 
 
 class ERC4626Vaults(BaseSDK):
-    def vault(
+    def vaults_vault(
         self,
         *,
-        chain: models.VaultsVaultChain = models.VaultsVaultChain.ETHEREUM_MAINNET,
+        chain: models.V1VaultsVaultChain = models.V1VaultsVaultChain.ETHEREUM,
         vault_address: str = "0x182863131F9a4630fF9E27830d945B1413e347E8",
         block: OptionalNullable[int] = UNSET,
         user_address: OptionalNullable[str] = UNSET,
@@ -20,14 +20,14 @@ class ERC4626Vaults(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.VaultGetVaultResponse:
+    ) -> models.CompassAPIBackendModelsVaultsReadResponseVaultVaultGetVaultResponse:
         r"""Get Vault & User Position
 
         Get Vault data & User Position.
 
         The user position is only included if 'user_address' parameter is included.
 
-        :param chain: The chain to use.
+        :param chain:
         :param vault_address: The vault address of the desired vault position.
         :param block: Optional block number (defaults to latest).
         :param user_address: The user address of the desired vault position. Only include if you would like the user position included in the response. Defaults to `None`.
@@ -46,7 +46,7 @@ class ERC4626Vaults(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.VaultsVaultRequest(
+        request = models.V1VaultsVaultRequest(
             chain=chain,
             block=block,
             vault_address=vault_address,
@@ -55,7 +55,7 @@ class ERC4626Vaults(BaseSDK):
 
         req = self._build_request(
             method="GET",
-            path="/v0/vaults/vault",
+            path="/v1/vaults/vault",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -81,7 +81,7 @@ class ERC4626Vaults(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="vaults_vault",
+                operation_id="v1_vaults_vault",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -92,7 +92,10 @@ class ERC4626Vaults(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.VaultGetVaultResponse, http_res)
+            return unmarshal_json_response(
+                models.CompassAPIBackendModelsVaultsReadResponseVaultVaultGetVaultResponse,
+                http_res,
+            )
         if utils.match_response(http_res, "422", "application/json"):
             response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
@@ -107,10 +110,10 @@ class ERC4626Vaults(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def vault_async(
+    async def vaults_vault_async(
         self,
         *,
-        chain: models.VaultsVaultChain = models.VaultsVaultChain.ETHEREUM_MAINNET,
+        chain: models.V1VaultsVaultChain = models.V1VaultsVaultChain.ETHEREUM,
         vault_address: str = "0x182863131F9a4630fF9E27830d945B1413e347E8",
         block: OptionalNullable[int] = UNSET,
         user_address: OptionalNullable[str] = UNSET,
@@ -118,14 +121,14 @@ class ERC4626Vaults(BaseSDK):
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.VaultGetVaultResponse:
+    ) -> models.CompassAPIBackendModelsVaultsReadResponseVaultVaultGetVaultResponse:
         r"""Get Vault & User Position
 
         Get Vault data & User Position.
 
         The user position is only included if 'user_address' parameter is included.
 
-        :param chain: The chain to use.
+        :param chain:
         :param vault_address: The vault address of the desired vault position.
         :param block: Optional block number (defaults to latest).
         :param user_address: The user address of the desired vault position. Only include if you would like the user position included in the response. Defaults to `None`.
@@ -144,7 +147,7 @@ class ERC4626Vaults(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.VaultsVaultRequest(
+        request = models.V1VaultsVaultRequest(
             chain=chain,
             block=block,
             vault_address=vault_address,
@@ -153,7 +156,7 @@ class ERC4626Vaults(BaseSDK):
 
         req = self._build_request_async(
             method="GET",
-            path="/v0/vaults/vault",
+            path="/v1/vaults/vault",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -179,7 +182,7 @@ class ERC4626Vaults(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="vaults_vault",
+                operation_id="v1_vaults_vault",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -190,7 +193,10 @@ class ERC4626Vaults(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.VaultGetVaultResponse, http_res)
+            return unmarshal_json_response(
+                models.CompassAPIBackendModelsVaultsReadResponseVaultVaultGetVaultResponse,
+                http_res,
+            )
         if utils.match_response(http_res, "422", "application/json"):
             response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
@@ -205,21 +211,22 @@ class ERC4626Vaults(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def deposit(
+    def vaults_deposit(
         self,
         *,
         vault_address: str,
         amount: Union[
-            models.VaultDepositRequestAmount, models.VaultDepositRequestAmountTypedDict
+            models.CompassAPIBackendModelsVaultsTransactRequestDepositVaultDepositRequestAmount,
+            models.CompassAPIBackendModelsVaultsTransactRequestDepositVaultDepositRequestAmountTypedDict,
         ],
-        chain: models.Chain,
+        chain: models.CompassAPIBackendModelsVaultsTransactRequestDepositVaultDepositRequestChain,
         sender: str,
         receiver: OptionalNullable[str] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.TxResponse:
+    ) -> models.TransactionResponse:
         r"""Deposit to Vault
 
         Deposit tokens into a Vault (ERC-4626 Standard) to earn passive yield.
@@ -228,7 +235,7 @@ class ERC4626Vaults(BaseSDK):
         <Info>
         **Required Allowances**
 
-        In order to make this transaction, token allowances need to be set on the following contracts.
+        In order to make this transaction, token allowances need to be set for the following contracts.
 
         - `<vault_address>`
         </Info>
@@ -236,7 +243,7 @@ class ERC4626Vaults(BaseSDK):
 
         :param vault_address: The vault address you are depositing to.
         :param amount: The amount of tokens to deposit into the vault.
-        :param chain: The chain to use.
+        :param chain:
         :param sender: The address of the transaction sender.
         :param receiver: The address which will receive the shares from the vault representing their proportional ownership of the vault's assets. Defaults to the sender.
         :param retries: Override the default retry configuration for this method
@@ -254,7 +261,7 @@ class ERC4626Vaults(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.VaultDepositRequest(
+        request = models.CompassAPIBackendModelsVaultsTransactRequestDepositVaultDepositRequest(
             vault_address=vault_address,
             amount=amount,
             receiver=receiver,
@@ -264,7 +271,7 @@ class ERC4626Vaults(BaseSDK):
 
         req = self._build_request(
             method="POST",
-            path="/v0/vaults/deposit",
+            path="/v1/vaults/deposit",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -276,7 +283,11 @@ class ERC4626Vaults(BaseSDK):
             http_headers=http_headers,
             security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
-                request, False, False, "json", models.VaultDepositRequest
+                request,
+                False,
+                False,
+                "json",
+                models.CompassAPIBackendModelsVaultsTransactRequestDepositVaultDepositRequest,
             ),
             timeout_ms=timeout_ms,
         )
@@ -293,7 +304,7 @@ class ERC4626Vaults(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="vaults_deposit",
+                operation_id="v1_vaults_deposit",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -304,7 +315,7 @@ class ERC4626Vaults(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TransactionResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
@@ -319,21 +330,22 @@ class ERC4626Vaults(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def deposit_async(
+    async def vaults_deposit_async(
         self,
         *,
         vault_address: str,
         amount: Union[
-            models.VaultDepositRequestAmount, models.VaultDepositRequestAmountTypedDict
+            models.CompassAPIBackendModelsVaultsTransactRequestDepositVaultDepositRequestAmount,
+            models.CompassAPIBackendModelsVaultsTransactRequestDepositVaultDepositRequestAmountTypedDict,
         ],
-        chain: models.Chain,
+        chain: models.CompassAPIBackendModelsVaultsTransactRequestDepositVaultDepositRequestChain,
         sender: str,
         receiver: OptionalNullable[str] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.TxResponse:
+    ) -> models.TransactionResponse:
         r"""Deposit to Vault
 
         Deposit tokens into a Vault (ERC-4626 Standard) to earn passive yield.
@@ -342,7 +354,7 @@ class ERC4626Vaults(BaseSDK):
         <Info>
         **Required Allowances**
 
-        In order to make this transaction, token allowances need to be set on the following contracts.
+        In order to make this transaction, token allowances need to be set for the following contracts.
 
         - `<vault_address>`
         </Info>
@@ -350,7 +362,7 @@ class ERC4626Vaults(BaseSDK):
 
         :param vault_address: The vault address you are depositing to.
         :param amount: The amount of tokens to deposit into the vault.
-        :param chain: The chain to use.
+        :param chain:
         :param sender: The address of the transaction sender.
         :param receiver: The address which will receive the shares from the vault representing their proportional ownership of the vault's assets. Defaults to the sender.
         :param retries: Override the default retry configuration for this method
@@ -368,7 +380,7 @@ class ERC4626Vaults(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.VaultDepositRequest(
+        request = models.CompassAPIBackendModelsVaultsTransactRequestDepositVaultDepositRequest(
             vault_address=vault_address,
             amount=amount,
             receiver=receiver,
@@ -378,7 +390,7 @@ class ERC4626Vaults(BaseSDK):
 
         req = self._build_request_async(
             method="POST",
-            path="/v0/vaults/deposit",
+            path="/v1/vaults/deposit",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -390,7 +402,11 @@ class ERC4626Vaults(BaseSDK):
             http_headers=http_headers,
             security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
-                request, False, False, "json", models.VaultDepositRequest
+                request,
+                False,
+                False,
+                "json",
+                models.CompassAPIBackendModelsVaultsTransactRequestDepositVaultDepositRequest,
             ),
             timeout_ms=timeout_ms,
         )
@@ -407,7 +423,7 @@ class ERC4626Vaults(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="vaults_deposit",
+                operation_id="v1_vaults_deposit",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -418,7 +434,7 @@ class ERC4626Vaults(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TransactionResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
@@ -433,19 +449,19 @@ class ERC4626Vaults(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def withdraw(
+    def vaults_withdraw(
         self,
         *,
         vault_address: str,
         amount: Any,
-        chain: models.Chain,
+        chain: models.CompassAPIBackendModelsVaultsTransactRequestWithdrawVaultWithdrawRequestChain,
         sender: str,
         receiver: OptionalNullable[str] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.TxResponse:
+    ) -> models.TransactionResponse:
         r"""Withdraw from Vault
 
         Withdraw deposited tokens from a Vault (ERC-4626 Standard).
@@ -456,7 +472,7 @@ class ERC4626Vaults(BaseSDK):
         <Info>
         **Required Allowances**
 
-        In order to make this transaction, token allowances need to be set on the following contracts.
+        In order to make this transaction, token allowances need to be set for the following contracts.
 
         - `<vault address>`
         </Info>
@@ -464,7 +480,7 @@ class ERC4626Vaults(BaseSDK):
 
         :param vault_address: The vault address you are withdrawing from.
         :param amount: The amount of tokens to withdraw from the vault. If set to 'ALL', your total deposited token amount will be withdrawn.
-        :param chain: The chain to use.
+        :param chain:
         :param sender: The address of the transaction sender.
         :param receiver: The address which will receive the tokens withdrawn. Defaults to the sender.
         :param retries: Override the default retry configuration for this method
@@ -482,7 +498,7 @@ class ERC4626Vaults(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.VaultWithdrawRequest(
+        request = models.CompassAPIBackendModelsVaultsTransactRequestWithdrawVaultWithdrawRequest(
             vault_address=vault_address,
             amount=amount,
             receiver=receiver,
@@ -492,7 +508,7 @@ class ERC4626Vaults(BaseSDK):
 
         req = self._build_request(
             method="POST",
-            path="/v0/vaults/withdraw",
+            path="/v1/vaults/withdraw",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -504,7 +520,11 @@ class ERC4626Vaults(BaseSDK):
             http_headers=http_headers,
             security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
-                request, False, False, "json", models.VaultWithdrawRequest
+                request,
+                False,
+                False,
+                "json",
+                models.CompassAPIBackendModelsVaultsTransactRequestWithdrawVaultWithdrawRequest,
             ),
             timeout_ms=timeout_ms,
         )
@@ -521,7 +541,7 @@ class ERC4626Vaults(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="vaults_withdraw",
+                operation_id="v1_vaults_withdraw",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -532,7 +552,7 @@ class ERC4626Vaults(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TransactionResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res
@@ -547,19 +567,19 @@ class ERC4626Vaults(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def withdraw_async(
+    async def vaults_withdraw_async(
         self,
         *,
         vault_address: str,
         amount: Any,
-        chain: models.Chain,
+        chain: models.CompassAPIBackendModelsVaultsTransactRequestWithdrawVaultWithdrawRequestChain,
         sender: str,
         receiver: OptionalNullable[str] = UNSET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
-    ) -> models.TxResponse:
+    ) -> models.TransactionResponse:
         r"""Withdraw from Vault
 
         Withdraw deposited tokens from a Vault (ERC-4626 Standard).
@@ -570,7 +590,7 @@ class ERC4626Vaults(BaseSDK):
         <Info>
         **Required Allowances**
 
-        In order to make this transaction, token allowances need to be set on the following contracts.
+        In order to make this transaction, token allowances need to be set for the following contracts.
 
         - `<vault address>`
         </Info>
@@ -578,7 +598,7 @@ class ERC4626Vaults(BaseSDK):
 
         :param vault_address: The vault address you are withdrawing from.
         :param amount: The amount of tokens to withdraw from the vault. If set to 'ALL', your total deposited token amount will be withdrawn.
-        :param chain: The chain to use.
+        :param chain:
         :param sender: The address of the transaction sender.
         :param receiver: The address which will receive the tokens withdrawn. Defaults to the sender.
         :param retries: Override the default retry configuration for this method
@@ -596,7 +616,7 @@ class ERC4626Vaults(BaseSDK):
         else:
             base_url = self._get_url(base_url, url_variables)
 
-        request = models.VaultWithdrawRequest(
+        request = models.CompassAPIBackendModelsVaultsTransactRequestWithdrawVaultWithdrawRequest(
             vault_address=vault_address,
             amount=amount,
             receiver=receiver,
@@ -606,7 +626,7 @@ class ERC4626Vaults(BaseSDK):
 
         req = self._build_request_async(
             method="POST",
-            path="/v0/vaults/withdraw",
+            path="/v1/vaults/withdraw",
             base_url=base_url,
             url_variables=url_variables,
             request=request,
@@ -618,7 +638,11 @@ class ERC4626Vaults(BaseSDK):
             http_headers=http_headers,
             security=self.sdk_configuration.security,
             get_serialized_body=lambda: utils.serialize_request_body(
-                request, False, False, "json", models.VaultWithdrawRequest
+                request,
+                False,
+                False,
+                "json",
+                models.CompassAPIBackendModelsVaultsTransactRequestWithdrawVaultWithdrawRequest,
             ),
             timeout_ms=timeout_ms,
         )
@@ -635,7 +659,7 @@ class ERC4626Vaults(BaseSDK):
             hook_ctx=HookContext(
                 config=self.sdk_configuration,
                 base_url=base_url or "",
-                operation_id="vaults_withdraw",
+                operation_id="v1_vaults_withdraw",
                 oauth2_scopes=[],
                 security_source=self.sdk_configuration.security,
             ),
@@ -646,7 +670,7 @@ class ERC4626Vaults(BaseSDK):
 
         response_data: Any = None
         if utils.match_response(http_res, "200", "application/json"):
-            return unmarshal_json_response(models.TxResponse, http_res)
+            return unmarshal_json_response(models.TransactionResponse, http_res)
         if utils.match_response(http_res, "422", "application/json"):
             response_data = unmarshal_json_response(
                 errors.HTTPValidationErrorData, http_res

compass_api_sdk/errors/__init__.py

@@ -2,6 +2,7 @@
 
 from typing import TYPE_CHECKING
 from importlib import import_module
+import builtins
 
 if TYPE_CHECKING:
     from .apierror import APIError
@@ -51,5 +52,5 @@ def __getattr__(attr_name: str) -> object:
 
 
 def __dir__():
-    lazy_attrs = list(_dynamic_imports.keys())
-    return sorted(lazy_attrs)
+    lazy_attrs = builtins.list(_dynamic_imports.keys())
+    return builtins.sorted(lazy_attrs)