@getopenpay/client/models/PaymentRouteExternal.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 { PaymentRouteType } from './PaymentRouteType';
import type { GeneralPaymentRouteArgsOutput } from './GeneralPaymentRouteArgsOutput';
import type { ObjectName } from './ObjectName';
/**
 *
 * @export
 * @interface PaymentRouteExternal
 */
export interface PaymentRouteExternal {
    /**
     * Unique Identifier of the account.
     * @type {string}
     * @memberof PaymentRouteExternal
     */
    accountId: string;
    /**
     * DateTime at which the object was created, in 'ISO 8601' format.
     * @type {Date}
     * @memberof PaymentRouteExternal
     */
    createdAt: Date;
    /**
     *
     * @type {GeneralPaymentRouteArgsOutput}
     * @memberof PaymentRouteExternal
     */
    generalPaymentRouteArgs?: GeneralPaymentRouteArgsOutput | null;
    /**
     * Unique Identifier of the payment route.
     * @type {string}
     * @memberof PaymentRouteExternal
     */
    id: string;
    /**
     * If true, indicates that this object has been deleted
     * @type {boolean}
     * @memberof PaymentRouteExternal
     */
    isDeleted?: boolean;
    /**
     * The name of the payment route.
     * @type {string}
     * @memberof PaymentRouteExternal
     */
    name: string;
    /**
     *
     * @type {ObjectName}
     * @memberof PaymentRouteExternal
     */
    object?: ObjectName;
    /**
     * The configuration object for the payment route.
     * @type {object}
     * @memberof PaymentRouteExternal
     */
    routeConfig: object;
    /**
     * The type of payment route.
     * @type {PaymentRouteType}
     * @memberof PaymentRouteExternal
     */
    routeType: PaymentRouteType;
    /**
     * DateTime at which the object was updated, in 'ISO 8601' format.
     * @type {Date}
     * @memberof PaymentRouteExternal
     */
    updatedAt: Date;
}
/**
 * Check if a given object implements the PaymentRouteExternal interface.
 */
export declare function instanceOfPaymentRouteExternal(value: object): value is PaymentRouteExternal;
export declare function PaymentRouteExternalFromJSON(json: any): PaymentRouteExternal;
export declare function PaymentRouteExternalFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaymentRouteExternal;
export declare function PaymentRouteExternalToJSON(json: any): PaymentRouteExternal;
export declare function PaymentRouteExternalToJSONTyped(value?: PaymentRouteExternal | null, ignoreDiscriminator?: boolean): any;