@emilgroup/payment-sdk-node 1.23.1-beta.10 → 1.23.1-beta.100

package/models/bank-data-class.ts

@@ -0,0 +1,42 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface BankDataClass
+ */
+export interface BankDataClass {
+    /**
+     * BIC
+     * @type {string}
+     * @memberof BankDataClass
+     */
+    'bic': string;
+    /**
+     * Bank name
+     * @type {string}
+     * @memberof BankDataClass
+     */
+    'name': string;
+    /**
+     * Bank code
+     * @type {string}
+     * @memberof BankDataClass
+     */
+    'code': string;
+}
+

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

@@ -0,0 +1,74 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CreatePaymentReceiptRequestDto
+ */
+export interface CreatePaymentReceiptRequestDto {
+    /**
+     * amount
+     * @type {number}
+     * @memberof CreatePaymentReceiptRequestDto
+     */
+    'amount': number;
+    /**
+     * currency
+     * @type {string}
+     * @memberof CreatePaymentReceiptRequestDto
+     */
+    'currency': string;
+    /**
+     * The flow of the payment: disburse or collect
+     * @type {string}
+     * @memberof CreatePaymentReceiptRequestDto
+     */
+    'direction': CreatePaymentReceiptRequestDtoDirectionEnum;
+    /**
+     * Date the payment was confirmed
+     * @type {string}
+     * @memberof CreatePaymentReceiptRequestDto
+     */
+    'dateOfPayment': string;
+    /**
+     * paymentRequestCode
+     * @type {string}
+     * @memberof CreatePaymentReceiptRequestDto
+     */
+    'paymentRequestCode'?: string;
+    /**
+     * psp
+     * @type {string}
+     * @memberof CreatePaymentReceiptRequestDto
+     */
+    'psp'?: string;
+    /**
+     * comment
+     * @type {string}
+     * @memberof CreatePaymentReceiptRequestDto
+     */
+    'comment'?: string;
+}
+
+export const CreatePaymentReceiptRequestDtoDirectionEnum = {
+    Collect: 'collect',
+    Disburse: 'disburse'
+} as const;
+
+export type CreatePaymentReceiptRequestDtoDirectionEnum = typeof CreatePaymentReceiptRequestDtoDirectionEnum[keyof typeof CreatePaymentReceiptRequestDtoDirectionEnum];
+
+

package/models/create-payment-receipt-response-class.ts

@@ -0,0 +1,31 @@
+/* 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 { PaymentReceiptClass } from './payment-receipt-class';
+
+/**
+ * 
+ * @export
+ * @interface CreatePaymentReceiptResponseClass
+ */
+export interface CreatePaymentReceiptResponseClass {
+    /**
+     * The created payment receipt with all its details.
+     * @type {PaymentReceiptClass}
+     * @memberof CreatePaymentReceiptResponseClass
+     */
+    'paymentReceipt'?: PaymentReceiptClass;
+}
+

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

@@ -27,7 +27,7 @@ export interface CreatePaymentRequestRequestDto {
      */
     'amount': number;
     /**
-     * Currency code for the payment request.
+     * Currency code for the payment request (ISO 4217 format).
      * @type {string}
      * @memberof CreatePaymentRequestRequestDto
      */
@@ -39,17 +39,47 @@ export interface CreatePaymentRequestRequestDto {
      */
     'direction': CreatePaymentRequestRequestDtoDirectionEnum;
     /**
-     * Code of the source entity (e.g., invoice code, claim code) that this payment request is associated with.
+     * Code of the financial entity (e.g., invoice code, claim adjustment code) that this payment request is associated with.
      * @type {string}
      * @memberof CreatePaymentRequestRequestDto
      */
-    'sourceEntityCode'?: string;
+    'financialEntityCode': string;
     /**
-     * Type of the payment request. Defines the business context or purpose of the payment.
+     * Number of the financial entity (e.g., invoice number, claim adjustment number).
      * @type {string}
      * @memberof CreatePaymentRequestRequestDto
      */
-    'type': CreatePaymentRequestRequestDtoTypeEnum;
+    'financialEntityNumber': string;
+    /**
+     * Type of the financial entity (e.g., refund_allocation, claim_regulation).
+     * @type {string}
+     * @memberof CreatePaymentRequestRequestDto
+     */
+    'financialEntityType': CreatePaymentRequestRequestDtoFinancialEntityTypeEnum;
+    /**
+     * Code of the domain entity (e.g., policy code, claim code) that this payment request is associated with.
+     * @type {string}
+     * @memberof CreatePaymentRequestRequestDto
+     */
+    'domainEntityCode': string;
+    /**
+     * Number of the domain entity (e.g., policy number, claim number).
+     * @type {string}
+     * @memberof CreatePaymentRequestRequestDto
+     */
+    'domainEntityNumber': string;
+    /**
+     * Type of the domain entity (e.g., policy, claim).
+     * @type {string}
+     * @memberof CreatePaymentRequestRequestDto
+     */
+    'domainEntityType': CreatePaymentRequestRequestDtoDomainEntityTypeEnum;
+    /**
+     * Code of the settlement the payment request was created for.
+     * @type {string}
+     * @memberof CreatePaymentRequestRequestDto
+     */
+    'settlementCode'?: string;
     /**
      * Code of the payment method to be used for this payment request. If not provided, a default payment method may be selected.
      * @type {string}
@@ -58,10 +88,10 @@ export interface CreatePaymentRequestRequestDto {
     'paymentMethodCode'?: string;
     /**
      * Optional field containing extra information about the payment request.
-     * @type {object}
+     * @type {{ [key: string]: object; }}
      * @memberof CreatePaymentRequestRequestDto
      */
-    'metadata'?: object;
+    'metadata'?: { [key: string]: object; };
 }
 
 export const CreatePaymentRequestRequestDtoDirectionEnum = {
@@ -70,13 +100,19 @@ export const CreatePaymentRequestRequestDtoDirectionEnum = {
 } as const;
 
 export type CreatePaymentRequestRequestDtoDirectionEnum = typeof CreatePaymentRequestRequestDtoDirectionEnum[keyof typeof CreatePaymentRequestRequestDtoDirectionEnum];
-export const CreatePaymentRequestRequestDtoTypeEnum = {
+export const CreatePaymentRequestRequestDtoFinancialEntityTypeEnum = {
+    ClaimRegulation: 'claim_regulation',
+    RefundAllocation: 'refund_allocation',
+    Other: 'other'
+} as const;
+
+export type CreatePaymentRequestRequestDtoFinancialEntityTypeEnum = typeof CreatePaymentRequestRequestDtoFinancialEntityTypeEnum[keyof typeof CreatePaymentRequestRequestDtoFinancialEntityTypeEnum];
+export const CreatePaymentRequestRequestDtoDomainEntityTypeEnum = {
     Other: 'other',
     Claim: 'claim',
-    Premium: 'premium',
-    Commission: 'commission'
+    Policy: 'policy'
 } as const;
 
-export type CreatePaymentRequestRequestDtoTypeEnum = typeof CreatePaymentRequestRequestDtoTypeEnum[keyof typeof CreatePaymentRequestRequestDtoTypeEnum];
+export type CreatePaymentRequestRequestDtoDomainEntityTypeEnum = typeof CreatePaymentRequestRequestDtoDomainEntityTypeEnum[keyof typeof CreatePaymentRequestRequestDtoDomainEntityTypeEnum];
 
 

package/models/create-payout-method-by-bank-account-request-dto.ts

@@ -0,0 +1,42 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CreatePayoutMethodByBankAccountRequestDto
+ */
+export interface CreatePayoutMethodByBankAccountRequestDto {
+    /**
+     * The code identifying the bank account that will be used to create the payout method.
+     * @type {string}
+     * @memberof CreatePayoutMethodByBankAccountRequestDto
+     */
+    'bankAccountCode': string;
+    /**
+     * Billing address code
+     * @type {string}
+     * @memberof CreatePayoutMethodByBankAccountRequestDto
+     */
+    'billingAddressCode': string;
+    /**
+     * Unique identifier of the partner that this object belongs to.
+     * @type {string}
+     * @memberof CreatePayoutMethodByBankAccountRequestDto
+     */
+    'partnerCode': string;
+}
+

package/models/create-payout-method-request-dto.ts

@@ -31,13 +31,19 @@ export interface CreatePayoutMethodRequestDto {
      * @type {string}
      * @memberof CreatePayoutMethodRequestDto
      */
-    'firstName': string;
+    'firstName'?: string;
     /**
      * Last name
      * @type {string}
      * @memberof CreatePayoutMethodRequestDto
      */
-    'lastName': string;
+    'lastName'?: string;
+    /**
+     * Account holder
+     * @type {string}
+     * @memberof CreatePayoutMethodRequestDto
+     */
+    'accountHolder'?: string;
     /**
      * IBAN
      * @type {string}

package/models/get-payment-receipt-response-class.ts

@@ -0,0 +1,31 @@
+/* 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 { PaymentReceiptClass } from './payment-receipt-class';
+
+/**
+ * 
+ * @export
+ * @interface GetPaymentReceiptResponseClass
+ */
+export interface GetPaymentReceiptResponseClass {
+    /**
+     * The payment receipt retrieved by its code.
+     * @type {PaymentReceiptClass}
+     * @memberof GetPaymentReceiptResponseClass
+     */
+    'paymentReceipt'?: PaymentReceiptClass;
+}
+

package/models/index.ts

@@ -1,6 +1,7 @@
 export * from './activate-policy-payment-method-request-dto';
 export * from './bank-account-class';
 export * from './bank-account-class-without-expand-properties';
+export * from './bank-data-class';
 export * from './bank-order-class';
 export * from './bank-order-entity';
 export * from './bank-order-xml-file-class';
@@ -33,12 +34,15 @@ export * from './create-credit-allocation-response-class';
 export * from './create-payment-method-response-class';
 export * from './create-payment-order-dto';
 export * from './create-payment-order-request-dto';
+export * from './create-payment-receipt-request-dto';
+export * from './create-payment-receipt-response-class';
 export * from './create-payment-reminder-request-dto';
 export * from './create-payment-reminder-response-class';
 export * from './create-payment-request-dto';
 export * from './create-payment-request-request-dto';
 export * from './create-payment-request-response-class';
 export * from './create-payment-response-class';
+export * from './create-payout-method-by-bank-account-request-dto';
 export * from './create-payout-method-request-dto';
 export * from './create-payout-method-response-class';
 export * from './create-policy-payment-method-request-dto';
@@ -64,6 +68,7 @@ export * from './get-billing-address-response-class';
 export * from './get-credit-allocation-response-class';
 export * from './get-exceeding-credit-response-class';
 export * from './get-payment-method-response-class';
+export * from './get-payment-receipt-response-class';
 export * from './get-payment-reminder-response-class';
 export * from './get-payment-request-response-class';
 export * from './get-payment-response-class';
@@ -94,6 +99,7 @@ export * from './list-billing-addresses-response-class';
 export * from './list-credit-allocations-response-class';
 export * from './list-exceeding-credits-response-class';
 export * from './list-payment-methods-response-class';
+export * from './list-payment-receipts-response-class';
 export * from './list-payment-reminders-response-class';
 export * from './list-payment-requests-response-class';
 export * from './list-payments-response-class';
@@ -108,6 +114,7 @@ export * from './payment-class';
 export * from './payment-class-without-expand-properties';
 export * from './payment-entity';
 export * from './payment-method-class';
+export * from './payment-receipt-class';
 export * from './payment-reminder-class';
 export * from './payment-request-class';
 export * from './payout-method-class';
@@ -134,8 +141,11 @@ export * from './update-bank-order-request-dto';
 export * from './update-bank-order-response-class';
 export * from './update-billing-address-request-dto';
 export * from './update-billing-address-response-class';
+export * from './update-payment-receipt-response-class';
 export * from './update-payment-request-request-dto';
 export * from './update-payment-request-response-class';
 export * from './update-tenant-bank-account-response-class';
 export * from './update-tenant-bank-account-rest-request-dto';
+export * from './validate-iban-request-dto';
+export * from './validate-iban-response-class';
 export * from './validate-pspconfig-request-dto';

package/models/list-billing-addresses-response-class.ts

@@ -21,18 +21,18 @@ import { BillingAddressClass } from './billing-address-class';
  * @interface ListBillingAddressesResponseClass
  */
 export interface ListBillingAddressesResponseClass {
-    /**
-     * The billing addresses
-     * @type {Array<BillingAddressClass>}
-     * @memberof ListBillingAddressesResponseClass
-     */
-    'items': Array<BillingAddressClass>;
     /**
      * Next page token.
      * @type {string}
      * @memberof ListBillingAddressesResponseClass
      */
     'nextPageToken': string;
+    /**
+     * Total amount of items.
+     * @type {number}
+     * @memberof ListBillingAddressesResponseClass
+     */
+    'totalItems': number;
     /**
      * Items per page.
      * @type {number}
@@ -40,10 +40,10 @@ export interface ListBillingAddressesResponseClass {
      */
     'itemsPerPage': number;
     /**
-     * Total amount of items.
-     * @type {number}
+     * The billing addresses
+     * @type {Array<BillingAddressClass>}
      * @memberof ListBillingAddressesResponseClass
      */
-    'totalItems': number;
+    'items': Array<BillingAddressClass>;
 }
 

package/models/list-exceeding-credits-response-class.ts

@@ -21,17 +21,29 @@ import { ExceedingCreditClass } from './exceeding-credit-class';
  * @interface ListExceedingCreditsResponseClass
  */
 export interface ListExceedingCreditsResponseClass {
-    /**
-     * The list of exceeding credits.
-     * @type {Array<ExceedingCreditClass>}
-     * @memberof ListExceedingCreditsResponseClass
-     */
-    'items': Array<ExceedingCreditClass>;
     /**
      * Next page token.
      * @type {string}
      * @memberof ListExceedingCreditsResponseClass
      */
     'nextPageToken': string;
+    /**
+     * Total amount of items.
+     * @type {number}
+     * @memberof ListExceedingCreditsResponseClass
+     */
+    'totalItems': number;
+    /**
+     * Items per page.
+     * @type {number}
+     * @memberof ListExceedingCreditsResponseClass
+     */
+    'itemsPerPage': number;
+    /**
+     * The list of exceeding credits.
+     * @type {Array<ExceedingCreditClass>}
+     * @memberof ListExceedingCreditsResponseClass
+     */
+    'items': Array<ExceedingCreditClass>;
 }
 

package/models/list-payment-receipts-response-class.ts

@@ -0,0 +1,49 @@
+/* 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 { PaymentReceiptClass } from './payment-receipt-class';
+
+/**
+ * 
+ * @export
+ * @interface ListPaymentReceiptsResponseClass
+ */
+export interface ListPaymentReceiptsResponseClass {
+    /**
+     * Next page token.
+     * @type {string}
+     * @memberof ListPaymentReceiptsResponseClass
+     */
+    'nextPageToken': string;
+    /**
+     * Total amount of items.
+     * @type {number}
+     * @memberof ListPaymentReceiptsResponseClass
+     */
+    'totalItems': number;
+    /**
+     * Items per page.
+     * @type {number}
+     * @memberof ListPaymentReceiptsResponseClass
+     */
+    'itemsPerPage': number;
+    /**
+     * The list of payment receipts.
+     * @type {Array<PaymentReceiptClass>}
+     * @memberof ListPaymentReceiptsResponseClass
+     */
+    'items': Array<PaymentReceiptClass>;
+}
+

package/models/list-payment-requests-response-class.ts

@@ -21,17 +21,29 @@ import { PaymentRequestClass } from './payment-request-class';
  * @interface ListPaymentRequestsResponseClass
  */
 export interface ListPaymentRequestsResponseClass {
-    /**
-     * The list of payment requests.
-     * @type {Array<PaymentRequestClass>}
-     * @memberof ListPaymentRequestsResponseClass
-     */
-    'items': Array<PaymentRequestClass>;
     /**
      * Next page token.
      * @type {string}
      * @memberof ListPaymentRequestsResponseClass
      */
     'nextPageToken': string;
+    /**
+     * Total amount of items.
+     * @type {number}
+     * @memberof ListPaymentRequestsResponseClass
+     */
+    'totalItems': number;
+    /**
+     * Items per page.
+     * @type {number}
+     * @memberof ListPaymentRequestsResponseClass
+     */
+    'itemsPerPage': number;
+    /**
+     * The list of payment requests.
+     * @type {Array<PaymentRequestClass>}
+     * @memberof ListPaymentRequestsResponseClass
+     */
+    'items': Array<PaymentRequestClass>;
 }
 

package/models/list-payout-methods-response-class.ts

@@ -21,18 +21,18 @@ import { PayoutMethodClass } from './payout-method-class';
  * @interface ListPayoutMethodsResponseClass
  */
 export interface ListPayoutMethodsResponseClass {
-    /**
-     * The payout methods
-     * @type {Array<PayoutMethodClass>}
-     * @memberof ListPayoutMethodsResponseClass
-     */
-    'items': Array<PayoutMethodClass>;
     /**
      * Next page token.
      * @type {string}
      * @memberof ListPayoutMethodsResponseClass
      */
     'nextPageToken': string;
+    /**
+     * Total amount of items.
+     * @type {number}
+     * @memberof ListPayoutMethodsResponseClass
+     */
+    'totalItems': number;
     /**
      * Items per page.
      * @type {number}
@@ -40,10 +40,10 @@ export interface ListPayoutMethodsResponseClass {
      */
     'itemsPerPage': number;
     /**
-     * Total amount of items.
-     * @type {number}
+     * The payout methods
+     * @type {Array<PayoutMethodClass>}
      * @memberof ListPayoutMethodsResponseClass
      */
-    'totalItems': number;
+    'items': Array<PayoutMethodClass>;
 }
 

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

@@ -21,17 +21,29 @@ import { RefundClass } from './refund-class';
  * @interface ListRefundsResponseClass
  */
 export interface ListRefundsResponseClass {
-    /**
-     * The list of refunds.
-     * @type {Array<RefundClass>}
-     * @memberof ListRefundsResponseClass
-     */
-    'items': Array<RefundClass>;
     /**
      * Next page token.
      * @type {string}
      * @memberof ListRefundsResponseClass
      */
     'nextPageToken': string;
+    /**
+     * Total amount of items.
+     * @type {number}
+     * @memberof ListRefundsResponseClass
+     */
+    'totalItems': number;
+    /**
+     * Items per page.
+     * @type {number}
+     * @memberof ListRefundsResponseClass
+     */
+    'itemsPerPage': number;
+    /**
+     * The list of refunds.
+     * @type {Array<RefundClass>}
+     * @memberof ListRefundsResponseClass
+     */
+    'items': Array<RefundClass>;
 }