@emilgroup/payment-sdk 1.4.1-beta.30 → 1.4.1-beta.31

package/dist/api/webhooks-api.d.ts

@@ -18,9 +18,10 @@ import { RequestArgs, BaseAPI } from '../base';
  */
 export declare const WebhooksApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     *
-     * @param {string} pspType
-     * @param {string} tenantSlug
+     * This will processes the webhook from external payment service provider.
+     * @summary Handle the webhook from PSP
+     * @param {string} pspType The type of the payment service provider (PSP).<br/>           <br/>           <i>Supported PSP: braintree, stripe, b4u, eis</i>
+     * @param {string} tenantSlug Unique slug identifier representing a tenant.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -32,9 +33,10 @@ export declare const WebhooksApiAxiosParamCreator: (configuration?: Configuratio
  */
 export declare const WebhooksApiFp: (configuration?: Configuration) => {
     /**
-     *
-     * @param {string} pspType
-     * @param {string} tenantSlug
+     * This will processes the webhook from external payment service provider.
+     * @summary Handle the webhook from PSP
+     * @param {string} pspType The type of the payment service provider (PSP).<br/>           <br/>           <i>Supported PSP: braintree, stripe, b4u, eis</i>
+     * @param {string} tenantSlug Unique slug identifier representing a tenant.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -46,9 +48,10 @@ export declare const WebhooksApiFp: (configuration?: Configuration) => {
  */
 export declare const WebhooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     *
-     * @param {string} pspType
-     * @param {string} tenantSlug
+     * This will processes the webhook from external payment service provider.
+     * @summary Handle the webhook from PSP
+     * @param {string} pspType The type of the payment service provider (PSP).<br/>           <br/>           <i>Supported PSP: braintree, stripe, b4u, eis</i>
+     * @param {string} tenantSlug Unique slug identifier representing a tenant.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -61,13 +64,13 @@ export declare const WebhooksApiFactory: (configuration?: Configuration, basePat
  */
 export interface WebhooksApiPostWebhookRequest {
     /**
-     *
+     * The type of the payment service provider (PSP).<br/>           <br/>           <i>Supported PSP: braintree, stripe, b4u, eis</i>
      * @type {string}
      * @memberof WebhooksApiPostWebhook
      */
     readonly pspType: string;
     /**
-     *
+     * Unique slug identifier representing a tenant.
      * @type {string}
      * @memberof WebhooksApiPostWebhook
      */
@@ -81,7 +84,8 @@ export interface WebhooksApiPostWebhookRequest {
  */
 export declare class WebhooksApi extends BaseAPI {
     /**
-     *
+     * This will processes the webhook from external payment service provider.
+     * @summary Handle the webhook from PSP
      * @param {WebhooksApiPostWebhookRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/dist/api/webhooks-api.js

@@ -93,9 +93,10 @@ var WebhooksApiAxiosParamCreator = function (configuration) {
     var _this = this;
     return {
         /**
-         *
-         * @param {string} pspType
-         * @param {string} tenantSlug
+         * This will processes the webhook from external payment service provider.
+         * @summary Handle the webhook from PSP
+         * @param {string} pspType The type of the payment service provider (PSP).<br/>           <br/>           <i>Supported PSP: braintree, stripe, b4u, eis</i>
+         * @param {string} tenantSlug Unique slug identifier representing a tenant.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -140,9 +141,10 @@ var WebhooksApiFp = function (configuration) {
     var localVarAxiosParamCreator = (0, exports.WebhooksApiAxiosParamCreator)(configuration);
     return {
         /**
-         *
-         * @param {string} pspType
-         * @param {string} tenantSlug
+         * This will processes the webhook from external payment service provider.
+         * @summary Handle the webhook from PSP
+         * @param {string} pspType The type of the payment service provider (PSP).<br/>           <br/>           <i>Supported PSP: braintree, stripe, b4u, eis</i>
+         * @param {string} tenantSlug Unique slug identifier representing a tenant.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -170,9 +172,10 @@ var WebhooksApiFactory = function (configuration, basePath, axios) {
     var localVarFp = (0, exports.WebhooksApiFp)(configuration);
     return {
         /**
-         *
-         * @param {string} pspType
-         * @param {string} tenantSlug
+         * This will processes the webhook from external payment service provider.
+         * @summary Handle the webhook from PSP
+         * @param {string} pspType The type of the payment service provider (PSP).<br/>           <br/>           <i>Supported PSP: braintree, stripe, b4u, eis</i>
+         * @param {string} tenantSlug Unique slug identifier representing a tenant.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -194,7 +197,8 @@ var WebhooksApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     *
+     * This will processes the webhook from external payment service provider.
+     * @summary Handle the webhook from PSP
      * @param {WebhooksApiPostWebhookRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/dist/api.d.ts

@@ -11,7 +11,7 @@
  */
 export * from './api/bank-accounts-api';
 export * from './api/bank-transaction-api';
-export * from './api/default-api';
+export * from './api/health-check-api';
 export * from './api/payment-methods-api';
 export * from './api/payment-reminders-api';
 export * from './api/payment-setup-api';

package/dist/api.js

@@ -29,7 +29,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./api/bank-accounts-api"), exports);
 __exportStar(require("./api/bank-transaction-api"), exports);
-__exportStar(require("./api/default-api"), exports);
+__exportStar(require("./api/health-check-api"), exports);
 __exportStar(require("./api/payment-methods-api"), exports);
 __exportStar(require("./api/payment-reminders-api"), exports);
 __exportStar(require("./api/payment-setup-api"), exports);

package/dist/models/{bank-transaction-response-class.d.ts → bank-transaction-class-without-expand-properties.d.ts}

@@ -9,120 +9,106 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { TenantBankAccountResponseClass } from './tenant-bank-account-response-class';
-import { TransactionClass } from './transaction-class';
 /**
  *
  * @export
- * @interface BankTransactionResponseClass
+ * @interface BankTransactionClassWithoutExpandProperties
  */
-export interface BankTransactionResponseClass {
+export interface BankTransactionClassWithoutExpandProperties {
     /**
      * Internal unique identifier for the object. You should not have to use this, use code instead.
      * @type {number}
-     * @memberof BankTransactionResponseClass
+     * @memberof BankTransactionClassWithoutExpandProperties
      */
     'id': number;
     /**
      * Unique identifier for the object.
      * @type {string}
-     * @memberof BankTransactionResponseClass
+     * @memberof BankTransactionClassWithoutExpandProperties
      */
     'code': string;
     /**
-     * Bank account ID associated with the transaction.
+     * bank account
      * @type {number}
-     * @memberof BankTransactionResponseClass
+     * @memberof BankTransactionClassWithoutExpandProperties
      */
     'bankAccountId': number;
     /**
      * Account number of the bank account
      * @type {string}
-     * @memberof BankTransactionResponseClass
+     * @memberof BankTransactionClassWithoutExpandProperties
      */
     'bankAccountNumber': string;
     /**
      * Reference number derived from the MT940 swift Insturctions
      * @type {string}
-     * @memberof BankTransactionResponseClass
+     * @memberof BankTransactionClassWithoutExpandProperties
      */
     'swiftMessageReference'?: string;
     /**
      * Currency of the transaction.
      * @type {string}
-     * @memberof BankTransactionResponseClass
+     * @memberof BankTransactionClassWithoutExpandProperties
      */
     'currency': string;
     /**
      * Amount of the transaction - can be negative or positive
      * @type {string}
-     * @memberof BankTransactionResponseClass
+     * @memberof BankTransactionClassWithoutExpandProperties
      */
     'amount': string;
     /**
      * Date on which the transaction was executed. Also known as Value Date
      * @type {string}
-     * @memberof BankTransactionResponseClass
+     * @memberof BankTransactionClassWithoutExpandProperties
      */
     'transactionDate': string;
     /**
      * Date on which the transaction entry was made in the system. Also known as Booking Date
      * @type {string}
-     * @memberof BankTransactionResponseClass
+     * @memberof BankTransactionClassWithoutExpandProperties
      */
     'entryDate': string;
     /**
      * Optional reference number that can be given by the customer or bank to uniquely identify a transaction. If no transaction reference is provided the value is set to \'NONREF\'
      * @type {string}
-     * @memberof BankTransactionResponseClass
+     * @memberof BankTransactionClassWithoutExpandProperties
      */
     'transactionReference': string;
     /**
      * Optional metadata that can be provided by the customer or bank to give more context to the transaction
      * @type {object}
-     * @memberof BankTransactionResponseClass
+     * @memberof BankTransactionClassWithoutExpandProperties
      */
     'metadata'?: object;
     /**
      * The id of the PSP transaction that this bank transaction is linked to
      * @type {number}
-     * @memberof BankTransactionResponseClass
+     * @memberof BankTransactionClassWithoutExpandProperties
      */
-    'linkedTransactionId': number;
+    'linkedTransactionId'?: number;
     /**
      * The code of the invoice that this bank transaction is linked to
      * @type {string}
-     * @memberof BankTransactionResponseClass
+     * @memberof BankTransactionClassWithoutExpandProperties
      */
     'linkedInvoiceCode'?: string;
     /**
      * The identifying invoice number that this bank transaction is linked to
      * @type {string}
-     * @memberof BankTransactionResponseClass
+     * @memberof BankTransactionClassWithoutExpandProperties
      */
     'linkedInvoiceNumber'?: string;
     /**
      * Boolean flag to indicate if the bank transaction is linked to an invoice - defaults to false
      * @type {boolean}
-     * @memberof BankTransactionResponseClass
+     * @memberof BankTransactionClassWithoutExpandProperties
      */
     'isLinked': boolean;
-    /**
-     * The bank account object that this transaction is belongs to
-     * @type {TenantBankAccountResponseClass}
-     * @memberof BankTransactionResponseClass
-     */
-    'bankAccount': TenantBankAccountResponseClass;
-    /**
-     * The linked transaction object
-     * @type {TransactionClass}
-     * @memberof BankTransactionResponseClass
-     */
-    'linkedTransaction': TransactionClass;
     /**
      * Time at which the object was created.
      * @type {string}
-     * @memberof BankTransactionResponseClass
+     * @memberof BankTransactionClassWithoutExpandProperties
      */
     'createdAt': string;
 }

package/dist/models/create-tenant-bank-account-response-class.d.ts

@@ -9,7 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { TenantBankAccountResponseClass } from './tenant-bank-account-response-class';
+import { TenantBankAccountClassWithoutExpandProperties } from './tenant-bank-account-class-without-expand-properties';
 /**
  *
  * @export
@@ -17,9 +17,9 @@ import { TenantBankAccountResponseClass } from './tenant-bank-account-response-c
  */
 export interface CreateTenantBankAccountResponseClass {
     /**
-     * Tenant Bank Account
-     * @type {TenantBankAccountResponseClass}
+     * Tenant bank account
+     * @type {TenantBankAccountClassWithoutExpandProperties}
      * @memberof CreateTenantBankAccountResponseClass
      */
-    'bankAccount': TenantBankAccountResponseClass;
+    'bankAccount': TenantBankAccountClassWithoutExpandProperties;
 }

package/dist/models/get-tenant-bank-account-response-class.d.ts

@@ -9,7 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { TenantBankAccountResponseClass } from './tenant-bank-account-response-class';
+import { TenantBankAccountClass } from './tenant-bank-account-class';
 /**
  *
  * @export
@@ -17,9 +17,9 @@ import { TenantBankAccountResponseClass } from './tenant-bank-account-response-c
  */
 export interface GetTenantBankAccountResponseClass {
     /**
-     * Tenant Bank Account
-     * @type {TenantBankAccountResponseClass}
+     * Tenant bank account
+     * @type {TenantBankAccountClass}
      * @memberof GetTenantBankAccountResponseClass
      */
-    'bankAccount': TenantBankAccountResponseClass;
+    'bankAccount': TenantBankAccountClass;
 }

package/dist/models/index.d.ts

@@ -1,32 +1,22 @@
-export * from './bank-account-class';
-export * from './bank-transaction-response-class';
+export * from './bank-transaction-class-without-expand-properties';
 export * from './create-bank-account-request-dto';
 export * from './create-payment-reminder-request-dto';
 export * from './create-payment-request-dto';
 export * from './create-refund-request-dto';
-export * from './create-refund-response-class';
 export * from './create-tenant-bank-account-request-dto';
 export * from './create-tenant-bank-account-response-class';
 export * from './deactivate-payment-reminder-request-dto';
-export * from './get-bank-account-response-class';
-export * from './get-bank-transactions-response-class';
-export * from './get-refund-response-class';
-export * from './get-request-dto';
 export * from './get-tenant-bank-account-response-class';
 export * from './inline-response200';
 export * from './inline-response503';
 export * from './link-bank-transaction-request-dto-rest';
-export * from './list-bank-transactions-response-class';
-export * from './list-refunds-response-class';
 export * from './list-tenant-bank-account-response-class';
-export * from './primary-bank-account-response-class';
-export * from './refund-class';
 export * from './set-primary-bank-account-request-dto-rest';
-export * from './tenant-bank-account-response-class';
-export * from './transaction-class';
+export * from './tenant-bank-account-class';
+export * from './tenant-bank-account-class-without-expand-properties';
 export * from './unlink-bank-transaction-request-dto-rest';
 export * from './update-bank-account-request-dto';
 export * from './update-bank-account-request-dto-rest';
-export * from './update-bank-account-response-class';
+export * from './update-tenant-bank-account-response-class';
 export * from './update-tenant-bank-account-rest-request-dto';
 export * from './validate-pspconfig-request-dto';

package/dist/models/index.js

@@ -14,35 +14,25 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./bank-account-class"), exports);
-__exportStar(require("./bank-transaction-response-class"), exports);
+__exportStar(require("./bank-transaction-class-without-expand-properties"), exports);
 __exportStar(require("./create-bank-account-request-dto"), exports);
 __exportStar(require("./create-payment-reminder-request-dto"), exports);
 __exportStar(require("./create-payment-request-dto"), exports);
 __exportStar(require("./create-refund-request-dto"), exports);
-__exportStar(require("./create-refund-response-class"), exports);
 __exportStar(require("./create-tenant-bank-account-request-dto"), exports);
 __exportStar(require("./create-tenant-bank-account-response-class"), exports);
 __exportStar(require("./deactivate-payment-reminder-request-dto"), exports);
-__exportStar(require("./get-bank-account-response-class"), exports);
-__exportStar(require("./get-bank-transactions-response-class"), exports);
-__exportStar(require("./get-refund-response-class"), exports);
-__exportStar(require("./get-request-dto"), exports);
 __exportStar(require("./get-tenant-bank-account-response-class"), exports);
 __exportStar(require("./inline-response200"), exports);
 __exportStar(require("./inline-response503"), exports);
 __exportStar(require("./link-bank-transaction-request-dto-rest"), exports);
-__exportStar(require("./list-bank-transactions-response-class"), exports);
-__exportStar(require("./list-refunds-response-class"), exports);
 __exportStar(require("./list-tenant-bank-account-response-class"), exports);
-__exportStar(require("./primary-bank-account-response-class"), exports);
-__exportStar(require("./refund-class"), exports);
 __exportStar(require("./set-primary-bank-account-request-dto-rest"), exports);
-__exportStar(require("./tenant-bank-account-response-class"), exports);
-__exportStar(require("./transaction-class"), exports);
+__exportStar(require("./tenant-bank-account-class"), exports);
+__exportStar(require("./tenant-bank-account-class-without-expand-properties"), exports);
 __exportStar(require("./unlink-bank-transaction-request-dto-rest"), exports);
 __exportStar(require("./update-bank-account-request-dto"), exports);
 __exportStar(require("./update-bank-account-request-dto-rest"), exports);
-__exportStar(require("./update-bank-account-response-class"), exports);
+__exportStar(require("./update-tenant-bank-account-response-class"), exports);
 __exportStar(require("./update-tenant-bank-account-rest-request-dto"), exports);
 __exportStar(require("./validate-pspconfig-request-dto"), exports);

package/dist/models/list-tenant-bank-account-response-class.d.ts

@@ -9,7 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { TenantBankAccountResponseClass } from './tenant-bank-account-response-class';
+import { TenantBankAccountClass } from './tenant-bank-account-class';
 /**
  *
  * @export
@@ -17,13 +17,13 @@ import { TenantBankAccountResponseClass } from './tenant-bank-account-response-c
  */
 export interface ListTenantBankAccountResponseClass {
     /**
-     * The list of bankAccountss.
-     * @type {Array<TenantBankAccountResponseClass>}
+     * The list of bank accounts.
+     * @type {Array<TenantBankAccountClass>}
      * @memberof ListTenantBankAccountResponseClass
      */
-    'items': Array<TenantBankAccountResponseClass>;
+    'items': Array<TenantBankAccountClass>;
     /**
-     * Next page token
+     * Next page token.
      * @type {string}
      * @memberof ListTenantBankAccountResponseClass
      */

package/dist/models/{tenant-bank-account-response-class.d.ts → tenant-bank-account-class-without-expand-properties.d.ts}

@@ -12,55 +12,55 @@
 /**
  *
  * @export
- * @interface TenantBankAccountResponseClass
+ * @interface TenantBankAccountClassWithoutExpandProperties
  */
-export interface TenantBankAccountResponseClass {
+export interface TenantBankAccountClassWithoutExpandProperties {
     /**
      * Internal unique identifier for the object. You should not have to use this, use code instead.
      * @type {number}
-     * @memberof TenantBankAccountResponseClass
+     * @memberof TenantBankAccountClassWithoutExpandProperties
      */
     'id': number;
     /**
      * Unique identifier for the object.
      * @type {string}
-     * @memberof TenantBankAccountResponseClass
+     * @memberof TenantBankAccountClassWithoutExpandProperties
      */
     'code': string;
     /**
      * IBAN number for the bank account
      * @type {string}
-     * @memberof TenantBankAccountResponseClass
+     * @memberof TenantBankAccountClassWithoutExpandProperties
      */
     'iban': string;
     /**
      * Name of the account given by the user - to quickly identify the account
      * @type {string}
-     * @memberof TenantBankAccountResponseClass
+     * @memberof TenantBankAccountClassWithoutExpandProperties
      */
     'accountName': string;
     /**
      * Name of the bank the account belongs to
      * @type {string}
-     * @memberof TenantBankAccountResponseClass
+     * @memberof TenantBankAccountClassWithoutExpandProperties
      */
     'bankName': string;
     /**
      * Number of the booking account this bank account belongs to
      * @type {string}
-     * @memberof TenantBankAccountResponseClass
+     * @memberof TenantBankAccountClassWithoutExpandProperties
      */
     'bookingAccount': string;
     /**
      * Time at which the object was created.
      * @type {string}
-     * @memberof TenantBankAccountResponseClass
+     * @memberof TenantBankAccountClassWithoutExpandProperties
      */
     'createdAt': string;
     /**
      * Time at which the object was updated.
      * @type {string}
-     * @memberof TenantBankAccountResponseClass
+     * @memberof TenantBankAccountClassWithoutExpandProperties
      */
     'updatedAt': string;
 }

package/dist/models/tenant-bank-account-class.d.ts

@@ -0,0 +1,73 @@
+/**
+ * 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 { BankTransactionClassWithoutExpandProperties } from './bank-transaction-class-without-expand-properties';
+/**
+ *
+ * @export
+ * @interface TenantBankAccountClass
+ */
+export interface TenantBankAccountClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof TenantBankAccountClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof TenantBankAccountClass
+     */
+    'code': string;
+    /**
+     * IBAN number for the bank account
+     * @type {string}
+     * @memberof TenantBankAccountClass
+     */
+    'iban': string;
+    /**
+     * Name of the account given by the user - to quickly identify the account
+     * @type {string}
+     * @memberof TenantBankAccountClass
+     */
+    'accountName': string;
+    /**
+     * Name of the bank the account belongs to
+     * @type {string}
+     * @memberof TenantBankAccountClass
+     */
+    'bankName': string;
+    /**
+     * Number of the booking account this bank account belongs to
+     * @type {string}
+     * @memberof TenantBankAccountClass
+     */
+    'bookingAccount': string;
+    /**
+     * List of transactions of the bank the account belongs to
+     * @type {BankTransactionClassWithoutExpandProperties}
+     * @memberof TenantBankAccountClass
+     */
+    'bankTransactions'?: BankTransactionClassWithoutExpandProperties;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof TenantBankAccountClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof TenantBankAccountClass
+     */
+    'updatedAt': string;
+}

package/dist/models/{get-bank-account-response-class.d.ts → update-tenant-bank-account-response-class.d.ts}

@@ -9,17 +9,17 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { BankAccountClass } from './bank-account-class';
+import { TenantBankAccountClassWithoutExpandProperties } from './tenant-bank-account-class-without-expand-properties';
 /**
  *
  * @export
- * @interface GetBankAccountResponseClass
+ * @interface UpdateTenantBankAccountResponseClass
  */
-export interface GetBankAccountResponseClass {
+export interface UpdateTenantBankAccountResponseClass {
     /**
-     * Bank account
-     * @type {BankAccountClass}
-     * @memberof GetBankAccountResponseClass
+     * Tenant bank account
+     * @type {TenantBankAccountClassWithoutExpandProperties}
+     * @memberof UpdateTenantBankAccountResponseClass
      */
-    'bankAccount': BankAccountClass;
+    'bankAccount': TenantBankAccountClassWithoutExpandProperties;
 }