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

package/src/models/DynamicJwt.d.ts

@@ -21,73 +21,73 @@ import { ProjectSettingsKyc } from './ProjectSettingsKyc';
  */
 export interface DynamicJwt {
     /**
-     *
+     * Key ID used to identify which public key to verify this JWT
      * @type {string}
      * @memberof DynamicJwt
      */
     kid: string;
     /**
-     *
+     * JWT audience claim identifying the client origin
      * @type {string}
      * @memberof DynamicJwt
      */
     aud: string;
     /**
-     *
+     * JWT issuer claim identifying the Dynamic backend
      * @type {string}
      * @memberof DynamicJwt
      */
     iss: string;
     /**
-     *
+     * JWT subject claim containing the Dynamic user ID
      * @type {string}
      * @memberof DynamicJwt
      */
     sub: string;
     /**
-     *
+     * JWT expiration timestamp in seconds since Unix epoch
      * @type {number}
      * @memberof DynamicJwt
      */
     exp?: number;
     /**
-     *
+     * JWT issued-at timestamp in seconds since Unix epoch
      * @type {number}
      * @memberof DynamicJwt
      */
     iat?: number;
     /**
-     *
+     * Dynamic session ID
      * @type {string}
      * @memberof DynamicJwt
      */
     sid: string;
     /**
-     *
+     * Client session public key for session binding
      * @type {string}
      * @memberof DynamicJwt
      */
     sessionPublicKey?: string;
     /**
-     *
+     * User-defined alias or display name
      * @type {string}
      * @memberof DynamicJwt
      */
     alias?: string;
     /**
-     *
+     * List of blockchain accounts linked to the user
      * @type {Array<JwtBlockchainAccount>}
      * @memberof DynamicJwt
      */
     blockchainAccounts?: Array<JwtBlockchainAccount>;
     /**
-     *
+     * ISO country code of the user
      * @type {string}
      * @memberof DynamicJwt
      */
     country?: string;
     /**
-     *
+     * Email address of the user
      * @type {string}
      * @memberof DynamicJwt
      */
@@ -99,19 +99,19 @@ export interface DynamicJwt {
      */
     environmentId: string;
     /**
-     *
+     * Last name of the user
      * @type {string}
      * @memberof DynamicJwt
      */
     familyName?: string;
     /**
-     *
+     * First name of the user
      * @type {string}
      * @memberof DynamicJwt
      */
     givenName?: string;
     /**
-     *
+     * Job title of the user
      * @type {string}
      * @memberof DynamicJwt
      */
@@ -123,19 +123,19 @@ export interface DynamicJwt {
      */
     lastAuthenticatedAccountId?: string;
     /**
-     *
+     * Access lists the user belongs to
      * @type {Array<string>}
      * @memberof DynamicJwt
      */
     lists?: Array<string>;
     /**
-     *
+     * Phone number of the user
      * @type {string}
      * @memberof DynamicJwt
      */
     phoneNumber?: string;
     /**
-     *
+     * List of required user fields not yet provided
      * @type {Array<ProjectSettingsKyc>}
      * @memberof DynamicJwt
      */
@@ -147,25 +147,25 @@ export interface DynamicJwt {
      */
     scope?: string;
     /**
-     *
+     * T-shirt size preference of the user
      * @type {string}
      * @memberof DynamicJwt
      */
     tShirtSize?: string;
     /**
-     *
+     * Team the user belongs to
      * @type {string}
      * @memberof DynamicJwt
      */
     team?: string;
     /**
-     *
+     * Username of the user
      * @type {string}
      * @memberof DynamicJwt
      */
     username?: string;
     /**
-     *
+     * Whether the user accepted terms of service and privacy policy
      * @type {boolean}
      * @memberof DynamicJwt
      */
@@ -177,7 +177,7 @@ export interface DynamicJwt {
      */
     verifiedAccount?: JwtBlockchainAccount;
     /**
-     *
+     * List of verified credentials linked to the user
      * @type {Array<JwtVerifiedCredential>}
      * @memberof DynamicJwt
      */
@@ -195,79 +195,79 @@ export interface DynamicJwt {
      */
     signinCredentialId?: string;
     /**
-     *
+     * ISO 8601 timestamp of the user's first visit
      * @type {Date}
      * @memberof DynamicJwt
      */
     firstVisit?: Date;
     /**
-     *
+     * ISO 8601 timestamp of the user's last visit
      * @type {Date}
      * @memberof DynamicJwt
      */
     lastVisit?: Date;
     /**
-     *
+     * Whether this is a newly created user
      * @type {boolean}
      * @memberof DynamicJwt
      */
     newUser?: boolean;
     /**
-     *
+     * Bitcoin wallet address of the user
      * @type {string}
      * @memberof DynamicJwt
      */
     btcWallet?: string;
     /**
-     *
+     * Kadena wallet address of the user
      * @type {string}
      * @memberof DynamicJwt
      */
     kdaWallet?: string;
     /**
-     *
+     * Litecoin wallet address of the user
      * @type {string}
      * @memberof DynamicJwt
      */
     ltcWallet?: string;
     /**
-     *
+     * Nervos CKB wallet address of the user
      * @type {string}
      * @memberof DynamicJwt
      */
     ckbWallet?: string;
     /**
-     *
+     * Kaspa wallet address of the user
      * @type {string}
      * @memberof DynamicJwt
      */
     kasWallet?: string;
     /**
-     *
+     * Dogecoin wallet address of the user
      * @type {string}
      * @memberof DynamicJwt
      */
     dogeWallet?: string;
     /**
-     *
+     * Whether the user opted in to email notifications
      * @type {boolean}
      * @memberof DynamicJwt
      */
     emailNotification?: boolean;
     /**
-     *
+     * Whether the user opted in to Discord notifications
      * @type {boolean}
      * @memberof DynamicJwt
      */
     discordNotification?: boolean;
     /**
-     *
+     * Whether the user opted in to newsletter notifications
      * @type {boolean}
      * @memberof DynamicJwt
      */
     newsletterNotification?: boolean;
     /**
-     *
+     * Arbitrary key-value metadata associated with the user
      * @type {object}
      * @memberof DynamicJwt
      */
@@ -285,7 +285,7 @@ export interface DynamicJwt {
      */
     info?: JwtPayloadDeprecatedInfo;
     /**
-     *
+     * Whether this JWT was issued via server-side authentication
      * @type {boolean}
      * @memberof DynamicJwt
      */

package/src/models/Eip712Domain.d.ts

@@ -16,19 +16,19 @@
  */
 export interface Eip712Domain {
     /**
-     *
+     * Human-readable name of the signing domain
      * @type {string}
      * @memberof Eip712Domain
      */
     name?: string;
     /**
-     *
+     * Version of the signing domain
      * @type {string}
      * @memberof Eip712Domain
      */
     version?: string;
     /**
-     *
+     * Chain ID the typed data is intended for
      * @type {number}
      * @memberof Eip712Domain
      */

package/src/models/Eip712TypeMember.d.ts

@@ -16,13 +16,13 @@
  */
 export interface Eip712TypeMember {
     /**
-     *
+     * Name of the struct field
      * @type {string}
      * @memberof Eip712TypeMember
      */
     name: string;
     /**
-     *
+     * Solidity type of the struct field
      * @type {string}
      * @memberof Eip712TypeMember
      */

package/src/models/EmailVerificationCreateRequest.d.ts

@@ -16,7 +16,7 @@
  */
 export interface EmailVerificationCreateRequest {
     /**
-     *
+     * Email address to verify
      * @type {string}
      * @memberof EmailVerificationCreateRequest
      */

package/src/models/EmailVerificationCreateResponse.d.ts

@@ -22,7 +22,7 @@ export interface EmailVerificationCreateResponse {
      */
     verificationUUID: string;
     /**
-     *
+     * Email address that the verification was sent to
      * @type {string}
      * @memberof EmailVerificationCreateResponse
      */

package/src/models/EmailVerificationRetryRequest.d.ts

@@ -22,7 +22,7 @@ export interface EmailVerificationRetryRequest {
      */
     verificationUUID: string;
     /**
-     *
+     * Email address to resend the verification to
      * @type {string}
      * @memberof EmailVerificationRetryRequest
      */

package/src/models/EmbeddedWalletAuthToken.d.ts

@@ -16,7 +16,7 @@
  */
 export interface EmbeddedWalletAuthToken {
     /**
-     *
+     * Authentication token for embedded wallet operations
      * @type {string}
      * @memberof EmbeddedWalletAuthToken
      */

package/src/models/EmbeddedWalletSecret.d.ts

@@ -23,7 +23,7 @@ export interface EmbeddedWalletSecret {
      */
     walletId: string;
     /**
-     *
+     * Encrypted secret material for the embedded wallet
      * @type {string}
      * @memberof EmbeddedWalletSecret
      */

package/src/models/EmbeddedWalletSecretWithUpdatedJwt.d.ts

@@ -18,7 +18,7 @@ import { SdkUser } from './SdkUser';
  */
 export interface EmbeddedWalletSecretWithUpdatedJwt {
     /**
-     *
+     * Token used to continue multi-factor authentication flow
      * @type {string}
      * @memberof EmbeddedWalletSecretWithUpdatedJwt
      */
@@ -60,7 +60,7 @@ export interface EmbeddedWalletSecretWithUpdatedJwt {
      */
     walletId: string;
     /**
-     *
+     * Encrypted secret material for the embedded wallet
      * @type {string}
      * @memberof EmbeddedWalletSecretWithUpdatedJwt
      */

package/src/models/EmbeddedWalletSecretWithUpdatedJwtAllOf.d.ts

@@ -23,7 +23,7 @@ export interface EmbeddedWalletSecretWithUpdatedJwtAllOf {
      */
     walletId: string;
     /**
-     *
+     * Encrypted secret material for the embedded wallet
      * @type {string}
      * @memberof EmbeddedWalletSecretWithUpdatedJwtAllOf
      */

package/src/models/ErrorMessageWithCode.d.ts

@@ -16,13 +16,13 @@
  */
 export interface ErrorMessageWithCode {
     /**
-     *
+     * Machine-readable error code
      * @type {string}
      * @memberof ErrorMessageWithCode
      */
     code?: string;
     /**
-     *
+     * Human-readable error message
      * @type {string}
      * @memberof ErrorMessageWithCode
      */

package/src/models/Exchange.d.ts

@@ -30,7 +30,7 @@ export interface Exchange {
      */
     exchange: ExchangeKeyEnum;
     /**
-     *
+     * ISO 8601 timestamp of when the exchange was enabled
      * @type {Date}
      * @memberof Exchange
      */

package/src/models/ExchangeTransaction.d.ts

@@ -46,7 +46,7 @@ export interface ExchangeTransaction {
      */
     currency?: string;
     /**
-     *
+     * ISO 8601 timestamp of when the transaction was created
      * @type {Date}
      * @memberof ExchangeTransaction
      */

package/src/models/ExchangeTransferResponse.d.ts

@@ -46,7 +46,7 @@ export interface ExchangeTransferResponse {
      */
     currency: string;
     /**
-     *
+     * ISO 8601 timestamp of when the transfer was created
      * @type {Date}
      * @memberof ExchangeTransferResponse
      */

package/src/models/ExportEmbeddedWalletResponse.d.ts

@@ -16,7 +16,7 @@
  */
 export interface ExportEmbeddedWalletResponse {
     /**
-     *
+     * Encrypted bundle containing the wallet private key material
      * @type {string}
      * @memberof ExportEmbeddedWalletResponse
      */

package/src/models/ExportWaasWalletPrivateKeyRequest.d.ts

@@ -16,13 +16,13 @@
  */
 export interface ExportWaasWalletPrivateKeyRequest {
     /**
-     *
+     * Unique identifier for the export session
      * @type {string}
      * @memberof ExportWaasWalletPrivateKeyRequest
      */
     exportId: string;
     /**
-     *
+     * Address derivation type of the wallet to export
      * @type {string}
      * @memberof ExportWaasWalletPrivateKeyRequest
      */

package/src/models/ExternalAuth.d.ts

@@ -16,7 +16,7 @@
  */
 export interface ExternalAuth {
     /**
-     *
+     * Whether external JWT authentication is enabled
      * @type {boolean}
      * @memberof ExternalAuth
      */

package/src/models/ExternalWalletFundingDefaultSettingsToken.d.ts

@@ -11,7 +11,7 @@
  */
 import { ExternalWalletFundingTokenRule } from './ExternalWalletFundingTokenRule';
 /**
- *
+ * Token configuration for external wallet funding
  * @export
  * @interface ExternalWalletFundingDefaultSettingsToken
  */

package/src/models/FeatureFlags.d.ts

@@ -16,13 +16,13 @@
  */
 export interface FeatureFlags {
     /**
-     *
+     * Whether multi-asset support is enabled in connect-only mode
      * @type {boolean}
      * @memberof FeatureFlags
      */
     connectOnlyMultiAsset: boolean;
     /**
-     *
+     * Whether exchange integrations are enabled
      * @type {boolean}
      * @memberof FeatureFlags
      */

package/src/models/Forbidden.d.ts

@@ -16,7 +16,7 @@
  */
 export interface Forbidden {
     /**
-     *
+     * Human-readable error message
      * @type {string}
      * @memberof Forbidden
      */

package/src/models/ForbiddenErrorPayload.d.ts

@@ -22,7 +22,7 @@ export interface ForbiddenErrorPayload {
      */
     walletPublicKey?: string;
     /**
-     *
+     * Email address associated with the forbidden request
      * @type {string}
      * @memberof ForbiddenErrorPayload
      */

package/src/models/Funding.d.ts

@@ -18,7 +18,7 @@ import { OnrampProviders } from './OnrampProviders';
  */
 export interface Funding {
     /**
-     *
+     * List of enabled onramp providers for fiat-to-crypto purchases
      * @type {Array<OnrampProviders>}
      * @memberof Funding
      */

package/src/models/FundingExternalWallets.d.ts

@@ -12,7 +12,7 @@
 import { FundingExternalWalletsDefaultSettings } from './FundingExternalWalletsDefaultSettings';
 import { FundingExternalWalletsMinAmount } from './FundingExternalWalletsMinAmount';
 /**
- *
+ * Configuration for external wallet funding
  * @export
  * @interface FundingExternalWallets
  */

package/src/models/GetPasskeyAuthenticationOptionsResponse.d.ts

@@ -44,7 +44,7 @@ export interface GetPasskeyAuthenticationOptionsResponse {
      */
     userVerification?: UserVerificationRequirement;
     /**
-     *
+     * List of credentials the authenticator may use
      * @type {Array<PasskeyAllowCredential>}
      * @memberof GetPasskeyAuthenticationOptionsResponse
      */

package/src/models/GetPasskeyRegistrationOptionsResponse.d.ts

@@ -41,7 +41,7 @@ export interface GetPasskeyRegistrationOptionsResponse {
      */
     challenge: string;
     /**
-     *
+     * List of credentials to exclude from registration
      * @type {Array<PasskeyExcludeCredential>}
      * @memberof GetPasskeyRegistrationOptionsResponse
      */
@@ -59,7 +59,7 @@ export interface GetPasskeyRegistrationOptionsResponse {
      */
     hints?: Array<string>;
     /**
-     *
+     * List of acceptable public key credential parameters
      * @type {Array<PublicKeyCredentialParameters>}
      * @memberof GetPasskeyRegistrationOptionsResponse
      */

package/src/models/GetUserPasskeysResponse.d.ts

@@ -23,7 +23,7 @@ export interface GetUserPasskeysResponse {
      */
     passkeys: Array<UserPasskey>;
     /**
-     *
+     * Total number of passkeys registered by the user
      * @type {number}
      * @memberof GetUserPasskeysResponse
      */

package/src/models/GlobalWalletConnection.d.ts

@@ -47,13 +47,13 @@ export interface GlobalWalletConnection {
      */
     expiresAt?: Date | null;
     /**
-     *
+     * ISO 8601 timestamp of when the connection was created
      * @type {Date}
      * @memberof GlobalWalletConnection
      */
     createdAt: Date;
     /**
-     *
+     * ISO 8601 timestamp of when the connection was last updated
      * @type {Date}
      * @memberof GlobalWalletConnection
      */

package/src/models/GlobalWalletConnectionCreateRequest.d.ts

@@ -16,7 +16,7 @@
  */
 export interface GlobalWalletConnectionCreateRequest {
     /**
-     *
+     * ISO 8601 timestamp of when the connection should expire
      * @type {Date}
      * @memberof GlobalWalletConnectionCreateRequest
      */

package/src/models/GlobalWalletSettings.d.ts

@@ -65,13 +65,13 @@ export interface GlobalWalletSettings {
      */
     termsOfServiceAndPrivacyPolicyMarkdown?: string;
     /**
-     *
+     * List of custom menu links displayed in the global wallet
      * @type {Array<GlobalWalletSettingsCustomMenuLinks>}
      * @memberof GlobalWalletSettings
      */
     customMenuLinks?: Array<GlobalWalletSettingsCustomMenuLinks>;
     /**
-     *
+     * Whether users can log in using external (non-embedded) wallets
      * @type {boolean}
      * @memberof GlobalWalletSettings
      */

package/src/models/HCaptchaSettings.d.ts

@@ -16,7 +16,7 @@
  */
 export interface HCaptchaSettings {
     /**
-     *
+     * Whether hCaptcha verification is enabled
      * @type {boolean}
      * @memberof HCaptchaSettings
      */
@@ -28,7 +28,7 @@ export interface HCaptchaSettings {
      */
     secretKey?: string;
     /**
-     *
+     * Public site key used to render the hCaptcha widget
      * @type {string}
      * @memberof HCaptchaSettings
      */

package/src/models/ImportWaasPrivateKeyRequest.d.ts

@@ -24,7 +24,7 @@ export interface ImportWaasPrivateKeyRequest {
      */
     chain: WaasChainEnum;
     /**
-     *
+     * List of client-side key generation identifiers
      * @type {Array<string>}
      * @memberof ImportWaasPrivateKeyRequest
      */

package/src/models/IntegrationSetting.d.ts

@@ -16,19 +16,19 @@
  */
 export interface IntegrationSetting {
     /**
-     *
+     * Name of the integration
      * @type {string}
      * @memberof IntegrationSetting
      */
     name: string;
     /**
-     *
+     * Whether the integration is required for user onboarding
      * @type {boolean}
      * @memberof IntegrationSetting
      */
     required?: boolean;
     /**
-     *
+     * Whether the integration is enabled
      * @type {boolean}
      * @memberof IntegrationSetting
      */