@compass-labs/api-sdk 0.5.8 → 0.5.9

package/README.md

@@ -262,13 +262,15 @@ run();
 
 * [position](docs/sdks/pendle/README.md#position) - Check User's Market Position
 * [positions](docs/sdks/pendle/README.md#positions) - List User's Market Positions
-* [markets](docs/sdks/pendle/README.md#markets) - List Market Data
 * [market](docs/sdks/pendle/README.md#market) - Get Market Data
+* [markets](docs/sdks/pendle/README.md#markets) - List Market Data
 * [buyPt](docs/sdks/pendle/README.md#buypt) - Buy Principal Token (PT)
 * [sellPt](docs/sdks/pendle/README.md#sellpt) - Sell Principal Token (PT)
 * [buyYt](docs/sdks/pendle/README.md#buyyt) - Buy Yield Token (YT)
 * [sellYt](docs/sdks/pendle/README.md#sellyt) - Sell Yield Token (YT)
 * [redeemYield](docs/sdks/pendle/README.md#redeemyield) - Redeem Claimable Yield
+* [addLiquidity](docs/sdks/pendle/README.md#addliquidity) - Add Liquidity
+* [removeLiquidity](docs/sdks/pendle/README.md#removeliquidity) - Remove Liquidity
 
 ### [sky](docs/sdks/sky/README.md)
 
@@ -317,7 +319,7 @@ run();
 * [ens](docs/sdks/universal/README.md#ens) - Resolve ENS
 * [wrapEth](docs/sdks/universal/README.md#wrapeth) - Wrap ETH
 * [unwrapWeth](docs/sdks/universal/README.md#unwrapweth) - Unwrap WETH
-* [allowanceSet](docs/sdks/universal/README.md#allowanceset) - Set Allowance (symbol)
+* [allowanceSet](docs/sdks/universal/README.md#allowanceset) - Set Allowance
 
 </details>
 <!-- End Available Resources and Operations [operations] -->
@@ -371,6 +373,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`morphoVaults`](docs/sdks/morpho/README.md#vaults) - Get Vaults
 - [`morphoWithdraw`](docs/sdks/morpho/README.md#withdraw) - Withdraw from Vault
 - [`morphoWithdrawCollateral`](docs/sdks/morpho/README.md#withdrawcollateral) - Withdraw Collateral from Market
+- [`pendleAddLiquidity`](docs/sdks/pendle/README.md#addliquidity) - Add Liquidity
 - [`pendleBuyPt`](docs/sdks/pendle/README.md#buypt) - Buy Principal Token (PT)
 - [`pendleBuyYt`](docs/sdks/pendle/README.md#buyyt) - Buy Yield Token (YT)
 - [`pendleMarket`](docs/sdks/pendle/README.md#market) - Get Market Data
@@ -378,6 +381,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`pendlePosition`](docs/sdks/pendle/README.md#position) - Check User's Market Position
 - [`pendlePositions`](docs/sdks/pendle/README.md#positions) - List User's Market Positions
 - [`pendleRedeemYield`](docs/sdks/pendle/README.md#redeemyield) - Redeem Claimable Yield
+- [`pendleRemoveLiquidity`](docs/sdks/pendle/README.md#removeliquidity) - Remove Liquidity
 - [`pendleSellPt`](docs/sdks/pendle/README.md#sellpt) - Sell Principal Token (PT)
 - [`pendleSellYt`](docs/sdks/pendle/README.md#sellyt) - Sell Yield Token (YT)
 - [`skyBuy`](docs/sdks/sky/README.md#buy) - Buy USDS
@@ -404,7 +408,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`uniswapV3SwapBuyExactly`](docs/sdks/uniswapv3/README.md#swapbuyexactly) - Buy exact amount
 - [`uniswapV3SwapSellExactly`](docs/sdks/uniswapv3/README.md#swapsellexactly) - Sell exact amount
 - [`universalAllowance`](docs/sdks/universal/README.md#allowance) - Get allowance - Protocol
-- [`universalAllowanceSet`](docs/sdks/universal/README.md#allowanceset) - Set Allowance (symbol)
+- [`universalAllowanceSet`](docs/sdks/universal/README.md#allowanceset) - Set Allowance
 - [`universalEns`](docs/sdks/universal/README.md#ens) - Resolve ENS
 - [`universalPortfolio`](docs/sdks/universal/README.md#portfolio) - List user portfolio
 - [`universalSupportedTokens`](docs/sdks/universal/README.md#supportedtokens) - List supported tokens
@@ -481,16 +485,15 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-This table shows properties which are common on error classes. For full details see [error classes](#error-classes).
+[`CompassAPISDKError`](./src/models/errors/compassapisdkerror.ts) is the base class for all HTTP error responses. It has the following properties:
 
 | Property            | Type       | Description                                                                             |
 | ------------------- | ---------- | --------------------------------------------------------------------------------------- |
-| `error.name`        | `string`   | Error class name eg `APIError`                                                          |
 | `error.message`     | `string`   | Error message                                                                           |
-| `error.statusCode`  | `number`   | HTTP status code eg `404`                                                               |
-| `error.contentType` | `string`   | HTTP content type eg `application/json`                                                 |
+| `error.statusCode`  | `number`   | HTTP response status code eg `404`                                                      |
+| `error.headers`     | `Headers`  | HTTP response headers                                                                   |
 | `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |
-| `error.rawResponse` | `Response` | Raw HTTP response. Access to headers and more.                                          |
+| `error.rawResponse` | `Response` | Raw HTTP response                                                                       |
 | `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
 
 ### Example
@@ -508,18 +511,17 @@ async function run() {
 
     console.log(result);
   } catch (error) {
-    // Depending on the method different errors may be thrown
-    if (error instanceof errors.HTTPValidationError) {
-      console.log(error.message);
-      console.log(error.data$.detail); // ValidationError[]
-    }
-
-    // Fallback error class, if no other more specific error class is matched
-    if (error instanceof errors.APIError) {
+    // The base class for HTTP error responses
+    if (error instanceof errors.CompassAPISDKError) {
       console.log(error.message);
       console.log(error.statusCode);
       console.log(error.body);
-      console.log(error.rawResponse.headers);
+      console.log(error.headers);
+
+      // Depending on the method different errors may be thrown
+      if (error instanceof errors.HTTPValidationError) {
+        console.log(error.data$.detail); // ValidationError[]
+      }
     }
   }
 }
@@ -529,15 +531,26 @@ run();
 ```
 
 ### Error Classes
-* [`HTTPValidationError`](docs/models/errors/httpvalidationerror.md): Validation Error. Status code `422`.
-* `APIError`: The fallback error class, if no other more specific error class is matched.
-* `SDKValidationError`: Type mismatch between the data returned from the server and the structure expected by the SDK. This can also be thrown for invalid method arguments. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
-* Network errors:
-    * `ConnectionError`: HTTP client was unable to make a request to a server.
-    * `RequestTimeoutError`: HTTP request timed out due to an AbortSignal signal.
-    * `RequestAbortedError`: HTTP request was aborted by the client.
-    * `InvalidRequestError`: Any input used to create a request is invalid.
-    * `UnexpectedClientError`: Unrecognised or unexpected error.
+**Primary errors:**
+* [`CompassAPISDKError`](./src/models/errors/compassapisdkerror.ts): The base class for HTTP error responses.
+  * [`HTTPValidationError`](docs/models/errors/httpvalidationerror.md): Validation Error. Status code `422`.
+
+<details><summary>Less common errors (6)</summary>
+
+<br />
+
+**Network errors:**
+* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
+* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
+* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
+* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
+* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
+
+
+**Inherit from [`CompassAPISDKError`](./src/models/errors/compassapisdkerror.ts)**:
+* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
+
+</details>
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->