@compass-labs/api-sdk 2.2.17 → 2.2.18-rc.1

package/docs/models/components/creditborrowresponse.md

@@ -0,0 +1,17 @@
+# 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

@@ -0,0 +1,25 @@
+# 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

@@ -0,0 +1,19 @@
+# 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.                                                                               |

package/docs/models/components/creditevent.md

@@ -0,0 +1,29 @@
+# CreditEvent
+
+A single historical event in a credit position.
+
+## Example Usage
+
+```typescript
+import { CreditEvent } from "@compass-labs/api-sdk/models/components";
+
+let value: CreditEvent = {
+  eventType: "supply",
+  blockNumber: 349470,
+  blockTimestamp: new Date("2026-03-29T05:53:04.536Z"),
+  transactionHash: "<value>",
+  amount: "731.51",
+  symbol: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `eventType`                                                                                   | [components.EventType](../../models/components/eventtype.md)                                  | :heavy_check_mark:                                                                            | Type of credit event.                                                                         |
+| `blockNumber`                                                                                 | *number*                                                                                      | :heavy_check_mark:                                                                            | Block number when the event occurred                                                          |
+| `blockTimestamp`                                                                              | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | Timestamp when the event occurred                                                             |
+| `transactionHash`                                                                             | *string*                                                                                      | :heavy_check_mark:                                                                            | Transaction hash of the event                                                                 |
+| `amount`                                                                                      | *string*                                                                                      | :heavy_check_mark:                                                                            | Amount involved in the event                                                                  |
+| `symbol`                                                                                      | *string*                                                                                      | :heavy_check_mark:                                                                            | Symbol of the token                                                                           |

package/docs/models/components/creditpositionsresponse.md

@@ -0,0 +1,31 @@
+# CreditPositionsResponse
+
+Credit account positions response with per-reserve positions and account summary.
+
+## Example Usage
+
+```typescript
+import { CreditPositionsResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: CreditPositionsResponse = {
+  collateralPositions: [],
+  debtPositions: [],
+  accountSummary: {
+    healthFactor: "<value>",
+    totalCollateralUsd: "<value>",
+    totalDebtUsd: "<value>",
+    availableBorrowsUsd: "<value>",
+    ltv: "<value>",
+    emodeCategoryId: 0,
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                  | Type                                                                                   | Required                                                                               | Description                                                                            | Example                                                                                |
+| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
+| `collateralPositions`                                                                  | [components.CollateralPosition](../../models/components/collateralposition.md)[]       | :heavy_minus_sign:                                                                     | All collateral positions, one per reserve.                                             | []                                                                                     |
+| `debtPositions`                                                                        | [components.DebtPosition](../../models/components/debtposition.md)[]                   | :heavy_minus_sign:                                                                     | All debt positions, one per reserve.                                                   | []                                                                                     |
+| `accountSummary`                                                                       | [components.AccountSummary](../../models/components/accountsummary.md)                 | :heavy_check_mark:                                                                     | Aave account-level summary from getUserAccountData().                                  |                                                                                        |
+| `totalUsdValue`                                                                        | *string*                                                                               | :heavy_minus_sign:                                                                     | Net position value in USD (total collateral - total debt). Null if prices unavailable. |                                                                                        |

package/docs/models/components/creditrepayparams.md

@@ -0,0 +1,24 @@
+# CreditRepayParams
+
+Repay debt to Aave via Credit Account.
+
+## Example Usage
+
+```typescript
+import { CreditRepayParams } from "@compass-labs/api-sdk/models/components";
+
+let value: CreditRepayParams = {
+  actionType: "CREDIT_REPAY",
+  token: "<value>",
+  amount: 9432.03,
+};
+```
+
+## Fields
+
+| Field                                                                                                    | Type                                                                                                     | Required                                                                                                 | Description                                                                                              | Example                                                                                                  |
+| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
+| `actionType`                                                                                             | *"CREDIT_REPAY"*                                                                                         | :heavy_check_mark:                                                                                       | N/A                                                                                                      | CREDIT_REPAY                                                                                             |
+| `token`                                                                                                  | *string*                                                                                                 | :heavy_check_mark:                                                                                       | Token to repay to Aave.                                                                                  |                                                                                                          |
+| `amount`                                                                                                 | *components.CreditRepayParamsAmount*                                                                     | :heavy_check_mark:                                                                                       | Amount in token units to repay.                                                                          |                                                                                                          |
+| `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/creditrepayparamsamount.md

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

package/docs/models/components/creditrepayrequest.md

@@ -0,0 +1,37 @@
+# CreditRepayRequest
+
+## Example Usage
+
+```typescript
+import { CreditRepayRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: CreditRepayRequest = {
+  owner: "0x831Ad0C52C77708DA5D49dc8278C966dfdD4ddA1",
+  chain: "base",
+  repayToken: "WETH",
+  repayAmount: 0.01,
+  interestRateMode: "variable",
+  withdrawToken: "USDC",
+  withdrawAmount: 100,
+  slippage: 0.5,
+  gasSponsorship: false,
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                                                                      | Type                                                                                                                                                                                                                                                                       | Required                                                                                                                                                                                                                                                                   | Description                                                                                                                                                                                                                                                                | Example                                                                                                                                                                                                                                                                    |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `owner`                                                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                         | The address that owns the Credit Account.                                                                                                                                                                                                                                  | 0x831Ad0C52C77708DA5D49dc8278C966dfdD4ddA1                                                                                                                                                                                                                                 |
+| `chain`                                                                                                                                                                                                                                                                    | [components.Chain](../../models/components/chain.md)                                                                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                                                                                                                         | The chain to use.                                                                                                                                                                                                                                                          |                                                                                                                                                                                                                                                                            |
+| `repayToken`                                                                                                                                                                                                                                                               | *string*                                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                         | The borrowed asset to repay (e.g. WETH). Must match the debt position's token.                                                                                                                                                                                             | WETH                                                                                                                                                                                                                                                                       |
+| `repayAmount`                                                                                                                                                                                                                                                              | *components.RepayAmount*                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                         | Amount of repay_token to repay (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.                                                                                                                                                           |                                                                                                                                                                                                                                                                            |
+| `withdrawToken`                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                                                         | Collateral token to withdraw from Aave after repaying debt.                                                                                                                                                                                                                | USDC                                                                                                                                                                                                                                                                       |
+| `withdrawAmount`                                                                                                                                                                                                                                                           | *components.WithdrawAmount*                                                                                                                                                                                                                                                | :heavy_check_mark:                                                                                                                                                                                                                                                         | Amount of collateral to withdraw (in token units, not wei).                                                                                                                                                                                                                | 100                                                                                                                                                                                                                                                                        |
+| `tokenOut`                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                                                                                                         | Desired output token. If different from withdraw_token, a swap is performed after withdrawal. If None, the withdrawn collateral is kept as-is.                                                                                                                             |                                                                                                                                                                                                                                                                            |
+| `slippage`                                                                                                                                                                                                                                                                 | *components.CreditRepayRequestSlippage*                                                                                                                                                                                                                                    | :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 repay bundle will first pull repay_token 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/creditrepayrequestslippage.md

@@ -0,0 +1,19 @@
+# CreditRepayRequestSlippage
+
+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/creditrepayresponse.md

@@ -0,0 +1,17 @@
+# CreditRepayResponse
+
+## Example Usage
+
+```typescript
+import { CreditRepayResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: CreditRepayResponse = {};
+```
+
+## Fields
+
+| Field                                                                                                            | Type                                                                                                             | Required                                                                                                         | Description                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
+| `transaction`                                                                                                    | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)                                 | :heavy_minus_sign:                                                                                               | Unsigned transaction to execute the repay 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.                            |
+| `estimatedTokenOutAmount`                                                                                        | *string*                                                                                                         | :heavy_minus_sign:                                                                                               | Estimated amount of token_out received from swap. Only present when token_out differs from withdraw_token.       |

package/docs/models/components/creditsupplyparams.md

@@ -0,0 +1,23 @@
+# CreditSupplyParams
+
+Supply collateral to Aave via Credit Account.
+
+## Example Usage
+
+```typescript
+import { CreditSupplyParams } from "@compass-labs/api-sdk/models/components";
+
+let value: CreditSupplyParams = {
+  actionType: "CREDIT_SUPPLY",
+  token: "<value>",
+  amount: "271.94",
+};
+```
+
+## Fields
+
+| Field                                 | Type                                  | Required                              | Description                           | Example                               |
+| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
+| `actionType`                          | *"CREDIT_SUPPLY"*                     | :heavy_check_mark:                    | N/A                                   | CREDIT_SUPPLY                         |
+| `token`                               | *string*                              | :heavy_check_mark:                    | Collateral token to supply to Aave.   |                                       |
+| `amount`                              | *components.CreditSupplyParamsAmount* | :heavy_check_mark:                    | Amount in token units to supply.      |                                       |

package/docs/models/components/creditsupplyparamsamount.md

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

package/docs/models/components/credittransferrequest.md

@@ -0,0 +1,23 @@
+# CreditTransferRequest
+
+## Example Usage
+
+```typescript
+import { CreditTransferRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: CreditTransferRequest = {
+  owner: "0x4A83fec8c6A9A25Be28f3242a16dBaD0ab00f3a6",
+  chain: "base",
+  token: "USDC",
+  amount: 100,
+};
+```
+
+## Fields
+
+| Field                                                       | Type                                                        | Required                                                    | Description                                                 | Example                                                     |
+| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
+| `owner`                                                     | *string*                                                    | :heavy_check_mark:                                          | The owner's wallet address (EOA).                           | 0x4A83fec8c6A9A25Be28f3242a16dBaD0ab00f3a6                  |
+| `chain`                                                     | [components.Chain](../../models/components/chain.md)        | :heavy_check_mark:                                          | The chain to use.                                           |                                                             |
+| `token`                                                     | *string*                                                    | :heavy_check_mark:                                          | The token to transfer from the EOA to the Credit Account.   | USDC                                                        |
+| `amount`                                                    | *components.CreditTransferRequestAmount*                    | :heavy_check_mark:                                          | The amount of tokens to transfer (in token units, not wei). | 100                                                         |

package/docs/models/components/credittransferrequestamount.md

@@ -0,0 +1,19 @@
+# CreditTransferRequestAmount
+
+The amount of tokens to transfer (in token units, not wei).
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 100;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/credittransferresponse.md

@@ -0,0 +1,75 @@
+# CreditTransferResponse
+
+## Example Usage
+
+```typescript
+import { CreditTransferResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: CreditTransferResponse = {
+  eip712: {
+    types: {
+      eip712Domain: [
+        {
+          name: "name",
+          type: "string",
+        },
+        {
+          name: "chainId",
+          type: "uint256",
+        },
+        {
+          name: "verifyingContract",
+          type: "address",
+        },
+      ],
+      tokenPermissions: [
+        {
+          name: "token",
+          type: "address",
+        },
+        {
+          name: "amount",
+          type: "uint256",
+        },
+      ],
+      permitTransferFrom: [
+        {
+          name: "permitted",
+          type: "TokenPermissions",
+        },
+        {
+          name: "spender",
+          type: "address",
+        },
+        {
+          name: "nonce",
+          type: "uint256",
+        },
+        {
+          name: "deadline",
+          type: "uint256",
+        },
+      ],
+    },
+    domain: {
+      chainId: 659817,
+      verifyingContract: "<value>",
+    },
+    message: {
+      permitted: {
+        token: "<value>",
+        amount: 387057,
+      },
+      spender: "<value>",
+      nonce: 382019,
+      deadline: 22738,
+    },
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                  | Type                                                                                   | Required                                                                               | Description                                                                            |
+| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
+| `eip712`                                                                               | [components.Permit2TypedDataOutput](../../models/components/permit2typeddataoutput.md) | :heavy_check_mark:                                                                     | N/A                                                                                    |

package/docs/models/components/credituseroperation.md

@@ -0,0 +1,23 @@
+# CreditUserOperation
+
+A single operation in a credit bundle.
+
+## Example Usage
+
+```typescript
+import { CreditUserOperation } from "@compass-labs/api-sdk/models/components";
+
+let value: CreditUserOperation = {
+  body: {
+    actionType: "CREDIT_SUPPLY",
+    token: "<value>",
+    amount: "988.97",
+  },
+};
+```
+
+## Fields
+
+| Field                                | Type                                 | Required                             | Description                          |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
+| `body`                               | *components.CreditUserOperationBody* | :heavy_check_mark:                   | N/A                                  |

package/docs/models/components/credituseroperationbody.md

@@ -0,0 +1,80 @@
+# CreditUserOperationBody
+
+
+## Supported Types
+
+### `components.CreditBorrowParams`
+
+```typescript
+const value: components.CreditBorrowParams = {
+  actionType: "CREDIT_BORROW",
+  token: "<value>",
+  amount: "528.33",
+};
+```
+
+### `components.CreditRepayParams`
+
+```typescript
+const value: components.CreditRepayParams = {
+  actionType: "CREDIT_REPAY",
+  token: "<value>",
+  amount: 9432.03,
+};
+```
+
+### `components.CreditSupplyParams`
+
+```typescript
+const value: components.CreditSupplyParams = {
+  actionType: "CREDIT_SUPPLY",
+  token: "<value>",
+  amount: "271.94",
+};
+```
+
+### `components.CreditWithdrawParams`
+
+```typescript
+const value: components.CreditWithdrawParams = {
+  actionType: "CREDIT_WITHDRAW",
+  token: "<value>",
+  amount: 6714.86,
+};
+```
+
+### `components.EarnSwapParams`
+
+```typescript
+const value: components.EarnSwapParams = {
+  actionType: "V2_SWAP",
+  tokenIn: "<value>",
+  tokenOut: "<value>",
+  amountIn: 1543.87,
+  slippage: "0.5",
+};
+```
+
+### `components.EarnTransferFromEOAParams`
+
+```typescript
+const value: components.EarnTransferFromEOAParams = {
+  actionType: "V2_TRANSFER_FROM_EOA",
+  token: "<value>",
+  amount: 4305.68,
+  permit2Signature: "<value>",
+  permit2Nonce: 649287,
+  permit2Deadline: 645376,
+};
+```
+
+### `components.EarnTransferToEOAParams`
+
+```typescript
+const value: components.EarnTransferToEOAParams = {
+  actionType: "V2_TRANSFER_TO_EOA",
+  token: "<value>",
+  amount: 692.89,
+};
+```
+

package/docs/models/components/creditwithdrawparams.md

@@ -0,0 +1,23 @@
+# CreditWithdrawParams
+
+Withdraw collateral from Aave via Credit Account.
+
+## Example Usage
+
+```typescript
+import { CreditWithdrawParams } from "@compass-labs/api-sdk/models/components";
+
+let value: CreditWithdrawParams = {
+  actionType: "CREDIT_WITHDRAW",
+  token: "<value>",
+  amount: 6714.86,
+};
+```
+
+## Fields
+
+| Field                                   | Type                                    | Required                                | Description                             | Example                                 |
+| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
+| `actionType`                            | *"CREDIT_WITHDRAW"*                     | :heavy_check_mark:                      | N/A                                     | CREDIT_WITHDRAW                         |
+| `token`                                 | *string*                                | :heavy_check_mark:                      | Collateral token to withdraw from Aave. |                                         |
+| `amount`                                | *components.CreditWithdrawParamsAmount* | :heavy_check_mark:                      | Amount in token units to withdraw.      |                                         |

package/docs/models/components/creditwithdrawparamsamount.md

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