@emilgroup/payment-sdk 1.4.1-beta.9 → 1.5.0

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

@@ -0,0 +1,115 @@
+/**
+ * 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 { SharedTransactionClass } from './shared-transaction-class';
+/**
+ *
+ * @export
+ * @interface PaymentClass
+ */
+export interface PaymentClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof PaymentClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PaymentClass
+     */
+    'code': string;
+    /**
+     * Payment Service Provider with which the payment is done.
+     * @type {string}
+     * @memberof PaymentClass
+     */
+    'psp': string;
+    /**
+     * User account code associated to that payment.
+     * @type {string}
+     * @memberof PaymentClass
+     */
+    'accountCode': string;
+    /**
+     * Amount to be paid in cents. 100 to charge 1€.
+     * @type {number}
+     * @memberof PaymentClass
+     */
+    'amount': number;
+    /**
+     * 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<number>}
+     * @memberof PaymentClass
+     */
+    'invoiceIds': Array<number>;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof PaymentClass
+     */
+    'createdAt': string;
+    /**
+     * Transactions referenced by this payment.
+     * @type {Array<SharedTransactionClass>}
+     * @memberof PaymentClass
+     */
+    'transactions'?: Array<SharedTransactionClass>;
+    /**
+     * Optional field contain extra information.
+     * @type {object}
+     * @memberof 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.
+     * @type {string}
+     * @memberof PaymentClass
+     */
+    'productSlug'?: string;
+    /**
+     * Time at which the payment was actually received.
+     * @type {string}
+     * @memberof PaymentClass
+     */
+    'receivedDate': string;
+    /**
+     * Reference number of the payment.
+     * @type {string}
+     * @memberof PaymentClass
+     */
+    'referenceNumber'?: string;
+    /**
+     * Comment on this payment
+     * @type {string}
+     * @memberof PaymentClass
+     */
+    'comment'?: string;
+    /**
+     * ERN of the payment entity
+     * @type {string}
+     * @memberof PaymentClass
+     */
+    'ern'?: string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof PaymentClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof PaymentClass
+     */
+    'updatedBy': string;
+}

package/dist/models/payment-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-method-class.d.ts

@@ -0,0 +1,78 @@
+/**
+ * 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 PaymentMethodClass
+ */
+export interface PaymentMethodClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof PaymentMethodClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PaymentMethodClass
+     */
+    'code': string;
+    /**
+     * A unique identifier generated by the payment service provider for this payment method.
+     * @type {string}
+     * @memberof PaymentMethodClass
+     */
+    'providerToken': string;
+    /**
+     * Customer identifier for the payment service provider.
+     * @type {string}
+     * @memberof PaymentMethodClass
+     */
+    'pspCustomerId': string;
+    /**
+     * The payment service provider associated to this payment method.
+     * @type {string}
+     * @memberof PaymentMethodClass
+     */
+    'psp': string;
+    /**
+     * The payment method type.
+     * @type {string}
+     * @memberof PaymentMethodClass
+     */
+    'type': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof PaymentMethodClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof PaymentMethodClass
+     */
+    'updatedBy': string;
+    /**
+     * Optional field contain extra information
+     * @type {object}
+     * @memberof PaymentMethodClass
+     */
+    'metadata': object;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof PaymentMethodClass
+     */
+    'createdAt': string;
+}

package/dist/models/payment-method-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-reminder-class.d.ts

@@ -0,0 +1,102 @@
+/**
+ * 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 PaymentReminderClass
+ */
+export interface PaymentReminderClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof PaymentReminderClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PaymentReminderClass
+     */
+    'code': string;
+    /**
+     * Unique identifier of related policy.
+     * @type {string}
+     * @memberof PaymentReminderClass
+     */
+    'policyCode': string;
+    /**
+     * Unique identifier of related account.
+     * @type {string}
+     * @memberof PaymentReminderClass
+     */
+    'accountCode': string;
+    /**
+     * Type of the invoice
+     * @type {string}
+     * @memberof PaymentReminderClass
+     */
+    'invoiceType': string;
+    /**
+     * Unique identifier of the payment for which the reminder happened.
+     * @type {string}
+     * @memberof PaymentReminderClass
+     */
+    'paymentCode': string;
+    /**
+     * The stage of the reminder.
+     * @type {number}
+     * @memberof PaymentReminderClass
+     */
+    'reminderStage': number;
+    /**
+     * True if the reminder should be triggered on the next reminder date.
+     * @type {boolean}
+     * @memberof PaymentReminderClass
+     */
+    'isActive': boolean;
+    /**
+     * When a reminder is set to inactive, a reason must be given.
+     * @type {string}
+     * @memberof PaymentReminderClass
+     */
+    'updateReason'?: string;
+    /**
+     * Next date at which the reminder should be sent.
+     * @type {string}
+     * @memberof PaymentReminderClass
+     */
+    'nextReminderDate'?: string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof PaymentReminderClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof PaymentReminderClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof PaymentReminderClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof PaymentReminderClass
+     */
+    'updatedBy': string;
+}

package/dist/models/payment-reminder-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/primary-bank-account-response-class.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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 PrimaryBankAccountResponseClass
+ */
+export interface PrimaryBankAccountResponseClass {
+    /**
+     * Partner code associated with primary bank account.
+     * @type {string}
+     * @memberof PrimaryBankAccountResponseClass
+     */
+    'entityCode': string;
+    /**
+     * Primary bank account id
+     * @type {number}
+     * @memberof PrimaryBankAccountResponseClass
+     */
+    'bankAccountId': number;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof PrimaryBankAccountResponseClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof PrimaryBankAccountResponseClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof PrimaryBankAccountResponseClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof PrimaryBankAccountResponseClass
+     */
+    'updatedBy': string;
+}

package/dist/models/primary-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/refund-class.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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.
+ * 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
@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { RefundItemClass } from './refund-item-class';
 /**
  *
  * @export
@@ -82,11 +83,23 @@ export interface RefundClass {
      */
     'status': RefundClassStatusEnum;
     /**
-     * Items that were refunded.
-     * @type {Array<string>}
+     * Refund items.
+     * @type {RefundItemClass}
      * @memberof RefundClass
      */
-    'refundItems': Array<string>;
+    'refundItems'?: RefundItemClass;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof RefundClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof RefundClass
+     */
+    'updatedBy': string;
 }
 export declare const RefundClassReasonEnum: {
     readonly PolicyWithdrawn: "POLICY_WITHDRAWN";
@@ -100,5 +113,6 @@ export declare const RefundClassStatusEnum: {
     readonly Succeeded: "succeeded";
     readonly Failed: "failed";
     readonly Canceled: "canceled";
+    readonly Refunded: "refunded";
 };
 export type RefundClassStatusEnum = typeof RefundClassStatusEnum[keyof typeof RefundClassStatusEnum];

package/dist/models/refund-class.js

@@ -3,7 +3,7 @@
 /* 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.
+ * 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
@@ -24,5 +24,6 @@ exports.RefundClassStatusEnum = {
     Pending: 'pending',
     Succeeded: 'succeeded',
     Failed: 'failed',
-    Canceled: 'canceled'
+    Canceled: 'canceled',
+    Refunded: 'refunded'
 };

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

@@ -0,0 +1,114 @@
+/**
+ * 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 RefundItemClass
+ */
+export interface RefundItemClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof RefundItemClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof RefundItemClass
+     */
+    'code': string;
+    /**
+     * Payment Service Provider with which the payment/refund is done.
+     * @type {string}
+     * @memberof RefundItemClass
+     */
+    'psp': string;
+    /**
+     * Identifier of the refund to which this refund item belongs to
+     * @type {number}
+     * @memberof RefundItemClass
+     */
+    'refundId': number;
+    /**
+     * Payment/Charge identifier given by the PSP against which the refund is made
+     * @type {string}
+     * @memberof RefundItemClass
+     */
+    'pspChargeId': string;
+    /**
+     * Refund identifier given by the PSP
+     * @type {string}
+     * @memberof RefundItemClass
+     */
+    'pspRefundId': string;
+    /**
+     * Amount that was refunded in cents. 100 to refund 1€.
+     * @type {number}
+     * @memberof RefundItemClass
+     */
+    'amount': number;
+    /**
+     * Currency of the amount refunded.
+     * @type {string}
+     * @memberof RefundItemClass
+     */
+    'currency': string;
+    /**
+     * Identifier of the payment against which the refund is made
+     * @type {number}
+     * @memberof RefundItemClass
+     */
+    'sourcePaymentId': number;
+    /**
+     * Status of the refund item
+     * @type {string}
+     * @memberof RefundItemClass
+     */
+    'status': string;
+    /**
+     * Status of the refund item provided by the psp
+     * @type {string}
+     * @memberof RefundItemClass
+     */
+    'rawStatus': string;
+    /**
+     * Additional metadata for the refund item, mostly from PSP
+     * @type {object}
+     * @memberof RefundItemClass
+     */
+    'metadata': object;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof RefundItemClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof RefundItemClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof RefundItemClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof RefundItemClass
+     */
+    'updatedBy': string;
+}

package/dist/models/refund-item-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/sepa-direct-dto.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 SepaDirectDto
+ */
+export interface SepaDirectDto {
+    /**
+     *
+     * @type {string}
+     * @memberof SepaDirectDto
+     */
+    'iban': string;
+}

package/dist/models/sepa-direct-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/set-primary-bank-account-request-dto-rest.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 SetPrimaryBankAccountRequestDtoRest
+ */
+export interface SetPrimaryBankAccountRequestDtoRest {
+    /**
+     * The code of the partner/user account that the primary bank account will be set to.
+     * @type {string}
+     * @memberof SetPrimaryBankAccountRequestDtoRest
+     */
+    'entityCode': string;
+}