@dynamic-labs/sdk-api 0.0.936 → 0.0.938

package/package.json

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

package/src/index.cjs

@@ -235,6 +235,7 @@ var EmbeddedWalletVersionEnum = require('./models/EmbeddedWalletVersionEnum.cjs'
 var EnvironmentEnum = require('./models/EnvironmentEnum.cjs');
 var EnvironmentVisitorsResponse = require('./models/EnvironmentVisitorsResponse.cjs');
 var EnvironmentVisitorsResponseUsers = require('./models/EnvironmentVisitorsResponseUsers.cjs');
+var EnvironmentVisitorsResponseVisitors = require('./models/EnvironmentVisitorsResponseVisitors.cjs');
 var EnvironmentsResponse = require('./models/EnvironmentsResponse.cjs');
 var EnvironmentsResponseEnvironments = require('./models/EnvironmentsResponseEnvironments.cjs');
 var ErrorMessageWithCode = require('./models/ErrorMessageWithCode.cjs');
@@ -1498,6 +1499,9 @@ exports.EnvironmentVisitorsResponseToJSON = EnvironmentVisitorsResponse.Environm
 exports.EnvironmentVisitorsResponseUsersFromJSON = EnvironmentVisitorsResponseUsers.EnvironmentVisitorsResponseUsersFromJSON;
 exports.EnvironmentVisitorsResponseUsersFromJSONTyped = EnvironmentVisitorsResponseUsers.EnvironmentVisitorsResponseUsersFromJSONTyped;
 exports.EnvironmentVisitorsResponseUsersToJSON = EnvironmentVisitorsResponseUsers.EnvironmentVisitorsResponseUsersToJSON;
+exports.EnvironmentVisitorsResponseVisitorsFromJSON = EnvironmentVisitorsResponseVisitors.EnvironmentVisitorsResponseVisitorsFromJSON;
+exports.EnvironmentVisitorsResponseVisitorsFromJSONTyped = EnvironmentVisitorsResponseVisitors.EnvironmentVisitorsResponseVisitorsFromJSONTyped;
+exports.EnvironmentVisitorsResponseVisitorsToJSON = EnvironmentVisitorsResponseVisitors.EnvironmentVisitorsResponseVisitorsToJSON;
 exports.EnvironmentsResponseFromJSON = EnvironmentsResponse.EnvironmentsResponseFromJSON;
 exports.EnvironmentsResponseFromJSONTyped = EnvironmentsResponse.EnvironmentsResponseFromJSONTyped;
 exports.EnvironmentsResponseToJSON = EnvironmentsResponse.EnvironmentsResponseToJSON;

package/src/index.js

@@ -231,6 +231,7 @@ export { EmbeddedWalletVersionEnum, EmbeddedWalletVersionEnumFromJSON, EmbeddedW
 export { EnvironmentEnum, EnvironmentEnumFromJSON, EnvironmentEnumFromJSONTyped, EnvironmentEnumToJSON } from './models/EnvironmentEnum.js';
 export { EnvironmentVisitorsResponseFromJSON, EnvironmentVisitorsResponseFromJSONTyped, EnvironmentVisitorsResponseToJSON } from './models/EnvironmentVisitorsResponse.js';
 export { EnvironmentVisitorsResponseUsersFromJSON, EnvironmentVisitorsResponseUsersFromJSONTyped, EnvironmentVisitorsResponseUsersToJSON } from './models/EnvironmentVisitorsResponseUsers.js';
+export { EnvironmentVisitorsResponseVisitorsFromJSON, EnvironmentVisitorsResponseVisitorsFromJSONTyped, EnvironmentVisitorsResponseVisitorsToJSON } from './models/EnvironmentVisitorsResponseVisitors.js';
 export { EnvironmentsResponseFromJSON, EnvironmentsResponseFromJSONTyped, EnvironmentsResponseToJSON } from './models/EnvironmentsResponse.js';
 export { EnvironmentsResponseEnvironmentsFromJSON, EnvironmentsResponseEnvironmentsFromJSONTyped, EnvironmentsResponseEnvironmentsToJSON } from './models/EnvironmentsResponseEnvironments.js';
 export { ErrorMessageWithCodeFromJSON, ErrorMessageWithCodeFromJSONTyped, ErrorMessageWithCodeToJSON } from './models/ErrorMessageWithCode.js';

package/src/models/Allowlist.d.ts

@@ -23,13 +23,13 @@ export interface Allowlist {
      */
     id: string;
     /**
-     *
+     * Human-readable name of the allowlist
      * @type {string}
      * @memberof Allowlist
      */
     name: string;
     /**
-     *
+     * ISO 8601 timestamp of when the allowlist was enabled, or null if disabled
      * @type {Date}
      * @memberof Allowlist
      */
@@ -41,7 +41,7 @@ export interface Allowlist {
      */
     projectEnvironmentId: string;
     /**
-     *
+     * Space-delimited permission scopes granted to matched users
      * @type {string}
      * @memberof Allowlist
      */

package/src/models/AllowlistEntriesResponse.d.ts

@@ -17,13 +17,13 @@ import { AllowlistEntry } from './AllowlistEntry';
  */
 export interface AllowlistEntriesResponse {
     /**
-     *
+     * Total number of entries in the allowlist
      * @type {number}
      * @memberof AllowlistEntriesResponse
      */
     count?: number;
     /**
-     *
+     * List of allowlist entry objects
      * @type {Array<AllowlistEntry>}
      * @memberof AllowlistEntriesResponse
      */

package/src/models/AllowlistEntry.d.ts

@@ -28,61 +28,61 @@ export interface AllowlistEntry {
      */
     allowListId: string;
     /**
-     *
+     * Wallet address matched against user wallets for allowlist evaluation
      * @type {string}
      * @memberof AllowlistEntry
      */
     walletPublicKey?: string;
     /**
-     *
+     * Email address matched against user profiles for allowlist evaluation
      * @type {string}
      * @memberof AllowlistEntry
      */
     email?: string;
     /**
-     *
+     * Email domain (e.g. company.com) matched against all emails from that organization
      * @type {string}
      * @memberof AllowlistEntry
      */
     emailDomain?: string;
     /**
-     *
+     * Phone number matched against user profiles for allowlist evaluation
      * @type {string}
      * @memberof AllowlistEntry
      */
     phoneNumber?: string;
     /**
-     *
+     * Discord username matched against the user's linked Discord OAuth account
      * @type {string}
      * @memberof AllowlistEntry
      */
     discordUsername?: string;
     /**
-     *
+     * Twitter/X username matched against the user's linked Twitter OAuth account
      * @type {string}
      * @memberof AllowlistEntry
      */
     twitterUsername?: string;
     /**
-     *
+     * Farcaster username matched against the user's linked Farcaster profile
      * @type {string}
      * @memberof AllowlistEntry
      */
     farcasterUsername?: string;
     /**
-     *
+     * Farcaster FID (numeric protocol identifier) matched against user profiles
      * @type {number}
      * @memberof AllowlistEntry
      */
     farcasterFid?: number;
     /**
-     *
+     * Human-readable label to identify this entry in the dashboard
      * @type {string}
      * @memberof AllowlistEntry
      */
     alias?: string;
     /**
-     *
+     * External system user ID matched against linked ExternalUser identities
      * @type {string}
      * @memberof AllowlistEntry
      */

package/src/models/AnalyticsEngagementResponse.d.ts

@@ -19,7 +19,7 @@ import { SessionsHeatmapResult } from './SessionsHeatmapResult';
  */
 export interface AnalyticsEngagementResponse {
     /**
-     *
+     * Distribution of how many days per week users are active
      * @type {Array<ActiveWeeklyDaysResult>}
      * @memberof AnalyticsEngagementResponse
      */
@@ -31,7 +31,7 @@ export interface AnalyticsEngagementResponse {
      */
     retention: AnalyticsEngagementResponseRetention;
     /**
-     *
+     * Session activity heatmap grouped by hour of day and day of week
      * @type {Array<SessionsHeatmapResult>}
      * @memberof AnalyticsEngagementResponse
      */

package/src/models/AnalyticsEngagementResponseRetention.d.ts

@@ -11,7 +11,7 @@
  */
 import { RetentionTrendResult } from './RetentionTrendResult';
 /**
- *
+ * Weekly cohort retention data for all users and new users
  * @export
  * @interface AnalyticsEngagementResponseRetention
  */

package/src/models/AnalyticsOverviewResponse.d.ts

@@ -18,7 +18,7 @@ import { AnalyticsOverviewResponseSessions } from './AnalyticsOverviewResponseSe
  */
 export interface AnalyticsOverviewResponse {
     /**
-     *
+     * Daily active user counts over the selected date range
      * @type {Array<ActiveUsersTrendResult>}
      * @memberof AnalyticsOverviewResponse
      */

package/src/models/AnalyticsOverviewResponseSessions.d.ts

@@ -11,7 +11,7 @@
  */
 import { SessionsTrendResult } from './SessionsTrendResult';
 /**
- *
+ * Session trends broken down by login method and operating system
  * @export
  * @interface AnalyticsOverviewResponseSessions
  */

package/src/models/AnalyticsSessionsByDate.d.ts

@@ -17,13 +17,13 @@ import { AnalyticsSessionsByDateSessions } from './AnalyticsSessionsByDateSessio
  */
 export interface AnalyticsSessionsByDate {
     /**
-     *
+     * Total number of unique users or visitors in the dataset
      * @type {number}
      * @memberof AnalyticsSessionsByDate
      */
     totalUnique?: number;
     /**
-     *
+     * List of session count entries grouped by date
      * @type {Array<AnalyticsSessionsByDateSessions>}
      * @memberof AnalyticsSessionsByDate
      */

package/src/models/AnalyticsToplineResponseSessions.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * Aggregate session counts for all-time and the selected date range
  * @export
  * @interface AnalyticsToplineResponseSessions
  */

package/src/models/AnalyticsToplineResponseUsers.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * Aggregate user counts for all-time and the selected date range
  * @export
  * @interface AnalyticsToplineResponseUsers
  */

package/src/models/AnalyticsToplineResponseWallets.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * Aggregate wallet counts for all-time and the selected date range
  * @export
  * @interface AnalyticsToplineResponseWallets
  */

package/src/models/AnalyticsVisitResponse.d.ts

@@ -17,13 +17,13 @@ import { AnalyticsSessionsByDate } from './AnalyticsSessionsByDate';
  */
 export interface AnalyticsVisitResponse {
     /**
-     *
+     * Total number of sessions across the selected date range
      * @type {number}
      * @memberof AnalyticsVisitResponse
      */
     summedSessionsCount?: number;
     /**
-     *
+     * Total number of unique users or visitors across the selected date range
      * @type {number}
      * @memberof AnalyticsVisitResponse
      */

package/src/models/AnalyticsWalletsResponseBreakdown.d.ts

@@ -11,7 +11,7 @@
  */
 import { WalletsBreakdownResult } from './WalletsBreakdownResult';
 /**
- *
+ * Wallet usage breakdown by provider for all-time and the selected date range
  * @export
  * @interface AnalyticsWalletsResponseBreakdown
  */

package/src/models/BackupKeySharesToLocationsWithUserIdRequest.d.ts

@@ -23,7 +23,7 @@ export interface BackupKeySharesToLocationsWithUserIdRequest {
      */
     userId: string;
     /**
-     *
+     * Where to store key backup shares — valid values include user, dynamic, googleDrive, iCloud, external
      * @type {Array<BackupKeySharesToLocationsWithUserIdRequestLocations>}
      * @memberof BackupKeySharesToLocationsWithUserIdRequest
      */

package/src/models/BillingSubscription.d.ts

@@ -19,25 +19,25 @@ import { BillingSubscriptionPlanTypeEnum } from './BillingSubscriptionPlanTypeEn
  */
 export interface BillingSubscription {
     /**
-     *
+     * URL to the Stripe billing portal for managing the subscription
      * @type {string}
      * @memberof BillingSubscription
      */
     billingPortalUrl?: string;
     /**
-     *
+     * URL to the Stripe billing portal pre-configured to add a payment method
      * @type {string}
      * @memberof BillingSubscription
      */
     billingPortalAddPaymentMethodUrl?: string;
     /**
-     *
+     * When true, the subscription will be cancelled at the end of the current billing period
      * @type {boolean}
      * @memberof BillingSubscription
      */
     cancelAtPeriodEnd?: boolean;
     /**
-     *
+     * Whether the organization has a valid payment method on file
      * @type {boolean}
      * @memberof BillingSubscription
      */
@@ -49,31 +49,31 @@ export interface BillingSubscription {
      */
     planType: BillingSubscriptionPlanTypeEnum;
     /**
-     *
+     * Whether the subscription is currently in a free trial period
      * @type {boolean}
      * @memberof BillingSubscription
      */
     inTrial: boolean;
     /**
-     *
+     * List of feature scope strings included in the current subscription plan
      * @type {Array<string>}
      * @memberof BillingSubscription
      */
     scope: Array<string>;
     /**
-     *
+     * ISO 8601 timestamp of when the trial period started
      * @type {Date}
      * @memberof BillingSubscription
      */
     trialStart?: Date;
     /**
-     *
+     * ISO 8601 timestamp of when the trial period ends
      * @type {Date}
      * @memberof BillingSubscription
      */
     trialEnd?: Date;
     /**
-     *
+     * Number of days remaining in the trial period
      * @type {number}
      * @memberof BillingSubscription
      */
@@ -85,19 +85,19 @@ export interface BillingSubscription {
      */
     currentBillingPeriod?: BillingSubscriptionPeriod;
     /**
-     *
+     * Billing plan version identifier
      * @type {string}
      * @memberof BillingSubscription
      */
     version: string;
     /**
-     *
+     * When true, the user cannot switch between live and sandbox until payment is added
      * @type {boolean}
      * @memberof BillingSubscription
      */
     shouldLockEnvironmentSwitch?: boolean;
     /**
-     *
+     * List of discount coupons applied to the subscription
      * @type {Array<BillingSubscriptionCoupon>}
      * @memberof BillingSubscription
      */

package/src/models/BillingSubscriptionPeriod.d.ts

@@ -16,19 +16,19 @@
  */
 export interface BillingSubscriptionPeriod {
     /**
-     *
+     * ISO 8601 timestamp of when the billing period started
      * @type {Date}
      * @memberof BillingSubscriptionPeriod
      */
     startDate: Date;
     /**
-     *
+     * ISO 8601 timestamp of when the billing period ends
      * @type {Date}
      * @memberof BillingSubscriptionPeriod
      */
     endDate: Date;
     /**
-     *
+     * Number of metered usage events recorded in this billing period
      * @type {number}
      * @memberof BillingSubscriptionPeriod
      */

package/src/models/BulkUserCreateResponse.d.ts

@@ -18,25 +18,25 @@ import { User } from './User';
  */
 export interface BulkUserCreateResponse {
     /**
-     *
+     * List of user objects that were newly created
      * @type {Array<User>}
      * @memberof BulkUserCreateResponse
      */
     created?: Array<User>;
     /**
-     *
+     * List of user objects that were updated with new data
      * @type {Array<User>}
      * @memberof BulkUserCreateResponse
      */
     updated?: Array<User>;
     /**
-     *
+     * List of user objects that failed to create or update, with error details
      * @type {Array<BulkUserCreateResponseFailed>}
      * @memberof BulkUserCreateResponse
      */
     failed?: Array<BulkUserCreateResponseFailed>;
     /**
-     *
+     * Total number of users in the bulk request
      * @type {number}
      * @memberof BulkUserCreateResponse
      */

package/src/models/ChainalysisCheck.d.ts

@@ -23,7 +23,7 @@ export interface ChainalysisCheck {
      */
     id: string;
     /**
-     *
+     * ISO 8601 timestamp of when the Chainalysis check was performed
      * @type {Date}
      * @memberof ChainalysisCheck
      */
@@ -41,7 +41,7 @@ export interface ChainalysisCheck {
      */
     walletPublicKey: string;
     /**
-     *
+     * Raw JSON response body from the Chainalysis API
      * @type {string}
      * @memberof ChainalysisCheck
      */

package/src/models/ChainalysisConfiguration.d.ts

@@ -22,13 +22,13 @@ export interface ChainalysisConfiguration {
      */
     id: string;
     /**
-     *
+     * Whether Chainalysis sanctions screening is enabled for wallet addresses
      * @type {boolean}
      * @memberof ChainalysisConfiguration
      */
     sanctionsApiEnabled: boolean;
     /**
-     *
+     * Whether Chainalysis Know Your Transaction (KYT) monitoring is enabled
      * @type {boolean}
      * @memberof ChainalysisConfiguration
      */
@@ -40,13 +40,13 @@ export interface ChainalysisConfiguration {
      */
     projectEnvironmentId: string;
     /**
-     *
+     * ISO 8601 timestamp of when the Chainalysis configuration was created
      * @type {Date}
      * @memberof ChainalysisConfiguration
      */
     createdAt: Date;
     /**
-     *
+     * ISO 8601 timestamp of when the Chainalysis configuration was last updated
      * @type {Date}
      * @memberof ChainalysisConfiguration
      */

package/src/models/CreateProjectResponseProject.d.ts

@@ -11,7 +11,7 @@
  */
 import { CreateProjectResponseProjectProjectEnvironments } from './CreateProjectResponseProjectProjectEnvironments';
 /**
- *
+ * The newly created project with its environments
  * @export
  * @interface CreateProjectResponseProject
  */

package/src/models/CreateUserOauthRequest.d.ts

@@ -29,7 +29,7 @@ export interface CreateUserOauthRequest {
      */
     accountId: string;
     /**
-     *
+     * List of email addresses associated with this OAuth account
      * @type {Array<string>}
      * @memberof CreateUserOauthRequest
      */
@@ -47,13 +47,13 @@ export interface CreateUserOauthRequest {
      */
     username?: string;
     /**
-     *
+     * List of profile photo URLs from the OAuth provider
      * @type {Array<string>}
      * @memberof CreateUserOauthRequest
      */
     photos?: Array<string>;
     /**
-     *
+     * Raw profile data returned by the OAuth provider
      * @type {object}
      * @memberof CreateUserOauthRequest
      */

package/src/models/CreateWalletRequest.d.ts

@@ -43,7 +43,7 @@ export interface CreateWalletRequest {
      */
     walletProvider: WalletProviderEnum;
     /**
-     *
+     * Extra public addresses derived from or associated with this wallet (e.g. multi-chain)
      * @type {Array<WalletAdditionalAddress>}
      * @memberof CreateWalletRequest
      */

package/src/models/CustomField.d.ts

@@ -60,7 +60,7 @@ export interface CustomField {
      */
     validationRules?: CustomFieldValidationRules;
     /**
-     *
+     * Zero-based display order in the onboarding form — lower values appear first
      * @type {number}
      * @memberof CustomField
      */

package/src/models/CustomFieldRequest.d.ts

@@ -24,13 +24,13 @@ export interface CustomFieldRequest {
      */
     name: string;
     /**
-     *
+     * When true the field is visible in user forms; when false it is hidden but existing data persists
      * @type {boolean}
      * @memberof CustomFieldRequest
      */
     enabled: boolean;
     /**
-     *
+     * When true users must fill this field to complete onboarding
      * @type {boolean}
      * @memberof CustomFieldRequest
      */
@@ -48,7 +48,7 @@ export interface CustomFieldRequest {
      */
     validationRules?: CustomFieldValidationRules;
     /**
-     *
+     * Zero-based display order in the onboarding form — lower values appear first
      * @type {number}
      * @memberof CustomFieldRequest
      */

package/src/models/CustomHostname.d.ts

@@ -43,13 +43,13 @@ export interface CustomHostname {
      */
     status: CustomHostnameStatusEnum;
     /**
-     *
+     * List of DNS records required to verify ownership of the custom hostname
      * @type {Array<CustomHostnameVerificationRecord>}
      * @memberof CustomHostname
      */
     verificationRecords: Array<CustomHostnameVerificationRecord>;
     /**
-     *
+     * Error message describing why hostname verification or activation failed
      * @type {string}
      * @memberof CustomHostname
      */

package/src/models/CustomHostnameVerificationRecord.d.ts

@@ -30,13 +30,13 @@ export interface CustomHostnameVerificationRecord {
      */
     verificationType: CustomHostnameVerificationType;
     /**
-     *
+     * DNS record name (host) to create for verification
      * @type {string}
      * @memberof CustomHostnameVerificationRecord
      */
     name: string;
     /**
-     *
+     * DNS record value to set for verification
      * @type {string}
      * @memberof CustomHostnameVerificationRecord
      */

package/src/models/CustomHostnamesResponse.d.ts

@@ -17,7 +17,7 @@ import { CustomHostname } from './CustomHostname';
  */
 export interface CustomHostnamesResponse {
     /**
-     *
+     * List of custom hostname objects configured for this environment
      * @type {Array<CustomHostname>}
      * @memberof CustomHostnamesResponse
      */

package/src/models/CustomNetworkResponseCustomNetwork.d.ts

@@ -11,7 +11,7 @@
  */
 import { ChainEnum } from './ChainEnum';
 /**
- *
+ * The custom network configuration details
  * @export
  * @interface CustomNetworkResponseCustomNetwork
  */

package/src/models/DeeplinkUrlResponse.d.ts

@@ -28,7 +28,7 @@ export interface DeeplinkUrlResponse {
      */
     url: string;
     /**
-     *
+     * ISO 8601 timestamp of when the deeplink URL was created
      * @type {Date}
      * @memberof DeeplinkUrlResponse
      */

package/src/models/DeeplinkUrlsResponse.d.ts

@@ -17,7 +17,7 @@ import { DeeplinkUrlResponse } from './DeeplinkUrlResponse';
  */
 export interface DeeplinkUrlsResponse {
     /**
-     *
+     * List of deeplink URL objects configured for this environment
      * @type {Array<DeeplinkUrlResponse>}
      * @memberof DeeplinkUrlsResponse
      */

package/src/models/DelegatedAccessEncryptionPublicKey.d.ts

@@ -71,13 +71,13 @@ export interface DelegatedAccessEncryptionPublicKey {
      */
     revokedAt?: Date | null;
     /**
-     *
+     * ISO 8601 timestamp of when the encryption public key was created
      * @type {Date}
      * @memberof DelegatedAccessEncryptionPublicKey
      */
     createdAt: Date;
     /**
-     *
+     * ISO 8601 timestamp of when the encryption public key was last updated
      * @type {Date}
      * @memberof DelegatedAccessEncryptionPublicKey
      */