wallee/dist/models/TransactionLineItemVersion.d.ts

TypeScript/JavaScript client for wallee

import type { Transaction } from './Transaction';
import type { FailureReason } from './FailureReason';
import type { Label } from './Label';
import type { TransactionLineItemVersionState } from './TransactionLineItemVersionState';
import type { LineItem } from './LineItem';
/**
 *
 * @export
 * @interface TransactionLineItemVersion
 */
export interface TransactionLineItemVersion {
    /**
     * The total amount of the updated line items, including taxes.
     * @type {number}
     * @memberof TransactionLineItemVersion
     */
    readonly amount?: number;
    /**
     * 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 TransactionLineItemVersion
     */
    readonly plannedPurgeDate?: Date;
    /**
     * The date and time when the processing of the line item version was started.
     * @type {Date}
     * @memberof TransactionLineItemVersion
     */
    readonly processingOn?: 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 TransactionLineItemVersion
     */
    readonly externalId?: string;
    /**
     * The language that is linked to the object.
     * @type {string}
     * @memberof TransactionLineItemVersion
     */
    readonly language?: string;
    /**
     * The ID of the space view this object is linked to.
     * @type {number}
     * @memberof TransactionLineItemVersion
     */
    readonly spaceViewId?: number;
    /**
     * The date and time when the object was created.
     * @type {Date}
     * @memberof TransactionLineItemVersion
     */
    readonly createdOn?: Date;
    /**
     * The version is used for optimistic locking and incremented whenever the object is updated.
     * @type {number}
     * @memberof TransactionLineItemVersion
     */
    readonly version?: number;
    /**
     * The labels providing additional information about the object.
     * @type {Set<Label>}
     * @memberof TransactionLineItemVersion
     */
    readonly labels?: Set<Label>;
    /**
     * The line items that replace the original line items in the transaction.
     * @type {Array<LineItem>}
     * @memberof TransactionLineItemVersion
     */
    readonly lineItems?: Array<LineItem>;
    /**
     * The ID of the space this object belongs to.
     * @type {number}
     * @memberof TransactionLineItemVersion
     */
    readonly linkedSpaceId?: number;
    /**
     * The date and time by when the line item version is expected to be processed.
     * @type {Date}
     * @memberof TransactionLineItemVersion
     */
    readonly timeoutOn?: Date;
    /**
     * The ID of the user the line item version was created by.
     * @type {number}
     * @memberof TransactionLineItemVersion
     */
    readonly createdBy?: number;
    /**
     * The date and time when the next update of the line item version's state is planned.
     * @type {Date}
     * @memberof TransactionLineItemVersion
     */
    readonly nextUpdateOn?: Date;
    /**
     *
     * @type {FailureReason}
     * @memberof TransactionLineItemVersion
     */
    failureReason?: FailureReason;
    /**
     * The date and time when the line item version was processed successfully.
     * @type {Date}
     * @memberof TransactionLineItemVersion
     */
    readonly succeededOn?: Date;
    /**
     * A unique identifier for the object.
     * @type {number}
     * @memberof TransactionLineItemVersion
     */
    readonly id?: number;
    /**
     *
     * @type {TransactionLineItemVersionState}
     * @memberof TransactionLineItemVersion
     */
    state?: TransactionLineItemVersionState;
    /**
     * The payment transaction this object is linked to.
     * @type {number}
     * @memberof TransactionLineItemVersion
     */
    readonly linkedTransaction?: number;
    /**
     * The portion of the total amount that corresponds to taxes.
     * @type {number}
     * @memberof TransactionLineItemVersion
     */
    readonly taxAmount?: number;
    /**
     * The date and time when the processing of the line item version failed.
     * @type {Date}
     * @memberof TransactionLineItemVersion
     */
    readonly failedOn?: Date;
    /**
     *
     * @type {Transaction}
     * @memberof TransactionLineItemVersion
     */
    transaction?: Transaction;
}
/**
 * Check if a given object implements the TransactionLineItemVersion interface.
 */
export declare function instanceOfTransactionLineItemVersion(value: object): value is TransactionLineItemVersion;
export declare function TransactionLineItemVersionFromJSON(json: any): TransactionLineItemVersion;
export declare function TransactionLineItemVersionFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionLineItemVersion;
export declare function TransactionLineItemVersionToJSON(json: any): TransactionLineItemVersion;
export declare function TransactionLineItemVersionToJSONTyped(value?: Omit<TransactionLineItemVersion, 'amount' | 'plannedPurgeDate' | 'processingOn' | 'externalId' | 'language' | 'spaceViewId' | 'createdOn' | 'version' | 'labels' | 'lineItems' | 'linkedSpaceId' | 'timeoutOn' | 'createdBy' | 'nextUpdateOn' | 'succeededOn' | 'id' | 'linkedTransaction' | 'taxAmount' | 'failedOn'> | null, ignoreDiscriminator?: boolean): any;