wallee/dist/models/Token.d.ts

TypeScript/JavaScript client for wallee

import type { CreationEntityState } from './CreationEntityState';
/**
 *
 * @export
 * @interface Token
 */
export interface Token {
    /**
     * Whether the token is enabled for one-click payments, which simplify the payment process for the customer. One-click tokens are linked to customers via the customer ID.
     * @type {boolean}
     * @memberof Token
     */
    readonly enabledForOneClickPayment?: boolean;
    /**
     * The customer's email address.
     * @type {string}
     * @memberof Token
     */
    readonly customerEmailAddress?: string;
    /**
     * The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
     * @type {Date}
     * @memberof Token
     */
    readonly plannedPurgeDate?: Date;
    /**
     * A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
     * @type {string}
     * @memberof Token
     */
    readonly externalId?: string;
    /**
     * The customer's time zone, which affects how dates and times are formatted when communicating with the customer.
     * @type {string}
     * @memberof Token
     */
    readonly timeZone?: string;
    /**
     * The language that is linked to the object.
     * @type {string}
     * @memberof Token
     */
    readonly language?: string;
    /**
     * The date and time when the object was created.
     * @type {Date}
     * @memberof Token
     */
    readonly createdOn?: Date;
    /**
     * The version is used for optimistic locking and incremented whenever the object is updated.
     * @type {number}
     * @memberof Token
     */
    readonly version?: number;
    /**
     * The ID of the space this object belongs to.
     * @type {number}
     * @memberof Token
     */
    readonly linkedSpaceId?: number;
    /**
     * The reference used to identify the payment token (e.g. the customer's ID or email address).
     * @type {string}
     * @memberof Token
     */
    readonly tokenReference?: string;
    /**
     * The unique identifier of the customer in the external system.
     * @type {string}
     * @memberof Token
     */
    readonly customerId?: string;
    /**
     * A unique identifier for the object.
     * @type {number}
     * @memberof Token
     */
    readonly id?: number;
    /**
     *
     * @type {CreationEntityState}
     * @memberof Token
     */
    state?: CreationEntityState;
}
/**
 * Check if a given object implements the Token interface.
 */
export declare function instanceOfToken(value: object): value is Token;
export declare function TokenFromJSON(json: any): Token;
export declare function TokenFromJSONTyped(json: any, ignoreDiscriminator: boolean): Token;
export declare function TokenToJSON(json: any): Token;
export declare function TokenToJSONTyped(value?: Omit<Token, 'enabledForOneClickPayment' | 'customerEmailAddress' | 'plannedPurgeDate' | 'externalId' | 'timeZone' | 'language' | 'createdOn' | 'version' | 'linkedSpaceId' | 'tokenReference' | 'customerId' | 'id'> | null, ignoreDiscriminator?: boolean): any;