wallee/dist/models/TransactionVoid.d.ts

TypeScript/JavaScript client for wallee

import type { TransactionVoidMode } from './TransactionVoidMode';
import type { Transaction } from './Transaction';
import type { TransactionVoidState } from './TransactionVoidState';
import type { FailureReason } from './FailureReason';
import type { Label } from './Label';
/**
 *
 * @export
 * @interface TransactionVoid
 */
export interface TransactionVoid {
    /**
     * 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 TransactionVoid
     */
    readonly plannedPurgeDate?: Date;
    /**
     * The language that is linked to the object.
     * @type {string}
     * @memberof TransactionVoid
     */
    readonly language?: string;
    /**
     * The ID of the space view this object is linked to.
     * @type {number}
     * @memberof TransactionVoid
     */
    readonly spaceViewId?: number;
    /**
     * The date and time when the object was created.
     * @type {Date}
     * @memberof TransactionVoid
     */
    readonly createdOn?: Date;
    /**
     * The version is used for optimistic locking and incremented whenever the object is updated.
     * @type {number}
     * @memberof TransactionVoid
     */
    readonly version?: number;
    /**
     * The labels providing additional information about the object.
     * @type {Set<Label>}
     * @memberof TransactionVoid
     */
    readonly labels?: Set<Label>;
    /**
     *
     * @type {TransactionVoidMode}
     * @memberof TransactionVoid
     */
    mode?: TransactionVoidMode;
    /**
     * The ID of the space this object belongs to.
     * @type {number}
     * @memberof TransactionVoid
     */
    readonly linkedSpaceId?: number;
    /**
     * The date and time when the object will expire.
     * @type {Date}
     * @memberof TransactionVoid
     */
    readonly timeoutOn?: Date;
    /**
     * The ID of the user the transaction void was created by.
     * @type {number}
     * @memberof TransactionVoid
     */
    readonly createdBy?: number;
    /**
     * The date and time when the next update of the object's state is planned.
     * @type {Date}
     * @memberof TransactionVoid
     */
    readonly nextUpdateOn?: Date;
    /**
     *
     * @type {FailureReason}
     * @memberof TransactionVoid
     */
    failureReason?: FailureReason;
    /**
     * The date and time when the transaction void succeeded.
     * @type {Date}
     * @memberof TransactionVoid
     */
    readonly succeededOn?: Date;
    /**
     * A unique identifier for the object.
     * @type {number}
     * @memberof TransactionVoid
     */
    readonly id?: number;
    /**
     *
     * @type {TransactionVoidState}
     * @memberof TransactionVoid
     */
    state?: TransactionVoidState;
    /**
     * The payment transaction this object is linked to.
     * @type {number}
     * @memberof TransactionVoid
     */
    readonly linkedTransaction?: number;
    /**
     * The date and time when the transaction void failed.
     * @type {Date}
     * @memberof TransactionVoid
     */
    readonly failedOn?: Date;
    /**
     *
     * @type {Transaction}
     * @memberof TransactionVoid
     */
    transaction?: Transaction;
    /**
     * The reference ID provided by the payment processor, used to trace the void through the external payment system.
     * @type {string}
     * @memberof TransactionVoid
     */
    readonly processorReference?: string;
}
/**
 * Check if a given object implements the TransactionVoid interface.
 */
export declare function instanceOfTransactionVoid(value: object): value is TransactionVoid;
export declare function TransactionVoidFromJSON(json: any): TransactionVoid;
export declare function TransactionVoidFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionVoid;
export declare function TransactionVoidToJSON(json: any): TransactionVoid;
export declare function TransactionVoidToJSONTyped(value?: Omit<TransactionVoid, 'plannedPurgeDate' | 'language' | 'spaceViewId' | 'createdOn' | 'version' | 'labels' | 'linkedSpaceId' | 'timeoutOn' | 'createdBy' | 'nextUpdateOn' | 'succeededOn' | 'id' | 'linkedTransaction' | 'failedOn' | 'processorReference'> | null, ignoreDiscriminator?: boolean): any;