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

package/dist/api/bank-transaction-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
@@ -13,14 +13,16 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
 import { Configuration } from '../configuration';
 import { RequestArgs, BaseAPI } from '../base';
 import { GetBankTransactionsResponseClass } from '../models';
+import { LinkBankTransactionRequestDtoRest } from '../models';
 import { ListBankTransactionsResponseClass } from '../models';
+import { UnlinkBankTransactionRequestDtoRest } from '../models';
 /**
  * BankTransactionApi - axios parameter creator
  * @export
  */
 export declare const BankTransactionApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
+     * Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code        that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
      * @summary Retrieve the Bank Transaction
      * @param {string} code
      * @param {string} [authorization] Bearer Token
@@ -32,45 +34,47 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
     /**
      * Import bank transactions from a swift MT940 file
      * @summary Create the bank transactions
+     * @param {any} file Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.<br/> Allowed Content Types: text/plain, application/octet-stream
      * @param {string} [authorization] Bearer Token
-     * @param {any} [file]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    importBankTransactions: (authorization?: string, file?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    importBankTransactions: (file: any, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Links a bank transaction with an invoice
      * @summary Link Bank Transaction
      * @param {string} code Code of the bank transaction to link
+     * @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    linkBankTransaction: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    linkBankTransaction: (code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * Returns a list of bank transactions you have previously created.        The bank transactions are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
      * @summary List bank transactions
      * @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} [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: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked&lt;/i&gt;
+     * @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 {string} [expand] Expand the response with additional entities
+     * @param {'bankAccount' | 'transaction'} [expand] Expand the response with additional entities
      * @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.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listBankTransactions: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: string, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    listBankTransactions: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: 'bankAccount' | 'transaction', filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Unlinks an already linked bank transaction
      * @summary Unlink Bank Transaction
      * @param {string} code Code of the bank transaction to unlink
+     * @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    unlinkBankTransaction: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    unlinkBankTransaction: (code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * BankTransactionApi - functional programming interface
@@ -78,7 +82,7 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
  */
 export declare const BankTransactionApiFp: (configuration?: Configuration) => {
     /**
-     * Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
+     * Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code        that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
      * @summary Retrieve the Bank Transaction
      * @param {string} code
      * @param {string} [authorization] Bearer Token
@@ -90,45 +94,47 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
     /**
      * Import bank transactions from a swift MT940 file
      * @summary Create the bank transactions
+     * @param {any} file Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.&lt;br/&gt; Allowed Content Types: text/plain, application/octet-stream
      * @param {string} [authorization] Bearer Token
-     * @param {any} [file]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    importBankTransactions(authorization?: string, file?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBankTransactionsResponseClass>>;
+    importBankTransactions(file: any, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBankTransactionsResponseClass>>;
     /**
      * Links a bank transaction with an invoice
      * @summary Link Bank Transaction
      * @param {string} code Code of the bank transaction to link
+     * @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    linkBankTransaction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankTransactionsResponseClass>>;
+    linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankTransactionsResponseClass>>;
     /**
-     * Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * Returns a list of bank transactions you have previously created.        The bank transactions are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
      * @summary List bank transactions
      * @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} [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: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked&lt;/i&gt;
+     * @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 {string} [expand] Expand the response with additional entities
+     * @param {'bankAccount' | 'transaction'} [expand] Expand the response with additional entities
      * @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.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listBankTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: string, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBankTransactionsResponseClass>>;
+    listBankTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: 'bankAccount' | 'transaction', filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Unlinks an already linked bank transaction
      * @summary Unlink Bank Transaction
      * @param {string} code Code of the bank transaction to unlink
+     * @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    unlinkBankTransaction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankTransactionsResponseClass>>;
+    unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankTransactionsResponseClass>>;
 };
 /**
  * BankTransactionApi - factory interface
@@ -136,7 +142,7 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
  */
 export declare const BankTransactionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
+     * Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code        that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
      * @summary Retrieve the Bank Transaction
      * @param {string} code
      * @param {string} [authorization] Bearer Token
@@ -148,45 +154,47 @@ export declare const BankTransactionApiFactory: (configuration?: Configuration,
     /**
      * Import bank transactions from a swift MT940 file
      * @summary Create the bank transactions
+     * @param {any} file Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.&lt;br/&gt; Allowed Content Types: text/plain, application/octet-stream
      * @param {string} [authorization] Bearer Token
-     * @param {any} [file]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    importBankTransactions(authorization?: string, file?: any, options?: any): AxiosPromise<ListBankTransactionsResponseClass>;
+    importBankTransactions(file: any, authorization?: string, options?: any): AxiosPromise<ListBankTransactionsResponseClass>;
     /**
      * Links a bank transaction with an invoice
      * @summary Link Bank Transaction
      * @param {string} code Code of the bank transaction to link
+     * @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    linkBankTransaction(code: string, authorization?: string, options?: any): AxiosPromise<GetBankTransactionsResponseClass>;
+    linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<GetBankTransactionsResponseClass>;
     /**
-     * Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * Returns a list of bank transactions you have previously created.        The bank transactions are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
      * @summary List bank transactions
      * @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} [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: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked&lt;/i&gt;
+     * @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 {string} [expand] Expand the response with additional entities
+     * @param {'bankAccount' | 'transaction'} [expand] Expand the response with additional entities
      * @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.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listBankTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: string, filters?: any, options?: any): AxiosPromise<ListBankTransactionsResponseClass>;
+    listBankTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: 'bankAccount' | 'transaction', filters?: any, options?: any): AxiosPromise<void>;
     /**
      * Unlinks an already linked bank transaction
      * @summary Unlink Bank Transaction
      * @param {string} code Code of the bank transaction to unlink
+     * @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    unlinkBankTransaction(code: string, authorization?: string, options?: any): AxiosPromise<GetBankTransactionsResponseClass>;
+    unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<GetBankTransactionsResponseClass>;
 };
 /**
  * Request parameters for getBankTransaction operation in BankTransactionApi.
@@ -220,17 +228,17 @@ export interface BankTransactionApiGetBankTransactionRequest {
  */
 export interface BankTransactionApiImportBankTransactionsRequest {
     /**
-     * Bearer Token
-     * @type {string}
+     * Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.&lt;br/&gt; Allowed Content Types: text/plain, application/octet-stream
+     * @type {any}
      * @memberof BankTransactionApiImportBankTransactions
      */
-    readonly authorization?: string;
+    readonly file: any;
     /**
-     *
-     * @type {any}
+     * Bearer Token
+     * @type {string}
      * @memberof BankTransactionApiImportBankTransactions
      */
-    readonly file?: any;
+    readonly authorization?: string;
 }
 /**
  * Request parameters for linkBankTransaction operation in BankTransactionApi.
@@ -244,6 +252,12 @@ export interface BankTransactionApiLinkBankTransactionRequest {
      * @memberof BankTransactionApiLinkBankTransaction
      */
     readonly code: string;
+    /**
+     *
+     * @type {LinkBankTransactionRequestDtoRest}
+     * @memberof BankTransactionApiLinkBankTransaction
+     */
+    readonly linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest;
     /**
      * Bearer Token
      * @type {string}
@@ -276,13 +290,13 @@ export interface BankTransactionApiListBankTransactionsRequest {
      */
     readonly pageToken?: any;
     /**
-     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * 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: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked&lt;/i&gt;
      * @type {any}
      * @memberof BankTransactionApiListBankTransactions
      */
     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 BankTransactionApiListBankTransactions
      */
@@ -295,10 +309,10 @@ export interface BankTransactionApiListBankTransactionsRequest {
     readonly order?: any;
     /**
      * Expand the response with additional entities
-     * @type {string}
+     * @type {'bankAccount' | 'transaction'}
      * @memberof BankTransactionApiListBankTransactions
      */
-    readonly expand?: string;
+    readonly expand?: 'bankAccount' | 'transaction';
     /**
      * 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.
      * @type {any}
@@ -318,6 +332,12 @@ export interface BankTransactionApiUnlinkBankTransactionRequest {
      * @memberof BankTransactionApiUnlinkBankTransaction
      */
     readonly code: string;
+    /**
+     *
+     * @type {UnlinkBankTransactionRequestDtoRest}
+     * @memberof BankTransactionApiUnlinkBankTransaction
+     */
+    readonly unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest;
     /**
      * Bearer Token
      * @type {string}
@@ -333,7 +353,7 @@ export interface BankTransactionApiUnlinkBankTransactionRequest {
  */
 export declare class BankTransactionApi extends BaseAPI {
     /**
-     * Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
+     * Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code        that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
      * @summary Retrieve the Bank Transaction
      * @param {BankTransactionApiGetBankTransactionRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -349,7 +369,7 @@ export declare class BankTransactionApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof BankTransactionApi
      */
-    importBankTransactions(requestParameters?: BankTransactionApiImportBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBankTransactionsResponseClass, any>>;
+    importBankTransactions(requestParameters: BankTransactionApiImportBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBankTransactionsResponseClass, any>>;
     /**
      * Links a bank transaction with an invoice
      * @summary Link Bank Transaction
@@ -360,14 +380,14 @@ export declare class BankTransactionApi extends BaseAPI {
      */
     linkBankTransaction(requestParameters: BankTransactionApiLinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankTransactionsResponseClass, any>>;
     /**
-     * Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * Returns a list of bank transactions you have previously created.        The bank transactions are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
      * @summary List bank transactions
      * @param {BankTransactionApiListBankTransactionsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof BankTransactionApi
      */
-    listBankTransactions(requestParameters?: BankTransactionApiListBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBankTransactionsResponseClass, any>>;
+    listBankTransactions(requestParameters?: BankTransactionApiListBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * Unlinks an already linked bank transaction
      * @summary Unlink Bank Transaction