wallee
Version:
TypeScript/JavaScript client for wallee
105 lines (104 loc) • 3.76 kB
TypeScript
import type { PaymentAppProcessor } from './PaymentAppProcessor';
import type { PaymentConnectorConfiguration } from './PaymentConnectorConfiguration';
import type { PaymentAppConnectorState } from './PaymentAppConnectorState';
import type { PaymentAppCompletionConfiguration } from './PaymentAppCompletionConfiguration';
import type { PaymentAppRefundConfiguration } from './PaymentAppRefundConfiguration';
/**
*
* @export
* @interface PaymentAppConnector
*/
export interface PaymentAppConnector {
/**
* The URL where the user is redirected to process a payment. This endpoint is provided by the external service provider.
* @type {string}
* @memberof PaymentAppConnector
*/
readonly paymentPageEndpoint?: string;
/**
* 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 PaymentAppConnector
*/
readonly externalId?: string;
/**
* The date and time when the connector was last updated.
* @type {Date}
* @memberof PaymentAppConnector
*/
readonly updatedOn?: Date;
/**
*
* @type {PaymentAppCompletionConfiguration}
* @memberof PaymentAppConnector
*/
completionConfiguration?: PaymentAppCompletionConfiguration;
/**
* The date and time when the connector was created.
* @type {Date}
* @memberof PaymentAppConnector
*/
readonly createdOn?: Date;
/**
*
* @type {PaymentAppProcessor}
* @memberof PaymentAppConnector
*/
processor?: PaymentAppProcessor;
/**
* The version is used for optimistic locking and incremented whenever the object is updated.
* @type {number}
* @memberof PaymentAppConnector
*/
readonly version?: number;
/**
* The ID of the space this object belongs to.
* @type {number}
* @memberof PaymentAppConnector
*/
readonly linkedSpaceId?: number;
/**
*
* @type {PaymentConnectorConfiguration}
* @memberof PaymentAppConnector
*/
connectorConfiguration?: PaymentConnectorConfiguration;
/**
* The duration within which the authorization process for a payment should complete.
* @type {string}
* @memberof PaymentAppConnector
*/
readonly authorizationTimeout?: string;
/**
* The name used to identify the connector.
* @type {string}
* @memberof PaymentAppConnector
*/
readonly name?: string;
/**
* A unique identifier for the object.
* @type {number}
* @memberof PaymentAppConnector
*/
readonly id?: number;
/**
*
* @type {PaymentAppConnectorState}
* @memberof PaymentAppConnector
*/
state?: PaymentAppConnectorState;
/**
*
* @type {PaymentAppRefundConfiguration}
* @memberof PaymentAppConnector
*/
refundConfiguration?: PaymentAppRefundConfiguration;
}
/**
* Check if a given object implements the PaymentAppConnector interface.
*/
export declare function instanceOfPaymentAppConnector(value: object): value is PaymentAppConnector;
export declare function PaymentAppConnectorFromJSON(json: any): PaymentAppConnector;
export declare function PaymentAppConnectorFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaymentAppConnector;
export declare function PaymentAppConnectorToJSON(json: any): PaymentAppConnector;
export declare function PaymentAppConnectorToJSONTyped(value?: Omit<PaymentAppConnector, 'paymentPageEndpoint' | 'externalId' | 'updatedOn' | 'createdOn' | 'version' | 'linkedSpaceId' | 'authorizationTimeout' | 'name' | 'id'> | null, ignoreDiscriminator?: boolean): any;