@emilgroup/payment-sdk 1.4.1-beta.15 → 1.4.1-beta.17

package/dist/api/bank-accounts-api.d.ts

@@ -12,6 +12,9 @@
 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';
 /**
  * BankAccountsApi - axios parameter creator
  * @export
@@ -20,20 +23,38 @@ 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.
      * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
      * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
-     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
      * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
      * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
      * @param {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -41,6 +62,16 @@ 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>;
 };
 /**
  * BankAccountsApi - functional programming interface
@@ -50,20 +81,38 @@ 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(createBankAccountRequestDto: CreateBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * 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}
      */
-    createBankAccount(body: object, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    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.
+     * 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.
      * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
      * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
-     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
      * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
      * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
      * @param {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -71,6 +120,16 @@ 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>>;
 };
 /**
  * BankAccountsApi - factory interface
@@ -80,20 +139,38 @@ 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.
      * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
      * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
-     * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
      * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
      * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
      * @param {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -101,6 +178,16 @@ 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>;
 };
 /**
  * Request parameters for createBankAccount operation in BankAccountsApi.
@@ -110,10 +197,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 +208,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
@@ -152,7 +277,7 @@ export interface BankAccountsApiListBankAccountsRequest {
      */
     readonly filter?: any;
     /**
-     * Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
      * @type {any}
      * @memberof BankAccountsApiListBankAccounts
      */
@@ -176,6 +301,31 @@ 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;
+}
 /**
  * BankAccountsApi - object-oriented interface
  * @export
@@ -193,7 +343,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 +369,13 @@ 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>>;
 }