@basetime/a2w-api-ts/dist/types/ScannerInvite.d.ts

Client library that communicates with the addtowallet API.

/**
 * A scanner invite is a jwt that is used to authenticate with a scanner.
 */
export interface ScannerInvite {
    /**
     * The ID of the scanner invite.
     */
    id: string;
    /**
     * The organization the scanner invite belongs to.
     */
    organization: string;
    /**
     * The invite code.
     */
    secret: string;
    /**
     * The security code used to verify the scanner.
     */
    verificationCode: string;
    /**
     * Has the invite been claimed?
     */
    isClaimed: boolean;
    /**
     * The base url for the api.
     */
    baseUrl: string;
    /**
     * The pin number used to verify the scanner.
     */
    pin: string;
    /**
     * The brand color.
     */
    brandColor: string;
    /**
     * The brand logo url.
     */
    brandLogoUrl: string;
    /**
     * Whether or not to show the scanner button.
     */
    hideScanButton: boolean;
    /**
     * The webview jwt.
     */
    webviewJwt: string;
    /**
     * The scan webview url.
     */
    webviewUrl: string;
    /**
     * The standby webview url.
     */
    standbyUrl: string;
    /**
     * The date the invite was created.
     */
    createdDate: Date;
}