diff --git a/src/models/APIError.ts b/src/models/APIError.ts index 8e39fe2..80541bf 100644 --- a/src/models/APIError.ts +++ b/src/models/APIError.ts @@ -1,88 +1,50 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Contains detailed information on one single error. - */ -export class APIError { +/** @description Contains detailed information on one single error. */ +export interface APIError { /** - * Error code + * @description Error code + * @example 50001130 */ - 'errorCode': string; + errorCode: string; /** - * Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values: * DIRECT_PLATFORM_ERROR - indicating that a functional error has occurred in the platform. * PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the payment platform. * IO_ERROR - indicating that a technical error has occurred within the payment platform or between the payment platform and third party systems. * COMMERCE_PLATFORM_ERROR - indicating an error originating from the Commerce Platform. * COMMERCE_PORTAL_BACKEND_ERROR - indicating an error originating from the Commerce Portal Backend. + * @description Category the error belongs to. The category should give an indication of the type of error you are dealing + * with. Possible values: + * * DIRECT_PLATFORM_ERROR - indicating that a functional error has occurred in the platform. + * * PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the payment platform. + * * IO_ERROR - indicating that a technical error has occurred within the payment platform or between the + * payment platform and third party systems. + * * COMMERCE_PLATFORM_ERROR - indicating an error originating from the Commerce Platform. + * * COMMERCE_PORTAL_BACKEND_ERROR - indicating an error originating from the Commerce Portal Backend. + * @example PAYMENT_PLATFORM_ERROR */ - 'category'?: string; + category?: string; /** - * HTTP status code for this error that can be used to determine the type of error + * Format: int32 + * @description HTTP status code for this error that can be used to determine the type of error + * @example 404 */ - 'httpStatusCode'?: number; + httpStatusCode?: number; /** - * ID of the error. This is a short human-readable message that briefly describes the error. + * @description ID of the error. This is a short human-readable message that briefly describes the error. + * @example general-error-technical-fault-internal */ - 'id'?: string; + id?: string; /** - * Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud + * @description Human-readable error message that is not meant to be relayed to customer as it might tip off people who are + * trying to commit fraud + * @example Authorisation declined */ - 'message'?: string; + message?: string; /** - * Returned only if the error relates to a value that was missing or incorrect. Contains a location path to the value as a JSonata query. Some common examples: * a.b selects the value of property b of root property a, * a[1] selects the first element of the array in root property a, * a[b=\'some value\'] selects all elements of the array in root property a that have a property b with value \'some value\'. + * @description Returned only if the error relates to a value that was missing or incorrect. + * + * Contains a location path to the value as a JSonata query. + * + * Some common examples: + * * a.b selects the value of property b of root property a, + * * a[1] selects the first element of the array in root property a, + * * a[b='some value'] selects all elements of the array in root property a that have a property b with value + * 'some value'. + * @example paymentId */ - 'propertyName'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'errorCode', - baseName: 'errorCode', - type: 'string', - format: '', - }, - { - name: 'category', - baseName: 'category', - type: 'string', - format: '', - }, - { - name: 'httpStatusCode', - baseName: 'httpStatusCode', - type: 'number', - format: 'int32', - }, - { - name: 'id', - baseName: 'id', - type: 'string', - format: '', - }, - { - name: 'message', - baseName: 'message', - type: 'string', - format: '', - }, - { - name: 'propertyName', - baseName: 'propertyName', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return APIError.attributeTypeMap; - } - - public constructor() {} + propertyName?: string; } diff --git a/src/models/Address.ts b/src/models/Address.ts index 7d58e44..4e6f14c 100644 --- a/src/models/Address.ts +++ b/src/models/Address.ts @@ -1,55 +1,39 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Object containing billing address details - */ -export class Address { +/** @description Object containing billing address details */ +export interface Address { /** - * Second line of street or additional address information such as apartments and suits + * @description Second line of street or additional address information such as apartments and suits + * @example Apartment 203 */ - additionalInfo: string | null; + additionalInfo?: string; /** - * City + * @description City + * @example Kiel */ - city: string | null; + city?: string; /** - * ISO 3166-1 alpha-2 country code + * @description ISO 3166-1 alpha-2 country code + * @example DE */ - countryCode: string | null; + countryCode?: string; /** - * House number + * @description House number + * @example 3 */ - houseNumber: string | null; + houseNumber?: string; /** - * State (ISO 3166-2 subdivisions), only if country=US, CA, CN, JP, MX, BR, AR, ID, TH, IN. + * @description State (ISO 3166-2 subdivisions), only if country=US, CA, CN, JP, MX, BR, AR, ID, TH, IN. + * @example BR */ - state: string | null; + state?: string; /** - * Street name + * @description Street name + * @example Coral Avenue */ - street: string | null; + street?: string; /** - * Zip code + * @description Zip code + * @example 12345 */ - zip: string | null; - - public constructor() { - this.additionalInfo = null; - this.city = null; - this.countryCode = null; - this.houseNumber = null; - this.state = null; - this.street = null; - this.zip = null; - } + zip?: string; } + diff --git a/src/models/AddressPersonal.ts b/src/models/AddressPersonal.ts index cc14549..cad4d7a 100644 --- a/src/models/AddressPersonal.ts +++ b/src/models/AddressPersonal.ts @@ -1,59 +1,41 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { PersonalName } from './PersonalName.js'; -import { PersonalName } from './PersonalName.js'; - -/** - * Object containing personal or shipping address information. - */ -export class AddressPersonal { +/** @description Object containing personal or shipping address information. */ +export interface AddressPersonal { /** - * Second line of street or additional address information such as apartments and suits + * @description Second line of street or additional address information such as apartments and suits + * @example Apartment 203 */ - additionalInfo: string | null; + additionalInfo?: string; /** - * City + * @description City + * @example Kiel */ - city: string | null; + city?: string; /** - * ISO 3166-1 alpha-2 country code + * @description ISO 3166-1 alpha-2 country code + * @example DE */ - countryCode: string | null; + countryCode?: string; /** - * House number + * @description House number + * @example 3 */ - houseNumber: string | null; + houseNumber?: string; /** - * State (ISO 3166-2 subdivisions), only if country=US, CA, CN, JP, MX, BR, AR, ID, TH, IN. + * @description State (ISO 3166-2 subdivisions), only if country=US, CA, CN, JP, MX, BR, AR, ID, TH, IN. + * @example MX */ - state: string | null; + state?: string; /** - * Street name + * @description Street name + * @example Coral Avenue */ - street: string | null; + street?: string; /** - * Zip code + * @description Zip code + * @example 1234 */ - zip: string | null; - name: PersonalName | null; - - public constructor() { - this.additionalInfo = null; - this.city = null; - this.countryCode = null; - this.houseNumber = null; - this.state = null; - this.street = null; - this.zip = null; - this.name = null; - } + zip?: string; + name?: PersonalName; } diff --git a/src/models/AllowedPaymentActions.ts b/src/models/AllowedPaymentActions.ts index f94f364..ba8e994 100644 --- a/src/models/AllowedPaymentActions.ts +++ b/src/models/AllowedPaymentActions.ts @@ -1,17 +1,10 @@ /** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Indicates which payment endpoints can be used for the respective Checkout. The systems offers two alternatives to trigger a payment and consecutive events: OrderManagementCheckoutActions or the Payment Execution resource. Both alternatives can be used simultaneously but once one of the Payment Execution endpoints is used the Order Management endpoints can no longer be used for that Checkout since it is no longer possible to match payment events to items of the Checkout. + * @description Indicates which payment endpoints can be used for the respective Checkout. + * The systems offers two alternatives to trigger a payment and consecutive events: + * OrderManagementCheckoutActions or the Payment Execution resource. + * Both alternatives can be used simultaneously but once one of the Payment Execution endpoints is used the + * Order Management endpoints can no longer be used for that Checkout since it is no longer possible to match + * payment events to items of the Checkout. */ export enum AllowedPaymentActions { OrderManagement = 'ORDER_MANAGEMENT', diff --git a/src/models/AmountOfMoney.ts b/src/models/AmountOfMoney.ts index 1cb64ba..8912a85 100644 --- a/src/models/AmountOfMoney.ts +++ b/src/models/AmountOfMoney.ts @@ -1,48 +1,15 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Object containing amount and ISO currency code attributes - */ -export class AmountOfMoney { +/** @description Object containing amount and ISO currency code attributes */ +export interface AmountOfMoney { /** - * Amount in cents and always having 2 decimals + * Format: int64 + * @description Amount in cents and always having 2 decimals + * @example 1000 */ - 'amount': number; + amount: number; /** - * Three-letter ISO currency code representing the currency for the amount + * @description Three-letter ISO currency code representing the currency for the amount + * @example EUR */ - 'currencyCode': string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'amount', - baseName: 'amount', - type: 'number', - format: 'int64', - }, - { - name: 'currencyCode', - baseName: 'currencyCode', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return AmountOfMoney.attributeTypeMap; - } - - public constructor() {} + currencyCode: string; } + diff --git a/src/models/ApplePaymentDataTokenHeaderInformation.ts b/src/models/ApplePaymentDataTokenHeaderInformation.ts index a4d5897..49478fa 100644 --- a/src/models/ApplePaymentDataTokenHeaderInformation.ts +++ b/src/models/ApplePaymentDataTokenHeaderInformation.ts @@ -1,48 +1,7 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Additional information about the Apple payment data token header. - */ -export class ApplePaymentDataTokenHeaderInformation { - /** - * A hexadecimal Transaction identifier identifier as a string. - */ - 'transactionId'?: string; - /** - * SHA–256 hash, hex encoded as a string. Hash of the applicationData property of the original PKPaymentRequest object. - */ - 'applicationData'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'transactionId', - baseName: 'transactionId', - type: 'string', - format: '', - }, - { - name: 'applicationData', - baseName: 'applicationData', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return ApplePaymentDataTokenHeaderInformation.attributeTypeMap; - } - - public constructor() {} +/** @description Additional information about the Apple payment data token header. */ +export interface ApplePaymentDataTokenHeaderInformation { + /** @description A hexadecimal Transaction identifier identifier as a string. */ + transactionId?: string; + /** @description SHA–256 hash, hex encoded as a string. Hash of the applicationData property of the original PKPaymentRequest object. */ + applicationData?: string; } diff --git a/src/models/ApplePaymentDataTokenInformation.ts b/src/models/ApplePaymentDataTokenInformation.ts index 39b54d1..a5378b9 100644 --- a/src/models/ApplePaymentDataTokenInformation.ts +++ b/src/models/ApplePaymentDataTokenInformation.ts @@ -1,61 +1,17 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { ApplePaymentDataTokenHeaderInformation } from './ApplePaymentDataTokenHeaderInformation.js'; +import type { ApplePaymentDataTokenHeaderInformation } from './ApplePaymentDataTokenHeaderInformation.js'; +import type { ApplePaymentTokenVersion } from './ApplePaymentTokenVersion.js'; /** - * Additional information about the Apple payment data token. This information are needed for checking the validity of the payment data token before decryption. + * @description Additional information about the Apple payment data token. This information are needed for checking the validity + * of the payment data token before decryption. */ -export class ApplePaymentDataTokenInformation { +export interface ApplePaymentDataTokenInformation { + version?: ApplePaymentTokenVersion; /** - * Version information about the payment token. Currently only EC_v1 for ECC-encrypted data is supported. + * @description Detached PKCS #7 signature, Base64 encoded as string. Signature of the payment and header data. The + * signature includes the signing certificate, its intermediate CA certificate, and information about the + * signing algorithm. */ - 'version'?: ApplePaymentDataTokenInformationVersionEnum; - /** - * Detached PKCS #7 signature, Base64 encoded as string. Signature of the payment and header data. The signature includes the signing certificate, its intermediate CA certificate, and information about the signing algorithm. - */ - 'signature'?: string; - 'header'?: ApplePaymentDataTokenHeaderInformation; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'version', - baseName: 'version', - type: 'ApplePaymentDataTokenInformationVersionEnum', - format: '', - }, - { - name: 'signature', - baseName: 'signature', - type: 'string', - format: '', - }, - { - name: 'header', - baseName: 'header', - type: 'ApplePaymentDataTokenHeaderInformation', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return ApplePaymentDataTokenInformation.attributeTypeMap; - } - - public constructor() {} -} - -export enum ApplePaymentDataTokenInformationVersionEnum { - EcV1 = 'EC_V1', + signature?: string; + header?: ApplePaymentDataTokenHeaderInformation; } diff --git a/src/models/ApplePaymentTokenVersion.ts b/src/models/ApplePaymentTokenVersion.ts new file mode 100644 index 0000000..cf260ac --- /dev/null +++ b/src/models/ApplePaymentTokenVersion.ts @@ -0,0 +1,7 @@ +/** + * @description Version information about the payment token. Currently only EC_v1 for ECC-encrypted data is supported. + * @example EC_V1 + */ +export enum ApplePaymentTokenVersion { + EC_V1 = 'EC_V1', +} diff --git a/src/models/AppliedExemption.ts b/src/models/AppliedExemption.ts new file mode 100644 index 0000000..c06db32 --- /dev/null +++ b/src/models/AppliedExemption.ts @@ -0,0 +1,7 @@ +/** + * @description Exemption requested and applied in the authorization. + */ +export enum AppliedExemption { + LOW_VALUE = 'low-value', + MERCHANT_ACQUIRER_TRANSACTION_RISK_ANALYSIS = 'merchant-acquirer-transaction-risk-analysis', +} diff --git a/src/models/AuthorizationMode.ts b/src/models/AuthorizationMode.ts index 047b95d..8b21e8c 100644 --- a/src/models/AuthorizationMode.ts +++ b/src/models/AuthorizationMode.ts @@ -1,19 +1,14 @@ /** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. + * @description Determines the type of the authorization that will be used. Allowed values: + * * PRE_AUTHORIZATION - The payment creation results in a pre-authorization that is ready for Capture. Pre- + * authortizations can be reversed and can be captured within 30 days. The capture amount can be lower than the + * authorized amount. + * * SALE - The payment creation results in an authorization that is already captured at the moment of approval. * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Determines the type of the authorization that will be used. Allowed values: * PRE_AUTHORIZATION - The payment creation results in a pre-authorization that is ready for Capture. Pre- authortizations can be reversed and can be captured within 30 days. The capture amount can be lower than the authorized amount. * SALE - The payment creation results in an authorization that is already captured at the moment of approval. If the parameter is not provided in the request, the default value will be PRE_AUTHORIZATION + * If the parameter is not provided in the request, the default value will be PRE_AUTHORIZATION */ export enum AuthorizationMode { - PreAuthorization = 'PRE_AUTHORIZATION', - Sale = 'SALE', + PRE_AUTHORIZATION = 'PRE_AUTHORIZATION', + SALE = 'SALE', } + diff --git a/src/models/BankAccountInformation.ts b/src/models/BankAccountInformation.ts index 26776ec..301d3d1 100644 --- a/src/models/BankAccountInformation.ts +++ b/src/models/BankAccountInformation.ts @@ -1,48 +1,16 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Object containing information about the end customer\'s bank account. - */ -export class BankAccountInformation { +/** @description Object containing information about the end customer's bank account. */ +export interface BankAccountInformation { /** - * IBAN of the end customer\'s bank account. The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits. + * @description IBAN of the end customer's bank account. + * The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and + * includes the ISO country code and two check digits. + * @example DE02370502990000684712 */ - 'iban': string; + iban: string; /** - * Account holder of the bank account with the given IBAN. Does not necessarily have to be the end customer (e.g. joint accounts). + * @description Account holder of the bank account with the given IBAN. + * Does not necessarily have to be the end customer (e.g. joint accounts). + * @example Max Mustermann */ - 'accountHolder': string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'iban', - baseName: 'iban', - type: 'string', - format: '', - }, - { - name: 'accountHolder', - baseName: 'accountHolder', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return BankAccountInformation.attributeTypeMap; - } - - public constructor() {} + accountHolder: string; } diff --git a/src/models/CancelItem.ts b/src/models/CancelItem.ts index 61682e7..568bb0a 100644 --- a/src/models/CancelItem.ts +++ b/src/models/CancelItem.ts @@ -1,45 +1,16 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -export class CancelItem { +export interface CancelItem { /** - * Id of the item to cancel. + * Format: UUID + * @description Id of the item to cancel. + * @example 4f0c512e-f12c-11ec-8ea0-0242ac120002 */ - 'id': string; + id: string; /** - * Quantity of the units being cancelled, should be greater than zero Note: Must not be all spaces or all zeros + * Format: int64 + * @description Quantity of the units being cancelled, should be greater than zero + * Note: Must not be all spaces or all zeros + * @example 1 */ - 'quantity': number; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'id', - baseName: 'id', - type: 'string', - format: 'UUID', - }, - { - name: 'quantity', - baseName: 'quantity', - type: 'number', - format: 'int64', - }, - ]; - - static getAttributeTypeMap() { - return CancelItem.attributeTypeMap; - } - - public constructor() {} + quantity: number; } + diff --git a/src/models/CancelPaymentRequest.ts b/src/models/CancelPaymentRequest.ts index 8aab171..5a6095b 100644 --- a/src/models/CancelPaymentRequest.ts +++ b/src/models/CancelPaymentRequest.ts @@ -1,34 +1,5 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CancellationReason } from './CancellationReason.js'; -import { CancellationReason } from './CancellationReason.js'; - -export class CancelPaymentRequest { - 'cancellationReason'?: CancellationReason; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'cancellationReason', - baseName: 'cancellationReason', - type: 'CancellationReason', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CancelPaymentRequest.attributeTypeMap; - } - - public constructor() {} +export interface CancelPaymentRequest { + cancellationReason?: CancellationReason; } diff --git a/src/models/CancelPaymentResponse.ts b/src/models/CancelPaymentResponse.ts index b32fff3..0461c49 100644 --- a/src/models/CancelPaymentResponse.ts +++ b/src/models/CancelPaymentResponse.ts @@ -1,34 +1,5 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { PaymentResponse } from './PaymentResponse.js'; -import { PaymentResponse } from './PaymentResponse.js'; - -export class CancelPaymentResponse { - 'payment'?: PaymentResponse; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'payment', - baseName: 'payment', - type: 'PaymentResponse', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CancelPaymentResponse.attributeTypeMap; - } - - public constructor() {} +export interface CancelPaymentResponse { + payment?: PaymentResponse; } diff --git a/src/models/CancelRequest.ts b/src/models/CancelRequest.ts index 8f99f6e..eba6870 100644 --- a/src/models/CancelRequest.ts +++ b/src/models/CancelRequest.ts @@ -1,53 +1,20 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { CancelItem } from './CancelItem.js'; -import { CancelType } from './CancelType.js'; -import { CancellationReason } from './CancellationReason.js'; +import type { CancelItem } from "./CancelItem.js"; +import type { CancellationReason } from "./CancellationReason.js"; +import type { CancelType } from "./CancelType.js"; /** - * Request to mark items as of the respective Checkout as cancelled and to automatically reverse the associated payment. A Cancel can be created for a full or the partial ShoppingCart of the Checkout. The platform will automatically calculate the respective amount to trigger the Cancel. For a partial Cancel a list of items must be provided. The cancellationReason is mandatory for BNPL payment methods (paymentProductId 3390, 3391 and 3392). For other payment methods the cancellationReason is not mandatory but can be used for reporting and reconciliation purposes. + * @description Request to mark items as of the respective Checkout as cancelled and to automatically reverse the associated + * payment. + * A Cancel can be created for a full or the partial ShoppingCart of the Checkout. + * The platform will automatically calculate the respective amount to trigger the Cancel. For a partial Cancel a + * list of items must be provided. + * + * The cancellationReason is mandatory for BNPL payment methods (paymentProductId 3390, 3391 and 3392). + * For other payment methods the cancellationReason is not mandatory but can be used for reporting and + * reconciliation purposes. */ -export class CancelRequest { - 'cancelType'?: CancelType; - 'cancellationReason'?: CancellationReason; - 'cancelItems'?: Array; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'cancelType', - baseName: 'cancelType', - type: 'CancelType', - format: '', - }, - { - name: 'cancellationReason', - baseName: 'cancellationReason', - type: 'CancellationReason', - format: '', - }, - { - name: 'cancelItems', - baseName: 'cancelItems', - type: 'Array', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CancelRequest.attributeTypeMap; - } - - public constructor() {} +export interface CancelRequest { + cancelType?: CancelType; + cancellationReason?: CancellationReason; + cancelItems?: CancelItem[]; } diff --git a/src/models/CancelResponse.ts b/src/models/CancelResponse.ts index fb679af..4159356 100644 --- a/src/models/CancelResponse.ts +++ b/src/models/CancelResponse.ts @@ -1,42 +1,7 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CancelPaymentResponse } from './CancelPaymentResponse.js'; +import type { ShoppingCartResult } from './ShoppingCartResult.js'; -import { CancelPaymentResponse } from './CancelPaymentResponse.js'; -import { ShoppingCartResult } from './ShoppingCartResult.js'; - -export class CancelResponse { - 'cancelPaymentResponse'?: CancelPaymentResponse; - 'shoppingCart'?: ShoppingCartResult; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'cancelPaymentResponse', - baseName: 'cancelPaymentResponse', - type: 'CancelPaymentResponse', - format: '', - }, - { - name: 'shoppingCart', - baseName: 'shoppingCart', - type: 'ShoppingCartResult', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CancelResponse.attributeTypeMap; - } - - public constructor() {} +export interface CancelResponse { + cancelPaymentResponse?: CancelPaymentResponse; + shoppingCart?: ShoppingCartResult; } diff --git a/src/models/CancelType.ts b/src/models/CancelType.ts index 3829beb..7cdf352 100644 --- a/src/models/CancelType.ts +++ b/src/models/CancelType.ts @@ -1,19 +1,19 @@ /** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. + * @description The cancelType refers to the ShoppingCart items of the Checkout. + * cancelType = FULL should be provided if all items should be marked as cancelled and the payment for the entire + * ShoppingCart should be reversed. + * cancelType = PARTIAL should be provided if only certain items should be marked as cancelled and the Cancel + * should not be made for the entire ShoppingCart. For this type the list of items has to be provided. + * Please note that a reversal for a partial payment will not reverse the respective amount from the authorization + * but only reduces the openAmount that is ready for collecting. * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * The cancelType refers to the ShoppingCart items of the Checkout. cancelType = FULL should be provided if all items should be marked as cancelled and the payment for the entire ShoppingCart should be reversed. cancelType = PARTIAL should be provided if only certain items should be marked as cancelled and the Cancel should not be made for the entire ShoppingCart. For this type the list of items has to be provided. Please note that a reversal for a partial payment will not reverse the respective amount from the authorization but only reduces the openAmount that is ready for collecting. Following conditions apply to the Cancel request: * items must be in status ORDERED * there was no Capture, Refund or Cancel triggered over the Payment Execution resource * for the cancelType FULL no items are provided in the request Note: If a DISCOUNT productType is among the ShoppingCart items, only cancelType FULL is possible. + * Following conditions apply to the Cancel request: + * * items must be in status ORDERED + * * there was no Capture, Refund or Cancel triggered over the Payment Execution resource + * * for the cancelType FULL no items are provided in the request + * Note: If a DISCOUNT productType is among the ShoppingCart items, only cancelType FULL is possible. */ export enum CancelType { - Full = 'FULL', - Partial = 'PARTIAL', + FULL = 'FULL', + PARTIAL = 'PARTIAL', } diff --git a/src/models/CancellationReason.ts b/src/models/CancellationReason.ts index af28fe2..7eee502 100644 --- a/src/models/CancellationReason.ts +++ b/src/models/CancellationReason.ts @@ -1,23 +1,25 @@ /** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. + * @description Reason why an order was cancelled. Possible values: + * * CONSUMER_REQUEST - The consumer requested a cancellation of the Order + * * UNDELIVERABLE - The merchant cannot fulfill the Order + * * DUPLICATE - The Order was created twice accidentally + * * FRAUDULENT- Consumer turned out to be a fraudster + * * ORDER_SHIPPED_IN_FULL - The merchant shipped everything and wants to cancel the remaining authorized amount of + * the Order + * * AUTOMATED_SHIPMENT_FAILED - A technical error was thrown during an automated shipment API call rendering the + * Order impossible to complete * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Reason why an order was cancelled. Possible values: * CONSUMER_REQUEST - The consumer requested a cancellation of the Order * UNDELIVERABLE - The merchant cannot fulfill the Order * DUPLICATE - The Order was created twice accidentally * FRAUDULENT- Consumer turned out to be a fraudster * ORDER_SHIPPED_IN_FULL - The merchant shipped everything and wants to cancel the remaining authorized amount of the Order * AUTOMATED_SHIPMENT_FAILED - A technical error was thrown during an automated shipment API call rendering the Order impossible to complete Mandatory for PAYONE Buy Now, Pay Later (BNPL): * 3390 - PAYONE Secured Invoice * 3391 - PAYONE Secured Installment * 3392 - PAYONE Secured Direct Debit + * Mandatory for PAYONE Buy Now, Pay Later (BNPL): + * * 3390 - PAYONE Secured Invoice + * * 3391 - PAYONE Secured Installment + * * 3392 - PAYONE Secured Direct Debit + * @example CONSUMER_REQUEST */ export enum CancellationReason { - ConsumerRequest = 'CONSUMER_REQUEST', - Undeliverable = 'UNDELIVERABLE', - Duplicate = 'DUPLICATE', - Fraudulent = 'FRAUDULENT', - OrderShippedInFull = 'ORDER_SHIPPED_IN_FULL', - AutomatedShipmentFailed = 'AUTOMATED_SHIPMENT_FAILED', + CONSUMER_REQUEST = 'CONSUMER_REQUEST', + UNDELIVERABLE = 'UNDELIVERABLE', + DUPLICATE = 'DUPLICATE', + FRAUDULENT = 'FRAUDULENT', + ORDER_SHIPPED_IN_FULL = 'ORDER_SHIPPED_IN_FULL', + AUTOMATED_SHIPMENT_FAILED = 'AUTOMATED_SHIPMENT_FAILED', } diff --git a/src/models/CaptureOutput.ts b/src/models/CaptureOutput.ts index 9c74e0b..459cced 100644 --- a/src/models/CaptureOutput.ts +++ b/src/models/CaptureOutput.ts @@ -1,65 +1,16 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { AmountOfMoney } from './AmountOfMoney.js'; +import type { PaymentReferences } from './PaymentReferences.js'; -import { AmountOfMoney } from './AmountOfMoney.js'; -import { PaymentReferences } from './PaymentReferences.js'; - -/** - * Object containing Capture details. - */ -export class CaptureOutput { - 'amountOfMoney'?: AmountOfMoney; - /** - * It allows you to store additional parameters for the transaction in JSON format. This field must not contain any personal data. - */ - 'merchantParameters'?: string; - 'references'?: PaymentReferences; +/** @description Object containing Capture details. */ +export interface CaptureOutput { + amountOfMoney?: AmountOfMoney; /** - * Payment method identifier used by our payment engine. + * @description It allows you to store additional parameters for the transaction in JSON format. + * This field must not contain any personal data. + * @example {'SessionID':'126548354','ShopperID':'7354131'} */ - 'paymentMethod'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'amountOfMoney', - baseName: 'amountOfMoney', - type: 'AmountOfMoney', - format: '', - }, - { - name: 'merchantParameters', - baseName: 'merchantParameters', - type: 'string', - format: '', - }, - { - name: 'references', - baseName: 'references', - type: 'PaymentReferences', - format: '', - }, - { - name: 'paymentMethod', - baseName: 'paymentMethod', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CaptureOutput.attributeTypeMap; - } - - public constructor() {} + merchantParameters?: string; + references?: PaymentReferences; + /** @description Payment method identifier used by our payment engine. */ + paymentMethod?: string; } diff --git a/src/models/CapturePaymentRequest.ts b/src/models/CapturePaymentRequest.ts index 7aa8b35..957ab96 100644 --- a/src/models/CapturePaymentRequest.ts +++ b/src/models/CapturePaymentRequest.ts @@ -1,73 +1,25 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CancellationReason } from './CancellationReason.js'; +import type { DeliveryInformation } from './DeliveryInformation.js'; +import type { PaymentReferences } from './PaymentReferences.js'; -import { CancellationReason } from './CancellationReason.js'; -import { DeliveryInformation } from './DeliveryInformation.js'; -import { PaymentReferences } from './PaymentReferences.js'; - -/** - * If the shopping cart is specified, a Capture is made with the amount of the shopping cart for the items that are specified. - */ -export class CapturePaymentRequest { +/** @description If the shopping cart is specified, a Capture is made with the amount of the shopping cart for the items that are specified. */ +export interface CapturePaymentRequest { /** - * Here you can specify the amount that you want to capture (specified in cents, where single digit currencies are presumed to have 2 digits). The amount can be lower than the amount that was authorized, but not higher. If left empty, the full amount will be captured and the request will be final. If the full amount is captured, the request will also be final. + * Format: int64 + * @description Here you can specify the amount that you want to capture (specified in cents, where single digit currencies + * are presumed to have 2 digits). The amount can be lower than the amount that was authorized, but not higher. + * If left empty, the full amount will be captured and the request will be final. + * If the full amount is captured, the request will also be final. */ - 'amount'?: number; + amount?: number; /** - * This property indicates whether this will be the final operation. If the full amount should not captured but the property is set to true, the remaining amount will automatically be cancelled. + * @description This property indicates whether this will be the final operation. + * If the full amount should not captured but the property is set to true, the remaining amount will automatically be cancelled. + * + * @default false */ - 'isFinal'?: boolean; - 'cancellationReason'?: CancellationReason; - 'references'?: PaymentReferences; - 'delivery'?: DeliveryInformation; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'amount', - baseName: 'amount', - type: 'number', - format: 'int64', - }, - { - name: 'isFinal', - baseName: 'isFinal', - type: 'boolean', - format: '', - }, - { - name: 'cancellationReason', - baseName: 'cancellationReason', - type: 'CancellationReason', - format: '', - }, - { - name: 'references', - baseName: 'references', - type: 'PaymentReferences', - format: '', - }, - { - name: 'delivery', - baseName: 'delivery', - type: 'DeliveryInformation', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CapturePaymentRequest.attributeTypeMap; - } - - public constructor() {} + isFinal: boolean; + cancellationReason?: CancellationReason; + references?: PaymentReferences; + delivery?: DeliveryInformation; } diff --git a/src/models/CapturePaymentResponse.ts b/src/models/CapturePaymentResponse.ts index 9156e4a..ede1edb 100644 --- a/src/models/CapturePaymentResponse.ts +++ b/src/models/CapturePaymentResponse.ts @@ -1,60 +1,14 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { CaptureOutput } from './CaptureOutput.js'; -import { PaymentStatusOutput } from './PaymentStatusOutput.js'; -import { StatusValue } from './StatusValue.js'; - -export class CapturePaymentResponse { - 'captureOutput'?: CaptureOutput; - 'status'?: StatusValue; - 'statusOutput'?: PaymentStatusOutput; +import type { CaptureOutput } from './CaptureOutput.js'; +import type { PaymentStatusOutput } from './PaymentStatusOutput.js'; +import type { StatusValue } from './StatusValue.js'; + +export interface CapturePaymentResponse { + captureOutput?: CaptureOutput; + status?: StatusValue; + statusOutput?: PaymentStatusOutput; /** - * Unique payment transaction identifier of the payment gateway. + * @description Unique payment transaction identifier of the payment gateway. + * @example 3066019730_1 */ - 'id'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'captureOutput', - baseName: 'captureOutput', - type: 'CaptureOutput', - format: '', - }, - { - name: 'status', - baseName: 'status', - type: 'StatusValue', - format: '', - }, - { - name: 'statusOutput', - baseName: 'statusOutput', - type: 'PaymentStatusOutput', - format: '', - }, - { - name: 'id', - baseName: 'id', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CapturePaymentResponse.attributeTypeMap; - } - - public constructor() {} + id?: string; } diff --git a/src/models/CardFraudResults.ts b/src/models/CardFraudResults.ts index 0f9b952..0bea789 100644 --- a/src/models/CardFraudResults.ts +++ b/src/models/CardFraudResults.ts @@ -1,38 +1,33 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Fraud results contained in the CardFraudResults object. - */ -export class CardFraudResults { +/** @description Fraud results contained in the CardFraudResults object. */ +export interface CardFraudResults { /** - * Result of the Address Verification Service checks. Possible values are: * A - Address (Street) matches, Zip does not * B - Street address match for international transactions—Postal code not verified due to incompatible formats * C - Street address and postal code not verified for international transaction due to incompatible formats * D - Street address and postal code match for international transaction, cardholder name is incorrect * E - AVS error * F - Address does match and five digit ZIP code does match (UK only) * G - Address information is unavailable; international transaction; non-AVS participant * H - Billing address and postal code match, cardholder name is incorrect (Amex) * I - Address information not verified for international transaction * K - Cardholder name matches (Amex) * L - Cardholder name and postal code match (Amex) * M - Cardholder name, street address, and postal code match for international transaction * N - No Match on Address (Street) or Zip * O - Cardholder name and address match (Amex) * P - Postal codes match for international transaction—Street address not verified due to incompatible formats * Q - Billing address matches, cardholder is incorrect (Amex) * R - Retry, System unavailable or Timed out * S - Service not supported by issuer * U - Address information is unavailable * W - 9 digit Zip matches, Address (Street) does not * X - Exact AVS Match * Y - Address (Street) and 5 digit Zip match * Z - 5 digit Zip matches, Address (Street) does not * 0 - No service available + * @description Result of the Address Verification Service checks. Possible values are: + * * A - Address (Street) matches, Zip does not + * * B - Street address match for international transactions—Postal code not verified due to incompatible + * formats + * * C - Street address and postal code not verified for international transaction due to incompatible formats + * * D - Street address and postal code match for international transaction, cardholder name is incorrect + * * E - AVS error + * * F - Address does match and five digit ZIP code does match (UK only) + * * G - Address information is unavailable; international transaction; non-AVS participant + * * H - Billing address and postal code match, cardholder name is incorrect (Amex) + * * I - Address information not verified for international transaction + * * K - Cardholder name matches (Amex) + * * L - Cardholder name and postal code match (Amex) + * * M - Cardholder name, street address, and postal code match for international transaction + * * N - No Match on Address (Street) or Zip + * * O - Cardholder name and address match (Amex) + * * P - Postal codes match for international transaction—Street address not verified due to incompatible formats + * * Q - Billing address matches, cardholder is incorrect (Amex) + * * R - Retry, System unavailable or Timed out + * * S - Service not supported by issuer + * * U - Address information is unavailable + * * W - 9 digit Zip matches, Address (Street) does not + * * X - Exact AVS Match + * * Y - Address (Street) and 5 digit Zip match + * * Z - 5 digit Zip matches, Address (Street) does not + * * 0 - No service available + * @example A */ - 'avsResult'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'avsResult', - baseName: 'avsResult', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CardFraudResults.attributeTypeMap; - } - - public constructor() {} + avsResult?: string; } diff --git a/src/models/CardInfo.ts b/src/models/CardInfo.ts index e2058fa..9402cab 100644 --- a/src/models/CardInfo.ts +++ b/src/models/CardInfo.ts @@ -1,38 +1,5 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Object containing additional non PCI DSS relevant card information. used instead of card (missing fields: cardNumber, expiryDate, cvv) - */ -export class CardInfo { - /** - * The card holder\'s name on the card. - */ - 'cardholderName'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'cardholderName', - baseName: 'cardholderName', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CardInfo.attributeTypeMap; - } - - public constructor() {} +/** @description Object containing additional non PCI DSS relevant card information. used instead of card (missing fields: cardNumber, expiryDate, cvv) */ +export interface CardInfo { + /** @description The card holder's name on the card. */ + cardholderName?: string; } diff --git a/src/models/CardOnFileRecurringFrequency.ts b/src/models/CardOnFileRecurringFrequency.ts new file mode 100644 index 0000000..927ff6b --- /dev/null +++ b/src/models/CardOnFileRecurringFrequency.ts @@ -0,0 +1,16 @@ +/** + * @description Period of payment occurrence for recurring and installment payments. Allowed values: + * * Yearly + * * Quarterly + * * Monthly + * * Weekly + * * Daily + * Supported soon + */ +export enum CardOnFileRecurringFrequency { + YEARLY = 'Yearly', + QUARTERLY = 'Quarterly', + MONTHLY = 'Monthly', + WEEKLY = 'Weekly', + DAILY = 'Daily', +} diff --git a/src/models/CardPaymentDetails.ts b/src/models/CardPaymentDetails.ts index e173b9b..ba9c583 100644 --- a/src/models/CardPaymentDetails.ts +++ b/src/models/CardPaymentDetails.ts @@ -1,68 +1,25 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Information for card payments realized at a POS. - */ -export class CardPaymentDetails { +/** @description Information for card payments realized at a POS. */ +export interface CardPaymentDetails { /** - * Reference to the card of the transaction. + * @description Reference to the card of the transaction. + * @example 672559XXXXXX1108 */ - 'maskedCardNumber'?: string; + maskedCardNumber?: string; /** - * ID of the token. This property is populated when the payment was done with a token. + * @description ID of the token. This property is populated when the payment was done with a token. + * @example 0ca037cc-9079-4df7-8f6f-f2a3443ee521 */ - 'paymentProcessingToken'?: string; + paymentProcessingToken?: string; /** - * Token to identify the card in the reporting. + * @description Token to identify the card in the reporting. + * @example 12a037cc-833d-8b45-8f6f-11c34171f4e1 */ - 'reportingToken'?: string; + reportingToken?: string; /** - * Identifier for a successful authorization, reversal or refund. Usually provided by the issuer system. Only provided for card payments. + * @description Identifier for a successful authorization, reversal or refund. + * Usually provided by the issuer system. Only provided for card payments. + * + * @example 260042 */ - 'cardAuthorizationId'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'maskedCardNumber', - baseName: 'maskedCardNumber', - type: 'string', - format: '', - }, - { - name: 'paymentProcessingToken', - baseName: 'paymentProcessingToken', - type: 'string', - format: '', - }, - { - name: 'reportingToken', - baseName: 'reportingToken', - type: 'string', - format: '', - }, - { - name: 'cardAuthorizationId', - baseName: 'cardAuthorizationId', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CardPaymentDetails.attributeTypeMap; - } - - public constructor() {} + cardAuthorizationId?: string; } diff --git a/src/models/CardPaymentMethodSpecificInput.ts b/src/models/CardPaymentMethodSpecificInput.ts index a62bf5f..a9fd1e7 100644 --- a/src/models/CardPaymentMethodSpecificInput.ts +++ b/src/models/CardPaymentMethodSpecificInput.ts @@ -1,145 +1,51 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { AuthorizationMode } from "./AuthorizationMode.js"; +import type { CardInfo } from "./CardInfo.js"; +import type { CardOnFileRecurringFrequency } from "./CardOnFileRecurringFrequency.js"; +import type { CardRecurrenceDetails } from "./CardRecurrenceDetails.js"; +import type { TransactionChannel } from "./TransactionChannel.js"; +import type { UnscheduledCardOnFileRequestor } from "./UnscheduledCardOnFileRequestor.js"; +import type { UnscheduledCardOnFileSequenceIndicator } from "./UnscheduledCardOnFileSequenceIndicator.js"; -import { AuthorizationMode } from './AuthorizationMode.js'; -import { CardInfo } from './CardInfo.js'; -import { CardRecurrenceDetails } from './CardRecurrenceDetails.js'; -import { TransactionChannel } from './TransactionChannel.js'; -import { UnscheduledCardOnFileRequestor } from './UnscheduledCardOnFileRequestor.js'; -import { UnscheduledCardOnFileSequenceIndicator } from './UnscheduledCardOnFileSequenceIndicator.js'; - -/** - * Object containing the specific input details for card payments. - */ -export class CardPaymentMethodSpecificInput { - 'authorizationMode'?: AuthorizationMode; - 'recurring'?: CardRecurrenceDetails; - /** - * ID of the token to use to create the payment. - */ - 'paymentProcessingToken'?: string; +/** @description Object containing the specific input details for card payments. */ +export interface CardPaymentMethodSpecificInput { + authorizationMode?: AuthorizationMode; + recurring?: CardRecurrenceDetails; /** - * Token to identify the card in the reporting. + * @description ID of the token to use to create the payment. + * @example 0ca037cc-9079-4df7-8f6f-f2a3443ee521 */ - 'reportingToken'?: string; - 'transactionChannel'?: TransactionChannel; - 'unscheduledCardOnFileRequestor'?: UnscheduledCardOnFileRequestor; - 'unscheduledCardOnFileSequenceIndicator'?: UnscheduledCardOnFileSequenceIndicator; + paymentProcessingToken?: string; /** - * Payment product identifier - please check product documentation for a full overview of possible values. + * @description Token to identify the card in the reporting. + * @example 12a037cc-833d-8b45-8f6f-11c34171f4e1 */ - 'paymentProductId'?: number; - 'card'?: CardInfo; + readonly reportingToken?: string; + transactionChannel?: TransactionChannel; + unscheduledCardOnFileRequestor?: UnscheduledCardOnFileRequestor; + unscheduledCardOnFileSequenceIndicator?: UnscheduledCardOnFileSequenceIndicator; /** - * The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process. Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first. URLs without a protocol will be rejected. + * Format: int32 + * @description Payment product identifier - please check product documentation for a full overview of possible values. + * @example 840 */ - 'returnUrl'?: string; + paymentProductId?: number; + card?: CardInfo; /** - * Period of payment occurrence for recurring and installment payments. Allowed values: * Yearly * Quarterly * Monthly * Weekly * Daily Supported soon + * @description The URL that the customer is redirect to after the payment flow has finished. You can add any number of key + * value pairs in the query string that, for instance help you to identify the customer when they return to + * your site. Please note that we will also append some additional key value pairs that will also help you with + * this identification process. + * Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use + * on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered + * on the device first. + * URLs without a protocol will be rejected. + * @example https://secure.ogone.com/ncol/test/displayparams.asp */ - 'cardOnFileRecurringFrequency'?: CardPaymentMethodSpecificInputCardOnFileRecurringFrequencyEnum; + returnUrl?: string; + cardOnFileRecurringFrequency?: CardOnFileRecurringFrequency; /** - * The end date of the last scheduled payment in a series of transactions. Format YYYYMMDD Supported soon + * @description The end date of the last scheduled payment in a series of transactions. + * Format YYYYMMDD Supported soon */ - 'cardOnFileRecurringExpiration'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'authorizationMode', - baseName: 'authorizationMode', - type: 'AuthorizationMode', - format: '', - }, - { - name: 'recurring', - baseName: 'recurring', - type: 'CardRecurrenceDetails', - format: '', - }, - { - name: 'paymentProcessingToken', - baseName: 'paymentProcessingToken', - type: 'string', - format: '', - }, - { - name: 'reportingToken', - baseName: 'reportingToken', - type: 'string', - format: '', - }, - { - name: 'transactionChannel', - baseName: 'transactionChannel', - type: 'TransactionChannel', - format: '', - }, - { - name: 'unscheduledCardOnFileRequestor', - baseName: 'unscheduledCardOnFileRequestor', - type: 'UnscheduledCardOnFileRequestor', - format: '', - }, - { - name: 'unscheduledCardOnFileSequenceIndicator', - baseName: 'unscheduledCardOnFileSequenceIndicator', - type: 'UnscheduledCardOnFileSequenceIndicator', - format: '', - }, - { - name: 'paymentProductId', - baseName: 'paymentProductId', - type: 'number', - format: 'int32', - }, - { - name: 'card', - baseName: 'card', - type: 'CardInfo', - format: '', - }, - { - name: 'returnUrl', - baseName: 'returnUrl', - type: 'string', - format: '', - }, - { - name: 'cardOnFileRecurringFrequency', - baseName: 'cardOnFileRecurringFrequency', - type: 'CardPaymentMethodSpecificInputCardOnFileRecurringFrequencyEnum', - format: '', - }, - { - name: 'cardOnFileRecurringExpiration', - baseName: 'cardOnFileRecurringExpiration', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CardPaymentMethodSpecificInput.attributeTypeMap; - } - - public constructor() {} -} - -export enum CardPaymentMethodSpecificInputCardOnFileRecurringFrequencyEnum { - Yearly = 'Yearly', - Quarterly = 'Quarterly', - Monthly = 'Monthly', - Weekly = 'Weekly', - Daily = 'Daily', + cardOnFileRecurringExpiration?: string; } diff --git a/src/models/CardPaymentMethodSpecificOutput.ts b/src/models/CardPaymentMethodSpecificOutput.ts index 9d107b3..5bcf143 100644 --- a/src/models/CardPaymentMethodSpecificOutput.ts +++ b/src/models/CardPaymentMethodSpecificOutput.ts @@ -1,65 +1,16 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CardFraudResults } from './CardFraudResults.js'; +import type { ThreeDSecureResults } from './ThreeDSecureResults.js'; -import { CardFraudResults } from './CardFraudResults.js'; -import { ThreeDSecureResults } from './ThreeDSecureResults.js'; - -/** - * Object containing the card payment method details. - */ -export class CardPaymentMethodSpecificOutput { - /** - * Payment product identifier - please check product documentation for a full overview of possible values. - */ - 'paymentProductId'?: number; +/** @description Object containing the card payment method details. */ +export interface CardPaymentMethodSpecificOutput { /** - * Card Authorization code as returned by the acquirer + * Format: int32 + * @description Payment product identifier - please check product documentation for a full overview of possible values. + * @example 840 */ - 'authorisationCode'?: string; - 'fraudResults'?: CardFraudResults; - 'threeDSecureResults'?: ThreeDSecureResults; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'paymentProductId', - baseName: 'paymentProductId', - type: 'number', - format: 'int32', - }, - { - name: 'authorisationCode', - baseName: 'authorisationCode', - type: 'string', - format: '', - }, - { - name: 'fraudResults', - baseName: 'fraudResults', - type: 'CardFraudResults', - format: '', - }, - { - name: 'threeDSecureResults', - baseName: 'threeDSecureResults', - type: 'ThreeDSecureResults', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CardPaymentMethodSpecificOutput.attributeTypeMap; - } - - public constructor() {} + paymentProductId?: number; + /** @description Card Authorization code as returned by the acquirer */ + authorisationCode?: string; + fraudResults?: CardFraudResults; + threeDSecureResults?: ThreeDSecureResults; } diff --git a/src/models/CardRecurrenceDetails.ts b/src/models/CardRecurrenceDetails.ts index 87d9591..e2fbceb 100644 --- a/src/models/CardRecurrenceDetails.ts +++ b/src/models/CardRecurrenceDetails.ts @@ -1,38 +1,12 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Object containing data related to recurring. - */ -export class CardRecurrenceDetails { +/** @description Object containing data related to recurring. */ +export interface CardRecurrenceDetails { /** - * * first = This transaction is the first of a series of recurring transactions * recurring = This transaction is a subsequent transaction in a series of recurring transactions Note: For any first of a recurring the system will automatically create a token as you will need to use a token for any subsequent recurring transactions. In case a token already exists this is indicated in the response with a value of False for the isNewToken property in the response. + * @description * first = This transaction is the first of a series of recurring transactions + * * recurring = This transaction is a subsequent transaction in a series of recurring transactions + * + * Note: For any first of a recurring the system will automatically create a token as you will need to use a + * token for any subsequent recurring transactions. In case a token already exists this is indicated in the + * response with a value of False for the isNewToken property in the response. */ - 'recurringPaymentSequenceIndicator'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'recurringPaymentSequenceIndicator', - baseName: 'recurringPaymentSequenceIndicator', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CardRecurrenceDetails.attributeTypeMap; - } - - public constructor() {} + recurringPaymentSequenceIndicator?: string; } diff --git a/src/models/CartItemInput.ts b/src/models/CartItemInput.ts index 914026c..3bf1cdd 100644 --- a/src/models/CartItemInput.ts +++ b/src/models/CartItemInput.ts @@ -1,45 +1,8 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CartItemInvoiceData } from './CartItemInvoiceData.js'; +import type { OrderLineDetailsInput } from './OrderLineDetailsInput.js'; -import { CartItemInvoiceData } from './CartItemInvoiceData.js'; -import { OrderLineDetailsInput } from './OrderLineDetailsInput.js'; - -/** - * This object contains information of all items in the cart. If a cart item is provided, the productPrice and quantity is required. - */ -export class CartItemInput { - 'invoiceData'?: CartItemInvoiceData; - 'orderLineDetails'?: OrderLineDetailsInput; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'invoiceData', - baseName: 'invoiceData', - type: 'CartItemInvoiceData', - format: '', - }, - { - name: 'orderLineDetails', - baseName: 'orderLineDetails', - type: 'OrderLineDetailsInput', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CartItemInput.attributeTypeMap; - } - - public constructor() {} +/** @description This object contains information of all items in the cart. If a cart item is provided, the productPrice and quantity is required. */ +export interface CartItemInput { + invoiceData?: CartItemInvoiceData; + orderLineDetails?: OrderLineDetailsInput; } diff --git a/src/models/CartItemInvoiceData.ts b/src/models/CartItemInvoiceData.ts index bd8a03e..8471641 100644 --- a/src/models/CartItemInvoiceData.ts +++ b/src/models/CartItemInvoiceData.ts @@ -1,38 +1,10 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Object containing the line items of the invoice or shopping cart. - */ -export class CartItemInvoiceData { +/** @description Object containing the line items of the invoice or shopping cart. */ +export interface CartItemInvoiceData { /** - * Shopping cart item description. The description will also be displayed in the portal as the product name. + * @description Shopping cart item description. + * The description will also be displayed in the portal as the product name. + * + * @example Smartwatch */ - 'description'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'description', - baseName: 'description', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CartItemInvoiceData.attributeTypeMap; - } - - public constructor() {} + description?: string; } diff --git a/src/models/CartItemOrderStatus.ts b/src/models/CartItemOrderStatus.ts index 823f260..a855979 100644 --- a/src/models/CartItemOrderStatus.ts +++ b/src/models/CartItemOrderStatus.ts @@ -1,47 +1,12 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CartItemStatus } from './CartItemStatus.js'; -import { CartItemStatus } from './CartItemStatus.js'; - -/** - * Detailed information regarding an occurred payment event. - */ -export class CartItemOrderStatus { - 'cartItemStatus'?: CartItemStatus; +/** @description Detailed information regarding an occurred payment event. */ +export interface CartItemOrderStatus { + cartItemStatus?: CartItemStatus; /** - * Amount of units for which this status is applicable, should be greater than zero + * Format: int64 + * @description Amount of units for which this status is applicable, should be greater than zero + * @example 1 */ - 'quantity'?: number; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'cartItemStatus', - baseName: 'cartItemStatus', - type: 'CartItemStatus', - format: '', - }, - { - name: 'quantity', - baseName: 'quantity', - type: 'number', - format: 'int64', - }, - ]; - - static getAttributeTypeMap() { - return CartItemOrderStatus.attributeTypeMap; - } - - public constructor() {} + quantity?: number; } diff --git a/src/models/CartItemPatch.ts b/src/models/CartItemPatch.ts index d89b24e..3d28505 100644 --- a/src/models/CartItemPatch.ts +++ b/src/models/CartItemPatch.ts @@ -1,45 +1,8 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CartItemInvoiceData } from './CartItemInvoiceData.js'; +import type { OrderLineDetailsPatch } from './OrderLineDetailsPatch.js'; -import { CartItemInvoiceData } from './CartItemInvoiceData.js'; -import { OrderLineDetailsPatch } from './OrderLineDetailsPatch.js'; - -/** - * This object contains information of all items in the cart. If a cart item is provided, the productPrice and quantity is required. - */ -export class CartItemPatch { - 'invoiceData'?: CartItemInvoiceData; - 'orderLineDetails'?: OrderLineDetailsPatch; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'invoiceData', - baseName: 'invoiceData', - type: 'CartItemInvoiceData', - format: '', - }, - { - name: 'orderLineDetails', - baseName: 'orderLineDetails', - type: 'OrderLineDetailsPatch', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CartItemPatch.attributeTypeMap; - } - - public constructor() {} +/** @description This object contains information of all items in the cart. If a cart item is provided, the productPrice and quantity is required. */ +export interface CartItemPatch { + invoiceData?: CartItemInvoiceData; + orderLineDetails?: OrderLineDetailsPatch; } diff --git a/src/models/CartItemResult.ts b/src/models/CartItemResult.ts index 594c22e..dd15e04 100644 --- a/src/models/CartItemResult.ts +++ b/src/models/CartItemResult.ts @@ -1,45 +1,8 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CartItemInvoiceData } from './CartItemInvoiceData.js'; +import type { OrderLineDetailsResult } from './OrderLineDetailsResult.js'; -import { CartItemInvoiceData } from './CartItemInvoiceData.js'; -import { OrderLineDetailsResult } from './OrderLineDetailsResult.js'; - -/** - * This object contains information of all items in the cart. If a cart item is provided, the productPrice and quantity is required. - */ -export class CartItemResult { - 'invoiceData'?: CartItemInvoiceData; - 'orderLineDetails'?: OrderLineDetailsResult; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'invoiceData', - baseName: 'invoiceData', - type: 'CartItemInvoiceData', - format: '', - }, - { - name: 'orderLineDetails', - baseName: 'orderLineDetails', - type: 'OrderLineDetailsResult', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CartItemResult.attributeTypeMap; - } - - public constructor() {} +/** @description This object contains information of all items in the cart. If a cart item is provided, the productPrice and quantity is required. */ +export interface CartItemResult { + invoiceData?: CartItemInvoiceData; + orderLineDetails?: OrderLineDetailsResult; } diff --git a/src/models/CartItemStatus.ts b/src/models/CartItemStatus.ts index 0a5a7c3..14548af 100644 --- a/src/models/CartItemStatus.ts +++ b/src/models/CartItemStatus.ts @@ -1,22 +1,10 @@ /** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Indicates in which status the line item is + * @description Indicates in which status the line item is */ export enum CartItemStatus { - Ordered = 'ORDERED', - Delivered = 'DELIVERED', - Cancelled = 'CANCELLED', - Returned = 'RETURNED', - WaitingForPayment = 'WAITING_FOR_PAYMENT', + ORDERED = 'ORDERED', + DELIVERED = 'DELIVERED', + CANCELLED = 'CANCELLED', + RETURNED = 'RETURNED', + WAITING_FOR_PAYMENT = 'WAITING_FOR_PAYMENT', } diff --git a/src/models/CheckoutReferences.ts b/src/models/CheckoutReferences.ts index 1380492..097924d 100644 --- a/src/models/CheckoutReferences.ts +++ b/src/models/CheckoutReferences.ts @@ -1,48 +1,13 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Object containing all details that are linked to the Checkout. - */ -export class CheckoutReferences { +/** @description Object containing all details that are linked to the Checkout. */ +export interface CheckoutReferences { /** - * Unique reference of the Checkout that is also returned for reporting and reconciliation purposes. + * @description Unique reference of the Checkout that is also returned for reporting and reconciliation purposes. + * @example customer-order-1234 */ - 'merchantReference'?: string; + merchantReference?: string; /** - * Optional parameter to define the shop or touchpoint where a sale has been realized (e.g. different stores). + * @description Optional parameter to define the shop or touchpoint where a sale has been realized (e.g. different stores). + * @example Shop-12345 */ - 'merchantShopReference'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'merchantReference', - baseName: 'merchantReference', - type: 'string', - format: '', - }, - { - name: 'merchantShopReference', - baseName: 'merchantShopReference', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CheckoutReferences.attributeTypeMap; - } - - public constructor() {} + merchantShopReference?: string; } diff --git a/src/models/CheckoutResponse.ts b/src/models/CheckoutResponse.ts index 74a2bce..8a2871d 100644 --- a/src/models/CheckoutResponse.ts +++ b/src/models/CheckoutResponse.ts @@ -1,68 +1,44 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { AllowedPaymentActions } from './AllowedPaymentActions.js'; -import { AmountOfMoney } from './AmountOfMoney.js'; -import { CheckoutReferences } from './CheckoutReferences.js'; -import { PaymentExecution } from './PaymentExecution.js'; -import { PaymentInformationResponse } from './PaymentInformationResponse.js'; -import { Shipping } from './Shipping.js'; -import { ShoppingCartResult } from './ShoppingCartResult.js'; -import { StatusCheckout } from './StatusCheckout.js'; -import { StatusOutput } from './StatusOutput.js'; +import type { AllowedPaymentActions } from './AllowedPaymentActions.js'; +import type { AmountOfMoney } from './AmountOfMoney.js'; +import type { CheckoutReferences } from './CheckoutReferences.js'; +import type { CreationDateTime } from './CreationDateTime.js'; +import type { PaymentExecution } from './PaymentExecution.js'; +import type { PaymentInformationResponse } from './PaymentInformationResponse.js'; +import type { Shipping } from './Shipping.js'; +import type { ShoppingCartResult } from './ShoppingCartResult.js'; +import type { StatusCheckout } from './StatusCheckout.js'; +import type { StatusOutput } from './StatusOutput.js'; /** - * The Checkout corresponds to the order of the WL API. We do not take additionalInput from the WL API. We have no shipping and use deliveryAddress instead of address. + * @description The Checkout corresponds to the order of the WL API. We do not take additionalInput from the WL API. We have no + * shipping and use deliveryAddress instead of address. */ -export class CheckoutResponse { +export interface CheckoutResponse { /** - * reference to the Commerce Case. + * Format: UUID + * @description reference to the Commerce Case. + * @example 4f0c512e-f12c-11ec-8ea0-0242ac120002 */ - commerceCaseId: string | null; + commerceCaseId?: string; /** - * reference to the Checkout. + * Format: UUID + * @description reference to the Checkout. + * @example 4f0c512e-f12c-11ec-8ea0-0242ac120002 */ - checkoutId: string | null; + checkoutId?: string; /** - * Unique identifier for the customer. + * @description Unique identifier for the customer. + * @example 1234 */ - merchantCustomerId: string | null; - amountOfMoney: AmountOfMoney | null; - references: CheckoutReferences | null; - shipping: Shipping | null; - shoppingCart: ShoppingCartResult | null; - paymentExecutions: Array | null; - checkoutStatus: StatusCheckout | null; - statusOutput: StatusOutput | null; - paymentInformation: Array | null; - /** - * Creation date and time of the Checkout in RFC3339 format. It can either be provided in the request or otherwise will be automatically set to the time when the request CreateCommerceCase was received. Response values will always be in UTC time, but when providing this field in the requests, the time offset can have different formats. Accepted formats are: * YYYY-MM-DD\'T\'HH:mm:ss\'Z\' * YYYY-MM-DD\'T\'HH:mm:ss+XX:XX * YYYY-MM-DD\'T\'HH:mm:ss-XX:XX * YYYY-MM-DD\'T\'HH:mm\'Z\' * YYYY-MM-DD\'T\'HH:mm+XX:XX * YYYY-MM-DD\'T\'HH:mm-XX:XX All other formats may be ignored by the system. - */ - creationDateTime: Date | null; - allowedPaymentActions: Array | null; - - constructor() { - this.commerceCaseId = null; - this.checkoutId = null; - this.merchantCustomerId = null; - this.amountOfMoney = null; - this.references = null; - this.shipping = null; - this.shoppingCart = null; - this.paymentExecutions = null; - this.checkoutStatus = null; - this.statusOutput = null; - this.paymentInformation = null; - this.creationDateTime = null; - this.allowedPaymentActions = null; - } + merchantCustomerId?: string; + amountOfMoney?: AmountOfMoney; + references?: CheckoutReferences; + shipping?: Shipping; + shoppingCart?: ShoppingCartResult; + paymentExecutions?: PaymentExecution[]; + checkoutStatus?: StatusCheckout; + statusOutput?: StatusOutput; + paymentInformation?: PaymentInformationResponse[]; + creationDateTime?: CreationDateTime; + allowedPaymentActions?: AllowedPaymentActions[]; } diff --git a/src/models/CheckoutsResponse.ts b/src/models/CheckoutsResponse.ts index 576ae0e..bb85de1 100644 --- a/src/models/CheckoutsResponse.ts +++ b/src/models/CheckoutsResponse.ts @@ -1,50 +1,13 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CheckoutResponse } from './CheckoutResponse.js'; -import { CheckoutResponse } from './CheckoutResponse.js'; - -/** - * Object that holds the number of found Checkouts and the requested page of Checkouts - */ -export class CheckoutsResponse { - /** - * Number of found Checkouts - */ - 'numberOfCheckouts'?: number; +/** @description Object that holds the number of found Checkouts and the requested page of Checkouts */ +export interface CheckoutsResponse { /** - * List of Checkouts + * Format: int64 + * @description Number of found Checkouts + * @example 3390 */ - 'checkouts'?: Array; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'numberOfCheckouts', - baseName: 'numberOfCheckouts', - type: 'number', - format: 'int64', - }, - { - name: 'checkouts', - baseName: 'checkouts', - type: 'Array', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CheckoutsResponse.attributeTypeMap; - } - - public constructor() {} + numberOfCheckouts?: number; + /** @description List of Checkouts */ + checkouts?: CheckoutResponse[]; } diff --git a/src/models/CommerceCaseResponse.ts b/src/models/CommerceCaseResponse.ts index 677dd8b..63acd89 100644 --- a/src/models/CommerceCaseResponse.ts +++ b/src/models/CommerceCaseResponse.ts @@ -1,39 +1,20 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CheckoutResponse } from './CheckoutResponse.js'; +import type { CreationDateTime } from './CreationDateTime.js'; +import type { Customer } from './Customer.js'; -import { CheckoutResponse } from './CheckoutResponse.js'; -import { Customer } from './Customer.js'; - -export class CommerceCaseResponse { - /** - * Unique reference of the Commerce Case that is also returned for reporting and reconciliation purposes. - */ - merchantReference: string | null; +export interface CommerceCaseResponse { /** - * Unique ID reference of the Commerce Case. It can be used to add additional Checkouts to the Commerce Case. + * @description Unique reference of the Commerce Case that is also returned for reporting and reconciliation purposes. + * @example customer-commerce-case-123 */ - commerceCaseId: string | null; - customer: Customer | null; - checkouts: Array | null; + merchantReference?: string; /** - * Creation date and time of the Checkout in RFC3339 format. It can either be provided in the request or otherwise will be automatically set to the time when the request CreateCommerceCase was received. Response values will always be in UTC time, but when providing this field in the requests, the time offset can have different formats. Accepted formats are: * YYYY-MM-DD\'T\'HH:mm:ss\'Z\' * YYYY-MM-DD\'T\'HH:mm:ss+XX:XX * YYYY-MM-DD\'T\'HH:mm:ss-XX:XX * YYYY-MM-DD\'T\'HH:mm\'Z\' * YYYY-MM-DD\'T\'HH:mm+XX:XX * YYYY-MM-DD\'T\'HH:mm-XX:XX All other formats may be ignored by the system. + * Format: UUID + * @description Unique ID reference of the Commerce Case. It can be used to add additional Checkouts to the Commerce Case. + * @example 0c3ab9d7-19ed-40da-9a0e-1f96f4cfb8ae */ - creationDateTime: Date | null; - - public constructor() { - this.merchantReference = null; - this.commerceCaseId = null; - this.customer = null; - this.checkouts = null; - this.creationDateTime = null; - } + commerceCaseId?: string; + customer?: Customer; + checkouts?: CheckoutResponse[]; + creationDateTime?: CreationDateTime; } diff --git a/src/models/CompanyInformation.ts b/src/models/CompanyInformation.ts index 4a7a616..3199f7f 100644 --- a/src/models/CompanyInformation.ts +++ b/src/models/CompanyInformation.ts @@ -1,38 +1,8 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Object containing details of the company. - */ -export class CompanyInformation { +/** @description Object containing details of the company. */ +export interface CompanyInformation { /** - * Name of company from a customer perspective + * @description Name of company from a customer perspective + * @example Customer Company Name */ - 'name'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'name', - baseName: 'name', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CompanyInformation.attributeTypeMap; - } - - public constructor() {} + name?: string; } diff --git a/src/models/CompleteFinancingPaymentMethodSpecificInput.ts b/src/models/CompleteFinancingPaymentMethodSpecificInput.ts index 53f5d43..fab7133 100644 --- a/src/models/CompleteFinancingPaymentMethodSpecificInput.ts +++ b/src/models/CompleteFinancingPaymentMethodSpecificInput.ts @@ -1,57 +1,23 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { PaymentProduct3391SpecificInput } from './PaymentProduct3391SpecificInput.js'; +import type { PaymentProduct3391SpecificInput } from './PaymentProduct3391SpecificInput.js'; /** - * To complete the Payment the completeFinancingMethodSpecificInput has to be provided. At the moment it is only available for PAYONE Secured Installment (paymentProductId 3391). + * @description To complete the Payment the completeFinancingMethodSpecificInput has to be provided. + * At the moment it is only available for PAYONE Secured Installment (paymentProductId 3391). */ -export class CompleteFinancingPaymentMethodSpecificInput { +export interface CompleteFinancingPaymentMethodSpecificInput { /** - * Payment product identifier. Currently supported payment methods: * 3391 - PAYONE Secured Installment + * Format: int32 + * @description Payment product identifier. Currently supported payment methods: + * * 3391 - PAYONE Secured Installment + * @example 3391 */ - 'paymentProductId'?: number; + paymentProductId?: number; /** - * * true = the payment requires approval before the funds will be captured using the Approve payment or Capture payment API * false = the payment does not require approval, and the funds will be captured automatically If the parameter is not provided in the request, the default value will be true + * @description * true = the payment requires approval before the funds will be captured using the Approve payment or Capture payment API + * false = the payment does not require approval, and the funds will be captured automatically + * + * If the parameter is not provided in the request, the default value will be true */ - 'requiresApproval'?: boolean; - 'paymentProduct3391SpecificInput'?: PaymentProduct3391SpecificInput; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'paymentProductId', - baseName: 'paymentProductId', - type: 'number', - format: 'int32', - }, - { - name: 'requiresApproval', - baseName: 'requiresApproval', - type: 'boolean', - format: '', - }, - { - name: 'paymentProduct3391SpecificInput', - baseName: 'paymentProduct3391SpecificInput', - type: 'PaymentProduct3391SpecificInput', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CompleteFinancingPaymentMethodSpecificInput.attributeTypeMap; - } - - public constructor() {} + requiresApproval?: boolean; + paymentProduct3391SpecificInput?: PaymentProduct3391SpecificInput; } diff --git a/src/models/CompletePaymentMethodSpecificInput.ts b/src/models/CompletePaymentMethodSpecificInput.ts index ebed830..9390b7e 100644 --- a/src/models/CompletePaymentMethodSpecificInput.ts +++ b/src/models/CompletePaymentMethodSpecificInput.ts @@ -1,37 +1,6 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { PaymentProduct3391SpecificInput } from './PaymentProduct3391SpecificInput.js'; -import { PaymentProduct3391SpecificInput } from './PaymentProduct3391SpecificInput.js'; - -/** - * To complete the Order the completePaymentMethodSpecificInput has to be provided, containing the selected installmentOptionId as well as the the bankAccountInformation of the customer. - */ -export class CompletePaymentMethodSpecificInput { - 'paymentProduct3391SpecificInput'?: PaymentProduct3391SpecificInput; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'paymentProduct3391SpecificInput', - baseName: 'paymentProduct3391SpecificInput', - type: 'PaymentProduct3391SpecificInput', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CompletePaymentMethodSpecificInput.attributeTypeMap; - } - - public constructor() {} +/** @description To complete the Order the completePaymentMethodSpecificInput has to be provided, containing the selected installmentOptionId as well as the the bankAccountInformation of the customer. */ +export interface CompletePaymentMethodSpecificInput { + paymentProduct3391SpecificInput?: PaymentProduct3391SpecificInput; } diff --git a/src/models/CompletePaymentRequest.ts b/src/models/CompletePaymentRequest.ts index 063e7af..653b86e 100644 --- a/src/models/CompletePaymentRequest.ts +++ b/src/models/CompletePaymentRequest.ts @@ -1,53 +1,14 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { CompleteFinancingPaymentMethodSpecificInput } from './CompleteFinancingPaymentMethodSpecificInput.js'; -import { CustomerDevice } from './CustomerDevice.js'; -import { Order } from './Order.js'; +import type { CompleteFinancingPaymentMethodSpecificInput } from './CompleteFinancingPaymentMethodSpecificInput.js'; +import type { CustomerDevice } from './CustomerDevice.js'; +import type { Order } from './Order.js'; /** - * The Complete request is the last step to finalize the initially created Payment. It requires the completeFinancingPaymentMethodSpecificInput. The data for the order object should not differ from the previously provided information in Commerce Case, Checkout and Payment, but will not be validated nor automatically loaded from the Commerce Platform. + * @description The Complete request is the last step to finalize the initially created Payment. + * It requires the completeFinancingPaymentMethodSpecificInput. + * The data for the order object should not differ from the previously provided information in Commerce Case, Checkout and Payment, but will not be validated nor automatically loaded from the Commerce Platform. */ -export class CompletePaymentRequest { - 'financingPaymentMethodSpecificInput'?: CompleteFinancingPaymentMethodSpecificInput; - 'order'?: Order; - 'device'?: CustomerDevice; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'financingPaymentMethodSpecificInput', - baseName: 'financingPaymentMethodSpecificInput', - type: 'CompleteFinancingPaymentMethodSpecificInput', - format: '', - }, - { - name: 'order', - baseName: 'order', - type: 'Order', - format: '', - }, - { - name: 'device', - baseName: 'device', - type: 'CustomerDevice', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CompletePaymentRequest.attributeTypeMap; - } - - public constructor() {} +export interface CompletePaymentRequest { + financingPaymentMethodSpecificInput?: CompleteFinancingPaymentMethodSpecificInput; + order?: Order; + device?: CustomerDevice; } diff --git a/src/models/CompletePaymentResponse.ts b/src/models/CompletePaymentResponse.ts index 34fc1b8..03e8e77 100644 --- a/src/models/CompletePaymentResponse.ts +++ b/src/models/CompletePaymentResponse.ts @@ -1,50 +1,9 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { MerchantAction } from './MerchantAction.js'; -import { PaymentCreationOutput } from './PaymentCreationOutput.js'; -import { PaymentResponse } from './PaymentResponse.js'; - -export class CompletePaymentResponse { - 'creationOutput'?: PaymentCreationOutput; - 'merchantAction'?: MerchantAction; - 'payment'?: PaymentResponse; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'creationOutput', - baseName: 'creationOutput', - type: 'PaymentCreationOutput', - format: '', - }, - { - name: 'merchantAction', - baseName: 'merchantAction', - type: 'MerchantAction', - format: '', - }, - { - name: 'payment', - baseName: 'payment', - type: 'PaymentResponse', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CompletePaymentResponse.attributeTypeMap; - } - - public constructor() {} +import type { MerchantAction } from './MerchantAction.js'; +import type { PaymentCreationOutput } from './PaymentCreationOutput.js'; +import type { PaymentResponse } from './PaymentResponse.js'; + +export interface CompletePaymentResponse { + creationOutput?: PaymentCreationOutput; + merchantAction?: MerchantAction; + payment?: PaymentResponse; } diff --git a/src/models/ContactDetails.ts b/src/models/ContactDetails.ts index 578b124..98c50fe 100644 --- a/src/models/ContactDetails.ts +++ b/src/models/ContactDetails.ts @@ -1,48 +1,13 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Object containing contact details like email address and phone number. - */ -export class ContactDetails { +/** @description Object containing contact details like email address and phone number. */ +export interface ContactDetails { /** - * Email address of the customer + * @description Email address of the customer + * @example wile.e.coyote@acmelabs.com */ - 'emailAddress'?: string; + emailAddress?: string; /** - * Phone number of the customer + * @description Phone number of the customer + * @example +1234567890 */ - 'phoneNumber'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'emailAddress', - baseName: 'emailAddress', - type: 'string', - format: '', - }, - { - name: 'phoneNumber', - baseName: 'phoneNumber', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return ContactDetails.attributeTypeMap; - } - - public constructor() {} + phoneNumber?: string; } diff --git a/src/models/CreateCheckoutRequest.ts b/src/models/CreateCheckoutRequest.ts index 3a79524..b53c9c7 100644 --- a/src/models/CreateCheckoutRequest.ts +++ b/src/models/CreateCheckoutRequest.ts @@ -1,89 +1,35 @@ +import type { AmountOfMoney } from './AmountOfMoney.js'; +import type { CheckoutReferences } from './CheckoutReferences.js'; +import type { CreationDateTime } from './CreationDateTime.js'; +import type { OrderRequest } from './OrderRequest.js'; +import type { Shipping } from './Shipping.js'; +import type { ShoppingCartInput } from './ShoppingCartInput.js'; + /** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 + * @description Request to create a Checkout for a Commerce Case. + * The payment for the Checkout can be directly executed if autoExecuteOrder = true. + * In this case, the paymentMethodSpecificInput must be provided and only a full order is possible. * + * If no amountOfMoney is provided, the platform will calculate the respective Checkout amount based on the + * cartItem productPrice and quantity. * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { AmountOfMoney } from './AmountOfMoney.js'; -import { CheckoutReferences } from './CheckoutReferences.js'; -import { OrderRequest } from './OrderRequest.js'; -import { Shipping } from './Shipping.js'; -import { ShoppingCartInput } from './ShoppingCartInput.js'; - -/** - * Request to create a Checkout for a Commerce Case. The payment for the Checkout can be directly executed if autoExecuteOrder = true. In this case, the paymentMethodSpecificInput must be provided and only a full order is possible. If no amountOfMoney is provided, the platform will calculate the respective Checkout amount based on the cartItem productPrice and quantity. In case of a payment error, the payment can be retried by providing the respective commerceCaseId and checkoutId to the the Order or Payment Execution endpoint. + * In case of a payment error, the payment can be retried by providing the respective commerceCaseId and checkoutId + * to the the Order or Payment Execution endpoint. */ -export class CreateCheckoutRequest { - 'amountOfMoney'?: AmountOfMoney; - 'references'?: CheckoutReferences; - 'shipping'?: Shipping; - 'shoppingCart'?: ShoppingCartInput; - 'orderRequest'?: OrderRequest; +export interface CreateCheckoutRequest { + amountOfMoney?: AmountOfMoney; + references?: CheckoutReferences; + shipping?: Shipping; + shoppingCart?: ShoppingCartInput; + orderRequest?: OrderRequest; + creationDateTime?: CreationDateTime; /** - * Creation date and time of the Checkout in RFC3339 format. It can either be provided in the request or otherwise will be automatically set to the time when the request CreateCommerceCase was received. Response values will always be in UTC time, but when providing this field in the requests, the time offset can have different formats. Accepted formats are: * YYYY-MM-DD\'T\'HH:mm:ss\'Z\' * YYYY-MM-DD\'T\'HH:mm:ss+XX:XX * YYYY-MM-DD\'T\'HH:mm:ss-XX:XX * YYYY-MM-DD\'T\'HH:mm\'Z\' * YYYY-MM-DD\'T\'HH:mm+XX:XX * YYYY-MM-DD\'T\'HH:mm-XX:XX All other formats may be ignored by the system. + * @description Set this flag to directly execute a payment when creating a Commerce Case or Checkout. + * If the value for autoExecuteOrder is set to true, the paymentMethodSpecificInput for the order is mandatory + * and has to be provided. The autoExecuteOrder can only be used for orderType = full. + * If no shoppingCart information has been provided, a Payment Execution will be created instead of an Order. As a consequence, only Payment Execution endpoints can be used. + * + * @default false */ - 'creationDateTime'?: Date; - /** - * Set this flag to directly execute a payment when creating a Commerce Case or Checkout. If the value for autoExecuteOrder is set to true, the paymentMethodSpecificInput for the order is mandatory and has to be provided. The autoExecuteOrder can only be used for orderType = full. If no shoppingCart information has been provided, a Payment Execution will be created instead of an Order. As a consequence, only Payment Execution endpoints can be used. - */ - 'autoExecuteOrder'?: boolean; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'amountOfMoney', - baseName: 'amountOfMoney', - type: 'AmountOfMoney', - format: '', - }, - { - name: 'references', - baseName: 'references', - type: 'CheckoutReferences', - format: '', - }, - { - name: 'shipping', - baseName: 'shipping', - type: 'Shipping', - format: '', - }, - { - name: 'shoppingCart', - baseName: 'shoppingCart', - type: 'ShoppingCartInput', - format: '', - }, - { - name: 'orderRequest', - baseName: 'orderRequest', - type: 'OrderRequest', - format: '', - }, - { - name: 'creationDateTime', - baseName: 'creationDateTime', - type: 'Date', - format: 'date-time', - }, - { - name: 'autoExecuteOrder', - baseName: 'autoExecuteOrder', - type: 'boolean', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CreateCheckoutRequest.attributeTypeMap; - } - - public constructor() {} + autoExecuteOrder: boolean; } diff --git a/src/models/CreateCheckoutResponse.ts b/src/models/CreateCheckoutResponse.ts index 6e58ef6..94301bf 100644 --- a/src/models/CreateCheckoutResponse.ts +++ b/src/models/CreateCheckoutResponse.ts @@ -1,129 +1,33 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { AllowedPaymentActions } from './AllowedPaymentActions.js'; +import type { AmountOfMoney } from './AmountOfMoney.js'; +import type { CheckoutReferences } from './CheckoutReferences.js'; +import type { CreatePaymentResponse } from './CreatePaymentResponse.js'; +import type { CreationDateTime } from './CreationDateTime.js'; +import type { ErrorResponse } from './ErrorResponse.js'; +import type { PaymentExecution } from './PaymentExecution.js'; +import type { Shipping } from './Shipping.js'; +import type { ShoppingCartResult } from './ShoppingCartResult.js'; +import type { StatusCheckout } from './StatusCheckout.js'; +import type { StatusOutput } from './StatusOutput.js'; -import { AllowedPaymentActions } from './AllowedPaymentActions.js'; -import { AmountOfMoney } from './AmountOfMoney.js'; -import { CheckoutReferences } from './CheckoutReferences.js'; -import { CreatePaymentResponse } from './CreatePaymentResponse.js'; -import { ErrorResponse } from './ErrorResponse.js'; -import { PaymentExecution } from './PaymentExecution.js'; -import { Shipping } from './Shipping.js'; -import { ShoppingCartResult } from './ShoppingCartResult.js'; -import { StatusCheckout } from './StatusCheckout.js'; -import { StatusOutput } from './StatusOutput.js'; - -/** - * Object containing the reference of the Checkout for following requests. - */ -export class CreateCheckoutResponse { - /** - * Reference to the Checkout. Can be used for following requests to get and update the Checkout and execute the payment. - */ - 'checkoutId'?: string; - 'shoppingCart'?: ShoppingCartResult; - 'paymentResponse'?: CreatePaymentResponse; - 'errorResponse'?: ErrorResponse; - 'amountOfMoney'?: AmountOfMoney; - 'references'?: CheckoutReferences; - 'shipping'?: Shipping; - 'paymentExecution'?: PaymentExecution; - 'checkoutStatus'?: StatusCheckout; - 'statusOutput'?: StatusOutput; +/** @description Object containing the reference of the Checkout for following requests. */ +export interface CreateCheckoutResponse { /** - * Creation date and time of the Checkout in RFC3339 format. It can either be provided in the request or otherwise will be automatically set to the time when the request CreateCommerceCase was received. Response values will always be in UTC time, but when providing this field in the requests, the time offset can have different formats. Accepted formats are: * YYYY-MM-DD\'T\'HH:mm:ss\'Z\' * YYYY-MM-DD\'T\'HH:mm:ss+XX:XX * YYYY-MM-DD\'T\'HH:mm:ss-XX:XX * YYYY-MM-DD\'T\'HH:mm\'Z\' * YYYY-MM-DD\'T\'HH:mm+XX:XX * YYYY-MM-DD\'T\'HH:mm-XX:XX All other formats may be ignored by the system. + * Format: UUID + * @description Reference to the Checkout. Can be used for following requests to get and update the Checkout and execute the + * payment. + * @example 707ef15b-7a0a-48f2-b7d8-c95103418a9c */ - 'creationDateTime'?: Date; - 'allowedPaymentActions'?: Array; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'checkoutId', - baseName: 'checkoutId', - type: 'string', - format: 'UUID', - }, - { - name: 'shoppingCart', - baseName: 'shoppingCart', - type: 'ShoppingCartResult', - format: '', - }, - { - name: 'paymentResponse', - baseName: 'paymentResponse', - type: 'CreatePaymentResponse', - format: '', - }, - { - name: 'errorResponse', - baseName: 'errorResponse', - type: 'ErrorResponse', - format: '', - }, - { - name: 'amountOfMoney', - baseName: 'amountOfMoney', - type: 'AmountOfMoney', - format: '', - }, - { - name: 'references', - baseName: 'references', - type: 'CheckoutReferences', - format: '', - }, - { - name: 'shipping', - baseName: 'shipping', - type: 'Shipping', - format: '', - }, - { - name: 'paymentExecution', - baseName: 'paymentExecution', - type: 'PaymentExecution', - format: '', - }, - { - name: 'checkoutStatus', - baseName: 'checkoutStatus', - type: 'StatusCheckout', - format: '', - }, - { - name: 'statusOutput', - baseName: 'statusOutput', - type: 'StatusOutput', - format: '', - }, - { - name: 'creationDateTime', - baseName: 'creationDateTime', - type: 'Date', - format: 'date-time', - }, - { - name: 'allowedPaymentActions', - baseName: 'allowedPaymentActions', - type: 'Array', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CreateCheckoutResponse.attributeTypeMap; - } - - public constructor() {} + checkoutId?: string; + shoppingCart?: ShoppingCartResult; + paymentResponse?: CreatePaymentResponse; + errorResponse?: ErrorResponse; + amountOfMoney?: AmountOfMoney; + references?: CheckoutReferences; + shipping?: Shipping; + paymentExecution?: PaymentExecution; + checkoutStatus?: StatusCheckout; + statusOutput?: StatusOutput; + creationDateTime?: CreationDateTime; + allowedPaymentActions?: AllowedPaymentActions[]; } diff --git a/src/models/CreateCommerceCaseRequest.ts b/src/models/CreateCommerceCaseRequest.ts index 29ae53c..dd60e3c 100644 --- a/src/models/CreateCommerceCaseRequest.ts +++ b/src/models/CreateCommerceCaseRequest.ts @@ -1,34 +1,14 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CreateCheckoutRequest } from './CreateCheckoutRequest.js'; +import type { CreationDateTime } from './CreationDateTime.js'; +import type { Customer } from './Customer.js'; -import { CreateCheckoutRequest } from './CreateCheckoutRequest.js'; -import { Customer } from './Customer.js'; - -export class CreateCommerceCaseRequest { - /** - * Unique reference of the Commerce Case that is also returned for reporting and reconciliation purposes. - */ - merchantReference: string | null; - customer: Customer | null; +export interface CreateCommerceCaseRequest { /** - * Creation date and time of the Checkout in RFC3339 format. It can either be provided in the request or otherwise will be automatically set to the time when the request CreateCommerceCase was received. Response values will always be in UTC time, but when providing this field in the requests, the time offset can have different formats. Accepted formats are: * YYYY-MM-DD\'T\'HH:mm:ss\'Z\' * YYYY-MM-DD\'T\'HH:mm:ss+XX:XX * YYYY-MM-DD\'T\'HH:mm:ss-XX:XX * YYYY-MM-DD\'T\'HH:mm\'Z\' * YYYY-MM-DD\'T\'HH:mm+XX:XX * YYYY-MM-DD\'T\'HH:mm-XX:XX All other formats may be ignored by the system. + * @description Unique reference of the Commerce Case that is also returned for reporting and reconciliation purposes. + * @example customer-commerce-case-123 */ - creationDateTime: Date | null; - checkout: CreateCheckoutRequest | null; - - public constructor() { - this.merchantReference = null; - this.customer = null; - this.creationDateTime = null; - this.checkout = null; - } + merchantReference?: string; + customer?: Customer; + creationDateTime?: CreationDateTime; + checkout?: CreateCheckoutRequest; } diff --git a/src/models/CreateCommerceCaseResponse.ts b/src/models/CreateCommerceCaseResponse.ts index 54939be..0a115bd 100644 --- a/src/models/CreateCommerceCaseResponse.ts +++ b/src/models/CreateCommerceCaseResponse.ts @@ -1,75 +1,23 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { CreateCheckoutResponse } from './CreateCheckoutResponse.js'; -import { Customer } from './Customer.js'; +import type { CreateCheckoutResponse } from './CreateCheckoutResponse.js'; +import type { CreationDateTime } from './CreationDateTime.js'; +import type { Customer } from './Customer.js'; /** - * The response contains references to the created Commerce case and the Checkout. It also contains the payment response if the flag \'autoExecuteOrder\' was set to true. - */ -export class CreateCommerceCaseResponse { - /** - * Unique ID of the Commerce Case. It can used to add additional Checkouts to the Commerce Case. - */ - 'commerceCaseId'?: string; + * @description The response contains references to the created Commerce case and the Checkout. It also contains the payment + * response if the flag 'autoExecuteOrder' was set to true. */ +export interface CreateCommerceCaseResponse { /** - * Unique reference of the Commerce Case that is also returned for reporting and reconciliation purposes. + * Format: UUID + * @description Unique ID of the Commerce Case. It can used to add additional Checkouts to the Commerce Case. + * @example 707ef15b-7a0a-48f2-b7d8-c95103418a9c */ - 'merchantReference'?: string; - 'customer'?: Customer; - 'checkout'?: CreateCheckoutResponse; + commerceCaseId?: string; /** - * Creation date and time of the Checkout in RFC3339 format. It can either be provided in the request or otherwise will be automatically set to the time when the request CreateCommerceCase was received. Response values will always be in UTC time, but when providing this field in the requests, the time offset can have different formats. Accepted formats are: * YYYY-MM-DD\'T\'HH:mm:ss\'Z\' * YYYY-MM-DD\'T\'HH:mm:ss+XX:XX * YYYY-MM-DD\'T\'HH:mm:ss-XX:XX * YYYY-MM-DD\'T\'HH:mm\'Z\' * YYYY-MM-DD\'T\'HH:mm+XX:XX * YYYY-MM-DD\'T\'HH:mm-XX:XX All other formats may be ignored by the system. + * @description Unique reference of the Commerce Case that is also returned for reporting and reconciliation purposes. + * @example customer-commerce-case-123 */ - 'creationDateTime'?: Date; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'commerceCaseId', - baseName: 'commerceCaseId', - type: 'string', - format: 'UUID', - }, - { - name: 'merchantReference', - baseName: 'merchantReference', - type: 'string', - format: '', - }, - { - name: 'customer', - baseName: 'customer', - type: 'Customer', - format: '', - }, - { - name: 'checkout', - baseName: 'checkout', - type: 'CreateCheckoutResponse', - format: '', - }, - { - name: 'creationDateTime', - baseName: 'creationDateTime', - type: 'Date', - format: 'date-time', - }, - ]; - - static getAttributeTypeMap() { - return CreateCommerceCaseResponse.attributeTypeMap; - } - - public constructor() {} + merchantReference?: string; + customer?: Customer; + checkout?: CreateCheckoutResponse; + creationDateTime?: CreationDateTime; } diff --git a/src/models/CreatePaymentResponse.ts b/src/models/CreatePaymentResponse.ts index 28c449b..d78ba4b 100644 --- a/src/models/CreatePaymentResponse.ts +++ b/src/models/CreatePaymentResponse.ts @@ -1,63 +1,16 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { MerchantAction } from './MerchantAction.js'; +import type { PaymentCreationOutput } from './PaymentCreationOutput.js'; +import type { PaymentResponse } from './PaymentResponse.js'; -import { MerchantAction } from './MerchantAction.js'; -import { PaymentCreationOutput } from './PaymentCreationOutput.js'; -import { PaymentResponse } from './PaymentResponse.js'; - -/** - * Object containing details on the created payment it has directly be executed. - */ -export class CreatePaymentResponse { - 'creationOutput'?: PaymentCreationOutput; - 'merchantAction'?: MerchantAction; - 'payment'?: PaymentResponse; +/** @description Object containing details on the created payment it has directly be executed. */ +export interface CreatePaymentResponse { + creationOutput?: PaymentCreationOutput; + merchantAction?: MerchantAction; + payment?: PaymentResponse; /** - * reference to the paymentExecution. + * Format: UUID + * @description reference to the paymentExecution. + * @example 4f0c512e-f12c-11ec-8ea0-0242ac120002 */ - 'paymentExecutionId'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'creationOutput', - baseName: 'creationOutput', - type: 'PaymentCreationOutput', - format: '', - }, - { - name: 'merchantAction', - baseName: 'merchantAction', - type: 'MerchantAction', - format: '', - }, - { - name: 'payment', - baseName: 'payment', - type: 'PaymentResponse', - format: '', - }, - { - name: 'paymentExecutionId', - baseName: 'paymentExecutionId', - type: 'string', - format: 'UUID', - }, - ]; - - static getAttributeTypeMap() { - return CreatePaymentResponse.attributeTypeMap; - } - - public constructor() {} + paymentExecutionId?: string; } diff --git a/src/models/CreationDateTime.ts b/src/models/CreationDateTime.ts new file mode 100644 index 0000000..14e97de --- /dev/null +++ b/src/models/CreationDateTime.ts @@ -0,0 +1,20 @@ +/** + * Format: date-time + * @description Creation date and time of the Checkout in RFC3339 format. It can either be provided in the request or + * otherwise will be automatically set to the time when the request CreateCommerceCase was received. + * Response values will always be in UTC time, but when providing this field in the requests, the time offset + * can have different formats. + * + * Accepted formats are: + * * YYYY-MM-DD'T'HH:mm:ss'Z' + * * YYYY-MM-DD'T'HH:mm:ss+XX:XX + * * YYYY-MM-DD'T'HH:mm:ss-XX:XX + * * YYYY-MM-DD'T'HH:mm'Z' + * * YYYY-MM-DD'T'HH:mm+XX:XX + * * YYYY-MM-DD'T'HH:mm-XX:XX + * + * All other formats may be ignored by the system. + * + * @example 2023-12-06T23:59:60Z + */ +export type CreationDateTime = string; diff --git a/src/models/Customer.ts b/src/models/Customer.ts index 9320d0b..2f4f8ed 100644 --- a/src/models/Customer.ts +++ b/src/models/Customer.ts @@ -1,53 +1,47 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { Address } from './Address.js'; +import type { CompanyInformation } from './CompanyInformation.js'; +import type { ContactDetails } from './ContactDetails.js'; +import type { PersonalInformation } from './PersonalInformation.js'; -import { Address } from './Address.js'; -import { CompanyInformation } from './CompanyInformation.js'; -import { ContactDetails } from './ContactDetails.js'; -import { PersonalInformation } from './PersonalInformation.js'; - -/** - * Object containing the details of a customer. - */ -export class Customer { - companyInformation: CompanyInformation | null; +/** @description Object containing the details of a customer. */ +export interface Customer { + companyInformation?: CompanyInformation; /** - * Unique identifier for the customer. + * @description Unique identifier for the customer. + * @example 1234 */ - merchantCustomerId: string | null; - billingAddress: Address | null; - contactDetails: ContactDetails | null; + merchantCustomerId?: string; + billingAddress?: Address; + contactDetails?: ContactDetails; /** - * Fiscal registration number of the customer or the tax registration number of the company for a business customer. Please find below specifics per country: * Brazil - Consumer (CPF) with a length of 11 digits * Brazil - Company (CNPJ) with a length of 14 digits * Denmark - Consumer (CPR-nummer or personnummer) with a length of 10 digits * Finland - Consumer (Finnish: henkilötunnus (abbreviated as HETU), Swedish: personbeteckning) with a length of 11 characters * Norway - Consumer (fødselsnummer) with a length of 11 digits * Sweden - Consumer (personnummer) with a length of 10 or 12 digits + * @description Fiscal registration number of the customer or the tax registration number of the company for a business + * customer. Please find below specifics per country: + * * Brazil - Consumer (CPF) with a length of 11 digits + * * Brazil - Company (CNPJ) with a length of 14 digits + * * Denmark - Consumer (CPR-nummer or personnummer) with a length of 10 digits + * * Finland - Consumer (Finnish: henkilötunnus (abbreviated as HETU), Swedish: personbeteckning) with a + * length of 11 characters + * * Norway - Consumer (fødselsnummer) with a length of 11 digits + * * Sweden - Consumer (personnummer) with a length of 10 or 12 digits */ - fiscalNumber: string | null; + fiscalNumber?: string; /** - * Business relation to the customer. Possible values: * B2C - Indicates business to consumer * B2B - Indicates business to business Mandatory for the the following payment methods: * 3390 - PAYONE Secured Invoice * 3391 - PAYONE Secured Installment * 3392 - PAYONE Secured Direct Debit + * @description Business relation to the customer. Possible values: + * * B2C - Indicates business to consumer + * * B2B - Indicates business to business + * + * Mandatory for the the following payment methods: + * * 3390 - PAYONE Secured Invoice + * * 3391 - PAYONE Secured Installment + * * 3392 - PAYONE Secured Direct Debit */ - businessRelation: string | null; + businessRelation?: string; /** - * The locale that the customer should be addressed in (for 3rd parties). Note: Only the language code is supported. + * @description The locale that the customer should be addressed in (for 3rd parties). + * + * Note: Only the language code is supported. + * @example de */ - locale: string | null; - personalInformation: PersonalInformation | null; - - public constructor() { - this.companyInformation = null; - this.merchantCustomerId = null; - this.billingAddress = null; - this.contactDetails = null; - this.fiscalNumber = null; - this.businessRelation = null; - this.locale = null; - this.personalInformation = null; - } + locale?: string; + personalInformation?: PersonalInformation; } diff --git a/src/models/CustomerDevice.ts b/src/models/CustomerDevice.ts index 262b51b..70912e4 100644 --- a/src/models/CustomerDevice.ts +++ b/src/models/CustomerDevice.ts @@ -1,48 +1,7 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Object containing information about the device of the end customer. - */ -export class CustomerDevice { - /** - * The IP address of the customer client from the HTTP Headers. - */ - 'ipAddress'?: string; - /** - * Tokenized representation of the end customers device. For example used for PAYONE Buy Now, Pay Later (BNPL). - */ - 'deviceToken'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'ipAddress', - baseName: 'ipAddress', - type: 'string', - format: '', - }, - { - name: 'deviceToken', - baseName: 'deviceToken', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return CustomerDevice.attributeTypeMap; - } - - public constructor() {} +/** @description Object containing information about the device of the end customer. */ +export interface CustomerDevice { + /** @description The IP address of the customer client from the HTTP Headers. */ + ipAddress?: string; + /** @description Tokenized representation of the end customers device. For example used for PAYONE Buy Now, Pay Later (BNPL). */ + deviceToken?: string; } diff --git a/src/models/DeliverItem.ts b/src/models/DeliverItem.ts index e302e30..70adf52 100644 --- a/src/models/DeliverItem.ts +++ b/src/models/DeliverItem.ts @@ -1,45 +1,15 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -export class DeliverItem { +export interface DeliverItem { /** - * Id of the item to deliver. + * Format: UUID + * @description Id of the item to deliver. + * @example 4f0c512e-f12c-11ec-8ea0-0242ac120002 */ - 'id': string; + id: string; /** - * Quantity of the units being delivered, should be greater than zero Note: Must not be all spaces or all zeros + * Format: int64 + * @description Quantity of the units being delivered, should be greater than zero + * Note: Must not be all spaces or all zeros + * @example 1 */ - 'quantity': number; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'id', - baseName: 'id', - type: 'string', - format: 'UUID', - }, - { - name: 'quantity', - baseName: 'quantity', - type: 'number', - format: 'int64', - }, - ]; - - static getAttributeTypeMap() { - return DeliverItem.attributeTypeMap; - } - - public constructor() {} + quantity: number; } diff --git a/src/models/DeliverRequest.ts b/src/models/DeliverRequest.ts index 16026a8..205f799 100644 --- a/src/models/DeliverRequest.ts +++ b/src/models/DeliverRequest.ts @@ -1,63 +1,29 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { CancellationReason } from './CancellationReason.js'; -import { DeliverItem } from './DeliverItem.js'; -import { DeliverType } from './DeliverType.js'; +import type { CancellationReason } from './CancellationReason.js'; +import type { DeliverItem } from './DeliverItem.js'; +import type { DeliverType } from './DeliverType.js'; /** - * Request to mark items of the respective Checkout as delivered and to automatically execute a Capture. A Deliver can be created for a full or the partial ShoppingCart of the Checkout. The platform will automatically calculate the respective amount to trigger the Capture. For a partial Deliver a list of items must be provided. The item details for the Capture will be automatically loaded from the Checkout. The cancellationReason must be provided if deliverType is set to PARTIAL and isFinal is set to true for BNPL payment methods (paymentProductId 3390, 3391 and 3392). For other payment methods the cancellationReason is not mandatory in this case but can be used for reporting and reconciliation purposes. + * @description Request to mark items of the respective Checkout as delivered and to automatically execute a Capture. + * A Deliver can be created for a full or the partial ShoppingCart of the Checkout. + * The platform will automatically calculate the respective amount to trigger the Capture. For a partial Deliver a + * list of items must be provided. + * The item details for the Capture will be automatically loaded from the Checkout. + * + * The cancellationReason must be provided if deliverType is set to PARTIAL and isFinal is set to true for BNPL + * payment methods (paymentProductId 3390, 3391 and 3392). + * For other payment methods the cancellationReason is not mandatory in this case but can be used for reporting + * and reconciliation purposes. */ -export class DeliverRequest { - 'deliverType'?: DeliverType; +export interface DeliverRequest { + deliverType?: DeliverType; /** - * This property indicates whether this will be the final operation. For deliverType FULL, it is always the final operation. If deliverType PARTIAL is provided and the property is set to true, the remaining amount of the items will be cancelled and the items are marked as CANCELLED. + * @description This property indicates whether this will be the final operation. + * For deliverType FULL, it is always the final operation. + * If deliverType PARTIAL is provided and the property is set to true, the remaining amount of the items will be cancelled and the items are marked as CANCELLED. + * + * @default false */ - 'isFinal'?: boolean; - 'cancellationReason'?: CancellationReason; - 'deliverItems'?: Array; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'deliverType', - baseName: 'deliverType', - type: 'DeliverType', - format: '', - }, - { - name: 'isFinal', - baseName: 'isFinal', - type: 'boolean', - format: '', - }, - { - name: 'cancellationReason', - baseName: 'cancellationReason', - type: 'CancellationReason', - format: '', - }, - { - name: 'deliverItems', - baseName: 'deliverItems', - type: 'Array', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return DeliverRequest.attributeTypeMap; - } - - public constructor() {} + isFinal: boolean; + cancellationReason?: CancellationReason; + deliverItems?: DeliverItem[]; } diff --git a/src/models/DeliverResponse.ts b/src/models/DeliverResponse.ts index d6bbaf4..2867c5e 100644 --- a/src/models/DeliverResponse.ts +++ b/src/models/DeliverResponse.ts @@ -1,42 +1,7 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CapturePaymentResponse } from './CapturePaymentResponse.js'; +import type { ShoppingCartResult } from './ShoppingCartResult.js'; -import { CapturePaymentResponse } from './CapturePaymentResponse.js'; -import { ShoppingCartResult } from './ShoppingCartResult.js'; - -export class DeliverResponse { - 'capturePaymentResponse'?: CapturePaymentResponse; - 'shoppingCart'?: ShoppingCartResult; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'capturePaymentResponse', - baseName: 'capturePaymentResponse', - type: 'CapturePaymentResponse', - format: '', - }, - { - name: 'shoppingCart', - baseName: 'shoppingCart', - type: 'ShoppingCartResult', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return DeliverResponse.attributeTypeMap; - } - - public constructor() {} +export interface DeliverResponse { + capturePaymentResponse?: CapturePaymentResponse; + shoppingCart?: ShoppingCartResult; } diff --git a/src/models/DeliverType.ts b/src/models/DeliverType.ts index 24f40bc..1603c46 100644 --- a/src/models/DeliverType.ts +++ b/src/models/DeliverType.ts @@ -1,19 +1,16 @@ /** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * The deliverType refers to the ShoppingCart items of the Checkout. deliverType = FULL should be provided if all items should be marked as delivered and the payment for the entire ShoppingCart should be captured. deliverType = PARTIAL should be provided if only certain items should be marked as delivered and the Capture should not be made for the entire ShoppingCart. For this type the list of items has to be provided. Following conditions apply to the Deliver request: * items must be in status ORDERED * there was no Capture, Refund or Cancel triggered over the Payment Execution resource * for the deliverType FULL no items are provided in the request Note: If a DISCOUNT productType is among the ShoppingCart items, only deliverType FULL is possible. + * @description The deliverType refers to the ShoppingCart items of the Checkout. + * deliverType = FULL should be provided if all items should be marked as delivered and the payment for the entire + * ShoppingCart should be captured. + * deliverType = PARTIAL should be provided if only certain items should be marked as delivered and the Capture + * should not be made for the entire ShoppingCart. For this type the list of items has to be provided. + * Following conditions apply to the Deliver request: + * * items must be in status ORDERED + * * there was no Capture, Refund or Cancel triggered over the Payment Execution resource + * * for the deliverType FULL no items are provided in the request + * Note: If a DISCOUNT productType is among the ShoppingCart items, only deliverType FULL is possible. */ export enum DeliverType { - Full = 'FULL', - Partial = 'PARTIAL', + FULL = 'FULL', + PARTIAL = 'PARTIAL', } diff --git a/src/models/DeliveryInformation.ts b/src/models/DeliveryInformation.ts index cdc4a9a..24a7f51 100644 --- a/src/models/DeliveryInformation.ts +++ b/src/models/DeliveryInformation.ts @@ -1,40 +1,10 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { CartItemInput } from './CartItemInput.js'; +import type { CartItemInput } from './CartItemInput.js'; /** - * Delivery object contains additional information about the delivery/shipment, which is the basis for the Capture. The amountOfMoney in the cartItem will not be used in the request. + * @description Delivery object contains additional information about the delivery/shipment, which is the basis for the Capture. + * The amountOfMoney in the cartItem will not be used in the request. */ -export class DeliveryInformation { - /** - * Items delivered. - */ - 'items'?: Array; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'items', - baseName: 'items', - type: 'Array', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return DeliveryInformation.attributeTypeMap; - } - - public constructor() {} +export interface DeliveryInformation { + /** @description Items delivered. */ + items?: CartItemInput[]; } diff --git a/src/models/ErrorResponse.ts b/src/models/ErrorResponse.ts index bbabdc4..588e5a2 100644 --- a/src/models/ErrorResponse.ts +++ b/src/models/ErrorResponse.ts @@ -1,26 +1,7 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { APIError } from './APIError.js'; -import { APIError } from './APIError.js'; - -export class ErrorResponse { - /** - * Unique reference of this error response for debugging purposes - */ - errorId: string | null; - errors: Array | null; - - public constructor() { - this.errorId = null; - this.errors = null; - } +export interface ErrorResponse { + /** @description Unique reference of this error response for debugging purposes */ + errorId?: string; + errors?: APIError[]; } diff --git a/src/models/ExtendedCheckoutStatus.ts b/src/models/ExtendedCheckoutStatus.ts index 3bbbdd6..7903123 100644 --- a/src/models/ExtendedCheckoutStatus.ts +++ b/src/models/ExtendedCheckoutStatus.ts @@ -1,26 +1,28 @@ /** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. + * @description The extendedCheckoutStatus provides a more granular status of the Checkout based on the respective amounts. The + * extendedCheckoutStatus include the regular Checkout status OPEN, DELETED, PENDING_COMPLETION, COMPLETED, BILLED, + * and CHARGEBACKED as well as three additional status: * - * OpenAPI spec version: 1.8.0 + * 1. PARTIALLY_BILLED: Checkout amount has been partially collected. Overall the Checkout status is BILLED and one + * of the following conditions is true: + * (1) the openAmount is greater than zero or + * (2) the openAmount is zero, the refundAmount is zero and the checkoutAmount is not equal to collectedAmount plus the cancelledAmount. + * 2. PARTIALLY_REFUNDED: The entire Checkout amount has been captured and an amount has been partially refunded to + * customer. Overall the Checkout status is BILLED, the openAmount is zero and the refundAmount and collectedAmount + * are greater than zero. + * 3. REFUNDED: The entire Checkout amount has been refunded to the customer. Overall the Checkout status is + * BILLED, the openAmount and collectedAmount are zero but the refundAmount is greater than zero. * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * The extendedCheckoutStatus provides a more granular status of the Checkout based on the respective amounts. The extendedCheckoutStatus include the regular Checkout status OPEN, DELETED, PENDING_COMPLETION, COMPLETED, BILLED, and CHARGEBACKED as well as three additional status: 1. PARTIALLY_BILLED: Checkout amount has been partially collected. Overall the Checkout status is BILLED and one of the following conditions is true: (1) the openAmount is greater than zero or (2) the openAmount is zero, the refundAmount is zero and the checkoutAmount is not equal to collectedAmount plus the cancelledAmount. 2. PARTIALLY_REFUNDED: The entire Checkout amount has been captured and an amount has been partially refunded to customer. Overall the Checkout status is BILLED, the openAmount is zero and the refundAmount and collectedAmount are greater than zero. 3. REFUNDED: The entire Checkout amount has been refunded to the customer. Overall the Checkout status is BILLED, the openAmount and collectedAmount are zero but the refundAmount is greater than zero. + * @example OPEN */ export enum ExtendedCheckoutStatus { - Open = 'OPEN', - Deleted = 'DELETED', - PendingCompletion = 'PENDING_COMPLETION', - Completed = 'COMPLETED', - PartiallyBilled = 'PARTIALLY_BILLED', - Billed = 'BILLED', - Chargebacked = 'CHARGEBACKED', - PartiallyRefunded = 'PARTIALLY_REFUNDED', - Refunded = 'REFUNDED', + OPEN = 'OPEN', + DELETED = 'DELETED', + PENDING_COMPLETION = 'PENDING_COMPLETION', + COMPLETED = 'COMPLETED', + PARTIALLY_BILLED = 'PARTIALLY_BILLED', + BILLED = 'BILLED', + CHARGEBACKED = 'CHARGEBACKED', + PARTIALLY_REFUNDED = 'PARTIALLY_REFUNDED', + REFUNDED = 'REFUNDED', } diff --git a/src/models/FinancingPaymentMethodSpecificInput.ts b/src/models/FinancingPaymentMethodSpecificInput.ts index f9eea67..f843a5f 100644 --- a/src/models/FinancingPaymentMethodSpecificInput.ts +++ b/src/models/FinancingPaymentMethodSpecificInput.ts @@ -1,57 +1,24 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { PaymentProduct3392SpecificInput } from './PaymentProduct3392SpecificInput.js'; -import { PaymentProduct3392SpecificInput } from './PaymentProduct3392SpecificInput.js'; - -/** - * Object containing the specific input details for financing payment methods (Buy Now Pay Later) - */ -export class FinancingPaymentMethodSpecificInput { +/** @description Object containing the specific input details for financing payment methods (Buy Now Pay Later) */ +export interface FinancingPaymentMethodSpecificInput { /** - * Payment product identifier - please check product documentation for a full overview of possible values. Currently supported payment methods * 3390 - PAYONE Secured Invoice * 3391 - PAYONE Secured Installment * 3392 - PAYONE Secured Direct Debit + * Format: int32 + * @description Payment product identifier - please check product documentation for a full overview of possible values. + * Currently supported payment methods + * * 3390 - PAYONE Secured Invoice + * * 3391 - PAYONE Secured Installment + * * 3392 - PAYONE Secured Direct Debit + * @example 3390 */ - 'paymentProductId'?: number; + paymentProductId?: number; /** - * * true = the payment requires approval before the funds will be captured using the Approve payment or Capture payment API * false = the payment does not require approval, and the funds will be captured automatically If the parameter is not provided in the request, the default value will be true + * @description * true = the payment requires approval before the funds will be captured using the Approve payment or + * Capture payment API + * * false = the payment does not require approval, and the funds will be captured automatically + * + * If the parameter is not provided in the request, the default value will be true */ - 'requiresApproval'?: boolean; - 'paymentProduct3392SpecificInput'?: PaymentProduct3392SpecificInput; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'paymentProductId', - baseName: 'paymentProductId', - type: 'number', - format: 'int32', - }, - { - name: 'requiresApproval', - baseName: 'requiresApproval', - type: 'boolean', - format: '', - }, - { - name: 'paymentProduct3392SpecificInput', - baseName: 'paymentProduct3392SpecificInput', - type: 'PaymentProduct3392SpecificInput', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return FinancingPaymentMethodSpecificInput.attributeTypeMap; - } - - public constructor() {} + requiresApproval?: boolean; + paymentProduct3392SpecificInput?: PaymentProduct3392SpecificInput; } diff --git a/src/models/FinancingPaymentMethodSpecificOutput.ts b/src/models/FinancingPaymentMethodSpecificOutput.ts index c3b1fff..a5e86d3 100644 --- a/src/models/FinancingPaymentMethodSpecificOutput.ts +++ b/src/models/FinancingPaymentMethodSpecificOutput.ts @@ -1,47 +1,16 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { PaymentProduct3391SpecificOutput } from './PaymentProduct3391SpecificOutput.js'; -import { PaymentProduct3391SpecificOutput } from './PaymentProduct3391SpecificOutput.js'; - -/** - * Object containing the specific output details for financing payment methods (Buy Now Pay Later) - */ -export class FinancingPaymentMethodSpecificOutput { +/** @description Object containing the specific output details for financing payment methods (Buy Now Pay Later) */ +export interface FinancingPaymentMethodSpecificOutput { /** - * Payment product identifier - please check product documentation for a full overview of possible values. Currently supported payment methods * 3390 - PAYONE Secured Invoice * 3391 - PAYONE Secured Installment * 3392 - PAYONE Secured Direct Debit + * Format: int32 + * @description Payment product identifier - please check product documentation for a full overview of possible values. + * Currently supported payment methods + * * 3390 - PAYONE Secured Invoice + * * 3391 - PAYONE Secured Installment + * * 3392 - PAYONE Secured Direct Debit + * @example 3390 */ - 'paymentProductId'?: number; - 'paymentProduct3391SpecificOutput'?: PaymentProduct3391SpecificOutput; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'paymentProductId', - baseName: 'paymentProductId', - type: 'number', - format: 'int32', - }, - { - name: 'paymentProduct3391SpecificOutput', - baseName: 'paymentProduct3391SpecificOutput', - type: 'PaymentProduct3391SpecificOutput', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return FinancingPaymentMethodSpecificOutput.attributeTypeMap; - } - - public constructor() {} + paymentProductId?: number; + paymentProduct3391SpecificOutput?: PaymentProduct3391SpecificOutput; } diff --git a/src/models/Gender.ts b/src/models/Gender.ts new file mode 100644 index 0000000..cfc8f5a --- /dev/null +++ b/src/models/Gender.ts @@ -0,0 +1,11 @@ +/** + * @description The gender of the customer, possible values are: + * * MALE + * * FEMALE + * * UNKNOWN + */ +export enum Gender { + MALE = 'MALE', + FEMALE = 'FEMALE', + UNKNOWN = 'UNKNOWN', +} diff --git a/src/models/InstallmentOption.ts b/src/models/InstallmentOption.ts index 627d8b1..1bbd404 100644 --- a/src/models/InstallmentOption.ts +++ b/src/models/InstallmentOption.ts @@ -1,118 +1,39 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { AmountOfMoney } from './AmountOfMoney.js'; +import type { LinkInformation } from './LinkInformation.js'; -import { AmountOfMoney } from './AmountOfMoney.js'; -import { LinkInformation } from './LinkInformation.js'; - -export class InstallmentOption { - /** - * Installment option Identifier. Use this in the Complete Payment for the selected installment option. - */ - 'installmentOptionId': string; - /** - * The number of monthly payments for this installment. - */ - 'numberOfPayments': number; - /** - * Monthly rate amount. - */ - 'monthlyAmount': AmountOfMoney; +export interface InstallmentOption { /** - * Last rate amount. + * @description Installment option Identifier. Use this in the Complete Payment for the selected installment option. + * @example IOP_478d44fea0494eea86bc87f9e4a63328 */ - 'lastRateAmount': AmountOfMoney; + installmentOptionId: string; /** - * Effective interest amount in percent with two decimals. + * Format: int32 + * @description The number of monthly payments for this installment. + * @example 12 */ - 'effectiveInterestRate': number; + numberOfPayments: number; + /** @description Monthly rate amount. */ + monthlyAmount: AmountOfMoney; + /** @description Last rate amount. */ + lastRateAmount: AmountOfMoney; /** - * Nominal interest amount in percent with two decimals. + * Format: int32 + * @description Effective interest amount in percent with two decimals. + * @example 1209 */ - 'nominalInterestRate': number; + effectiveInterestRate: number; /** - * Total rate amount. + * Format: int32 + * @description Nominal interest amount in percent with two decimals. + * @example 1199 */ - 'totalAmount': AmountOfMoney; - /** - * Due date of first rate. Format: YYYYMMDD - */ - 'firstRateDate': string; - /** - * Link with credit information. - */ - 'creditInformation': LinkInformation; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'installmentOptionId', - baseName: 'installmentOptionId', - type: 'string', - format: '', - }, - { - name: 'numberOfPayments', - baseName: 'numberOfPayments', - type: 'number', - format: 'int32', - }, - { - name: 'monthlyAmount', - baseName: 'monthlyAmount', - type: 'AmountOfMoney', - format: '', - }, - { - name: 'lastRateAmount', - baseName: 'lastRateAmount', - type: 'AmountOfMoney', - format: '', - }, - { - name: 'effectiveInterestRate', - baseName: 'effectiveInterestRate', - type: 'number', - format: 'int32', - }, - { - name: 'nominalInterestRate', - baseName: 'nominalInterestRate', - type: 'number', - format: 'int32', - }, - { - name: 'totalAmount', - baseName: 'totalAmount', - type: 'AmountOfMoney', - format: '', - }, - { - name: 'firstRateDate', - baseName: 'firstRateDate', - type: 'string', - format: '', - }, - { - name: 'creditInformation', - baseName: 'creditInformation', - type: 'LinkInformation', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return InstallmentOption.attributeTypeMap; - } - - public constructor() {} + nominalInterestRate: number; + /** @description Total rate amount. */ + totalAmount: AmountOfMoney; + /** @description Due date of first rate. + * Format: YYYYMMDD */ + firstRateDate: string; + /** @description Link with credit information. */ + creditInformation: LinkInformation; } diff --git a/src/models/LinkInformation.ts b/src/models/LinkInformation.ts index 5bb6def..9298400 100644 --- a/src/models/LinkInformation.ts +++ b/src/models/LinkInformation.ts @@ -1,48 +1,7 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * URL and content type information for an web resource. - */ -export class LinkInformation { - /** - * URL of link. - */ - 'href': string; - /** - * Content type of linked data. - */ - 'type': string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'href', - baseName: 'href', - type: 'string', - format: '', - }, - { - name: 'type', - baseName: 'type', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return LinkInformation.attributeTypeMap; - } - - public constructor() {} +/** @description URL and content type information for an web resource. */ +export interface LinkInformation { + /** @description URL of link. */ + href: string; + /** @description Content type of linked data. */ + type: string; } diff --git a/src/models/MandateRecurrenceType.ts b/src/models/MandateRecurrenceType.ts index 361bff8..c6593c6 100644 --- a/src/models/MandateRecurrenceType.ts +++ b/src/models/MandateRecurrenceType.ts @@ -1,19 +1,9 @@ /** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Specifies whether the mandate is for one-off or recurring payments. Possible values are: * UNIQUE * RECURRING + * @description Specifies whether the mandate is for one-off or recurring payments. Possible values are: + * * UNIQUE + * * RECURRING */ export enum MandateRecurrenceType { - Unique = 'UNIQUE', - Recurring = 'RECURRING', + UNIQUE = 'UNIQUE', + RECURRING = 'RECURRING', } diff --git a/src/models/MerchantAction.ts b/src/models/MerchantAction.ts index 3f4ae17..8b587f6 100644 --- a/src/models/MerchantAction.ts +++ b/src/models/MerchantAction.ts @@ -1,47 +1,25 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { RedirectData } from './RedirectData.js'; +import type { RedirectData } from './RedirectData.js'; /** - * Object that contains the action, including the needed data, that you should perform next, like showing instructions, showing the transaction results or redirect to a third party to complete the payment + * @description Object that contains the action, including the needed data, that you should perform next, like showing + * instructions, showing the transaction results or redirect to a third party to complete the payment */ -export class MerchantAction { +export interface MerchantAction { /** - * Action merchants needs to take in the online payment process. Possible values are: * REDIRECT - The customer needs to be redirected using the details found in redirectData * SHOW_FORM - The customer needs to be shown a form with the fields found in formFields. You can submit the data entered by the user in a Complete payment request. * SHOW_INSTRUCTIONS - The customer needs to be shown payment instruction using the details found in showData. Alternatively the instructions can be rendered by us using the instructionsRenderingData * SHOW_TRANSACTION_RESULTS - The customer needs to be shown the transaction results using the details found in showData. Alternatively the instructions can be rendered by us using the instructionsRenderingData * MOBILE_THREEDS_CHALLENGE - The customer needs to complete a challenge as part of the 3D Secure authentication inside your mobile app. The details contained in mobileThreeDSecureChallengeParameters need to be provided to the EMVco certified Mobile SDK as a challengeParameters object. * CALL_THIRD_PARTY - The merchant needs to call a third party using the data found in thirdPartyData + * @description Action merchants needs to take in the online payment process. Possible values are: + * * REDIRECT - The customer needs to be redirected using the details found in redirectData + * * SHOW_FORM - The customer needs to be shown a form with the fields found in formFields. You can submit the + * data entered by the user in a Complete payment request. + * * SHOW_INSTRUCTIONS - The customer needs to be shown payment instruction using the details found in + * showData. Alternatively the instructions can be rendered by us using the instructionsRenderingData + * * SHOW_TRANSACTION_RESULTS - The customer needs to be shown the transaction results using the details found + * in showData. Alternatively the instructions can be rendered by us using the instructionsRenderingData + * * MOBILE_THREEDS_CHALLENGE - The customer needs to complete a challenge as part of the 3D Secure + * authentication inside your mobile app. The details contained in mobileThreeDSecureChallengeParameters need + * to be provided to the EMVco certified Mobile SDK as a challengeParameters object. + * * CALL_THIRD_PARTY - The merchant needs to call a third party using the data found in thirdPartyData + * @example REDIRECT */ - 'actionType'?: string; - 'redirectData'?: RedirectData; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'actionType', - baseName: 'actionType', - type: 'string', - format: '', - }, - { - name: 'redirectData', - baseName: 'redirectData', - type: 'RedirectData', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return MerchantAction.attributeTypeMap; - } - - public constructor() {} + actionType?: string; + redirectData?: RedirectData; } diff --git a/src/models/MobilePaymentMethodSpecificInput.ts b/src/models/MobilePaymentMethodSpecificInput.ts index 5251505..e0a3fae 100644 --- a/src/models/MobilePaymentMethodSpecificInput.ts +++ b/src/models/MobilePaymentMethodSpecificInput.ts @@ -1,85 +1,24 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { AuthorizationMode } from './AuthorizationMode.js'; +import type { PaymentProduct320SpecificInput } from './PaymentProduct320SpecificInput.js'; -import { AuthorizationMode } from './AuthorizationMode.js'; -import { PaymentProduct320SpecificInput } from './PaymentProduct320SpecificInput.js'; - -/** - * Object containing the specific input details for mobile payments. - */ -export class MobilePaymentMethodSpecificInput { - /** - * Payment product identifier - please check product documentation for a full overview of possible values. - */ - 'paymentProductId'?: number; - 'authorizationMode'?: AuthorizationMode; - /** - * The payment data if we will do the decryption of the encrypted payment data. Typically you\'d use encryptedCustomerInput in the root of the create payment request to provide the encrypted payment data instead. - */ - 'encryptedPaymentData'?: string; +/** @description Object containing the specific input details for mobile payments. */ +export interface MobilePaymentMethodSpecificInput { /** - * Public Key Hash A unique identifier to retrieve key used by Apple to encrypt information. + * Format: int32 + * @description Payment product identifier - please check product documentation for a full overview of possible values. + * @example 840 */ - 'publicKeyHash'?: string; + paymentProductId?: number; + authorizationMode?: AuthorizationMode; /** - * Ephemeral Key A unique generated key used by Apple to encrypt data. + * @description The payment data if we will do the decryption of the encrypted payment data. Typically you'd use + * encryptedCustomerInput in the root of the create payment request to provide the encrypted payment data + * instead. */ - 'ephemeralKey'?: string; - 'paymentProduct302SpecificInput'?: PaymentProduct320SpecificInput; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'paymentProductId', - baseName: 'paymentProductId', - type: 'number', - format: 'int32', - }, - { - name: 'authorizationMode', - baseName: 'authorizationMode', - type: 'AuthorizationMode', - format: '', - }, - { - name: 'encryptedPaymentData', - baseName: 'encryptedPaymentData', - type: 'string', - format: '', - }, - { - name: 'publicKeyHash', - baseName: 'publicKeyHash', - type: 'string', - format: '', - }, - { - name: 'ephemeralKey', - baseName: 'ephemeralKey', - type: 'string', - format: '', - }, - { - name: 'paymentProduct302SpecificInput', - baseName: 'paymentProduct302SpecificInput', - type: 'PaymentProduct320SpecificInput', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return MobilePaymentMethodSpecificInput.attributeTypeMap; - } - - public constructor() {} + encryptedPaymentData?: string; + /** @description Public Key Hash A unique identifier to retrieve key used by Apple to encrypt information. */ + publicKeyHash?: string; + /** @description Ephemeral Key A unique generated key used by Apple to encrypt data. */ + ephemeralKey?: string; + paymentProduct302SpecificInput?: PaymentProduct320SpecificInput; } diff --git a/src/models/MobilePaymentMethodSpecificOutput.ts b/src/models/MobilePaymentMethodSpecificOutput.ts index 73d5da8..509d8f6 100644 --- a/src/models/MobilePaymentMethodSpecificOutput.ts +++ b/src/models/MobilePaymentMethodSpecificOutput.ts @@ -1,75 +1,18 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CardFraudResults } from './CardFraudResults.js'; +import type { ThreeDSecureResults } from './ThreeDSecureResults.js'; -import { CardFraudResults } from './CardFraudResults.js'; -import { ThreeDSecureResults } from './ThreeDSecureResults.js'; - -/** - * Object containing the mobile payment method details. - */ -export class MobilePaymentMethodSpecificOutput { - /** - * Payment product identifier - please check product documentation for a full overview of possible values. - */ - 'paymentProductId'?: number; - /** - * Card Authorization code as returned by the acquirer - */ - 'authorisationCode'?: string; - 'fraudResults'?: CardFraudResults; - 'threeDSecureResults'?: ThreeDSecureResults; +/** @description Object containing the mobile payment method details. */ +export interface MobilePaymentMethodSpecificOutput { /** - * The card network that was used for a mobile payment method operation + * Format: int32 + * @description Payment product identifier - please check product documentation for a full overview of possible values. + * @example 302 */ - 'network'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'paymentProductId', - baseName: 'paymentProductId', - type: 'number', - format: 'int32', - }, - { - name: 'authorisationCode', - baseName: 'authorisationCode', - type: 'string', - format: '', - }, - { - name: 'fraudResults', - baseName: 'fraudResults', - type: 'CardFraudResults', - format: '', - }, - { - name: 'threeDSecureResults', - baseName: 'threeDSecureResults', - type: 'ThreeDSecureResults', - format: '', - }, - { - name: 'network', - baseName: 'network', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return MobilePaymentMethodSpecificOutput.attributeTypeMap; - } - - public constructor() {} + paymentProductId?: number; + /** @description Card Authorization code as returned by the acquirer */ + authorisationCode?: string; + fraudResults?: CardFraudResults; + threeDSecureResults?: ThreeDSecureResults; + /** @description The card network that was used for a mobile payment method operation */ + network?: string; } diff --git a/src/models/Network.ts b/src/models/Network.ts new file mode 100644 index 0000000..ec855ca --- /dev/null +++ b/src/models/Network.ts @@ -0,0 +1,11 @@ +/** + * @example GIROCARD + */ +export enum Network { + MASTERCARD = 'MASTERCARD', + VISA = 'VISA', + AMEX = 'AMEX', + GIROCARD = 'GIROCARD', + DISCOVER = 'DISCOVER', + JCB = 'JCB', +} diff --git a/src/models/Order.ts b/src/models/Order.ts index b6aadf0..8f24f3b 100644 --- a/src/models/Order.ts +++ b/src/models/Order.ts @@ -1,69 +1,14 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { AmountOfMoney } from './AmountOfMoney.js'; -import { Customer } from './Customer.js'; -import { References } from './References.js'; -import { Shipping } from './Shipping.js'; -import { ShoppingCartInput } from './ShoppingCartInput.js'; - -/** - * Order object containing order related data Please note that this object is required to be able to submit the amount. - */ -export class Order { - 'amountOfMoney'?: AmountOfMoney; - 'customer'?: Customer; - 'references': References; - 'shipping'?: Shipping; - 'shoppingCart'?: ShoppingCartInput; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'amountOfMoney', - baseName: 'amountOfMoney', - type: 'AmountOfMoney', - format: '', - }, - { - name: 'customer', - baseName: 'customer', - type: 'Customer', - format: '', - }, - { - name: 'references', - baseName: 'references', - type: 'References', - format: '', - }, - { - name: 'shipping', - baseName: 'shipping', - type: 'Shipping', - format: '', - }, - { - name: 'shoppingCart', - baseName: 'shoppingCart', - type: 'ShoppingCartInput', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return Order.attributeTypeMap; - } - - public constructor() {} +import type { AmountOfMoney } from './AmountOfMoney.js'; +import type { Customer } from './Customer.js'; +import type { References } from './References.js'; +import type { Shipping } from './Shipping.js'; +import type { ShoppingCartInput } from './ShoppingCartInput.js'; + +/** @description Order object containing order related data Please note that this object is required to be able to submit the amount. */ +export interface Order { + amountOfMoney?: AmountOfMoney; + customer?: Customer; + references: References; + shipping?: Shipping; + shoppingCart?: ShoppingCartInput; } diff --git a/src/models/OrderItem.ts b/src/models/OrderItem.ts index 80dd092..7f701ee 100644 --- a/src/models/OrderItem.ts +++ b/src/models/OrderItem.ts @@ -1,48 +1,17 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Items should only be provided for orderType = PARTIAL - */ -export class OrderItem { +/** @description Items should only be provided for orderType = PARTIAL */ +export interface OrderItem { /** - * Id of the item from the ShoppingCart. The id will be returned in the response from create Checkout request. + * Format: UUID + * @description Id of the item from the ShoppingCart. The id will be returned in the response from create Checkout request. + * @example 4f0c512e-f12c-11ec-8ea0-0242ac120002 */ - 'id': string; + id: string; /** - * Quantity of the specific item. Must be greater than zero. Note: Must not be all spaces or all zeros + * Format: int64 + * @description Quantity of the specific item. Must be greater than zero. + * Note: Must not be all spaces or all zeros + * + * @example 1 */ - 'quantity': number; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'id', - baseName: 'id', - type: 'string', - format: 'UUID', - }, - { - name: 'quantity', - baseName: 'quantity', - type: 'number', - format: 'int64', - }, - ]; - - static getAttributeTypeMap() { - return OrderItem.attributeTypeMap; - } - - public constructor() {} + quantity: number; } diff --git a/src/models/OrderLineDetailsInput.ts b/src/models/OrderLineDetailsInput.ts index 9f3384d..f88b47e 100644 --- a/src/models/OrderLineDetailsInput.ts +++ b/src/models/OrderLineDetailsInput.ts @@ -1,117 +1,59 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { ProductType } from './ProductType.js'; -import { ProductType } from './ProductType.js'; - -/** - * Object containing additional information that when supplied can have a beneficial effect on the discountrates. - */ -export class OrderLineDetailsInput { +/** @description Object containing additional information that when supplied can have a beneficial effect on the discountrates. */ +export interface OrderLineDetailsInput { /** - * Product or UPC Code + * @description Product or UPC Code + * @example ASP01 */ - 'productCode'?: string; + productCode?: string; /** - * The price of one unit of the product, the value should be zero or greater. + * Format: int64 + * @description The price of one unit of the product, the value should be zero or greater. + * @example 480 */ - 'productPrice': number; - 'productType'?: ProductType; + productPrice: number; + productType?: ProductType; /** - * Quantity of the units being purchased, should be greater than zero Note: Must not be all spaces or all zeros + * Format: int64 + * @description Quantity of the units being purchased, should be greater than zero + * Note: Must not be all spaces or all zeros + * @example 1 */ - 'quantity': number; + quantity: number; /** - * Tax on the line item, with the last two digits implied as decimal places + * Format: int64 + * @description Tax on the line item, with the last two digits implied as decimal places + * @example 0 */ - 'taxAmount'?: number; + taxAmount?: number; /** - * URL of the product in shop. Used for PAYONE Buy Now, Pay Later (BNPL). + * Format: uri + * @description URL of the product in shop. + * + * Used for PAYONE Buy Now, Pay Later (BNPL). + * @example https://shop.url/watches/watch01 */ - 'productUrl'?: string; + productURL?: string; /** - * URL of a product image. Used for PAYONE Buy Now, Pay Later (BNPL). + * Format: uri + * @description URL of a product image. + * + * Used for PAYONE Buy Now, Pay Later (BNPL). + * @example https://shop.url/watches/watch01.jpg */ - 'productImageUrl'?: string; + productImageUrl?: string; /** - * Category path of the item. Used for PAYONE Buy Now, Pay Later (BNPL). + * @description Category path of the item. + * + * Used for PAYONE Buy Now, Pay Later (BNPL). + * @example Watches > Smartwatches */ - 'productCategoryPath'?: string; + productCategoryPath?: string; /** - * Optional parameter to define the delivery shop or touchpoint where an item has been collected (e.g. for Click & Collect or Click & Reserve). + * @description Optional parameter to define the delivery shop or touchpoint where an item has been collected (e.g. for + * Click & Collect or Click & Reserve). + * @example Store-12345 */ - 'merchantShopDeliveryReference'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'productCode', - baseName: 'productCode', - type: 'string', - format: '', - }, - { - name: 'productPrice', - baseName: 'productPrice', - type: 'number', - format: 'int64', - }, - { - name: 'productType', - baseName: 'productType', - type: 'ProductType', - format: '', - }, - { - name: 'quantity', - baseName: 'quantity', - type: 'number', - format: 'int64', - }, - { - name: 'taxAmount', - baseName: 'taxAmount', - type: 'number', - format: 'int64', - }, - { - name: 'productUrl', - baseName: 'productUrl', - type: 'string', - format: 'uri', - }, - { - name: 'productImageUrl', - baseName: 'productImageUrl', - type: 'string', - format: 'uri', - }, - { - name: 'productCategoryPath', - baseName: 'productCategoryPath', - type: 'string', - format: '', - }, - { - name: 'merchantShopDeliveryReference', - baseName: 'merchantShopDeliveryReference', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return OrderLineDetailsInput.attributeTypeMap; - } - - public constructor() {} + merchantShopDeliveryReference?: string; } diff --git a/src/models/OrderLineDetailsPatch.ts b/src/models/OrderLineDetailsPatch.ts index c2bab26..3f02281 100644 --- a/src/models/OrderLineDetailsPatch.ts +++ b/src/models/OrderLineDetailsPatch.ts @@ -1,135 +1,13 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CartItemOrderStatus } from './CartItemOrderStatus.js'; +import type { OrderLineDetailsInput } from './OrderLineDetailsInput.js'; -import { CartItemOrderStatus } from './CartItemOrderStatus.js'; -import { ProductType } from './ProductType.js'; - -/** - * Object containing additional information that when supplied can have a beneficial effect on the discountrates. - */ -export class OrderLineDetailsPatch { - /** - * Unique identifier of a cart item - */ - 'id'?: string; - 'status'?: Array; - /** - * Product or UPC Code - */ - 'productCode'?: string; - /** - * The price of one unit of the product, the value should be zero or greater. - */ - 'productPrice': number; - 'productType'?: ProductType; - /** - * Quantity of the units being purchased, should be greater than zero Note: Must not be all spaces or all zeros - */ - 'quantity': number; - /** - * Tax on the line item, with the last two digits implied as decimal places - */ - 'taxAmount'?: number; +/** @description Object containing additional information that when supplied can have a beneficial effect on the discountrates. */ +export interface OrderLineDetailsPatch extends OrderLineDetailsInput { /** - * URL of the product in shop. Used for PAYONE Buy Now, Pay Later (BNPL). + * Format: UUID + * @description Unique identifier of a cart item + * @example 7a3444d3-f6ce-4b6e-b6c4-2486a160cf19 */ - 'productUrl'?: string; - /** - * URL of a product image. Used for PAYONE Buy Now, Pay Later (BNPL). - */ - 'productImageUrl'?: string; - /** - * Category path of the item. Used for PAYONE Buy Now, Pay Later (BNPL). - */ - 'productCategoryPath'?: string; - /** - * Optional parameter to define the delivery shop or touchpoint where an item has been collected (e.g. for Click & Collect or Click & Reserve). - */ - 'merchantShopDeliveryReference'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'id', - baseName: 'id', - type: 'string', - format: 'UUID', - }, - { - name: 'status', - baseName: 'status', - type: 'Array', - format: '', - }, - { - name: 'productCode', - baseName: 'productCode', - type: 'string', - format: '', - }, - { - name: 'productPrice', - baseName: 'productPrice', - type: 'number', - format: 'int64', - }, - { - name: 'productType', - baseName: 'productType', - type: 'ProductType', - format: '', - }, - { - name: 'quantity', - baseName: 'quantity', - type: 'number', - format: 'int64', - }, - { - name: 'taxAmount', - baseName: 'taxAmount', - type: 'number', - format: 'int64', - }, - { - name: 'productUrl', - baseName: 'productUrl', - type: 'string', - format: 'uri', - }, - { - name: 'productImageUrl', - baseName: 'productImageUrl', - type: 'string', - format: 'uri', - }, - { - name: 'productCategoryPath', - baseName: 'productCategoryPath', - type: 'string', - format: '', - }, - { - name: 'merchantShopDeliveryReference', - baseName: 'merchantShopDeliveryReference', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return OrderLineDetailsPatch.attributeTypeMap; - } - - public constructor() {} + id?: string; + status?: CartItemOrderStatus[]; } diff --git a/src/models/OrderLineDetailsResult.ts b/src/models/OrderLineDetailsResult.ts index b3a6ae4..bd70978 100644 --- a/src/models/OrderLineDetailsResult.ts +++ b/src/models/OrderLineDetailsResult.ts @@ -1,135 +1,13 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CartItemOrderStatus } from './CartItemOrderStatus.js'; +import type { OrderLineDetailsInput } from './OrderLineDetailsInput.js'; -import { CartItemOrderStatus } from './CartItemOrderStatus.js'; -import { ProductType } from './ProductType.js'; - -/** - * Object containing additional information that when supplied can have a beneficial effect on the discountrates. - */ -export class OrderLineDetailsResult { - /** - * Unique identifier of a cart item - */ - 'id'?: string; - 'status'?: Array; - /** - * Product or UPC Code - */ - 'productCode'?: string; - /** - * The price of one unit of the product, the value should be zero or greater. - */ - 'productPrice': number; - 'productType'?: ProductType; - /** - * Quantity of the units being purchased, should be greater than zero Note: Must not be all spaces or all zeros - */ - 'quantity': number; - /** - * Tax on the line item, with the last two digits implied as decimal places - */ - 'taxAmount'?: number; +/** @description Object containing additional information that when supplied can have a beneficial effect on the discountrates. */ +export interface OrderLineDetailsResult extends OrderLineDetailsInput { /** - * URL of the product in shop. Used for PAYONE Buy Now, Pay Later (BNPL). + * Format: UUID + * @description Unique identifier of a cart item + * @example 7a3444d3-f6ce-4b6e-b6c4-2486a160cf19 */ - 'productUrl'?: string; - /** - * URL of a product image. Used for PAYONE Buy Now, Pay Later (BNPL). - */ - 'productImageUrl'?: string; - /** - * Category path of the item. Used for PAYONE Buy Now, Pay Later (BNPL). - */ - 'productCategoryPath'?: string; - /** - * Optional parameter to define the delivery shop or touchpoint where an item has been collected (e.g. for Click & Collect or Click & Reserve). - */ - 'merchantShopDeliveryReference'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'id', - baseName: 'id', - type: 'string', - format: 'UUID', - }, - { - name: 'status', - baseName: 'status', - type: 'Array', - format: '', - }, - { - name: 'productCode', - baseName: 'productCode', - type: 'string', - format: '', - }, - { - name: 'productPrice', - baseName: 'productPrice', - type: 'number', - format: 'int64', - }, - { - name: 'productType', - baseName: 'productType', - type: 'ProductType', - format: '', - }, - { - name: 'quantity', - baseName: 'quantity', - type: 'number', - format: 'int64', - }, - { - name: 'taxAmount', - baseName: 'taxAmount', - type: 'number', - format: 'int64', - }, - { - name: 'productUrl', - baseName: 'productUrl', - type: 'string', - format: 'uri', - }, - { - name: 'productImageUrl', - baseName: 'productImageUrl', - type: 'string', - format: 'uri', - }, - { - name: 'productCategoryPath', - baseName: 'productCategoryPath', - type: 'string', - format: '', - }, - { - name: 'merchantShopDeliveryReference', - baseName: 'merchantShopDeliveryReference', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return OrderLineDetailsResult.attributeTypeMap; - } - - public constructor() {} + id?: string; + status?: CartItemOrderStatus[]; } diff --git a/src/models/OrderRequest.ts b/src/models/OrderRequest.ts index 51be08f..facf9d9 100644 --- a/src/models/OrderRequest.ts +++ b/src/models/OrderRequest.ts @@ -1,61 +1,21 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { OrderItem } from './OrderItem.js'; -import { OrderType } from './OrderType.js'; -import { PaymentMethodSpecificInput } from './PaymentMethodSpecificInput.js'; -import { References } from './References.js'; +import type { OrderItem } from './OrderItem.js'; +import type { OrderType } from './OrderType.js'; +import type { PaymentMethodSpecificInput } from './PaymentMethodSpecificInput.js'; +import type { References } from './References.js'; /** - * Request to execute an Order for the corresponding Checkout for a specific payment method. The provided data from the Commerce Case and the Checkout regarding customer, shipping, and ShoppingCart will be automatically loaded and used for the Payment Execution. In case the paymentMethodSpecificInput has already been provided when creating the Commerce Case or Checkout, this input will automatically be used. An Order can be created for a full or the partial ShoppingCart of the Checkout. For a partial Order a list of items must be provided. The platform will automatically calculate the respective amount to trigger the payment execution. + * @description Request to execute an Order for the corresponding Checkout for a specific payment method. + * The provided data from the Commerce Case and the Checkout regarding customer, shipping, and ShoppingCart will be + * automatically loaded and used for the Payment Execution. + * In case the paymentMethodSpecificInput has already been provided when creating the Commerce Case or Checkout, + * this input will automatically be used. + * An Order can be created for a full or the partial ShoppingCart of the Checkout. For a partial Order a list of + * items must be provided. The platform will automatically calculate the respective amount to trigger the payment + * execution. */ -export class OrderRequest { - 'orderType'?: OrderType; - 'orderReferences'?: References; - 'items'?: Array; - 'paymentMethodSpecificInput'?: PaymentMethodSpecificInput; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'orderType', - baseName: 'orderType', - type: 'OrderType', - format: '', - }, - { - name: 'orderReferences', - baseName: 'orderReferences', - type: 'References', - format: '', - }, - { - name: 'items', - baseName: 'items', - type: 'Array', - format: '', - }, - { - name: 'paymentMethodSpecificInput', - baseName: 'paymentMethodSpecificInput', - type: 'PaymentMethodSpecificInput', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return OrderRequest.attributeTypeMap; - } - - public constructor() {} +export interface OrderRequest { + orderType?: OrderType; + orderReferences?: References; + items?: OrderItem[]; + paymentMethodSpecificInput?: PaymentMethodSpecificInput; } diff --git a/src/models/OrderResponse.ts b/src/models/OrderResponse.ts index 6d24f28..8afac3c 100644 --- a/src/models/OrderResponse.ts +++ b/src/models/OrderResponse.ts @@ -10,36 +10,11 @@ * Do not edit the class manually. */ -import { CreatePaymentResponse } from './CreatePaymentResponse.js'; -import { ShoppingCartResult } from './ShoppingCartResult.js'; +import type { CreatePaymentResponse } from './CreatePaymentResponse.js'; +import type { ShoppingCartResult } from './ShoppingCartResult.js'; -/** - * Object that contains details on the created payment in case one has been created. - */ -export class OrderResponse { - 'createPaymentResponse'?: CreatePaymentResponse; - 'shoppingCart'?: ShoppingCartResult; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'createPaymentResponse', - baseName: 'createPaymentResponse', - type: 'CreatePaymentResponse', - format: '', - }, - { - name: 'shoppingCart', - baseName: 'shoppingCart', - type: 'ShoppingCartResult', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return OrderResponse.attributeTypeMap; - } - - public constructor() {} +/** @description Object that contains details on the created payment in case one has been created. */ +export interface OrderResponse { + createPaymentResponse?: CreatePaymentResponse; + shoppingCart?: ShoppingCartResult; } diff --git a/src/models/OrderType.ts b/src/models/OrderType.ts index 1af3831..1597430 100644 --- a/src/models/OrderType.ts +++ b/src/models/OrderType.ts @@ -1,17 +1,7 @@ /** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * The orderType refers to the ShoppingCart of the Checkout. orderType = FULL should be provided if a payment for the entire ShoppingCart should be created. orderType = PARTIAL should be provided if the payment should be created only for certain items of the ShoppingCart. For this type the list of items has to be provided. Following conditions apply to the Order request: * amount of the Checkout can not be zero * the ShoppingCart cannot be empty * for orderType = FULL the Checkout status is OPEN, there is no other order and/or Payment Execution and no items should be provided in the body * if no paymentMethodSpecificInput has been provided in the creation of the Commerce Case or Checkout it has to be provided in this request + * The orderType refers to the ShoppingCart of the Checkout. + * - orderType = FULL should be provided if a payment for the entire ShoppingCart should be created. + * - orderType = PARTIAL should be provided if the payment should be created only for certain items of the ShoppingCart. For this type the list of items has to be provided. Following conditions apply to the Order request: * amount of the Checkout can not be zero * the ShoppingCart cannot be empty * for orderType = FULL the Checkout status is OPEN, there is no other order and/or Payment Execution and no items should be provided in the body * if no paymentMethodSpecificInput has been provided in the creation of the Commerce Case or Checkout it has to be provided in this request */ export enum OrderType { Full = 'FULL', diff --git a/src/models/PatchCheckoutRequest.ts b/src/models/PatchCheckoutRequest.ts index 6fa3c14..42d1641 100644 --- a/src/models/PatchCheckoutRequest.ts +++ b/src/models/PatchCheckoutRequest.ts @@ -1,77 +1,25 @@ +import type { AmountOfMoney } from './AmountOfMoney.js'; +import type { CheckoutReferences } from './CheckoutReferences.js'; +import type { PaymentMethodSpecificInput } from './PaymentMethodSpecificInput.js'; +import type { References } from './References.js'; +import type { Shipping } from './Shipping.js'; +import type { ShoppingCartPatch } from './ShoppingCartPatch.js'; + /** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 + * @description An existing shopping cart of a Checkout will not be overwritten with the Patch request. + * New items can be added to the shoppingCart by providing them in the request. + * To change existing items (delete, modify or add), the respective itemId must be provided. An item can be completely removed if quantity = 0 is provided. * + * The price of an item can be changed as long as no payment has happened for this item (i.e. as long as an item has no specific status). + * Items with a status can no longer be removed entirely, however the quantity can be increased or decreased (for items without payment) by using the itemId. * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { AmountOfMoney } from './AmountOfMoney.js'; -import { CheckoutReferences } from './CheckoutReferences.js'; -import { PaymentMethodSpecificInput } from './PaymentMethodSpecificInput.js'; -import { References } from './References.js'; -import { Shipping } from './Shipping.js'; -import { ShoppingCartPatch } from './ShoppingCartPatch.js'; - -/** - * An existing shopping cart of a Checkout will not be overwritten with the Patch request. New items can be added to the shoppingCart by providing them in the request. To change existing items (delete, modify or add), the respective itemId must be provided. An item can be completely removed if quantity = 0 is provided. The price of an item can be changed as long as no payment has happened for this item (i.e. as long as an item has no specific status). Items with a status can no longer be removed entirely, however the quantity can be increased or decreased (for items without payment) by using the itemId. If no amountOfMoney for the Checkout is provided, the platform will calculate the respective amount based on the cartItem productPrice and productQuantity. + * If no amountOfMoney for the Checkout is provided, the platform will calculate the respective amount based on the cartItem productPrice and productQuantity. */ -export class PatchCheckoutRequest { - 'amountOfMoney'?: AmountOfMoney; - 'references'?: CheckoutReferences; - 'shipping'?: Shipping; - 'shoppingCart'?: ShoppingCartPatch; - 'paymentMethodSpecificInput'?: PaymentMethodSpecificInput; - 'paymentReferences'?: References; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'amountOfMoney', - baseName: 'amountOfMoney', - type: 'AmountOfMoney', - format: '', - }, - { - name: 'references', - baseName: 'references', - type: 'CheckoutReferences', - format: '', - }, - { - name: 'shipping', - baseName: 'shipping', - type: 'Shipping', - format: '', - }, - { - name: 'shoppingCart', - baseName: 'shoppingCart', - type: 'ShoppingCartPatch', - format: '', - }, - { - name: 'paymentMethodSpecificInput', - baseName: 'paymentMethodSpecificInput', - type: 'PaymentMethodSpecificInput', - format: '', - }, - { - name: 'paymentReferences', - baseName: 'paymentReferences', - type: 'References', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PatchCheckoutRequest.attributeTypeMap; - } - - public constructor() {} +export interface PatchCheckoutRequest { + amountOfMoney?: AmountOfMoney; + references?: CheckoutReferences; + shipping?: Shipping; + shoppingCart?: ShoppingCartPatch; + paymentMethodSpecificInput?: PaymentMethodSpecificInput; + paymentReferences?: References; } diff --git a/src/models/PatchCommerceCaseRequest.ts b/src/models/PatchCommerceCaseRequest.ts index 1639a17..c1215e1 100644 --- a/src/models/PatchCommerceCaseRequest.ts +++ b/src/models/PatchCommerceCaseRequest.ts @@ -1,37 +1,6 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { Customer } from './Customer.js'; -import { Customer } from './Customer.js'; - -/** - * Update the customer data of the given Commerce Case - */ -export class PatchCommerceCaseRequest { - 'customer'?: Customer; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'customer', - baseName: 'customer', - type: 'Customer', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PatchCommerceCaseRequest.attributeTypeMap; - } - - public constructor() {} +/** @description Update the customer data of the given Commerce Case */ +export interface PatchCommerceCaseRequest { + customer?: Customer; } diff --git a/src/models/PaymentChannel.ts b/src/models/PaymentChannel.ts index f21fdcd..2a98c14 100644 --- a/src/models/PaymentChannel.ts +++ b/src/models/PaymentChannel.ts @@ -1,15 +1,3 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - export enum PaymentChannel { Ecommerce = 'ECOMMERCE', Pos = 'POS', diff --git a/src/models/PaymentCreationOutput.ts b/src/models/PaymentCreationOutput.ts index 0cb25dd..086ccf7 100644 --- a/src/models/PaymentCreationOutput.ts +++ b/src/models/PaymentCreationOutput.ts @@ -1,38 +1,8 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Object containing the details of the created payment. - */ -export class PaymentCreationOutput { +/** @description Object containing the details of the created payment. */ +export interface PaymentCreationOutput { /** - * The external reference is an identifier for this transaction and can be used for reconciliation purposes. + * @description The external reference is an identifier for this transaction and can be used for reconciliation purposes. + * @example C1232O2342 */ - 'externalReference'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'externalReference', - baseName: 'externalReference', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PaymentCreationOutput.attributeTypeMap; - } - - public constructor() {} + externalReference?: string; } diff --git a/src/models/PaymentEvent.ts b/src/models/PaymentEvent.ts index 0d922d9..01e7965 100644 --- a/src/models/PaymentEvent.ts +++ b/src/models/PaymentEvent.ts @@ -1,71 +1,17 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { AmountOfMoney } from './AmountOfMoney.js'; +import type { CancellationReason } from './CancellationReason.js'; +import type { PaymentType } from './PaymentType.js'; +import type { StatusValue } from './StatusValue.js'; -import { AmountOfMoney } from './AmountOfMoney.js'; -import { CancellationReason } from './CancellationReason.js'; -import { PaymentType } from './PaymentType.js'; -import { StatusValue } from './StatusValue.js'; - -/** - * Detailed information regarding an occurred payment event. - */ -export class PaymentEvent { - 'type'?: PaymentType; - 'amountOfMoney'?: AmountOfMoney; - 'paymentStatus'?: StatusValue; - 'cancellationReason'?: CancellationReason; +/** @description Detailed information regarding an occurred payment event. */ +export interface PaymentEvent { + type?: PaymentType; + amountOfMoney?: AmountOfMoney; + paymentStatus?: StatusValue; + cancellationReason?: CancellationReason; /** - * Reason of the Refund (e.g. communicated by or to the costumer). + * @description Reason of the Refund (e.g. communicated by or to the costumer). + * @example Customer complained */ - 'returnReason'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'type', - baseName: 'type', - type: 'PaymentType', - format: '', - }, - { - name: 'amountOfMoney', - baseName: 'amountOfMoney', - type: 'AmountOfMoney', - format: '', - }, - { - name: 'paymentStatus', - baseName: 'paymentStatus', - type: 'StatusValue', - format: '', - }, - { - name: 'cancellationReason', - baseName: 'cancellationReason', - type: 'CancellationReason', - format: '', - }, - { - name: 'returnReason', - baseName: 'returnReason', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PaymentEvent.attributeTypeMap; - } - - public constructor() {} + returnReason?: string; } diff --git a/src/models/PaymentExecution.ts b/src/models/PaymentExecution.ts index 76ed3d4..3740947 100644 --- a/src/models/PaymentExecution.ts +++ b/src/models/PaymentExecution.ts @@ -1,113 +1,31 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CardPaymentMethodSpecificInput } from './CardPaymentMethodSpecificInput.js'; +import type { FinancingPaymentMethodSpecificInput } from './FinancingPaymentMethodSpecificInput.js'; +import type { MobilePaymentMethodSpecificInput } from './MobilePaymentMethodSpecificInput.js'; +import type { PaymentChannel } from './PaymentChannel.js'; +import type { PaymentEvent } from './PaymentEvent.js'; +import type { RedirectPaymentMethodSpecificInput } from './RedirectPaymentMethodSpecificInput.js'; +import type { References } from './References.js'; +import type { SepaDirectDebitPaymentMethodSpecificInput } from './SepaDirectDebitPaymentMethodSpecificInput.js'; -import { CardPaymentMethodSpecificInput } from './CardPaymentMethodSpecificInput.js'; -import { FinancingPaymentMethodSpecificInput } from './FinancingPaymentMethodSpecificInput.js'; -import { MobilePaymentMethodSpecificInput } from './MobilePaymentMethodSpecificInput.js'; -import { PaymentChannel } from './PaymentChannel.js'; -import { PaymentEvent } from './PaymentEvent.js'; -import { RedirectPaymentMethodSpecificInput } from './RedirectPaymentMethodSpecificInput.js'; -import { References } from './References.js'; -import { SepaDirectDebitPaymentMethodSpecificInput } from './SepaDirectDebitPaymentMethodSpecificInput.js'; - -/** - * Object contains information of the payment with a specific payment method. - */ -export class PaymentExecution { +/** @description Object contains information of the payment with a specific payment method. */ +export interface PaymentExecution { /** - * Unique ID of paymentExecution. + * Format: UUID + * @description Unique ID of paymentExecution. + * @example 4f0c512e-f12c-11ec-8ea0-0242ac120002 */ - 'paymentExecutionId'?: string; + paymentExecutionId?: string; /** - * Unique payment transaction identifier of the payment gateway. + * @description Unique payment transaction identifier of the payment gateway. + * @example 3066019730_1 */ - 'paymentId'?: string; - 'cardPaymentMethodSpecificInput'?: CardPaymentMethodSpecificInput; - 'mobilePaymentMethodSpecificInput'?: MobilePaymentMethodSpecificInput; - 'redirectPaymentMethodSpecificInput'?: RedirectPaymentMethodSpecificInput; - 'sepaDirectDebitPaymentMethodSpecificInput'?: SepaDirectDebitPaymentMethodSpecificInput; - 'financingPaymentMethodSpecificInput'?: FinancingPaymentMethodSpecificInput; - 'paymentChannel'?: PaymentChannel; - 'references'?: References; - 'events'?: Array; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'paymentExecutionId', - baseName: 'paymentExecutionId', - type: 'string', - format: 'UUID', - }, - { - name: 'paymentId', - baseName: 'paymentId', - type: 'string', - format: '', - }, - { - name: 'cardPaymentMethodSpecificInput', - baseName: 'cardPaymentMethodSpecificInput', - type: 'CardPaymentMethodSpecificInput', - format: '', - }, - { - name: 'mobilePaymentMethodSpecificInput', - baseName: 'mobilePaymentMethodSpecificInput', - type: 'MobilePaymentMethodSpecificInput', - format: '', - }, - { - name: 'redirectPaymentMethodSpecificInput', - baseName: 'redirectPaymentMethodSpecificInput', - type: 'RedirectPaymentMethodSpecificInput', - format: '', - }, - { - name: 'sepaDirectDebitPaymentMethodSpecificInput', - baseName: 'sepaDirectDebitPaymentMethodSpecificInput', - type: 'SepaDirectDebitPaymentMethodSpecificInput', - format: '', - }, - { - name: 'financingPaymentMethodSpecificInput', - baseName: 'financingPaymentMethodSpecificInput', - type: 'FinancingPaymentMethodSpecificInput', - format: '', - }, - { - name: 'paymentChannel', - baseName: 'paymentChannel', - type: 'PaymentChannel', - format: '', - }, - { - name: 'references', - baseName: 'references', - type: 'References', - format: '', - }, - { - name: 'events', - baseName: 'events', - type: 'Array', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PaymentExecution.attributeTypeMap; - } - - public constructor() {} + paymentId?: string; + cardPaymentMethodSpecificInput?: CardPaymentMethodSpecificInput; + mobilePaymentMethodSpecificInput?: MobilePaymentMethodSpecificInput; + redirectPaymentMethodSpecificInput?: RedirectPaymentMethodSpecificInput; + sepaDirectDebitPaymentMethodSpecificInput?: SepaDirectDebitPaymentMethodSpecificInput; + financingPaymentMethodSpecificInput?: FinancingPaymentMethodSpecificInput; + paymentChannel?: PaymentChannel; + references?: References; + events?: PaymentEvent[]; } diff --git a/src/models/PaymentExecutionRequest.ts b/src/models/PaymentExecutionRequest.ts index 1fa934b..070b8f6 100644 --- a/src/models/PaymentExecutionRequest.ts +++ b/src/models/PaymentExecutionRequest.ts @@ -1,45 +1,14 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { PaymentExecutionSpecificInput } from './PaymentExecutionSpecificInput.js'; -import { PaymentMethodSpecificInput } from './PaymentMethodSpecificInput.js'; +import type { PaymentExecutionSpecificInput } from './PaymentExecutionSpecificInput.js'; +import type { PaymentMethodSpecificInput } from './PaymentMethodSpecificInput.js'; /** - * Request to trigger a payment for a respective Checkout providing the input for a specific payment method. The data from the Commerce case and the Checkout will not be loaded automatically and there is no validation between the data input in place. Depending on the payment method, information of the customer and / or the shopping cart might be required. For more details regarding payment method specific input please check the documentation. + * @description Request to trigger a payment for a respective Checkout providing the input for a specific payment method. + * The data from the Commerce case and the Checkout will not be loaded automatically and there is no validation + * between the data input in place. + * Depending on the payment method, information of the customer and / or the shopping cart might be required. + * For more details regarding payment method specific input please check the documentation. */ -export class PaymentExecutionRequest { - 'paymentMethodSpecificInput'?: PaymentMethodSpecificInput; - 'paymentExecutionSpecificInput'?: PaymentExecutionSpecificInput; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'paymentMethodSpecificInput', - baseName: 'paymentMethodSpecificInput', - type: 'PaymentMethodSpecificInput', - format: '', - }, - { - name: 'paymentExecutionSpecificInput', - baseName: 'paymentExecutionSpecificInput', - type: 'PaymentExecutionSpecificInput', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PaymentExecutionRequest.attributeTypeMap; - } - - public constructor() {} +export interface PaymentExecutionRequest { + paymentMethodSpecificInput?: PaymentMethodSpecificInput; + paymentExecutionSpecificInput?: PaymentExecutionSpecificInput; } diff --git a/src/models/PaymentExecutionSpecificInput.ts b/src/models/PaymentExecutionSpecificInput.ts index 061528e..e4e1116 100644 --- a/src/models/PaymentExecutionSpecificInput.ts +++ b/src/models/PaymentExecutionSpecificInput.ts @@ -1,53 +1,17 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { AmountOfMoney } from './AmountOfMoney.js'; -import { References } from './References.js'; -import { ShoppingCartInput } from './ShoppingCartInput.js'; +import type { AmountOfMoney } from './AmountOfMoney.js'; +import type { References } from './References.js'; +import type { ShoppingCartInput } from './ShoppingCartInput.js'; /** - * The amount of the paymentSpecificInput might differ from the Checkout amount in case of partial payments but cannot be higher. Additionally, the total amount of the provided shopping cart cannot exceed the Checkout amount. If a different currency is provided than in the Checkout, the payment execution will be declined. Provided details of the customer and shipping from the Checkout will be automatically loaded and used in the Payment Execution request. The ShoppingCart might differ from the one provided in the Checkout (e.g., for partial payments) and might be required by the payment provider (e.g., BNPL). If the ShoppingCart elements differ from the data provided in the Checkout, the existing data will not be overwritten. + * @description The amount of the paymentSpecificInput might differ from the Checkout amount in case of partial payments but cannot be higher. + * Additionally, the total amount of the provided shopping cart cannot exceed the Checkout amount. + * If a different currency is provided than in the Checkout, the payment execution will be declined. + * Provided details of the customer and shipping from the Checkout will be automatically loaded and used in the Payment Execution request. + * The ShoppingCart might differ from the one provided in the Checkout (e.g., for partial payments) and might be required by the payment provider (e.g., BNPL). + * If the ShoppingCart elements differ from the data provided in the Checkout, the existing data will not be overwritten. */ -export class PaymentExecutionSpecificInput { - 'amountOfMoney'?: AmountOfMoney; - 'shoppingCart'?: ShoppingCartInput; - 'paymentReferences': References; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'amountOfMoney', - baseName: 'amountOfMoney', - type: 'AmountOfMoney', - format: '', - }, - { - name: 'shoppingCart', - baseName: 'shoppingCart', - type: 'ShoppingCartInput', - format: '', - }, - { - name: 'paymentReferences', - baseName: 'paymentReferences', - type: 'References', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PaymentExecutionSpecificInput.attributeTypeMap; - } - - public constructor() {} +export interface PaymentExecutionSpecificInput { + amountOfMoney?: AmountOfMoney; + shoppingCart?: ShoppingCartInput; + paymentReferences: References; } diff --git a/src/models/PaymentInformationRequest.ts b/src/models/PaymentInformationRequest.ts index 156e2ab..14bf0ac 100644 --- a/src/models/PaymentInformationRequest.ts +++ b/src/models/PaymentInformationRequest.ts @@ -1,70 +1,22 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { AmountOfMoney } from './AmountOfMoney.js'; +import type { PaymentChannel } from './PaymentChannel.js'; +import type { PaymentType } from './PaymentType.js'; -import { AmountOfMoney } from './AmountOfMoney.js'; -import { PaymentChannel } from './PaymentChannel.js'; -import { PaymentType } from './PaymentType.js'; - -export class PaymentInformationRequest { - 'amountOfMoney': AmountOfMoney; - 'type': PaymentType; - 'paymentChannel': PaymentChannel; +export interface PaymentInformationRequest { + amountOfMoney: AmountOfMoney; + type: PaymentType; + paymentChannel: PaymentChannel; /** - * Payment method identifier - please check the product documentation for a full overview of possible values. + * Format: int32 + * @description Payment method identifier - please check the product documentation for a full overview of possible values. */ - 'paymentProductId': number; + paymentProductId: number; /** - * Unique reference of the PaymentInformation. In case of card present transactions, the reference from the ECR or terminal will be used. It is always the reference for external transactions. (e.g. card present payments, cash payments or payments processed by other payment providers). + * @description Unique reference of the PaymentInformation. In case of card present transactions, the reference from the ECR + * or terminal will be used. It is always the reference for external transactions. + * (e.g. card present payments, cash payments or payments processed by other payment providers). + * + * @example 6a891660b8cf16edaeb26f87d86f0b2f */ - 'merchantReference'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'amountOfMoney', - baseName: 'amountOfMoney', - type: 'AmountOfMoney', - format: '', - }, - { - name: 'type', - baseName: 'type', - type: 'PaymentType', - format: '', - }, - { - name: 'paymentChannel', - baseName: 'paymentChannel', - type: 'PaymentChannel', - format: '', - }, - { - name: 'paymentProductId', - baseName: 'paymentProductId', - type: 'number', - format: 'int32', - }, - { - name: 'merchantReference', - baseName: 'merchantReference', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PaymentInformationRequest.attributeTypeMap; - } - - public constructor() {} + merchantReference?: string; } diff --git a/src/models/PaymentInformationResponse.ts b/src/models/PaymentInformationResponse.ts index 9d60c65..49458d1 100644 --- a/src/models/PaymentInformationResponse.ts +++ b/src/models/PaymentInformationResponse.ts @@ -1,133 +1,58 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CardPaymentDetails } from './CardPaymentDetails.js'; +import type { PaymentChannel } from './PaymentChannel.js'; +import type { PaymentEvent } from './PaymentEvent.js'; -import { CardPaymentDetails } from './CardPaymentDetails.js'; -import { PaymentChannel } from './PaymentChannel.js'; -import { PaymentEvent } from './PaymentEvent.js'; - -/** - * Object containing the related data of the created Payment Information. - */ -export class PaymentInformationResponse { +/** @description Object containing the related data of the created Payment Information. */ +export interface PaymentInformationResponse { /** - * Unique ID of the Commerce Case. + * Format: UUID + * @description Unique ID of the Commerce Case. + * @example 4f0c512e-f12c-11ec-8ea0-0242ac120002 */ - 'commerceCaseId'?: string; + commerceCaseId?: string; /** - * Unique ID of the Commerce Case. + * Format: UUID + * @description Unique ID of the Commerce Case. + * @example 4f0c512e-f12c-11ec-8ea0-0242ac120002 */ - 'checkoutId'?: string; + checkoutId?: string; /** - * Unique identifier of the customer. + * @description Unique identifier of the customer. + * @example 1234 */ - 'merchantCustomerId'?: string; + merchantCustomerId?: string; /** - * Unique ID of the Payment Information. + * Format: UUID + * @description Unique ID of the Payment Information. + * @example 637ef15b-1a0a-48f2-27d8-c954a344329c */ - 'paymentInformationId'?: string; - 'paymentChannel'?: PaymentChannel; + paymentInformationId?: string; + paymentChannel?: PaymentChannel; /** - * Payment product identifier - please check see product documentation for a full overview of possible values. + * Format: int32 + * @description Payment product identifier - please check see product documentation for a full overview of possible values. + * @example 840 */ - 'paymentProductId'?: number; + paymentProductId?: number; /** - * Unique identifier of the POS terminal of the payment transaction. + * @description Unique identifier of the POS terminal of the payment transaction. + * @example 60023723 */ - 'terminalId'?: string; + terminalId?: string; /** - * Unique ID that identifies a store location or transaction point and which refers to the contract number of the merchant accepting the card. + * @description Unique ID that identifies a store location or transaction point and which refers to the contract number of + * the merchant accepting the card. + * @example 455600217015 */ - 'cardAcceptorId'?: string; + cardAcceptorId?: string; /** - * Unique reference of the PaymentInformation. In case of card present transactions, the reference from the ECR or terminal will be used. It is always the reference for external transactions. (e.g. card present payments, cash payments or payments processed by other payment providers). + * @description Unique reference of the PaymentInformation. In case of card present transactions, the reference from the ECR + * or terminal will be used. It is always the reference for external transactions. + * (e.g. card present payments, cash payments or payments processed by other payment providers). + * + * @example 6a891660b8cf16edaeb26f87d86f0b2f */ - 'merchantReference'?: string; - 'cardPaymentDetails'?: CardPaymentDetails; - 'events'?: Array; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'commerceCaseId', - baseName: 'commerceCaseId', - type: 'string', - format: 'UUID', - }, - { - name: 'checkoutId', - baseName: 'checkoutId', - type: 'string', - format: 'UUID', - }, - { - name: 'merchantCustomerId', - baseName: 'merchantCustomerId', - type: 'string', - format: '', - }, - { - name: 'paymentInformationId', - baseName: 'paymentInformationId', - type: 'string', - format: 'UUID', - }, - { - name: 'paymentChannel', - baseName: 'paymentChannel', - type: 'PaymentChannel', - format: '', - }, - { - name: 'paymentProductId', - baseName: 'paymentProductId', - type: 'number', - format: 'int32', - }, - { - name: 'terminalId', - baseName: 'terminalId', - type: 'string', - format: '', - }, - { - name: 'cardAcceptorId', - baseName: 'cardAcceptorId', - type: 'string', - format: '', - }, - { - name: 'merchantReference', - baseName: 'merchantReference', - type: 'string', - format: '', - }, - { - name: 'cardPaymentDetails', - baseName: 'cardPaymentDetails', - type: 'CardPaymentDetails', - format: '', - }, - { - name: 'events', - baseName: 'events', - type: 'Array', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PaymentInformationResponse.attributeTypeMap; - } - - public constructor() {} + merchantReference?: string; + cardPaymentDetails?: CardPaymentDetails; + events?: PaymentEvent[]; } diff --git a/src/models/PaymentMethodSpecificInput.ts b/src/models/PaymentMethodSpecificInput.ts index 5745fa1..ced1afe 100644 --- a/src/models/PaymentMethodSpecificInput.ts +++ b/src/models/PaymentMethodSpecificInput.ts @@ -1,85 +1,23 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { CardPaymentMethodSpecificInput } from './CardPaymentMethodSpecificInput.js'; -import { CustomerDevice } from './CustomerDevice.js'; -import { FinancingPaymentMethodSpecificInput } from './FinancingPaymentMethodSpecificInput.js'; -import { MobilePaymentMethodSpecificInput } from './MobilePaymentMethodSpecificInput.js'; -import { PaymentChannel } from './PaymentChannel.js'; -import { RedirectPaymentMethodSpecificInput } from './RedirectPaymentMethodSpecificInput.js'; -import { SepaDirectDebitPaymentMethodSpecificInput } from './SepaDirectDebitPaymentMethodSpecificInput.js'; +import type { CardPaymentMethodSpecificInput } from './CardPaymentMethodSpecificInput.js'; +import type { CustomerDevice } from './CustomerDevice.js'; +import type { FinancingPaymentMethodSpecificInput } from './FinancingPaymentMethodSpecificInput.js'; +import type { MobilePaymentMethodSpecificInput } from './MobilePaymentMethodSpecificInput.js'; +import type { PaymentChannel } from './PaymentChannel.js'; +import type { RedirectPaymentMethodSpecificInput } from './RedirectPaymentMethodSpecificInput.js'; +import type { SepaDirectDebitPaymentMethodSpecificInput } from './SepaDirectDebitPaymentMethodSpecificInput.js'; /** - * Input for the payment for a respective payment method. In case the paymentMethodSpecificInput has already been provided when creating the Commerce Case or Checkout, it will automatically be used for the Payment Execution. If a new input will be provided, the existing input will be updated. + * @description Input for the payment for a respective payment method. + * In case the paymentMethodSpecificInput has already been provided when creating the Commerce Case or Checkout, it + * will automatically be used for the Payment Execution. + * If a new input will be provided, the existing input will be updated. */ -export class PaymentMethodSpecificInput { - 'cardPaymentMethodSpecificInput'?: CardPaymentMethodSpecificInput; - 'mobilePaymentMethodSpecificInput'?: MobilePaymentMethodSpecificInput; - 'redirectPaymentMethodSpecificInput'?: RedirectPaymentMethodSpecificInput; - 'sepaDirectDebitPaymentMethodSpecificInput'?: SepaDirectDebitPaymentMethodSpecificInput; - 'financingPaymentMethodSpecificInput'?: FinancingPaymentMethodSpecificInput; - 'customerDevice'?: CustomerDevice; - 'paymentChannel'?: PaymentChannel; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'cardPaymentMethodSpecificInput', - baseName: 'cardPaymentMethodSpecificInput', - type: 'CardPaymentMethodSpecificInput', - format: '', - }, - { - name: 'mobilePaymentMethodSpecificInput', - baseName: 'mobilePaymentMethodSpecificInput', - type: 'MobilePaymentMethodSpecificInput', - format: '', - }, - { - name: 'redirectPaymentMethodSpecificInput', - baseName: 'redirectPaymentMethodSpecificInput', - type: 'RedirectPaymentMethodSpecificInput', - format: '', - }, - { - name: 'sepaDirectDebitPaymentMethodSpecificInput', - baseName: 'sepaDirectDebitPaymentMethodSpecificInput', - type: 'SepaDirectDebitPaymentMethodSpecificInput', - format: '', - }, - { - name: 'financingPaymentMethodSpecificInput', - baseName: 'financingPaymentMethodSpecificInput', - type: 'FinancingPaymentMethodSpecificInput', - format: '', - }, - { - name: 'customerDevice', - baseName: 'customerDevice', - type: 'CustomerDevice', - format: '', - }, - { - name: 'paymentChannel', - baseName: 'paymentChannel', - type: 'PaymentChannel', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PaymentMethodSpecificInput.attributeTypeMap; - } - - public constructor() {} +export interface PaymentMethodSpecificInput { + cardPaymentMethodSpecificInput?: CardPaymentMethodSpecificInput; + mobilePaymentMethodSpecificInput?: MobilePaymentMethodSpecificInput; + redirectPaymentMethodSpecificInput?: RedirectPaymentMethodSpecificInput; + sepaDirectDebitPaymentMethodSpecificInput?: SepaDirectDebitPaymentMethodSpecificInput; + financingPaymentMethodSpecificInput?: FinancingPaymentMethodSpecificInput; + customerDevice?: CustomerDevice; + paymentChannel?: PaymentChannel; } diff --git a/src/models/PaymentOutput.ts b/src/models/PaymentOutput.ts index 8892e07..e9eae00 100644 --- a/src/models/PaymentOutput.ts +++ b/src/models/PaymentOutput.ts @@ -1,105 +1,25 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { AmountOfMoney } from './AmountOfMoney.js'; +import type { CardPaymentMethodSpecificOutput } from './CardPaymentMethodSpecificOutput.js'; +import type { FinancingPaymentMethodSpecificOutput } from './FinancingPaymentMethodSpecificOutput.js'; +import type { MobilePaymentMethodSpecificOutput } from './MobilePaymentMethodSpecificOutput.js'; +import type { PaymentReferences } from './PaymentReferences.js'; +import type { RedirectPaymentMethodSpecificOutput } from './RedirectPaymentMethodSpecificOutput.js'; +import type { SepaDirectDebitPaymentMethodSpecificOutput } from './SepaDirectDebitPaymentMethodSpecificOutput.js'; -import { AmountOfMoney } from './AmountOfMoney.js'; -import { CardPaymentMethodSpecificOutput } from './CardPaymentMethodSpecificOutput.js'; -import { FinancingPaymentMethodSpecificOutput } from './FinancingPaymentMethodSpecificOutput.js'; -import { MobilePaymentMethodSpecificOutput } from './MobilePaymentMethodSpecificOutput.js'; -import { PaymentReferences } from './PaymentReferences.js'; -import { RedirectPaymentMethodSpecificOutput } from './RedirectPaymentMethodSpecificOutput.js'; -import { SepaDirectDebitPaymentMethodSpecificOutput } from './SepaDirectDebitPaymentMethodSpecificOutput.js'; - -/** - * Object containing payment details. - */ -export class PaymentOutput { - 'amountOfMoney'?: AmountOfMoney; - /** - * It allows you to store additional parameters for the transaction in JSON format. This field should not contain any personal data. - */ - 'merchantParameters'?: string; - 'references'?: PaymentReferences; - 'cardPaymentMethodSpecificOutput'?: CardPaymentMethodSpecificOutput; - 'mobilePaymentMethodSpecificOutput'?: MobilePaymentMethodSpecificOutput; +/** @description Object containing payment details. */ +export interface PaymentOutput { + amountOfMoney?: AmountOfMoney; /** - * Payment method identifier based on the paymentProductId. + * @description It allows you to store additional parameters for the transaction in JSON format. This field should not contain any personal data. + * @example {'SessionID':'126548354','ShopperID':'7354131'} */ - 'paymentMethod'?: string; - 'redirectPaymentMethodSpecificOutput'?: RedirectPaymentMethodSpecificOutput; - 'sepaDirectDebitPaymentMethodSpecificOutput'?: SepaDirectDebitPaymentMethodSpecificOutput; - 'financingPaymentMethodSpecificOutput'?: FinancingPaymentMethodSpecificOutput; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'amountOfMoney', - baseName: 'amountOfMoney', - type: 'AmountOfMoney', - format: '', - }, - { - name: 'merchantParameters', - baseName: 'merchantParameters', - type: 'string', - format: '', - }, - { - name: 'references', - baseName: 'references', - type: 'PaymentReferences', - format: '', - }, - { - name: 'cardPaymentMethodSpecificOutput', - baseName: 'cardPaymentMethodSpecificOutput', - type: 'CardPaymentMethodSpecificOutput', - format: '', - }, - { - name: 'mobilePaymentMethodSpecificOutput', - baseName: 'mobilePaymentMethodSpecificOutput', - type: 'MobilePaymentMethodSpecificOutput', - format: '', - }, - { - name: 'paymentMethod', - baseName: 'paymentMethod', - type: 'string', - format: '', - }, - { - name: 'redirectPaymentMethodSpecificOutput', - baseName: 'redirectPaymentMethodSpecificOutput', - type: 'RedirectPaymentMethodSpecificOutput', - format: '', - }, - { - name: 'sepaDirectDebitPaymentMethodSpecificOutput', - baseName: 'sepaDirectDebitPaymentMethodSpecificOutput', - type: 'SepaDirectDebitPaymentMethodSpecificOutput', - format: '', - }, - { - name: 'financingPaymentMethodSpecificOutput', - baseName: 'financingPaymentMethodSpecificOutput', - type: 'FinancingPaymentMethodSpecificOutput', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PaymentOutput.attributeTypeMap; - } - - public constructor() {} + merchantParameters?: string; + references?: PaymentReferences; + cardPaymentMethodSpecificOutput?: CardPaymentMethodSpecificOutput; + mobilePaymentMethodSpecificOutput?: MobilePaymentMethodSpecificOutput; + /** @description Payment method identifier based on the paymentProductId. */ + paymentMethod?: string; + redirectPaymentMethodSpecificOutput?: RedirectPaymentMethodSpecificOutput; + sepaDirectDebitPaymentMethodSpecificOutput?: SepaDirectDebitPaymentMethodSpecificOutput; + financingPaymentMethodSpecificOutput?: FinancingPaymentMethodSpecificOutput; } diff --git a/src/models/PaymentProduct320SpecificInput.ts b/src/models/PaymentProduct320SpecificInput.ts index 5e79318..72f0d54 100644 --- a/src/models/PaymentProduct320SpecificInput.ts +++ b/src/models/PaymentProduct320SpecificInput.ts @@ -1,53 +1,8 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { ApplePaymentDataTokenInformation } from './ApplePaymentDataTokenInformation.js'; +import type { Network } from './Network.js'; -import { ApplePaymentDataTokenInformation } from './ApplePaymentDataTokenInformation.js'; - -/** - * Object containing additional Information needed for Apple Pay payment transactions. - */ -export class PaymentProduct320SpecificInput { - 'network'?: PaymentProduct320SpecificInputNetworkEnum; - 'token'?: ApplePaymentDataTokenInformation; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'network', - baseName: 'network', - type: 'PaymentProduct320SpecificInputNetworkEnum', - format: '', - }, - { - name: 'token', - baseName: 'token', - type: 'ApplePaymentDataTokenInformation', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PaymentProduct320SpecificInput.attributeTypeMap; - } - - public constructor() {} -} - -export enum PaymentProduct320SpecificInputNetworkEnum { - Mastercard = 'MASTERCARD', - Visa = 'VISA', - Amex = 'AMEX', - Girocard = 'GIROCARD', - Discover = 'DISCOVER', - Jcb = 'JCB', +/** @description Object containing additional Information needed for Apple Pay payment transactions. */ +export interface PaymentProduct320SpecificInput { + network?: Network; + token?: ApplePaymentDataTokenInformation; } diff --git a/src/models/PaymentProduct3391SpecificInput.ts b/src/models/PaymentProduct3391SpecificInput.ts index 8112cce..13ac86c 100644 --- a/src/models/PaymentProduct3391SpecificInput.ts +++ b/src/models/PaymentProduct3391SpecificInput.ts @@ -1,47 +1,8 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { BankAccountInformation } from './BankAccountInformation.js'; -import { BankAccountInformation } from './BankAccountInformation.js'; - -/** - * Object containing specific information for PAYONE Secured Installment. - */ -export class PaymentProduct3391SpecificInput { - /** - * ID of the selected installment option. Will be provided in the response of the Order / Payment Execution request. - */ - 'installmentOptionId': string; - 'bankAccountInformation': BankAccountInformation; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'installmentOptionId', - baseName: 'installmentOptionId', - type: 'string', - format: '', - }, - { - name: 'bankAccountInformation', - baseName: 'bankAccountInformation', - type: 'BankAccountInformation', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PaymentProduct3391SpecificInput.attributeTypeMap; - } - - public constructor() {} +/** @description Object containing specific information for PAYONE Secured Installment. */ +export interface PaymentProduct3391SpecificInput { + /** @description ID of the selected installment option. Will be provided in the response of the Order / Payment Execution request. */ + installmentOptionId: string; + bankAccountInformation: BankAccountInformation; } diff --git a/src/models/PaymentProduct3391SpecificOutput.ts b/src/models/PaymentProduct3391SpecificOutput.ts index 9019b05..e8c7df4 100644 --- a/src/models/PaymentProduct3391SpecificOutput.ts +++ b/src/models/PaymentProduct3391SpecificOutput.ts @@ -1,40 +1,7 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { InstallmentOption } from './InstallmentOption.js'; -import { InstallmentOption } from './InstallmentOption.js'; - -/** - * Object containing specific information for PAYONE Secured Installment. - */ -export class PaymentProduct3391SpecificOutput { - /** - * List of installment options. - */ - 'installmentOptions'?: Array; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'installmentOptions', - baseName: 'installmentOptions', - type: 'Array', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PaymentProduct3391SpecificOutput.attributeTypeMap; - } - - public constructor() {} +/** @description Object containing specific information for PAYONE Secured Installment. */ +export interface PaymentProduct3391SpecificOutput { + /** @description List of installment options. */ + installmentOptions?: InstallmentOption[]; } diff --git a/src/models/PaymentProduct3392SpecificInput.ts b/src/models/PaymentProduct3392SpecificInput.ts index ac77a28..8566382 100644 --- a/src/models/PaymentProduct3392SpecificInput.ts +++ b/src/models/PaymentProduct3392SpecificInput.ts @@ -1,37 +1,6 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { BankAccountInformation } from './BankAccountInformation.js'; -import { BankAccountInformation } from './BankAccountInformation.js'; - -/** - * Object containing specific information for PAYONE Secured Direct. Debit. - */ -export class PaymentProduct3392SpecificInput { - 'bankAccountInformation': BankAccountInformation; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'bankAccountInformation', - baseName: 'bankAccountInformation', - type: 'BankAccountInformation', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PaymentProduct3392SpecificInput.attributeTypeMap; - } - - public constructor() {} +/** @description Object containing specific information for PAYONE Secured Direct. Debit. */ +export interface PaymentProduct3392SpecificInput { + bankAccountInformation: BankAccountInformation; } diff --git a/src/models/PaymentProduct771SpecificOutput.ts b/src/models/PaymentProduct771SpecificOutput.ts index 95b1d28..1aab9e3 100644 --- a/src/models/PaymentProduct771SpecificOutput.ts +++ b/src/models/PaymentProduct771SpecificOutput.ts @@ -1,38 +1,5 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Output that is SEPA Direct Debit specific (i.e. the used mandate). - */ -export class PaymentProduct771SpecificOutput { - /** - * Unique reference fo a SEPA Mandate - */ - 'mandateReference'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'mandateReference', - baseName: 'mandateReference', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PaymentProduct771SpecificOutput.attributeTypeMap; - } - - public constructor() {} +/** @description Output that is SEPA Direct Debit specific (i.e. the used mandate). */ +export interface PaymentProduct771SpecificOutput { + /** @description Unique reference fo a SEPA Mandate */ + mandateReference?: string; } diff --git a/src/models/PaymentProduct840CustomerAccount.ts b/src/models/PaymentProduct840CustomerAccount.ts index 7affa5b..212d908 100644 --- a/src/models/PaymentProduct840CustomerAccount.ts +++ b/src/models/PaymentProduct840CustomerAccount.ts @@ -1,68 +1,23 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Object containing the details of the PayPal account. - */ -export class PaymentProduct840CustomerAccount { +/** @description Object containing the details of the PayPal account. */ +export interface PaymentProduct840CustomerAccount { /** - * Name of the company in case the PayPal account is owned by a business + * @description Name of the company in case the PayPal account is owned by a business + * @example Customer Company Name */ - 'companyName'?: string; + companyName?: string; /** - * First name of the PayPal account holder + * @description First name of the PayPal account holder + * @example John */ - 'firstName'?: string; + firstName?: string; /** - * The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account. + * @description The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account. + * @example RRCYJUTFJGZTA */ - 'payerId'?: string; + payerId?: string; /** - * Surname of the PayPal account holder + * @description Surname of the PayPal account holder + * @example Doe */ - 'surname'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'companyName', - baseName: 'companyName', - type: 'string', - format: '', - }, - { - name: 'firstName', - baseName: 'firstName', - type: 'string', - format: '', - }, - { - name: 'payerId', - baseName: 'payerId', - type: 'string', - format: '', - }, - { - name: 'surname', - baseName: 'surname', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PaymentProduct840CustomerAccount.attributeTypeMap; - } - - public constructor() {} + surname?: string; } diff --git a/src/models/PaymentProduct840SpecificOutput.ts b/src/models/PaymentProduct840SpecificOutput.ts index 6e567b9..a518a29 100644 --- a/src/models/PaymentProduct840SpecificOutput.ts +++ b/src/models/PaymentProduct840SpecificOutput.ts @@ -1,52 +1,9 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { Address } from './Address.js'; -import { PaymentProduct840CustomerAccount } from './PaymentProduct840CustomerAccount.js'; - -/** - * PayPal (payment product 840) specific details. - */ -export class PaymentProduct840SpecificOutput { - 'billingAddress'?: Address; - 'customerAccount'?: PaymentProduct840CustomerAccount; - 'shippingAddress'?: Address; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'billingAddress', - baseName: 'billingAddress', - type: 'Address', - format: '', - }, - { - name: 'customerAccount', - baseName: 'customerAccount', - type: 'PaymentProduct840CustomerAccount', - format: '', - }, - { - name: 'shippingAddress', - baseName: 'shippingAddress', - type: 'Address', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PaymentProduct840SpecificOutput.attributeTypeMap; - } - - public constructor() {} +import type { Address } from './Address.js'; +import type { PaymentProduct840CustomerAccount } from './PaymentProduct840CustomerAccount.js'; + +/** @description PayPal (payment product 840) specific details. */ +export interface PaymentProduct840SpecificOutput { + billingAddress?: Address; + customerAccount?: PaymentProduct840CustomerAccount; + shippingAddress?: Address; } diff --git a/src/models/PaymentReferences.ts b/src/models/PaymentReferences.ts index d52ff0f..2e7f39f 100644 --- a/src/models/PaymentReferences.ts +++ b/src/models/PaymentReferences.ts @@ -1,38 +1,8 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Object that holds all reference properties that are linked to this transaction. - */ -export class PaymentReferences { +/** @description Object that holds all reference properties that are linked to this transaction. */ +export interface PaymentReferences { /** - * Unique reference of the Commerce Case that is also returned for reporting and reconciliation purposes. + * @description Unique reference of the Commerce Case that is also returned for reporting and reconciliation purposes. + * @example your-order-6372 */ - 'merchantReference'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'merchantReference', - baseName: 'merchantReference', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PaymentReferences.attributeTypeMap; - } - - public constructor() {} + merchantReference?: string; } diff --git a/src/models/PaymentResponse.ts b/src/models/PaymentResponse.ts index 5289acd..c072d75 100644 --- a/src/models/PaymentResponse.ts +++ b/src/models/PaymentResponse.ts @@ -1,63 +1,15 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { PaymentOutput } from './PaymentOutput.js'; -import { PaymentStatusOutput } from './PaymentStatusOutput.js'; -import { StatusValue } from './StatusValue.js'; - -/** - * Object that holds the payment related properties. - */ -export class PaymentResponse { - 'paymentOutput'?: PaymentOutput; - 'status'?: StatusValue; - 'statusOutput'?: PaymentStatusOutput; +import type { PaymentOutput } from './PaymentOutput.js'; +import type { PaymentStatusOutput } from './PaymentStatusOutput.js'; +import type { StatusValue } from './StatusValue.js'; + +/** @description Object that holds the payment related properties. */ +export interface PaymentResponse { + paymentOutput?: PaymentOutput; + status?: StatusValue; + statusOutput?: PaymentStatusOutput; /** - * Unique payment transaction identifier of the payment gateway. + * @description Unique payment transaction identifier of the payment gateway. + * @example PP1AA7KKLSFB9MBG */ - 'id'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'paymentOutput', - baseName: 'paymentOutput', - type: 'PaymentOutput', - format: '', - }, - { - name: 'status', - baseName: 'status', - type: 'StatusValue', - format: '', - }, - { - name: 'statusOutput', - baseName: 'statusOutput', - type: 'PaymentStatusOutput', - format: '', - }, - { - name: 'id', - baseName: 'id', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PaymentResponse.attributeTypeMap; - } - - public constructor() {} + id?: string; } diff --git a/src/models/PaymentStatus.ts b/src/models/PaymentStatus.ts new file mode 100644 index 0000000..749fe99 --- /dev/null +++ b/src/models/PaymentStatus.ts @@ -0,0 +1,18 @@ +/** + * @description + * - WAITING_FOR_PAYMENT - There does not yet exist a PaymentExecution nor a PaymentInformation for this + * Checkout. + * - PAYMENT_NOT_COMPLETED - There exists a PaymentExecution or a PaymentInformation for this Checkout, but all + * or some part of the total amount is still unpaid. + * - PAYMENT_COMPLETED - There exists a PaymentExecution or a PaymentInformation for this Checkout and the + * total amount is fully paid. + * - NO_PAYMENT - Checkout was created and deleted. No Payment Execution and no other actions can be triggered + * on the Checkout. + * @example WAITING_FOR_PAYMENT + */ +export enum PaymentStatus { + WAITING_FOR_PAYMENT = 'WAITING_FOR_PAYMENT', + PAYMENT_NOT_COMPLETED = 'PAYMENT_NOT_COMPLETED', + PAYMENT_COMPLETED = 'PAYMENT_COMPLETED', + NO_PAYMENT = 'NO_PAYMENT', +} diff --git a/src/models/PaymentStatusOutput.ts b/src/models/PaymentStatusOutput.ts index 0f709b2..335147a 100644 --- a/src/models/PaymentStatusOutput.ts +++ b/src/models/PaymentStatusOutput.ts @@ -1,67 +1,16 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { StatusCategoryValue } from './StatusCategoryValue.js'; +import type { StatusCategoryValue } from './StatusCategoryValue.js'; /** - * This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource. In case of failed payments and negative scenarios, detailed error information is listed. + * @description This object has the numeric representation of the current payment status, timestamp of last status change and + * performable action on the current payment resource. In case of failed payments and negative scenarios, detailed + * error information is listed. */ -export class PaymentStatusOutput { - /** - * Flag indicating if the payment can be cancelled - */ - 'isCancellable'?: boolean; - 'statusCategory'?: StatusCategoryValue; - /** - * Indicates if the transaction has been authorized - */ - 'isAuthorized'?: boolean; - /** - * Flag indicating if the payment can be refunded - */ - 'isRefundable'?: boolean; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'isCancellable', - baseName: 'isCancellable', - type: 'boolean', - format: '', - }, - { - name: 'statusCategory', - baseName: 'statusCategory', - type: 'StatusCategoryValue', - format: '', - }, - { - name: 'isAuthorized', - baseName: 'isAuthorized', - type: 'boolean', - format: '', - }, - { - name: 'isRefundable', - baseName: 'isRefundable', - type: 'boolean', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PaymentStatusOutput.attributeTypeMap; - } - - public constructor() {} +export interface PaymentStatusOutput { + /** @description Flag indicating if the payment can be cancelled */ + isCancellable?: boolean; + statusCategory?: StatusCategoryValue; + /** @description Indicates if the transaction has been authorized */ + isAuthorized?: boolean; + /** @description Flag indicating if the payment can be refunded */ + isRefundable?: boolean; } diff --git a/src/models/PaymentType.ts b/src/models/PaymentType.ts index 1cf15f7..3e4d1f8 100644 --- a/src/models/PaymentType.ts +++ b/src/models/PaymentType.ts @@ -1,15 +1,3 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - /** * Defines the respective payment type. */ diff --git a/src/models/PayoutOutput.ts b/src/models/PayoutOutput.ts index f062247..c3b5cdf 100644 --- a/src/models/PayoutOutput.ts +++ b/src/models/PayoutOutput.ts @@ -1,55 +1,10 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { AmountOfMoney } from './AmountOfMoney.js'; -import { PaymentReferences } from './PaymentReferences.js'; - -/** - * Object containing details from the created payout. - */ -export class PayoutOutput { - 'amountOfMoney'?: AmountOfMoney; - 'references'?: PaymentReferences; - /** - * Payment method identifier based on the paymentProductId. - */ - 'paymentMethod'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'amountOfMoney', - baseName: 'amountOfMoney', - type: 'AmountOfMoney', - format: '', - }, - { - name: 'references', - baseName: 'references', - type: 'PaymentReferences', - format: '', - }, - { - name: 'paymentMethod', - baseName: 'paymentMethod', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PayoutOutput.attributeTypeMap; - } - - public constructor() {} +import type { AmountOfMoney } from './AmountOfMoney.js'; +import type { PaymentReferences } from './PaymentReferences.js'; + +/** @description Object containing details from the created payout. */ +export interface PayoutOutput { + amountOfMoney?: AmountOfMoney; + references?: PaymentReferences; + /** @description Payment method identifier based on the paymentProductId. */ + paymentMethod?: string; } diff --git a/src/models/PayoutResponse.ts b/src/models/PayoutResponse.ts index 0b79582..8e7c7b1 100644 --- a/src/models/PayoutResponse.ts +++ b/src/models/PayoutResponse.ts @@ -1,63 +1,15 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { PayoutOutput } from './PayoutOutput.js'; -import { StatusCategoryValue } from './StatusCategoryValue.js'; -import { StatusValue } from './StatusValue.js'; - -/** - * Object that holds the payment related properties for the refund of a Payment Information. - */ -export class PayoutResponse { - 'payoutOutput'?: PayoutOutput; - 'status'?: StatusValue; - 'statusCategory'?: StatusCategoryValue; +import type { PayoutOutput } from './PayoutOutput.js'; +import type { StatusCategoryValue } from './StatusCategoryValue.js'; +import type { StatusValue } from './StatusValue.js'; + +/** @description Object that holds the payment related properties for the refund of a Payment Information. */ +export interface PayoutResponse { + payoutOutput?: PayoutOutput; + status?: StatusValue; + statusCategory?: StatusCategoryValue; /** - * Unique payment transaction identifier of the payment gateway. + * @description Unique payment transaction identifier of the payment gateway. + * @example PP1AA7KKLSFB9MBG */ - 'id'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'payoutOutput', - baseName: 'payoutOutput', - type: 'PayoutOutput', - format: '', - }, - { - name: 'status', - baseName: 'status', - type: 'StatusValue', - format: '', - }, - { - name: 'statusCategory', - baseName: 'statusCategory', - type: 'StatusCategoryValue', - format: '', - }, - { - name: 'id', - baseName: 'id', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PayoutResponse.attributeTypeMap; - } - - public constructor() {} + id?: string; } diff --git a/src/models/PersonalInformation.ts b/src/models/PersonalInformation.ts index 49f11be..6048312 100644 --- a/src/models/PersonalInformation.ts +++ b/src/models/PersonalInformation.ts @@ -1,63 +1,13 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { PersonalName } from './PersonalName.js'; +import type { Gender } from './Gender.js'; -import { PersonalName } from './PersonalName.js'; - -/** - * Object containing personal information like name, date of birth and gender. - */ -export class PersonalInformation { - /** - * The date of birth of the customer of the recipient of the loan. Format YYYYMMDD - */ - 'dateOfBirth'?: string; +/** @description Object containing personal information like name, date of birth and gender. */ +export interface PersonalInformation { /** - * The gender of the customer, possible values are: * MALE * FEMALE * UNKNOWN + * @description The date of birth of the customer of the recipient of the loan. + * Format YYYYMMDD */ - 'gender'?: PersonalInformationGenderEnum; - 'name'?: PersonalName; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'dateOfBirth', - baseName: 'dateOfBirth', - type: 'string', - format: '', - }, - { - name: 'gender', - baseName: 'gender', - type: 'PersonalInformationGenderEnum', - format: '', - }, - { - name: 'name', - baseName: 'name', - type: 'PersonalName', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PersonalInformation.attributeTypeMap; - } - - public constructor() {} -} - -export enum PersonalInformationGenderEnum { - Male = 'MALE', - Female = 'FEMALE', - Unknown = 'UNKNOWN', + dateOfBirth?: string; + gender?: Gender; + name?: PersonalName; } diff --git a/src/models/PersonalName.ts b/src/models/PersonalName.ts index 060e70e..1c54e9f 100644 --- a/src/models/PersonalName.ts +++ b/src/models/PersonalName.ts @@ -1,58 +1,18 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Object containing the name details of the customer - */ -export class PersonalName { +/** @description Object containing the name details of the customer */ +export interface PersonalName { /** - * Given name(s) or first name(s) of the customer + * @description Given name(s) or first name(s) of the customer + * @example Wile */ - 'firstName'?: string; + firstName?: string; /** - * Surname(s) or last name(s) of the customer + * @description Surname(s) or last name(s) of the customer + * @example E. Coyote */ - 'surname'?: string; + surname?: string; /** - * Title of customer + * @description Title of customer + * @example Dr. */ - 'title'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'firstName', - baseName: 'firstName', - type: 'string', - format: '', - }, - { - name: 'surname', - baseName: 'surname', - type: 'string', - format: '', - }, - { - name: 'title', - baseName: 'title', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PersonalName.attributeTypeMap; - } - - public constructor() {} + title?: string; } diff --git a/src/models/PositiveAmountOfMoney.ts b/src/models/PositiveAmountOfMoney.ts index ddfe9bf..9fc1b41 100644 --- a/src/models/PositiveAmountOfMoney.ts +++ b/src/models/PositiveAmountOfMoney.ts @@ -1,48 +1,14 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Object containing amount and ISO currency code attributes - */ -export class PositiveAmountOfMoney { +/** @description Object containing amount and ISO currency code attributes */ +export interface PositiveAmountOfMoney { /** - * Amount in cents and always having 2 decimals + * Format: int64 + * @description Amount in cents and always having 2 decimals + * @example 1000 */ - 'amount': number; + amount: number; /** - * Three-letter ISO currency code representing the currency for the amount + * @description Three-letter ISO currency code representing the currency for the amount + * @example EUR */ - 'currencyCode': string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'amount', - baseName: 'amount', - type: 'number', - format: 'int64', - }, - { - name: 'currencyCode', - baseName: 'currencyCode', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return PositiveAmountOfMoney.attributeTypeMap; - } - - public constructor() {} + currencyCode: string; } diff --git a/src/models/ProcessingMandateInformation.ts b/src/models/ProcessingMandateInformation.ts index b7104f3..ae0f253 100644 --- a/src/models/ProcessingMandateInformation.ts +++ b/src/models/ProcessingMandateInformation.ts @@ -1,75 +1,28 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { BankAccountInformation } from './BankAccountInformation.js'; -import { MandateRecurrenceType } from './MandateRecurrenceType.js'; +import type { BankAccountInformation } from './BankAccountInformation.js'; +import type { MandateRecurrenceType } from './MandateRecurrenceType.js'; /** - * Object containing the relevant information of a SEPA Direct Debit mandate for processing (mandatory fields in pain.008). Renamed from CreateMandateWithReturnUrl to ProcessingMandateInformation. + * @description Object containing the relevant information of a SEPA Direct Debit + * mandate for processing (mandatory fields in pain.008). + * Renamed from CreateMandateWithReturnUrl to ProcessingMandateInformation. */ -export class ProcessingMandateInformation { - 'bankAccountIban': BankAccountInformation; - 'recurrenceType': MandateRecurrenceType; +export interface ProcessingMandateInformation { + bankAccountIban: BankAccountInformation; + recurrenceType: MandateRecurrenceType; /** - * The unique identifier of the mandate + * @description The unique identifier of the mandate + * @example your-mandate-id */ - 'uniqueMandateReference': string; + uniqueMandateReference: string; /** - * The date of signature of the mandate. Format YYYYMMDD + * @description The date of signature of the mandate. + * Format YYYYMMDD + * @example 20220101 */ - 'dateOfSignature': string; + dateOfSignature: string; /** - * Your unique creditor identifier. + * @description Your unique creditor identifier. + * @example DE98ZZZ09999999999 */ - 'creditorId': string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'bankAccountIban', - baseName: 'bankAccountIban', - type: 'BankAccountInformation', - format: '', - }, - { - name: 'recurrenceType', - baseName: 'recurrenceType', - type: 'MandateRecurrenceType', - format: '', - }, - { - name: 'uniqueMandateReference', - baseName: 'uniqueMandateReference', - type: 'string', - format: '', - }, - { - name: 'dateOfSignature', - baseName: 'dateOfSignature', - type: 'string', - format: '', - }, - { - name: 'creditorId', - baseName: 'creditorId', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return ProcessingMandateInformation.attributeTypeMap; - } - - public constructor() {} + creditorId: string; } diff --git a/src/models/ProductType.ts b/src/models/ProductType.ts index 91b28c0..ffd4d8e 100644 --- a/src/models/ProductType.ts +++ b/src/models/ProductType.ts @@ -1,21 +1,13 @@ /** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Enum to classify items that are purchased * GOODS - Goods * SHIPMENT - Shipping charges * HANDLING_FEE - Handling fee * DISCOUNT - Voucher / discount + * @description Enum to classify items that are purchased + * * GOODS - Goods + * * SHIPMENT - Shipping charges + * * HANDLING_FEE - Handling fee + * * DISCOUNT - Voucher / discount */ export enum ProductType { - Goods = 'GOODS', - Shipment = 'SHIPMENT', - HandlingFee = 'HANDLING_FEE', - Discount = 'DISCOUNT', + GOODS = 'GOODS', + SHIPMENT = 'SHIPMENT', + HANDLING_FEE = 'HANDLING_FEE', + DISCOUNT = 'DISCOUNT', } diff --git a/src/models/RedirectData.ts b/src/models/RedirectData.ts index 5a7a0a4..758a355 100644 --- a/src/models/RedirectData.ts +++ b/src/models/RedirectData.ts @@ -1,38 +1,8 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Object containing all data needed to redirect the customer. - */ -export class RedirectData { +/** @description Object containing all data needed to redirect the customer. */ +export interface RedirectData { /** - * The URL that the customer should be redirected to. Be sure to redirect using the GET method + * @description The URL that the customer should be redirected to. Be sure to redirect using the GET method + * @example https://example-mandate-signing-url.com\ */ - 'redirectURL'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'redirectURL', - baseName: 'redirectURL', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return RedirectData.attributeTypeMap; - } - - public constructor() {} + redirectURL?: string; } diff --git a/src/models/RedirectPaymentMethodSpecificInput.ts b/src/models/RedirectPaymentMethodSpecificInput.ts index 04ffc58..b0ffd50 100644 --- a/src/models/RedirectPaymentMethodSpecificInput.ts +++ b/src/models/RedirectPaymentMethodSpecificInput.ts @@ -1,95 +1,39 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { RedirectPaymentProduct840SpecificInput } from './RedirectPaymentProduct840SpecificInput.js'; +import type { RedirectionData } from './RedirectionData.js'; -import { RedirectPaymentProduct840SpecificInput } from './RedirectPaymentProduct840SpecificInput.js'; -import { RedirectionData } from './RedirectionData.js'; - -/** - * Object containing the specific input details for payments that involve redirects to 3rd parties to complete, like iDeal and PayPal - */ -export class RedirectPaymentMethodSpecificInput { +/** @description Object containing the specific input details for payments that involve redirects to 3rd parties to complete, like iDeal and PayPal */ +export interface RedirectPaymentMethodSpecificInput { /** - * * true = the payment requires approval before the funds will be captured using the Approve payment or Capture payment API * false = the payment does not require approval, and the funds will be captured automatically If the parameter is not provided in the request, the default value will be true + * @description * true = the payment requires approval before the funds will be captured using the Approve payment or + * Capture payment API + * * false = the payment does not require approval, and the funds will be captured automatically + * + * If the parameter is not provided in the request, the default value will be true */ - 'requiresApproval'?: boolean; + requiresApproval?: boolean; /** - * ID of the token to use to create the payment. + * @description ID of the token to use to create the payment. + * @example 0ca037cc-9079-4df7-8f6f-f2a3443ee521 */ - 'paymentProcessingToken'?: string; + paymentProcessingToken?: string; /** - * Token to identify the card in the reporting. + * @description Token to identify the card in the reporting. + * @example 12a037cc-833d-8b45-8f6f-11c34171f4e1 */ - 'reportingToken'?: string; + readonly reportingToken?: string; /** - * Indicates if this transaction should be tokenized * true - Tokenize the transaction. * false - Do not tokenize the transaction, unless it would be tokenized by other means such as auto- tokenization of recurring payments. example: false + * @description Indicates if this transaction should be tokenized + * * true - Tokenize the transaction. + * * false - Do not tokenize the transaction, unless it would be tokenized by other means such as auto- + * tokenization of recurring payments. example: false */ - 'tokenize'?: boolean; + tokenize?: boolean; /** - * Payment product identifier - please check product documentation for a full overview of possible values. + * Format: int32 + * @description Payment product identifier - please check product documentation for a full overview of possible values. + * @example 840 */ - 'paymentProductId'?: number; - 'paymentProduct840SpecificInput'?: RedirectPaymentProduct840SpecificInput; - 'redirectionData'?: RedirectionData; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'requiresApproval', - baseName: 'requiresApproval', - type: 'boolean', - format: '', - }, - { - name: 'paymentProcessingToken', - baseName: 'paymentProcessingToken', - type: 'string', - format: '', - }, - { - name: 'reportingToken', - baseName: 'reportingToken', - type: 'string', - format: '', - }, - { - name: 'tokenize', - baseName: 'tokenize', - type: 'boolean', - format: '', - }, - { - name: 'paymentProductId', - baseName: 'paymentProductId', - type: 'number', - format: 'int32', - }, - { - name: 'paymentProduct840SpecificInput', - baseName: 'paymentProduct840SpecificInput', - type: 'RedirectPaymentProduct840SpecificInput', - format: '', - }, - { - name: 'redirectionData', - baseName: 'redirectionData', - type: 'RedirectionData', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return RedirectPaymentMethodSpecificInput.attributeTypeMap; - } - - public constructor() {} + paymentProductId?: number; + paymentProduct840SpecificInput?: RedirectPaymentProduct840SpecificInput; + redirectionData?: RedirectionData; } diff --git a/src/models/RedirectPaymentMethodSpecificOutput.ts b/src/models/RedirectPaymentMethodSpecificOutput.ts index 6e53c33..8bb032f 100644 --- a/src/models/RedirectPaymentMethodSpecificOutput.ts +++ b/src/models/RedirectPaymentMethodSpecificOutput.ts @@ -1,67 +1,22 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { PaymentProduct840SpecificOutput } from './PaymentProduct840SpecificOutput.js'; -import { PaymentProduct840SpecificOutput } from './PaymentProduct840SpecificOutput.js'; - -/** - * Object containing the redirect payment product details. - */ -export class RedirectPaymentMethodSpecificOutput { +/** @description Object containing the redirect payment product details. */ +export interface RedirectPaymentMethodSpecificOutput { /** - * <- Payment product identifier - please check product documentation for a full overview of possible values. + * Format: int32 + * @description <- Payment product identifier - please check product documentation for a full overview of possible values. + * @example 840 */ - 'paymentProductId'?: number; - 'paymentProduct840SpecificOutput'?: PaymentProduct840SpecificOutput; + paymentProductId?: number; + paymentProduct840SpecificOutput?: PaymentProduct840SpecificOutput; /** - * ID of the token. This property is populated when the payment was done with a token. + * @description ID of the token. This property is populated when the payment was done with a token. + * @example 0ca037cc-9079-4df7-8f6f-f2a3443ee521 */ - 'paymentProcessingToken'?: string; + paymentProcessingToken?: string; /** - * Token to identify the card in the reporting. + * @description Token to identify the card in the reporting. + * @example 12a037cc-833d-8b45-8f6f-11c34171f4e1 */ - 'reportingToken'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'paymentProductId', - baseName: 'paymentProductId', - type: 'number', - format: 'int32', - }, - { - name: 'paymentProduct840SpecificOutput', - baseName: 'paymentProduct840SpecificOutput', - type: 'PaymentProduct840SpecificOutput', - format: '', - }, - { - name: 'paymentProcessingToken', - baseName: 'paymentProcessingToken', - type: 'string', - format: '', - }, - { - name: 'reportingToken', - baseName: 'reportingToken', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return RedirectPaymentMethodSpecificOutput.attributeTypeMap; - } - - public constructor() {} + reportingToken?: string; } diff --git a/src/models/RedirectPaymentProduct840SpecificInput.ts b/src/models/RedirectPaymentProduct840SpecificInput.ts index 753e865..d23e308 100644 --- a/src/models/RedirectPaymentProduct840SpecificInput.ts +++ b/src/models/RedirectPaymentProduct840SpecificInput.ts @@ -1,38 +1,12 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Object containing specific input required for PayPal payments (Payment product ID 840) - */ -export class RedirectPaymentProduct840SpecificInput { +/** @description Object containing specific input required for PayPal payments (Payment product ID 840) */ +export interface RedirectPaymentProduct840SpecificInput { /** - * Indicates whether to use PayPal Express Checkout Shortcut. * true = When shortcut is enabled, the consumer can select a shipping address during PayPal checkout. * false = When shortcut is disabled, the consumer cannot change the shipping address. Default value is false. Please note that this field is ignored when order.additionalInput.typeInformation.purchaseType is set to \"digital\" + * @description Indicates whether to use PayPal Express Checkout Shortcut. + * * true = When shortcut is enabled, the consumer can select a shipping address during PayPal checkout. + * * false = When shortcut is disabled, the consumer cannot change the shipping address. + * Default value is false. + * Please note that this field is ignored when order.additionalInput.typeInformation.purchaseType is set to + * "digital" */ - 'addressSelectionAtPayPal'?: boolean; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'addressSelectionAtPayPal', - baseName: 'addressSelectionAtPayPal', - type: 'boolean', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return RedirectPaymentProduct840SpecificInput.attributeTypeMap; - } - - public constructor() {} + addressSelectionAtPayPal?: boolean; } diff --git a/src/models/RedirectionData.ts b/src/models/RedirectionData.ts index f987400..ad50b91 100644 --- a/src/models/RedirectionData.ts +++ b/src/models/RedirectionData.ts @@ -1,38 +1,15 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Object containing browser specific redirection related data. - */ -export class RedirectionData { +/** @description Object containing browser specific redirection related data. */ +export interface RedirectionData { /** - * The URL that the customer is redirected to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process. Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first. URLs without a protocol will be rejected. + * @description The URL that the customer is redirected to after the payment flow has finished. You can add any number of + * key value pairs in the query string that, for instance help you to identify the customer when they return to + * your site. Please note that we will also append some additional key value pairs that will also help you with + * this identification process. + * Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use + * on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered + * on the device first. + * URLs without a protocol will be rejected. + * @example https://secure.ogone.com/ncol/test/displayparams.asp */ - 'returnUrl': string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'returnUrl', - baseName: 'returnUrl', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return RedirectionData.attributeTypeMap; - } - - public constructor() {} + returnUrl: string; } diff --git a/src/models/References.ts b/src/models/References.ts index 624af1d..4a0a9d8 100644 --- a/src/models/References.ts +++ b/src/models/References.ts @@ -1,58 +1,57 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -/** - * Object that holds all reference properties that are linked to this transaction. - */ -export class References { - /** - * Descriptive text that is used towards to customer, either during an online Checkout at a third party and/or on the statement of the customer. For card transactions this is usually referred to as a Soft Descriptor. The maximum allowed length varies per card acquirer: * AIB - 22 characters * American Express - 25 characters * Atos Origin BNP - 15 characters * Barclays - 25 characters * Catella - 22 characters * CBA - 20 characters * Elavon - 25 characters * First Data - 25 characters * INICIS (INIPAY) - 22-30 characters * JCB - 25 characters * Merchant Solutions - 22-25 characters * Payvision (EU & HK) - 25 characters * SEB Euroline - 22 characters * Sub1 Argentina - 15 characters * Wells Fargo - 25 characters Note that we advise you to use 22 characters as the max length as beyond this our experience is that issuers will start to truncate. We currently also only allow per API call overrides for AIB and Barclays For alternative payment products the maximum allowed length varies per payment product: * 402 e-Przelewy - 30 characters * 404 INICIS - 80 characters * 802 Nordea ePayment Finland - 234 characters * 809 iDeal - 32 characters * 836 SOFORT - 42 characters * 840 PayPal - 127 characters * 841 WebMoney - 175 characters * 849 Yandex - 64 characters * 861 Alipay - 256 characters * 863 WeChat Pay - 32 characters * 880 BOKU - 20 characters * 8580 Qiwi - 255 characters * 1504 Konbini - 80 characters All other payment products don\'t support a descriptor. +/** @description Object that holds all reference properties that are linked to this transaction. */ +export interface References { + /** @description Descriptive text that is used towards to customer, either during an online Checkout at a third party and/or + * on the statement of the customer. For card transactions this is usually referred to as a Soft Descriptor. + * The maximum allowed length varies per card acquirer: + * * AIB - 22 characters + * * American Express - 25 characters + * * Atos Origin BNP - 15 characters + * * Barclays - 25 characters + * * Catella - 22 characters + * * CBA - 20 characters + * * Elavon - 25 characters + * * First Data - 25 characters + * * INICIS (INIPAY) - 22-30 characters + * * JCB - 25 characters + * * Merchant Solutions - 22-25 characters + * * Payvision (EU & HK) - 25 characters + * * SEB Euroline - 22 characters + * * Sub1 Argentina - 15 characters + * * Wells Fargo - 25 characters + * + * Note that we advise you to use 22 characters as the max length as beyond this our experience is that issuers + * will start to truncate. We currently also only allow per API call overrides for AIB and Barclays + * For alternative payment products the maximum allowed length varies per payment product: + * * 402 e-Przelewy - 30 characters + * * 404 INICIS - 80 characters + * * 802 Nordea ePayment Finland - 234 characters + * * 809 iDeal - 32 characters + * * 836 SOFORT - 42 characters + * * 840 PayPal - 127 characters + * * 841 WebMoney - 175 characters + * * 849 Yandex - 64 characters + * * 861 Alipay - 256 characters + * * 863 WeChat Pay - 32 characters + * * 880 BOKU - 20 characters + * * 8580 Qiwi - 255 characters + * * 1504 Konbini - 80 characters + * + * All other payment products don't support a descriptor. */ - 'descriptor'?: string; + descriptor?: string; /** - * The merchantReference is a unique identifier for a payment and can be used for reporting purposes. The merchantReference is required for the execution of a payment and has to be unique. In case a payment has failed the same merchantReference can be used again. Once a successful payment has been made the same merchantReference can no longer be used and will be rejected. + * @description The merchantReference is a unique identifier for a payment and can be used for reporting purposes. The + * merchantReference is required for the execution of a payment and has to be unique. In case a payment has + * failed the same merchantReference can be used again. + * Once a successful payment has been made the same merchantReference can no longer be used and will be + * rejected. + * + * @example 5a891df0b8cf11edaeb2af87d8ff0b2f */ - 'merchantReference': string; + merchantReference: string; /** - * It allows you to store additional parameters for the transaction in JSON format. This field must not contain any personal data. + * @description It allows you to store additional parameters for the transaction in JSON format. This field must not contain any personal data. + * @example {'SessionID':'126548354','ShopperID':'7354131'} */ - 'merchantParameters'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'descriptor', - baseName: 'descriptor', - type: 'string', - format: '', - }, - { - name: 'merchantReference', - baseName: 'merchantReference', - type: 'string', - format: '', - }, - { - name: 'merchantParameters', - baseName: 'merchantParameters', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return References.attributeTypeMap; - } - - public constructor() {} + merchantParameters?: string; } diff --git a/src/models/RefundErrorResponse.ts b/src/models/RefundErrorResponse.ts index 6956a24..0279a96 100644 --- a/src/models/RefundErrorResponse.ts +++ b/src/models/RefundErrorResponse.ts @@ -1,44 +1,7 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { APIError } from './APIError.js'; -import { APIError } from './APIError.js'; - -export class RefundErrorResponse { - /** - * Unique reference, for debugging purposes, of this error response - */ - 'errorId'?: string; - 'errors'?: Array; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'errorId', - baseName: 'errorId', - type: 'string', - format: '', - }, - { - name: 'errors', - baseName: 'errors', - type: 'Array', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return RefundErrorResponse.attributeTypeMap; - } - - public constructor() {} +export interface RefundErrorResponse { + /** @description Unique reference, for debugging purposes, of this error response */ + errorId?: string; + errors?: APIError[]; } diff --git a/src/models/RefundOutput.ts b/src/models/RefundOutput.ts index b6a5dc8..4527156 100644 --- a/src/models/RefundOutput.ts +++ b/src/models/RefundOutput.ts @@ -1,65 +1,17 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { AmountOfMoney } from './AmountOfMoney.js'; +import type { PaymentReferences } from './PaymentReferences.js'; -import { AmountOfMoney } from './AmountOfMoney.js'; -import { PaymentReferences } from './PaymentReferences.js'; - -/** - * Object containing Refund details - */ -export class RefundOutput { - 'amountOfMoney'?: AmountOfMoney; - /** - * It allows you to store additional parameters for the transaction in JSON format. This field must not contain any personal data. - */ - 'merchantParameters'?: string; - 'references'?: PaymentReferences; +/** @description Object containing Refund details */ +export interface RefundOutput { + amountOfMoney?: AmountOfMoney; /** - * Payment method identifier used by the our payment engine. + * @description It allows you to store additional parameters for the transaction in JSON format. + * This field must not contain any personal data. + * + * @example {'SessionID':'126548354','ShopperID':'7354131'} */ - 'paymentMethod'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'amountOfMoney', - baseName: 'amountOfMoney', - type: 'AmountOfMoney', - format: '', - }, - { - name: 'merchantParameters', - baseName: 'merchantParameters', - type: 'string', - format: '', - }, - { - name: 'references', - baseName: 'references', - type: 'PaymentReferences', - format: '', - }, - { - name: 'paymentMethod', - baseName: 'paymentMethod', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return RefundOutput.attributeTypeMap; - } - - public constructor() {} + merchantParameters?: string; + references?: PaymentReferences; + /** @description Payment method identifier used by the our payment engine. */ + paymentMethod?: string; } diff --git a/src/models/RefundPaymentResponse.ts b/src/models/RefundPaymentResponse.ts index ad99b00..e1c279c 100644 --- a/src/models/RefundPaymentResponse.ts +++ b/src/models/RefundPaymentResponse.ts @@ -1,63 +1,19 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { PaymentStatusOutput } from './PaymentStatusOutput.js'; -import { RefundOutput } from './RefundOutput.js'; -import { StatusValue } from './StatusValue.js'; +import type { PaymentStatusOutput } from './PaymentStatusOutput.js'; +import type { RefundOutput } from './RefundOutput.js'; +import type { StatusValue } from './StatusValue.js'; /** - * This object has the numeric representation of the current Refund status, timestamp of last status change and performable action on the current Refund resource. In case of a rejected Refund, detailed error information is listed. + * @description This object has the numeric representation of the current Refund status, timestamp of last status change and + * performable action on the current Refund resource. In case of a rejected Refund, detailed error information is + * listed. */ -export class RefundPaymentResponse { - 'refundOutput'?: RefundOutput; - 'status'?: StatusValue; - 'statusOutput'?: PaymentStatusOutput; +export interface RefundPaymentResponse { + refundOutput?: RefundOutput; + status?: StatusValue; + statusOutput?: PaymentStatusOutput; /** - * Unique payment transaction identifier of the payment gateway. + * @description Unique payment transaction identifier of the payment gateway. + * @example 3066019730_1 */ - 'id'?: string; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'refundOutput', - baseName: 'refundOutput', - type: 'RefundOutput', - format: '', - }, - { - name: 'status', - baseName: 'status', - type: 'StatusValue', - format: '', - }, - { - name: 'statusOutput', - baseName: 'statusOutput', - type: 'PaymentStatusOutput', - format: '', - }, - { - name: 'id', - baseName: 'id', - type: 'string', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return RefundPaymentResponse.attributeTypeMap; - } - - public constructor() {} + id?: string; } diff --git a/src/models/RefundRequest.ts b/src/models/RefundRequest.ts index c8e68af..b4e83b9 100644 --- a/src/models/RefundRequest.ts +++ b/src/models/RefundRequest.ts @@ -1,53 +1,14 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { PaymentReferences } from './PaymentReferences.js'; -import { PositiveAmountOfMoney } from './PositiveAmountOfMoney.js'; -import { ReturnInformation } from './ReturnInformation.js'; +import type { PaymentReferences } from './PaymentReferences.js'; +import type { PositiveAmountOfMoney } from './PositiveAmountOfMoney.js'; +import type { ReturnInformation } from './ReturnInformation.js'; /** - * Request to refund a payment for a Checkout. It is possible to perform multiple partial refunds by providing an amount that is lower than the total captured amount. The returnReason can be provided for reporting and reconciliation purposes but is not mandatory. + * @description Request to refund a payment for a Checkout. It is possible to perform multiple partial refunds by providing an + * amount that is lower than the total captured amount. + * The returnReason can be provided for reporting and reconciliation purposes but is not mandatory. */ -export class RefundRequest { - 'amountOfMoney'?: PositiveAmountOfMoney; - 'references'?: PaymentReferences; - '_return'?: ReturnInformation; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'amountOfMoney', - baseName: 'amountOfMoney', - type: 'PositiveAmountOfMoney', - format: '', - }, - { - name: 'references', - baseName: 'references', - type: 'PaymentReferences', - format: '', - }, - { - name: '_return', - baseName: 'return', - type: 'ReturnInformation', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return RefundRequest.attributeTypeMap; - } - - public constructor() {} +export interface RefundRequest { + amountOfMoney?: PositiveAmountOfMoney; + references?: PaymentReferences; + return?: ReturnInformation; } diff --git a/src/models/ReturnInformation.ts b/src/models/ReturnInformation.ts index ef0a92f..572a2aa 100644 --- a/src/models/ReturnInformation.ts +++ b/src/models/ReturnInformation.ts @@ -1,50 +1,15 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { CartItemInput } from './CartItemInput.js'; +import type { CartItemInput } from './CartItemInput.js'; /** - * Return object contains additional information about the return/shipment, which is the basis for the Refund. The amountOfMoney in the cartItem will not be used in the request. + * @description Return object contains additional information about the return/shipment, which is the basis for the Refund. + * The amountOfMoney in the cartItem will not be used in the request. */ -export class ReturnInformation { - /** - * Reason of the Refund (e.g. communicated by or to the consumer). - */ - 'returnReason'?: string; +export interface ReturnInformation { /** - * Items returned. + * @description Reason of the Refund (e.g. communicated by or to the consumer). + * @example Customer complained */ - 'items'?: Array; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'returnReason', - baseName: 'returnReason', - type: 'string', - format: '', - }, - { - name: 'items', - baseName: 'items', - type: 'Array', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return ReturnInformation.attributeTypeMap; - } - - public constructor() {} + returnReason?: string; + /** @description Items returned. */ + items?: CartItemInput[]; } diff --git a/src/models/ReturnItem.ts b/src/models/ReturnItem.ts index 8477ae0..fc7340c 100644 --- a/src/models/ReturnItem.ts +++ b/src/models/ReturnItem.ts @@ -1,45 +1,15 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -export class ReturnItem { +export interface ReturnItem { /** - * Id of the item to return. + * Format: UUID + * @description Id of the item to return. + * @example 4f0c512e-f12c-11ec-8ea0-0242ac120002 */ - 'id': string; + id: string; /** - * Quantity of the units being returned, should be greater than zero Note: Must not be all spaces or all zeros + * Format: int64 + * @description Quantity of the units being returned, should be greater than zero + * Note: Must not be all spaces or all zeros + * @example 1 */ - 'quantity': number; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'id', - baseName: 'id', - type: 'string', - format: 'UUID', - }, - { - name: 'quantity', - baseName: 'quantity', - type: 'number', - format: 'int64', - }, - ]; - - static getAttributeTypeMap() { - return ReturnItem.attributeTypeMap; - } - - public constructor() {} + quantity: number; } diff --git a/src/models/ReturnRequest.ts b/src/models/ReturnRequest.ts index 14babe6..129932c 100644 --- a/src/models/ReturnRequest.ts +++ b/src/models/ReturnRequest.ts @@ -1,55 +1,21 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - -import { ReturnItem } from './ReturnItem.js'; -import { ReturnType } from './ReturnType.js'; +import type { ReturnItem } from './ReturnItem.js'; +import type { ReturnType } from './ReturnType.js'; /** - * Request to mark items of the respective Checkout as returned and to automatically refund a payment for those items. A Return can be created for a full or the partial ShoppingCart of the Checkout. The platform will automatically calculate the respective amount to trigger the Refund. For a partial Return a list of items must be provided. The item details for the Refund will be automatically loaded from the Checkout. The returnReason can be provided for reporting and reconciliation purposes but is not mandatory. + * @description Request to mark items of the respective Checkout as returned and to automatically refund a payment for those + * items. + * A Return can be created for a full or the partial ShoppingCart of the Checkout. + * The platform will automatically calculate the respective amount to trigger the Refund. For a partial Return a + * list of items must be provided. + * The item details for the Refund will be automatically loaded from the Checkout. + * The returnReason can be provided for reporting and reconciliation purposes but is not mandatory. */ -export class ReturnRequest { - 'returnType'?: ReturnType; +export interface ReturnRequest { + returnType?: ReturnType; /** - * Reason of the Refund (e.g. communicated by or to the consumer). + * @description Reason of the Refund (e.g. communicated by or to the consumer). + * @example Customer complained */ - 'returnReason'?: string; - 'returnItems'?: Array; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'returnType', - baseName: 'returnType', - type: 'ReturnType', - format: '', - }, - { - name: 'returnReason', - baseName: 'returnReason', - type: 'string', - format: '', - }, - { - name: 'returnItems', - baseName: 'returnItems', - type: 'Array', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return ReturnRequest.attributeTypeMap; - } - - public constructor() {} + returnReason?: string; // Reason for the refund + returnItems?: ReturnItem[]; } diff --git a/src/models/ReturnResponse.ts b/src/models/ReturnResponse.ts index 658ea34..1612fc4 100644 --- a/src/models/ReturnResponse.ts +++ b/src/models/ReturnResponse.ts @@ -1,42 +1,7 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { RefundPaymentResponse } from './RefundPaymentResponse.js'; +import type { ShoppingCartResult } from './ShoppingCartResult.js'; -import { RefundPaymentResponse } from './RefundPaymentResponse.js'; -import { ShoppingCartResult } from './ShoppingCartResult.js'; - -export class ReturnResponse { - 'returnPaymentResponse'?: RefundPaymentResponse; - 'shoppingCart'?: ShoppingCartResult; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'returnPaymentResponse', - baseName: 'returnPaymentResponse', - type: 'RefundPaymentResponse', - format: '', - }, - { - name: 'shoppingCart', - baseName: 'shoppingCart', - type: 'ShoppingCartResult', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return ReturnResponse.attributeTypeMap; - } - - public constructor() {} +export interface ReturnResponse { + returnPaymentResponse?: RefundPaymentResponse; + shoppingCart?: ShoppingCartResult; } diff --git a/src/models/ReturnType.ts b/src/models/ReturnType.ts index a8f64cc..a6e5ad5 100644 --- a/src/models/ReturnType.ts +++ b/src/models/ReturnType.ts @@ -1,15 +1,3 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - /** * The returnType refers to the ShoppingCart items of the Checkout. returnType = FULL should be provided if all items should be marked as returned and the payment for the entire ShoppingCart should be refunded. returnType = PARTIAL should be provided if only certain items should be marked as returned and the Refund should not be made for the entire ShoppingCart. For this type the list of items has to be provided. Following conditions apply to the Return request: * items must be in status DELIVERED * there was no Capture, Refund or Cancel triggered over the Payment Execution resource * for the deliverType FULL no items are provided in the request Note: If a DISCOUNT productType is among the ShoppingCart items, only returnType FULL is possible. */ diff --git a/src/models/SepaDirectDebitPaymentMethodSpecificInput.ts b/src/models/SepaDirectDebitPaymentMethodSpecificInput.ts index e384a49..622b460 100644 --- a/src/models/SepaDirectDebitPaymentMethodSpecificInput.ts +++ b/src/models/SepaDirectDebitPaymentMethodSpecificInput.ts @@ -1,47 +1,12 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { SepaDirectDebitPaymentProduct771SpecificInput } from './SepaDirectDebitPaymentProduct771SpecificInput.js'; -import { SepaDirectDebitPaymentProduct771SpecificInput } from './SepaDirectDebitPaymentProduct771SpecificInput.js'; - -/** - * Object containing the specific input details for SEPA direct debit payments - */ -export class SepaDirectDebitPaymentMethodSpecificInput { - 'paymentProduct771SpecificInput'?: SepaDirectDebitPaymentProduct771SpecificInput; +/** @description Object containing the specific input details for SEPA direct debit payments */ +export interface SepaDirectDebitPaymentMethodSpecificInput { + paymentProduct771SpecificInput?: SepaDirectDebitPaymentProduct771SpecificInput; /** - * Payment product identifier - please check product documentation for a full overview of possible values. + * Format: int32 + * @description Payment product identifier - please check product documentation for a full overview of possible values. + * @example 840 */ - 'paymentProductId'?: number; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'paymentProduct771SpecificInput', - baseName: 'paymentProduct771SpecificInput', - type: 'SepaDirectDebitPaymentProduct771SpecificInput', - format: '', - }, - { - name: 'paymentProductId', - baseName: 'paymentProductId', - type: 'number', - format: 'int32', - }, - ]; - - static getAttributeTypeMap() { - return SepaDirectDebitPaymentMethodSpecificInput.attributeTypeMap; - } - - public constructor() {} + paymentProductId?: number; } diff --git a/src/models/SepaDirectDebitPaymentMethodSpecificOutput.ts b/src/models/SepaDirectDebitPaymentMethodSpecificOutput.ts index b36e536..dcadbf4 100644 --- a/src/models/SepaDirectDebitPaymentMethodSpecificOutput.ts +++ b/src/models/SepaDirectDebitPaymentMethodSpecificOutput.ts @@ -1,47 +1,12 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { PaymentProduct771SpecificOutput } from './PaymentProduct771SpecificOutput.js'; -import { PaymentProduct771SpecificOutput } from './PaymentProduct771SpecificOutput.js'; - -/** - * Object containing the SEPA direct debit details. - */ -export class SepaDirectDebitPaymentMethodSpecificOutput { +/** @description Object containing the SEPA direct debit details. */ +export interface SepaDirectDebitPaymentMethodSpecificOutput { /** - * Payment product identifier - please check product documentation for a full overview of possible values. + * Format: int32 + * @description Payment product identifier - please check product documentation for a full overview of possible values. + * @example 840 */ - 'paymentProductId'?: number; - 'paymentProduct771SpecificOutput'?: PaymentProduct771SpecificOutput; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'paymentProductId', - baseName: 'paymentProductId', - type: 'number', - format: 'int32', - }, - { - name: 'paymentProduct771SpecificOutput', - baseName: 'paymentProduct771SpecificOutput', - type: 'PaymentProduct771SpecificOutput', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return SepaDirectDebitPaymentMethodSpecificOutput.attributeTypeMap; - } - - public constructor() {} + paymentProductId?: number; + paymentProduct771SpecificOutput?: PaymentProduct771SpecificOutput; } diff --git a/src/models/SepaDirectDebitPaymentProduct771SpecificInput.ts b/src/models/SepaDirectDebitPaymentProduct771SpecificInput.ts index a1b8984..05df208 100644 --- a/src/models/SepaDirectDebitPaymentProduct771SpecificInput.ts +++ b/src/models/SepaDirectDebitPaymentProduct771SpecificInput.ts @@ -1,47 +1,11 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { ProcessingMandateInformation } from './ProcessingMandateInformation.js'; -import { ProcessingMandateInformation } from './ProcessingMandateInformation.js'; - -/** - * Object containing information specific to SEPA Direct Debit - */ -export class SepaDirectDebitPaymentProduct771SpecificInput { +/** @description Object containing information specific to SEPA Direct Debit */ +export interface SepaDirectDebitPaymentProduct771SpecificInput { /** - * The unique reference of the existing mandate to use in this payment. + * @description The unique reference of the existing mandate to use in this payment. + * @example exampleMandateReference */ - 'existingUniqueMandateReference'?: string; - 'mandate'?: ProcessingMandateInformation; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'existingUniqueMandateReference', - baseName: 'existingUniqueMandateReference', - type: 'string', - format: '', - }, - { - name: 'mandate', - baseName: 'mandate', - type: 'ProcessingMandateInformation', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return SepaDirectDebitPaymentProduct771SpecificInput.attributeTypeMap; - } - - public constructor() {} + existingUniqueMandateReference?: string; + mandate?: ProcessingMandateInformation; } diff --git a/src/models/Shipping.ts b/src/models/Shipping.ts index fc413e5..294a3b0 100644 --- a/src/models/Shipping.ts +++ b/src/models/Shipping.ts @@ -1,37 +1,6 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { AddressPersonal } from './AddressPersonal.js'; -import { AddressPersonal } from './AddressPersonal.js'; - -/** - * Object containing information regarding shipping / delivery - */ -export class Shipping { - 'address'?: AddressPersonal; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'address', - baseName: 'address', - type: 'AddressPersonal', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return Shipping.attributeTypeMap; - } - - public constructor() {} +/** @description Object containing information regarding shipping / delivery */ +export interface Shipping { + address?: AddressPersonal; } diff --git a/src/models/ShoppingCartInput.ts b/src/models/ShoppingCartInput.ts index 4bb6001..af86d04 100644 --- a/src/models/ShoppingCartInput.ts +++ b/src/models/ShoppingCartInput.ts @@ -1,37 +1,6 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CartItemInput } from './CartItemInput.js'; -import { CartItemInput } from './CartItemInput.js'; - -/** - * Shopping cart data, including items and specific amounts. - */ -export class ShoppingCartInput { - 'items'?: Array; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'items', - baseName: 'items', - type: 'Array', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return ShoppingCartInput.attributeTypeMap; - } - - public constructor() {} +/** @description Shopping cart data, including items and specific amounts. */ +export interface ShoppingCartInput { + items?: CartItemInput[]; } diff --git a/src/models/ShoppingCartPatch.ts b/src/models/ShoppingCartPatch.ts index 9b31b42..8ad8821 100644 --- a/src/models/ShoppingCartPatch.ts +++ b/src/models/ShoppingCartPatch.ts @@ -1,37 +1,6 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CartItemPatch } from './CartItemPatch.js'; -import { CartItemPatch } from './CartItemPatch.js'; - -/** - * Shopping cart data, including items and specific amounts. - */ -export class ShoppingCartPatch { - 'items'?: Array; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'items', - baseName: 'items', - type: 'Array', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return ShoppingCartPatch.attributeTypeMap; - } - - public constructor() {} +/** @description Shopping cart data, including items and specific amounts. */ +export interface ShoppingCartPatch { + items?: CartItemPatch[]; } diff --git a/src/models/ShoppingCartResult.ts b/src/models/ShoppingCartResult.ts index 0149d12..a0a7de9 100644 --- a/src/models/ShoppingCartResult.ts +++ b/src/models/ShoppingCartResult.ts @@ -1,37 +1,6 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { CartItemResult } from './CartItemResult.js'; -import { CartItemResult } from './CartItemResult.js'; - -/** - * Shopping cart data, including items and specific amounts. - */ -export class ShoppingCartResult { - 'items'?: Array; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'items', - baseName: 'items', - type: 'Array', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return ShoppingCartResult.attributeTypeMap; - } - - public constructor() {} +/** @description Shopping cart data, including items and specific amounts. */ +export interface ShoppingCartResult { + items?: CartItemResult[]; } diff --git a/src/models/StatusCategoryValue.ts b/src/models/StatusCategoryValue.ts index b57d9e5..f7bdc26 100644 --- a/src/models/StatusCategoryValue.ts +++ b/src/models/StatusCategoryValue.ts @@ -1,15 +1,3 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - /** * Highlevel status of the payment, payout or Refund. */ diff --git a/src/models/StatusCheckout.ts b/src/models/StatusCheckout.ts index 69aab10..db6022a 100644 --- a/src/models/StatusCheckout.ts +++ b/src/models/StatusCheckout.ts @@ -1,15 +1,3 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - /** * Current high-level status of the Checkout */ diff --git a/src/models/StatusOutput.ts b/src/models/StatusOutput.ts index 1f3bd7c..65be62e 100644 --- a/src/models/StatusOutput.ts +++ b/src/models/StatusOutput.ts @@ -1,105 +1,34 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { PaymentStatus } from './PaymentStatus.js'; -/** - * Contains information about whether the payment of the Checkout has already been completed and how much of the total sum has been collected already. - */ -export class StatusOutput { +/** @description Contains information about whether the payment of the Checkout has already been completed and how much of the total sum has been collected already. */ +export interface StatusOutput { + paymentStatus?: PaymentStatus; + /** @description Indicates whether the Checkout can still be modified. False if any payment is already in progress, true otherwise. */ + isModifiable?: boolean; /** - * * WAITING_FOR_PAYMENT - There does not yet exist a PaymentExecution nor a PaymentInformation for this Checkout. * PAYMENT_NOT_COMPLETED - There exists a PaymentExecution or a PaymentInformation for this Checkout, but all or some part of the total amount is still unpaid. * PAYMENT_COMPLETED - There exists a PaymentExecution or a PaymentInformation for this Checkout and the total amount is fully paid. * NO_PAYMENT - Checkout was created and deleted. No Payment Execution and no other actions can be triggered on the Checkout. + * Format: int64 + * @description Amount in cents always having 2 decimals. The amount yet to be paid. */ - 'paymentStatus'?: StatusOutputPaymentStatusEnum; + openAmount?: number; /** - * Indicates whether the Checkout can still be modified. False if any payment is already in progress, true otherwise. + * Format: int64 + * @description Amount in cents always having 2 decimals. The amount that has already been collected. */ - 'isModifiable'?: boolean; + collectedAmount?: number; /** - * Amount in cents always having 2 decimals. The amount yet to be paid. + * Format: int64 + * @description Amount in cents always having 2 decimals. The amount that has already been cancelled. */ - 'openAmount'?: number; + cancelledAmount?: number; /** - * Amount in cents always having 2 decimals. The amount that has already been collected. + * Format: int64 + * @description Amount in cents always having 2 decimals. Amount that has been collected but was refunded to the customer. */ - 'collectedAmount'?: number; + refundedAmount?: number; /** - * Amount in cents always having 2 decimals. The amount that has already been cancelled. + * Format: int64 + * @description Amount in cents always having 2 decimals. Amount that has been collected but was charged back by the + * customer. */ - 'cancelledAmount'?: number; - /** - * Amount in cents always having 2 decimals. Amount that has been collected but was refunded to the customer. - */ - 'refundedAmount'?: number; - /** - * Amount in cents always having 2 decimals. Amount that has been collected but was charged back by the customer. - */ - 'chargebackAmount'?: number; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'paymentStatus', - baseName: 'paymentStatus', - type: 'StatusOutputPaymentStatusEnum', - format: '', - }, - { - name: 'isModifiable', - baseName: 'isModifiable', - type: 'boolean', - format: '', - }, - { - name: 'openAmount', - baseName: 'openAmount', - type: 'number', - format: 'int64', - }, - { - name: 'collectedAmount', - baseName: 'collectedAmount', - type: 'number', - format: 'int64', - }, - { - name: 'cancelledAmount', - baseName: 'cancelledAmount', - type: 'number', - format: 'int64', - }, - { - name: 'refundedAmount', - baseName: 'refundedAmount', - type: 'number', - format: 'int64', - }, - { - name: 'chargebackAmount', - baseName: 'chargebackAmount', - type: 'number', - format: 'int64', - }, - ]; - - static getAttributeTypeMap() { - return StatusOutput.attributeTypeMap; - } - - public constructor() {} -} - -export enum StatusOutputPaymentStatusEnum { - WaitingForPayment = 'WAITING_FOR_PAYMENT', - PaymentNotCompleted = 'PAYMENT_NOT_COMPLETED', - PaymentCompleted = 'PAYMENT_COMPLETED', - NoPayment = 'NO_PAYMENT', + chargebackAmount?: number; } diff --git a/src/models/StatusValue.ts b/src/models/StatusValue.ts index f6142c9..e6c97b2 100644 --- a/src/models/StatusValue.ts +++ b/src/models/StatusValue.ts @@ -1,15 +1,3 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - /** * Current high-level status of the payment in a human-readable form. */ diff --git a/src/models/ThreeDSecureResults.ts b/src/models/ThreeDSecureResults.ts index 0c0fd42..7b94b7d 100644 --- a/src/models/ThreeDSecureResults.ts +++ b/src/models/ThreeDSecureResults.ts @@ -1,63 +1,16 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ +import type { AppliedExemption } from "./AppliedExemption.js"; -/** - * 3D Secure results object - */ -export class ThreeDSecureResults { +/** @description 3D Secure results object */ +export interface ThreeDSecureResults { /** - * 3D Secure Protocol version used during this transaction. + * @description 3D Secure Protocol version used during this transaction. + * @example 2.2.0 */ - 'version'?: string; + version?: string; /** - * 3D Secure ECI (Electronic Commerce Indicator) depending on the Scheme. Returned by DS. + * @description 3D Secure ECI (Electronic Commerce Indicator) depending on the Scheme. Returned by DS. + * @example 5 */ - 'schemeEci'?: string; - /** - * Exemption requested and applied in the authorization. - */ - 'appliedExemption'?: ThreeDSecureResultsAppliedExemptionEnum; - - static readonly discriminator: string | undefined = undefined; - - static readonly attributeTypeMap: Array<{ name: string; baseName: string; type: string; format: string }> = [ - { - name: 'version', - baseName: 'version', - type: 'string', - format: '', - }, - { - name: 'schemeEci', - baseName: 'schemeEci', - type: 'string', - format: '', - }, - { - name: 'appliedExemption', - baseName: 'appliedExemption', - type: 'ThreeDSecureResultsAppliedExemptionEnum', - format: '', - }, - ]; - - static getAttributeTypeMap() { - return ThreeDSecureResults.attributeTypeMap; - } - - public constructor() {} -} - -export enum ThreeDSecureResultsAppliedExemptionEnum { - LowValue = 'low-value', - MerchantAcquirerTransactionRiskAnalysis = 'merchant-acquirer-transaction-risk-analysis', + schemeEci?: string; + appliedExemption?: AppliedExemption; } diff --git a/src/models/TransactionChannel.ts b/src/models/TransactionChannel.ts index f624da8..37b40a8 100644 --- a/src/models/TransactionChannel.ts +++ b/src/models/TransactionChannel.ts @@ -1,15 +1,3 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - /** * Indicates the channel via which the payment is created. Allowed values: * ECOMMERCE - The transaction is a regular E-Commerce transaction. * MOTO - The transaction is a Mail Order/Telephone Order. Defaults to ECOMMERCE. */ diff --git a/src/models/UnscheduledCardOnFileRequestor.ts b/src/models/UnscheduledCardOnFileRequestor.ts index 3294824..9462bab 100644 --- a/src/models/UnscheduledCardOnFileRequestor.ts +++ b/src/models/UnscheduledCardOnFileRequestor.ts @@ -1,15 +1,3 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - /** * Indicates which party initiated the unscheduled recurring transaction. Allowed values: * merchantInitiated - Merchant Initiated Transaction. * cardholderInitiated - Cardholder Initiated Transaction. Note: * When a customer has chosen to use a token on a hosted Checkout this property is set to \"cardholderInitiated\". */ diff --git a/src/models/UnscheduledCardOnFileSequenceIndicator.ts b/src/models/UnscheduledCardOnFileSequenceIndicator.ts index 0ac1ce7..4851f82 100644 --- a/src/models/UnscheduledCardOnFileSequenceIndicator.ts +++ b/src/models/UnscheduledCardOnFileSequenceIndicator.ts @@ -1,15 +1,3 @@ -/** - * Commerce Platform API - * RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments. - * - * OpenAPI spec version: 1.8.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - /** * * first = This transaction is the first of a series of unscheduled recurring transactions * subsequent = This transaction is a subsequent transaction in a series of unscheduled recurring transactions Note: this property is not allowed if isRecurring is true. */ diff --git a/src/models/index.ts b/src/models/index.ts index e513f09..34d4bce 100644 --- a/src/models/index.ts +++ b/src/models/index.ts @@ -1,131 +1,131 @@ -export * from './APIError.js'; -export * from './Address.js'; -export * from './AddressPersonal.js'; -export * from './AllowedPaymentActions.js'; -export * from './AmountOfMoney.js'; -export * from './ApplePaymentDataTokenHeaderInformation.js'; -export * from './ApplePaymentDataTokenInformation.js'; -export * from './AuthorizationMode.js'; -export * from './BankAccountInformation.js'; -export * from './CancelItem.js'; -export * from './CancelPaymentRequest.js'; -export * from './CancelPaymentResponse.js'; -export * from './CancelRequest.js'; -export * from './CancelResponse.js'; -export * from './CancelType.js'; -export * from './CancellationReason.js'; -export * from './CaptureOutput.js'; -export * from './CapturePaymentRequest.js'; -export * from './CapturePaymentResponse.js'; -export * from './CardFraudResults.js'; -export * from './CardInfo.js'; -export * from './CardPaymentDetails.js'; -export * from './CardPaymentMethodSpecificInput.js'; -export * from './CardPaymentMethodSpecificOutput.js'; -export * from './CardRecurrenceDetails.js'; -export * from './CartItemInput.js'; -export * from './CartItemInvoiceData.js'; -export * from './CartItemOrderStatus.js'; -export * from './CartItemPatch.js'; -export * from './CartItemResult.js'; -export * from './CartItemStatus.js'; -export * from './CheckoutReferences.js'; -export * from './CheckoutResponse.js'; -export * from './CheckoutsResponse.js'; -export * from './CommerceCaseResponse.js'; -export * from './CompanyInformation.js'; -export * from './CompleteFinancingPaymentMethodSpecificInput.js'; -export * from './CompletePaymentMethodSpecificInput.js'; -export * from './CompletePaymentRequest.js'; -export * from './CompletePaymentResponse.js'; -export * from './ContactDetails.js'; -export * from './CreateCheckoutRequest.js'; -export * from './CreateCheckoutResponse.js'; -export * from './CreateCommerceCaseRequest.js'; -export * from './CreateCommerceCaseResponse.js'; -export * from './CreatePaymentResponse.js'; -export * from './Customer.js'; -export * from './CustomerDevice.js'; -export * from './DeliverItem.js'; -export * from './DeliverRequest.js'; -export * from './DeliverResponse.js'; -export * from './DeliverType.js'; -export * from './DeliveryInformation.js'; -export * from './ErrorResponse.js'; -export * from './ExtendedCheckoutStatus.js'; -export * from './FinancingPaymentMethodSpecificInput.js'; -export * from './FinancingPaymentMethodSpecificOutput.js'; -export * from './InstallmentOption.js'; -export * from './LinkInformation.js'; -export * from './MandateRecurrenceType.js'; -export * from './MerchantAction.js'; -export * from './MobilePaymentMethodSpecificInput.js'; -export * from './MobilePaymentMethodSpecificOutput.js'; -export * from './Order.js'; -export * from './OrderItem.js'; -export * from './OrderLineDetailsInput.js'; -export * from './OrderLineDetailsPatch.js'; -export * from './OrderLineDetailsResult.js'; -export * from './OrderRequest.js'; -export * from './OrderResponse.js'; -export * from './OrderType.js'; -export * from './PatchCheckoutRequest.js'; -export * from './PatchCommerceCaseRequest.js'; -export * from './PaymentChannel.js'; -export * from './PaymentCreationOutput.js'; -export * from './PaymentEvent.js'; -export * from './PaymentExecution.js'; -export * from './PaymentExecutionRequest.js'; -export * from './PaymentExecutionSpecificInput.js'; -export * from './PaymentInformationRequest.js'; -export * from './PaymentInformationResponse.js'; -export * from './PaymentMethodSpecificInput.js'; -export * from './PaymentOutput.js'; -export * from './PaymentProduct320SpecificInput.js'; -export * from './PaymentProduct3391SpecificInput.js'; -export * from './PaymentProduct3391SpecificOutput.js'; -export * from './PaymentProduct3392SpecificInput.js'; -export * from './PaymentProduct771SpecificOutput.js'; -export * from './PaymentProduct840CustomerAccount.js'; -export * from './PaymentProduct840SpecificOutput.js'; -export * from './PaymentReferences.js'; -export * from './PaymentResponse.js'; -export * from './PaymentStatusOutput.js'; -export * from './PaymentType.js'; -export * from './PayoutOutput.js'; -export * from './PayoutResponse.js'; -export * from './PersonalInformation.js'; -export * from './PersonalName.js'; -export * from './PositiveAmountOfMoney.js'; -export * from './ProcessingMandateInformation.js'; -export * from './ProductType.js'; -export * from './RedirectData.js'; -export * from './RedirectPaymentMethodSpecificInput.js'; -export * from './RedirectPaymentMethodSpecificOutput.js'; -export * from './RedirectPaymentProduct840SpecificInput.js'; -export * from './RedirectionData.js'; -export * from './References.js'; -export * from './RefundErrorResponse.js'; -export * from './RefundOutput.js'; -export * from './RefundPaymentResponse.js'; -export * from './RefundRequest.js'; -export * from './ReturnInformation.js'; -export * from './ReturnItem.js'; -export * from './ReturnRequest.js'; -export * from './ReturnResponse.js'; -export * from './ReturnType.js'; -export * from './SepaDirectDebitPaymentMethodSpecificInput.js'; -export * from './SepaDirectDebitPaymentMethodSpecificOutput.js'; -export * from './SepaDirectDebitPaymentProduct771SpecificInput.js'; -export * from './Shipping.js'; -export * from './ShoppingCartInput.js'; -export * from './ShoppingCartPatch.js'; -export * from './ShoppingCartResult.js'; -export * from './StatusCategoryValue.js'; -export * from './StatusCheckout.js'; -export * from './StatusOutput.js'; -export * from './StatusValue.js'; -export * from './ThreeDSecureResults.js'; -export * from './TransactionChannel.js'; -export * from './UnscheduledCardOnFileRequestor.js'; -export * from './UnscheduledCardOnFileSequenceIndicator.js'; +export type * from './APIError.js'; +export type * from './Address.js'; +export type * from './AddressPersonal.js'; +export type * from './AllowedPaymentActions.js'; +export type * from './AmountOfMoney.js'; +export type * from './ApplePaymentDataTokenHeaderInformation.js'; +export type * from './ApplePaymentDataTokenInformation.js'; +export type * from './AuthorizationMode.js'; +export type * from './BankAccountInformation.js'; +export type * from './CancelItem.js'; +export type * from './CancelPaymentRequest.js'; +export type * from './CancelPaymentResponse.js'; +export type * from './CancelRequest.js'; +export type * from './CancelResponse.js'; +export type * from './CancelType.js'; +export type * from './CancellationReason.js'; +export type * from './CaptureOutput.js'; +export type * from './CapturePaymentRequest.js'; +export type * from './CapturePaymentResponse.js'; +export type * from './CardFraudResults.js'; +export type * from './CardInfo.js'; +export type * from './CardPaymentDetails.js'; +export type * from './CardPaymentMethodSpecificInput.js'; +export type * from './CardPaymentMethodSpecificOutput.js'; +export type * from './CardRecurrenceDetails.js'; +export type * from './CartItemInput.js'; +export type * from './CartItemInvoiceData.js'; +export type * from './CartItemOrderStatus.js'; +export type * from './CartItemPatch.js'; +export type * from './CartItemResult.js'; +export type * from './CartItemStatus.js'; +export type * from './CheckoutReferences.js'; +export type * from './CheckoutResponse.js'; +export type * from './CheckoutsResponse.js'; +export type * from './CommerceCaseResponse.js'; +export type * from './CompanyInformation.js'; +export type * from './CompleteFinancingPaymentMethodSpecificInput.js'; +export type * from './CompletePaymentMethodSpecificInput.js'; +export type * from './CompletePaymentRequest.js'; +export type * from './CompletePaymentResponse.js'; +export type * from './ContactDetails.js'; +export type * from './CreateCheckoutRequest.js'; +export type * from './CreateCheckoutResponse.js'; +export type * from './CreateCommerceCaseRequest.js'; +export type * from './CreateCommerceCaseResponse.js'; +export type * from './CreatePaymentResponse.js'; +export type * from './Customer.js'; +export type * from './CustomerDevice.js'; +export type * from './DeliverItem.js'; +export type * from './DeliverRequest.js'; +export type * from './DeliverResponse.js'; +export type * from './DeliverType.js'; +export type * from './DeliveryInformation.js'; +export type * from './ErrorResponse.js'; +export type * from './ExtendedCheckoutStatus.js'; +export type * from './FinancingPaymentMethodSpecificInput.js'; +export type * from './FinancingPaymentMethodSpecificOutput.js'; +export type * from './InstallmentOption.js'; +export type * from './LinkInformation.js'; +export type * from './MandateRecurrenceType.js'; +export type * from './MerchantAction.js'; +export type * from './MobilePaymentMethodSpecificInput.js'; +export type * from './MobilePaymentMethodSpecificOutput.js'; +export type * from './Order.js'; +export type * from './OrderItem.js'; +export type * from './OrderLineDetailsInput.js'; +export type * from './OrderLineDetailsPatch.js'; +export type * from './OrderLineDetailsResult.js'; +export type * from './OrderRequest.js'; +export type * from './OrderResponse.js'; +export type * from './OrderType.js'; +export type * from './PatchCheckoutRequest.js'; +export type * from './PatchCommerceCaseRequest.js'; +export type * from './PaymentChannel.js'; +export type * from './PaymentCreationOutput.js'; +export type * from './PaymentEvent.js'; +export type * from './PaymentExecution.js'; +export type * from './PaymentExecutionRequest.js'; +export type * from './PaymentExecutionSpecificInput.js'; +export type * from './PaymentInformationRequest.js'; +export type * from './PaymentInformationResponse.js'; +export type * from './PaymentMethodSpecificInput.js'; +export type * from './PaymentOutput.js'; +export type * from './PaymentProduct320SpecificInput.js'; +export type * from './PaymentProduct3391SpecificInput.js'; +export type * from './PaymentProduct3391SpecificOutput.js'; +export type * from './PaymentProduct3392SpecificInput.js'; +export type * from './PaymentProduct771SpecificOutput.js'; +export type * from './PaymentProduct840CustomerAccount.js'; +export type * from './PaymentProduct840SpecificOutput.js'; +export type * from './PaymentReferences.js'; +export type * from './PaymentResponse.js'; +export type * from './PaymentStatusOutput.js'; +export type * from './PaymentType.js'; +export type * from './PayoutOutput.js'; +export type * from './PayoutResponse.js'; +export type * from './PersonalInformation.js'; +export type * from './PersonalName.js'; +export type * from './PositiveAmountOfMoney.js'; +export type * from './ProcessingMandateInformation.js'; +export type * from './ProductType.js'; +export type * from './RedirectData.js'; +export type * from './RedirectPaymentMethodSpecificInput.js'; +export type * from './RedirectPaymentMethodSpecificOutput.js'; +export type * from './RedirectPaymentProduct840SpecificInput.js'; +export type * from './RedirectionData.js'; +export type * from './References.js'; +export type * from './RefundErrorResponse.js'; +export type * from './RefundOutput.js'; +export type * from './RefundPaymentResponse.js'; +export type * from './RefundRequest.js'; +export type * from './ReturnInformation.js'; +export type * from './ReturnItem.js'; +export type * from './ReturnRequest.js'; +export type * from './ReturnResponse.js'; +export type * from './ReturnType.js'; +export type * from './SepaDirectDebitPaymentMethodSpecificInput.js'; +export type * from './SepaDirectDebitPaymentMethodSpecificOutput.js'; +export type * from './SepaDirectDebitPaymentProduct771SpecificInput.js'; +export type * from './Shipping.js'; +export type * from './ShoppingCartInput.js'; +export type * from './ShoppingCartPatch.js'; +export type * from './ShoppingCartResult.js'; +export type * from './StatusCategoryValue.js'; +export type * from './StatusCheckout.js'; +export type * from './StatusOutput.js'; +export type * from './StatusValue.js'; +export type * from './ThreeDSecureResults.js'; +export type * from './TransactionChannel.js'; +export type * from './UnscheduledCardOnFileRequestor.js'; +export type * from './UnscheduledCardOnFileSequenceIndicator.js';