@emilgroup/payment-sdk 1.0.0 → 1.4.1-beta.0

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

@@ -0,0 +1,371 @@
+/**
+ * Emil Payment Service
+ * This service directly communicates with the various Payment Service Providers (PSPs)    in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: z
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { GetBankTransactionsResponseClass } from '../models';
+import { ListBankTransactionsResponseClass } 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.
+     * @summary Retrieve the Bank Transaction
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Expand the response with additional entities
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBankTransaction: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Import bank transactions from a swift MT940 file
+     * @summary Create the bank transactions
+     * @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>;
+    /**
+     * Links a bank transaction with an invoice
+     * @summary Link Bank Transaction
+     * @param {string} code Code of the bank transaction to link
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    linkBankTransaction: (code: string, 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.
+     * @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} [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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBankTransactions: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: string, 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 {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    unlinkBankTransaction: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * BankTransactionApi - functional programming interface
+ * @export
+ */
+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.
+     * @summary Retrieve the Bank Transaction
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Expand the response with additional entities
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBankTransaction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankTransactionsResponseClass>>;
+    /**
+     * Import bank transactions from a swift MT940 file
+     * @summary Create the bank transactions
+     * @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>>;
+    /**
+     * Links a bank transaction with an invoice
+     * @summary Link Bank Transaction
+     * @param {string} code Code of the bank transaction to link
+     * @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>>;
+    /**
+     * 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} [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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBankTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: string, 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 {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>>;
+};
+/**
+ * BankTransactionApi - factory interface
+ * @export
+ */
+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.
+     * @summary Retrieve the Bank Transaction
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Expand the response with additional entities
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBankTransaction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetBankTransactionsResponseClass>;
+    /**
+     * Import bank transactions from a swift MT940 file
+     * @summary Create the bank transactions
+     * @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>;
+    /**
+     * Links a bank transaction with an invoice
+     * @summary Link Bank Transaction
+     * @param {string} code Code of the bank transaction to link
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    linkBankTransaction(code: string, 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.
+     * @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} [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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBankTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: string, 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 {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    unlinkBankTransaction(code: string, authorization?: string, options?: any): AxiosPromise<GetBankTransactionsResponseClass>;
+};
+/**
+ * Request parameters for getBankTransaction operation in BankTransactionApi.
+ * @export
+ * @interface BankTransactionApiGetBankTransactionRequest
+ */
+export interface BankTransactionApiGetBankTransactionRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof BankTransactionApiGetBankTransaction
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BankTransactionApiGetBankTransaction
+     */
+    readonly authorization?: string;
+    /**
+     * Expand the response with additional entities
+     * @type {string}
+     * @memberof BankTransactionApiGetBankTransaction
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for importBankTransactions operation in BankTransactionApi.
+ * @export
+ * @interface BankTransactionApiImportBankTransactionsRequest
+ */
+export interface BankTransactionApiImportBankTransactionsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BankTransactionApiImportBankTransactions
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {any}
+     * @memberof BankTransactionApiImportBankTransactions
+     */
+    readonly file?: any;
+}
+/**
+ * Request parameters for linkBankTransaction operation in BankTransactionApi.
+ * @export
+ * @interface BankTransactionApiLinkBankTransactionRequest
+ */
+export interface BankTransactionApiLinkBankTransactionRequest {
+    /**
+     * Code of the bank transaction to link
+     * @type {string}
+     * @memberof BankTransactionApiLinkBankTransaction
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BankTransactionApiLinkBankTransaction
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listBankTransactions operation in BankTransactionApi.
+ * @export
+ * @interface BankTransactionApiListBankTransactionsRequest
+ */
+export interface BankTransactionApiListBankTransactionsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BankTransactionApiListBankTransactions
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {any}
+     * @memberof BankTransactionApiListBankTransactions
+     */
+    readonly pageSize?: any;
+    /**
+     * 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.
+     * @type {any}
+     * @memberof BankTransactionApiListBankTransactions
+     */
+    readonly pageToken?: any;
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @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.
+     * @type {any}
+     * @memberof BankTransactionApiListBankTransactions
+     */
+    readonly search?: any;
+    /**
+     * 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.
+     * @type {any}
+     * @memberof BankTransactionApiListBankTransactions
+     */
+    readonly order?: any;
+    /**
+     * Expand the response with additional entities
+     * @type {string}
+     * @memberof BankTransactionApiListBankTransactions
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for unlinkBankTransaction operation in BankTransactionApi.
+ * @export
+ * @interface BankTransactionApiUnlinkBankTransactionRequest
+ */
+export interface BankTransactionApiUnlinkBankTransactionRequest {
+    /**
+     * Code of the bank transaction to unlink
+     * @type {string}
+     * @memberof BankTransactionApiUnlinkBankTransaction
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BankTransactionApiUnlinkBankTransaction
+     */
+    readonly authorization?: string;
+}
+/**
+ * BankTransactionApi - object-oriented interface
+ * @export
+ * @class BankTransactionApi
+ * @extends {BaseAPI}
+ */
+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.
+     * @summary Retrieve the Bank Transaction
+     * @param {BankTransactionApiGetBankTransactionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BankTransactionApi
+     */
+    getBankTransaction(requestParameters: BankTransactionApiGetBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankTransactionsResponseClass, any>>;
+    /**
+     * Import bank transactions from a swift MT940 file
+     * @summary Create the bank transactions
+     * @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BankTransactionApi
+     */
+    importBankTransactions(requestParameters?: BankTransactionApiImportBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBankTransactionsResponseClass, any>>;
+    /**
+     * Links a bank transaction with an invoice
+     * @summary Link Bank Transaction
+     * @param {BankTransactionApiLinkBankTransactionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BankTransactionApi
+     */
+    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.
+     * @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<void, any>>;
+    /**
+     * Unlinks an already linked bank transaction
+     * @summary Unlink Bank Transaction
+     * @param {BankTransactionApiUnlinkBankTransactionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BankTransactionApi
+     */
+    unlinkBankTransaction(requestParameters: BankTransactionApiUnlinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankTransactionsResponseClass, any>>;
+}