@getopenpay/client/models/PortalSessionExternal.d.ts

OpenPay API TypeScript SDK

/**
 * OpenPay API
 * super charge your subscription management.
 *
 * The version of the OpenAPI document: 1.2.1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { ObjectName } from './ObjectName';
/**
 *
 * @export
 * @interface PortalSessionExternal
 */
export interface PortalSessionExternal {
    /**
     * Unique identifier for the account.
     * @type {string}
     * @memberof PortalSessionExternal
     */
    accountId: string;
    /**
     * DateTime at which the object was created, in 'ISO 8601' format.
     * @type {Date}
     * @memberof PortalSessionExternal
     */
    createdAt: Date;
    /**
     * The ID of an existing customer.
     * @type {string}
     * @memberof PortalSessionExternal
     */
    customerId: string;
    /**
     * The ID of the portal session.
     * @type {string}
     * @memberof PortalSessionExternal
     */
    id: string;
    /**
     * If true, indicates that this object has been deleted
     * @type {boolean}
     * @memberof PortalSessionExternal
     */
    isDeleted?: boolean;
    /**
     *
     * @type {ObjectName}
     * @memberof PortalSessionExternal
     */
    object?: ObjectName;
    /**
     * The default URL to redirect customers to when they click on the portal"s link to return to your website.
     * @type {string}
     * @memberof PortalSessionExternal
     */
    returnUrl: string;
    /**
     * The short-lived token of the session that gives customers access to the customer portal.
     * @type {string}
     * @memberof PortalSessionExternal
     */
    token: string;
    /**
     * DateTime at which the object was updated, in 'ISO 8601' format.
     * @type {Date}
     * @memberof PortalSessionExternal
     */
    updatedAt: Date;
    /**
     * The short-lived URL of the session that gives customers access to the customer portal.
     * @type {string}
     * @memberof PortalSessionExternal
     */
    url: string;
}
/**
 * Check if a given object implements the PortalSessionExternal interface.
 */
export declare function instanceOfPortalSessionExternal(value: object): value is PortalSessionExternal;
export declare function PortalSessionExternalFromJSON(json: any): PortalSessionExternal;
export declare function PortalSessionExternalFromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalSessionExternal;
export declare function PortalSessionExternalToJSON(json: any): PortalSessionExternal;
export declare function PortalSessionExternalToJSONTyped(value?: PortalSessionExternal | null, ignoreDiscriminator?: boolean): any;