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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynamic-labs/sdk-api-core",
-  "version": "0.0.939",
+  "version": "0.0.941",
   "author": "Dynamic Labs",
   "license": "Apache-2.0",
   "publishConfig": {

package/src/apis/SDKApi.cjs

@@ -4033,7 +4033,7 @@ class SDKApi extends runtime.BaseAPI {
         await this.getPasskeyRegistrationOptionsOptionsRaw(requestParameters, initOverrides);
     }
     /**
-     * Returns a short-lived JWT for subscribing to realtime channels.
+     * Returns a short-lived JWT for subscribing to realtime channels. Accepts either a JWT (via Authorization header) or a checkout session token with transaction ID for unauthenticated checkout flows.
      * Get a realtime auth token
      */
     async getRealtimeAuthTokenRaw(requestParameters, initOverrides) {
@@ -4045,6 +4045,12 @@ class SDKApi extends runtime.BaseAPI {
             queryParameters['capabilities'] = requestParameters.capabilities;
         }
         const headerParameters = {};
+        if (requestParameters.xDynamicCheckoutSessionToken !== undefined && requestParameters.xDynamicCheckoutSessionToken !== null) {
+            headerParameters['X-Dynamic-Checkout-Session-Token'] = String(requestParameters.xDynamicCheckoutSessionToken);
+        }
+        if (requestParameters.xDynamicCheckoutTransactionId !== undefined && requestParameters.xDynamicCheckoutTransactionId !== null) {
+            headerParameters['X-Dynamic-Checkout-Transaction-Id'] = String(requestParameters.xDynamicCheckoutTransactionId);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
             const tokenString = await token("bearerAuth", []);
@@ -4061,7 +4067,7 @@ class SDKApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => RealtimeAuthTokenResponse.RealtimeAuthTokenResponseFromJSON(jsonValue));
     }
     /**
-     * Returns a short-lived JWT for subscribing to realtime channels.
+     * Returns a short-lived JWT for subscribing to realtime channels. Accepts either a JWT (via Authorization header) or a checkout session token with transaction ID for unauthenticated checkout flows.
      * Get a realtime auth token
      */
     async getRealtimeAuthToken(requestParameters, initOverrides) {

package/src/apis/SDKApi.d.ts

@@ -497,6 +497,8 @@ export interface GetPasskeyRegistrationOptionsOptionsRequest {
 export interface GetRealtimeAuthTokenRequest {
     environmentId: string;
     capabilities?: string;
+    xDynamicCheckoutSessionToken?: string;
+    xDynamicCheckoutTransactionId?: string;
 }
 export interface GetRecoveryCodesRequest {
     environmentId: string;
@@ -2285,12 +2287,12 @@ export declare class SDKApi extends runtime.BaseAPI {
      */
     getPasskeyRegistrationOptionsOptions(requestParameters: GetPasskeyRegistrationOptionsOptionsRequest, initOverrides?: RequestInit): Promise<void>;
     /**
-     * Returns a short-lived JWT for subscribing to realtime channels.
+     * Returns a short-lived JWT for subscribing to realtime channels. Accepts either a JWT (via Authorization header) or a checkout session token with transaction ID for unauthenticated checkout flows.
      * Get a realtime auth token
      */
     getRealtimeAuthTokenRaw(requestParameters: GetRealtimeAuthTokenRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<RealtimeAuthTokenResponse>>;
     /**
-     * Returns a short-lived JWT for subscribing to realtime channels.
+     * Returns a short-lived JWT for subscribing to realtime channels. Accepts either a JWT (via Authorization header) or a checkout session token with transaction ID for unauthenticated checkout flows.
      * Get a realtime auth token
      */
     getRealtimeAuthToken(requestParameters: GetRealtimeAuthTokenRequest, initOverrides?: RequestInit): Promise<RealtimeAuthTokenResponse>;

package/src/apis/SDKApi.js

@@ -4029,7 +4029,7 @@ class SDKApi extends BaseAPI {
         await this.getPasskeyRegistrationOptionsOptionsRaw(requestParameters, initOverrides);
     }
     /**
-     * Returns a short-lived JWT for subscribing to realtime channels.
+     * Returns a short-lived JWT for subscribing to realtime channels. Accepts either a JWT (via Authorization header) or a checkout session token with transaction ID for unauthenticated checkout flows.
      * Get a realtime auth token
      */
     async getRealtimeAuthTokenRaw(requestParameters, initOverrides) {
@@ -4041,6 +4041,12 @@ class SDKApi extends BaseAPI {
             queryParameters['capabilities'] = requestParameters.capabilities;
         }
         const headerParameters = {};
+        if (requestParameters.xDynamicCheckoutSessionToken !== undefined && requestParameters.xDynamicCheckoutSessionToken !== null) {
+            headerParameters['X-Dynamic-Checkout-Session-Token'] = String(requestParameters.xDynamicCheckoutSessionToken);
+        }
+        if (requestParameters.xDynamicCheckoutTransactionId !== undefined && requestParameters.xDynamicCheckoutTransactionId !== null) {
+            headerParameters['X-Dynamic-Checkout-Transaction-Id'] = String(requestParameters.xDynamicCheckoutTransactionId);
+        }
         if (this.configuration && this.configuration.accessToken) {
             const token = this.configuration.accessToken;
             const tokenString = await token("bearerAuth", []);
@@ -4057,7 +4063,7 @@ class SDKApi extends BaseAPI {
         return new JSONApiResponse(response, (jsonValue) => RealtimeAuthTokenResponseFromJSON(jsonValue));
     }
     /**
-     * Returns a short-lived JWT for subscribing to realtime channels.
+     * Returns a short-lived JWT for subscribing to realtime channels. Accepts either a JWT (via Authorization header) or a checkout session token with transaction ID for unauthenticated checkout flows.
      * Get a realtime auth token
      */
     async getRealtimeAuthToken(requestParameters, initOverrides) {

package/src/index.cjs

@@ -55,6 +55,7 @@ var CheckoutTransaction = require('./models/CheckoutTransaction.cjs');
 var CheckoutTransactionCreateRequest = require('./models/CheckoutTransactionCreateRequest.cjs');
 var CheckoutTransactionCreateResponse = require('./models/CheckoutTransactionCreateResponse.cjs');
 var CheckoutTransactionDestinationAddress = require('./models/CheckoutTransactionDestinationAddress.cjs');
+var CheckoutTransactionExchangeSource = require('./models/CheckoutTransactionExchangeSource.cjs');
 var CheckoutTransactionQuote = require('./models/CheckoutTransactionQuote.cjs');
 var CheckoutUpdateRequest = require('./models/CheckoutUpdateRequest.cjs');
 var CheckoutsResponse = require('./models/CheckoutsResponse.cjs');
@@ -668,6 +669,9 @@ exports.CheckoutTransactionCreateResponseToJSON = CheckoutTransactionCreateRespo
 exports.CheckoutTransactionDestinationAddressFromJSON = CheckoutTransactionDestinationAddress.CheckoutTransactionDestinationAddressFromJSON;
 exports.CheckoutTransactionDestinationAddressFromJSONTyped = CheckoutTransactionDestinationAddress.CheckoutTransactionDestinationAddressFromJSONTyped;
 exports.CheckoutTransactionDestinationAddressToJSON = CheckoutTransactionDestinationAddress.CheckoutTransactionDestinationAddressToJSON;
+exports.CheckoutTransactionExchangeSourceFromJSON = CheckoutTransactionExchangeSource.CheckoutTransactionExchangeSourceFromJSON;
+exports.CheckoutTransactionExchangeSourceFromJSONTyped = CheckoutTransactionExchangeSource.CheckoutTransactionExchangeSourceFromJSONTyped;
+exports.CheckoutTransactionExchangeSourceToJSON = CheckoutTransactionExchangeSource.CheckoutTransactionExchangeSourceToJSON;
 exports.CheckoutTransactionQuoteFromJSON = CheckoutTransactionQuote.CheckoutTransactionQuoteFromJSON;
 exports.CheckoutTransactionQuoteFromJSONTyped = CheckoutTransactionQuote.CheckoutTransactionQuoteFromJSONTyped;
 exports.CheckoutTransactionQuoteToJSON = CheckoutTransactionQuote.CheckoutTransactionQuoteToJSON;

package/src/index.js

@@ -51,6 +51,7 @@ export { CheckoutTransactionFromJSON, CheckoutTransactionFromJSONTyped, Checkout
 export { CheckoutTransactionCreateRequestFromJSON, CheckoutTransactionCreateRequestFromJSONTyped, CheckoutTransactionCreateRequestToJSON } from './models/CheckoutTransactionCreateRequest.js';
 export { CheckoutTransactionCreateResponseFromJSON, CheckoutTransactionCreateResponseFromJSONTyped, CheckoutTransactionCreateResponseToJSON } from './models/CheckoutTransactionCreateResponse.js';
 export { CheckoutTransactionDestinationAddressFromJSON, CheckoutTransactionDestinationAddressFromJSONTyped, CheckoutTransactionDestinationAddressToJSON } from './models/CheckoutTransactionDestinationAddress.js';
+export { CheckoutTransactionExchangeSourceFromJSON, CheckoutTransactionExchangeSourceFromJSONTyped, CheckoutTransactionExchangeSourceToJSON } from './models/CheckoutTransactionExchangeSource.js';
 export { CheckoutTransactionQuoteFromJSON, CheckoutTransactionQuoteFromJSONTyped, CheckoutTransactionQuoteToJSON } from './models/CheckoutTransactionQuote.js';
 export { CheckoutUpdateRequestFromJSON, CheckoutUpdateRequestFromJSONTyped, CheckoutUpdateRequestToJSON } from './models/CheckoutUpdateRequest.js';
 export { CheckoutsResponseFromJSON, CheckoutsResponseFromJSONTyped, CheckoutsResponseToJSON } from './models/CheckoutsResponse.js';

package/src/models/Account.d.ts

@@ -36,7 +36,7 @@ export interface Account {
      */
     type?: string;
     /**
-     *
+     * List of balance entries for each currency held in the account
      * @type {Array<AccountBalances>}
      * @memberof Account
      */

package/src/models/AccountBalances.d.ts

@@ -34,7 +34,7 @@ export interface AccountBalances {
      */
     availableBalance?: number;
     /**
-     *
+     * URL of the token or currency logo image
      * @type {string}
      * @memberof AccountBalances
      */

package/src/models/Asset.d.ts

@@ -22,43 +22,43 @@ export interface Asset {
      */
     address: string | null;
     /**
-     *
+     * Numeric identifier of the blockchain network
      * @type {number}
      * @memberof Asset
      */
     chainId?: number;
     /**
-     *
+     * Human-readable name of the blockchain network
      * @type {string}
      * @memberof Asset
      */
     chainName: string;
     /**
-     *
+     * Number of decimal places used by the token
      * @type {number}
      * @memberof Asset
      */
     decimals: number;
     /**
-     *
+     * URL of the token logo image
      * @type {string}
      * @memberof Asset
      */
     logoUrl: string;
     /**
-     *
+     * Display name of the token or asset
      * @type {string}
      * @memberof Asset
      */
     name: string;
     /**
-     *
+     * Ticker symbol of the token (e.g. ETH, USDC)
      * @type {string}
      * @memberof Asset
      */
     symbol: string;
     /**
-     *
+     * Classification of the asset (e.g. ERC20, NATIVE)
      * @type {string}
      * @memberof Asset
      */

package/src/models/AssetDiff.d.ts

@@ -24,13 +24,13 @@ export interface AssetDiff {
      */
     asset: Asset;
     /**
-     *
+     * List of incoming asset transfers
      * @type {Array<AssetTransfer>}
      * @memberof AssetDiff
      */
     transferIn: Array<AssetTransfer>;
     /**
-     *
+     * List of outgoing asset transfers
      * @type {Array<AssetTransfer>}
      * @memberof AssetDiff
      */

package/src/models/AssetExposure.d.ts

@@ -24,7 +24,7 @@ export interface AssetExposure {
      */
     asset: Asset;
     /**
-     *
+     * Mapping of spender addresses to their approval details
      * @type {{ [key: string]: AssetExposureSpenderToInfo; }}
      * @memberof AssetExposure
      */

package/src/models/AssetTransfer.d.ts

@@ -16,25 +16,25 @@
  */
 export interface AssetTransfer {
     /**
-     *
+     * Raw token amount before decimal adjustment
      * @type {string}
      * @memberof AssetTransfer
      */
     rawValue?: string;
     /**
-     *
+     * Human-readable summary of the transfer
      * @type {string}
      * @memberof AssetTransfer
      */
     summary?: string;
     /**
-     *
+     * Estimated USD value of the transferred amount
      * @type {string}
      * @memberof AssetTransfer
      */
     usdPrice?: string;
     /**
-     *
+     * Decimal-adjusted token amount
      * @type {string}
      * @memberof AssetTransfer
      */

package/src/models/AttachSourceRequest.cjs

@@ -5,6 +5,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var runtime = require('../runtime.cjs');
 var ChainEnum = require('./ChainEnum.cjs');
 var CheckoutSourceTypeEnum = require('./CheckoutSourceTypeEnum.cjs');
+var ExchangeKeyEnum = require('./ExchangeKeyEnum.cjs');
 
 /* tslint:disable */
 function AttachSourceRequestFromJSON(json) {
@@ -19,6 +20,7 @@ function AttachSourceRequestFromJSONTyped(json, ignoreDiscriminator) {
         'fromAddress': !runtime.exists(json, 'fromAddress') ? undefined : json['fromAddress'],
         'fromChainId': !runtime.exists(json, 'fromChainId') ? undefined : json['fromChainId'],
         'fromChainName': !runtime.exists(json, 'fromChainName') ? undefined : ChainEnum.ChainEnumFromJSON(json['fromChainName']),
+        'exchangeProvider': !runtime.exists(json, 'exchangeProvider') ? undefined : ExchangeKeyEnum.ExchangeKeyEnumFromJSON(json['exchangeProvider']),
     };
 }
 function AttachSourceRequestToJSON(value) {
@@ -33,6 +35,7 @@ function AttachSourceRequestToJSON(value) {
         'fromAddress': value.fromAddress,
         'fromChainId': value.fromChainId,
         'fromChainName': ChainEnum.ChainEnumToJSON(value.fromChainName),
+        'exchangeProvider': ExchangeKeyEnum.ExchangeKeyEnumToJSON(value.exchangeProvider),
     };
 }
 

package/src/models/AttachSourceRequest.d.ts

@@ -11,8 +11,9 @@
  */
 import { ChainEnum } from './ChainEnum';
 import { CheckoutSourceTypeEnum } from './CheckoutSourceTypeEnum';
+import { ExchangeKeyEnum } from './ExchangeKeyEnum';
 /**
- * fromAddress, fromChainId, and fromChainName are required when sourceType is 'wallet' or 'deposit_address', and optional when sourceType is 'exchange'.
+ * fromAddress, fromChainId, and fromChainName are required when sourceType is 'wallet' and optional when sourceType is 'exchange'. When sourceType is 'exchange', pass exchangeProvider to generate the buy URL and create the exchange source record server-side.
  * @export
  * @interface AttachSourceRequest
  */
@@ -41,6 +42,12 @@ export interface AttachSourceRequest {
      * @memberof AttachSourceRequest
      */
     fromChainName?: ChainEnum;
+    /**
+     *
+     * @type {ExchangeKeyEnum}
+     * @memberof AttachSourceRequest
+     */
+    exchangeProvider?: ExchangeKeyEnum;
 }
 export declare function AttachSourceRequestFromJSON(json: any): AttachSourceRequest;
 export declare function AttachSourceRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AttachSourceRequest;

package/src/models/AttachSourceRequest.js

@@ -1,6 +1,7 @@
 import { exists } from '../runtime.js';
 import { ChainEnumFromJSON, ChainEnumToJSON } from './ChainEnum.js';
 import { CheckoutSourceTypeEnumFromJSON, CheckoutSourceTypeEnumToJSON } from './CheckoutSourceTypeEnum.js';
+import { ExchangeKeyEnumFromJSON, ExchangeKeyEnumToJSON } from './ExchangeKeyEnum.js';
 
 /* tslint:disable */
 function AttachSourceRequestFromJSON(json) {
@@ -15,6 +16,7 @@ function AttachSourceRequestFromJSONTyped(json, ignoreDiscriminator) {
         'fromAddress': !exists(json, 'fromAddress') ? undefined : json['fromAddress'],
         'fromChainId': !exists(json, 'fromChainId') ? undefined : json['fromChainId'],
         'fromChainName': !exists(json, 'fromChainName') ? undefined : ChainEnumFromJSON(json['fromChainName']),
+        'exchangeProvider': !exists(json, 'exchangeProvider') ? undefined : ExchangeKeyEnumFromJSON(json['exchangeProvider']),
     };
 }
 function AttachSourceRequestToJSON(value) {
@@ -29,6 +31,7 @@ function AttachSourceRequestToJSON(value) {
         'fromAddress': value.fromAddress,
         'fromChainId': value.fromChainId,
         'fromChainName': ChainEnumToJSON(value.fromChainName),
+        'exchangeProvider': ExchangeKeyEnumToJSON(value.exchangeProvider),
     };
 }
 

package/src/models/AuthSettings.d.ts

@@ -23,7 +23,7 @@ export interface AuthSettings {
      */
     allowMultipleCredentialsForSignIn?: boolean;
     /**
-     *
+     * List of browser storage mechanisms where the JWT token may be persisted
      * @type {Array<AuthStorageEnum>}
      * @memberof AuthSettings
      */

package/src/models/AuthenticationExtensionsClientInputs.d.ts

@@ -16,19 +16,19 @@
  */
 export interface AuthenticationExtensionsClientInputs {
     /**
-     *
+     * FIDO AppID extension input for backward compatibility with U2F
      * @type {string}
      * @memberof AuthenticationExtensionsClientInputs
      */
     appid?: string;
     /**
-     *
+     * Whether to request credential properties from the authenticator
      * @type {boolean}
      * @memberof AuthenticationExtensionsClientInputs
      */
     credProps?: boolean;
     /**
-     *
+     * Whether to create an HMAC secret with the authenticator
      * @type {boolean}
      * @memberof AuthenticationExtensionsClientInputs
      */

package/src/models/AuthenticationExtensionsClientOutputs.d.ts

@@ -16,19 +16,19 @@
  */
 export interface AuthenticationExtensionsClientOutputs {
     /**
-     *
+     * Whether the FIDO AppID extension was used during the ceremony
      * @type {boolean}
      * @memberof AuthenticationExtensionsClientOutputs
      */
     appid?: boolean;
     /**
-     *
+     * Properties of the created credential returned by the authenticator
      * @type {object}
      * @memberof AuthenticationExtensionsClientOutputs
      */
     credProps?: object;
     /**
-     *
+     * Whether an HMAC secret was successfully created
      * @type {boolean}
      * @memberof AuthenticationExtensionsClientOutputs
      */

package/src/models/AuthenticatorAssertionResponse.d.ts

@@ -34,7 +34,7 @@ export interface AuthenticatorAssertionResponse {
      */
     signature: string;
     /**
-     *
+     * Base64URL-encoded user handle returned by the authenticator
      * @type {string}
      * @memberof AuthenticatorAssertionResponse
      */

package/src/models/AuthenticatorAttestationResponse.d.ts

@@ -34,7 +34,7 @@ export interface AuthenticatorAttestationResponse {
      */
     authenticatorData?: string;
     /**
-     *
+     * COSE algorithm identifier for the credential public key
      * @type {number}
      * @memberof AuthenticatorAttestationResponse
      */

package/src/models/AuthenticatorSelectionCriteria.d.ts

@@ -25,7 +25,7 @@ export interface AuthenticatorSelectionCriteria {
      */
     authenticatorAttachment?: AuthenticatorAttachment;
     /**
-     *
+     * Whether a resident (discoverable) credential is required
      * @type {boolean}
      * @memberof AuthenticatorSelectionCriteria
      */

package/src/models/BackupKeySharesToLocationResponse.d.ts

@@ -17,7 +17,7 @@ import { WaasBackupOptionsEnum } from './WaasBackupOptionsEnum';
  */
 export interface BackupKeySharesToLocationResponse {
     /**
-     *
+     * Human-readable status message for the backup operation
      * @type {string}
      * @memberof BackupKeySharesToLocationResponse
      */

package/src/models/BackupKeySharesToLocationsPendingResponse.d.ts

@@ -16,7 +16,7 @@
  */
 export interface BackupKeySharesToLocationsPendingResponse {
     /**
-     *
+     * Human-readable status message for the pending backup operation
      * @type {string}
      * @memberof BackupKeySharesToLocationsPendingResponse
      */
@@ -28,7 +28,7 @@ export interface BackupKeySharesToLocationsPendingResponse {
      */
     walletId: string;
     /**
-     *
+     * Current status of the password update process
      * @type {string}
      * @memberof BackupKeySharesToLocationsPendingResponse
      */

package/src/models/BackupKeySharesToLocationsRequest.d.ts

@@ -23,7 +23,7 @@ export interface BackupKeySharesToLocationsRequest {
      */
     passwordUpdateBatchId?: string;
     /**
-     *
+     * List of backup locations with their key share configuration
      * @type {Array<BackupKeySharesToLocationsRequestLocations>}
      * @memberof BackupKeySharesToLocationsRequest
      */

package/src/models/BackupKeySharesToLocationsResponse.d.ts

@@ -17,7 +17,7 @@ import { BackupKeySharesToLocationsResponseLocationsWithKeyShares } from './Back
  */
 export interface BackupKeySharesToLocationsResponse {
     /**
-     *
+     * Human-readable status message for the backup operation
      * @type {string}
      * @memberof BackupKeySharesToLocationsResponse
      */
@@ -29,13 +29,13 @@ export interface BackupKeySharesToLocationsResponse {
      */
     walletId: string;
     /**
-     *
+     * Current status of the password update process
      * @type {string}
      * @memberof BackupKeySharesToLocationsResponse
      */
     passwordUpdateStatus?: BackupKeySharesToLocationsResponsePasswordUpdateStatusEnum;
     /**
-     *
+     * List of backup locations paired with their key share identifiers
      * @type {Array<BackupKeySharesToLocationsResponseLocationsWithKeyShares>}
      * @memberof BackupKeySharesToLocationsResponse
      */

package/src/models/BackupMultipleClientKeySharesResponse.d.ts

@@ -17,7 +17,7 @@ import { WalletKeyShareInfo } from './WalletKeyShareInfo';
  */
 export interface BackupMultipleClientKeySharesResponse {
     /**
-     *
+     * List of key share information for each backed-up wallet
      * @type {Array<WalletKeyShareInfo>}
      * @memberof BackupMultipleClientKeySharesResponse
      */

package/src/models/BadGateway.d.ts

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

package/src/models/BadRequest.d.ts

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

package/src/models/BaseUser.d.ts

@@ -31,7 +31,7 @@ export interface BaseUser {
      */
     projectEnvironmentId: string;
     /**
-     *
+     * List of verified credentials (wallets, emails, social accounts) linked to the user
      * @type {Array<JwtVerifiedCredential>}
      * @memberof BaseUser
      */
@@ -61,7 +61,7 @@ export interface BaseUser {
      */
     country?: string | null;
     /**
-     *
+     * Primary email address of the user
      * @type {string}
      * @memberof BaseUser
      */
@@ -85,13 +85,13 @@ export interface BaseUser {
      */
     lastName?: string | null;
     /**
-     *
+     * Phone number of the user
      * @type {string}
      * @memberof BaseUser
      */
     phoneNumber?: string | null;
     /**
-     *
+     * Whether the user has accepted the terms of service and privacy policy
      * @type {boolean}
      * @memberof BaseUser
      */
@@ -115,25 +115,25 @@ export interface BaseUser {
      */
     username?: string | null;
     /**
-     *
+     * ISO 8601 timestamp of when the user first visited
      * @type {Date}
      * @memberof BaseUser
      */
     firstVisit?: Date;
     /**
-     *
+     * ISO 8601 timestamp of when the user last visited
      * @type {Date}
      * @memberof BaseUser
      */
     lastVisit?: Date;
     /**
-     *
+     * Whether this is a newly created user
      * @type {boolean}
      * @memberof BaseUser
      */
     newUser?: boolean;
     /**
-     *
+     * Arbitrary key-value metadata associated with the user
      * @type {object}
      * @memberof BaseUser
      */
@@ -145,55 +145,55 @@ export interface BaseUser {
      */
     mfaBackupCodeAcknowledgement?: MfaBackupCodeAcknowledgement | null;
     /**
-     *
+     * Bitcoin wallet address of the user
      * @type {string}
      * @memberof BaseUser
      */
     btcWallet?: string | null;
     /**
-     *
+     * Kadena wallet address of the user
      * @type {string}
      * @memberof BaseUser
      */
     kdaWallet?: string | null;
     /**
-     *
+     * Litecoin wallet address of the user
      * @type {string}
      * @memberof BaseUser
      */
     ltcWallet?: string | null;
     /**
-     *
+     * Nervos CKB wallet address of the user
      * @type {string}
      * @memberof BaseUser
      */
     ckbWallet?: string | null;
     /**
-     *
+     * Kaspa wallet address of the user
      * @type {string}
      * @memberof BaseUser
      */
     kasWallet?: string | null;
     /**
-     *
+     * Dogecoin wallet address of the user
      * @type {string}
      * @memberof BaseUser
      */
     dogeWallet?: string | null;
     /**
-     *
+     * Whether the user has opted in to email notifications
      * @type {boolean}
      * @memberof BaseUser
      */
     emailNotification?: boolean | null;
     /**
-     *
+     * Whether the user has opted in to Discord notifications
      * @type {boolean}
      * @memberof BaseUser
      */
     discordNotification?: boolean | null;
     /**
-     *
+     * Whether the user has opted in to newsletter notifications
      * @type {boolean}
      * @memberof BaseUser
      */
@@ -211,7 +211,7 @@ export interface BaseUser {
      */
     scope?: string;
     /**
-     *
+     * List of required user fields that have not yet been provided
      * @type {Array<ProjectSettingsKyc>}
      * @memberof BaseUser
      */