@compass-labs/api-sdk 2.1.11 → 2.1.12-rc.0

package/docs/models/components/createaccountrequest.md

@@ -0,0 +1,24 @@
+# CreateAccountRequest
+
+Request to create a compass account.
+
+## Example Usage
+
+```typescript
+import { CreateAccountRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: CreateAccountRequest = {
+  chain: "base",
+  sender: "0x9a30797cA5467fBaA1D74574886FeC5F79ae407A",
+  owner: "0x9a30797cA5467fBaA1D74574886FeC5F79ae407A",
+};
+```
+
+## Fields
+
+| Field                                                                                                                        | Type                                                                                                                         | Required                                                                                                                     | Description                                                                                                                  | Example                                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `chain`                                                                                                                      | [components.CreateAccountRequestChain](../../models/components/createaccountrequestchain.md)                                 | :heavy_check_mark:                                                                                                           | N/A                                                                                                                          |                                                                                                                              |
+| `sender`                                                                                                                     | *string*                                                                                                                     | :heavy_check_mark:                                                                                                           | The address of the transaction sender.                                                                                       |                                                                                                                              |
+| `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 account                                                                    |                                                                                                                              |

package/docs/models/components/createaccountrequestchain.md

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

package/docs/models/components/createaccountresponse.md

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

package/docs/models/components/denomination.md

@@ -0,0 +1,17 @@
+# Denomination
+
+The unit type for the fee amount. Use 'PERCENTAGE' for a percentage-based fee (e.g., 1.5 means 1.5% of the transaction amount) or 'FIXED' for a fixed token amount (e.g., 0.1 means 0.1 tokens).
+
+## Example Usage
+
+```typescript
+import { Denomination } from "@compass-labs/api-sdk/models/components";
+
+let value: Denomination = "PERCENTAGE";
+```
+
+## Values
+
+```typescript
+"PERCENTAGE" | "FIXED"
+```

package/docs/models/components/depositforburnrequest.md

@@ -0,0 +1,27 @@
+# DepositForBurnRequest
+
+## Example Usage
+
+```typescript
+import { DepositForBurnRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: DepositForBurnRequest = {
+  owner: "0x01E62835dd7F52173546A325294762143eE4a882",
+  chain: "arbitrum",
+  amount: "3",
+  destinationChain: "base",
+  gasSponsorship: true,
+  transferMode: "standard",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                        | Type                                                                                                                                                                                                                         | Required                                                                                                                                                                                                                     | Description                                                                                                                                                                                                                  | Example                                                                                                                                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `owner`                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                     | :heavy_check_mark:                                                                                                                                                                                                           | The primary wallet address that owns and controls the Product Account.                                                                                                                                                       |                                                                                                                                                                                                                              |
+| `chain`                                                                                                                                                                                                                      | [components.DepositForBurnRequestChain](../../models/components/depositforburnrequestchain.md)                                                                                                                               | :heavy_check_mark:                                                                                                                                                                                                           | The source chain where USDC will be burned.                                                                                                                                                                                  |                                                                                                                                                                                                                              |
+| `amount`                                                                                                                                                                                                                     | *components.DepositForBurnRequestAmount*                                                                                                                                                                                     | :heavy_check_mark:                                                                                                                                                                                                           | The amount of USDC to bridge (in token units, e.g., 100.5 for 100.5 USDC).                                                                                                                                                   |                                                                                                                                                                                                                              |
+| `destinationChain`                                                                                                                                                                                                           | [components.DestinationChain](../../models/components/destinationchain.md)                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                           | The destination chain where USDC will be minted.                                                                                                                                                                             |                                                                                                                                                                                                                              |
+| `gasSponsorship`                                                                                                                                                                                                             | *boolean*                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                           | Optionally request gas sponsorship. If set to `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`). | false                                                                                                                                                                                                                        |
+| `transferMode`                                                                                                                                                                                                               | [components.DepositForBurnRequestTransferMode](../../models/components/depositforburnrequesttransfermode.md)                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                           | Transfer speed mode. 'fast': ~30 second transfers using confirmed finality (requires a small fee taken from transfer amount). 'standard': ~15-19 minute transfers using full finality (free, no fee). Default is 'standard'. | standard                                                                                                                                                                                                                     |

package/docs/models/components/depositforburnrequestamount.md

@@ -0,0 +1,19 @@
+# DepositForBurnRequestAmount
+
+The amount of USDC to bridge (in token units, e.g., 100.5 for 100.5 USDC).
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/depositforburnrequestchain.md

@@ -0,0 +1,17 @@
+# DepositForBurnRequestChain
+
+The source chain where USDC will be burned.
+
+## Example Usage
+
+```typescript
+import { DepositForBurnRequestChain } from "@compass-labs/api-sdk/models/components";
+
+let value: DepositForBurnRequestChain = "arbitrum";
+```
+
+## Values
+
+```typescript
+"ethereum" | "arbitrum" | "base"
+```

package/docs/models/components/depositforburnrequesttransfermode.md

@@ -0,0 +1,17 @@
+# DepositForBurnRequestTransferMode
+
+Transfer speed mode. 'fast': ~30 second transfers using confirmed finality (requires a small fee taken from transfer amount). 'standard': ~15-19 minute transfers using full finality (free, no fee). Default is 'standard'.
+
+## Example Usage
+
+```typescript
+import { DepositForBurnRequestTransferMode } from "@compass-labs/api-sdk/models/components";
+
+let value: DepositForBurnRequestTransferMode = "standard";
+```
+
+## Values
+
+```typescript
+"fast" | "standard"
+```

package/docs/models/components/depositforburnresponse.md

@@ -0,0 +1,68 @@
+# DepositForBurnResponse
+
+Response model for CCTP depositForBurn transaction from a smart account.
+
+Contains either an unsigned transaction for direct submission or EIP-712 typed data
+for gas-sponsored transactions. Also includes a bridge_id for tracking the cross-
+chain transfer.
+
+## Example Usage
+
+```typescript
+import { DepositForBurnResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: DepositForBurnResponse = {
+  transaction: {
+    chainId: "<id>",
+    data: "<value>",
+    from: "<value>",
+    gas: "<value>",
+    to: "<value>",
+    value: "<value>",
+    nonce: "<value>",
+    maxFeePerGas: "<value>",
+    maxPriorityFeePerGas: "<value>",
+  },
+  eip712: {
+    domain: {
+      chainId: 95340,
+      verifyingContract: "<value>",
+    },
+    types: {
+      eip712Domain: [],
+      safeTx: [
+        {
+          name: "<value>",
+          type: "<value>",
+        },
+      ],
+    },
+    primaryType: "SafeTx",
+    message: {
+      to: "<value>",
+      value: "<value>",
+      data: "<value>",
+      operation: 0,
+      safeTxGas: "<value>",
+      baseGas: "<value>",
+      gasPrice: "<value>",
+      gasToken: "<value>",
+      refundReceiver: "<value>",
+      nonce: "<value>",
+    },
+  },
+  transferMode: "standard",
+  estimatedTimeSeconds: 781270,
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                  | Type                                                                                                                                                                                   | Required                                                                                                                                                                               | Description                                                                                                                                                                            |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `bridgeId`                                                                                                                                                                             | *string*                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                     | Unique bridge identifier for tracking this cross-chain transfer. Use this ID when calling /mint/prepare to complete the transfer. Only present when Redis is configured on the server. |
+| `transaction`                                                                                                                                                                          | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)                                                                                                       | :heavy_check_mark:                                                                                                                                                                     | N/A                                                                                                                                                                                    |
+| `eip712`                                                                                                                                                                               | [components.BatchedSafeOperationsResponseOutput](../../models/components/batchedsafeoperationsresponseoutput.md)                                                                       | :heavy_check_mark:                                                                                                                                                                     | N/A                                                                                                                                                                                    |
+| `transferMode`                                                                                                                                                                         | [components.DepositForBurnResponseTransferMode](../../models/components/depositforburnresponsetransfermode.md)                                                                         | :heavy_check_mark:                                                                                                                                                                     | The transfer speed mode used. 'fast' uses confirmed finality (~30s), 'standard' uses full finality (~15-19 min).                                                                       |
+| `fee`                                                                                                                                                                                  | *string*                                                                                                                                                                               | :heavy_minus_sign:                                                                                                                                                                     | Fee amount in USDC charged for this transfer. Only present for fast mode. Standard mode transfers are free (fee is None or 0).                                                         |
+| `estimatedTimeSeconds`                                                                                                                                                                 | *number*                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                     | Estimated time to complete the bridge in seconds.                                                                                                                                      |

package/docs/models/components/depositforburnresponsetransfermode.md

@@ -0,0 +1,17 @@
+# DepositForBurnResponseTransferMode
+
+The transfer speed mode used. 'fast' uses confirmed finality (~30s), 'standard' uses full finality (~15-19 min).
+
+## Example Usage
+
+```typescript
+import { DepositForBurnResponseTransferMode } from "@compass-labs/api-sdk/models/components";
+
+let value: DepositForBurnResponseTransferMode = "fast";
+```
+
+## Values
+
+```typescript
+"fast" | "standard"
+```

package/docs/models/components/destinationchain.md

@@ -0,0 +1,17 @@
+# DestinationChain
+
+The destination chain where USDC will be minted.
+
+## Example Usage
+
+```typescript
+import { DestinationChain } from "@compass-labs/api-sdk/models/components";
+
+let value: DestinationChain = "arbitrum";
+```
+
+## Values
+
+```typescript
+"ethereum" | "arbitrum" | "base"
+```

package/docs/models/components/details.md

@@ -0,0 +1,33 @@
+# Details
+
+## Example Usage
+
+```typescript
+import { Details } from "@compass-labs/api-sdk/models/components";
+
+let value: Details = {
+  liquidity: 4182.98,
+  pendleApy: 2079.32,
+  impliedApy: 122.5,
+  feeRate: 7216.92,
+  yieldRange: {
+    min: 6331.68,
+    max: 8582.82,
+  },
+  aggregatedApy: 821.33,
+  maxBoostedApy: 3012.82,
+};
+```
+
+## Fields
+
+| Field                                                                        | Type                                                                         | Required                                                                     | Description                                                                  |
+| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| `liquidity`                                                                  | *number*                                                                     | :heavy_check_mark:                                                           | N/A                                                                          |
+| `pendleApy`                                                                  | *number*                                                                     | :heavy_check_mark:                                                           | N/A                                                                          |
+| `impliedApy`                                                                 | *number*                                                                     | :heavy_check_mark:                                                           | N/A                                                                          |
+| `feeRate`                                                                    | *number*                                                                     | :heavy_check_mark:                                                           | N/A                                                                          |
+| `movement10Percent`                                                          | [components.Movement10Percent](../../models/components/movement10percent.md) | :heavy_minus_sign:                                                           | N/A                                                                          |
+| `yieldRange`                                                                 | [components.YieldRange](../../models/components/yieldrange.md)               | :heavy_check_mark:                                                           | N/A                                                                          |
+| `aggregatedApy`                                                              | *number*                                                                     | :heavy_check_mark:                                                           | N/A                                                                          |
+| `maxBoostedApy`                                                              | *number*                                                                     | :heavy_check_mark:                                                           | N/A                                                                          |

package/docs/models/components/earnmanagerequest.md

@@ -0,0 +1,30 @@
+# EarnManageRequest
+
+## Example Usage
+
+```typescript
+import { EarnManageRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: EarnManageRequest = {
+  owner: "0xe5310C39a8A8f16E6126ee6B1006bf6eD58B3A49",
+  chain: "base",
+  venue: {
+    type: "VAULT",
+    vaultAddress: "0x7BfA7C4f149E7415b73bdeDfe609237e29CBF34A",
+  },
+  action: "WITHDRAW",
+  amount: "0.01",
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                                | Type                                                                                                                                                                                                                                 | Required                                                                                                                                                                                                                             | Description                                                                                                                                                                                                                          | Example                                                                                                                                                                                                                              |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `owner`                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                             | :heavy_check_mark:                                                                                                                                                                                                                   | The primary wallet address that owns and controls the Earn Account.                                                                                                                                                                  |                                                                                                                                                                                                                                      |
+| `chain`                                                                                                                                                                                                                              | [components.Chain](../../models/components/chain.md)                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                                   | The chain to use.                                                                                                                                                                                                                    |                                                                                                                                                                                                                                      |
+| `venue`                                                                                                                                                                                                                              | *components.Venue*                                                                                                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                                                                   | The earn venue.                                                                                                                                                                                                                      |                                                                                                                                                                                                                                      |
+| `action`                                                                                                                                                                                                                             | [components.EarnManageRequestAction](../../models/components/earnmanagerequestaction.md)                                                                                                                                             | :heavy_check_mark:                                                                                                                                                                                                                   | Whether you are depositing into or withdrawing from the given Earn `venue`.                                                                                                                                                          |                                                                                                                                                                                                                                      |
+| `amount`                                                                                                                                                                                                                             | *any*                                                                                                                                                                                                                                | :heavy_check_mark:                                                                                                                                                                                                                   | Amount of the underlying asset to act on (deposit or withdraw). For VAULT, this is the vault’s underlying token; for AAVE, this is the Aave reserve asset. Provide as a decimal in token units (not wei); must be > 0.               |                                                                                                                                                                                                                                      |
+| `gasSponsorship`                                                                                                                                                                                                                     | *boolean*                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                   | Optionally request gas sponsorship. If set to `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`).         | false                                                                                                                                                                                                                                |
+| `fee`                                                                                                                                                                                                                                | [components.Fee](../../models/components/fee.md)                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                   | Optional fee configuration. If provided, a fee will be applied to the transaction amount and sent to the specified recipient address. The fee can be specified as a percentage of the transaction amount or as a fixed token amount. |                                                                                                                                                                                                                                      |

package/docs/models/components/earnmanagerequestaction.md

@@ -0,0 +1,17 @@
+# EarnManageRequestAction
+
+Whether you are depositing into or withdrawing from the given Earn `venue`.
+
+## Example Usage
+
+```typescript
+import { EarnManageRequestAction } from "@compass-labs/api-sdk/models/components";
+
+let value: EarnManageRequestAction = "DEPOSIT";
+```
+
+## Values
+
+```typescript
+"DEPOSIT" | "WITHDRAW"
+```

package/docs/models/components/earnmanageresponse.md

@@ -0,0 +1,29 @@
+# EarnManageResponse
+
+## Example Usage
+
+```typescript
+import { EarnManageResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: EarnManageResponse = {
+  transaction: {
+    chainId: "<id>",
+    data: "<value>",
+    from: "<value>",
+    gas: "<value>",
+    to: "<value>",
+    value: "<value>",
+    nonce: "<value>",
+    maxFeePerGas: "<value>",
+    maxPriorityFeePerGas: "<value>",
+  },
+  eip712: null,
+};
+```
+
+## Fields
+
+| Field                                                                                                            | Type                                                                                                             | Required                                                                                                         | Description                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
+| `transaction`                                                                                                    | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)                                 | :heavy_check_mark:                                                                                               | N/A                                                                                                              |
+| `eip712`                                                                                                         | [components.BatchedSafeOperationsResponseOutput](../../models/components/batchedsafeoperationsresponseoutput.md) | :heavy_check_mark:                                                                                               | N/A                                                                                                              |

package/docs/models/components/earnpositionresponse.md

@@ -0,0 +1,26 @@
+# EarnPositionResponse
+
+Response model for a single earn position.
+
+## Example Usage
+
+```typescript
+import { EarnPositionResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: EarnPositionResponse = {
+  position: {
+    type: "VAULT",
+    id: "<id>",
+    vaultAddress: "<value>",
+    amountInUnderlyingToken: "<value>",
+    tokenName: "<value>",
+    vaultName: "<value>",
+  },
+};
+```
+
+## Fields
+
+| Field                      | Type                       | Required                   | Description                |
+| -------------------------- | -------------------------- | -------------------------- | -------------------------- |
+| `position`                 | *components.PositionUnion* | :heavy_check_mark:         | The user's earn position.  |

package/docs/models/components/earnpositionsresponse.md

@@ -0,0 +1,17 @@
+# EarnPositionsResponse
+
+## Example Usage
+
+```typescript
+import { EarnPositionsResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: EarnPositionsResponse = {
+  userPositions: [],
+};
+```
+
+## Fields
+
+| Field                                | Type                                 | Required                             | Description                          |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ |
+| `userPositions`                      | *components.UserPosition*[]          | :heavy_check_mark:                   | A list of the user's earn positions. |

package/docs/models/components/earnswaprequest.md

@@ -0,0 +1,29 @@
+# EarnSwapRequest
+
+## Example Usage
+
+```typescript
+import { EarnSwapRequest } from "@compass-labs/api-sdk/models/components";
+
+let value: EarnSwapRequest = {
+  owner: "0xC1be8f91480648De355a45f3E2562811b4e2D3FF",
+  chain: "base",
+  tokenIn: "USDC",
+  tokenOut: "USDT",
+  amountIn: "0.01",
+  slippage: "0.5",
+  gasSponsorship: false,
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                                                                 | Type                                                                                                                                                                                                                  | Required                                                                                                                                                                                                              | Description                                                                                                                                                                                                           | Example                                                                                                                                                                                                               |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `owner`                                                                                                                                                                                                               | *string*                                                                                                                                                                                                              | :heavy_check_mark:                                                                                                                                                                                                    | The owner's wallet address.                                                                                                                                                                                           |                                                                                                                                                                                                                       |
+| `chain`                                                                                                                                                                                                               | [components.Chain](../../models/components/chain.md)                                                                                                                                                                  | :heavy_check_mark:                                                                                                                                                                                                    | The chain to use.                                                                                                                                                                                                     |                                                                                                                                                                                                                       |
+| `tokenIn`                                                                                                                                                                                                             | *string*                                                                                                                                                                                                              | :heavy_check_mark:                                                                                                                                                                                                    | Token to sell (input). Provide a token symbol from a limited set (e.g., 'USDC') or any token address.                                                                                                                 |                                                                                                                                                                                                                       |
+| `tokenOut`                                                                                                                                                                                                            | *string*                                                                                                                                                                                                              | :heavy_check_mark:                                                                                                                                                                                                    | Token to buy (output). Provide a token symbol from a limited set (e.g., 'USDT') or any token address.                                                                                                                 |                                                                                                                                                                                                                       |
+| `amountIn`                                                                                                                                                                                                            | *components.EarnSwapRequestAmountIn*                                                                                                                                                                                  | :heavy_check_mark:                                                                                                                                                                                                    | Human-readable amount of `token_in` to swap (token units, not wei).                                                                                                                                                   |                                                                                                                                                                                                                       |
+| `slippage`                                                                                                                                                                                                            | *components.Slippage*                                                                                                                                                                                                 | :heavy_check_mark:                                                                                                                                                                                                    | Maximum slippage tolerance as a percentage (e.g., 0.5 = 0.5%).                                                                                                                                                        |                                                                                                                                                                                                                       |
+| `gasSponsorship`                                                                                                                                                                                                      | *boolean*                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                    | Optionally request gas sponsorship. If `true`, EIP-712 typed data will be returned that must be signed by the `owner` and submitted to the 'Prepare gas-sponsored transaction' endpoint (`/gas_sponsorship/prepare`). | false                                                                                                                                                                                                                 |

package/docs/models/components/earnswaprequestamountin.md

@@ -0,0 +1,19 @@
+# EarnSwapRequestAmountIn
+
+Human-readable amount of `token_in` to swap (token units, not wei).
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/earnswapresponse.md

@@ -0,0 +1,58 @@
+# EarnSwapResponse
+
+## Example Usage
+
+```typescript
+import { EarnSwapResponse } from "@compass-labs/api-sdk/models/components";
+
+let value: EarnSwapResponse = {
+  transaction: {
+    chainId: "<id>",
+    data: "<value>",
+    from: "<value>",
+    gas: "<value>",
+    to: "<value>",
+    value: "<value>",
+    nonce: "<value>",
+    maxFeePerGas: "<value>",
+    maxPriorityFeePerGas: "<value>",
+  },
+  eip712: {
+    domain: {
+      chainId: 95340,
+      verifyingContract: "<value>",
+    },
+    types: {
+      eip712Domain: [],
+      safeTx: [
+        {
+          name: "<value>",
+          type: "<value>",
+        },
+      ],
+    },
+    primaryType: "SafeTx",
+    message: {
+      to: "<value>",
+      value: "<value>",
+      data: "<value>",
+      operation: 0,
+      safeTxGas: "<value>",
+      baseGas: "<value>",
+      gasPrice: "<value>",
+      gasToken: "<value>",
+      refundReceiver: "<value>",
+      nonce: "<value>",
+    },
+  },
+  estimatedAmountOut: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                                            | Type                                                                                                             | Required                                                                                                         | Description                                                                                                      |
+| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
+| `transaction`                                                                                                    | [components.UnsignedTransaction](../../models/components/unsignedtransaction.md)                                 | :heavy_check_mark:                                                                                               | N/A                                                                                                              |
+| `eip712`                                                                                                         | [components.BatchedSafeOperationsResponseOutput](../../models/components/batchedsafeoperationsresponseoutput.md) | :heavy_check_mark:                                                                                               | N/A                                                                                                              |
+| `estimatedAmountOut`                                                                                             | *string*                                                                                                         | :heavy_check_mark:                                                                                               | N/A                                                                                                              |