wallee
Version:
TypeScript/JavaScript client for wallee
85 lines (84 loc) • 3.51 kB
TypeScript
import type { DebtCollector } from './DebtCollector';
import type { CreationEntityState } from './CreationEntityState';
import type { DebtCollectorCondition } from './DebtCollectorCondition';
/**
* The debt collector configuration defines the behavior of the collection process for a particular collector.
* @export
* @interface DebtCollectorConfiguration
*/
export interface DebtCollectorConfiguration {
/**
* The ID of the space this object belongs to.
* @type {number}
* @memberof DebtCollectorConfiguration
*/
readonly linkedSpaceId?: number;
/**
* Whether the review of debt collection cases is skipped.
* @type {boolean}
* @memberof DebtCollectorConfiguration
*/
readonly skipReviewEnabled?: boolean;
/**
* The name used to identify the debt collector configuration.
* @type {string}
* @memberof DebtCollectorConfiguration
*/
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 DebtCollectorConfiguration
*/
readonly plannedPurgeDate?: Date;
/**
* The space views for which the debt collector configuration is enabled. If empty, it is enabled for all space views.
* @type {Set<number>}
* @memberof DebtCollectorConfiguration
*/
readonly enabledSpaceViews?: Set<number>;
/**
* A unique identifier for the object.
* @type {number}
* @memberof DebtCollectorConfiguration
*/
readonly id?: number;
/**
*
* @type {CreationEntityState}
* @memberof DebtCollectorConfiguration
*/
state?: CreationEntityState;
/**
* Conditions allow to define criteria that a debt collection case must fulfill in order for the debt collector configuration to be considered for processing the case.
* @type {Array<DebtCollectorCondition>}
* @memberof DebtCollectorConfiguration
*/
readonly conditions?: Array<DebtCollectorCondition>;
/**
* The priority that determines the order in which debt collector configurations are taken into account when processing a case. Low values are considered first.
* @type {number}
* @memberof DebtCollectorConfiguration
*/
readonly priority?: number;
/**
* The version is used for optimistic locking and incremented whenever the object is updated.
* @type {number}
* @memberof DebtCollectorConfiguration
*/
readonly version?: number;
/**
*
* @type {DebtCollector}
* @memberof DebtCollectorConfiguration
*/
collector?: DebtCollector;
}
/**
* Check if a given object implements the DebtCollectorConfiguration interface.
*/
export declare function instanceOfDebtCollectorConfiguration(value: object): value is DebtCollectorConfiguration;
export declare function DebtCollectorConfigurationFromJSON(json: any): DebtCollectorConfiguration;
export declare function DebtCollectorConfigurationFromJSONTyped(json: any, ignoreDiscriminator: boolean): DebtCollectorConfiguration;
export declare function DebtCollectorConfigurationToJSON(json: any): DebtCollectorConfiguration;
export declare function DebtCollectorConfigurationToJSONTyped(value?: Omit<DebtCollectorConfiguration, 'linkedSpaceId' | 'skipReviewEnabled' | 'name' | 'plannedPurgeDate' | 'enabledSpaceViews' | 'id' | 'conditions' | 'priority' | 'version'> | null, ignoreDiscriminator?: boolean): any;