@dynamic-labs/sdk-api 0.0.936 → 0.0.938

package/src/models/Invite.d.ts

@@ -30,7 +30,7 @@ export interface Invite {
      */
     organizationId: string;
     /**
-     *
+     * Display name of the organization the invite is for
      * @type {string}
      * @memberof Invite
      */
@@ -42,19 +42,19 @@ export interface Invite {
      */
     status: InviteStatusEnum;
     /**
-     *
+     * Email address the invite was sent to
      * @type {string}
      * @memberof Invite
      */
     email?: string;
     /**
-     *
+     * Suggested display name applied to the user's profile when they accept
      * @type {string}
      * @memberof Invite
      */
     alias?: string;
     /**
-     *
+     * Wallet address the invite was sent to (alternative to email)
      * @type {string}
      * @memberof Invite
      */

package/src/models/InviteConflictResponse.d.ts

@@ -16,7 +16,7 @@
  */
 export interface InviteConflictResponse {
     /**
-     *
+     * Human-readable explanation of why the invite conflicts with an existing one
      * @type {string}
      * @memberof InviteConflictResponse
      */

package/src/models/InvitesResponse.d.ts

@@ -17,13 +17,13 @@ import { Invite } from './Invite';
  */
 export interface InvitesResponse {
     /**
-     *
+     * Total number of invites matching the query
      * @type {number}
      * @memberof InvitesResponse
      */
     count?: number;
     /**
-     *
+     * List of invite objects
      * @type {Array<Invite>}
      * @memberof InvitesResponse
      */

package/src/models/NameServiceCreateRequest.d.ts

@@ -28,7 +28,7 @@ export interface NameServiceCreateRequest {
      */
     domain: string;
     /**
-     *
+     * Cryptographic signature of the signing message proving domain ownership
      * @type {string}
      * @memberof NameServiceCreateRequest
      */

package/src/models/NameServiceSigningMessageRequest.d.ts

@@ -28,7 +28,7 @@ export interface NameServiceSigningMessageRequest {
      */
     domain: string;
     /**
-     *
+     * URI to associate with the name service record (e.g. a profile URL or IPFS hash)
      * @type {string}
      * @memberof NameServiceSigningMessageRequest
      */

package/src/models/OAuthAccount.d.ts

@@ -29,7 +29,7 @@ export interface OAuthAccount {
      */
     provider?: ProviderEnum;
     /**
-     *
+     * Username or display name from the linked OAuth provider account
      * @type {string}
      * @memberof OAuthAccount
      */

package/src/models/OauthProviderLoginUrl.d.ts

@@ -16,7 +16,7 @@
  */
 export interface OauthProviderLoginUrl {
     /**
-     *
+     * OAuth authorization URL to redirect the user to for login
      * @type {string}
      * @memberof OauthProviderLoginUrl
      */

package/src/models/Organization.d.ts

@@ -24,7 +24,7 @@ export interface Organization {
      */
     id: string;
     /**
-     *
+     * Organization display name
      * @type {string}
      * @memberof Organization
      */

package/src/models/OrganizationMembersResponse.d.ts

@@ -17,13 +17,13 @@ import { OrganizationMember } from './OrganizationMember';
  */
 export interface OrganizationMembersResponse {
     /**
-     *
+     * Total number of members in the organization
      * @type {number}
      * @memberof OrganizationMembersResponse
      */
     count: number;
     /**
-     *
+     * List of organization member objects
      * @type {Array<OrganizationMember>}
      * @memberof OrganizationMembersResponse
      */

package/src/models/OrganizationMfaSettings.d.ts

@@ -17,7 +17,7 @@ import { MFADeviceType } from './MFADeviceType';
  */
 export interface OrganizationMfaSettings {
     /**
-     *
+     * ISO 8601 timestamp of when this MFA method was enabled, or null if disabled
      * @type {Date}
      * @memberof OrganizationMfaSettings
      */

package/src/models/OrganizationMfaSettingsResponse.d.ts

@@ -17,7 +17,7 @@ import { OrganizationMfaSettings } from './OrganizationMfaSettings';
  */
 export interface OrganizationMfaSettingsResponse {
     /**
-     *
+     * List of MFA device type settings for the organization
      * @type {Array<OrganizationMfaSettings>}
      * @memberof OrganizationMfaSettingsResponse
      */

package/src/models/OrganizationResponseOrganization.d.ts

@@ -11,7 +11,7 @@
  */
 import { OrganizationAddressFields } from './OrganizationAddressFields';
 /**
- *
+ * The organization details
  * @export
  * @interface OrganizationResponseOrganization
  */

package/src/models/OrganizationsResponse.d.ts

@@ -17,7 +17,7 @@ import { Organization } from './Organization';
  */
 export interface OrganizationsResponse {
     /**
-     *
+     * List of organization objects the authenticated user belongs to
      * @type {Array<Organization>}
      * @memberof OrganizationsResponse
      */

package/src/models/OriginResponse.d.ts

@@ -28,7 +28,7 @@ export interface OriginResponse {
      */
     origin?: string;
     /**
-     *
+     * ISO 8601 timestamp of when the allowed origin was created
      * @type {Date}
      * @memberof OriginResponse
      */

package/src/models/OriginsResponse.d.ts

@@ -17,7 +17,7 @@ import { OriginResponse } from './OriginResponse';
  */
 export interface OriginsResponse {
     /**
-     *
+     * List of allowed origin objects for this environment
      * @type {Array<OriginResponse>}
      * @memberof OriginsResponse
      */

package/src/models/PostAllowlistEntriesRequest.d.ts

@@ -64,7 +64,7 @@ export interface PostAllowlistEntriesRequest {
      */
     farcasterUsername?: string;
     /**
-     *
+     * Farcaster FID (numeric protocol identifier) to match
      * @type {number}
      * @memberof PostAllowlistEntriesRequest
      */

package/src/models/Project.d.ts

@@ -17,7 +17,7 @@ import { ProjectProjectEnvironments } from './ProjectProjectEnvironments';
  */
 export interface Project {
     /**
-     *
+     * Project display name
      * @type {string}
      * @memberof Project
      */
@@ -35,7 +35,7 @@ export interface Project {
      */
     organizationId: string;
     /**
-     *
+     * List of environments (live and sandbox) belonging to this project
      * @type {Array<ProjectProjectEnvironments>}
      * @memberof Project
      */

package/src/models/ProjectEnvironment.d.ts

@@ -29,19 +29,19 @@ export interface ProjectEnvironment {
      */
     settings?: ProjectSettings;
     /**
-     *
+     * ISO 8601 timestamp of when the environment was created
      * @type {Date}
      * @memberof ProjectEnvironment
      */
     createdAt?: Date;
     /**
-     *
+     * ISO 8601 timestamp of when the environment was last updated
      * @type {Date}
      * @memberof ProjectEnvironment
      */
     updatedAt?: Date;
     /**
-     *
+     * Latest SDK version reported by the client for this environment
      * @type {string}
      * @memberof ProjectEnvironment
      */

package/src/models/ProjectsResponse.d.ts

@@ -17,7 +17,7 @@ import { Project } from './Project';
  */
 export interface ProjectsResponse {
     /**
-     *
+     * List of project objects belonging to the organization
      * @type {Array<Project>}
      * @memberof ProjectsResponse
      */

package/src/models/ProviderCreateRequest.d.ts

@@ -71,7 +71,7 @@ export interface ProviderCreateRequest {
      */
     termsUrl?: string;
     /**
-     *
+     * When true, Dynamic manages the OAuth credentials — clientId and clientSecret are set to null
      * @type {boolean}
      * @memberof ProviderCreateRequest
      */
@@ -119,7 +119,7 @@ export interface ProviderCreateRequest {
      */
     twilioVerifyServiceSid?: string;
     /**
-     *
+     * ISO country codes restricting which countries can use this SMS provider
      * @type {Array<SmsCountryCode>}
      * @memberof ProviderCreateRequest
      */
@@ -131,7 +131,7 @@ export interface ProviderCreateRequest {
      */
     sendgridIpPoolName?: string;
     /**
-     *
+     * ZeroDev account abstraction chain mappings — each entry binds a clientId to a specific chain
      * @type {Array<ProviderCreateRequestMultichainAccountAbstractionProviders>}
      * @memberof ProviderCreateRequest
      */
@@ -155,13 +155,13 @@ export interface ProviderCreateRequest {
      */
     ecdsaProviderType?: EcdsaValidatorOptions;
     /**
-     *
+     * When true, migrates existing user smart accounts from Kernel v2 to v3 on next interaction
      * @type {boolean}
      * @memberof ProviderCreateRequest
      */
     enableKernelV3Migration?: boolean;
     /**
-     *
+     * When true, enables EIP-7702 set-code transactions for cheaper account abstraction deployment
      * @type {boolean}
      * @memberof ProviderCreateRequest
      */
@@ -197,19 +197,19 @@ export interface ProviderCreateRequest {
      */
     zerodevBundlerProvider?: ZerodevBundlerProvider;
     /**
-     *
+     * Custom RPC endpoint URL overriding the default ZeroDev bundler for UserOperation submission
      * @type {string}
      * @memberof ProviderCreateRequest
      */
     zerodevBundlerRpcUrl?: string;
     /**
-     *
+     * Custom RPC endpoint URL for the paymaster service that sponsors gas fees for users
      * @type {string}
      * @memberof ProviderCreateRequest
      */
     zerodevPaymasterRpcUrl?: string;
     /**
-     *
+     * Kernel smart contract address enabling delegated account control for multi-sig or recovery
      * @type {string}
      * @memberof ProviderCreateRequest
      */

package/src/models/ProviderUpdateRequest.d.ts

@@ -58,7 +58,7 @@ export interface ProviderUpdateRequest {
      */
     keyExportUrl?: string;
     /**
-     *
+     * When true, Dynamic manages the OAuth credentials — clientId and clientSecret are set to null
      * @type {boolean}
      * @memberof ProviderUpdateRequest
      */
@@ -112,7 +112,7 @@ export interface ProviderUpdateRequest {
      */
     twilioVerifyServiceSid?: string;
     /**
-     *
+     * ISO country codes restricting which countries can use this SMS provider
      * @type {Array<SmsCountryCode>}
      * @memberof ProviderUpdateRequest
      */
@@ -124,7 +124,7 @@ export interface ProviderUpdateRequest {
      */
     sendgridIpPoolName?: string;
     /**
-     *
+     * ZeroDev account abstraction chain mappings — each entry binds a clientId to a specific chain
      * @type {Array<ProviderCreateRequestMultichainAccountAbstractionProviders>}
      * @memberof ProviderUpdateRequest
      */
@@ -148,13 +148,13 @@ export interface ProviderUpdateRequest {
      */
     ecdsaProviderType?: EcdsaValidatorOptions;
     /**
-     *
+     * When true, migrates existing user smart accounts from Kernel v2 to v3 on next interaction
      * @type {boolean}
      * @memberof ProviderUpdateRequest
      */
     enableKernelV3Migration?: boolean;
     /**
-     *
+     * When true, enables EIP-7702 set-code transactions for cheaper account abstraction deployment
      * @type {boolean}
      * @memberof ProviderUpdateRequest
      */
@@ -190,19 +190,19 @@ export interface ProviderUpdateRequest {
      */
     zerodevBundlerProvider?: ZerodevBundlerProvider;
     /**
-     *
+     * Custom RPC endpoint URL overriding the default ZeroDev bundler for UserOperation submission
      * @type {string}
      * @memberof ProviderUpdateRequest
      */
     zerodevBundlerRpcUrl?: string;
     /**
-     *
+     * Custom RPC endpoint URL for the paymaster service that sponsors gas fees for users
      * @type {string}
      * @memberof ProviderUpdateRequest
      */
     zerodevPaymasterRpcUrl?: string;
     /**
-     *
+     * Kernel smart contract address enabling delegated account control for multi-sig or recovery
      * @type {string}
      * @memberof ProviderUpdateRequest
      */

package/src/models/ProviderUrlsResponse.d.ts

@@ -17,7 +17,7 @@ import { ProviderUrl } from './ProviderUrl';
  */
 export interface ProviderUrlsResponse {
     /**
-     *
+     * List of OAuth provider URL objects with authorization and redirect URLs
      * @type {Array<ProviderUrl>}
      * @memberof ProviderUrlsResponse
      */

package/src/models/ProvidersResponse.d.ts

@@ -17,7 +17,7 @@ import { Provider } from './Provider';
  */
 export interface ProvidersResponse {
     /**
-     *
+     * List of authentication provider objects configured for this environment
      * @type {Array<Provider>}
      * @memberof ProvidersResponse
      */

package/src/models/Session.d.ts

@@ -22,25 +22,25 @@ export interface Session {
      */
     id?: string;
     /**
-     *
+     * ISO 8601 timestamp of when the session was created
      * @type {Date}
      * @memberof Session
      */
     createdAt?: Date;
     /**
-     *
+     * IP address of the client that initiated the session
      * @type {string}
      * @memberof Session
      */
     ipAddress?: string | null;
     /**
-     *
+     * User-Agent string of the client that initiated the session
      * @type {string}
      * @memberof Session
      */
     userAgent?: string | null;
     /**
-     *
+     * ISO 8601 timestamp of when the session was revoked, or null if still active
      * @type {Date}
      * @memberof Session
      */

package/src/models/SessionsResponse.d.ts

@@ -17,7 +17,7 @@ import { Session } from './Session';
  */
 export interface SessionsResponse {
     /**
-     *
+     * List of session objects for the user
      * @type {Array<Session>}
      * @memberof SessionsResponse
      */

package/src/models/TestAccountResponse.d.ts

@@ -16,19 +16,19 @@
  */
 export interface TestAccountResponse {
     /**
-     *
+     * One-time verification code generated for the test account
      * @type {string}
      * @memberof TestAccountResponse
      */
     code: string;
     /**
-     *
+     * Email address associated with the test account
      * @type {string}
      * @memberof TestAccountResponse
      */
     email?: string;
     /**
-     *
+     * Phone number associated with the test account
      * @type {string}
      * @memberof TestAccountResponse
      */

package/src/models/Token.d.ts

@@ -37,13 +37,13 @@ export interface Token {
      */
     createdBy: TokenCreatedBy;
     /**
-     *
+     * ISO 8601 timestamp of when the token was created
      * @type {Date}
      * @memberof Token
      */
     createdAt: Date;
     /**
-     *
+     * Human-readable label to identify this token and its intended use
      * @type {string}
      * @memberof Token
      */

package/src/models/TokenCreatedBy.d.ts

@@ -22,25 +22,25 @@ export interface TokenCreatedBy {
      */
     id: string;
     /**
-     *
+     * Display name or nickname of the admin who created the token
      * @type {string}
      * @memberof TokenCreatedBy
      */
     alias?: string;
     /**
-     *
+     * First name of the admin who created the token
      * @type {string}
      * @memberof TokenCreatedBy
      */
     firstName?: string;
     /**
-     *
+     * Last name of the admin who created the token
      * @type {string}
      * @memberof TokenCreatedBy
      */
     lastName?: string;
     /**
-     *
+     * Email address of the admin who created the token
      * @type {string}
      * @memberof TokenCreatedBy
      */

package/src/models/TokenWithRaw.d.ts

@@ -49,13 +49,13 @@ export interface TokenWithRaw {
      */
     active?: boolean;
     /**
-     *
+     * ISO 8601 timestamp of when the token was created
      * @type {Date}
      * @memberof TokenWithRaw
      */
     createdAt: Date;
     /**
-     *
+     * Human-readable label to identify this token and its intended use
      * @type {string}
      * @memberof TokenWithRaw
      */

package/src/models/TokenWithRawProjectEnvironment.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * The environment this token is scoped to
  * @export
  * @interface TokenWithRawProjectEnvironment
  */

package/src/models/TokensResponse.d.ts

@@ -17,7 +17,7 @@ import { Token } from './Token';
  */
 export interface TokensResponse {
     /**
-     *
+     * List of environment API token objects
      * @type {Array<Token>}
      * @memberof TokensResponse
      */

package/src/models/UpdateProjectResponse.d.ts

@@ -22,7 +22,7 @@ export interface UpdateProjectResponse {
      */
     id?: string;
     /**
-     *
+     * Updated project display name
      * @type {string}
      * @memberof UpdateProjectResponse
      */

package/src/models/User.d.ts

@@ -241,43 +241,43 @@ export interface User {
      */
     chain?: ChainEnum;
     /**
-     *
+     * ISO 8601 timestamp of when the user account was created
      * @type {Date}
      * @memberof User
      */
     createdAt?: Date;
     /**
-     *
+     * ISO 8601 timestamp of when the user account was last updated
      * @type {Date}
      * @memberof User
      */
     updatedAt?: Date;
     /**
-     *
+     * List of authentication sessions for this user
      * @type {Array<Session>}
      * @memberof User
      */
     sessions?: Array<Session>;
     /**
-     *
+     * List of wallets linked to this user
      * @type {Array<Wallet>}
      * @memberof User
      */
     wallets?: Array<Wallet>;
     /**
-     *
+     * List of Chainalysis compliance checks performed on this user
      * @type {Array<ChainalysisCheck>}
      * @memberof User
      */
     chainalysisChecks?: Array<ChainalysisCheck>;
     /**
-     *
+     * List of OAuth social accounts linked to this user
      * @type {Array<OAuthAccount>}
      * @memberof User
      */
     oauthAccounts?: Array<OAuthAccount>;
     /**
-     *
+     * List of MFA devices registered by this user
      * @type {Array<MFADevice>}
      * @memberof User
      */

package/src/models/UserAllOf.d.ts

@@ -40,43 +40,43 @@ export interface UserAllOf {
      */
     chain?: ChainEnum;
     /**
-     *
+     * ISO 8601 timestamp of when the user account was created
      * @type {Date}
      * @memberof UserAllOf
      */
     createdAt?: Date;
     /**
-     *
+     * ISO 8601 timestamp of when the user account was last updated
      * @type {Date}
      * @memberof UserAllOf
      */
     updatedAt?: Date;
     /**
-     *
+     * List of authentication sessions for this user
      * @type {Array<Session>}
      * @memberof UserAllOf
      */
     sessions?: Array<Session>;
     /**
-     *
+     * List of wallets linked to this user
      * @type {Array<Wallet>}
      * @memberof UserAllOf
      */
     wallets?: Array<Wallet>;
     /**
-     *
+     * List of Chainalysis compliance checks performed on this user
      * @type {Array<ChainalysisCheck>}
      * @memberof UserAllOf
      */
     chainalysisChecks?: Array<ChainalysisCheck>;
     /**
-     *
+     * List of OAuth social accounts linked to this user
      * @type {Array<OAuthAccount>}
      * @memberof UserAllOf
      */
     oauthAccounts?: Array<OAuthAccount>;
     /**
-     *
+     * List of MFA devices registered by this user
      * @type {Array<MFADevice>}
      * @memberof UserAllOf
      */