wallee/dist/models/ChargeFlow.d.ts

TypeScript/JavaScript client for wallee

import type { Condition } from './Condition';
import type { CreationEntityState } from './CreationEntityState';
/**
 *
 * @export
 * @interface ChargeFlow
 */
export interface ChargeFlow {
    /**
     * The ID of the space this object belongs to.
     * @type {number}
     * @memberof ChargeFlow
     */
    readonly linkedSpaceId?: number;
    /**
     * The name used to identify the charge flow.
     * @type {string}
     * @memberof ChargeFlow
     */
    readonly name?: string;
    /**
     * 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 ChargeFlow
     */
    readonly plannedPurgeDate?: Date;
    /**
     * A unique identifier for the object.
     * @type {number}
     * @memberof ChargeFlow
     */
    readonly id?: number;
    /**
     *
     * @type {CreationEntityState}
     * @memberof ChargeFlow
     */
    state?: CreationEntityState;
    /**
     * Conditions allow to define criteria that a transaction must fulfill in order for the charge flow to be considered for processing the payment.
     * @type {Array<Condition>}
     * @memberof ChargeFlow
     */
    readonly conditions?: Array<Condition>;
    /**
     * The priority that determines the order in which charge flows are taken into account when processing a payment. Low values are considered first.
     * @type {number}
     * @memberof ChargeFlow
     */
    readonly priority?: number;
    /**
     * The version is used for optimistic locking and incremented whenever the object is updated.
     * @type {number}
     * @memberof ChargeFlow
     */
    readonly version?: number;
}
/**
 * Check if a given object implements the ChargeFlow interface.
 */
export declare function instanceOfChargeFlow(value: object): value is ChargeFlow;
export declare function ChargeFlowFromJSON(json: any): ChargeFlow;
export declare function ChargeFlowFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChargeFlow;
export declare function ChargeFlowToJSON(json: any): ChargeFlow;
export declare function ChargeFlowToJSONTyped(value?: Omit<ChargeFlow, 'linkedSpaceId' | 'name' | 'plannedPurgeDate' | 'id' | 'conditions' | 'priority' | 'version'> | null, ignoreDiscriminator?: boolean): any;