@emilgroup/payment-sdk 1.0.0

package/dist/models/billing-profile-limited-response-dto.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 BillingProfileLimitedResponseDto
+ */
+export interface BillingProfileLimitedResponseDto {
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProfileLimitedResponseDto
+     */
+    'sourceCode': string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProfileLimitedResponseDto
+     */
+    'status': string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProfileLimitedResponseDto
+     */
+    'brand': string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProfileLimitedResponseDto
+     */
+    'invoiceLanguage'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProfileLimitedResponseDto
+     */
+    'customerSegment': string;
+    /**
+     *
+     * @type {number}
+     * @memberof BillingProfileLimitedResponseDto
+     */
+    'activeSubsCnt': number;
+}

package/dist/models/billing-profile-limited-response-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/complete-braintree-payment-setup-request-dto.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 CompleteBraintreePaymentSetupRequestDto
+ */
+export interface CompleteBraintreePaymentSetupRequestDto {
+    /**
+     * Account email address
+     * @type {string}
+     * @memberof CompleteBraintreePaymentSetupRequestDto
+     */
+    'email': string;
+    /**
+     * Account first name
+     * @type {string}
+     * @memberof CompleteBraintreePaymentSetupRequestDto
+     */
+    'firstName': string;
+    /**
+     * Account last name
+     * @type {string}
+     * @memberof CompleteBraintreePaymentSetupRequestDto
+     */
+    'lastName': string;
+    /**
+     * Lead code
+     * @type {string}
+     * @memberof CompleteBraintreePaymentSetupRequestDto
+     */
+    'leadCode': string;
+    /**
+     * Braintree nonce generated by the client through the frontend component.
+     * @type {string}
+     * @memberof CompleteBraintreePaymentSetupRequestDto
+     */
+    'nonce': string;
+}

package/dist/models/complete-braintree-payment-setup-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/complete-payment-setup-request-dto.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 { CompleteBraintreePaymentSetupRequestDto } from './complete-braintree-payment-setup-request-dto';
+import { CompleteStripePaymentSetupRequestDto } from './complete-stripe-payment-setup-request-dto';
+/**
+ *
+ * @export
+ * @interface CompletePaymentSetupRequestDto
+ */
+export interface CompletePaymentSetupRequestDto {
+    /**
+     *
+     * @type {CompleteStripePaymentSetupRequestDto}
+     * @memberof CompletePaymentSetupRequestDto
+     */
+    'stripe'?: CompleteStripePaymentSetupRequestDto;
+    /**
+     *
+     * @type {CompleteBraintreePaymentSetupRequestDto}
+     * @memberof CompletePaymentSetupRequestDto
+     */
+    'braintree'?: CompleteBraintreePaymentSetupRequestDto;
+}

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

@@ -0,0 +1,25 @@
+/**
+ * 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 { PaymentMethodClass } from './payment-method-class';
+/**
+ *
+ * @export
+ * @interface CompletePaymentSetupResponseClass
+ */
+export interface CompletePaymentSetupResponseClass {
+    /**
+     * The payment method resulting of the completion of the setup.
+     * @type {PaymentMethodClass}
+     * @memberof CompletePaymentSetupResponseClass
+     */
+    'paymentMethod': PaymentMethodClass;
+}

package/dist/models/complete-payment-setup-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/complete-stripe-payment-setup-request-dto.d.ts

@@ -0,0 +1,60 @@
+/**
+ * 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 CompleteStripePaymentSetupRequestDto
+ */
+export interface CompleteStripePaymentSetupRequestDto {
+    /**
+     * Account email address
+     * @type {string}
+     * @memberof CompleteStripePaymentSetupRequestDto
+     */
+    'email': string;
+    /**
+     * Account first name
+     * @type {string}
+     * @memberof CompleteStripePaymentSetupRequestDto
+     */
+    'firstName': string;
+    /**
+     * Account last name
+     * @type {string}
+     * @memberof CompleteStripePaymentSetupRequestDto
+     */
+    'lastName': string;
+    /**
+     * Lead code
+     * @type {string}
+     * @memberof CompleteStripePaymentSetupRequestDto
+     */
+    'leadCode'?: string;
+    /**
+     * Unique identifier for the customer on Stripe.
+     * @type {string}
+     * @memberof CompleteStripePaymentSetupRequestDto
+     */
+    'pspCustomerId': string;
+    /**
+     * Unique identifier for payment method on Stripe.
+     * @type {string}
+     * @memberof CompleteStripePaymentSetupRequestDto
+     */
+    'pspPaymentMethodId'?: string;
+    /**
+     * The payment method type on Stripe.
+     * @type {string}
+     * @memberof CompleteStripePaymentSetupRequestDto
+     */
+    'paymentMethodType'?: string;
+}

package/dist/models/complete-stripe-payment-setup-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/create-bank-account-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 CreateBankAccountRequestDto
+ */
+export interface CreateBankAccountRequestDto {
+    /**
+     *
+     * @type {string}
+     * @memberof CreateBankAccountRequestDto
+     */
+    'accountCode': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateBankAccountRequestDto
+     */
+    'iban': string;
+}

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

@@ -0,0 +1,25 @@
+/**
+ * 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 { PaymentMethodClass } from './payment-method-class';
+/**
+ *
+ * @export
+ * @interface CreatePaymentMethodResponseClass
+ */
+export interface CreatePaymentMethodResponseClass {
+    /**
+     * The created payment method.
+     * @type {PaymentMethodClass}
+     * @memberof CreatePaymentMethodResponseClass
+     */
+    'paymentMethod': PaymentMethodClass;
+}

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

@@ -0,0 +1,65 @@
+/**
+ * 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 CreatePaymentReminderRequestDto
+ */
+export interface CreatePaymentReminderRequestDto {
+    /**
+     * Date on which the reminder is triggered.
+     * @type {string}
+     * @memberof CreatePaymentReminderRequestDto
+     */
+    'nextReminderDate': string;
+    /**
+     * Code referencing the policy for which this reminder is created.
+     * @type {string}
+     * @memberof CreatePaymentReminderRequestDto
+     */
+    'policyCode': string;
+    /**
+     * Code referencing the account for which this reminder is created.
+     * @type {string}
+     * @memberof CreatePaymentReminderRequestDto
+     */
+    'accountCode': string;
+    /**
+     * The type of invoice is used to determine the proper workflow.
+     * @type {string}
+     * @memberof CreatePaymentReminderRequestDto
+     */
+    'invoiceType': CreatePaymentReminderRequestDtoInvoiceTypeEnum;
+    /**
+     * Unique identifier of the payment for which the reminder happened.
+     * @type {string}
+     * @memberof CreatePaymentReminderRequestDto
+     */
+    'paymentCode': string;
+    /**
+     * The stage of a reminder according to the product definition.
+     * @type {number}
+     * @memberof CreatePaymentReminderRequestDto
+     */
+    'reminderStage': number;
+}
+export declare const CreatePaymentReminderRequestDtoInvoiceTypeEnum: {
+    readonly Initial: "initial";
+    readonly Recurring: "recurring";
+    readonly Correction: "correction";
+    readonly Estimated: "estimated";
+    readonly Penalty: "penalty";
+    readonly Other: "other";
+    readonly Withdraw: "withdraw";
+    readonly Final: "final";
+};
+export type CreatePaymentReminderRequestDtoInvoiceTypeEnum = typeof CreatePaymentReminderRequestDtoInvoiceTypeEnum[keyof typeof CreatePaymentReminderRequestDtoInvoiceTypeEnum];

package/dist/models/create-payment-reminder-request-dto.js

@@ -0,0 +1,26 @@
+"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.CreatePaymentReminderRequestDtoInvoiceTypeEnum = void 0;
+exports.CreatePaymentReminderRequestDtoInvoiceTypeEnum = {
+    Initial: 'initial',
+    Recurring: 'recurring',
+    Correction: 'correction',
+    Estimated: 'estimated',
+    Penalty: 'penalty',
+    Other: 'other',
+    Withdraw: 'withdraw',
+    Final: 'final'
+};

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

@@ -0,0 +1,72 @@
+/**
+ * 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 CreatePaymentRequestDto
+ */
+export interface CreatePaymentRequestDto {
+    /**
+     * User account code associated to that payment.
+     * @type {string}
+     * @memberof CreatePaymentRequestDto
+     */
+    'accountCode': string;
+    /**
+     * Amount to be paid in cents. 100 to charge 1€.
+     * @type {number}
+     * @memberof CreatePaymentRequestDto
+     */
+    'amount': number;
+    /**
+     * Currency of the payment. Optional. Default EUR.
+     * @type {string}
+     * @memberof 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>}
+     * @memberof CreatePaymentRequestDto
+     */
+    'invoiceIds': Array<string>;
+    /**
+     * Optional field contain extra information.
+     * @type {object}
+     * @memberof 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.
+     * @type {string}
+     * @memberof CreatePaymentRequestDto
+     */
+    'productSlug'?: string;
+    /**
+     * Optional payment date.
+     * @type {string}
+     * @memberof CreatePaymentRequestDto
+     */
+    'receivedDate'?: string;
+    /**
+     * Optional reference number.
+     * @type {string}
+     * @memberof CreatePaymentRequestDto
+     */
+    'referenceNumber'?: string;
+    /**
+     * Optional comment.
+     * @type {string}
+     * @memberof CreatePaymentRequestDto
+     */
+    'comment'?: string;
+}

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

@@ -0,0 +1,25 @@
+/**
+ * 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 { PaymentClass } from './payment-class';
+/**
+ *
+ * @export
+ * @interface CreatePaymentResponseClass
+ */
+export interface CreatePaymentResponseClass {
+    /**
+     * Payment
+     * @type {PaymentClass}
+     * @memberof CreatePaymentResponseClass
+     */
+    'payment': PaymentClass;
+}

package/dist/models/create-payment-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 });