@emilgroup/payment-sdk 1.4.1-beta.20 → 1.4.1-beta.22

package/dist/api/bank-accounts-api.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
@@ -12,6 +12,10 @@
 import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
 import { Configuration } from '../configuration';
 import { RequestArgs, BaseAPI } from '../base';
+import { CreateBankAccountRequestDto } from '../models';
+import { GetBankAccountResponseClass } from '../models';
+import { SetPrimaryBankAccountRequestDtoRest } from '../models';
+import { UpdateBankAccountRequestDtoRest } from '../models';
 /**
  * BankAccountsApi - axios parameter creator
  * @export
@@ -20,14 +24,32 @@ export declare const BankAccountsApiAxiosParamCreator: (configuration?: Configur
     /**
      * Creates a bank account for a specified account.
      * @summary Create a bank account
-     * @param {object} body
+     * @param {CreateBankAccountRequestDto} createBankAccountRequestDto
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createBankAccount: (body: object, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    createBankAccount: (createBankAccountRequestDto: CreateBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns a list of bank accounts you’ve previously created.        The bank accounts are returned in sorted order,        with the oldest payment appearing first. For more information about pagination, read the Pagination        documentation.
+     * Deletes a bank account by code
+     * @summary Delete the bank account
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteBankAccount: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the Bank Account that was previously created. Supply the unique Bank Account code        that was returned when you created it and Emil Api will return the corresponding Bank Account information.
+     * @summary Retrieve the Bank Account
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBankAccount: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of bank accounts you’ve previously created.       The bank accounts are returned in sorted order,       with the oldest payment appearing first. For more information about pagination, read the Pagination       documentation.
      * @summary List bank accounts
      * @param {string} [authorization] Bearer Token
      * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
@@ -41,6 +63,26 @@ export declare const BankAccountsApiAxiosParamCreator: (configuration?: Configur
      * @throws {RequiredError}
      */
     listBankAccounts: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Set primary bank account
+     * @summary Set primary bank account
+     * @param {string} code Code of the bank account to set primary
+     * @param {SetPrimaryBankAccountRequestDtoRest} setPrimaryBankAccountRequestDtoRest
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setPrimaryBankAccount: (code: string, setPrimaryBankAccountRequestDtoRest: SetPrimaryBankAccountRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update a bank account by code
+     * @summary Update the Update 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?: AxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * BankAccountsApi - functional programming interface
@@ -50,14 +92,32 @@ export declare const BankAccountsApiFp: (configuration?: Configuration) => {
     /**
      * Creates a bank account for a specified account.
      * @summary Create a bank account
-     * @param {object} body
+     * @param {CreateBankAccountRequestDto} createBankAccountRequestDto
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createBankAccount(body: object, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    createBankAccount(createBankAccountRequestDto: CreateBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * Returns a list of bank accounts you’ve previously created.        The bank accounts are returned in sorted order,        with the oldest payment appearing first. For more information about pagination, read the Pagination        documentation.
+     * Deletes a bank account by code
+     * @summary Delete the bank account
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteBankAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     * Retrieves the details of the Bank Account that was previously created. Supply the unique Bank Account code        that was returned when you created it and Emil Api will return the corresponding Bank Account information.
+     * @summary Retrieve the Bank Account
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBankAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankAccountResponseClass>>;
+    /**
+     * Returns a list of bank accounts you’ve previously created.       The bank accounts are returned in sorted order,       with the oldest payment appearing first. For more information about pagination, read the Pagination       documentation.
      * @summary List bank accounts
      * @param {string} [authorization] Bearer Token
      * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
@@ -71,6 +131,26 @@ export declare const BankAccountsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listBankAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Set primary bank account
+     * @summary Set primary bank account
+     * @param {string} code Code of the bank account to set primary
+     * @param {SetPrimaryBankAccountRequestDtoRest} setPrimaryBankAccountRequestDtoRest
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setPrimaryBankAccount(code: string, setPrimaryBankAccountRequestDtoRest: SetPrimaryBankAccountRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Update a bank account by code
+     * @summary Update the Update 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
 };
 /**
  * BankAccountsApi - factory interface
@@ -80,14 +160,32 @@ export declare const BankAccountsApiFactory: (configuration?: Configuration, bas
     /**
      * Creates a bank account for a specified account.
      * @summary Create a bank account
-     * @param {object} body
+     * @param {CreateBankAccountRequestDto} createBankAccountRequestDto
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createBankAccount(body: object, authorization?: string, options?: any): AxiosPromise<void>;
+    createBankAccount(createBankAccountRequestDto: CreateBankAccountRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
     /**
-     * Returns a list of bank accounts you’ve previously created.        The bank accounts are returned in sorted order,        with the oldest payment appearing first. For more information about pagination, read the Pagination        documentation.
+     * Deletes a bank account by code
+     * @summary Delete the bank account
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteBankAccount(code: string, authorization?: string, options?: any): AxiosPromise<object>;
+    /**
+     * Retrieves the details of the Bank Account that was previously created. Supply the unique Bank Account code        that was returned when you created it and Emil Api will return the corresponding Bank Account information.
+     * @summary Retrieve the Bank Account
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBankAccount(code: string, authorization?: string, options?: any): AxiosPromise<GetBankAccountResponseClass>;
+    /**
+     * Returns a list of bank accounts you’ve previously created.       The bank accounts are returned in sorted order,       with the oldest payment appearing first. For more information about pagination, read the Pagination       documentation.
      * @summary List bank accounts
      * @param {string} [authorization] Bearer Token
      * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
@@ -101,6 +199,26 @@ export declare const BankAccountsApiFactory: (configuration?: Configuration, bas
      * @throws {RequiredError}
      */
     listBankAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<void>;
+    /**
+     * Set primary bank account
+     * @summary Set primary bank account
+     * @param {string} code Code of the bank account to set primary
+     * @param {SetPrimaryBankAccountRequestDtoRest} setPrimaryBankAccountRequestDtoRest
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setPrimaryBankAccount(code: string, setPrimaryBankAccountRequestDtoRest: SetPrimaryBankAccountRequestDtoRest, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * Update a bank account by code
+     * @summary Update the Update 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<object>;
 };
 /**
  * Request parameters for createBankAccount operation in BankAccountsApi.
@@ -110,10 +228,10 @@ export declare const BankAccountsApiFactory: (configuration?: Configuration, bas
 export interface BankAccountsApiCreateBankAccountRequest {
     /**
      *
-     * @type {object}
+     * @type {CreateBankAccountRequestDto}
      * @memberof BankAccountsApiCreateBankAccount
      */
-    readonly body: object;
+    readonly createBankAccountRequestDto: CreateBankAccountRequestDto;
     /**
      * Bearer Token
      * @type {string}
@@ -121,6 +239,44 @@ export interface BankAccountsApiCreateBankAccountRequest {
      */
     readonly authorization?: string;
 }
+/**
+ * Request parameters for deleteBankAccount operation in BankAccountsApi.
+ * @export
+ * @interface BankAccountsApiDeleteBankAccountRequest
+ */
+export interface BankAccountsApiDeleteBankAccountRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof BankAccountsApiDeleteBankAccount
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BankAccountsApiDeleteBankAccount
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getBankAccount operation in BankAccountsApi.
+ * @export
+ * @interface BankAccountsApiGetBankAccountRequest
+ */
+export interface BankAccountsApiGetBankAccountRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof BankAccountsApiGetBankAccount
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BankAccountsApiGetBankAccount
+     */
+    readonly authorization?: string;
+}
 /**
  * Request parameters for listBankAccounts operation in BankAccountsApi.
  * @export
@@ -176,6 +332,56 @@ export interface BankAccountsApiListBankAccountsRequest {
      */
     readonly filters?: any;
 }
+/**
+ * Request parameters for setPrimaryBankAccount operation in BankAccountsApi.
+ * @export
+ * @interface BankAccountsApiSetPrimaryBankAccountRequest
+ */
+export interface BankAccountsApiSetPrimaryBankAccountRequest {
+    /**
+     * Code of the bank account to set primary
+     * @type {string}
+     * @memberof BankAccountsApiSetPrimaryBankAccount
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {SetPrimaryBankAccountRequestDtoRest}
+     * @memberof BankAccountsApiSetPrimaryBankAccount
+     */
+    readonly setPrimaryBankAccountRequestDtoRest: SetPrimaryBankAccountRequestDtoRest;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BankAccountsApiSetPrimaryBankAccount
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for updateBankAccount operation in BankAccountsApi.
+ * @export
+ * @interface BankAccountsApiUpdateBankAccountRequest
+ */
+export interface BankAccountsApiUpdateBankAccountRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof BankAccountsApiUpdateBankAccount
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateBankAccountRequestDtoRest}
+     * @memberof BankAccountsApiUpdateBankAccount
+     */
+    readonly updateBankAccountRequestDtoRest: UpdateBankAccountRequestDtoRest;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BankAccountsApiUpdateBankAccount
+     */
+    readonly authorization?: string;
+}
 /**
  * BankAccountsApi - object-oriented interface
  * @export
@@ -193,7 +399,25 @@ export declare class BankAccountsApi extends BaseAPI {
      */
     createBankAccount(requestParameters: BankAccountsApiCreateBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     * Returns a list of bank accounts you’ve previously created.        The bank accounts are returned in sorted order,        with the oldest payment appearing first. For more information about pagination, read the Pagination        documentation.
+     * Deletes a bank account by code
+     * @summary Delete the bank account
+     * @param {BankAccountsApiDeleteBankAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BankAccountsApi
+     */
+    deleteBankAccount(requestParameters: BankAccountsApiDeleteBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    /**
+     * Retrieves the details of the Bank Account that was previously created. Supply the unique Bank Account code        that was returned when you created it and Emil Api will return the corresponding Bank Account information.
+     * @summary Retrieve the Bank Account
+     * @param {BankAccountsApiGetBankAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BankAccountsApi
+     */
+    getBankAccount(requestParameters: BankAccountsApiGetBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankAccountResponseClass, any>>;
+    /**
+     * Returns a list of bank accounts you’ve previously created.       The bank accounts are returned in sorted order,       with the oldest payment appearing first. For more information about pagination, read the Pagination       documentation.
      * @summary List bank accounts
      * @param {BankAccountsApiListBankAccountsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -201,4 +425,22 @@ export declare class BankAccountsApi extends BaseAPI {
      * @memberof BankAccountsApi
      */
     listBankAccounts(requestParameters?: BankAccountsApiListBankAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Set primary bank account
+     * @summary Set primary bank account
+     * @param {BankAccountsApiSetPrimaryBankAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BankAccountsApi
+     */
+    setPrimaryBankAccount(requestParameters: BankAccountsApiSetPrimaryBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Update a bank account by code
+     * @summary Update the Update bank account
+     * @param {BankAccountsApiUpdateBankAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BankAccountsApi
+     */
+    updateBankAccount(requestParameters: BankAccountsApiUpdateBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
 }