wallee
Version:
TypeScript/JavaScript client for wallee
112 lines (111 loc) • 4.58 kB
TypeScript
import type { Condition } from './Condition';
import type { SalesChannel } from './SalesChannel';
import type { PaymentConnector } from './PaymentConnector';
import type { PaymentProcessorConfiguration } from './PaymentProcessorConfiguration';
import type { CreationEntityState } from './CreationEntityState';
import type { PaymentMethodConfiguration } from './PaymentMethodConfiguration';
/**
*
* @export
* @interface PaymentConnectorConfiguration
*/
export interface PaymentConnectorConfiguration {
/**
*
* @type {PaymentMethodConfiguration}
* @memberof PaymentConnectorConfiguration
*/
paymentMethodConfiguration?: PaymentMethodConfiguration;
/**
* The URL to the connector's image.
* @type {string}
* @memberof PaymentConnectorConfiguration
*/
readonly imagePath?: 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 PaymentConnectorConfiguration
*/
readonly plannedPurgeDate?: Date;
/**
* The priority that determines the order in which connector configurations are taken into account when processing a payment. Low values are considered first.
* @type {number}
* @memberof PaymentConnectorConfiguration
*/
readonly priority?: number;
/**
* The sales channels for which the connector configuration is enabled. If empty, it is enabled for all sales channels.
* @type {Set<SalesChannel>}
* @memberof PaymentConnectorConfiguration
*/
readonly enabledSalesChannels?: Set<SalesChannel>;
/**
* The version is used for optimistic locking and incremented whenever the object is updated.
* @type {number}
* @memberof PaymentConnectorConfiguration
*/
readonly version?: number;
/**
*
* @type {PaymentProcessorConfiguration}
* @memberof PaymentConnectorConfiguration
*/
processorConfiguration?: PaymentProcessorConfiguration;
/**
* The ID of the space this object belongs to.
* @type {number}
* @memberof PaymentConnectorConfiguration
*/
readonly linkedSpaceId?: number;
/**
*
* @type {PaymentConnector}
* @memberof PaymentConnectorConfiguration
*/
connector?: PaymentConnector;
/**
* The name used to identify the connector configuration.
* @type {string}
* @memberof PaymentConnectorConfiguration
*/
readonly name?: string;
/**
* The space views for which the connector configuration is enabled. If empty, it is enabled for all space views.
* @type {Set<number>}
* @memberof PaymentConnectorConfiguration
*/
readonly enabledSpaceViews?: Set<number>;
/**
* A unique identifier for the object.
* @type {number}
* @memberof PaymentConnectorConfiguration
*/
readonly id?: number;
/**
*
* @type {CreationEntityState}
* @memberof PaymentConnectorConfiguration
*/
state?: CreationEntityState;
/**
* Whether this connector configuration is enabled for processing payments, taking into account the state of the processor and payment method configurations.
* @type {boolean}
* @memberof PaymentConnectorConfiguration
*/
readonly applicableForTransactionProcessing?: boolean;
/**
* Conditions allow to define criteria that a transaction must fulfill in order for the connector configuration to be considered for processing the payment.
* @type {Array<Condition>}
* @memberof PaymentConnectorConfiguration
*/
readonly conditions?: Array<Condition>;
}
/**
* Check if a given object implements the PaymentConnectorConfiguration interface.
*/
export declare function instanceOfPaymentConnectorConfiguration(value: object): value is PaymentConnectorConfiguration;
export declare function PaymentConnectorConfigurationFromJSON(json: any): PaymentConnectorConfiguration;
export declare function PaymentConnectorConfigurationFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaymentConnectorConfiguration;
export declare function PaymentConnectorConfigurationToJSON(json: any): PaymentConnectorConfiguration;
export declare function PaymentConnectorConfigurationToJSONTyped(value?: Omit<PaymentConnectorConfiguration, 'imagePath' | 'plannedPurgeDate' | 'priority' | 'enabledSalesChannels' | 'version' | 'linkedSpaceId' | 'name' | 'enabledSpaceViews' | 'id' | 'applicableForTransactionProcessing' | 'conditions'> | null, ignoreDiscriminator?: boolean): any;