wallee/dist/models/Charge.d.ts

TypeScript/JavaScript client for wallee

import type { Transaction } from './Transaction';
import type { ChargeType } from './ChargeType';
import type { FailureReason } from './FailureReason';
import type { ChargeState } from './ChargeState';
/**
 *
 * @export
 * @interface Charge
 */
export interface Charge {
    /**
     * 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 Charge
     */
    readonly plannedPurgeDate?: Date;
    /**
     * The time zone that this object is associated with.
     * @type {string}
     * @memberof Charge
     */
    readonly timeZone?: string;
    /**
     * The language that is linked to the object.
     * @type {string}
     * @memberof Charge
     */
    readonly language?: string;
    /**
     * The ID of the space view this object is linked to.
     * @type {number}
     * @memberof Charge
     */
    readonly spaceViewId?: number;
    /**
     *
     * @type {ChargeType}
     * @memberof Charge
     */
    type?: ChargeType;
    /**
     * The message that can be displayed to the customer explaining why the charge failed, in the customer's language.
     * @type {string}
     * @memberof Charge
     */
    readonly userFailureMessage?: string;
    /**
     * The date and time when the object was created.
     * @type {Date}
     * @memberof Charge
     */
    readonly createdOn?: Date;
    /**
     * The version is used for optimistic locking and incremented whenever the object is updated.
     * @type {number}
     * @memberof Charge
     */
    readonly version?: number;
    /**
     * The ID of the space this object belongs to.
     * @type {number}
     * @memberof Charge
     */
    readonly linkedSpaceId?: number;
    /**
     * The date and time when the charge will expire.
     * @type {Date}
     * @memberof Charge
     */
    readonly timeoutOn?: Date;
    /**
     *
     * @type {FailureReason}
     * @memberof Charge
     */
    failureReason?: FailureReason;
    /**
     * A unique identifier for the object.
     * @type {number}
     * @memberof Charge
     */
    readonly id?: number;
    /**
     *
     * @type {ChargeState}
     * @memberof Charge
     */
    state?: ChargeState;
    /**
     *
     * @type {Transaction}
     * @memberof Charge
     */
    transaction?: Transaction;
}
/**
 * Check if a given object implements the Charge interface.
 */
export declare function instanceOfCharge(value: object): value is Charge;
export declare function ChargeFromJSON(json: any): Charge;
export declare function ChargeFromJSONTyped(json: any, ignoreDiscriminator: boolean): Charge;
export declare function ChargeToJSON(json: any): Charge;
export declare function ChargeToJSONTyped(value?: Omit<Charge, 'plannedPurgeDate' | 'timeZone' | 'language' | 'spaceViewId' | 'userFailureMessage' | 'createdOn' | 'version' | 'linkedSpaceId' | 'timeoutOn' | 'id'> | null, ignoreDiscriminator?: boolean): any;