@compass-labs/api-sdk 0.5.59 → 0.5.61

package/docs/sdks/morpho/README.md

@@ -28,6 +28,7 @@ exchange value increasing over time.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="morpho_vaults" method="get" path="/v0/morpho/vaults" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -99,6 +100,7 @@ The user position is only included if 'user_address' parameter is included.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="morpho_vault" method="get" path="/v0/morpho/vault" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -171,6 +173,7 @@ can be used as collateral.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="morpho_markets" method="get" path="/v0/morpho/markets" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -249,6 +252,7 @@ Including:
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="morpho_market" method="get" path="/v0/morpho/market" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -319,6 +323,7 @@ market.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="morpho_market_position" method="get" path="/v0/morpho/market_position" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -391,6 +396,7 @@ and markets.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="morpho_user_position" method="get" path="/v0/morpho/user_position" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -470,7 +476,7 @@ state at any time, and withdraw their liquidity at their discretion.
 <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-contract-address>`
 </Info>
@@ -478,6 +484,7 @@ state at any time, and withdraw their liquidity at their discretion.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="morpho_deposit" method="post" path="/v0/morpho/deposit" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -567,14 +574,15 @@ state at any time, and withdraw their liquidity at their discretion.
 <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.
 
- - `<token address>`
+ - `<vault-contract-address>`
 </Info>
 
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="morpho_withdraw" method="post" path="/v0/morpho/withdraw" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -659,7 +667,7 @@ as long as the blockchain it is deployed on is live.
 <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.
 
  - `Morpho`
 </Info>
@@ -667,6 +675,7 @@ as long as the blockchain it is deployed on is live.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="morpho_supply_collateral" method="post" path="/v0/morpho/supply_collateral" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -751,7 +760,7 @@ as long as the blockchain it is deployed on is live.
 <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.
 
  - `Morpho`
 </Info>
@@ -759,6 +768,7 @@ as long as the blockchain it is deployed on is live.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="morpho_withdraw_collateral" method="post" path="/v0/morpho/withdraw_collateral" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -846,7 +856,7 @@ as long as the blockchain it is deployed on is live.
 <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.
 
  - `Morpho`
 </Info>
@@ -854,6 +864,7 @@ as long as the blockchain it is deployed on is live.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="morpho_borrow" method="post" path="/v0/morpho/borrow" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -938,7 +949,7 @@ as long as the blockchain it is deployed on is live.
 <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.
 
  - `Morpho`
 </Info>
@@ -946,6 +957,7 @@ as long as the blockchain it is deployed on is live.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="morpho_repay" method="post" path="/v0/morpho/repay" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 

package/docs/sdks/pendle/README.md

@@ -25,6 +25,7 @@ The user position is only included if 'user_address' parameter is included.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="pendle_market" method="get" path="/v0/pendle/market" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -98,6 +99,7 @@ List the user's SY, PT, YT and LP positions for all markets on a given chain.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="pendle_positions" method="get" path="/v0/pendle/positions" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -167,6 +169,7 @@ Get a list of active markets.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="pendle_markets" method="get" path="/v0/pendle/markets" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -241,6 +244,7 @@ For `SELL`, `amount` is the quantity of `token_type` to sell, and the quote retu
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="pendle_quote" method="get" path="/v0/pendle/quote" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -314,7 +318,7 @@ Buy Principal Token (PT) with market's Underlying Token.
 <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.
 
  - `PendleRouter`
 </Info>
@@ -322,6 +326,7 @@ Buy Principal Token (PT) with market's Underlying Token.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="pendle_buy_pt" method="post" path="/v0/pendle/buy_pt" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -405,7 +410,7 @@ Sell Principal Token (PT) for the market's Underlying Token.
 <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.
 
  - `PendleRouter`
 </Info>
@@ -413,6 +418,7 @@ Sell Principal Token (PT) for the market's Underlying Token.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="pendle_sell_pt" method="post" path="/v0/pendle/sell_pt" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -496,7 +502,7 @@ Buy Yield Token (YT) with market's Underlying Token.
 <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.
 
  - `PendleRouter`
 </Info>
@@ -504,6 +510,7 @@ Buy Yield Token (YT) with market's Underlying Token.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="pendle_buy_yt" method="post" path="/v0/pendle/buy_yt" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -587,7 +594,7 @@ Sell Yield Token (YT) for the market's Underlying Token.
 <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.
 
  - `PendleRouter`
 </Info>
@@ -595,6 +602,7 @@ Sell Yield Token (YT) for the market's Underlying Token.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="pendle_sell_yt" method="post" path="/v0/pendle/sell_yt" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -678,7 +686,7 @@ Redeem claimable yield from the market's associated Yield Token (YT).
 <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.
 
  - `PendleRouter`
 </Info>
@@ -686,6 +694,7 @@ Redeem claimable yield from the market's associated Yield Token (YT).
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="pendle_redeem_yield" method="post" path="/v0/pendle/redeem_yield" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -766,7 +775,7 @@ the liquidity received is the market's Liquidity Provider Token (LP).
 <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.
 
  - `PendleRouter`
 </Info>
@@ -774,6 +783,7 @@ the liquidity received is the market's Liquidity Provider Token (LP).
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="pendle_add_liquidity" method="post" path="/v0/pendle/add_liquidity" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -861,7 +871,7 @@ market contract must be set beforehand
 <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.
 
  - `PendleRouter`
 </Info>
@@ -869,6 +879,7 @@ market contract must be set beforehand
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="pendle_remove_liquidity" method="post" path="/v0/pendle/remove_liquidity" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 

package/docs/sdks/sky/README.md

@@ -17,6 +17,7 @@ Check the USDS overall position.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="sky_position" method="get" path="/v0/sky/position" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -92,7 +93,7 @@ If buying with USDC, user will need to set an allowance on the USDC contract for
 <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.
 
  - `SkyUsdcUsdsConverter`
 </Info>
@@ -100,6 +101,7 @@ If buying with USDC, user will need to set an allowance on the USDC contract for
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="sky_buy" method="post" path="/v0/sky/buy" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -185,7 +187,7 @@ If swapping to USDC, user will need to set an allowance on the USDS contract for
 <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.
 
  - `SkyUsdcUsdsConverter`
 </Info>
@@ -193,6 +195,7 @@ If swapping to USDC, user will need to set an allowance on the USDS contract for
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="sky_sell" method="post" path="/v0/sky/sell" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -274,7 +277,7 @@ There are no fees.
 <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.
 
  - `SkyUsdsVault`
 </Info>
@@ -282,6 +285,7 @@ There are no fees.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="sky_deposit" method="post" path="/v0/sky/deposit" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -361,7 +365,7 @@ There are no fees.
 <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.
 
  - `SkyUsdcUsdsConverter`
  - `SkyUsdsVault`
@@ -370,6 +374,7 @@ There are no fees.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="sky_withdraw" method="post" path="/v0/sky/withdraw" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 

package/docs/sdks/smartaccount/README.md

@@ -13,6 +13,7 @@ Generate a list of user operations for smart account batching.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="smart_account_batched_user_operations" method="post" path="/v0/smart_account/batched_user_operations" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 

package/docs/sdks/swap/README.md

@@ -13,7 +13,7 @@ Swap between two tokens using Odos Smart Order Routing.
 <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.
 
  - `OdosRouter`
 </Info>
@@ -21,6 +21,7 @@ Swap between two tokens using Odos Smart Order Routing.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="swap_odos" method="post" path="/v0/swap/odos" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 

package/docs/sdks/token/README.md

@@ -16,6 +16,7 @@ This endpoint retrieves the address for a token supported by us.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="token_address" method="get" path="/v0/token/address/get" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -89,6 +90,7 @@ with the update frequency of the oracle.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="token_price" method="get" path="/v0/token/price/get" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -162,6 +164,7 @@ Returns the balance of a specific ERC20 token for a given user address.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="token_balance" method="get" path="/v0/token/balance/get" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -235,6 +238,7 @@ Sends native ETH or ERC20 tokens from the sender's address to another address.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="token_transfer" method="post" path="/v0/token/transfer" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 

package/docs/sdks/transactionbundler/README.md

@@ -20,6 +20,7 @@ transaction uniqueness and proper network targeting.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="transaction_bundler_authorization" method="post" path="/v0/transaction_bundler/authorization" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -101,6 +102,7 @@ prevent replay attacks.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="transaction_bundler_execute" method="post" path="/v0/transaction_bundler/execute" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -222,6 +224,7 @@ The transaction must be authorized using the /authorization endpoint to prevent
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="transaction_bundler_aave_loop" method="post" path="/v0/transaction_bundler/aave/loop" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -247,6 +250,7 @@ async function run() {
     multiplier: "2.5",
     maxSlippagePercent: 2.5,
     loanToValue: 20.5,
+    isAccountAbstraction: true,
   });
 
   console.log(result);
@@ -287,6 +291,7 @@ async function run() {
     multiplier: "2.5",
     maxSlippagePercent: 2.5,
     loanToValue: 20.5,
+    isAccountAbstraction: true,
   });
   if (res.ok) {
     const { value: result } = res;
@@ -310,7 +315,7 @@ run();
 
 ### Response
 
-**Promise\<[components.UnsignedMulticallTransaction](../../models/components/unsignedmulticalltransaction.md)\>**
+**Promise\<[operations.ResponseTransactionBundlerAaveLoop](../../models/operations/responsetransactionbundleraaveloop.md)\>**
 
 ### Errors
 

package/docs/sdks/uniswapv3v0/README.md

@@ -26,6 +26,7 @@ into account the current pool state and the specified fee tier.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="uniswap_quote_buy_exactly" method="get" path="/v0/uniswap/quote/buy_exactly/get" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -103,6 +104,7 @@ into account the current pool state and the specified fee tier.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="uniswap_quote_sell_exactly" method="get" path="/v0/uniswap/quote/sell_exactly/get" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -178,6 +180,7 @@ The price is calculated based on the current pool state and the specified fee ti
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="uniswap_pool_price" method="get" path="/v0/uniswap/pool_price/get" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -254,6 +257,7 @@ and earning trading fees.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="uniswap_liquidity_provision_in_range" method="get" path="/v0/uniswap/liquidity_provision/in_range/get" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -329,6 +333,7 @@ activities effectively.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="uniswap_liquidity_provision_positions" method="get" path="/v0/uniswap/liquidity_provision/positions/get" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -404,7 +409,7 @@ needs to be wrapped, the appropriate amount will be wrapped automatically.
 <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.
 
  - `UniswapV3Router`
 </Info>
@@ -412,6 +417,7 @@ needs to be wrapped, the appropriate amount will be wrapped automatically.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="uniswap_swap_buy_exactly" method="post" path="/v0/uniswap/swap/buy_exactly" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -505,7 +511,7 @@ wrapped, the appropriate amount will be wrapped automatically.
 <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.
 
  - `UniswapV3Router`
 </Info>
@@ -513,6 +519,7 @@ wrapped, the appropriate amount will be wrapped automatically.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="uniswap_swap_sell_exactly" method="post" path="/v0/uniswap/swap/sell_exactly" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -608,7 +615,7 @@ needed for the minting process.
 <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.
 
  - `UniswapV3NFTPositionManager`
 </Info>
@@ -616,6 +623,7 @@ needed for the minting process.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="uniswap_liquidity_provision_mint" method="post" path="/v0/uniswap/liquidity_provision/mint" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -719,7 +727,7 @@ process.
 <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.
 
  - `AerodromeSlipstreamRouter`
 </Info>
@@ -727,6 +735,7 @@ process.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="uniswap_liquidity_provision_increase" method="post" path="/v0/uniswap/liquidity_provision/increase" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -821,7 +830,7 @@ before initiating a withdrawal to avoid potential issues or penalties.
 <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.
 
  - `UniswapV3NFTPositionManager`
 </Info>
@@ -829,6 +838,7 @@ before initiating a withdrawal to avoid potential issues or penalties.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="uniswap_liquidity_provision_withdraw" method="post" path="/v0/uniswap/liquidity_provision/withdraw" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 

package/docs/sdks/uniswapv3v1/README.md

@@ -19,7 +19,7 @@ wrapped, the appropriate amount will be wrapped automatically.
 <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.
 
  - `UniswapV3Router`
 </Info>
@@ -27,6 +27,7 @@ wrapped, the appropriate amount will be wrapped automatically.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="v1_uniswap_swap_buy_exactly" method="post" path="/v1/uniswap/swap/buy_exactly" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 

package/docs/sdks/universal/README.md

@@ -24,6 +24,7 @@ balances, including their respective values and quantities.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="generic_portfolio" method="get" path="/v0/generic/portfolio/get" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -97,6 +98,7 @@ USD.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="generic_visualize_portfolio" method="get" path="/v0/generic/visualize_portfolio/get" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -166,6 +168,7 @@ Get the list of supported tokens on a chain by the Compass API.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="generic_supported_tokens" method="get" path="/v0/generic/supported_tokens/get" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -235,6 +238,7 @@ Get the list of supported chains by the Compass API.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="generic_supported_chains" method="get" path="/v0/generic/supported_chains/get" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -310,6 +314,7 @@ the user's tokens securely and efficiently.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="generic_allowance" method="get" path="/v0/generic/allowance/get" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -388,6 +393,7 @@ query the actual ethereum wallet address behind the ENS name.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="generic_ens" method="get" path="/v0/generic/ens/get" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -458,6 +464,7 @@ it to be traded on DeFi protocols.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="generic_wrap_eth" method="post" path="/v0/generic/wrap_eth" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -536,6 +543,7 @@ can be used for gas and other native purposes.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="generic_unwrap_weth" method="post" path="/v0/generic/unwrap_weth" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -620,6 +628,7 @@ within the DeFi ecosystem.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="generic_allowance_set" method="post" path="/v0/generic/allowance/set" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";