@compass-labs/api-sdk 0.5.61 → 0.5.63

package/dist/esm/sdk/{uniswapv3v0.js → uniswapv3.js}

@@ -1,19 +1,19 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
-import { uniswapV3V0LiquidityProvisionIncrease } from "../funcs/uniswapV3V0LiquidityProvisionIncrease.js";
-import { uniswapV3V0LiquidityProvisionInRange } from "../funcs/uniswapV3V0LiquidityProvisionInRange.js";
-import { uniswapV3V0LiquidityProvisionMint } from "../funcs/uniswapV3V0LiquidityProvisionMint.js";
-import { uniswapV3V0LiquidityProvisionPositions } from "../funcs/uniswapV3V0LiquidityProvisionPositions.js";
-import { uniswapV3V0LiquidityProvisionWithdraw } from "../funcs/uniswapV3V0LiquidityProvisionWithdraw.js";
-import { uniswapV3V0PoolPrice } from "../funcs/uniswapV3V0PoolPrice.js";
-import { uniswapV3V0QuoteBuyExactly } from "../funcs/uniswapV3V0QuoteBuyExactly.js";
-import { uniswapV3V0QuoteSellExactly } from "../funcs/uniswapV3V0QuoteSellExactly.js";
-import { uniswapV3V0SwapBuyExactly } from "../funcs/uniswapV3V0SwapBuyExactly.js";
-import { uniswapV3V0SwapSellExactly } from "../funcs/uniswapV3V0SwapSellExactly.js";
+import { uniswapV3LiquidityProvisionIncrease } from "../funcs/uniswapV3LiquidityProvisionIncrease.js";
+import { uniswapV3LiquidityProvisionInRange } from "../funcs/uniswapV3LiquidityProvisionInRange.js";
+import { uniswapV3LiquidityProvisionMint } from "../funcs/uniswapV3LiquidityProvisionMint.js";
+import { uniswapV3LiquidityProvisionPositions } from "../funcs/uniswapV3LiquidityProvisionPositions.js";
+import { uniswapV3LiquidityProvisionWithdraw } from "../funcs/uniswapV3LiquidityProvisionWithdraw.js";
+import { uniswapV3PoolPrice } from "../funcs/uniswapV3PoolPrice.js";
+import { uniswapV3QuoteBuyExactly } from "../funcs/uniswapV3QuoteBuyExactly.js";
+import { uniswapV3QuoteSellExactly } from "../funcs/uniswapV3QuoteSellExactly.js";
+import { uniswapV3SwapBuyExactly } from "../funcs/uniswapV3SwapBuyExactly.js";
+import { uniswapV3SwapSellExactly } from "../funcs/uniswapV3SwapSellExactly.js";
 import { ClientSDK } from "../lib/sdks.js";
 import { unwrapAsync } from "../types/fp.js";
-export class UniswapV3V0 extends ClientSDK {
+export class UniswapV3 extends ClientSDK {
     /**
      * Get Quote - to Specified Amount
      *
@@ -25,7 +25,7 @@ export class UniswapV3V0 extends ClientSDK {
      * into account the current pool state and the specified fee tier.
      */
     async quoteBuyExactly(request, options) {
-        return unwrapAsync(uniswapV3V0QuoteBuyExactly(this, request, options));
+        return unwrapAsync(uniswapV3QuoteBuyExactly(this, request, options));
     }
     /**
      * Get quote - From Specified Amount
@@ -38,7 +38,7 @@ export class UniswapV3V0 extends ClientSDK {
      * into account the current pool state and the specified fee tier.
      */
     async quoteSellExactly(request, options) {
-        return unwrapAsync(uniswapV3V0QuoteSellExactly(this, request, options));
+        return unwrapAsync(uniswapV3QuoteSellExactly(this, request, options));
     }
     /**
      * Pool Price
@@ -49,7 +49,7 @@ export class UniswapV3V0 extends ClientSDK {
      * The price is calculated based on the current pool state and the specified fee tier.
      */
     async poolPrice(request, options) {
-        return unwrapAsync(uniswapV3V0PoolPrice(this, request, options));
+        return unwrapAsync(uniswapV3PoolPrice(this, request, options));
     }
     /**
      * Check if LP is Active.
@@ -65,7 +65,7 @@ export class UniswapV3V0 extends ClientSDK {
      * and earning trading fees.
      */
     async liquidityProvisionInRange(request, options) {
-        return unwrapAsync(uniswapV3V0LiquidityProvisionInRange(this, request, options));
+        return unwrapAsync(uniswapV3LiquidityProvisionInRange(this, request, options));
     }
     /**
      * List LP
@@ -80,7 +80,7 @@ export class UniswapV3V0 extends ClientSDK {
      * activities effectively.
      */
     async liquidityProvisionPositions(request, options) {
-        return unwrapAsync(uniswapV3V0LiquidityProvisionPositions(this, request, options));
+        return unwrapAsync(uniswapV3LiquidityProvisionPositions(this, request, options));
     }
     /**
      * Buy exact amount
@@ -102,7 +102,7 @@ export class UniswapV3V0 extends ClientSDK {
      * </Info>
      */
     async swapBuyExactly(request, options) {
-        return unwrapAsync(uniswapV3V0SwapBuyExactly(this, request, options));
+        return unwrapAsync(uniswapV3SwapBuyExactly(this, request, options));
     }
     /**
      * Sell exact amount
@@ -124,7 +124,7 @@ export class UniswapV3V0 extends ClientSDK {
      * </Info>
      */
     async swapSellExactly(request, options) {
-        return unwrapAsync(uniswapV3V0SwapSellExactly(this, request, options));
+        return unwrapAsync(uniswapV3SwapSellExactly(this, request, options));
     }
     /**
      * Open a new LP position
@@ -148,7 +148,7 @@ export class UniswapV3V0 extends ClientSDK {
      * </Info>
      */
     async liquidityProvisionMint(request, options) {
-        return unwrapAsync(uniswapV3V0LiquidityProvisionMint(this, request, options));
+        return unwrapAsync(uniswapV3LiquidityProvisionMint(this, request, options));
     }
     /**
      * Increase an LP position
@@ -172,7 +172,7 @@ export class UniswapV3V0 extends ClientSDK {
      * </Info>
      */
     async liquidityProvisionIncrease(request, options) {
-        return unwrapAsync(uniswapV3V0LiquidityProvisionIncrease(this, request, options));
+        return unwrapAsync(uniswapV3LiquidityProvisionIncrease(this, request, options));
     }
     /**
      * Withdraw an LP position
@@ -197,7 +197,7 @@ export class UniswapV3V0 extends ClientSDK {
      * </Info>
      */
     async liquidityProvisionWithdraw(request, options) {
-        return unwrapAsync(uniswapV3V0LiquidityProvisionWithdraw(this, request, options));
+        return unwrapAsync(uniswapV3LiquidityProvisionWithdraw(this, request, options));
     }
 }
-//# sourceMappingURL=uniswapv3v0.js.map
+//# sourceMappingURL=uniswapv3.js.map

package/dist/esm/sdk/uniswapv3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uniswapv3.js","sourceRoot":"","sources":["../../../src/sdk/uniswapv3.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,mCAAmC,EAAE,MAAM,iDAAiD,CAAC;AACtG,OAAO,EAAE,kCAAkC,EAAE,MAAM,gDAAgD,CAAC;AACpG,OAAO,EAAE,+BAA+B,EAAE,MAAM,6CAA6C,CAAC;AAC9F,OAAO,EAAE,oCAAoC,EAAE,MAAM,kDAAkD,CAAC;AACxG,OAAO,EAAE,mCAAmC,EAAE,MAAM,iDAAiD,CAAC;AACtG,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,SAAU,SAAQ,SAAS;IACtC;;;;;;;;;OASG;IACH,KAAK,CAAC,eAAe,CACnB,OAAiD,EACjD,OAAwB;QAExB,OAAO,WAAW,CAAC,wBAAwB,CACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAAkD,EAClD,OAAwB;QAExB,OAAO,WAAW,CAAC,yBAAyB,CAC1C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,SAAS,CACb,OAA2C,EAC3C,OAAwB;QAExB,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,yBAAyB,CAC7B,OAA2D,EAC3D,OAAwB;QAExB,OAAO,WAAW,CAAC,kCAAkC,CACnD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,2BAA2B,CAC/B,OAA6D,EAC7D,OAAwB;QAExB,OAAO,WAAW,CAAC,oCAAoC,CACrD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,cAAc,CAClB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,uBAAuB,CACxC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,eAAe,CACnB,OAA6C,EAC7C,OAAwB;QAExB,OAAO,WAAW,CAAC,wBAAwB,CACzC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAwD,EACxD,OAAwB;QAExB,OAAO,WAAW,CAAC,+BAA+B,CAChD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,0BAA0B,CAC9B,OAA4D,EAC5D,OAAwB;QAExB,OAAO,WAAW,CAAC,mCAAmC,CACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,0BAA0B,CAC9B,OAA4D,EAC5D,OAAwB;QAExB,OAAO,WAAW,CAAC,mCAAmC,CACpD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/docs/sdks/pendle/README.md

@@ -13,9 +13,9 @@
 * [sellPt](#sellpt) - Sell Principal Token (PT)
 * [buyYt](#buyyt) - Buy Yield Token (YT)
 * [sellYt](#sellyt) - Sell Yield Token (YT)
+* [addLiquidity](#addliquidity) - Add Liquidity (LP)
+* [removeLiquidity](#removeliquidity) - Remove Liquidity (LP)
 * [redeemYield](#redeemyield) - Redeem Claimable Yield
-* [addLiquidity](#addliquidity) - Add Liquidity
-* [removeLiquidity](#removeliquidity) - Remove Liquidity
 
 ## market
 
@@ -314,7 +314,12 @@ run();
 
 ## buyPt
 
-Buy Principal Token (PT) with market's Underlying Token.
+Buy market's Principal Token (PT) for fixed yield.
+
+PT is bought with a token of the user's choice.
+
+An appropriate allowance for the Pendle Router on the token_in contract must be set
+beforehand.
 <Info>
   **Required Allowances**
 
@@ -406,7 +411,12 @@ run();
 
 ## sellPt
 
-Sell Principal Token (PT) for the market's Underlying Token.
+Sell Principal Token (PT) to redeem the fixed yield you have earned thus far.
+
+PT is sold for a token of the user's choice.
+
+An appropriate allowance for the Pendle Router on the market's PT token contract
+must be set beforehand.
 <Info>
   **Required Allowances**
 
@@ -498,7 +508,12 @@ run();
 
 ## buyYt
 
-Buy Yield Token (YT) with market's Underlying Token.
+Buy Yield Token (YT) to go long yield and earn variable yield.
+
+YT is bought with a token of the user's choice.
+
+An appropriate allowance for the Pendle Router on the token_in contract must be set
+beforehand.
 <Info>
   **Required Allowances**
 
@@ -590,7 +605,15 @@ run();
 
 ## sellYt
 
-Sell Yield Token (YT) for the market's Underlying Token.
+Sell Yield Token (YT) to stop earning variable yield.
+
+YT is sold for a token of the user's choice.
+
+An appropriate allowance for the Pendle Router on the market's YT token contract
+must be set beforehand.
+
+Make sure to redeem yield earned thus far by calling the 'Redeem Claimable Yield'
+before selling YT.
 <Info>
   **Required Allowances**
 
@@ -680,9 +703,17 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
-## redeemYield
+## addLiquidity
 
-Redeem claimable yield from the market's associated Yield Token (YT).
+Add liquidity to a Pendle Market to earn yield.
+
+Liquidity is added to the market with a token of the user's choice.
+
+Representation of the liquidity provided is in the form of market's Liquidity
+Provider Token (LP) received by the user.
+
+An appropriate allowance for the Pendle Router on the token_in contract must be set
+beforehand.
 <Info>
   **Required Allowances**
 
@@ -694,7 +725,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" -->
+<!-- UsageSnippet language="typescript" operationID="pendle_add_liquidity" method="post" path="/v0/pendle/add_liquidity" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -703,8 +734,11 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.pendle.redeemYield({
+  const result = await compassApiSDK.pendle.addLiquidity({
     marketAddress: "0x08a152834de126d2ef83d612ff36e4523fd0017f",
+    tokenIn: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
+    amountIn: 1.5,
+    maxSlippagePercent: 0.5,
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
@@ -721,7 +755,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
-import { pendleRedeemYield } from "@compass-labs/api-sdk/funcs/pendleRedeemYield.js";
+import { pendleAddLiquidity } from "@compass-labs/api-sdk/funcs/pendleAddLiquidity.js";
 
 // Use `CompassApiSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -730,8 +764,11 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await pendleRedeemYield(compassApiSDK, {
+  const res = await pendleAddLiquidity(compassApiSDK, {
     marketAddress: "0x08a152834de126d2ef83d612ff36e4523fd0017f",
+    tokenIn: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
+    amountIn: 1.5,
+    maxSlippagePercent: 0.5,
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
@@ -739,7 +776,7 @@ async function run() {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("pendleRedeemYield failed:", res.error);
+    console.log("pendleAddLiquidity failed:", res.error);
   }
 }
 
@@ -750,7 +787,7 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.PendleRedeemYieldRequest](../../models/components/pendleredeemyieldrequest.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.PendleAddLiquidityRequest](../../models/components/pendleaddliquidityrequest.md)                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
@@ -766,12 +803,14 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
-## addLiquidity
+## removeLiquidity
 
-Add liquidity to a Pendle Market to earn yield.
+Remove liquidity from a Pendle Market.
+
+Liquidity is removed from the market into a token of the user's choice.
 
-Liquidity is added in the form of the market's Underlying Token. Representation of
-the liquidity received is the market's Liquidity Provider Token (LP).
+ An appropriate allowance for the Pendle Router on the market contract (LP) must be
+set beforehand.
 <Info>
   **Required Allowances**
 
@@ -783,7 +822,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" -->
+<!-- UsageSnippet language="typescript" operationID="pendle_remove_liquidity" method="post" path="/v0/pendle/remove_liquidity" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -792,9 +831,9 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.pendle.addLiquidity({
+  const result = await compassApiSDK.pendle.removeLiquidity({
     marketAddress: "0x08a152834de126d2ef83d612ff36e4523fd0017f",
-    tokenIn: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
+    tokenOut: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
     amountIn: 1.5,
     maxSlippagePercent: 0.5,
     chain: "ethereum:mainnet",
@@ -813,7 +852,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
-import { pendleAddLiquidity } from "@compass-labs/api-sdk/funcs/pendleAddLiquidity.js";
+import { pendleRemoveLiquidity } from "@compass-labs/api-sdk/funcs/pendleRemoveLiquidity.js";
 
 // Use `CompassApiSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -822,9 +861,9 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await pendleAddLiquidity(compassApiSDK, {
+  const res = await pendleRemoveLiquidity(compassApiSDK, {
     marketAddress: "0x08a152834de126d2ef83d612ff36e4523fd0017f",
-    tokenIn: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
+    tokenOut: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
     amountIn: 1.5,
     maxSlippagePercent: 0.5,
     chain: "ethereum:mainnet",
@@ -834,7 +873,7 @@ async function run() {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("pendleAddLiquidity failed:", res.error);
+    console.log("pendleRemoveLiquidity failed:", res.error);
   }
 }
 
@@ -845,7 +884,7 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.PendleAddLiquidityRequest](../../models/components/pendleaddliquidityrequest.md)                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.PendleRemoveLiquidityRequest](../../models/components/pendleremoveliquidityrequest.md)                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
@@ -861,13 +900,9 @@ run();
 | errors.HTTPValidationError | 422                        | application/json           |
 | errors.APIError            | 4XX, 5XX                   | \*/\*                      |
 
-## removeLiquidity
-
-Remove liquidity from a Pendle Market.
+## redeemYield
 
-Liquidity is removed in the form of the market's Liquidity Provider Token (LP) into
-the market's Underlying Token. An appropriate allowance for the Pendle Router on the
-market contract must be set beforehand
+Redeem claimable yield from the market's associated Yield Token (YT).
 <Info>
   **Required Allowances**
 
@@ -879,7 +914,7 @@ market contract must be set beforehand
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="pendle_remove_liquidity" method="post" path="/v0/pendle/remove_liquidity" -->
+<!-- UsageSnippet language="typescript" operationID="pendle_redeem_yield" method="post" path="/v0/pendle/redeem_yield" -->
 ```typescript
 import { CompassApiSDK } from "@compass-labs/api-sdk";
 
@@ -888,11 +923,8 @@ const compassApiSDK = new CompassApiSDK({
 });
 
 async function run() {
-  const result = await compassApiSDK.pendle.removeLiquidity({
+  const result = await compassApiSDK.pendle.redeemYield({
     marketAddress: "0x08a152834de126d2ef83d612ff36e4523fd0017f",
-    tokenOut: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
-    amountIn: 1.5,
-    maxSlippagePercent: 0.5,
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
@@ -909,7 +941,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
-import { pendleRemoveLiquidity } from "@compass-labs/api-sdk/funcs/pendleRemoveLiquidity.js";
+import { pendleRedeemYield } from "@compass-labs/api-sdk/funcs/pendleRedeemYield.js";
 
 // Use `CompassApiSDKCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -918,11 +950,8 @@ const compassApiSDK = new CompassApiSDKCore({
 });
 
 async function run() {
-  const res = await pendleRemoveLiquidity(compassApiSDK, {
+  const res = await pendleRedeemYield(compassApiSDK, {
     marketAddress: "0x08a152834de126d2ef83d612ff36e4523fd0017f",
-    tokenOut: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831",
-    amountIn: 1.5,
-    maxSlippagePercent: 0.5,
     chain: "ethereum:mainnet",
     sender: "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
   });
@@ -930,7 +959,7 @@ async function run() {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("pendleRemoveLiquidity failed:", res.error);
+    console.log("pendleRedeemYield failed:", res.error);
   }
 }
 
@@ -941,7 +970,7 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.PendleRemoveLiquidityRequest](../../models/components/pendleremoveliquidityrequest.md)                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.PendleRedeemYieldRequest](../../models/components/pendleredeemyieldrequest.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |