@emilgroup/payment-sdk 1.16.1-beta.9 → 1.16.1-beta.91

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

@@ -51,7 +51,7 @@ export interface CreatePaymentRequestRequestDto {
      */
     'financialEntityNumber': string;
     /**
-     * Type of the financial entity (e.g., invoice, claim_adjustment).
+     * Type of the financial entity (e.g., refund_allocation, claim_regulation).
      * @type {string}
      * @memberof CreatePaymentRequestRequestDto
      */
@@ -74,6 +74,12 @@ export interface CreatePaymentRequestRequestDto {
      * @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}
@@ -82,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 = {
@@ -95,9 +101,8 @@ export const CreatePaymentRequestRequestDtoDirectionEnum = {
 
 export type CreatePaymentRequestRequestDtoDirectionEnum = typeof CreatePaymentRequestRequestDtoDirectionEnum[keyof typeof CreatePaymentRequestRequestDtoDirectionEnum];
 export const CreatePaymentRequestRequestDtoFinancialEntityTypeEnum = {
-    ClaimAdjustment: 'claim_adjustment',
-    CommissionSettlement: 'commission_settlement',
-    Invoice: 'invoice',
+    ClaimRegulation: 'claim_regulation',
+    RefundAllocation: 'refund_allocation',
     Other: 'other'
 } as const;
 
@@ -105,8 +110,7 @@ export type CreatePaymentRequestRequestDtoFinancialEntityTypeEnum = typeof Creat
 export const CreatePaymentRequestRequestDtoDomainEntityTypeEnum = {
     Other: 'other',
     Claim: 'claim',
-    Premium: 'premium',
-    Commission: 'commission'
+    Policy: 'policy'
 } as const;
 
 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>;
 }
 

package/models/payment-receipt-class.ts

@@ -0,0 +1,110 @@
+/* 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 PaymentReceiptClass
+ */
+export interface PaymentReceiptClass {
+    /**
+     * id
+     * @type {number}
+     * @memberof PaymentReceiptClass
+     */
+    'id': number;
+    /**
+     * code
+     * @type {string}
+     * @memberof PaymentReceiptClass
+     */
+    'code': string;
+    /**
+     * amount in cents.
+     * @type {number}
+     * @memberof PaymentReceiptClass
+     */
+    'amount': number;
+    /**
+     * currency
+     * @type {string}
+     * @memberof PaymentReceiptClass
+     */
+    'currency': string;
+    /**
+     * The receipt direction. Collect for incoming payments, Disburse for outgoing payments.
+     * @type {string}
+     * @memberof PaymentReceiptClass
+     */
+    'direction': PaymentReceiptClassDirectionEnum;
+    /**
+     * Date the payment was confirmed
+     * @type {string}
+     * @memberof PaymentReceiptClass
+     */
+    'dateOfPayment': string;
+    /**
+     * The code of the payment request associated with the payment receipt.
+     * @type {string}
+     * @memberof PaymentReceiptClass
+     */
+    'paymentRequestCode'?: string;
+    /**
+     * The payment service provider that produced the payment receipt.
+     * @type {string}
+     * @memberof PaymentReceiptClass
+     */
+    'psp'?: string;
+    /**
+     * An optional comment associated with the payment receipt.
+     * @type {string}
+     * @memberof PaymentReceiptClass
+     */
+    'comment'?: string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof PaymentReceiptClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof PaymentReceiptClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof PaymentReceiptClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof PaymentReceiptClass
+     */
+    'updatedBy': string;
+}
+
+export const PaymentReceiptClassDirectionEnum = {
+    Collect: 'collect',
+    Disburse: 'disburse'
+} as const;
+
+export type PaymentReceiptClassDirectionEnum = typeof PaymentReceiptClassDirectionEnum[keyof typeof PaymentReceiptClassDirectionEnum];
+
+

package/models/payment-request-class.ts

@@ -13,6 +13,7 @@
  */
 
 
+import { PaymentReceiptClass } from './payment-receipt-class';
 
 /**
  * 
@@ -69,7 +70,7 @@ export interface PaymentRequestClass {
      */
     'financialEntityNumber': string;
     /**
-     * Type of the financial entity (e.g., invoice, claim_adjustment).
+     * Type of the financial entity (e.g., invoice, claim_regulation).
      * @type {string}
      * @memberof PaymentRequestClass
      */
@@ -93,7 +94,7 @@ export interface PaymentRequestClass {
      */
     'domainEntityType': PaymentRequestClassDomainEntityTypeEnum;
     /**
-     * Current status of the payment request. Valid statuses: open, approved, pending, succeeded, failed, withdrawn.
+     * Current status of the payment request. Valid statuses: open, approved, pending, paid, failed, withdrawn.
      * @type {string}
      * @memberof PaymentRequestClass
      */
@@ -118,10 +119,16 @@ export interface PaymentRequestClass {
     'paymentMethodPsp'?: string;
     /**
      * Optional field containing extra information about the payment request.
-     * @type {object}
+     * @type {{ [key: string]: object; }}
      * @memberof PaymentRequestClass
      */
-    'metadata'?: object;
+    'metadata'?: { [key: string]: object; };
+    /**
+     * The list of payment receipts.
+     * @type {Array<PaymentReceiptClass>}
+     * @memberof PaymentRequestClass
+     */
+    'paymentReceipts': Array<PaymentReceiptClass>;
 }
 
 export const PaymentRequestClassDirectionEnum = {
@@ -131,9 +138,8 @@ export const PaymentRequestClassDirectionEnum = {
 
 export type PaymentRequestClassDirectionEnum = typeof PaymentRequestClassDirectionEnum[keyof typeof PaymentRequestClassDirectionEnum];
 export const PaymentRequestClassFinancialEntityTypeEnum = {
-    ClaimAdjustment: 'claim_adjustment',
-    CommissionSettlement: 'commission_settlement',
-    Invoice: 'invoice',
+    ClaimRegulation: 'claim_regulation',
+    RefundAllocation: 'refund_allocation',
     Other: 'other'
 } as const;
 
@@ -141,8 +147,7 @@ export type PaymentRequestClassFinancialEntityTypeEnum = typeof PaymentRequestCl
 export const PaymentRequestClassDomainEntityTypeEnum = {
     Other: 'other',
     Claim: 'claim',
-    Premium: 'premium',
-    Commission: 'commission'
+    Policy: 'policy'
 } as const;
 
 export type PaymentRequestClassDomainEntityTypeEnum = typeof PaymentRequestClassDomainEntityTypeEnum[keyof typeof PaymentRequestClassDomainEntityTypeEnum];
@@ -150,7 +155,7 @@ export const PaymentRequestClassStatusEnum = {
     Open: 'open',
     Approved: 'approved',
     Pending: 'pending',
-    Succeeded: 'succeeded',
+    Paid: 'paid',
     Failed: 'failed',
     Withdrawn: 'withdrawn'
 } as const;

package/models/payout-method-class.ts

@@ -45,6 +45,12 @@ export interface PayoutMethodClass {
      * @memberof PayoutMethodClass
      */
     'lastName': string;
+    /**
+     * Bank account holder.
+     * @type {string}
+     * @memberof PayoutMethodClass
+     */
+    'accountHolder': string;
     /**
      * IBAN
      * @type {string}