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

package/.openapi-generator/FILES

@@ -5,7 +5,7 @@ README.md
 api.ts
 api/bank-accounts-api.ts
 api/bank-transaction-api.ts
-api/default-api.ts
+api/health-check-api.ts
 api/payment-methods-api.ts
 api/payment-reminders-api.ts
 api/payment-setup-api.ts
@@ -18,37 +18,27 @@ common.ts
 configuration.ts
 git_push.sh
 index.ts
-models/bank-account-class.ts
-models/bank-transaction-response-class.ts
+models/bank-transaction-class-without-expand-properties.ts
 models/create-bank-account-request-dto.ts
 models/create-payment-reminder-request-dto.ts
 models/create-payment-request-dto.ts
 models/create-refund-request-dto.ts
-models/create-refund-response-class.ts
 models/create-tenant-bank-account-request-dto.ts
 models/create-tenant-bank-account-response-class.ts
 models/deactivate-payment-reminder-request-dto.ts
-models/get-bank-account-response-class.ts
-models/get-bank-transactions-response-class.ts
-models/get-refund-response-class.ts
-models/get-request-dto.ts
 models/get-tenant-bank-account-response-class.ts
 models/index.ts
 models/inline-response200.ts
 models/inline-response503.ts
 models/link-bank-transaction-request-dto-rest.ts
-models/list-bank-transactions-response-class.ts
-models/list-refunds-response-class.ts
 models/list-tenant-bank-account-response-class.ts
-models/primary-bank-account-response-class.ts
-models/refund-class.ts
 models/set-primary-bank-account-request-dto-rest.ts
-models/tenant-bank-account-response-class.ts
-models/transaction-class.ts
+models/tenant-bank-account-class-without-expand-properties.ts
+models/tenant-bank-account-class.ts
 models/unlink-bank-transaction-request-dto-rest.ts
 models/update-bank-account-request-dto-rest.ts
 models/update-bank-account-request-dto.ts
-models/update-bank-account-response-class.ts
+models/update-tenant-bank-account-response-class.ts
 models/update-tenant-bank-account-rest-request-dto.ts
 models/validate-pspconfig-request-dto.ts
 package.json

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/payment-sdk@1.4.1-beta.30 --save
+npm install @emilgroup/payment-sdk@1.4.1-beta.32 --save
 ```
 or 
 ```
-yarn add @emilgroup/payment-sdk@1.4.1-beta.30
+yarn add @emilgroup/payment-sdk@1.4.1-beta.32
 ```
 
 And then you can import `PaymentsApi`.

package/api/bank-accounts-api.ts

@@ -23,13 +23,9 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
 // @ts-ignore
 import { CreateBankAccountRequestDto } from '../models';
 // @ts-ignore
-import { GetBankAccountResponseClass } from '../models';
-// @ts-ignore
 import { SetPrimaryBankAccountRequestDtoRest } from '../models';
 // @ts-ignore
 import { UpdateBankAccountRequestDtoRest } from '../models';
-// @ts-ignore
-import { UpdateBankAccountResponseClass } from '../models';
 /**
  * BankAccountsApi - axios parameter creator
  * @export
@@ -37,8 +33,8 @@ import { UpdateBankAccountResponseClass } from '../models';
 export const BankAccountsApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * Creates a bank account for a specified partner/account.     If this is the first bank account for the specified partner/account,     it will be marked as primary.
-         * @summary Create a bank account
+         * This will create a bank account for a specified partner/account.     If this is the first bank account for the specified partner/account,     it will be marked as primary.
+         * @summary Create the bank account
          * @param {CreateBankAccountRequestDto} createBankAccountRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -133,11 +129,11 @@ export const BankAccountsApiAxiosParamCreator = function (configuration?: Config
          * @summary Retrieve the bank account
          * @param {string} code Unique identifier for the object.
          * @param {string} [authorization] Bearer Token
-         * @param {'primaryBankAccount'} [expand] Expand the response with additional entities.        For example, using the \"primaryBankAccount\" expand,        you can get information about whether a given bank account is primary.
+         * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.<br/>       <br/>       <i>Allowed values: primaryBankAccount.<i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getBankAccount: async (code: string, authorization?: string, expand?: 'primaryBankAccount', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getBankAccount: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'code' is not null or undefined
             assertParamExists('getBankAccount', 'code', code)
             const localVarPath = `/paymentservice/v1/bank-accounts/{code}`
@@ -187,12 +183,12 @@ export const BankAccountsApiAxiosParamCreator = function (configuration?: Config
          * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, id, accountCode, partnerCode&lt;/i&gt;
          * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
          * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
-         * @param {'primaryBankAccount'} [expand] Expand to fetch additional information about the list items.        For example, using the \&quot;primaryBankAccount\&quot; expand,        you can get information about whether a given bank account is primary.
+         * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: primaryBankAccount.&lt;i&gt;
          * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, id, accountCode, partnerCode&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listBankAccounts: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: 'primaryBankAccount', filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listBankAccounts: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             const localVarPath = `/paymentservice/v1/bank-accounts`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -307,7 +303,7 @@ export const BankAccountsApiAxiosParamCreator = function (configuration?: Config
         },
         /**
          * Update a bank account by code
-         * @summary Update the Update bank account
+         * @summary Update the bank account
          * @param {string} code Unique identifier for the object.
          * @param {UpdateBankAccountRequestDtoRest} updateBankAccountRequestDtoRest 
          * @param {string} [authorization] Bearer Token
@@ -367,8 +363,8 @@ export const BankAccountsApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = BankAccountsApiAxiosParamCreator(configuration)
     return {
         /**
-         * Creates a bank account for a specified partner/account.     If this is the first bank account for the specified partner/account,     it will be marked as primary.
-         * @summary Create a bank account
+         * This will create a bank account for a specified partner/account.     If this is the first bank account for the specified partner/account,     it will be marked as primary.
+         * @summary Create the bank account
          * @param {CreateBankAccountRequestDto} createBankAccountRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -386,7 +382,7 @@ export const BankAccountsApiFp = function(configuration?: Configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async deleteBankAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
+        async deleteBankAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBankAccount(code, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
@@ -395,11 +391,11 @@ export const BankAccountsApiFp = function(configuration?: Configuration) {
          * @summary Retrieve the bank account
          * @param {string} code Unique identifier for the object.
          * @param {string} [authorization] Bearer Token
-         * @param {'primaryBankAccount'} [expand] Expand the response with additional entities.        For example, using the \&quot;primaryBankAccount\&quot; expand,        you can get information about whether a given bank account is primary.
+         * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: primaryBankAccount.&lt;i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getBankAccount(code: string, authorization?: string, expand?: 'primaryBankAccount', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankAccountResponseClass>> {
+        async getBankAccount(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getBankAccount(code, authorization, expand, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
@@ -412,12 +408,12 @@ export const BankAccountsApiFp = function(configuration?: Configuration) {
          * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, id, accountCode, partnerCode&lt;/i&gt;
          * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
          * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
-         * @param {'primaryBankAccount'} [expand] Expand to fetch additional information about the list items.        For example, using the \&quot;primaryBankAccount\&quot; expand,        you can get information about whether a given bank account is primary.
+         * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: primaryBankAccount.&lt;i&gt;
          * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, id, accountCode, partnerCode&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listBankAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: 'primaryBankAccount', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+        async listBankAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.listBankAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
@@ -436,14 +432,14 @@ export const BankAccountsApiFp = function(configuration?: Configuration) {
         },
         /**
          * Update a bank account by code
-         * @summary Update the Update bank account
+         * @summary Update the bank account
          * @param {string} code Unique identifier for the object.
          * @param {UpdateBankAccountRequestDtoRest} updateBankAccountRequestDtoRest 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async updateBankAccount(code: string, updateBankAccountRequestDtoRest: UpdateBankAccountRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateBankAccountResponseClass>> {
+        async updateBankAccount(code: string, updateBankAccountRequestDtoRest: UpdateBankAccountRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.updateBankAccount(code, updateBankAccountRequestDtoRest, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
@@ -458,8 +454,8 @@ export const BankAccountsApiFactory = function (configuration?: Configuration, b
     const localVarFp = BankAccountsApiFp(configuration)
     return {
         /**
-         * Creates a bank account for a specified partner/account.     If this is the first bank account for the specified partner/account,     it will be marked as primary.
-         * @summary Create a bank account
+         * This will create a bank account for a specified partner/account.     If this is the first bank account for the specified partner/account,     it will be marked as primary.
+         * @summary Create the bank account
          * @param {CreateBankAccountRequestDto} createBankAccountRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -476,7 +472,7 @@ export const BankAccountsApiFactory = function (configuration?: Configuration, b
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        deleteBankAccount(code: string, authorization?: string, options?: any): AxiosPromise<object> {
+        deleteBankAccount(code: string, authorization?: string, options?: any): AxiosPromise<void> {
             return localVarFp.deleteBankAccount(code, authorization, options).then((request) => request(axios, basePath));
         },
         /**
@@ -484,11 +480,11 @@ export const BankAccountsApiFactory = function (configuration?: Configuration, b
          * @summary Retrieve the bank account
          * @param {string} code Unique identifier for the object.
          * @param {string} [authorization] Bearer Token
-         * @param {'primaryBankAccount'} [expand] Expand the response with additional entities.        For example, using the \&quot;primaryBankAccount\&quot; expand,        you can get information about whether a given bank account is primary.
+         * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: primaryBankAccount.&lt;i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getBankAccount(code: string, authorization?: string, expand?: 'primaryBankAccount', options?: any): AxiosPromise<GetBankAccountResponseClass> {
+        getBankAccount(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<void> {
             return localVarFp.getBankAccount(code, authorization, expand, options).then((request) => request(axios, basePath));
         },
         /**
@@ -500,12 +496,12 @@ export const BankAccountsApiFactory = function (configuration?: Configuration, b
          * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, id, accountCode, partnerCode&lt;/i&gt;
          * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
          * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
-         * @param {'primaryBankAccount'} [expand] Expand to fetch additional information about the list items.        For example, using the \&quot;primaryBankAccount\&quot; expand,        you can get information about whether a given bank account is primary.
+         * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: primaryBankAccount.&lt;i&gt;
          * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, id, accountCode, partnerCode&lt;/i&gt;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listBankAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: 'primaryBankAccount', filters?: string, options?: any): AxiosPromise<void> {
+        listBankAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void> {
             return localVarFp.listBankAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
         },
         /**
@@ -522,14 +518,14 @@ export const BankAccountsApiFactory = function (configuration?: Configuration, b
         },
         /**
          * Update a bank account by code
-         * @summary Update the Update bank account
+         * @summary Update the bank account
          * @param {string} code Unique identifier for the object.
          * @param {UpdateBankAccountRequestDtoRest} updateBankAccountRequestDtoRest 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        updateBankAccount(code: string, updateBankAccountRequestDtoRest: UpdateBankAccountRequestDtoRest, authorization?: string, options?: any): AxiosPromise<UpdateBankAccountResponseClass> {
+        updateBankAccount(code: string, updateBankAccountRequestDtoRest: UpdateBankAccountRequestDtoRest, authorization?: string, options?: any): AxiosPromise<void> {
             return localVarFp.updateBankAccount(code, updateBankAccountRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
         },
     };
@@ -598,11 +594,11 @@ export interface BankAccountsApiGetBankAccountRequest {
     readonly authorization?: string
 
     /**
-     * Expand the response with additional entities.        For example, using the \&quot;primaryBankAccount\&quot; expand,        you can get information about whether a given bank account is primary.
-     * @type {'primaryBankAccount'}
+     * Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: primaryBankAccount.&lt;i&gt;
+     * @type {string}
      * @memberof BankAccountsApiGetBankAccount
      */
-    readonly expand?: 'primaryBankAccount'
+    readonly expand?: string
 }
 
 /**
@@ -654,11 +650,11 @@ export interface BankAccountsApiListBankAccountsRequest {
     readonly order?: string
 
     /**
-     * Expand to fetch additional information about the list items.        For example, using the \&quot;primaryBankAccount\&quot; expand,        you can get information about whether a given bank account is primary.
-     * @type {'primaryBankAccount'}
+     * Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: primaryBankAccount.&lt;i&gt;
+     * @type {string}
      * @memberof BankAccountsApiListBankAccounts
      */
-    readonly expand?: 'primaryBankAccount'
+    readonly expand?: string
 
     /**
      * Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: code, id, accountCode, partnerCode&lt;/i&gt;
@@ -732,8 +728,8 @@ export interface BankAccountsApiUpdateBankAccountRequest {
  */
 export class BankAccountsApi extends BaseAPI {
     /**
-     * Creates a bank account for a specified partner/account.     If this is the first bank account for the specified partner/account,     it will be marked as primary.
-     * @summary Create a bank account
+     * This will create a bank account for a specified partner/account.     If this is the first bank account for the specified partner/account,     it will be marked as primary.
+     * @summary Create the bank account
      * @param {BankAccountsApiCreateBankAccountRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -793,7 +789,7 @@ export class BankAccountsApi extends BaseAPI {
 
     /**
      * Update a bank account by code
-     * @summary Update the Update bank account
+     * @summary Update the bank account
      * @param {BankAccountsApiUpdateBankAccountRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}