RedeemTicketMembers

Interface describing the data available on the Redeem Ticket screen.

Example

export interface RedeemTicketMembers extends BaseMembers {
  client: ClientMembers;
  organization: OrganizationMembers;
  prompt: PromptMembers;
  screen: ScreenMembers;
  transaction: TransactionMembers;

  /**
   * Performs the default action on the redeem-ticket screen, which usually involves continuing the flow.
   * @param {CustomOptions} [payload] - Optional custom options to include with the request.
   * @returns {Promise<void>} A promise that resolves when the action is complete.
   * @throws {Error} If the operation fails.
   * @example
   * ```typescript
   * import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket';
   *
   * const redeemTicket = new RedeemTicket();
   * await redeemTicket.continue();
   * ```
   */
  continue(payload?: CustomOptions): Promise<void>;
}

Properties

branding · BrandingMembers

client · ClientMembers

organization · OrganizationMembers

prompt · PromptMembers

screen · ScreenMembers

tenant · TenantMembers

transaction · TransactionMembers

untrustedData · UntrustedDataMembers

user · UserMembers

Methods

continue · Promise<void>

Performs the default action on the redeem-ticket screen, which usually involves continuing the flow.

A promise that resolves when the action is complete.

Throws

If the operation fails.

Example

import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket';

const redeemTicket = new RedeemTicket();
await redeemTicket.continue();

Show Parameters

payload? · CustomOptions

Optional custom options to include with the request.