compass_api_sdk 0.0.1__py3-none-any.whl → 0.0.2__py3-none-any.whl

compass_api_sdk/uniswap_v3.py

@@ -11,20 +11,14 @@ class UniswapV3(BaseSDK):
     def quote_buy_exactly(
         self,
         *,
+        chain: models.UniswapQuoteBuyExactlyChain = models.UniswapQuoteBuyExactlyChain.ARBITRUM_MAINNET,
+        token_in: models.UniswapQuoteBuyExactlyTokenInToken = models.UniswapQuoteBuyExactlyTokenInToken.USDC,
+        token_out: models.UniswapQuoteBuyExactlyTokenOutToken = models.UniswapQuoteBuyExactlyTokenOutToken.USDT,
         fee: models.UniswapQuoteBuyExactlyFeeEnum = models.UniswapQuoteBuyExactlyFeeEnum.ZERO_DOT_01,
         amount_out: Union[
             models.UniswapQuoteBuyExactlyAmountOut,
             models.UniswapQuoteBuyExactlyAmountOutTypedDict,
         ],
-        chain: Optional[
-            models.UniswapQuoteBuyExactlyChain
-        ] = models.UniswapQuoteBuyExactlyChain.ARBITRUM_MAINNET,
-        token_in: Optional[
-            models.UniswapQuoteBuyExactlyTokenInToken
-        ] = models.UniswapQuoteBuyExactlyTokenInToken.USDC,
-        token_out: Optional[
-            models.UniswapQuoteBuyExactlyTokenOutToken
-        ] = models.UniswapQuoteBuyExactlyTokenOutToken.USDT,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -38,11 +32,11 @@ class UniswapV3(BaseSDK):
         It also provides the resulting price after the transaction. The calculation takes
         into account the current pool state and the specified fee tier.
 
-        :param fee: The transaction fee of a Uniswap pool in bips.  Uniswap supports 4 different fee levels.
-        :param amount_out:
         :param chain: The chain to use.
         :param token_in: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param token_out: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
+        :param fee: The transaction fee of a Uniswap pool in bips.  Uniswap supports 4 different fee levels.
+        :param amount_out:
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -135,20 +129,14 @@ class UniswapV3(BaseSDK):
     async def quote_buy_exactly_async(
         self,
         *,
+        chain: models.UniswapQuoteBuyExactlyChain = models.UniswapQuoteBuyExactlyChain.ARBITRUM_MAINNET,
+        token_in: models.UniswapQuoteBuyExactlyTokenInToken = models.UniswapQuoteBuyExactlyTokenInToken.USDC,
+        token_out: models.UniswapQuoteBuyExactlyTokenOutToken = models.UniswapQuoteBuyExactlyTokenOutToken.USDT,
         fee: models.UniswapQuoteBuyExactlyFeeEnum = models.UniswapQuoteBuyExactlyFeeEnum.ZERO_DOT_01,
         amount_out: Union[
             models.UniswapQuoteBuyExactlyAmountOut,
             models.UniswapQuoteBuyExactlyAmountOutTypedDict,
         ],
-        chain: Optional[
-            models.UniswapQuoteBuyExactlyChain
-        ] = models.UniswapQuoteBuyExactlyChain.ARBITRUM_MAINNET,
-        token_in: Optional[
-            models.UniswapQuoteBuyExactlyTokenInToken
-        ] = models.UniswapQuoteBuyExactlyTokenInToken.USDC,
-        token_out: Optional[
-            models.UniswapQuoteBuyExactlyTokenOutToken
-        ] = models.UniswapQuoteBuyExactlyTokenOutToken.USDT,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -162,11 +150,11 @@ class UniswapV3(BaseSDK):
         It also provides the resulting price after the transaction. The calculation takes
         into account the current pool state and the specified fee tier.
 
-        :param fee: The transaction fee of a Uniswap pool in bips.  Uniswap supports 4 different fee levels.
-        :param amount_out:
         :param chain: The chain to use.
         :param token_in: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param token_out: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
+        :param fee: The transaction fee of a Uniswap pool in bips.  Uniswap supports 4 different fee levels.
+        :param amount_out:
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -259,20 +247,14 @@ class UniswapV3(BaseSDK):
     def quote_sell_exactly(
         self,
         *,
+        chain: models.UniswapQuoteSellExactlyChain = models.UniswapQuoteSellExactlyChain.ARBITRUM_MAINNET,
+        token_in: models.UniswapQuoteSellExactlyTokenInToken = models.UniswapQuoteSellExactlyTokenInToken.USDC,
+        token_out: models.UniswapQuoteSellExactlyTokenOutToken = models.UniswapQuoteSellExactlyTokenOutToken.USDT,
         fee: models.UniswapQuoteSellExactlyFeeEnum = models.UniswapQuoteSellExactlyFeeEnum.ZERO_DOT_01,
         amount_in: Union[
             models.UniswapQuoteSellExactlyAmountIn,
             models.UniswapQuoteSellExactlyAmountInTypedDict,
         ],
-        chain: Optional[
-            models.UniswapQuoteSellExactlyChain
-        ] = models.UniswapQuoteSellExactlyChain.ARBITRUM_MAINNET,
-        token_in: Optional[
-            models.UniswapQuoteSellExactlyTokenInToken
-        ] = models.UniswapQuoteSellExactlyTokenInToken.USDC,
-        token_out: Optional[
-            models.UniswapQuoteSellExactlyTokenOutToken
-        ] = models.UniswapQuoteSellExactlyTokenOutToken.USDT,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -286,11 +268,11 @@ class UniswapV3(BaseSDK):
         It also provides the resulting price after the transaction. The calculation takes
         into account the current pool state and the specified fee tier.
 
-        :param fee: The transaction fee of a Uniswap pool in bips.  Uniswap supports 4 different fee levels.
-        :param amount_in:
         :param chain: The chain to use.
         :param token_in: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param token_out: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
+        :param fee: The transaction fee of a Uniswap pool in bips.  Uniswap supports 4 different fee levels.
+        :param amount_in:
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -383,20 +365,14 @@ class UniswapV3(BaseSDK):
     async def quote_sell_exactly_async(
         self,
         *,
+        chain: models.UniswapQuoteSellExactlyChain = models.UniswapQuoteSellExactlyChain.ARBITRUM_MAINNET,
+        token_in: models.UniswapQuoteSellExactlyTokenInToken = models.UniswapQuoteSellExactlyTokenInToken.USDC,
+        token_out: models.UniswapQuoteSellExactlyTokenOutToken = models.UniswapQuoteSellExactlyTokenOutToken.USDT,
         fee: models.UniswapQuoteSellExactlyFeeEnum = models.UniswapQuoteSellExactlyFeeEnum.ZERO_DOT_01,
         amount_in: Union[
             models.UniswapQuoteSellExactlyAmountIn,
             models.UniswapQuoteSellExactlyAmountInTypedDict,
         ],
-        chain: Optional[
-            models.UniswapQuoteSellExactlyChain
-        ] = models.UniswapQuoteSellExactlyChain.ARBITRUM_MAINNET,
-        token_in: Optional[
-            models.UniswapQuoteSellExactlyTokenInToken
-        ] = models.UniswapQuoteSellExactlyTokenInToken.USDC,
-        token_out: Optional[
-            models.UniswapQuoteSellExactlyTokenOutToken
-        ] = models.UniswapQuoteSellExactlyTokenOutToken.USDT,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -410,11 +386,11 @@ class UniswapV3(BaseSDK):
         It also provides the resulting price after the transaction. The calculation takes
         into account the current pool state and the specified fee tier.
 
-        :param fee: The transaction fee of a Uniswap pool in bips.  Uniswap supports 4 different fee levels.
-        :param amount_in:
         :param chain: The chain to use.
         :param token_in: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param token_out: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
+        :param fee: The transaction fee of a Uniswap pool in bips.  Uniswap supports 4 different fee levels.
+        :param amount_in:
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -507,12 +483,10 @@ class UniswapV3(BaseSDK):
     def pool_price(
         self,
         *,
+        chain: models.UniswapPoolPriceChain = models.UniswapPoolPriceChain.ARBITRUM_MAINNET,
         token_in: models.UniswapPoolPriceTokenInToken = models.UniswapPoolPriceTokenInToken.USDC,
         token_out: models.UniswapPoolPriceTokenOutToken = models.UniswapPoolPriceTokenOutToken.USDT,
         fee: models.UniswapPoolPriceFeeEnum = models.UniswapPoolPriceFeeEnum.ZERO_DOT_01,
-        chain: Optional[
-            models.UniswapPoolPriceChain
-        ] = models.UniswapPoolPriceChain.ARBITRUM_MAINNET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -524,10 +498,10 @@ class UniswapV3(BaseSDK):
 
         The price is calculated based on the current pool state and the specified fee tier.
 
+        :param chain: The chain to use.
         :param token_in: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param token_out: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param fee: The transaction fee of a Uniswap pool in bips.  Uniswap supports 4 different fee levels.
-        :param chain: The chain to use.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -617,12 +591,10 @@ class UniswapV3(BaseSDK):
     async def pool_price_async(
         self,
         *,
+        chain: models.UniswapPoolPriceChain = models.UniswapPoolPriceChain.ARBITRUM_MAINNET,
         token_in: models.UniswapPoolPriceTokenInToken = models.UniswapPoolPriceTokenInToken.USDC,
         token_out: models.UniswapPoolPriceTokenOutToken = models.UniswapPoolPriceTokenOutToken.USDT,
         fee: models.UniswapPoolPriceFeeEnum = models.UniswapPoolPriceFeeEnum.ZERO_DOT_01,
-        chain: Optional[
-            models.UniswapPoolPriceChain
-        ] = models.UniswapPoolPriceChain.ARBITRUM_MAINNET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -634,10 +606,10 @@ class UniswapV3(BaseSDK):
 
         The price is calculated based on the current pool state and the specified fee tier.
 
+        :param chain: The chain to use.
         :param token_in: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param token_out: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
         :param fee: The transaction fee of a Uniswap pool in bips.  Uniswap supports 4 different fee levels.
-        :param chain: The chain to use.
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -727,10 +699,8 @@ class UniswapV3(BaseSDK):
     def liquidity_provision_in_range(
         self,
         *,
+        chain: models.UniswapLiquidityProvisionInRangeChain = models.UniswapLiquidityProvisionInRangeChain.ARBITRUM_MAINNET,
         token_id: int = 4318185,
-        chain: Optional[
-            models.UniswapLiquidityProvisionInRangeChain
-        ] = models.UniswapLiquidityProvisionInRangeChain.ARBITRUM_MAINNET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -747,8 +717,8 @@ class UniswapV3(BaseSDK):
         they are actively participating in the trading activities within the liquidity pool
         and earning trading fees.
 
-        :param token_id:
         :param chain: The chain to use.
+        :param token_id:
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -838,10 +808,8 @@ class UniswapV3(BaseSDK):
     async def liquidity_provision_in_range_async(
         self,
         *,
+        chain: models.UniswapLiquidityProvisionInRangeChain = models.UniswapLiquidityProvisionInRangeChain.ARBITRUM_MAINNET,
         token_id: int = 4318185,
-        chain: Optional[
-            models.UniswapLiquidityProvisionInRangeChain
-        ] = models.UniswapLiquidityProvisionInRangeChain.ARBITRUM_MAINNET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -858,8 +826,8 @@ class UniswapV3(BaseSDK):
         they are actively participating in the trading activities within the liquidity pool
         and earning trading fees.
 
-        :param token_id:
         :param chain: The chain to use.
+        :param token_id:
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -949,9 +917,7 @@ class UniswapV3(BaseSDK):
     def liquidity_provision_positions(
         self,
         *,
-        chain: Optional[
-            models.UniswapLiquidityProvisionPositionsChain
-        ] = models.UniswapLiquidityProvisionPositionsChain.ARBITRUM_MAINNET,
+        chain: models.UniswapLiquidityProvisionPositionsChain = models.UniswapLiquidityProvisionPositionsChain.ARBITRUM_MAINNET,
         user: Optional[str] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -1059,9 +1025,7 @@ class UniswapV3(BaseSDK):
     async def liquidity_provision_positions_async(
         self,
         *,
-        chain: Optional[
-            models.UniswapLiquidityProvisionPositionsChain
-        ] = models.UniswapLiquidityProvisionPositionsChain.ARBITRUM_MAINNET,
+        chain: models.UniswapLiquidityProvisionPositionsChain = models.UniswapLiquidityProvisionPositionsChain.ARBITRUM_MAINNET,
         user: Optional[str] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,

compass_api_sdk/universal.py

@@ -11,9 +11,7 @@ class Universal(BaseSDK):
     def portfolio(
         self,
         *,
-        chain: Optional[
-            models.GenericPortfolioChain
-        ] = models.GenericPortfolioChain.ARBITRUM_MAINNET,
+        chain: models.GenericPortfolioChain = models.GenericPortfolioChain.ARBITRUM_MAINNET,
         user: Optional[str] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -116,9 +114,7 @@ class Universal(BaseSDK):
     async def portfolio_async(
         self,
         *,
-        chain: Optional[
-            models.GenericPortfolioChain
-        ] = models.GenericPortfolioChain.ARBITRUM_MAINNET,
+        chain: models.GenericPortfolioChain = models.GenericPortfolioChain.ARBITRUM_MAINNET,
         user: Optional[str] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -221,9 +217,7 @@ class Universal(BaseSDK):
     def visualize_portfolio(
         self,
         *,
-        chain: Optional[
-            models.GenericVisualizePortfolioChain
-        ] = models.GenericVisualizePortfolioChain.ARBITRUM_MAINNET,
+        chain: models.GenericVisualizePortfolioChain = models.GenericVisualizePortfolioChain.ARBITRUM_MAINNET,
         user: Optional[str] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -327,9 +321,7 @@ class Universal(BaseSDK):
     async def visualize_portfolio_async(
         self,
         *,
-        chain: Optional[
-            models.GenericVisualizePortfolioChain
-        ] = models.GenericVisualizePortfolioChain.ARBITRUM_MAINNET,
+        chain: models.GenericVisualizePortfolioChain = models.GenericVisualizePortfolioChain.ARBITRUM_MAINNET,
         user: Optional[str] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -433,10 +425,8 @@ class Universal(BaseSDK):
     def price_usd(
         self,
         *,
-        chain: Optional[
-            models.GenericPriceUsdChain
-        ] = models.GenericPriceUsdChain.ARBITRUM_MAINNET,
-        token: Optional[models.GenericPriceUsdToken] = models.GenericPriceUsdToken.WBTC,
+        chain: models.GenericPriceUsdChain = models.GenericPriceUsdChain.ARBITRUM_MAINNET,
+        token: models.GenericPriceUsdToken = models.GenericPriceUsdToken.WBTC,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -540,10 +530,8 @@ class Universal(BaseSDK):
     async def price_usd_async(
         self,
         *,
-        chain: Optional[
-            models.GenericPriceUsdChain
-        ] = models.GenericPriceUsdChain.ARBITRUM_MAINNET,
-        token: Optional[models.GenericPriceUsdToken] = models.GenericPriceUsdToken.WBTC,
+        chain: models.GenericPriceUsdChain = models.GenericPriceUsdChain.ARBITRUM_MAINNET,
+        token: models.GenericPriceUsdToken = models.GenericPriceUsdToken.WBTC,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -647,9 +635,7 @@ class Universal(BaseSDK):
     def supported_tokens(
         self,
         *,
-        chain: Optional[
-            models.GenericSupportedTokensChain
-        ] = models.GenericSupportedTokensChain.ARBITRUM_MAINNET,
+        chain: models.GenericSupportedTokensChain = models.GenericSupportedTokensChain.ARBITRUM_MAINNET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -746,9 +732,7 @@ class Universal(BaseSDK):
     async def supported_tokens_async(
         self,
         *,
-        chain: Optional[
-            models.GenericSupportedTokensChain
-        ] = models.GenericSupportedTokensChain.ARBITRUM_MAINNET,
+        chain: models.GenericSupportedTokensChain = models.GenericSupportedTokensChain.ARBITRUM_MAINNET,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -845,11 +829,9 @@ class Universal(BaseSDK):
     def balance(
         self,
         *,
-        chain: Optional[
-            models.GenericBalanceChain
-        ] = models.GenericBalanceChain.ARBITRUM_MAINNET,
+        chain: models.GenericBalanceChain = models.GenericBalanceChain.ARBITRUM_MAINNET,
+        token: models.GenericBalanceToken = models.GenericBalanceToken.USDC,
         user: Optional[str] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
-        token: Optional[models.GenericBalanceToken] = models.GenericBalanceToken.USDC,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -860,8 +842,8 @@ class Universal(BaseSDK):
         Returns the balance of a specific ERC20 token for a given user address.
 
         :param chain: The chain to use.
-        :param user:
         :param token: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
+        :param user:
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -950,11 +932,9 @@ class Universal(BaseSDK):
     async def balance_async(
         self,
         *,
-        chain: Optional[
-            models.GenericBalanceChain
-        ] = models.GenericBalanceChain.ARBITRUM_MAINNET,
+        chain: models.GenericBalanceChain = models.GenericBalanceChain.ARBITRUM_MAINNET,
+        token: models.GenericBalanceToken = models.GenericBalanceToken.USDC,
         user: Optional[str] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
-        token: Optional[models.GenericBalanceToken] = models.GenericBalanceToken.USDC,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -965,8 +945,8 @@ class Universal(BaseSDK):
         Returns the balance of a specific ERC20 token for a given user address.
 
         :param chain: The chain to use.
-        :param user:
         :param token: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
+        :param user:
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -1055,14 +1035,10 @@ class Universal(BaseSDK):
     def allowance(
         self,
         *,
+        chain: models.GenericAllowanceChain = models.GenericAllowanceChain.ARBITRUM_MAINNET,
+        token: models.GenericAllowanceToken = models.GenericAllowanceToken.USDC,
         contract_name: models.GenericAllowanceContractName = models.GenericAllowanceContractName.AAVE_V3_POOL,
-        chain: Optional[
-            models.GenericAllowanceChain
-        ] = models.GenericAllowanceChain.ARBITRUM_MAINNET,
         user: Optional[str] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
-        token: Optional[
-            models.GenericAllowanceToken
-        ] = models.GenericAllowanceToken.USDC,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -1078,10 +1054,10 @@ class Universal(BaseSDK):
         these protocols, ensuring that the protocol has the necessary permissions to manage
         the user's tokens securely and efficiently.
 
-        :param contract_name:
         :param chain: The chain to use.
-        :param user:
         :param token: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
+        :param contract_name:
+        :param user:
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -1171,14 +1147,10 @@ class Universal(BaseSDK):
     async def allowance_async(
         self,
         *,
+        chain: models.GenericAllowanceChain = models.GenericAllowanceChain.ARBITRUM_MAINNET,
+        token: models.GenericAllowanceToken = models.GenericAllowanceToken.USDC,
         contract_name: models.GenericAllowanceContractName = models.GenericAllowanceContractName.AAVE_V3_POOL,
-        chain: Optional[
-            models.GenericAllowanceChain
-        ] = models.GenericAllowanceChain.ARBITRUM_MAINNET,
         user: Optional[str] = "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
-        token: Optional[
-            models.GenericAllowanceToken
-        ] = models.GenericAllowanceToken.USDC,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
         timeout_ms: Optional[int] = None,
@@ -1194,10 +1166,10 @@ class Universal(BaseSDK):
         these protocols, ensuring that the protocol has the necessary permissions to manage
         the user's tokens securely and efficiently.
 
-        :param contract_name:
         :param chain: The chain to use.
-        :param user:
         :param token: A class representing the token.  This class is used to represent the token in the system. Notice individual endpoints' documentation where per chain tokens are presented.
+        :param contract_name:
+        :param user:
         :param retries: Override the default retry configuration for this method
         :param server_url: Override the default server URL for this method
         :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
@@ -1287,9 +1259,7 @@ class Universal(BaseSDK):
     def ens(
         self,
         *,
-        chain: Optional[
-            models.GenericEnsChain
-        ] = models.GenericEnsChain.ETHEREUM_MAINNET,
+        chain: models.GenericEnsChain = models.GenericEnsChain.ETHEREUM_MAINNET,
         ens_name: Optional[str] = "vitalik.eth",
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,
@@ -1392,9 +1362,7 @@ class Universal(BaseSDK):
     async def ens_async(
         self,
         *,
-        chain: Optional[
-            models.GenericEnsChain
-        ] = models.GenericEnsChain.ETHEREUM_MAINNET,
+        chain: models.GenericEnsChain = models.GenericEnsChain.ETHEREUM_MAINNET,
         ens_name: Optional[str] = "vitalik.eth",
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
         server_url: Optional[str] = None,

{compass_api_sdk-0.0.1.dist-info → compass_api_sdk-0.0.2.dist-info}/METADATA

@@ -1,8 +1,8 @@
 Metadata-Version: 2.3
 Name: compass_api_sdk
-Version: 0.0.1
+Version: 0.0.2
 Summary: Python Client SDK Generated by Speakeasy.
-Author: royalnine
+Author: Speakeasy
 Requires-Python: >=3.9
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
@@ -60,10 +60,6 @@ Compass API: Compass Labs DeFi API
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
-> [!TIP]
-> To finish publishing your SDK to PyPI you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
-
-
 > [!NOTE]
 > **Python version upgrade policy**
 >
@@ -76,7 +72,7 @@ The SDK can be installed with either *pip* or *poetry* package managers.
 *PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
 
 ```bash
-pip install git+<UNSET>.git
+pip install compass_api_sdk
 ```
 
 ### Poetry
@@ -84,7 +80,7 @@ pip install git+<UNSET>.git
 *Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.
 
 ```bash
-poetry add git+<UNSET>.git
+poetry add compass_api_sdk
 ```
 
 ### Shell and script usage with `uv`
@@ -136,14 +132,14 @@ Generally, the SDK will work well with most IDEs out of the box. However, when u
 
 ```python
 # Synchronous Example
-from compass_api_sdk import CompassAPISDK
+from compass_api_sdk import CompassAPISDK, models
 
 
 with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.token_price()
+    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
 
     # Handle response
     print(res)
@@ -155,7 +151,7 @@ The same SDK client can also be used to make asychronous requests by importing a
 ```python
 # Asynchronous Example
 import asyncio
-from compass_api_sdk import CompassAPISDK
+from compass_api_sdk import CompassAPISDK, models
 
 async def main():
 
@@ -163,7 +159,7 @@ async def main():
         api_key_auth="<YOUR_API_KEY_HERE>",
     ) as cas_client:
 
-        res = await cas_client.aave_v3.token_price_async()
+        res = await cas_client.aave_v3.token_price_async(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
 
         # Handle response
         print(res)
@@ -185,14 +181,14 @@ This SDK supports the following security scheme globally:
 
 To authenticate with the API the `api_key_auth` parameter must be set when initializing the SDK client instance. For example:
 ```python
-from compass_api_sdk import CompassAPISDK
+from compass_api_sdk import CompassAPISDK, models
 
 
 with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.token_price()
+    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
 
     # Handle response
     print(res)
@@ -287,7 +283,7 @@ Some of the endpoints in this SDK support retries. If you use the SDK without an
 
 To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
 ```python
-from compass_api_sdk import CompassAPISDK
+from compass_api_sdk import CompassAPISDK, models
 from compass_api_sdk.utils import BackoffStrategy, RetryConfig
 
 
@@ -295,7 +291,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.token_price(,
+    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC,
         RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
 
     # Handle response
@@ -305,7 +301,7 @@ with CompassAPISDK(
 
 If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
 ```python
-from compass_api_sdk import CompassAPISDK
+from compass_api_sdk import CompassAPISDK, models
 from compass_api_sdk.utils import BackoffStrategy, RetryConfig
 
 
@@ -314,7 +310,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.token_price()
+    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
 
     # Handle response
     print(res)
@@ -346,7 +342,7 @@ When custom error responses are specified for an operation, the SDK may also rai
 ### Example
 
 ```python
-from compass_api_sdk import CompassAPISDK, errors
+from compass_api_sdk import CompassAPISDK, errors, models
 
 
 with CompassAPISDK(
@@ -355,7 +351,7 @@ with CompassAPISDK(
     res = None
     try:
 
-        res = cas_client.aave_v3.token_price()
+        res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
 
         # Handle response
         print(res)
@@ -376,7 +372,7 @@ with CompassAPISDK(
 
 The default server can be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
 ```python
-from compass_api_sdk import CompassAPISDK
+from compass_api_sdk import CompassAPISDK, models
 
 
 with CompassAPISDK(
@@ -384,7 +380,7 @@ with CompassAPISDK(
     api_key_auth="<YOUR_API_KEY_HERE>",
 ) as cas_client:
 
-    res = cas_client.aave_v3.token_price()
+    res = cas_client.aave_v3.token_price(chain=models.AaveTokenPriceChain.ARBITRUM_MAINNET, token=models.AaveTokenPriceToken.USDC)
 
     # Handle response
     print(res)