@emilgroup/payment-sdk-node 1.8.2 → 1.12.1

package/dist/models/link-bank-transaction-request-dto.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Emil Payment Service
+ * This service directly communicates with the various Payment Service Providers (PSPs)    in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface LinkBankTransactionRequestDto
+ */
+export interface LinkBankTransactionRequestDto {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof LinkBankTransactionRequestDto
+     */
+    'code': string;
+    /**
+     * The code of the invoice that the transaction will be linked to.
+     * @type {string}
+     * @memberof LinkBankTransactionRequestDto
+     */
+    'invoiceCode': string;
+}

package/dist/models/link-bank-transaction-request-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil Payment Service
+ * This service directly communicates with the various Payment Service Providers (PSPs)    in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/list-bank-transactions-response-class.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Emil Payment Service
+ * This service directly communicates with the various Payment Service Providers (PSPs)    in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { BankTransactionResponseClass } from './bank-transaction-response-class';
+/**
+ *
+ * @export
+ * @interface ListBankTransactionsResponseClass
+ */
+export interface ListBankTransactionsResponseClass {
+    /**
+     * The list of bankTransactionss.
+     * @type {Array<BankTransactionResponseClass>}
+     * @memberof ListBankTransactionsResponseClass
+     */
+    'items': Array<BankTransactionResponseClass>;
+    /**
+     * Next page token
+     * @type {string}
+     * @memberof ListBankTransactionsResponseClass
+     */
+    'nextPageToken': string;
+}

package/dist/models/list-bank-transactions-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil Payment Service
+ * This service directly communicates with the various Payment Service Providers (PSPs)    in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/list-refunds-response-class.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Emil Payment Service
+ * This service directly communicates with the various Payment Service Providers (PSPs)    in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { RefundClass } from './refund-class';
+/**
+ *
+ * @export
+ * @interface ListRefundsResponseClass
+ */
+export interface ListRefundsResponseClass {
+    /**
+     * The list of refundss.
+     * @type {Array<RefundClass>}
+     * @memberof ListRefundsResponseClass
+     */
+    'items': Array<RefundClass>;
+    /**
+     * Next page token
+     * @type {string}
+     * @memberof ListRefundsResponseClass
+     */
+    'nextPageToken': string;
+}

package/dist/models/list-refunds-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil Payment Service
+ * This service directly communicates with the various Payment Service Providers (PSPs)    in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/payment-class.d.ts

@@ -71,7 +71,7 @@ export interface PaymentClass {
      */
     'metadata': object;
     /**
-     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
+     * A slug is a human-readable, unique identifier, used to identify a resource     instead of a less human-readable identifier like an id.
      * @type {string}
      * @memberof PaymentClass
      */

package/dist/models/payment-method-class.d.ts

@@ -40,7 +40,7 @@ export interface PaymentMethodClass {
      */
     'pspCustomerId': string;
     /**
-     * The payment service provider used by this payment method.
+     * The payment service provider associated to this payment method.
      * @type {string}
      * @memberof PaymentMethodClass
      */
@@ -52,7 +52,13 @@ export interface PaymentMethodClass {
      */
     'type': string;
     /**
-     * Created at
+     * Optional field contain extra information
+     * @type {object}
+     * @memberof PaymentMethodClass
+     */
+    'metadata': object;
+    /**
+     * Time at which the object was created.
      * @type {string}
      * @memberof PaymentMethodClass
      */

package/dist/models/payment-reminder-class.d.ts

@@ -95,6 +95,8 @@ export declare const PaymentReminderClassInvoiceTypeEnum: {
     readonly Estimated: "estimated";
     readonly Penalty: "penalty";
     readonly Other: "other";
+    readonly Withdraw: "withdraw";
+    readonly Final: "final";
 };
 export type PaymentReminderClassInvoiceTypeEnum = typeof PaymentReminderClassInvoiceTypeEnum[keyof typeof PaymentReminderClassInvoiceTypeEnum];
 export declare const PaymentReminderClassPaymentCodeEnum: {
@@ -104,5 +106,7 @@ export declare const PaymentReminderClassPaymentCodeEnum: {
     readonly Estimated: "estimated";
     readonly Penalty: "penalty";
     readonly Other: "other";
+    readonly Withdraw: "withdraw";
+    readonly Final: "final";
 };
 export type PaymentReminderClassPaymentCodeEnum = typeof PaymentReminderClassPaymentCodeEnum[keyof typeof PaymentReminderClassPaymentCodeEnum];

package/dist/models/payment-reminder-class.js

@@ -20,7 +20,9 @@ exports.PaymentReminderClassInvoiceTypeEnum = {
     Correction: 'correction',
     Estimated: 'estimated',
     Penalty: 'penalty',
-    Other: 'other'
+    Other: 'other',
+    Withdraw: 'withdraw',
+    Final: 'final'
 };
 exports.PaymentReminderClassPaymentCodeEnum = {
     Initial: 'initial',
@@ -28,5 +30,7 @@ exports.PaymentReminderClassPaymentCodeEnum = {
     Correction: 'correction',
     Estimated: 'estimated',
     Penalty: 'penalty',
-    Other: 'other'
+    Other: 'other',
+    Withdraw: 'withdraw',
+    Final: 'final'
 };

package/dist/models/refund-class.d.ts

@@ -0,0 +1,104 @@
+/**
+ * Emil Payment Service
+ * This service directly communicates with the various Payment Service Providers (PSPs)    in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface RefundClass
+ */
+export interface RefundClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof RefundClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof RefundClass
+     */
+    'code': string;
+    /**
+     * Payment Service Provider with which the payment/refund is done.
+     * @type {string}
+     * @memberof RefundClass
+     */
+    'psp': string;
+    /**
+     * User account code associated with the payment.
+     * @type {string}
+     * @memberof RefundClass
+     */
+    'accountCode': string;
+    /**
+     * Amount that was refunded in cents. 100 to refund 1€.
+     * @type {number}
+     * @memberof RefundClass
+     */
+    'amount': number;
+    /**
+     * Invoice referenced in this refund. Usually, one refund is connected to one      withdraw/termination/correction invoice .
+     * @type {string}
+     * @memberof RefundClass
+     */
+    'invoiceCode': string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof RefundClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof RefundClass
+     */
+    'updatedAt': string;
+    /**
+     * Currency of the amount refunded.
+     * @type {string}
+     * @memberof RefundClass
+     */
+    'currency': string;
+    /**
+     * Reason for the refund.
+     * @type {string}
+     * @memberof RefundClass
+     */
+    'reason': RefundClassReasonEnum;
+    /**
+     * Status of the refund.
+     * @type {string}
+     * @memberof RefundClass
+     */
+    'status': RefundClassStatusEnum;
+    /**
+     * Items that were refunded.
+     * @type {Array<string>}
+     * @memberof RefundClass
+     */
+    'refundItems': Array<string>;
+}
+export declare const RefundClassReasonEnum: {
+    readonly PolicyWithdrawn: "POLICY_WITHDRAWN";
+    readonly PolicyTerminated: "POLICY_TERMINATED";
+    readonly PolicyCorrected: "POLICY_CORRECTED";
+    readonly ManualRefund: "MANUAL_REFUND";
+};
+export type RefundClassReasonEnum = typeof RefundClassReasonEnum[keyof typeof RefundClassReasonEnum];
+export declare const RefundClassStatusEnum: {
+    readonly Pending: "pending";
+    readonly Succeeded: "succeeded";
+    readonly Failed: "failed";
+    readonly Canceled: "canceled";
+};
+export type RefundClassStatusEnum = typeof RefundClassStatusEnum[keyof typeof RefundClassStatusEnum];

package/dist/models/refund-class.js

@@ -0,0 +1,28 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil Payment Service
+ * This service directly communicates with the various Payment Service Providers (PSPs)    in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RefundClassStatusEnum = exports.RefundClassReasonEnum = void 0;
+exports.RefundClassReasonEnum = {
+    PolicyWithdrawn: 'POLICY_WITHDRAWN',
+    PolicyTerminated: 'POLICY_TERMINATED',
+    PolicyCorrected: 'POLICY_CORRECTED',
+    ManualRefund: 'MANUAL_REFUND'
+};
+exports.RefundClassStatusEnum = {
+    Pending: 'pending',
+    Succeeded: 'succeeded',
+    Failed: 'failed',
+    Canceled: 'canceled'
+};

package/dist/models/tenant-bank-account-response-class.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Emil Payment Service
+ * This service directly communicates with the various Payment Service Providers (PSPs)    in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface TenantBankAccountResponseClass
+ */
+export interface TenantBankAccountResponseClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof TenantBankAccountResponseClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof TenantBankAccountResponseClass
+     */
+    'code': string;
+    /**
+     * IBAN number for the bank account
+     * @type {string}
+     * @memberof TenantBankAccountResponseClass
+     */
+    'iban': string;
+    /**
+     * Name of the account given by the user - to quickly identify the account
+     * @type {string}
+     * @memberof TenantBankAccountResponseClass
+     */
+    'accountName': string;
+    /**
+     * Name of the bank the account belongs to
+     * @type {string}
+     * @memberof TenantBankAccountResponseClass
+     */
+    'bankName': string;
+    /**
+     * Number of the booking account this bank account belongs to
+     * @type {string}
+     * @memberof TenantBankAccountResponseClass
+     */
+    'bookingAccount': string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof TenantBankAccountResponseClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof TenantBankAccountResponseClass
+     */
+    'updatedAt': string;
+}

package/dist/models/tenant-bank-account-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil Payment Service
+ * This service directly communicates with the various Payment Service Providers (PSPs)    in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/update-tenant-bank-account-rest-request-dto.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Emil Payment Service
+ * This service directly communicates with the various Payment Service Providers (PSPs)    in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface UpdateTenantBankAccountRestRequestDto
+ */
+export interface UpdateTenantBankAccountRestRequestDto {
+    /**
+     * Name of the account given by the user - to quickly identify the account
+     * @type {string}
+     * @memberof UpdateTenantBankAccountRestRequestDto
+     */
+    'accountName': string;
+    /**
+     * Name of the bank the account belongs to
+     * @type {string}
+     * @memberof UpdateTenantBankAccountRestRequestDto
+     */
+    'bankName': string;
+    /**
+     * The name of the account
+     * @type {string}
+     * @memberof UpdateTenantBankAccountRestRequestDto
+     */
+    'bookingAccount': string;
+}

package/dist/models/update-tenant-bank-account-rest-request-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil Payment Service
+ * This service directly communicates with the various Payment Service Providers (PSPs)    in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/models/bank-transaction-response-class.ts

@@ -0,0 +1,128 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil Payment Service
+ * This service directly communicates with the various Payment Service Providers (PSPs)    in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { TenantBankAccountResponseClass } from './tenant-bank-account-response-class';
+import { TransactionClass } from './transaction-class';
+
+/**
+ * 
+ * @export
+ * @interface BankTransactionResponseClass
+ */
+export interface BankTransactionResponseClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof BankTransactionResponseClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof BankTransactionResponseClass
+     */
+    'code': string;
+    /**
+     * Bank account ID associated with the transaction.
+     * @type {number}
+     * @memberof BankTransactionResponseClass
+     */
+    'bankAccountId': number;
+    /**
+     * Account number of the bank account
+     * @type {string}
+     * @memberof BankTransactionResponseClass
+     */
+    'bankAccountNumber': string;
+    /**
+     * Reference number derived from the MT940 swift Insturctions
+     * @type {string}
+     * @memberof BankTransactionResponseClass
+     */
+    'swiftMessageReference'?: string;
+    /**
+     * Currency of the transaction.
+     * @type {string}
+     * @memberof BankTransactionResponseClass
+     */
+    'currency': string;
+    /**
+     * Amount of the transaction - can be negative or positive
+     * @type {string}
+     * @memberof BankTransactionResponseClass
+     */
+    'amount': string;
+    /**
+     * Date on which the transaction was executed. Also known as Value Date
+     * @type {string}
+     * @memberof BankTransactionResponseClass
+     */
+    'transactionDate': string;
+    /**
+     * Date on which the transaction entry was made in the system. Also known as Booking Date
+     * @type {string}
+     * @memberof BankTransactionResponseClass
+     */
+    'entryDate': string;
+    /**
+     * Optional reference number that can be given by the customer or bank to uniquely identify a transaction. If no transaction reference is provided the value is set to \'NONREF\'
+     * @type {string}
+     * @memberof BankTransactionResponseClass
+     */
+    'transactionReference': string;
+    /**
+     * Optional metadata that can be provided by the customer or bank to give more context to the transaction
+     * @type {object}
+     * @memberof BankTransactionResponseClass
+     */
+    'metadata'?: object;
+    /**
+     * The id of the PSP transaction that this bank transaction is linked to
+     * @type {number}
+     * @memberof BankTransactionResponseClass
+     */
+    'linkedTransactionId': number;
+    /**
+     * The code of the invoice that this bank transaction is linked to
+     * @type {string}
+     * @memberof BankTransactionResponseClass
+     */
+    'linkedInvoiceCode'?: string;
+    /**
+     * Boolean flag to indicate if the bank transaction is linked to an invoice - defaults to false
+     * @type {boolean}
+     * @memberof BankTransactionResponseClass
+     */
+    'isLinked': boolean;
+    /**
+     * The bank account object that this transaction is belongs to
+     * @type {TenantBankAccountResponseClass}
+     * @memberof BankTransactionResponseClass
+     */
+    'bankAccount': TenantBankAccountResponseClass;
+    /**
+     * The linked transaction object
+     * @type {TransactionClass}
+     * @memberof BankTransactionResponseClass
+     */
+    'linkedTransaction': TransactionClass;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof BankTransactionResponseClass
+     */
+    'createdAt': string;
+}
+

package/models/create-payment-reminder-request-dto.ts

@@ -64,7 +64,9 @@ export const CreatePaymentReminderRequestDtoInvoiceTypeEnum = {
     Correction: 'correction',
     Estimated: 'estimated',
     Penalty: 'penalty',
-    Other: 'other'
+    Other: 'other',
+    Withdraw: 'withdraw',
+    Final: 'final'
 } as const;
 
 export type CreatePaymentReminderRequestDtoInvoiceTypeEnum = typeof CreatePaymentReminderRequestDtoInvoiceTypeEnum[keyof typeof CreatePaymentReminderRequestDtoInvoiceTypeEnum];

package/models/create-payment-request-dto.ts

@@ -40,10 +40,10 @@ export interface CreatePaymentRequestDto {
     'currency'?: string;
     /**
      * Invoices referenced in this payment. Usually, one payment has one invoice id        but it is possible to pay multiple invoices at once with a single payment.
-     * @type {Array<string>}
+     * @type {Array<number>}
      * @memberof CreatePaymentRequestDto
      */
-    'invoiceIds': Array<string>;
+    'invoiceIds': Array<number>;
     /**
      * Optional field contain extra information.
      * @type {object}
@@ -51,7 +51,7 @@ export interface CreatePaymentRequestDto {
      */
     'metadata': object;
     /**
-     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
+     * A slug is a human-readable, unique identifier, used to identify a resource     instead of a less human-readable identifier like an id.
      * @type {string}
      * @memberof CreatePaymentRequestDto
      */