@compass-labs/api-sdk 2.2.18-rc.2 → 2.2.18

package/dist/esm/sdk/credit.d.ts

@@ -1,86 +0,0 @@
-import { ClientSDK, RequestOptions } from "../lib/sdks.js";
-import * as components from "../models/components/index.js";
-import * as operations from "../models/operations/index.js";
-export declare class Credit extends ClientSDK {
-    /**
-     * List credit positions
-     *
-     * @remarks
-     * List all Credit positions for a given owner.
-     *
-     * Returns a unified list of positions (collateral and debt) and an account summary
-     * with health factor and LTV. Each position includes event history.
-     */
-    creditPositions(request: operations.V2CreditPositionsRequest, options?: RequestOptions): Promise<components.CreditPositionsResponse>;
-    /**
-     * Create credit account
-     *
-     * @remarks
-     * Create a Credit Account for a wallet address.
-     *
-     * Before using credit features, the owner must create a Credit Account. Each wallet address has one Credit Account per chain.
-     *
-     * Returns an unsigned transaction to create the account. The `sender` signs and broadcasts this transaction.
-     *
-     * **If owner pays gas:** Set `sender` to the owner's address.
-     *
-     * **If someone else pays gas:** Set `sender` to the wallet that will sign and broadcast the transaction on behalf of the owner.
-     */
-    creditCreateAccount(request: components.CreateCreditAccountRequest, options?: RequestOptions): Promise<components.CreateCreditAccountResponse>;
-    /**
-     * Borrow against collateral
-     *
-     * @remarks
-     * Borrow an asset from Aave using a Credit Account.
-     *
-     * Bundles an optional swap, collateral supply, and borrow into a single atomic Safe transaction.
-     *
-     * - If `token_in` equals `collateral_token`, the tokens are supplied directly as collateral.
-     * - If `token_in` differs from `collateral_token`, a swap is performed first via 1inch.
-     *
-     * The Credit Account must already be created via `/v2/credit/create_account` and funded with `token_in`.
-     */
-    creditBorrow(request: components.CreditBorrowRequest, options?: RequestOptions): Promise<components.CreditBorrowResponse>;
-    /**
-     * Get Permit2 signature data for Credit Account transfer
-     *
-     * @remarks
-     * Generate Permit2 EIP-712 typed data for transferring tokens from the owner's EOA
-     * to a Credit Account.
-     *
-     * The owner signs the returned EIP-712 data, then includes the signature in a `/v2/credit/borrow`
-     * or `/v2/credit/repay` request to atomically pull tokens from their EOA as part of the bundle.
-     *
-     * **Flow:**
-     * 1. Call this endpoint to get the Permit2 typed data
-     * 2. Sign the typed data with the owner's wallet
-     * 3. Call `/v2/credit/borrow` or `/v2/credit/repay` with the `permit2_signature`, `permit2_nonce`, and `permit2_deadline` fields
-     */
-    creditTransfer(request: components.CreditTransferRequest, options?: RequestOptions): Promise<components.CreditTransferResponse>;
-    /**
-     * Repay debt and withdraw collateral
-     *
-     * @remarks
-     * Repay an Aave debt and withdraw collateral from a Credit Account.
-     *
-     * Bundles repayment, collateral withdrawal, and an optional swap into a single atomic Safe transaction.
-     *
-     * - If `token_out` is None or equals `withdraw_token`, the withdrawn collateral is kept as-is.
-     * - If `token_out` differs from `withdraw_token`, a swap is performed after withdrawal via 1inch.
-     *
-     * The Credit Account must already have a borrow position created via `/v2/credit/borrow`.
-     * The repay_token must be available in the Credit Account (or pulled from EOA via Permit2).
-     */
-    creditRepay(request: components.CreditRepayRequest, options?: RequestOptions): Promise<components.CreditRepayResponse>;
-    /**
-     * Execute multiple credit actions atomically
-     *
-     * @remarks
-     * Compose individual credit operations (supply, withdraw, borrow, repay, swap, transfer)
-     * into a single atomic Safe transaction.
-     *
-     * The Credit Account must already be created via `/v2/credit/create_account`.
-     */
-    creditBundle(request: components.CreditBundleRequest, options?: RequestOptions): Promise<components.CreditBundleResponse>;
-}
-//# sourceMappingURL=credit.d.ts.map

package/dist/esm/sdk/credit.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"credit.d.ts","sourceRoot":"","sources":["../../../src/sdk/credit.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,MAAO,SAAQ,SAAS;IACnC;;;;;;;;OAQG;IACG,eAAe,CACnB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAQ9C;;;;;;;;;;;;;OAaG;IACG,mBAAmB,CACvB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAQlD;;;;;;;;;;;;OAYG;IACG,YAAY,CAChB,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAQ3C;;;;;;;;;;;;;;OAcG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,qBAAqB,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAQ7C;;;;;;;;;;;;;OAaG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAQ1C;;;;;;;;OAQG;IACG,YAAY,CAChB,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,oBAAoB,CAAC;CAO5C"}

package/dist/esm/sdk/credit.js

@@ -1,106 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-import { creditCreditBorrow } from "../funcs/creditCreditBorrow.js";
-import { creditCreditBundle } from "../funcs/creditCreditBundle.js";
-import { creditCreditCreateAccount } from "../funcs/creditCreditCreateAccount.js";
-import { creditCreditPositions } from "../funcs/creditCreditPositions.js";
-import { creditCreditRepay } from "../funcs/creditCreditRepay.js";
-import { creditCreditTransfer } from "../funcs/creditCreditTransfer.js";
-import { ClientSDK } from "../lib/sdks.js";
-import { unwrapAsync } from "../types/fp.js";
-export class Credit extends ClientSDK {
-    /**
-     * List credit positions
-     *
-     * @remarks
-     * List all Credit positions for a given owner.
-     *
-     * Returns a unified list of positions (collateral and debt) and an account summary
-     * with health factor and LTV. Each position includes event history.
-     */
-    async creditPositions(request, options) {
-        return unwrapAsync(creditCreditPositions(this, request, options));
-    }
-    /**
-     * Create credit account
-     *
-     * @remarks
-     * Create a Credit Account for a wallet address.
-     *
-     * Before using credit features, the owner must create a Credit Account. Each wallet address has one Credit Account per chain.
-     *
-     * Returns an unsigned transaction to create the account. The `sender` signs and broadcasts this transaction.
-     *
-     * **If owner pays gas:** Set `sender` to the owner's address.
-     *
-     * **If someone else pays gas:** Set `sender` to the wallet that will sign and broadcast the transaction on behalf of the owner.
-     */
-    async creditCreateAccount(request, options) {
-        return unwrapAsync(creditCreditCreateAccount(this, request, options));
-    }
-    /**
-     * Borrow against collateral
-     *
-     * @remarks
-     * Borrow an asset from Aave using a Credit Account.
-     *
-     * Bundles an optional swap, collateral supply, and borrow into a single atomic Safe transaction.
-     *
-     * - If `token_in` equals `collateral_token`, the tokens are supplied directly as collateral.
-     * - If `token_in` differs from `collateral_token`, a swap is performed first via 1inch.
-     *
-     * The Credit Account must already be created via `/v2/credit/create_account` and funded with `token_in`.
-     */
-    async creditBorrow(request, options) {
-        return unwrapAsync(creditCreditBorrow(this, request, options));
-    }
-    /**
-     * Get Permit2 signature data for Credit Account transfer
-     *
-     * @remarks
-     * Generate Permit2 EIP-712 typed data for transferring tokens from the owner's EOA
-     * to a Credit Account.
-     *
-     * The owner signs the returned EIP-712 data, then includes the signature in a `/v2/credit/borrow`
-     * or `/v2/credit/repay` request to atomically pull tokens from their EOA as part of the bundle.
-     *
-     * **Flow:**
-     * 1. Call this endpoint to get the Permit2 typed data
-     * 2. Sign the typed data with the owner's wallet
-     * 3. Call `/v2/credit/borrow` or `/v2/credit/repay` with the `permit2_signature`, `permit2_nonce`, and `permit2_deadline` fields
-     */
-    async creditTransfer(request, options) {
-        return unwrapAsync(creditCreditTransfer(this, request, options));
-    }
-    /**
-     * Repay debt and withdraw collateral
-     *
-     * @remarks
-     * Repay an Aave debt and withdraw collateral from a Credit Account.
-     *
-     * Bundles repayment, collateral withdrawal, and an optional swap into a single atomic Safe transaction.
-     *
-     * - If `token_out` is None or equals `withdraw_token`, the withdrawn collateral is kept as-is.
-     * - If `token_out` differs from `withdraw_token`, a swap is performed after withdrawal via 1inch.
-     *
-     * The Credit Account must already have a borrow position created via `/v2/credit/borrow`.
-     * The repay_token must be available in the Credit Account (or pulled from EOA via Permit2).
-     */
-    async creditRepay(request, options) {
-        return unwrapAsync(creditCreditRepay(this, request, options));
-    }
-    /**
-     * Execute multiple credit actions atomically
-     *
-     * @remarks
-     * Compose individual credit operations (supply, withdraw, borrow, repay, swap, transfer)
-     * into a single atomic Safe transaction.
-     *
-     * The Credit Account must already be created via `/v2/credit/create_account`.
-     */
-    async creditBundle(request, options) {
-        return unwrapAsync(creditCreditBundle(this, request, options));
-    }
-}
-//# sourceMappingURL=credit.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"credit.js","sourceRoot":"","sources":["../../../src/sdk/credit.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,MAAO,SAAQ,SAAS;IACnC;;;;;;;;OAQG;IACH,KAAK,CAAC,eAAe,CACnB,OAA4C,EAC5C,OAAwB;QAExB,OAAO,WAAW,CAAC,qBAAqB,CACtC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAA8C,EAC9C,OAAwB;QAExB,OAAO,WAAW,CAAC,yBAAyB,CAC1C,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,YAAY,CAChB,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,cAAc,CAClB,OAAyC,EACzC,OAAwB;QAExB,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,WAAW,CACf,OAAsC,EACtC,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,YAAY,CAChB,OAAuC,EACvC,OAAwB;QAExB,OAAO,WAAW,CAAC,kBAAkB,CACnC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/docs/models/components/accountsummary.md

@@ -1,30 +0,0 @@
-# AccountSummary
-
-Aave account-level summary from getUserAccountData().
-
-## Example Usage
-
-```typescript
-import { AccountSummary } from "@compass-labs/api-sdk/models/components";
-
-let value: AccountSummary = {
-  healthFactor: "<value>",
-  totalCollateralUsd: "<value>",
-  totalDebtUsd: "<value>",
-  availableBorrowsUsd: "<value>",
-  ltv: "<value>",
-  emodeCategoryId: 0,
-};
-```
-
-## Fields
-
-| Field                                                                                                                                                             | Type                                                                                                                                                              | Required                                                                                                                                                          | Description                                                                                                                                                       | Example                                                                                                                                                           |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `healthFactor`                                                                                                                                                    | *string*                                                                                                                                                          | :heavy_check_mark:                                                                                                                                                | Health factor. Above 1 is safe; below 1 risks liquidation.                                                                                                        |                                                                                                                                                                   |
-| `totalCollateralUsd`                                                                                                                                              | *string*                                                                                                                                                          | :heavy_check_mark:                                                                                                                                                | Total collateral value in USD.                                                                                                                                    |                                                                                                                                                                   |
-| `totalDebtUsd`                                                                                                                                                    | *string*                                                                                                                                                          | :heavy_check_mark:                                                                                                                                                | Total debt value in USD.                                                                                                                                          |                                                                                                                                                                   |
-| `availableBorrowsUsd`                                                                                                                                             | *string*                                                                                                                                                          | :heavy_check_mark:                                                                                                                                                | Available borrow capacity in USD.                                                                                                                                 |                                                                                                                                                                   |
-| `ltv`                                                                                                                                                             | *string*                                                                                                                                                          | :heavy_check_mark:                                                                                                                                                | Current loan-to-value ratio.                                                                                                                                      |                                                                                                                                                                   |
-| `emodeCategoryId`                                                                                                                                                 | *number*                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                | E-Mode category ID. 0 = disabled. E-Mode gives higher LTV when collateral and debt are price-correlated (e.g. stablecoin-to-stablecoin or ETH-to-ETH-derivative). | 0                                                                                                                                                                 |
-| `emodeLabel`                                                                                                                                                      | *string*                                                                                                                                                          | :heavy_minus_sign:                                                                                                                                                | Human-readable E-Mode category name (e.g. 'Stablecoins', 'ETH correlated'). Null when E-Mode is disabled (category 0).                                            |                                                                                                                                                                   |

package/docs/models/components/borrowamount.md

@@ -1,19 +0,0 @@
-# BorrowAmount
-
-Amount to borrow (in token units, not wei).
-
-
-## Supported Types
-
-### `number`
-
-```typescript
-const value: number = 0.01;
-```
-
-### `string`
-
-```typescript
-const value: string = "<value>";
-```
-

package/docs/models/components/collateralposition.md

@@ -1,31 +0,0 @@
-# CollateralPosition
-
-A per-reserve collateral position.
-
-## Example Usage
-
-```typescript
-import { CollateralPosition } from "@compass-labs/api-sdk/models/components";
-
-let value: CollateralPosition = {
-  token: "<value>",
-  symbol: "<value>",
-  amountSupplied: "<value>",
-  events: [],
-};
-```
-
-## Fields
-
-| Field                                                                                | Type                                                                                 | Required                                                                             | Description                                                                          | Example                                                                              |
-| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
-| `token`                                                                              | *string*                                                                             | :heavy_check_mark:                                                                   | Address of the collateral token.                                                     |                                                                                      |
-| `symbol`                                                                             | *string*                                                                             | :heavy_check_mark:                                                                   | Symbol of the collateral token (e.g. USDC).                                          |                                                                                      |
-| `amountSupplied`                                                                     | *string*                                                                             | :heavy_check_mark:                                                                   | Current on-chain aToken balance for the collateral.                                  |                                                                                      |
-| `usdValue`                                                                           | *string*                                                                             | :heavy_minus_sign:                                                                   | Collateral value in USD.                                                             |                                                                                      |
-| `supplyApy`                                                                          | *string*                                                                             | :heavy_minus_sign:                                                                   | Current supply APY in percentage (e.g. 4.5 means 4.5%).                              |                                                                                      |
-| `totalDeposited`                                                                     | *string*                                                                             | :heavy_minus_sign:                                                                   | Total collateral deposited over all time.                                            |                                                                                      |
-| `totalWithdrawn`                                                                     | *string*                                                                             | :heavy_minus_sign:                                                                   | Total collateral withdrawn over all time.                                            |                                                                                      |
-| `interestEarned`                                                                     | *string*                                                                             | :heavy_minus_sign:                                                                   | Interest earned on collateral: on_chain_balance + total_withdrawn - total_deposited. |                                                                                      |
-| `maxLtv`                                                                             | *string*                                                                             | :heavy_minus_sign:                                                                   | Maximum loan-to-value ratio for this collateral in percentage (e.g. 80 means 80%).   |                                                                                      |
-| `events`                                                                             | [components.CreditEvent](../../models/components/creditevent.md)[]                   | :heavy_minus_sign:                                                                   | All historical events for this collateral reserve.                                   | []                                                                                   |

package/docs/models/components/createcreditaccountrequest.md

@@ -1,24 +0,0 @@
-# CreateCreditAccountRequest
-
-Request to create a compass credit account.
-
-## Example Usage
-
-```typescript
-import { CreateCreditAccountRequest } from "@compass-labs/api-sdk/models/components";
-
-let value: CreateCreditAccountRequest = {
-  chain: "base",
-  sender: "0xc98949522db2eE403d6c75E91DDEe875a824bB10",
-  owner: "0xc98949522db2eE403d6c75E91DDEe875a824bB10",
-};
-```
-
-## Fields
-
-| Field                                                                                                                        | Type                                                                                                                         | Required                                                                                                                     | Description                                                                                                                  | Example                                                                                                                      |
-| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
-| `chain`                                                                                                                      | [components.CreateCreditAccountRequestChain](../../models/components/createcreditaccountrequestchain.md)                     | :heavy_check_mark:                                                                                                           | N/A                                                                                                                          | base                                                                                                                         |
-| `sender`                                                                                                                     | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | The address of the transaction sender.                                                                                       | 0xc98949522db2eE403d6c75E91DDEe875a824bB10                                                                                   |
-| `estimateGas`                                                                                                                | *boolean*                                                                                                                    | :heavy_minus_sign:                                                                                                           | Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed. | true                                                                                                                         |
-| `owner`                                                                                                                      | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | The address that will own and control the compass credit account                                                             | 0xc98949522db2eE403d6c75E91DDEe875a824bB10                                                                                   |

package/docs/models/components/createcreditaccountrequestchain.md

@@ -1,15 +0,0 @@
-# CreateCreditAccountRequestChain
-
-## Example Usage
-
-```typescript
-import { CreateCreditAccountRequestChain } from "@compass-labs/api-sdk/models/components";
-
-let value: CreateCreditAccountRequestChain = "base";
-```
-
-## Values
-
-```typescript
-"arbitrum" | "base" | "ethereum"
-```

package/docs/models/components/createcreditaccountresponse.md

@@ -1,31 +0,0 @@
-# CreateCreditAccountResponse
-
-Response containing unsigned transaction to create compass Credit account.
-
-## Example Usage
-
-```typescript
-import { CreateCreditAccountResponse } from "@compass-labs/api-sdk/models/components";
-
-let value: CreateCreditAccountResponse = {
-  transaction: {
-    chainId: "<id>",
-    data: "<value>",
-    from: "<value>",
-    gas: "<value>",
-    to: "<value>",
-    value: "<value>",
-    nonce: "<value>",
-    maxFeePerGas: "<value>",
-    maxPriorityFeePerGas: "<value>",
-  },
-  creditAccountAddress: "<value>",
-};
-```
-
-## Fields
-
-| Field                                                                            | Type                                                                             | Required                                                                         | Description                                                                      |
-| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
-| `transaction`                                                                    | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md) | :heavy_check_mark:                                                               | Transaction to create compass credit account                                     |
-| `creditAccountAddress`                                                           | *string*                                                                         | :heavy_check_mark:                                                               | Predicted address of the compass credit account that will be deployed            |

package/docs/models/components/creditborrowparams.md

@@ -1,24 +0,0 @@
-# CreditBorrowParams
-
-Borrow from Aave via Credit Account.
-
-## Example Usage
-
-```typescript
-import { CreditBorrowParams } from "@compass-labs/api-sdk/models/components";
-
-let value: CreditBorrowParams = {
-  actionType: "CREDIT_BORROW",
-  token: "<value>",
-  amount: "528.33",
-};
-```
-
-## Fields
-
-| Field                                                                                                    | Type                                                                                                     | Required                                                                                                 | Description                                                                                              | Example                                                                                                  |
-| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
-| `actionType`                                                                                             | *"CREDIT_BORROW"*                                                                                        | :heavy_check_mark:                                                                                       | N/A                                                                                                      | CREDIT_BORROW                                                                                            |
-| `token`                                                                                                  | *string*                                                                                                 | :heavy_check_mark:                                                                                       | Token to borrow from Aave.                                                                               |                                                                                                          |
-| `amount`                                                                                                 | *components.CreditBorrowParamsAmount*                                                                    | :heavy_check_mark:                                                                                       | Amount in token units to borrow.                                                                         |                                                                                                          |
-| `interestRateMode`                                                                                       | [components.InterestRateMode](../../models/components/interestratemode.md)                               | :heavy_minus_sign:                                                                                       | On AAVE there are 2 different interest modes.<br/><br/>A stable (but typically higher rate), or a variable rate. |                                                                                                          |

package/docs/models/components/creditborrowparamsamount.md

@@ -1,19 +0,0 @@
-# CreditBorrowParamsAmount
-
-Amount in token units to borrow.
-
-
-## Supported Types
-
-### `number`
-
-```typescript
-const value: number = 1284.03;
-```
-
-### `string`
-
-```typescript
-const value: string = "<value>";
-```
-

package/docs/models/components/creditborrowrequest.md

@@ -1,38 +0,0 @@
-# CreditBorrowRequest
-
-## Example Usage
-
-```typescript
-import { CreditBorrowRequest } from "@compass-labs/api-sdk/models/components";
-
-let value: CreditBorrowRequest = {
-  owner: "0xfeEb60eBf707DAA8248277058eb8D28EaeCF5425",
-  chain: "base",
-  tokenIn: "USDC",
-  amountIn: 100,
-  collateralToken: "USDC",
-  borrowToken: "WETH",
-  borrowAmount: 0.01,
-  interestRateMode: "variable",
-  slippage: 0.5,
-  gasSponsorship: false,
-};
-```
-
-## Fields
-
-| Field                                                                                                                                                                                                                                                                    | Type                                                                                                                                                                                                                                                                     | Required                                                                                                                                                                                                                                                                 | Description                                                                                                                                                                                                                                                              | Example                                                                                                                                                                                                                                                                  |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `owner`                                                                                                                                                                                                                                                                  | *string*                                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                                       | The address that owns the Credit Account.                                                                                                                                                                                                                                | 0xfeEb60eBf707DAA8248277058eb8D28EaeCF5425                                                                                                                                                                                                                               |
-| `chain`                                                                                                                                                                                                                                                                  | [components.Chain](../../models/components/chain.md)                                                                                                                                                                                                                     | :heavy_check_mark:                                                                                                                                                                                                                                                       | The chain to use.                                                                                                                                                                                                                                                        |                                                                                                                                                                                                                                                                          |
-| `tokenIn`                                                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                                       | Token currently held in the Credit Account to use as input. If the same as collateral_token, no swap is performed.                                                                                                                                                       | USDC                                                                                                                                                                                                                                                                     |
-| `amountIn`                                                                                                                                                                                                                                                               | *components.CreditBorrowRequestAmountIn*                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                                       | Amount of token_in to use (in token units, not wei).                                                                                                                                                                                                                     | 100                                                                                                                                                                                                                                                                      |
-| `collateralToken`                                                                                                                                                                                                                                                        | *string*                                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                                       | Aave reserve token to supply as collateral.                                                                                                                                                                                                                              | USDC                                                                                                                                                                                                                                                                     |
-| `borrowToken`                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                                                       | Asset to borrow from Aave.                                                                                                                                                                                                                                               | WETH                                                                                                                                                                                                                                                                     |
-| `borrowAmount`                                                                                                                                                                                                                                                           | *components.BorrowAmount*                                                                                                                                                                                                                                                | :heavy_check_mark:                                                                                                                                                                                                                                                       | Amount to borrow (in token units, not wei).                                                                                                                                                                                                                              | 0.01                                                                                                                                                                                                                                                                     |
-| `interestRateMode`                                                                                                                                                                                                                                                       | [components.InterestRateMode](../../models/components/interestratemode.md)                                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                                                                                                       | On AAVE there are 2 different interest modes.<br/><br/>A stable (but typically higher rate), or a variable rate.                                                                                                                                                         |                                                                                                                                                                                                                                                                          |
-| `slippage`                                                                                                                                                                                                                                                               | *components.CreditBorrowRequestSlippage*                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                       | Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%). Only used when a swap is needed.                                                                                                                                                                          | 0.5                                                                                                                                                                                                                                                                      |
-| `gasSponsorship`                                                                                                                                                                                                                                                         | *boolean*                                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                       | If true, returns EIP-712 signature data instead of an unsigned transaction.                                                                                                                                                                                              | false                                                                                                                                                                                                                                                                    |
-| `permit2Signature`                                                                                                                                                                                                                                                       | *string*                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                       | The EOA owner's signature of the Permit2 PermitTransferFrom typed data. When provided, the borrow bundle will first pull token_in from the owner's EOA into the Credit Account via Permit2. Obtain by calling /v2/credit/transfer and signing the returned EIP-712 data. |                                                                                                                                                                                                                                                                          |
-| `permit2Nonce`                                                                                                                                                                                                                                                           | *number*                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                       | The nonce used in the Permit2 signature (from the signed typed data).                                                                                                                                                                                                    |                                                                                                                                                                                                                                                                          |
-| `permit2Deadline`                                                                                                                                                                                                                                                        | *number*                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                       | The deadline timestamp used in the Permit2 signature (from the signed typed data).                                                                                                                                                                                       |                                                                                                                                                                                                                                                                          |

package/docs/models/components/creditborrowrequestamountin.md

@@ -1,19 +0,0 @@
-# CreditBorrowRequestAmountIn
-
-Amount of token_in to use (in token units, not wei).
-
-
-## Supported Types
-
-### `number`
-
-```typescript
-const value: number = 100;
-```
-
-### `string`
-
-```typescript
-const value: string = "<value>";
-```
-

package/docs/models/components/creditborrowrequestslippage.md

@@ -1,19 +0,0 @@
-# CreditBorrowRequestSlippage
-
-Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%). Only used when a swap is needed.
-
-
-## Supported Types
-
-### `number`
-
-```typescript
-const value: number = 1284.03;
-```
-
-### `string`
-
-```typescript
-const value: string = "0.5";
-```
-

package/docs/models/components/creditborrowresponse.md

@@ -1,17 +0,0 @@
-# CreditBorrowResponse
-
-## Example Usage
-
-```typescript
-import { CreditBorrowResponse } from "@compass-labs/api-sdk/models/components";
-
-let value: CreditBorrowResponse = {};
-```
-
-## Fields
-
-| Field                                                                                                              | Type                                                                                                               | Required                                                                                                           | Description                                                                                                        |
-| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
-| `transaction`                                                                                                      | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)                                   | :heavy_minus_sign:                                                                                                 | Unsigned transaction to execute the borrow bundle. Present when gas_sponsorship is false.                          |
-| `eip712`                                                                                                           | [components.BatchedSafeOperationsResponseOutput](../../models/components/batchedsafeoperationsresponseoutput.md)   | :heavy_minus_sign:                                                                                                 | EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship is true.                              |
-| `estimatedCollateralAmount`                                                                                        | *string*                                                                                                           | :heavy_minus_sign:                                                                                                 | Estimated amount of collateral token received from swap. Only present when token_in differs from collateral_token. |

package/docs/models/components/creditbundlerequest.md

@@ -1,25 +0,0 @@
-# CreditBundleRequest
-
-Request to execute multiple credit actions in a single atomic transaction.
-
-## Example Usage
-
-```typescript
-import { CreditBundleRequest } from "@compass-labs/api-sdk/models/components";
-
-let value: CreditBundleRequest = {
-  owner: "<value>",
-  chain: "base",
-  actions: [],
-  gasSponsorship: false,
-};
-```
-
-## Fields
-
-| Field                                                                              | Type                                                                               | Required                                                                           | Description                                                                        | Example                                                                            |
-| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
-| `owner`                                                                            | *string*                                                                           | :heavy_check_mark:                                                                 | The owner's wallet address that controls the Credit Account.                       |                                                                                    |
-| `chain`                                                                            | [components.Chain](../../models/components/chain.md)                               | :heavy_check_mark:                                                                 | The chain to use.                                                                  |                                                                                    |
-| `actions`                                                                          | [components.CreditUserOperation](../../models/components/credituseroperation.md)[] | :heavy_check_mark:                                                                 | List of actions to bundle. Actions are executed in order.                          |                                                                                    |
-| `gasSponsorship`                                                                   | *boolean*                                                                          | :heavy_minus_sign:                                                                 | If true, returns EIP-712 typed data for gas-sponsored execution.                   | false                                                                              |

package/docs/models/components/creditbundleresponse.md

@@ -1,19 +0,0 @@
-# CreditBundleResponse
-
-## Example Usage
-
-```typescript
-import { CreditBundleResponse } from "@compass-labs/api-sdk/models/components";
-
-let value: CreditBundleResponse = {
-  actionsCount: 957599,
-};
-```
-
-## Fields
-
-| Field                                                                                                                                      | Type                                                                                                                                       | Required                                                                                                                                   | Description                                                                                                                                |
-| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
-| `transaction`                                                                                                                              | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)                                                           | :heavy_minus_sign:                                                                                                                         | Unsigned transaction for direct execution by the owner. Present when gas_sponsorship=false.                                                |
-| `eip712`                                                                                                                                   | [components.BatchedSafeOperationsResponseOutput](../../models/components/batchedsafeoperationsresponseoutput.md)                           | :heavy_minus_sign:                                                                                                                         | EIP-712 typed data for gas-sponsored execution. Present when gas_sponsorship=true. Owner must sign and submit to /gas_sponsorship/prepare. |
-| `actionsCount`                                                                                                                             | *number*                                                                                                                                   | :heavy_check_mark:                                                                                                                         | Number of individual transactions bundled in this execution.                                                                               |