@dynamic-labs/sdk-api-core 0.0.940 → 0.0.941

package/src/models/SolanaTransactionOptimizationRequest.d.ts

@@ -16,7 +16,7 @@
  */
 export interface SolanaTransactionOptimizationRequest {
     /**
-     *
+     * Base64-encoded Solana transaction to optimize
      * @type {string}
      * @memberof SolanaTransactionOptimizationRequest
      */

package/src/models/SolanaTransactionOptimizationResponse.d.ts

@@ -16,7 +16,7 @@
  */
 export interface SolanaTransactionOptimizationResponse {
     /**
-     *
+     * Base64-encoded optimized Solana transaction
      * @type {string}
      * @memberof SolanaTransactionOptimizationResponse
      */

package/src/models/SsoProvider.d.ts

@@ -71,13 +71,13 @@ export interface SsoProvider {
      */
     enforceOnlySSO: boolean;
     /**
-     *
+     * ISO 8601 timestamp of when the SSO provider was created
      * @type {Date}
      * @memberof SsoProvider
      */
     createdAt: Date;
     /**
-     *
+     * ISO 8601 timestamp of when the SSO provider was last updated
      * @type {Date}
      * @memberof SsoProvider
      */

package/src/models/SupportedOfframpsResponse.d.ts

@@ -17,7 +17,7 @@ import { RampConfiguration } from './RampConfiguration';
  */
 export interface SupportedOfframpsResponse {
     /**
-     *
+     * List of supported offramp provider configurations
      * @type {Array<RampConfiguration>}
      * @memberof SupportedOfframpsResponse
      */

package/src/models/SupportedOnrampsResponse.d.ts

@@ -17,7 +17,7 @@ import { RampConfiguration } from './RampConfiguration';
  */
 export interface SupportedOnrampsResponse {
     /**
-     *
+     * List of supported onramp provider configurations
      * @type {Array<RampConfiguration>}
      * @memberof SupportedOnrampsResponse
      */

package/src/models/SupportedSecurityMethod.d.ts

@@ -16,25 +16,25 @@
  */
 export interface SupportedSecurityMethod {
     /**
-     *
+     * Whether this security method is selected by default
      * @type {boolean}
      * @memberof SupportedSecurityMethod
      */
     isDefault: boolean;
     /**
-     *
+     * Whether this security method is currently enabled
      * @type {boolean}
      * @memberof SupportedSecurityMethod
      */
     isEnabled: boolean;
     /**
-     *
+     * Whether this security method serves as a permanent authenticator that cannot be removed
      * @type {boolean}
      * @memberof SupportedSecurityMethod
      */
     isPermanentAuthenticator: boolean;
     /**
-     *
+     * Display position order of this security method in the list
      * @type {number}
      * @memberof SupportedSecurityMethod
      */

package/src/models/SwapFee.d.ts

@@ -17,25 +17,25 @@ import { SwapToken } from './SwapToken';
  */
 export interface SwapFee {
     /**
-     *
+     * Fee amount in the token's native units
      * @type {string}
      * @memberof SwapFee
      */
     amount: string;
     /**
-     *
+     * Fee amount converted to USD
      * @type {string}
      * @memberof SwapFee
      */
     amountUSD?: string;
     /**
-     *
+     * Whether this fee is already included in the swap quote
      * @type {boolean}
      * @memberof SwapFee
      */
     included: boolean;
     /**
-     *
+     * Display name describing the fee type
      * @type {string}
      * @memberof SwapFee
      */

package/src/models/SwapGasCost.d.ts

@@ -17,13 +17,13 @@ import { SwapToken } from './SwapToken';
  */
 export interface SwapGasCost {
     /**
-     *
+     * Gas cost amount in the native token's units
      * @type {string}
      * @memberof SwapGasCost
      */
     amount: string;
     /**
-     *
+     * Gas cost amount converted to USD
      * @type {string}
      * @memberof SwapGasCost
      */

package/src/models/SwapQuoteResponse.d.ts

@@ -26,7 +26,7 @@ export interface SwapQuoteResponse {
      */
     approvalAddress?: string;
     /**
-     *
+     * List of fee costs associated with the swap
      * @type {Array<SwapFee>}
      * @memberof SwapQuoteResponse
      */
@@ -38,13 +38,13 @@ export interface SwapQuoteResponse {
      */
     from: SwapQuoteResponseSide;
     /**
-     *
+     * Total estimated gas cost in USD
      * @type {string}
      * @memberof SwapQuoteResponse
      */
     gasCostUSD?: string;
     /**
-     *
+     * Unique identifier of the swap quote
      * @type {string}
      * @memberof SwapQuoteResponse
      */
@@ -56,7 +56,7 @@ export interface SwapQuoteResponse {
      */
     signingPayload?: SwapSigningPayload;
     /**
-     *
+     * List of steps required to execute the swap
      * @type {Array<SwapStep>}
      * @memberof SwapQuoteResponse
      */

package/src/models/SwapQuoteResponseSide.d.ts

@@ -17,13 +17,13 @@ import { SwapToken } from './SwapToken';
  */
 export interface SwapQuoteResponseSide {
     /**
-     *
+     * Token contract address
      * @type {string}
      * @memberof SwapQuoteResponseSide
      */
     address: string;
     /**
-     *
+     * Token amount in the smallest unit
      * @type {string}
      * @memberof SwapQuoteResponseSide
      */
@@ -35,7 +35,7 @@ export interface SwapQuoteResponseSide {
      */
     amountMin?: string;
     /**
-     *
+     * Token amount converted to USD
      * @type {string}
      * @memberof SwapQuoteResponseSide
      */

package/src/models/SwapStatusResponse.d.ts

@@ -16,43 +16,43 @@
  */
 export interface SwapStatusResponse {
     /**
-     *
+     * Error message if the swap failed
      * @type {string}
      * @memberof SwapStatusResponse
      */
     error?: string;
     /**
-     *
+     * URL to view the swap transaction on a block explorer
      * @type {string}
      * @memberof SwapStatusResponse
      */
     explorerLink?: string;
     /**
-     *
+     * Human-readable status message for the swap
      * @type {string}
      * @memberof SwapStatusResponse
      */
     message?: string;
     /**
-     *
+     * URL to view the receiving transaction on a block explorer
      * @type {string}
      * @memberof SwapStatusResponse
      */
     receivingTxLink?: string;
     /**
-     *
+     * URL to view the sending transaction on a block explorer
      * @type {string}
      * @memberof SwapStatusResponse
      */
     sendingTxLink?: string;
     /**
-     *
+     * Current status of the swap operation
      * @type {string}
      * @memberof SwapStatusResponse
      */
     status: SwapStatusResponseStatusEnum;
     /**
-     *
+     * Detailed substatus providing additional context on the swap state
      * @type {string}
      * @memberof SwapStatusResponse
      */

package/src/models/SwapStep.d.ts

@@ -19,7 +19,7 @@ import { SwapStepSide } from './SwapStepSide';
  */
 export interface SwapStep {
     /**
-     *
+     * List of fee costs for this swap step
      * @type {Array<SwapFee>}
      * @memberof SwapStep
      */
@@ -31,13 +31,13 @@ export interface SwapStep {
      */
     from: SwapStepSide;
     /**
-     *
+     * List of gas costs for this swap step
      * @type {Array<SwapGasCost>}
      * @memberof SwapStep
      */
     gasCosts?: Array<SwapGasCost>;
     /**
-     *
+     * Unique identifier of the swap step
      * @type {string}
      * @memberof SwapStep
      */
@@ -49,13 +49,13 @@ export interface SwapStep {
      */
     to: SwapStepSide;
     /**
-     *
+     * Name of the tool or protocol used for this swap step
      * @type {string}
      * @memberof SwapStep
      */
     tool: string;
     /**
-     *
+     * Type of swap step (e.g. swap, bridge, approve)
      * @type {string}
      * @memberof SwapStep
      */

package/src/models/SwapStepSide.d.ts

@@ -17,19 +17,19 @@ import { SwapToken } from './SwapToken';
  */
 export interface SwapStepSide {
     /**
-     *
+     * Token amount in the smallest unit
      * @type {string}
      * @memberof SwapStepSide
      */
     amount: string;
     /**
-     *
+     * Minimum token amount expected accounting for slippage
      * @type {string}
      * @memberof SwapStepSide
      */
     amountMin?: string;
     /**
-     *
+     * Token amount converted to USD
      * @type {string}
      * @memberof SwapStepSide
      */

package/src/models/SwapToken.d.ts

@@ -16,49 +16,49 @@
  */
 export interface SwapToken {
     /**
-     *
+     * Token contract address
      * @type {string}
      * @memberof SwapToken
      */
     address: string;
     /**
-     *
+     * Chain ID where the token resides
      * @type {string}
      * @memberof SwapToken
      */
     chainId: string;
     /**
-     *
+     * Unique key identifier for the token across chains
      * @type {string}
      * @memberof SwapToken
      */
     coinKey?: string;
     /**
-     *
+     * Number of decimal places the token supports
      * @type {number}
      * @memberof SwapToken
      */
     decimals: number;
     /**
-     *
+     * URL of the token logo image
      * @type {string}
      * @memberof SwapToken
      */
     logoURI?: string;
     /**
-     *
+     * Display name of the token
      * @type {string}
      * @memberof SwapToken
      */
     name: string;
     /**
-     *
+     * Current price of the token in USD
      * @type {string}
      * @memberof SwapToken
      */
     priceUSD?: string;
     /**
-     *
+     * Ticker symbol of the token
      * @type {string}
      * @memberof SwapToken
      */

package/src/models/TelegramUser.d.ts

@@ -16,43 +16,43 @@
  */
 export interface TelegramUser {
     /**
-     *
+     * Unique Telegram user identifier
      * @type {number}
      * @memberof TelegramUser
      */
     id: number;
     /**
-     *
+     * First name of the Telegram user
      * @type {string}
      * @memberof TelegramUser
      */
     firstName?: string;
     /**
-     *
+     * Last name of the Telegram user
      * @type {string}
      * @memberof TelegramUser
      */
     lastName?: string;
     /**
-     *
+     * Authentication hash used to verify the Telegram user data
      * @type {string}
      * @memberof TelegramUser
      */
     hash: string;
     /**
-     *
+     * URL of the Telegram user's profile photo
      * @type {string}
      * @memberof TelegramUser
      */
     photoURL?: string;
     /**
-     *
+     * Telegram username
      * @type {string}
      * @memberof TelegramUser
      */
     username?: string;
     /**
-     *
+     * Unix timestamp of when the Telegram authentication occurred
      * @type {string}
      * @memberof TelegramUser
      */

package/src/models/TokenBalance.d.ts

@@ -16,7 +16,7 @@
  */
 export interface TokenBalance {
     /**
-     *
+     * Network identifier where the token balance resides
      * @type {number}
      * @memberof TokenBalance
      */
@@ -28,67 +28,67 @@ export interface TokenBalance {
      */
     address: string;
     /**
-     *
+     * Display name of the token
      * @type {string}
      * @memberof TokenBalance
      */
     name: string;
     /**
-     *
+     * Ticker symbol of the token
      * @type {string}
      * @memberof TokenBalance
      */
     symbol: string;
     /**
-     *
+     * Number of decimal places the token supports
      * @type {number}
      * @memberof TokenBalance
      */
     decimals: number;
     /**
-     *
+     * URL of the token logo image
      * @type {string}
      * @memberof TokenBalance
      */
     logoURI: string;
     /**
-     *
+     * Human-readable token balance adjusted for decimals
      * @type {number}
      * @memberof TokenBalance
      */
     balance: number;
     /**
-     *
+     * Raw token balance in the smallest unit
      * @type {number}
      * @memberof TokenBalance
      */
     rawBalance: number;
     /**
-     *
+     * Current price per token in USD
      * @type {number}
      * @memberof TokenBalance
      */
     price?: number;
     /**
-     *
+     * Total market value of the balance in USD
      * @type {number}
      * @memberof TokenBalance
      */
     marketValue?: number;
     /**
-     *
+     * Size of the token's liquidity pool in USD
      * @type {number}
      * @memberof TokenBalance
      */
     liquidityPoolSizeUsd?: number;
     /**
-     *
+     * Total circulating supply of the token
      * @type {string}
      * @memberof TokenBalance
      */
     totalSupply?: string;
     /**
-     *
+     * Whether this is the chain's native token
      * @type {boolean}
      * @memberof TokenBalance
      */

package/src/models/TooManyRequests.d.ts

@@ -16,7 +16,7 @@
  */
 export interface TooManyRequests {
     /**
-     *
+     * Human-readable error message indicating rate limit exceeded
      * @type {string}
      * @memberof TooManyRequests
      */

package/src/models/TransferDestination.d.ts

@@ -22,7 +22,7 @@ export interface TransferDestination {
      */
     address: string;
     /**
-     *
+     * List of tokens available for transfer to this destination
      * @type {Array<string>}
      * @memberof TransferDestination
      */

package/src/models/TurnkeyCreateWalletAccountsRequestBodyParameters.d.ts

@@ -23,7 +23,7 @@ export interface TurnkeyCreateWalletAccountsRequestBodyParameters {
      */
     walletId: string;
     /**
-     *
+     * List of wallet account configurations to create
      * @type {Array<TurnkeyWalletAccount>}
      * @memberof TurnkeyCreateWalletAccountsRequestBodyParameters
      */

package/src/models/TurnkeyDeleteEmbeddedWalletsRequestBodyParameters.d.ts

@@ -16,13 +16,13 @@
  */
 export interface TurnkeyDeleteEmbeddedWalletsRequestBodyParameters {
     /**
-     *
+     * List of wallet identifiers to delete
      * @type {Array<string>}
      * @memberof TurnkeyDeleteEmbeddedWalletsRequestBodyParameters
      */
     walletIds: Array<string>;
     /**
-     *
+     * Whether to allow deletion of wallets that have not been exported
      * @type {boolean}
      * @memberof TurnkeyDeleteEmbeddedWalletsRequestBodyParameters
      */

package/src/models/TurnkeySignedRequest.d.ts

@@ -17,7 +17,7 @@ import { TurnkeyStamp } from './TurnkeyStamp';
  */
 export interface TurnkeySignedRequest {
     /**
-     *
+     * JSON-encoded body of the Turnkey signed request
      * @type {string}
      * @memberof TurnkeySignedRequest
      */

package/src/models/TurnkeyStamp.d.ts

@@ -22,7 +22,7 @@ export interface TurnkeyStamp {
      */
     stampHeaderName: string;
     /**
-     *
+     * Turnkey API stamp header value for request authentication
      * @type {string}
      * @memberof TurnkeyStamp
      */

package/src/models/TurnkeyWalletAccount.d.ts

@@ -28,7 +28,7 @@ export interface TurnkeyWalletAccount {
      */
     pathFormat: string;
     /**
-     *
+     * BIP-44 derivation path for the wallet account
      * @type {string}
      * @memberof TurnkeyWalletAccount
      */

package/src/models/TurnkeyWalletProperties.d.ts

@@ -50,7 +50,7 @@ export interface TurnkeyWalletProperties {
      */
     turnkeyUserId?: string | null;
     /**
-     *
+     * Whether this wallet supports session key operations
      * @type {boolean}
      * @memberof TurnkeyWalletProperties
      */

package/src/models/Unauthorized.d.ts

@@ -16,7 +16,7 @@
  */
 export interface Unauthorized {
     /**
-     *
+     * Human-readable error message describing the authentication failure
      * @type {string}
      * @memberof Unauthorized
      */

package/src/models/UnprocessableEntity.d.ts

@@ -18,7 +18,7 @@ import { UnprocessableEntityErrorPayload } from './UnprocessableEntityErrorPaylo
  */
 export interface UnprocessableEntity {
     /**
-     *
+     * Human-readable error message describing the validation failure
      * @type {string}
      * @memberof UnprocessableEntity
      */

package/src/models/UnprocessableEntityErrorPayload.d.ts

@@ -18,7 +18,7 @@ import { ProviderEnum } from './ProviderEnum';
  */
 export interface UnprocessableEntityErrorPayload {
     /**
-     *
+     * Email address that caused the validation error
      * @type {string}
      * @memberof UnprocessableEntityErrorPayload
      */
@@ -30,7 +30,7 @@ export interface UnprocessableEntityErrorPayload {
      */
     loginProvider?: ProviderEnum;
     /**
-     *
+     * Embedded wallet name that caused the validation error
      * @type {string}
      * @memberof UnprocessableEntityErrorPayload
      */
@@ -48,7 +48,7 @@ export interface UnprocessableEntityErrorPayload {
      */
     mergeConflicts?: MergeConflicts;
     /**
-     *
+     * List of additional validation error messages
      * @type {Array<string>}
      * @memberof UnprocessableEntityErrorPayload
      */

package/src/models/UpdateSelfResponse.d.ts

@@ -20,7 +20,7 @@ import { SmsVerificationCreateResponse } from './SmsVerificationCreateResponse';
  */
 export interface UpdateSelfResponse {
     /**
-     *
+     * Token used to continue multi-factor authentication flow
      * @type {string}
      * @memberof UpdateSelfResponse
      */

package/src/models/UserFieldsCheckResponse.d.ts

@@ -16,19 +16,19 @@
  */
 export interface UserFieldsCheckResponse {
     /**
-     *
+     * Name of the user field that was checked
      * @type {string}
      * @memberof UserFieldsCheckResponse
      */
     field: string;
     /**
-     *
+     * Value that was checked for availability
      * @type {string}
      * @memberof UserFieldsCheckResponse
      */
     value: string;
     /**
-     *
+     * Whether the checked field value is available for use
      * @type {boolean}
      * @memberof UserFieldsCheckResponse
      */