@dynamic-labs-sdk/client 1.18.0 → 1.19.0

package/dist/modules/auth/social/oauth/completeSocialRedirect/completeSocialRedirect.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"completeSocialRedirect.d.ts","sourceRoot":"","sources":["../../../../../../src/modules/auth/social/oauth/completeSocialRedirect/completeSocialRedirect.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,6BAA6B,CAAC;AAExD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAEnF,YAAY,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAEnF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,sBAAsB,6BACP,4BAA4B,8DAErD,OAAO,CAAC,IAAI,GAAG,IAAI,CACmC,CAAC"}
+{"version":3,"file":"completeSocialRedirect.d.ts","sourceRoot":"","sources":["../../../../../../src/modules/auth/social/oauth/completeSocialRedirect/completeSocialRedirect.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,6BAA6B,CAAC;AAExD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAEnF,YAAY,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAEnF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,sBAAsB,6BACP,4BAA4B,8DAErD,OAAO,CAAC,IAAI,GAAG,IAAI,CACmC,CAAC"}

package/dist/modules/auth/social/oauth/detectSocialRedirectUrl/detectSocialRedirectUrl.d.ts

@@ -11,7 +11,6 @@ export type { DetectSocialRedirectUrlParams } from './detectSocialRedirectUrl.ty
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns A promise that resolves to true if the URL is an OAuth redirect, false otherwise.
  * @notInstrumented
- * @noHook Low-level redirect-detection primitive that is not exposed as a React hook.
  */
 export declare const detectSocialRedirectUrl: ({ url }: DetectSocialRedirectUrlParams, client?: import("../../../../../exports").DynamicClient) => Promise<boolean>;
 //# sourceMappingURL=detectSocialRedirectUrl.d.ts.map

package/dist/modules/auth/social/oauth/detectSocialRedirectUrl/detectSocialRedirectUrl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"detectSocialRedirectUrl.d.ts","sourceRoot":"","sources":["../../../../../../src/modules/auth/social/oauth/detectSocialRedirectUrl/detectSocialRedirectUrl.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAErF,YAAY,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAErF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,uBAAuB,YACzB,6BAA6B,8DAErC,OAAO,CAAC,OAAO,CAkBjB,CAAC"}
+{"version":3,"file":"detectSocialRedirectUrl.d.ts","sourceRoot":"","sources":["../../../../../../src/modules/auth/social/oauth/detectSocialRedirectUrl/detectSocialRedirectUrl.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAErF,YAAY,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAErF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,uBAAuB,YACzB,6BAA6B,8DAErC,OAAO,CAAC,OAAO,CAkBjB,CAAC"}

package/dist/modules/auth/social/oauth/signInWithSocialPopUp/signInWithSocialPopUp.d.ts

@@ -9,7 +9,19 @@ export type { SignInWithSocialPopUpParams } from './signInWithSocialPopUp.types'
  * {@link signInWithSocialRedirect} + {@link completeSocialRedirect} instead —
  * the browser already owns the tab so there is no popup to open.
  *
+ * @example
+ * ```ts
+ * // React Native only
+ * const user = await signInWithSocialPopUp({ provider: 'google' });
+ * ```
+ *
+ * @param params.provider - The social provider to authenticate with.
+ * @param [params.requestedScopes] - Optional scopes to request from the provider.
+ * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+ * @returns A promise that resolves to the authenticated user or null.
  * @throws MethodNotImplementedError Always on web.
+ * @see signInWithSocialRedirect
+ * @see completeSocialRedirect
  * @instrumented
  */
 export declare const signInWithSocialPopUp: ({ provider, requestedScopes }: SignInWithSocialPopUpParams, client?: import("../../../../../exports").DynamicClient) => Promise<User | null>;

package/dist/modules/auth/social/oauth/signInWithSocialPopUp/signInWithSocialPopUp.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signInWithSocialPopUp.d.ts","sourceRoot":"","sources":["../../../../../../src/modules/auth/social/oauth/signInWithSocialPopUp/signInWithSocialPopUp.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEjF,YAAY,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEjF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB,kCAED,2BAA2B,8DAGzD,OAAO,CAAC,IAAI,GAAG,IAAI,CAIrB,CAAC"}
+{"version":3,"file":"signInWithSocialPopUp.d.ts","sourceRoot":"","sources":["../../../../../../src/modules/auth/social/oauth/signInWithSocialPopUp/signInWithSocialPopUp.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEjF,YAAY,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEjF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,qBAAqB,kCAED,2BAA2B,8DAGzD,OAAO,CAAC,IAAI,GAAG,IAAI,CAIrB,CAAC"}

package/dist/modules/auth/social/oauth/signInWithSocialRedirect/signInWithSocialRedirect.d.ts

@@ -10,9 +10,19 @@ export type { SignInWithSocialRedirectParams } from './signInWithSocialRedirect.
  * back because of this flow, then call `completeSocialRedirect` to finish
  * the social authentication.
  *
+ * @example
+ * ```ts
+ * await signInWithSocialRedirect({
+ *   provider: 'google',
+ *   redirectUrl: window.location.href,
+ * });
+ * ```
+ *
  * @param params.provider - The social provider to authenticate with (e.g., 'google', 'github').
  * @param params.redirectUrl - The URL to redirect back to after authentication.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+ * @see completeSocialRedirect
+ * @see detectSocialRedirectUrl
  * @instrumented
  */
 export declare const signInWithSocialRedirect: ({ provider, redirectUrl }: SignInWithSocialRedirectParams, client?: import("../../../../../exports").DynamicClient) => Promise<void>;

package/dist/modules/auth/social/oauth/signInWithSocialRedirect/signInWithSocialRedirect.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signInWithSocialRedirect.d.ts","sourceRoot":"","sources":["../../../../../../src/modules/auth/social/oauth/signInWithSocialRedirect/signInWithSocialRedirect.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAEvF,YAAY,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAEvF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,wBAAwB,8BACR,8BAA8B,2EA4B1D,CAAC"}
+{"version":3,"file":"signInWithSocialRedirect.d.ts","sourceRoot":"","sources":["../../../../../../src/modules/auth/social/oauth/signInWithSocialRedirect/signInWithSocialRedirect.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAEvF,YAAY,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAEvF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,wBAAwB,8BACR,8BAA8B,2EA4B1D,CAAC"}

package/dist/modules/auth/social/oauth/unlinkSocialAccount/unlinkSocialAccount.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unlinkSocialAccount.d.ts","sourceRoot":"","sources":["../../../../../../src/modules/auth/social/oauth/unlinkSocialAccount/unlinkSocialAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,cAAc,EAEpB,MAAM,4BAA4B,CAAC;AASpC,KAAK,yBAAyB,GAAG;IAC/B,oBAAoB,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,mBAAmB,6BACJ,yBAAyB,8DAElD,OAAO,CAAC,cAAc,CAoCxB,CAAC"}
+{"version":3,"file":"unlinkSocialAccount.d.ts","sourceRoot":"","sources":["../../../../../../src/modules/auth/social/oauth/unlinkSocialAccount/unlinkSocialAccount.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,cAAc,EAEpB,MAAM,4BAA4B,CAAC;AASpC,KAAK,yBAAyB,GAAG;IAC/B,oBAAoB,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,mBAAmB,6BACJ,yBAAyB,8DAElD,OAAO,CAAC,cAAc,CAmCxB,CAAC"}

package/dist/modules/captcha/CaptchaProviderEnum/CaptchaProviderEnum.d.ts

@@ -0,0 +1,37 @@
+import { CaptchaProviderEnum as SdkCaptchaProviderEnum } from '@dynamic-labs/sdk-api-core';
+/**
+ * The captcha providers Dynamic can be configured to use.
+ *
+ * Re-declared locally (instead of a bare re-export from `sdk-api-core`) so the
+ * value ships with SDK-level documentation. Branch on the provider returned by
+ * `getCaptchaSettings` to decide which captcha widget to render.
+ *
+ * @example
+ * ```ts
+ * const settings = getCaptchaSettings();
+ * if (settings?.provider === CaptchaProviderEnum.Hcaptcha) {
+ *   renderHcaptcha({ siteKey: settings.siteKey });
+ * }
+ * ```
+ *
+ * @see getCaptchaSettings
+ * @see isCaptchaRequired
+ */
+export declare const CaptchaProviderEnum: typeof SdkCaptchaProviderEnum;
+/**
+ * The captcha providers Dynamic can be configured to use.
+ *
+ * Re-declared locally (instead of a bare re-export from `sdk-api-core`) so the
+ * type ships with SDK-level documentation. Use it to type the provider returned
+ * by `getCaptchaSettings`.
+ *
+ * @example
+ * ```ts
+ * const provider: CaptchaProviderEnum = CaptchaProviderEnum.Hcaptcha;
+ * ```
+ *
+ * @see getCaptchaSettings
+ * @see isCaptchaRequired
+ */
+export type CaptchaProviderEnum = SdkCaptchaProviderEnum;
+//# sourceMappingURL=CaptchaProviderEnum.d.ts.map

package/dist/modules/captcha/CaptchaProviderEnum/CaptchaProviderEnum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CaptchaProviderEnum.d.ts","sourceRoot":"","sources":["../../../../src/modules/captcha/CaptchaProviderEnum/CaptchaProviderEnum.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,IAAI,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAE3F;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,mBAAmB,+BAAyB,CAAC;AAE1D;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,mBAAmB,GAAG,sBAAsB,CAAC"}

package/dist/modules/captcha/getCaptchaSettings/getCaptchaSettings.d.ts

@@ -1,13 +1,49 @@
-import { CaptchaProviderEnum } from '@dynamic-labs/sdk-api-core';
-export type CaptchaSettingsResult = {
-    provider: CaptchaProviderEnum;
-    siteKey: string | undefined;
-};
+import { CaptchaProviderEnum as CaptchaProviderEnumCore } from '@dynamic-labs/sdk-api-core';
+import type { CaptchaSettingsResult } from './getCaptchaSettings.types';
+/**
+ * The captcha providers Dynamic can be configured to use for an environment.
+ * Use it to branch on which captcha widget to render for the active provider.
+ *
+ * Redeclared locally (rather than re-exported directly from the generated
+ * `sdk-api-core`) so the public client entry point owns its own documented,
+ * stable surface for this token.
+ *
+ * @example
+ * ```ts
+ * const settings = getCaptchaSettings();
+ * if (settings?.provider === CaptchaProviderEnum.Hcaptcha) {
+ *   renderHcaptcha(settings.siteKey);
+ * }
+ * ```
+ * @see getCaptchaSettings
+ * @see CaptchaSettingsResult
+ */
+export declare const CaptchaProviderEnum: typeof CaptchaProviderEnumCore;
+/**
+ * The captcha providers Dynamic can be configured to use for an environment.
+ * Use it to type the `provider` returned by {@link getCaptchaSettings}.
+ *
+ * @example
+ * ```ts
+ * const provider: CaptchaProviderEnum = CaptchaProviderEnum.Hcaptcha;
+ * ```
+ * @see getCaptchaSettings
+ * @see CaptchaSettingsResult
+ */
+export type CaptchaProviderEnum = CaptchaProviderEnumCore;
 /**
  * Returns the active captcha provider and site key, or undefined if captcha is not enabled.
  * Use this to determine which captcha widget to render and which site key to pass it.
  *
+ * @example
+ * ```ts
+ * const settings = getCaptchaSettings();
+ * if (settings) renderCaptcha(settings.provider, settings.siteKey);
+ * ```
+ * @see CaptchaSettingsResult
+ * @see CaptchaProviderEnum
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+ * @returns The active captcha provider and site key, or undefined when captcha is not enabled.
  * @notInstrumented
  */
 export declare const getCaptchaSettings: (client?: import("../../../exports").DynamicClient) => CaptchaSettingsResult | undefined;

package/dist/modules/captcha/getCaptchaSettings/getCaptchaSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getCaptchaSettings.d.ts","sourceRoot":"","sources":["../../../../src/modules/captcha/getCaptchaSettings/getCaptchaSettings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAIjE,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,yDAE5B,qBAAqB,GAAG,SA2B1B,CAAC"}
+{"version":3,"file":"getCaptchaSettings.d.ts","sourceRoot":"","sources":["../../../../src/modules/captcha/getCaptchaSettings/getCaptchaSettings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,IAAI,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AAG5F,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAExE;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,mBAAmB,gCAA0B,CAAC;AAE3D;;;;;;;;;;GAUG;AACH,MAAM,MAAM,mBAAmB,GAAG,uBAAuB,CAAC;AAE1D;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,kBAAkB,yDAE5B,qBAAqB,GAAG,SA2B1B,CAAC"}

package/dist/modules/captcha/getCaptchaSettings/getCaptchaSettings.types.d.ts

@@ -0,0 +1,22 @@
+import type { CaptchaProviderEnum } from './getCaptchaSettings';
+/**
+ * The resolved captcha configuration for the current environment: the active
+ * `provider` and the `siteKey` to hand the captcha widget (`undefined` when the
+ * provider has no site key configured).
+ *
+ * Returned by {@link getCaptchaSettings}; `undefined` overall means captcha is
+ * not enabled.
+ *
+ * @example
+ * ```ts
+ * const settings: CaptchaSettingsResult | undefined = getCaptchaSettings();
+ * if (settings) renderCaptcha(settings.provider, settings.siteKey);
+ * ```
+ * @see getCaptchaSettings
+ * @see CaptchaProviderEnum
+ */
+export type CaptchaSettingsResult = {
+    provider: CaptchaProviderEnum;
+    siteKey: string | undefined;
+};
+//# sourceMappingURL=getCaptchaSettings.types.d.ts.map

package/dist/modules/captcha/getCaptchaSettings/getCaptchaSettings.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCaptchaSettings.types.d.ts","sourceRoot":"","sources":["../../../../src/modules/captcha/getCaptchaSettings/getCaptchaSettings.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAEhE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC"}

package/dist/modules/captcha/getCaptchaSettings/index.d.ts

@@ -1,3 +1,3 @@
 export { getCaptchaSettings } from './getCaptchaSettings';
-export type { CaptchaSettingsResult } from './getCaptchaSettings';
+export type { CaptchaSettingsResult } from './getCaptchaSettings.types';
 //# sourceMappingURL=index.d.ts.map

package/dist/modules/captcha/getCaptchaSettings/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/modules/captcha/getCaptchaSettings/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,YAAY,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/modules/captcha/getCaptchaSettings/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,YAAY,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC"}

package/dist/modules/clientEvents/clientEvents.d.ts

@@ -6,10 +6,25 @@ import type { DynamicEvents, EmitEventParams, OffEventParams, OnEventParams, Onc
  * This function allows you to listen for various events emitted by the Dynamic client,
  * such as authentication state changes, wallet connections, and more.
  *
+ * @example
+ * ```ts
+ * const unsubscribe = onEvent({
+ *   event: 'walletAdded',
+ *   listener: ({ walletAccount }) => {
+ *     console.log('Wallet added:', walletAccount.address);
+ *   },
+ * });
+ *
+ * // Later: clean up
+ * unsubscribe();
+ * ```
+ *
  * @param params.event - The event name to listen for.
  * @param params.listener - The callback function to execute when the event is fired.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns A function that can be called to remove the listener.
+ * @see offEvent
+ * @see onceEvent
  * @notInstrumented
  * @hook Event listeners are error-prone to wire up by hand with useEffect.
  */
@@ -20,9 +35,16 @@ export declare const onEvent: <E extends keyof DynamicEvents>({ event, listener
  * This function unsubscribes a previously registered event listener
  * from the specified Dynamic client event.
  *
+ * @example
+ * ```ts
+ * offEvent({ event: 'walletAdded', listener: myListener });
+ * ```
+ *
  * @param params.event - The event name to remove the listener from.
  * @param params.listener - The callback function to remove.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+ * @see onEvent
+ * @see onceEvent
  * @notInstrumented
  */
 export declare const offEvent: <E extends keyof DynamicEvents>({ event, listener }: OffEventParams<E>, client?: DynamicClient) => void;
@@ -32,10 +54,22 @@ export declare const offEvent: <E extends keyof DynamicEvents>({ event, listener
  * This function listens for an event that will automatically remove itself
  * after being triggered once.
  *
+ * @example
+ * ```ts
+ * onceEvent({
+ *   event: 'logout',
+ *   listener: () => {
+ *     console.log('User logged out');
+ *   },
+ * });
+ * ```
+ *
  * @param params.event - The event name to listen for.
  * @param params.listener - The callback function to execute when the event is fired.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns A function that can be called to remove the listener before it fires.
+ * @see onEvent
+ * @see offEvent
  * @notInstrumented
  * @hook Event listeners are error-prone to wire up by hand with useEffect.
  */

package/dist/modules/clientEvents/clientEvents.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"clientEvents.d.ts","sourceRoot":"","sources":["../../../src/modules/clientEvents/clientEvents.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EACf,cAAc,EACd,aAAa,EACb,eAAe,EAChB,MAAM,sBAAsB,CAAC;AAE9B;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,SAAS,MAAM,aAAa,uBAC9B,aAAa,CAAC,CAAC,CAAC,uCAUtC,CAAC;AAEF;;;;;;;;;;GAUG;AAEH,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,MAAM,aAAa,uBAC/B,cAAc,CAAC,CAAC,CAAC,iCAMvC,CAAC;AAEF;;;;;;;;;;;;GAYG;AAEH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,MAAM,aAAa,uBAChC,eAAe,CAAC,CAAC,CAAC,uCAUxC,CAAC;AAEF;;;;;;;;;;GAUG;AAEH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,MAAM,aAAa,mBACpC,eAAe,CAAC,CAAC,CAAC,UAC3B,aAAa,SAKtB,CAAC"}
+{"version":3,"file":"clientEvents.d.ts","sourceRoot":"","sources":["../../../src/modules/clientEvents/clientEvents.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EACf,cAAc,EACd,aAAa,EACb,eAAe,EAChB,MAAM,sBAAsB,CAAC;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,SAAS,MAAM,aAAa,uBAC9B,aAAa,CAAC,CAAC,CAAC,uCAUtC,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AAEH,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,MAAM,aAAa,uBAC/B,cAAc,CAAC,CAAC,CAAC,iCAMvC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,MAAM,aAAa,uBAChC,eAAe,CAAC,CAAC,CAAC,uCAUxC,CAAC;AAEF;;;;;;;;;;GAUG;AAEH,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,MAAM,aAAa,mBACpC,eAAe,CAAC,CAAC,CAAC,UAC3B,aAAa,SAKtB,CAAC"}

package/dist/modules/deviceRegistration/clearDeviceRegistrationRedirectParams/clearDeviceRegistrationRedirectParams.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Removes the device registration redirect parameters that the device
+ * registration email link appends to the return URL from the browser's current
+ * URL, leaving every other query parameter, the path, and the hash untouched.
+ *
+ * Call this once you have finished `completeDeviceRegistration` so a page
+ * refresh doesn't re-trigger the registration flow. Unlike clearing the whole
+ * query string, this preserves any of your own parameters on the callback URL.
+ *
+ * This reads and rewrites `window.location`, so it can only run in the
+ * browser. Calling it during server-side rendering (no `window`) throws
+ * `UnavailableInServerSideError`.
+ *
+ * @returns Nothing. The current URL is rewritten in place via
+ * `window.history.replaceState`.
+ *
+ * @throws {UnavailableInServerSideError} When called without a `window`
+ * (e.g. during server-side rendering).
+ *
+ * @example
+ * ```ts
+ * const deviceToken = getDeviceRegistrationTokenFromUrl({ url: window.location.href });
+ * await completeDeviceRegistration({ deviceToken });
+ * clearDeviceRegistrationRedirectParams();
+ * ```
+ *
+ * @see {@link completeDeviceRegistration} to finish the registration before
+ * clearing the parameters.
+ * @see {@link detectDeviceRegistrationRedirect} to check whether the current
+ * URL is a device registration callback.
+ *
+ * @notInstrumented
+ */
+export declare const clearDeviceRegistrationRedirectParams: () => void;
+//# sourceMappingURL=clearDeviceRegistrationRedirectParams.d.ts.map

package/dist/modules/deviceRegistration/clearDeviceRegistrationRedirectParams/clearDeviceRegistrationRedirectParams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clearDeviceRegistrationRedirectParams.d.ts","sourceRoot":"","sources":["../../../../src/modules/deviceRegistration/clearDeviceRegistrationRedirectParams/clearDeviceRegistrationRedirectParams.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,qCAAqC,QAAO,IAcxD,CAAC"}

package/dist/modules/deviceRegistration/clearDeviceRegistrationRedirectParams/index.d.ts

@@ -0,0 +1,2 @@
+export { clearDeviceRegistrationRedirectParams } from './clearDeviceRegistrationRedirectParams';
+//# sourceMappingURL=index.d.ts.map

package/dist/modules/deviceRegistration/clearDeviceRegistrationRedirectParams/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/modules/deviceRegistration/clearDeviceRegistrationRedirectParams/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qCAAqC,EAAE,MAAM,yCAAyC,CAAC"}

package/dist/modules/deviceRegistration/completeDeviceRegistration/completeDeviceRegistration.d.ts

@@ -2,7 +2,14 @@ import type { VerifyResponse } from '@dynamic-labs/sdk-api-core';
 type CompleteDeviceRegistrationParams = {
     deviceToken: string;
 };
-/** @instrumented */
+/**
+ * Completes device registration using the token from a device registration
+ * redirect, authenticating the current device against the user's account.
+ *
+ * @see detectDeviceRegistrationRedirect
+ * @see clearDeviceRegistrationRedirectParams
+ * @instrumented
+ */
 export declare const completeDeviceRegistration: ({ deviceToken }: CompleteDeviceRegistrationParams, client?: import("../../../exports").DynamicClient) => Promise<VerifyResponse>;
 export {};
 //# sourceMappingURL=completeDeviceRegistration.d.ts.map

package/dist/modules/deviceRegistration/completeDeviceRegistration/completeDeviceRegistration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"completeDeviceRegistration.d.ts","sourceRoot":"","sources":["../../../../src/modules/deviceRegistration/completeDeviceRegistration/completeDeviceRegistration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAYjE,KAAK,gCAAgC,GAAG;IACtC,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,oBAAoB;AACpB,eAAO,MAAM,0BAA0B,oBACpB,gCAAgC,wDAEhD,OAAO,CAAC,cAAc,CAmCxB,CAAC"}
+{"version":3,"file":"completeDeviceRegistration.d.ts","sourceRoot":"","sources":["../../../../src/modules/deviceRegistration/completeDeviceRegistration/completeDeviceRegistration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAYjE,KAAK,gCAAgC,GAAG;IACtC,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B,oBACpB,gCAAgC,wDAEhD,OAAO,CAAC,cAAc,CAmCxB,CAAC"}

package/dist/modules/flow/cancelFlow/cancelFlow.d.ts

@@ -3,11 +3,18 @@ export type CancelFlowParams = {
     flowId: string;
 };
 /**
- * Cancels a flow before it has been broadcasted
+ * Cancels a flow before it has been broadcasted.
  *
- * @param params CancelFlowParams - The flow to cancel.
+ * @example
+ * ```ts
+ * const cancelledFlow = await cancelFlow({ flowId: 'flow-abc123' });
+ * ```
+ *
+ * @param params.flowId - The unique identifier of the flow to cancel.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
- * @returns The cancelled flow
+ * @returns A promise that resolves to the cancelled flow.
+ * @see getFlow
+ * @see getFlowQuote
  * @instrumented
  */
 export declare const cancelFlow: ({ flowId }: CancelFlowParams, client?: import("../../../exports").DynamicClient) => Promise<Flow>;

package/dist/modules/flow/cancelFlow/cancelFlow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cancelFlow.d.ts","sourceRoot":"","sources":["../../../../src/modules/flow/cancelFlow/cancelFlow.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAK1C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,eACT,gBAAgB,wDAE3B,OAAO,CAAC,IAAI,CAsBd,CAAC"}
+{"version":3,"file":"cancelFlow.d.ts","sourceRoot":"","sources":["../../../../src/modules/flow/cancelFlow/cancelFlow.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAK1C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU,eACT,gBAAgB,wDAE3B,OAAO,CAAC,IAAI,CAsBd,CAAC"}

package/dist/modules/flow/getFlow/getFlow.d.ts

@@ -4,11 +4,19 @@ export type GetFlowParams = {
     flowId: string;
 };
 /**
- * Fetches a flow by its ID
+ * Fetches a flow by its ID.
  *
- * @param params GetFlowParams - The parameters for fetching the flow.
+ * @example
+ * ```ts
+ * const flow = await getFlow({ flowId: 'flow-abc123' });
+ * console.log('Flow status:', flow.status);
+ * ```
+ *
+ * @param params.flowId - The unique identifier of the flow to fetch.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
- * @returns The flow
+ * @returns A promise that resolves to the flow object.
+ * @see cancelFlow
+ * @see getFlowQuote
  * @notInstrumented
  */
 export declare const getFlow: ({ flowId }: GetFlowParams, client?: DynamicClient) => Promise<Flow>;

package/dist/modules/flow/getFlow/getFlow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getFlow.d.ts","sourceRoot":"","sources":["../../../../src/modules/flow/getFlow/getFlow.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAE1C,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO,eACN,aAAa,WACjB,aAAa,KACpB,OAAO,CAAC,IAAI,CAQd,CAAC"}
+{"version":3,"file":"getFlow.d.ts","sourceRoot":"","sources":["../../../../src/modules/flow/getFlow/getFlow.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAE1C,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,OAAO,eACN,aAAa,WACjB,aAAa,KACpB,OAAO,CAAC,IAAI,CAQd,CAAC"}

package/dist/modules/flow/getFlowQuote/getFlowQuote.d.ts

@@ -17,11 +17,24 @@ export type GetFlowQuoteParams = {
     slippage?: number;
 };
 /**
- * Fetches a quote for a flow
+ * Fetches a quote for a flow.
  *
- * @param params GetFlowQuoteParams - The quote parameters.
+ * @example
+ * ```ts
+ * const flow = await getFlowQuote({
+ *   flowId: 'flow-abc123',
+ *   slippage: 0.5,
+ * });
+ * ```
+ *
+ * @param params.flowId - The unique identifier of the flow.
+ * @param [params.fromChainId] - Optional chain ID overriding the one set at attachFlowSource time.
+ * @param [params.fromTokenAddress] - Optional token address (defaults to native token).
+ * @param [params.slippage] - Acceptable slippage percentage.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
- * @returns The updated flow with quote data
+ * @returns A promise that resolves to the updated flow with quote data.
+ * @see getFlow
+ * @see cancelFlow
  * @notInstrumented
  */
 export declare const getFlowQuote: ({ flowId, fromChainId, fromTokenAddress, slippage }: GetFlowQuoteParams, client?: import("../../../exports").DynamicClient) => Promise<Flow>;

package/dist/modules/flow/getFlowQuote/getFlowQuote.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getFlowQuote.d.ts","sourceRoot":"","sources":["../../../../src/modules/flow/getFlowQuote/getFlowQuote.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAI1C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,wDAC8B,kBAAkB,wDAEtE,OAAO,CAAC,IAAI,CAuBd,CAAC"}
+{"version":3,"file":"getFlowQuote.d.ts","sourceRoot":"","sources":["../../../../src/modules/flow/getFlowQuote/getFlowQuote.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAI1C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,YAAY,wDAC8B,kBAAkB,wDAEtE,OAAO,CAAC,IAAI,CAuBd,CAAC"}

package/dist/modules/initializeClient/initializeClient.d.ts

@@ -7,9 +7,25 @@
  *
  * You only need to call this function if you are not using `autoInitialize: true` in createDynamicClient.
  *
+ * @example
+ * ```ts
+ * const client = createDynamicClient({
+ *   environmentId: 'env-id',
+ *   autoInitialize: false,
+ * });
+ *
+ * try {
+ *   await initializeClient(client);
+ * } catch (error) {
+ *   console.error('Failed to initialize:', error);
+ * }
+ * ```
+ *
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns A promise that resolves when initialization is complete.
  * @throws ClientAlreadyInitializedError If the client is already initialized.
+ * @see createDynamicClient
+ * @see waitForClientInitialized
  * @instrumented
  * @noHook Client lifecycle management is not exposed as a React hook.
  */

package/dist/modules/initializeClient/initializeClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"initializeClient.d.ts","sourceRoot":"","sources":["../../../src/modules/initializeClient/initializeClient.ts"],"names":[],"mappings":"AAwBA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,mEAqK5B,CAAC"}
+{"version":3,"file":"initializeClient.d.ts","sourceRoot":"","sources":["../../../src/modules/initializeClient/initializeClient.ts"],"names":[],"mappings":"AAwBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,gBAAgB,mEAqK5B,CAAC"}

package/dist/modules/initializeClient/waitForClientInitialized/waitForClientInitialized.d.ts

@@ -2,8 +2,18 @@
  * Allows waiting until all modules of the client have been properly initialized
  * and are ready for use.
  *
- * @returns a promise that resolves once the client is fully initialized.
-  * @notInstrumented
+ * @example
+ * ```ts
+ * const client = createDynamicClient({ environmentId: 'env-id' });
+ * await waitForClientInitialized(client);
+ * // Client is now fully ready
+ * ```
+ *
+ * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+ * @returns A promise that resolves once the client is fully initialized.
+ * @see initializeClient
+ * @see createDynamicClient
+ * @notInstrumented
  * @noHook Client lifecycle management is not exposed as a hook; use useInitStatus.
  */
 export declare const waitForClientInitialized: (client?: import("../../../exports").DynamicClient) => Promise<void>;

package/dist/modules/initializeClient/waitForClientInitialized/waitForClientInitialized.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"waitForClientInitialized.d.ts","sourceRoot":"","sources":["../../../../src/modules/initializeClient/waitForClientInitialized/waitForClientInitialized.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,sEAIpC,CAAC"}
+{"version":3,"file":"waitForClientInitialized.d.ts","sourceRoot":"","sources":["../../../../src/modules/initializeClient/waitForClientInitialized/waitForClientInitialized.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,wBAAwB,sEAIpC,CAAC"}

package/dist/modules/otp/sendEmailOTP/sendEmailOTP.d.ts

@@ -7,9 +7,23 @@ export type SendEmailOTPParams = {
  *
  * Once you have the OTP code, you should then use `verifyOTP` to verify it and complete the authentication process.
  *
+ * @example
+ * ```ts
+ * const { verificationUUID } = await sendEmailOTP({
+ *   email: 'user@example.com',
+ * });
+ * // Then verify with the code the user received
+ * await verifyOTP({
+ *   otpVerification: { email: 'user@example.com', verificationUUID },
+ *   verificationToken: '123456',
+ * });
+ * ```
+ *
  * @param params.email - The email address to send the OTP to.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns A promise that resolves to an OTPVerification object containing the email and verification UUID.
+ * @see verifyOTP
+ * @see sendSmsOTP
  * @instrumented
  */
 export declare const sendEmailOTP: ({ email }: SendEmailOTPParams, client?: import("../../../exports").DynamicClient) => Promise<OTPVerification>;

package/dist/modules/otp/sendEmailOTP/sendEmailOTP.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sendEmailOTP.d.ts","sourceRoot":"","sources":["../../../../src/modules/otp/sendEmailOTP/sendEmailOTP.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,YAAY,cACZ,kBAAkB,wDAE5B,OAAO,CAAC,eAAe,CAgBzB,CAAC"}
+{"version":3,"file":"sendEmailOTP.d.ts","sourceRoot":"","sources":["../../../../src/modules/otp/sendEmailOTP/sendEmailOTP.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,YAAY,cACZ,kBAAkB,wDAE5B,OAAO,CAAC,eAAe,CAgBzB,CAAC"}

package/dist/modules/otp/sendSmsOTP/sendSmsOTP.d.ts

@@ -7,10 +7,22 @@ export type SendSmsOTPParams = {
 /**
  * Sends a one-time password (OTP) via SMS to the specified phone number.
  *
+ * @example
+ * ```ts
+ * const { verificationUUID } = await sendSmsOTP({
+ *   isoCountryCode: 'US',
+ *   phoneNumber: '5551234567',
+ * });
+ * // Then verify with the code the user received
+ * await verifyOTP({ otpVerification: { phoneNumber: '5551234567', verificationUUID }, verificationToken: '123456' });
+ * ```
+ *
  * @param params.isoCountryCode - The ISO country code for the phone number (e.g., 'US', 'CA', 'GB').
  * @param params.phoneNumber - The phone number to send the OTP to.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns A promise that resolves to an OTPVerification object containing the phone details and verification UUID.
+ * @see verifyOTP
+ * @see sendEmailOTP
  * @instrumented
  */
 export declare const sendSmsOTP: ({ isoCountryCode, phoneNumber }: SendSmsOTPParams, client?: import("../../../exports").DynamicClient) => Promise<OTPVerification>;

package/dist/modules/otp/sendSmsOTP/sendSmsOTP.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sendSmsOTP.d.ts","sourceRoot":"","sources":["../../../../src/modules/otp/sendSmsOTP/sendSmsOTP.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAGxD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,cAAc,EAAE,WAAW,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,oCACY,gBAAgB,wDAEhD,OAAO,CAAC,eAAe,CAoBzB,CAAC"}
+{"version":3,"file":"sendSmsOTP.d.ts","sourceRoot":"","sources":["../../../../src/modules/otp/sendSmsOTP/sendSmsOTP.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAGxD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,cAAc,EAAE,WAAW,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,UAAU,oCACY,gBAAgB,wDAEhD,OAAO,CAAC,eAAe,CAoBzB,CAAC"}

package/dist/modules/otp/verifyOTP/verifyOTP.d.ts

@@ -1,6 +1,25 @@
 import type { TokenScope, VerifyResponse } from '@dynamic-labs/sdk-api-core';
 import type { OTPVerification } from '../otp.types';
+/**
+ * Parameters for verifying an OTP during sign-in or an authenticated user update.
+ *
+ * @example
+ * ```ts
+ * const params: VerifyOTPParams = {
+ *   otpVerification,
+ *   verificationToken: '123456',
+ * };
+ * ```
+ * @see verifyOTP
+ * @see sendEmailOTP
+ */
 export type VerifyOTPParams = {
+    /**
+     * When true on a sign-in request, the server returns an elevated access
+     * token with credential:link scope if MFA is optional and the user has
+     * no MFA methods registered. Ignored on post-login verify requests.
+     */
+    allowNewMFALinking?: boolean;
     otpVerification: OTPVerification;
     requestedScopes?: TokenScope[];
     verificationToken: string;
@@ -11,11 +30,24 @@ export type VerifyOTPParams = {
  * This function validates the OTP code provided by the user and completes
  * the verification process for either sign-in or account updates.
  *
+ * @example
+ * ```ts
+ * const { verificationUUID } = await sendEmailOTP({ email: 'user@example.com' });
+ * const response = await verifyOTP({
+ *   otpVerification: { email: 'user@example.com', verificationUUID },
+ *   verificationToken: '123456',
+ * });
+ * ```
+ *
+ * @param [params.allowNewMFALinking] - Whether sign-in may return a credential-link elevated token for users without MFA.
  * @param params.otpVerification - The OTP verification object containing verification details.
  * @param params.verificationToken - The token received from the OTP verification process.
+ * @param [params.requestedScopes] - Optional token scopes to request during verification.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns A promise that resolves to the verify response object upon successful verification.
+ * @see sendEmailOTP
+ * @see sendSmsOTP
  * @instrumented
  */
-export declare const verifyOTP: ({ otpVerification, verificationToken, requestedScopes }: VerifyOTPParams, client?: import("../../../exports").DynamicClient) => Promise<VerifyResponse>;
+export declare const verifyOTP: ({ allowNewMFALinking, otpVerification, requestedScopes, verificationToken, }: VerifyOTPParams, client?: import("../../../exports").DynamicClient) => Promise<VerifyResponse>;
 //# sourceMappingURL=verifyOTP.d.ts.map