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

package/docs/models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionvaultposition.md

@@ -0,0 +1,52 @@
+# CompassApiBackendV1ModelsMorphoReadResponseCheckUserPositionVaultPosition
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV1ModelsMorphoReadResponseCheckUserPositionVaultPosition } from "@compass-labs/api-sdk/models/components";
+
+let value:
+  CompassApiBackendV1ModelsMorphoReadResponseCheckUserPositionVaultPosition = {
+    id: "<id>",
+    state: {
+      pnlUsd: "<value>",
+      assets: "<value>",
+      assetsUsd: "<value>",
+      shares: "<value>",
+    },
+    vault: {
+      address: "6345 Simonis Crest",
+      name: "<value>",
+      symbol: "<value>",
+      whitelisted: true,
+      asset: {
+        name: "<value>",
+        symbol: "<value>",
+        address: "47326 Grange Avenue",
+        decimals: 871956,
+        priceUsd: "<value>",
+        logoURI: "https://favorable-morbidity.net",
+      },
+      dailyApys: {
+        apy: "<value>",
+        netApy: "<value>",
+      },
+      weeklyApys: {
+        apy: "<value>",
+        netApy: "<value>",
+      },
+      monthlyApys: {
+        apy: "<value>",
+        netApy: "<value>",
+      },
+    },
+  };
+```
+
+## Fields
+
+| Field                                                                                                                                                                                  | Type                                                                                                                                                                                   | Required                                                                                                                                                                               | Description                                                                                                                                                                            |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `id`                                                                                                                                                                                   | *string*                                                                                                                                                                               | :heavy_check_mark:                                                                                                                                                                     | N/A                                                                                                                                                                                    |
+| `state`                                                                                                                                                                                | [components.CompassApiBackendV1ModelsMorphoReadResponseCheckUserPositionVaultState](../../models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionvaultstate.md) | :heavy_check_mark:                                                                                                                                                                     | N/A                                                                                                                                                                                    |
+| `vault`                                                                                                                                                                                | [components.Vault](../../models/components/vault.md)                                                                                                                                   | :heavy_check_mark:                                                                                                                                                                     | N/A                                                                                                                                                                                    |

package/docs/models/components/compassapibackendv1modelsmorphoreadresponsecheckuserpositionvaultstate.md

@@ -0,0 +1,24 @@
+# CompassApiBackendV1ModelsMorphoReadResponseCheckUserPositionVaultState
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV1ModelsMorphoReadResponseCheckUserPositionVaultState } from "@compass-labs/api-sdk/models/components";
+
+let value:
+  CompassApiBackendV1ModelsMorphoReadResponseCheckUserPositionVaultState = {
+    pnlUsd: "<value>",
+    assets: "<value>",
+    assetsUsd: "<value>",
+    shares: "<value>",
+  };
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `pnlUsd`           | *string*           | :heavy_check_mark: | N/A                |
+| `assets`           | *string*           | :heavy_check_mark: | N/A                |
+| `assetsUsd`        | *string*           | :heavy_check_mark: | N/A                |
+| `shares`           | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetmarketapydata.md

@@ -0,0 +1,23 @@
+# CompassApiBackendV1ModelsMorphoReadResponseGetMarketApyData
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV1ModelsMorphoReadResponseGetMarketApyData } from "@compass-labs/api-sdk/models/components";
+
+let value: CompassApiBackendV1ModelsMorphoReadResponseGetMarketApyData = {
+  borrowApy: "<value>",
+  netBorrowApy: "<value>",
+  netSupplyApy: "<value>",
+  supplyApy: "<value>",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `borrowApy`        | *string*           | :heavy_check_mark: | N/A                |
+| `netBorrowApy`     | *string*           | :heavy_check_mark: | N/A                |
+| `netSupplyApy`     | *string*           | :heavy_check_mark: | N/A                |
+| `supplyApy`        | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetmarketasset.md

@@ -0,0 +1,27 @@
+# CompassApiBackendV1ModelsMorphoReadResponseGetMarketAsset
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV1ModelsMorphoReadResponseGetMarketAsset } from "@compass-labs/api-sdk/models/components";
+
+let value: CompassApiBackendV1ModelsMorphoReadResponseGetMarketAsset = {
+  address: "7954 Larch Close",
+  symbol: "<value>",
+  name: "<value>",
+  decimals: 977902,
+  priceUsd: "<value>",
+  logoURI: "https://yearly-dream.biz",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `address`          | *string*           | :heavy_check_mark: | N/A                |
+| `symbol`           | *string*           | :heavy_check_mark: | N/A                |
+| `name`             | *string*           | :heavy_check_mark: | N/A                |
+| `decimals`         | *number*           | :heavy_check_mark: | N/A                |
+| `priceUsd`         | *string*           | :heavy_check_mark: | N/A                |
+| `logoURI`          | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetmarketmarketstate.md

@@ -0,0 +1,28 @@
+# CompassApiBackendV1ModelsMorphoReadResponseGetMarketMarketState
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV1ModelsMorphoReadResponseGetMarketMarketState } from "@compass-labs/api-sdk/models/components";
+
+let value: CompassApiBackendV1ModelsMorphoReadResponseGetMarketMarketState = {
+  utilization: "<value>",
+  borrowAssets: "<value>",
+  liquidityAssets: "<value>",
+  totalLiquidity: "<value>",
+};
+```
+
+## Fields
+
+| Field                 | Type                  | Required              | Description           |
+| --------------------- | --------------------- | --------------------- | --------------------- |
+| `utilization`         | *string*              | :heavy_check_mark:    | N/A                   |
+| `collateralAssets`    | *string*              | :heavy_minus_sign:    | N/A                   |
+| `collateralAssetsUsd` | *string*              | :heavy_minus_sign:    | N/A                   |
+| `borrowAssets`        | *string*              | :heavy_check_mark:    | N/A                   |
+| `borrowAssetsUsd`     | *string*              | :heavy_minus_sign:    | N/A                   |
+| `liquidityAssets`     | *string*              | :heavy_check_mark:    | N/A                   |
+| `liquidityAssetsUsd`  | *string*              | :heavy_minus_sign:    | N/A                   |
+| `totalLiquidity`      | *string*              | :heavy_check_mark:    | N/A                   |
+| `totalLiquidityUsd`   | *string*              | :heavy_minus_sign:    | N/A                   |

package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetmarketsasset.md

@@ -0,0 +1,23 @@
+# CompassApiBackendV1ModelsMorphoReadResponseGetMarketsAsset
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV1ModelsMorphoReadResponseGetMarketsAsset } from "@compass-labs/api-sdk/models/components";
+
+let value: CompassApiBackendV1ModelsMorphoReadResponseGetMarketsAsset = {
+  address: "73719 Amelie Manor",
+  symbol: "<value>",
+  name: "<value>",
+  decimals: 613797,
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `address`          | *string*           | :heavy_check_mark: | N/A                |
+| `symbol`           | *string*           | :heavy_check_mark: | N/A                |
+| `name`             | *string*           | :heavy_check_mark: | N/A                |
+| `decimals`         | *number*           | :heavy_check_mark: | N/A                |

package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetmarketsmarketstate.md

@@ -0,0 +1,31 @@
+# CompassApiBackendV1ModelsMorphoReadResponseGetMarketsMarketState
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV1ModelsMorphoReadResponseGetMarketsMarketState } from "@compass-labs/api-sdk/models/components";
+
+let value: CompassApiBackendV1ModelsMorphoReadResponseGetMarketsMarketState = {
+  borrowApy: 6783.31,
+  borrowAssets: 434012,
+  borrowAssetsUsd: 269.23,
+  supplyApy: 7105.65,
+  supplyAssets: 577262,
+  supplyAssetsUsd: 4759.24,
+  fee: 8984.01,
+  utilization: 8580.96,
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `borrowApy`        | *number*           | :heavy_check_mark: | N/A                |
+| `borrowAssets`     | *number*           | :heavy_check_mark: | N/A                |
+| `borrowAssetsUsd`  | *number*           | :heavy_check_mark: | N/A                |
+| `supplyApy`        | *number*           | :heavy_check_mark: | N/A                |
+| `supplyAssets`     | *number*           | :heavy_check_mark: | N/A                |
+| `supplyAssetsUsd`  | *number*           | :heavy_check_mark: | N/A                |
+| `fee`              | *number*           | :heavy_check_mark: | N/A                |
+| `utilization`      | *number*           | :heavy_check_mark: | N/A                |

package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetvaultsasset.md

@@ -0,0 +1,25 @@
+# CompassApiBackendV1ModelsMorphoReadResponseGetVaultsAsset
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV1ModelsMorphoReadResponseGetVaultsAsset } from "@compass-labs/api-sdk/models/components";
+
+let value: CompassApiBackendV1ModelsMorphoReadResponseGetVaultsAsset = {
+  symbol: "<value>",
+  address: "43121 Rice Bypass",
+  decimals: 938619,
+  chain: {
+    id: 111446,
+  },
+};
+```
+
+## Fields
+
+| Field                                                        | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `symbol`                                                     | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `address`                                                    | *string*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `decimals`                                                   | *number*                                                     | :heavy_check_mark:                                           | N/A                                                          |
+| `chain`                                                      | [components.ChainInfo](../../models/components/chaininfo.md) | :heavy_check_mark:                                           | N/A                                                          |

package/docs/models/components/compassapibackendv1modelsmorphoreadresponsegetvaultsvaultstate.md

@@ -0,0 +1,28 @@
+# CompassApiBackendV1ModelsMorphoReadResponseGetVaultsVaultState
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV1ModelsMorphoReadResponseGetVaultsVaultState } from "@compass-labs/api-sdk/models/components";
+
+let value: CompassApiBackendV1ModelsMorphoReadResponseGetVaultsVaultState = {
+  id: "<id>",
+  apy: 5923.62,
+  netApy: 2383.88,
+  totalAssets: 132455,
+  fee: 6635.24,
+  timelock: 346147,
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `id`               | *string*           | :heavy_check_mark: | N/A                |
+| `apy`              | *number*           | :heavy_check_mark: | N/A                |
+| `netApy`           | *number*           | :heavy_check_mark: | N/A                |
+| `totalAssets`      | *number*           | :heavy_check_mark: | N/A                |
+| `totalAssetsUsd`   | *number*           | :heavy_minus_sign: | N/A                |
+| `fee`              | *number*           | :heavy_check_mark: | N/A                |
+| `timelock`         | *number*           | :heavy_check_mark: | N/A                |

package/docs/models/components/compassapibackendv1modelspendlereadresponsemarketuserposition.md

@@ -0,0 +1,28 @@
+# CompassApiBackendV1ModelsPendleReadResponseMarketUserPosition
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV1ModelsPendleReadResponseMarketUserPosition } from "@compass-labs/api-sdk/models/components";
+
+let value: CompassApiBackendV1ModelsPendleReadResponseMarketUserPosition = {
+  claimableYield: "<value>",
+  syBalance: "<value>",
+  ptBalance: "<value>",
+  ytBalance: "<value>",
+  lpBalance: "<value>",
+  underlyingTokenBalance: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                            | Type                                                             | Required                                                         | Description                                                      |
+| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- |
+| `claimableYield`                                                 | *string*                                                         | :heavy_check_mark:                                               | The amount of yield that can be claimed in the underlying token. |
+| `syBalance`                                                      | *string*                                                         | :heavy_check_mark:                                               | The amount of SY tokens the user currently holds.                |
+| `ptBalance`                                                      | *string*                                                         | :heavy_check_mark:                                               | The amount of PT tokens the user currently holds.                |
+| `ytBalance`                                                      | *string*                                                         | :heavy_check_mark:                                               | The amount of YT tokens the user currently holds.                |
+| `lpBalance`                                                      | *string*                                                         | :heavy_check_mark:                                               | The amount of LP tokens the user currently holds.                |
+| `underlyingTokenBalance`                                         | *string*                                                         | :heavy_check_mark:                                               | The amount of underlying tokens the user currently holds.        |
+| `accountingAssetBalance`                                         | *string*                                                         | :heavy_minus_sign:                                               | The amount of accounting assets the user currently holds.        |

package/docs/models/components/compassapibackendv1modelspendlereadresponsepositionstokenbalance.md

@@ -0,0 +1,19 @@
+# CompassApiBackendV1ModelsPendleReadResponsePositionsTokenBalance
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV1ModelsPendleReadResponsePositionsTokenBalance } from "@compass-labs/api-sdk/models/components";
+
+let value: CompassApiBackendV1ModelsPendleReadResponsePositionsTokenBalance = {
+  valuation: 194.52,
+  balance: "<value>",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `valuation`        | *number*           | :heavy_check_mark: | N/A                |
+| `balance`          | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/components/compassapibackendv1modelsvaultsreadresponsevaultuserposition.md

@@ -0,0 +1,19 @@
+# CompassApiBackendV1ModelsVaultsReadResponseVaultUserPosition
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV1ModelsVaultsReadResponseVaultUserPosition } from "@compass-labs/api-sdk/models/components";
+
+let value: CompassApiBackendV1ModelsVaultsReadResponseVaultUserPosition = {
+  amountOfShares: "<value>",
+  amountInUnderlyingToken: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                                         | Type                                                                                                          | Required                                                                                                      | Description                                                                                                   |
+| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
+| `amountOfShares`                                                                                              | *string*                                                                                                      | :heavy_check_mark:                                                                                            | The number of vault share tokens representing the user’s proportional ownership of the assets in the vault.   |
+| `amountInUnderlyingToken`                                                                                     | *string*                                                                                                      | :heavy_check_mark:                                                                                            | The equivalent value of the user’s vault shares, denominated in the vault’s underlying asset (deposit token). |

package/docs/models/components/compassapibackendv1modelswildcatreadresponsemarketuserposition.md

@@ -0,0 +1,19 @@
+# CompassApiBackendV1ModelsWildcatReadResponseMarketUserPosition
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV1ModelsWildcatReadResponseMarketUserPosition } from "@compass-labs/api-sdk/models/components";
+
+let value: CompassApiBackendV1ModelsWildcatReadResponseMarketUserPosition = {
+  marketTokenBalance: "<value>",
+  underlyingTokenBalance: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                                     | Type                                                                                      | Required                                                                                  | Description                                                                               |
+| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
+| `marketTokenBalance`                                                                      | *string*                                                                                  | :heavy_check_mark:                                                                        | The quantity of market share tokens the user holds.                                       |
+| `underlyingTokenBalance`                                                                  | *string*                                                                                  | :heavy_check_mark:                                                                        | The total current value of the user's market tokens, denominated in the underlying asset. |

package/docs/models/components/compassapibackendv2modelsearnreadresponsepositionsvaultposition.md

@@ -0,0 +1,27 @@
+# CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition } from "@compass-labs/api-sdk/models/components";
+
+let value: CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition = {
+  type: "VAULT",
+  id: "<id>",
+  vaultAddress: "<value>",
+  amountInUnderlyingToken: "<value>",
+  tokenName: "<value>",
+  vaultName: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                          | Type                                                           | Required                                                       | Description                                                    |
+| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
+| `type`                                                         | *"VAULT"*                                                      | :heavy_check_mark:                                             | The market type discriminator.                                 |
+| `id`                                                           | *string*                                                       | :heavy_check_mark:                                             | Base64-encoded position identifier.                            |
+| `vaultAddress`                                                 | *string*                                                       | :heavy_check_mark:                                             | The vault address you are depositing to.                       |
+| `amountInUnderlyingToken`                                      | *string*                                                       | :heavy_check_mark:                                             | The user's position value denominated in the underlying token. |
+| `tokenName`                                                    | *string*                                                       | :heavy_check_mark:                                             | Symbol of the underlying token (e.g., USDC).                   |
+| `vaultName`                                                    | *string*                                                       | :heavy_check_mark:                                             | Name of the vault token (share token).                         |

package/docs/models/components/compassapibackendv2modelsgassponsorshippermit2typeddataeip712domain.md

@@ -0,0 +1,21 @@
+# CompassApiBackendV2ModelsGasSponsorshipPermit2TypedDataEip712Domain
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV2ModelsGasSponsorshipPermit2TypedDataEip712Domain } from "@compass-labs/api-sdk/models/components";
+
+let value: CompassApiBackendV2ModelsGasSponsorshipPermit2TypedDataEip712Domain =
+  {
+    chainId: 640875,
+    verifyingContract: "<value>",
+  };
+```
+
+## Fields
+
+| Field                    | Type                     | Required                 | Description              | Example                  |
+| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
+| `name`                   | *"Permit2"*              | :heavy_minus_sign:       | Must be 'Permit2'        | Permit2                  |
+| `chainId`                | *number*                 | :heavy_check_mark:       | EVM chain ID             |                          |
+| `verifyingContract`      | *string*                 | :heavy_check_mark:       | Permit2 contract address |                          |

package/docs/models/components/compassapibackendv2modelsgassponsorshippermit2typeddataeip712types.md

@@ -0,0 +1,61 @@
+# CompassApiBackendV2ModelsGasSponsorshipPermit2TypedDataEip712Types
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV2ModelsGasSponsorshipPermit2TypedDataEip712Types } from "@compass-labs/api-sdk/models/components";
+
+let value: CompassApiBackendV2ModelsGasSponsorshipPermit2TypedDataEip712Types =
+  {
+    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",
+      },
+    ],
+  };
+```
+
+## Fields
+
+| Field                                                                                                                                                                                | Type                                                                                                                                                                                 | Required                                                                                                                                                                             | Description                                                                                                                                                                          | Example                                                                                                                                                                              |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `eip712Domain`                                                                                                                                                                       | [components.Eip712Field](../../models/components/eip712field.md)[]                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                   | Standard EIP-712 domain type                                                                                                                                                         | [<br/>{<br/>"name": "name",<br/>"type": "string"<br/>},<br/>{<br/>"name": "chainId",<br/>"type": "uint256"<br/>},<br/>{<br/>"name": "verifyingContract",<br/>"type": "address"<br/>}<br/>] |
+| `tokenPermissions`                                                                                                                                                                   | [components.Eip712Field](../../models/components/eip712field.md)[]                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                   | TokenPermissions struct                                                                                                                                                              | [<br/>{<br/>"name": "token",<br/>"type": "address"<br/>},<br/>{<br/>"name": "amount",<br/>"type": "uint256"<br/>}<br/>]                                                              |
+| `permitTransferFrom`                                                                                                                                                                 | [components.Eip712Field](../../models/components/eip712field.md)[]                                                                                                                   | :heavy_minus_sign:                                                                                                                                                                   | Main permit message type                                                                                                                                                             | [<br/>{<br/>"name": "permitted",<br/>"type": "TokenPermissions"<br/>},<br/>{<br/>"name": "spender",<br/>"type": "address"<br/>},<br/>{<br/>"name": "nonce",<br/>"type": "uint256"<br/>},<br/>{<br/>"name": "deadline",<br/>"type": "uint256"<br/>}<br/>] |

package/docs/models/components/compassapibackendv2modelsgassponsorshippermittypeddataeip712domain.md

@@ -0,0 +1,26 @@
+# CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Domain
+
+The EIP-712 domain separator for ERC-20 Permit.
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Domain } from "@compass-labs/api-sdk/models/components";
+
+let value: CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Domain =
+  {
+    name: "<value>",
+    version: "<value>",
+    chainId: 561227,
+    verifyingContract: "<value>",
+  };
+```
+
+## Fields
+
+| Field                              | Type                               | Required                           | Description                        |
+| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
+| `name`                             | *string*                           | :heavy_check_mark:                 | Token name                         |
+| `version`                          | *string*                           | :heavy_check_mark:                 | Token version (usually '1' or '2') |
+| `chainId`                          | *number*                           | :heavy_check_mark:                 | Chain ID                           |
+| `verifyingContract`                | *string*                           | :heavy_check_mark:                 | Token contract address             |

package/docs/models/components/compassapibackendv2modelsgassponsorshippermittypeddataeip712types.md

@@ -0,0 +1,21 @@
+# CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types
+
+The type definitions for EIP-712 structured data (ERC-20 Permit).
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types } from "@compass-labs/api-sdk/models/components";
+
+let value: CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types = {
+  eip712Domain: [],
+  permit: [],
+};
+```
+
+## Fields
+
+| Field                                                                          | Type                                                                           | Required                                                                       | Description                                                                    |
+| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
+| `eip712Domain`                                                                 | [components.Eip712DomainField](../../models/components/eip712domainfield.md)[] | :heavy_check_mark:                                                             | EIP712Domain type definition                                                   |
+| `permit`                                                                       | [components.PermitField](../../models/components/permitfield.md)[]             | :heavy_check_mark:                                                             | Permit type definition                                                         |

package/docs/models/components/compassapibackendv2modelssafetransactresponsebatchedsafeoperationseip712domain.md

@@ -0,0 +1,23 @@
+# CompassApiBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Domain
+
+The EIP-712 domain separator for Safe transactions.
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Domain } from "@compass-labs/api-sdk/models/components";
+
+let value:
+  CompassApiBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Domain =
+    {
+      chainId: 923368,
+      verifyingContract: "<value>",
+    };
+```
+
+## Fields
+
+| Field                             | Type                              | Required                          | Description                       |
+| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
+| `chainId`                         | *number*                          | :heavy_check_mark:                | Chain ID for the Safe transaction |
+| `verifyingContract`               | *string*                          | :heavy_check_mark:                | Address of the Safe contract      |

package/docs/models/components/compassapibackendv2modelssafetransactresponsebatchedsafeoperationseip712types.md

@@ -0,0 +1,23 @@
+# CompassApiBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Types
+
+The type definitions for EIP-712 structured data.
+
+## Example Usage
+
+```typescript
+import { CompassApiBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Types } from "@compass-labs/api-sdk/models/components";
+
+let value:
+  CompassApiBackendV2ModelsSafeTransactResponseBatchedSafeOperationsEip712Types =
+    {
+      eip712Domain: [],
+      safeTx: [],
+    };
+```
+
+## Fields
+
+| Field                                                                          | Type                                                                           | Required                                                                       | Description                                                                    |
+| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
+| `eip712Domain`                                                                 | [components.Eip712DomainField](../../models/components/eip712domainfield.md)[] | :heavy_check_mark:                                                             | EIP712Domain type definition                                                   |
+| `safeTx`                                                                       | [components.SafeTxField](../../models/components/safetxfield.md)[]             | :heavy_check_mark:                                                             | SafeTx type definition                                                         |

package/docs/models/components/cooldownend.md

@@ -0,0 +1,19 @@
+# CooldownEnd
+
+When the cooldown period ends. ISO 8601 format. UTC timezone.
+
+
+## Supported Types
+
+### `Date`
+
+```typescript
+const value: Date = new Date("2023-12-07T03:31:58.587Z");
+```
+
+### `boolean`
+
+```typescript
+const value: boolean = true;
+```
+

package/docs/models/components/cooldownposition.md

@@ -0,0 +1,21 @@
+# CooldownPosition
+
+## Example Usage
+
+```typescript
+import { CooldownPosition } from "@compass-labs/api-sdk/models/components";
+
+let value: CooldownPosition = {
+  amountInUnderlyingAsset: "<value>",
+  cooldownEnd: new Date("2024-06-19T22:17:27.773Z"),
+  canBeWithdrawn: false,
+};
+```
+
+## Fields
+
+| Field                                                         | Type                                                          | Required                                                      | Description                                                   |
+| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
+| `amountInUnderlyingAsset`                                     | *string*                                                      | :heavy_check_mark:                                            | The amount of USDe currently in a cooldown period.            |
+| `cooldownEnd`                                                 | *components.CooldownEnd*                                      | :heavy_check_mark:                                            | When the cooldown period ends. ISO 8601 format. UTC timezone. |
+| `canBeWithdrawn`                                              | *boolean*                                                     | :heavy_check_mark:                                            | Whether the USDe in cooldown can be withdrawn at this moment. |