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

package/models/list-billing-addresses-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 { BillingAddressClass } from './billing-address-class';
+
+/**
+ * 
+ * @export
+ * @interface ListBillingAddressesResponseClass
+ */
+export interface ListBillingAddressesResponseClass {
+    /**
+     * Next page token.
+     * @type {string}
+     * @memberof ListBillingAddressesResponseClass
+     */
+    'nextPageToken': string;
+    /**
+     * Total amount of items.
+     * @type {number}
+     * @memberof ListBillingAddressesResponseClass
+     */
+    'totalItems': number;
+    /**
+     * Items per page.
+     * @type {number}
+     * @memberof ListBillingAddressesResponseClass
+     */
+    'itemsPerPage': number;
+    /**
+     * The billing addresses
+     * @type {Array<BillingAddressClass>}
+     * @memberof ListBillingAddressesResponseClass
+     */
+    '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

@@ -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 { PaymentRequestClass } from './payment-request-class';
+
+/**
+ * 
+ * @export
+ * @interface ListPaymentRequestsResponseClass
+ */
+export interface ListPaymentRequestsResponseClass {
+    /**
+     * 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

@@ -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 { PayoutMethodClass } from './payout-method-class';
+
+/**
+ * 
+ * @export
+ * @interface ListPayoutMethodsResponseClass
+ */
+export interface ListPayoutMethodsResponseClass {
+    /**
+     * Next page token.
+     * @type {string}
+     * @memberof ListPayoutMethodsResponseClass
+     */
+    'nextPageToken': string;
+    /**
+     * Total amount of items.
+     * @type {number}
+     * @memberof ListPayoutMethodsResponseClass
+     */
+    'totalItems': number;
+    /**
+     * Items per page.
+     * @type {number}
+     * @memberof ListPayoutMethodsResponseClass
+     */
+    'itemsPerPage': number;
+    /**
+     * The payout methods
+     * @type {Array<PayoutMethodClass>}
+     * @memberof ListPayoutMethodsResponseClass
+     */
+    '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

@@ -0,0 +1,165 @@
+/* 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 PaymentRequestClass
+ */
+export interface PaymentRequestClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof PaymentRequestClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PaymentRequestClass
+     */
+    'code': string;
+    /**
+     * Payment request number.
+     * @type {string}
+     * @memberof PaymentRequestClass
+     */
+    'paymentRequestNumber': string;
+    /**
+     * Payment amount in cents. 100 represents 1€.
+     * @type {number}
+     * @memberof PaymentRequestClass
+     */
+    'amount': number;
+    /**
+     * Currency code for the payment request.
+     * @type {string}
+     * @memberof PaymentRequestClass
+     */
+    'currency': string;
+    /**
+     * Direction of the payment request. Collect for incoming payments, Disburse for outgoing payments.
+     * @type {string}
+     * @memberof PaymentRequestClass
+     */
+    'direction': PaymentRequestClassDirectionEnum;
+    /**
+     * Code of the financial entity (e.g., invoice code, claim adjustment code) that this payment request is associated with.
+     * @type {string}
+     * @memberof PaymentRequestClass
+     */
+    'financialEntityCode': string;
+    /**
+     * Number of the financial entity (e.g., invoice number, claim adjustment number).
+     * @type {string}
+     * @memberof PaymentRequestClass
+     */
+    'financialEntityNumber': string;
+    /**
+     * Type of the financial entity (e.g., invoice, claim_regulation).
+     * @type {string}
+     * @memberof PaymentRequestClass
+     */
+    'financialEntityType': PaymentRequestClassFinancialEntityTypeEnum;
+    /**
+     * Code of the domain entity (e.g., policy code, claim code) that this payment request is associated with.
+     * @type {string}
+     * @memberof PaymentRequestClass
+     */
+    'domainEntityCode': string;
+    /**
+     * Number of the domain entity (e.g., policy number, claim number).
+     * @type {string}
+     * @memberof PaymentRequestClass
+     */
+    'domainEntityNumber': string;
+    /**
+     * Type of the domain entity (e.g., policy, claim).
+     * @type {string}
+     * @memberof PaymentRequestClass
+     */
+    'domainEntityType': PaymentRequestClassDomainEntityTypeEnum;
+    /**
+     * Current status of the payment request. Valid statuses: open, approved, pending, paid, failed, withdrawn.
+     * @type {string}
+     * @memberof PaymentRequestClass
+     */
+    'status': PaymentRequestClassStatusEnum;
+    /**
+     * Code of the payment method used for this payment request.
+     * @type {string}
+     * @memberof PaymentRequestClass
+     */
+    'paymentMethodCode'?: string;
+    /**
+     * Type of the payment method (e.g., sepa_debit, credit_card, bank_transfer).
+     * @type {string}
+     * @memberof PaymentRequestClass
+     */
+    'paymentMethodType'?: string;
+    /**
+     * Payment Service Provider (PSP) used for processing the payment (e.g., stripe, braintree, adyen, eis).
+     * @type {string}
+     * @memberof PaymentRequestClass
+     */
+    'paymentMethodPsp'?: string;
+    /**
+     * Optional field containing extra information about the payment request.
+     * @type {{ [key: string]: object; }}
+     * @memberof PaymentRequestClass
+     */
+    'metadata'?: { [key: string]: object; };
+    /**
+     * The list of payment receipts.
+     * @type {Array<PaymentReceiptClass>}
+     * @memberof PaymentRequestClass
+     */
+    'paymentReceipts': Array<PaymentReceiptClass>;
+}
+
+export const PaymentRequestClassDirectionEnum = {
+    Collect: 'collect',
+    Disburse: 'disburse'
+} as const;
+
+export type PaymentRequestClassDirectionEnum = typeof PaymentRequestClassDirectionEnum[keyof typeof PaymentRequestClassDirectionEnum];
+export const PaymentRequestClassFinancialEntityTypeEnum = {
+    ClaimRegulation: 'claim_regulation',
+    RefundAllocation: 'refund_allocation',
+    Other: 'other'
+} as const;
+
+export type PaymentRequestClassFinancialEntityTypeEnum = typeof PaymentRequestClassFinancialEntityTypeEnum[keyof typeof PaymentRequestClassFinancialEntityTypeEnum];
+export const PaymentRequestClassDomainEntityTypeEnum = {
+    Other: 'other',
+    Claim: 'claim',
+    Policy: 'policy'
+} as const;
+
+export type PaymentRequestClassDomainEntityTypeEnum = typeof PaymentRequestClassDomainEntityTypeEnum[keyof typeof PaymentRequestClassDomainEntityTypeEnum];
+export const PaymentRequestClassStatusEnum = {
+    Open: 'open',
+    Approved: 'approved',
+    Pending: 'pending',
+    Paid: 'paid',
+    Failed: 'failed',
+    Withdrawn: 'withdrawn'
+} as const;
+
+export type PaymentRequestClassStatusEnum = typeof PaymentRequestClassStatusEnum[keyof typeof PaymentRequestClassStatusEnum];
+
+

package/models/payout-method-class.ts

@@ -0,0 +1,127 @@
+/* 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 { BillingAddressClass } from './billing-address-class';
+
+/**
+ * 
+ * @export
+ * @interface PayoutMethodClass
+ */
+export interface PayoutMethodClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof PayoutMethodClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PayoutMethodClass
+     */
+    'code': string;
+    /**
+     * First name
+     * @type {string}
+     * @memberof PayoutMethodClass
+     */
+    'firstName': string;
+    /**
+     * Last name
+     * @type {string}
+     * @memberof PayoutMethodClass
+     */
+    'lastName': string;
+    /**
+     * Bank account holder.
+     * @type {string}
+     * @memberof PayoutMethodClass
+     */
+    'accountHolder': string;
+    /**
+     * IBAN
+     * @type {string}
+     * @memberof PayoutMethodClass
+     */
+    'iban': string;
+    /**
+     * BIC
+     * @type {string}
+     * @memberof PayoutMethodClass
+     */
+    'bic': string;
+    /**
+     * Bank name
+     * @type {string}
+     * @memberof PayoutMethodClass
+     */
+    'bankName': string;
+    /**
+     * Whether the payout method is active
+     * @type {boolean}
+     * @memberof PayoutMethodClass
+     */
+    'isActive': boolean;
+    /**
+     * Billing address code
+     * @type {string}
+     * @memberof PayoutMethodClass
+     */
+    'billingAddressCode': string;
+    /**
+     * Unique identifier of the account that this object belongs to.
+     * @type {string}
+     * @memberof PayoutMethodClass
+     */
+    'accountCode': string;
+    /**
+     * Unique identifier of the partner that this object belongs to.
+     * @type {string}
+     * @memberof PayoutMethodClass
+     */
+    'partnerCode': string;
+    /**
+     * Billing address
+     * @type {BillingAddressClass}
+     * @memberof PayoutMethodClass
+     */
+    'billingAddress'?: BillingAddressClass;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof PayoutMethodClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof PayoutMethodClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof PayoutMethodClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof PayoutMethodClass
+     */
+    'updatedBy': string;
+}
+