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

package/docs/models/components/permit2typeddataoutput.md

@@ -0,0 +1,76 @@
+# Permit2TypedDataOutput
+
+## Example Usage
+
+```typescript
+import { Permit2TypedDataOutput } from "@compass-labs/api-sdk/models/components";
+
+let value: Permit2TypedDataOutput = {
+  types: {
+    eip712Domain: [
+      {
+        name: "name",
+        type: "string",
+      },
+      {
+        name: "chainId",
+        type: "uint256",
+      },
+      {
+        name: "verifyingContract",
+        type: "address",
+      },
+    ],
+    tokenPermissions: [
+      {
+        name: "token",
+        type: "address",
+      },
+      {
+        name: "amount",
+        type: "uint256",
+      },
+    ],
+    permitTransferFrom: [
+      {
+        name: "permitted",
+        type: "TokenPermissions",
+      },
+      {
+        name: "spender",
+        type: "address",
+      },
+      {
+        name: "nonce",
+        type: "uint256",
+      },
+      {
+        name: "deadline",
+        type: "uint256",
+      },
+    ],
+  },
+  domain: {
+    chainId: 387057,
+    verifyingContract: "<value>",
+  },
+  message: {
+    permitted: {
+      token: "<value>",
+      amount: 434763,
+    },
+    spender: "<value>",
+    nonce: 410419,
+    deadline: 192156,
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                            | Type                                                                                                                                                                             | Required                                                                                                                                                                         | Description                                                                                                                                                                      | Example                                                                                                                                                                          |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `types`                                                                                                                                                                          | [components.CompassApiBackendV2ModelsGasSponsorshipPermit2TypedDataEip712Types](../../models/components/compassapibackendv2modelsgassponsorshippermit2typeddataeip712types.md)   | :heavy_check_mark:                                                                                                                                                               | N/A                                                                                                                                                                              |                                                                                                                                                                                  |
+| `primaryType`                                                                                                                                                                    | *"PermitTransferFrom"*                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                               | Root type for signing                                                                                                                                                            | PermitTransferFrom                                                                                                                                                               |
+| `domain`                                                                                                                                                                         | [components.CompassApiBackendV2ModelsGasSponsorshipPermit2TypedDataEip712Domain](../../models/components/compassapibackendv2modelsgassponsorshippermit2typeddataeip712domain.md) | :heavy_check_mark:                                                                                                                                                               | N/A                                                                                                                                                                              |                                                                                                                                                                                  |
+| `message`                                                                                                                                                                        | [components.PermitTransferFromMessage](../../models/components/permittransferfrommessage.md)                                                                                     | :heavy_check_mark:                                                                                                                                                               | N/A                                                                                                                                                                              |                                                                                                                                                                                  |

package/docs/models/components/permitfield.md

@@ -0,0 +1,21 @@
+# PermitField
+
+A field in the Permit type definition.
+
+## Example Usage
+
+```typescript
+import { PermitField } from "@compass-labs/api-sdk/models/components";
+
+let value: PermitField = {
+  name: "<value>",
+  type: "<value>",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `name`             | *string*           | :heavy_check_mark: | N/A                |
+| `type`             | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/components/permitmessage.md

@@ -0,0 +1,27 @@
+# PermitMessage
+
+The message data for an ERC-20 Permit.
+
+## Example Usage
+
+```typescript
+import { PermitMessage } from "@compass-labs/api-sdk/models/components";
+
+let value: PermitMessage = {
+  owner: "<value>",
+  spender: "<value>",
+  value: "<value>",
+  nonce: "<value>",
+  deadline: "<value>",
+};
+```
+
+## Fields
+
+| Field                              | Type                               | Required                           | Description                        |
+| ---------------------------------- | ---------------------------------- | ---------------------------------- | ---------------------------------- |
+| `owner`                            | *string*                           | :heavy_check_mark:                 | Token owner address                |
+| `spender`                          | *string*                           | :heavy_check_mark:                 | Address authorized to spend tokens |
+| `value`                            | *string*                           | :heavy_check_mark:                 | Amount to approve (as string)      |
+| `nonce`                            | *string*                           | :heavy_check_mark:                 | Current permit nonce for the owner |
+| `deadline`                         | *string*                           | :heavy_check_mark:                 | Permit expiry timestamp            |

package/docs/models/components/permittransferfrommessage.md

@@ -0,0 +1,26 @@
+# PermitTransferFromMessage
+
+## Example Usage
+
+```typescript
+import { PermitTransferFromMessage } from "@compass-labs/api-sdk/models/components";
+
+let value: PermitTransferFromMessage = {
+  permitted: {
+    token: "<value>",
+    amount: 434763,
+  },
+  spender: "<value>",
+  nonce: 942324,
+  deadline: 853009,
+};
+```
+
+## Fields
+
+| Field                                                                      | Type                                                                       | Required                                                                   | Description                                                                |
+| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
+| `permitted`                                                                | [components.TokenPermissions](../../models/components/tokenpermissions.md) | :heavy_check_mark:                                                         | N/A                                                                        |
+| `spender`                                                                  | *string*                                                                   | :heavy_check_mark:                                                         | Address allowed to transfer (caller of permitTransferFrom)                 |
+| `nonce`                                                                    | *number*                                                                   | :heavy_check_mark:                                                         | Unique nonce to prevent replay                                             |
+| `deadline`                                                                 | *number*                                                                   | :heavy_check_mark:                                                         | Unix timestamp after which signature expires                               |

package/docs/models/components/permittypeddataresponseinput.md

@@ -0,0 +1,39 @@
+# PermitTypedDataResponseInput
+
+Response containing EIP-712 typed data for ERC-20 Permit signing.
+
+## Example Usage
+
+```typescript
+import { PermitTypedDataResponseInput } from "@compass-labs/api-sdk/models/components";
+
+let value: PermitTypedDataResponseInput = {
+  domain: {
+    name: "<value>",
+    version: "<value>",
+    chainId: 76014,
+    verifyingContract: "<value>",
+  },
+  types: {
+    eip712Domain: [],
+    permit: [],
+  },
+  primaryType: "Permit",
+  message: {
+    owner: "<value>",
+    spender: "<value>",
+    value: "<value>",
+    nonce: "<value>",
+    deadline: "<value>",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                          | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `domain`                                                                                                                                                                       | [components.CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Domain](../../models/components/compassapibackendv2modelsgassponsorshippermittypeddataeip712domain.md) | :heavy_check_mark:                                                                                                                                                             | The EIP-712 domain separator for ERC-20 Permit.                                                                                                                                |
+| `types`                                                                                                                                                                        | [components.CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types](../../models/components/compassapibackendv2modelsgassponsorshippermittypeddataeip712types.md)   | :heavy_check_mark:                                                                                                                                                             | The type definitions for EIP-712 structured data (ERC-20 Permit).                                                                                                              |
+| `primaryType`                                                                                                                                                                  | *"Permit"*                                                                                                                                                                     | :heavy_check_mark:                                                                                                                                                             | Primary type for the structured data                                                                                                                                           |
+| `message`                                                                                                                                                                      | [components.PermitMessage](../../models/components/permitmessage.md)                                                                                                           | :heavy_check_mark:                                                                                                                                                             | The message data for an ERC-20 Permit.                                                                                                                                         |

package/docs/models/components/permittypeddataresponseoutput.md

@@ -0,0 +1,39 @@
+# PermitTypedDataResponseOutput
+
+Response containing EIP-712 typed data for ERC-20 Permit signing.
+
+## Example Usage
+
+```typescript
+import { PermitTypedDataResponseOutput } from "@compass-labs/api-sdk/models/components";
+
+let value: PermitTypedDataResponseOutput = {
+  domain: {
+    name: "<value>",
+    version: "<value>",
+    chainId: 76014,
+    verifyingContract: "<value>",
+  },
+  types: {
+    eip712Domain: [],
+    permit: [],
+  },
+  primaryType: "Permit",
+  message: {
+    owner: "<value>",
+    spender: "<value>",
+    value: "<value>",
+    nonce: "<value>",
+    deadline: "<value>",
+  },
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                          | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `domain`                                                                                                                                                                       | [components.CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Domain](../../models/components/compassapibackendv2modelsgassponsorshippermittypeddataeip712domain.md) | :heavy_check_mark:                                                                                                                                                             | The EIP-712 domain separator for ERC-20 Permit.                                                                                                                                |
+| `types`                                                                                                                                                                        | [components.CompassApiBackendV2ModelsGasSponsorshipPermitTypedDataEip712Types](../../models/components/compassapibackendv2modelsgassponsorshippermittypeddataeip712types.md)   | :heavy_check_mark:                                                                                                                                                             | The type definitions for EIP-712 structured data (ERC-20 Permit).                                                                                                              |
+| `primaryType`                                                                                                                                                                  | *"Permit"*                                                                                                                                                                     | :heavy_check_mark:                                                                                                                                                             | Primary type for the structured data                                                                                                                                           |
+| `message`                                                                                                                                                                      | [components.PermitMessage](../../models/components/permitmessage.md)                                                                                                           | :heavy_check_mark:                                                                                                                                                             | The message data for an ERC-20 Permit.                                                                                                                                         |

package/docs/models/components/portfolio.md

@@ -0,0 +1,28 @@
+# Portfolio
+
+## Example Usage
+
+```typescript
+import { Portfolio } from "@compass-labs/api-sdk/models/components";
+
+let value: Portfolio = {
+  totalValueInUsd: "<value>",
+  tokenBalances: [
+    {
+      amount: "114.16",
+      decimals: 416084,
+      tokenSymbol: "<value>",
+      tokenAddress: "<value>",
+      price: "30.51",
+      tokenValueInUsd: "<value>",
+    },
+  ],
+};
+```
+
+## Fields
+
+| Field                                                                                                                                                                          | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `totalValueInUsd`                                                                                                                                                              | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | Total value of the portfolio in USD                                                                                                                                            |
+| `tokenBalances`                                                                                                                                                                | [components.CompassApiBackendV1ModelsGenericReadResponsePortfolioTokenBalance](../../models/components/compassapibackendv1modelsgenericreadresponseportfoliotokenbalance.md)[] | :heavy_check_mark:                                                                                                                                                             | List of token balances in the portfolio                                                                                                                                        |

package/docs/models/components/position.md

@@ -0,0 +1,70 @@
+# Position
+
+## Example Usage
+
+```typescript
+import { Position } from "@compass-labs/api-sdk/models/components";
+
+let value: Position = {
+  chainId: 24101,
+  totalOpen: 928910,
+  totalClosed: 126791,
+  totalSy: 622814,
+  openPositions: [
+    {
+      marketId: "<id>",
+      pt: {
+        valuation: 6423.15,
+        balance: "<value>",
+      },
+      yt: {
+        valuation: 1467.38,
+        balance: "<value>",
+      },
+      lp: {
+        valuation: 6276.74,
+        balance: "<value>",
+        activeBalance: "<value>",
+      },
+    },
+  ],
+  closedPositions: [
+    {
+      marketId: "<id>",
+      pt: {
+        valuation: 6423.15,
+        balance: "<value>",
+      },
+      yt: {
+        valuation: 1467.38,
+        balance: "<value>",
+      },
+      lp: {
+        valuation: 6276.74,
+        balance: "<value>",
+        activeBalance: "<value>",
+      },
+    },
+  ],
+  syPositions: [
+    {
+      syId: "<id>",
+      balance: "<value>",
+    },
+  ],
+  updatedAt: new Date("2024-12-17T04:58:12.701Z"),
+};
+```
+
+## Fields
+
+| Field                                                                                         | Type                                                                                          | Required                                                                                      | Description                                                                                   |
+| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `chainId`                                                                                     | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `totalOpen`                                                                                   | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `totalClosed`                                                                                 | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `totalSy`                                                                                     | *number*                                                                                      | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `openPositions`                                                                               | [components.OpenPosition](../../models/components/openposition.md)[]                          | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `closedPositions`                                                                             | [components.OpenPosition](../../models/components/openposition.md)[]                          | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `syPositions`                                                                                 | [components.SyPosition](../../models/components/syposition.md)[]                              | :heavy_check_mark:                                                                            | N/A                                                                                           |
+| `updatedAt`                                                                                   | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark:                                                                            | N/A                                                                                           |

package/docs/models/components/positionunion.md

@@ -0,0 +1,32 @@
+# PositionUnion
+
+The user's earn position.
+
+
+## Supported Types
+
+### `components.AavePosition`
+
+```typescript
+const value: components.AavePosition = {
+  type: "AAVE",
+  id: "<id>",
+  amountInUnderlyingToken: "<value>",
+  tokenName: "<value>",
+};
+```
+
+### `components.CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition`
+
+```typescript
+const value:
+  components.CompassApiBackendV2ModelsEarnReadResponsePositionsVaultPosition = {
+    type: "VAULT",
+    id: "<id>",
+    vaultAddress: "<value>",
+    amountInUnderlyingToken: "<value>",
+    tokenName: "<value>",
+    vaultName: "<value>",
+  };
+```
+

package/docs/models/components/protocol.md

@@ -0,0 +1,15 @@
+# Protocol
+
+## Example Usage
+
+```typescript
+import { Protocol } from "@compass-labs/api-sdk/models/components";
+
+let value: Protocol = "aave";
+```
+
+## Values
+
+```typescript
+"aave" | "aerodrome" | "morpho" | "sky" | "uniswap" | "pendle"
+```

package/docs/models/components/r.md

@@ -0,0 +1,19 @@
+# R
+
+The r value of the signature
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 128403;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/repay.md

@@ -0,0 +1,35 @@
+# Repay
+
+## Example Usage
+
+```typescript
+import { Repay } from "@compass-labs/api-sdk/models/components";
+
+let value: Repay = {
+  id: "<id>",
+  timestamp: 529023,
+  txHash: "<value>",
+  amount: 9272.21,
+  reserve: {
+    symbol: "<value>",
+    name: "<value>",
+    underlyingAsset: "<value>",
+  },
+  assetPriceUSD: 3951.28,
+  action: "Repay",
+  block: 361702,
+};
+```
+
+## Fields
+
+| Field                                                                  | Type                                                                   | Required                                                               | Description                                                            |
+| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
+| `id`                                                                   | *string*                                                               | :heavy_check_mark:                                                     | The id of a historical transaction on aave                             |
+| `timestamp`                                                            | *number*                                                               | :heavy_check_mark:                                                     | Timestamp in unix time                                                 |
+| `txHash`                                                               | *string*                                                               | :heavy_check_mark:                                                     | Transaction hash. You can paste these into the search bar on etherscan |
+| `amount`                                                               | *number*                                                               | :heavy_check_mark:                                                     | Quantity of token                                                      |
+| `reserve`                                                              | [components.Reserve](../../models/components/reserve.md)               | :heavy_check_mark:                                                     | N/A                                                                    |
+| `assetPriceUSD`                                                        | *number*                                                               | :heavy_check_mark:                                                     | N/A                                                                    |
+| `action`                                                               | *"Repay"*                                                              | :heavy_check_mark:                                                     | The type of transaction                                                |
+| `block`                                                                | *number*                                                               | :heavy_check_mark:                                                     | N/A                                                                    |

package/docs/models/components/reserve.md

@@ -0,0 +1,22 @@
+# Reserve
+
+## Example Usage
+
+```typescript
+import { Reserve } from "@compass-labs/api-sdk/models/components";
+
+let value: Reserve = {
+  symbol: "<value>",
+  name: "<value>",
+  underlyingAsset: "<value>",
+};
+```
+
+## Fields
+
+| Field                        | Type                         | Required                     | Description                  |
+| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
+| `symbol`                     | *string*                     | :heavy_check_mark:           | Symbol of token.             |
+| `decimals`                   | *number*                     | :heavy_minus_sign:           | Number of decimals of token. |
+| `name`                       | *string*                     | :heavy_check_mark:           | Name of token                |
+| `underlyingAsset`            | *string*                     | :heavy_check_mark:           | Checksum address of Token.   |

package/docs/models/components/s.md

@@ -0,0 +1,19 @@
+# S
+
+The s value of the signature
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 128403;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+

package/docs/models/components/safetxfield.md

@@ -0,0 +1,21 @@
+# SafeTxField
+
+A field in the SafeTx type definition.
+
+## Example Usage
+
+```typescript
+import { SafeTxField } from "@compass-labs/api-sdk/models/components";
+
+let value: SafeTxField = {
+  name: "<value>",
+  type: "<value>",
+};
+```
+
+## Fields
+
+| Field              | Type               | Required           | Description        |
+| ------------------ | ------------------ | ------------------ | ------------------ |
+| `name`             | *string*           | :heavy_check_mark: | N/A                |
+| `type`             | *string*           | :heavy_check_mark: | N/A                |

package/docs/models/components/safetxmessage.md

@@ -0,0 +1,37 @@
+# SafeTxMessage
+
+The message data for a Safe transaction.
+
+## Example Usage
+
+```typescript
+import { SafeTxMessage } from "@compass-labs/api-sdk/models/components";
+
+let value: SafeTxMessage = {
+  to: "<value>",
+  value: "<value>",
+  data: "<value>",
+  operation: 1,
+  safeTxGas: "<value>",
+  baseGas: "<value>",
+  gasPrice: "<value>",
+  gasToken: "<value>",
+  refundReceiver: "<value>",
+  nonce: "<value>",
+};
+```
+
+## Fields
+
+| Field                                                                | Type                                                                 | Required                                                             | Description                                                          |
+| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
+| `to`                                                                 | *string*                                                             | :heavy_check_mark:                                                   | Destination address                                                  |
+| `value`                                                              | *string*                                                             | :heavy_check_mark:                                                   | Value in wei as a string                                             |
+| `data`                                                               | *string*                                                             | :heavy_check_mark:                                                   | Transaction data as hex string                                       |
+| `operation`                                                          | [components.OperationType](../../models/components/operationtype.md) | :heavy_check_mark:                                                   | Safe operation types.                                                |
+| `safeTxGas`                                                          | *string*                                                             | :heavy_check_mark:                                                   | Gas for the Safe transaction                                         |
+| `baseGas`                                                            | *string*                                                             | :heavy_check_mark:                                                   | Base gas costs                                                       |
+| `gasPrice`                                                           | *string*                                                             | :heavy_check_mark:                                                   | Gas price                                                            |
+| `gasToken`                                                           | *string*                                                             | :heavy_check_mark:                                                   | Token address for gas payment                                        |
+| `refundReceiver`                                                     | *string*                                                             | :heavy_check_mark:                                                   | Address to receive gas refund                                        |
+| `nonce`                                                              | *string*                                                             | :heavy_check_mark:                                                   | Safe transaction nonce                                               |

package/docs/models/components/security.md

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

package/docs/models/components/setallowanceparams.md

@@ -0,0 +1,25 @@
+# SetAllowanceParams
+
+Parameters model for setting the token allowance for a given contract.
+
+## Example Usage
+
+```typescript
+import { SetAllowanceParams } from "@compass-labs/api-sdk/models/components";
+
+let value: SetAllowanceParams = {
+  actionType: "SET_ALLOWANCE",
+  token: "<value>",
+  contract: "MorphoMarket",
+  amount: 2204.6,
+};
+```
+
+## Fields
+
+| Field                                                               | Type                                                                | Required                                                            | Description                                                         | Example                                                             |
+| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- |
+| `actionType`                                                        | *"SET_ALLOWANCE"*                                                   | :heavy_check_mark:                                                  | N/A                                                                 | SET_ALLOWANCE                                                       |
+| `token`                                                             | *string*                                                            | :heavy_check_mark:                                                  | The symbol or address of the token for which the allowance is set.. |                                                                     |
+| `contract`                                                          | *components.SetAllowanceParamsContractUnion*                        | :heavy_check_mark:                                                  | The name or address of the contract to set spending allowance for.  |                                                                     |
+| `amount`                                                            | *components.SetAllowanceParamsAmount*                               | :heavy_check_mark:                                                  | The amount to set the allowance to.                                 |                                                                     |

package/docs/models/components/setallowanceparamsamount.md

@@ -0,0 +1,19 @@
+# SetAllowanceParamsAmount
+
+The amount to set the allowance to.
+
+
+## Supported Types
+
+### `number`
+
+```typescript
+const value: number = 1284.03;
+```
+
+### `string`
+
+```typescript
+const value: string = "<value>";
+```
+