@emilgroup/payment-sdk 1.0.0 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +17 -2
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +4 -4
- package/api/bank-transaction-api.ts +565 -0
- package/api/payment-methods-api.ts +4 -4
- package/api/payment-reminders-api.ts +12 -10
- package/api/payments-api.ts +4 -4
- package/api/refunds-api.ts +460 -0
- package/api/tenant-bank-account-api.ts +651 -0
- package/api.ts +6 -2
- package/dist/api/bank-accounts-api.d.ts +4 -4
- package/dist/api/bank-accounts-api.js +3 -3
- package/dist/api/bank-transaction-api.d.ts +318 -0
- package/dist/api/bank-transaction-api.js +539 -0
- package/dist/api/payment-methods-api.d.ts +4 -4
- package/dist/api/payment-methods-api.js +3 -3
- package/dist/api/payment-reminders-api.d.ts +12 -11
- package/dist/api/payment-reminders-api.js +7 -7
- package/dist/api/payments-api.d.ts +4 -4
- package/dist/api/payments-api.js +3 -3
- package/dist/api/refunds-api.d.ts +260 -0
- package/dist/api/refunds-api.js +441 -0
- package/dist/api/tenant-bank-account-api.d.ts +361 -0
- package/dist/api/tenant-bank-account-api.js +616 -0
- package/dist/api.d.ts +3 -1
- package/dist/api.js +3 -1
- package/dist/models/bank-transaction-response-class.d.ts +122 -0
- package/dist/models/create-payment-request-dto.d.ts +3 -3
- package/dist/models/create-refund-request-dto.d.ts +24 -0
- package/dist/models/create-refund-request-dto.js +15 -0
- package/dist/models/create-refund-response-class.d.ts +25 -0
- package/dist/models/create-refund-response-class.js +15 -0
- package/dist/models/create-tenant-bank-account-request-dto.d.ts +42 -0
- package/dist/models/create-tenant-bank-account-request-dto.js +15 -0
- package/dist/models/deactivate-payment-reminder-response-class.d.ts +25 -0
- package/dist/models/deactivate-payment-reminder-response-class.js +15 -0
- package/dist/models/get-bank-transactions-response-class.d.ts +25 -0
- package/dist/models/get-bank-transactions-response-class.js +15 -0
- package/dist/models/{validate-pspconfig-response-class.d.ts → get-refund-response-class.d.ts} +7 -6
- package/dist/models/get-refund-response-class.js +15 -0
- package/dist/models/get-tenant-bank-account-response-class.d.ts +25 -0
- package/dist/models/get-tenant-bank-account-response-class.js +15 -0
- package/dist/models/index.d.ts +14 -1
- package/dist/models/index.js +14 -1
- package/dist/models/inline-response200.d.ts +6 -6
- package/dist/models/inline-response503.d.ts +6 -6
- package/dist/models/link-bank-transaction-request-dto.d.ts +30 -0
- package/dist/models/link-bank-transaction-request-dto.js +15 -0
- package/dist/models/list-bank-transactions-response-class.d.ts +31 -0
- package/dist/models/list-bank-transactions-response-class.js +15 -0
- package/dist/models/list-refunds-response-class.d.ts +31 -0
- package/dist/models/list-refunds-response-class.js +15 -0
- package/dist/models/payment-class.d.ts +1 -1
- package/dist/models/payment-method-class.d.ts +8 -2
- package/dist/models/refund-class.d.ts +104 -0
- package/dist/models/refund-class.js +28 -0
- package/dist/models/tenant-bank-account-response-class.d.ts +66 -0
- package/dist/models/tenant-bank-account-response-class.js +15 -0
- package/dist/models/update-tenant-bank-account-rest-request-dto.d.ts +36 -0
- package/dist/models/update-tenant-bank-account-rest-request-dto.js +15 -0
- package/git_push.sh +1 -1
- package/models/bank-transaction-response-class.ts +128 -0
- package/models/create-payment-request-dto.ts +3 -3
- package/models/create-refund-request-dto.ts +30 -0
- package/models/create-refund-response-class.ts +31 -0
- package/models/create-tenant-bank-account-request-dto.ts +48 -0
- package/models/deactivate-payment-reminder-response-class.ts +31 -0
- package/models/get-bank-transactions-response-class.ts +31 -0
- package/models/{validate-pspconfig-response-class.ts → get-refund-response-class.ts} +7 -6
- package/models/get-tenant-bank-account-response-class.ts +31 -0
- package/models/index.ts +14 -1
- package/models/inline-response200.ts +6 -6
- package/models/inline-response503.ts +6 -6
- package/models/link-bank-transaction-request-dto.ts +36 -0
- package/models/list-bank-transactions-response-class.ts +37 -0
- package/models/list-refunds-response-class.ts +37 -0
- package/models/payment-class.ts +1 -1
- package/models/payment-method-class.ts +8 -2
- package/models/refund-class.ts +114 -0
- package/models/tenant-bank-account-response-class.ts +72 -0
- package/models/update-tenant-bank-account-rest-request-dto.ts +42 -0
- package/package.json +1 -2
- package/api/payment-service-providers-api.ts +0 -161
- package/dist/api/payment-service-providers-api.d.ts +0 -93
- package/dist/api/payment-service-providers-api.js +0 -220
- /package/dist/models/{validate-pspconfig-response-class.js → bank-transaction-response-class.js} +0 -0
|
@@ -32,7 +32,7 @@ export declare const BankAccountsApiAxiosParamCreator: (configuration?: Configur
|
|
|
32
32
|
* 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.
|
|
33
33
|
* @summary List bank accounts
|
|
34
34
|
* @param {string} [authorization] Bearer Token
|
|
35
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
35
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
36
36
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
37
37
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
38
38
|
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
@@ -61,7 +61,7 @@ export declare const BankAccountsApiFp: (configuration?: Configuration) => {
|
|
|
61
61
|
* 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.
|
|
62
62
|
* @summary List bank accounts
|
|
63
63
|
* @param {string} [authorization] Bearer Token
|
|
64
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
64
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
65
65
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
66
66
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
67
67
|
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
@@ -90,7 +90,7 @@ export declare const BankAccountsApiFactory: (configuration?: Configuration, bas
|
|
|
90
90
|
* 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.
|
|
91
91
|
* @summary List bank accounts
|
|
92
92
|
* @param {string} [authorization] Bearer Token
|
|
93
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
93
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
94
94
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
95
95
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
96
96
|
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
@@ -133,7 +133,7 @@ export interface BankAccountsApiListBankAccountsRequest {
|
|
|
133
133
|
*/
|
|
134
134
|
readonly authorization?: string;
|
|
135
135
|
/**
|
|
136
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
136
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
137
137
|
* @type {any}
|
|
138
138
|
* @memberof BankAccountsApiListBankAccounts
|
|
139
139
|
*/
|
|
@@ -145,7 +145,7 @@ var BankAccountsApiAxiosParamCreator = function (configuration) {
|
|
|
145
145
|
* 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.
|
|
146
146
|
* @summary List bank accounts
|
|
147
147
|
* @param {string} [authorization] Bearer Token
|
|
148
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
148
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
149
149
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
150
150
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
151
151
|
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
@@ -244,7 +244,7 @@ var BankAccountsApiFp = function (configuration) {
|
|
|
244
244
|
* 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.
|
|
245
245
|
* @summary List bank accounts
|
|
246
246
|
* @param {string} [authorization] Bearer Token
|
|
247
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
247
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
248
248
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
249
249
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
250
250
|
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
@@ -291,7 +291,7 @@ var BankAccountsApiFactory = function (configuration, basePath, axios) {
|
|
|
291
291
|
* 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.
|
|
292
292
|
* @summary List bank accounts
|
|
293
293
|
* @param {string} [authorization] Bearer Token
|
|
294
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
294
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
295
295
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
296
296
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
297
297
|
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
@@ -0,0 +1,318 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Emil Payment Service
|
|
3
|
+
* 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.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
|
+
import { Configuration } from '../configuration';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { GetBankTransactionsResponseClass } from '../models';
|
|
16
|
+
import { LinkBankTransactionRequestDto } from '../models';
|
|
17
|
+
import { ListBankTransactionsResponseClass } from '../models';
|
|
18
|
+
/**
|
|
19
|
+
* BankTransactionApi - axios parameter creator
|
|
20
|
+
* @export
|
|
21
|
+
*/
|
|
22
|
+
export declare const BankTransactionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23
|
+
/**
|
|
24
|
+
*
|
|
25
|
+
* @param {string} code
|
|
26
|
+
* @param {string} [authorization] Bearer Token
|
|
27
|
+
* @param {string} [expand] Expand the response with additional entities
|
|
28
|
+
* @param {*} [options] Override http request option.
|
|
29
|
+
* @throws {RequiredError}
|
|
30
|
+
*/
|
|
31
|
+
getBankTransaction: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
|
+
/**
|
|
33
|
+
* Import bank transactions from a swift MT940 file
|
|
34
|
+
* @summary Create the Bank Transactions
|
|
35
|
+
* @param {string} [authorization] Bearer Token
|
|
36
|
+
* @param {any} [file]
|
|
37
|
+
* @param {*} [options] Override http request option.
|
|
38
|
+
* @throws {RequiredError}
|
|
39
|
+
*/
|
|
40
|
+
importBankTransactions: (authorization?: string, file?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41
|
+
/**
|
|
42
|
+
* Links a bank transaction with an invoice
|
|
43
|
+
* @summary Link Bank Transaction
|
|
44
|
+
* @param {string} code Code of the bank transcation to link
|
|
45
|
+
* @param {LinkBankTransactionRequestDto} linkBankTransactionRequestDto
|
|
46
|
+
* @param {string} [authorization] Bearer Token
|
|
47
|
+
* @param {*} [options] Override http request option.
|
|
48
|
+
* @throws {RequiredError}
|
|
49
|
+
*/
|
|
50
|
+
linkBankTransaction: (code: string, linkBankTransactionRequestDto: LinkBankTransactionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
* @param {string} [authorization] Bearer Token
|
|
54
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
55
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
56
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
57
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
58
|
+
* @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.
|
|
59
|
+
* @param {string} [expand] Expand the response with additional entities
|
|
60
|
+
* @param {*} [options] Override http request option.
|
|
61
|
+
* @throws {RequiredError}
|
|
62
|
+
*/
|
|
63
|
+
listBankTransactions: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
|
+
};
|
|
65
|
+
/**
|
|
66
|
+
* BankTransactionApi - functional programming interface
|
|
67
|
+
* @export
|
|
68
|
+
*/
|
|
69
|
+
export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
70
|
+
/**
|
|
71
|
+
*
|
|
72
|
+
* @param {string} code
|
|
73
|
+
* @param {string} [authorization] Bearer Token
|
|
74
|
+
* @param {string} [expand] Expand the response with additional entities
|
|
75
|
+
* @param {*} [options] Override http request option.
|
|
76
|
+
* @throws {RequiredError}
|
|
77
|
+
*/
|
|
78
|
+
getBankTransaction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankTransactionsResponseClass>>;
|
|
79
|
+
/**
|
|
80
|
+
* Import bank transactions from a swift MT940 file
|
|
81
|
+
* @summary Create the Bank Transactions
|
|
82
|
+
* @param {string} [authorization] Bearer Token
|
|
83
|
+
* @param {any} [file]
|
|
84
|
+
* @param {*} [options] Override http request option.
|
|
85
|
+
* @throws {RequiredError}
|
|
86
|
+
*/
|
|
87
|
+
importBankTransactions(authorization?: string, file?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBankTransactionsResponseClass>>;
|
|
88
|
+
/**
|
|
89
|
+
* Links a bank transaction with an invoice
|
|
90
|
+
* @summary Link Bank Transaction
|
|
91
|
+
* @param {string} code Code of the bank transcation to link
|
|
92
|
+
* @param {LinkBankTransactionRequestDto} linkBankTransactionRequestDto
|
|
93
|
+
* @param {string} [authorization] Bearer Token
|
|
94
|
+
* @param {*} [options] Override http request option.
|
|
95
|
+
* @throws {RequiredError}
|
|
96
|
+
*/
|
|
97
|
+
linkBankTransaction(code: string, linkBankTransactionRequestDto: LinkBankTransactionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankTransactionsResponseClass>>;
|
|
98
|
+
/**
|
|
99
|
+
*
|
|
100
|
+
* @param {string} [authorization] Bearer Token
|
|
101
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
102
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
103
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
104
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
105
|
+
* @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.
|
|
106
|
+
* @param {string} [expand] Expand the response with additional entities
|
|
107
|
+
* @param {*} [options] Override http request option.
|
|
108
|
+
* @throws {RequiredError}
|
|
109
|
+
*/
|
|
110
|
+
listBankTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBankTransactionsResponseClass>>;
|
|
111
|
+
};
|
|
112
|
+
/**
|
|
113
|
+
* BankTransactionApi - factory interface
|
|
114
|
+
* @export
|
|
115
|
+
*/
|
|
116
|
+
export declare const BankTransactionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
117
|
+
/**
|
|
118
|
+
*
|
|
119
|
+
* @param {string} code
|
|
120
|
+
* @param {string} [authorization] Bearer Token
|
|
121
|
+
* @param {string} [expand] Expand the response with additional entities
|
|
122
|
+
* @param {*} [options] Override http request option.
|
|
123
|
+
* @throws {RequiredError}
|
|
124
|
+
*/
|
|
125
|
+
getBankTransaction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetBankTransactionsResponseClass>;
|
|
126
|
+
/**
|
|
127
|
+
* Import bank transactions from a swift MT940 file
|
|
128
|
+
* @summary Create the Bank Transactions
|
|
129
|
+
* @param {string} [authorization] Bearer Token
|
|
130
|
+
* @param {any} [file]
|
|
131
|
+
* @param {*} [options] Override http request option.
|
|
132
|
+
* @throws {RequiredError}
|
|
133
|
+
*/
|
|
134
|
+
importBankTransactions(authorization?: string, file?: any, options?: any): AxiosPromise<ListBankTransactionsResponseClass>;
|
|
135
|
+
/**
|
|
136
|
+
* Links a bank transaction with an invoice
|
|
137
|
+
* @summary Link Bank Transaction
|
|
138
|
+
* @param {string} code Code of the bank transcation to link
|
|
139
|
+
* @param {LinkBankTransactionRequestDto} linkBankTransactionRequestDto
|
|
140
|
+
* @param {string} [authorization] Bearer Token
|
|
141
|
+
* @param {*} [options] Override http request option.
|
|
142
|
+
* @throws {RequiredError}
|
|
143
|
+
*/
|
|
144
|
+
linkBankTransaction(code: string, linkBankTransactionRequestDto: LinkBankTransactionRequestDto, authorization?: string, options?: any): AxiosPromise<GetBankTransactionsResponseClass>;
|
|
145
|
+
/**
|
|
146
|
+
*
|
|
147
|
+
* @param {string} [authorization] Bearer Token
|
|
148
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
149
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
150
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
151
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
152
|
+
* @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.
|
|
153
|
+
* @param {string} [expand] Expand the response with additional entities
|
|
154
|
+
* @param {*} [options] Override http request option.
|
|
155
|
+
* @throws {RequiredError}
|
|
156
|
+
*/
|
|
157
|
+
listBankTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: string, options?: any): AxiosPromise<ListBankTransactionsResponseClass>;
|
|
158
|
+
};
|
|
159
|
+
/**
|
|
160
|
+
* Request parameters for getBankTransaction operation in BankTransactionApi.
|
|
161
|
+
* @export
|
|
162
|
+
* @interface BankTransactionApiGetBankTransactionRequest
|
|
163
|
+
*/
|
|
164
|
+
export interface BankTransactionApiGetBankTransactionRequest {
|
|
165
|
+
/**
|
|
166
|
+
*
|
|
167
|
+
* @type {string}
|
|
168
|
+
* @memberof BankTransactionApiGetBankTransaction
|
|
169
|
+
*/
|
|
170
|
+
readonly code: string;
|
|
171
|
+
/**
|
|
172
|
+
* Bearer Token
|
|
173
|
+
* @type {string}
|
|
174
|
+
* @memberof BankTransactionApiGetBankTransaction
|
|
175
|
+
*/
|
|
176
|
+
readonly authorization?: string;
|
|
177
|
+
/**
|
|
178
|
+
* Expand the response with additional entities
|
|
179
|
+
* @type {string}
|
|
180
|
+
* @memberof BankTransactionApiGetBankTransaction
|
|
181
|
+
*/
|
|
182
|
+
readonly expand?: string;
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* Request parameters for importBankTransactions operation in BankTransactionApi.
|
|
186
|
+
* @export
|
|
187
|
+
* @interface BankTransactionApiImportBankTransactionsRequest
|
|
188
|
+
*/
|
|
189
|
+
export interface BankTransactionApiImportBankTransactionsRequest {
|
|
190
|
+
/**
|
|
191
|
+
* Bearer Token
|
|
192
|
+
* @type {string}
|
|
193
|
+
* @memberof BankTransactionApiImportBankTransactions
|
|
194
|
+
*/
|
|
195
|
+
readonly authorization?: string;
|
|
196
|
+
/**
|
|
197
|
+
*
|
|
198
|
+
* @type {any}
|
|
199
|
+
* @memberof BankTransactionApiImportBankTransactions
|
|
200
|
+
*/
|
|
201
|
+
readonly file?: any;
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* Request parameters for linkBankTransaction operation in BankTransactionApi.
|
|
205
|
+
* @export
|
|
206
|
+
* @interface BankTransactionApiLinkBankTransactionRequest
|
|
207
|
+
*/
|
|
208
|
+
export interface BankTransactionApiLinkBankTransactionRequest {
|
|
209
|
+
/**
|
|
210
|
+
* Code of the bank transcation to link
|
|
211
|
+
* @type {string}
|
|
212
|
+
* @memberof BankTransactionApiLinkBankTransaction
|
|
213
|
+
*/
|
|
214
|
+
readonly code: string;
|
|
215
|
+
/**
|
|
216
|
+
*
|
|
217
|
+
* @type {LinkBankTransactionRequestDto}
|
|
218
|
+
* @memberof BankTransactionApiLinkBankTransaction
|
|
219
|
+
*/
|
|
220
|
+
readonly linkBankTransactionRequestDto: LinkBankTransactionRequestDto;
|
|
221
|
+
/**
|
|
222
|
+
* Bearer Token
|
|
223
|
+
* @type {string}
|
|
224
|
+
* @memberof BankTransactionApiLinkBankTransaction
|
|
225
|
+
*/
|
|
226
|
+
readonly authorization?: string;
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* Request parameters for listBankTransactions operation in BankTransactionApi.
|
|
230
|
+
* @export
|
|
231
|
+
* @interface BankTransactionApiListBankTransactionsRequest
|
|
232
|
+
*/
|
|
233
|
+
export interface BankTransactionApiListBankTransactionsRequest {
|
|
234
|
+
/**
|
|
235
|
+
* Bearer Token
|
|
236
|
+
* @type {string}
|
|
237
|
+
* @memberof BankTransactionApiListBankTransactions
|
|
238
|
+
*/
|
|
239
|
+
readonly authorization?: string;
|
|
240
|
+
/**
|
|
241
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
242
|
+
* @type {any}
|
|
243
|
+
* @memberof BankTransactionApiListBankTransactions
|
|
244
|
+
*/
|
|
245
|
+
readonly pageSize?: any;
|
|
246
|
+
/**
|
|
247
|
+
* 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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
248
|
+
* @type {any}
|
|
249
|
+
* @memberof BankTransactionApiListBankTransactions
|
|
250
|
+
*/
|
|
251
|
+
readonly pageToken?: any;
|
|
252
|
+
/**
|
|
253
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
254
|
+
* @type {any}
|
|
255
|
+
* @memberof BankTransactionApiListBankTransactions
|
|
256
|
+
*/
|
|
257
|
+
readonly filter?: any;
|
|
258
|
+
/**
|
|
259
|
+
* Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
260
|
+
* @type {any}
|
|
261
|
+
* @memberof BankTransactionApiListBankTransactions
|
|
262
|
+
*/
|
|
263
|
+
readonly search?: any;
|
|
264
|
+
/**
|
|
265
|
+
* 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.
|
|
266
|
+
* @type {any}
|
|
267
|
+
* @memberof BankTransactionApiListBankTransactions
|
|
268
|
+
*/
|
|
269
|
+
readonly order?: any;
|
|
270
|
+
/**
|
|
271
|
+
* Expand the response with additional entities
|
|
272
|
+
* @type {string}
|
|
273
|
+
* @memberof BankTransactionApiListBankTransactions
|
|
274
|
+
*/
|
|
275
|
+
readonly expand?: string;
|
|
276
|
+
}
|
|
277
|
+
/**
|
|
278
|
+
* BankTransactionApi - object-oriented interface
|
|
279
|
+
* @export
|
|
280
|
+
* @class BankTransactionApi
|
|
281
|
+
* @extends {BaseAPI}
|
|
282
|
+
*/
|
|
283
|
+
export declare class BankTransactionApi extends BaseAPI {
|
|
284
|
+
/**
|
|
285
|
+
*
|
|
286
|
+
* @param {BankTransactionApiGetBankTransactionRequest} requestParameters Request parameters.
|
|
287
|
+
* @param {*} [options] Override http request option.
|
|
288
|
+
* @throws {RequiredError}
|
|
289
|
+
* @memberof BankTransactionApi
|
|
290
|
+
*/
|
|
291
|
+
getBankTransaction(requestParameters: BankTransactionApiGetBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankTransactionsResponseClass, any>>;
|
|
292
|
+
/**
|
|
293
|
+
* Import bank transactions from a swift MT940 file
|
|
294
|
+
* @summary Create the Bank Transactions
|
|
295
|
+
* @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
|
|
296
|
+
* @param {*} [options] Override http request option.
|
|
297
|
+
* @throws {RequiredError}
|
|
298
|
+
* @memberof BankTransactionApi
|
|
299
|
+
*/
|
|
300
|
+
importBankTransactions(requestParameters?: BankTransactionApiImportBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBankTransactionsResponseClass, any>>;
|
|
301
|
+
/**
|
|
302
|
+
* Links a bank transaction with an invoice
|
|
303
|
+
* @summary Link Bank Transaction
|
|
304
|
+
* @param {BankTransactionApiLinkBankTransactionRequest} requestParameters Request parameters.
|
|
305
|
+
* @param {*} [options] Override http request option.
|
|
306
|
+
* @throws {RequiredError}
|
|
307
|
+
* @memberof BankTransactionApi
|
|
308
|
+
*/
|
|
309
|
+
linkBankTransaction(requestParameters: BankTransactionApiLinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankTransactionsResponseClass, any>>;
|
|
310
|
+
/**
|
|
311
|
+
*
|
|
312
|
+
* @param {BankTransactionApiListBankTransactionsRequest} requestParameters Request parameters.
|
|
313
|
+
* @param {*} [options] Override http request option.
|
|
314
|
+
* @throws {RequiredError}
|
|
315
|
+
* @memberof BankTransactionApi
|
|
316
|
+
*/
|
|
317
|
+
listBankTransactions(requestParameters?: BankTransactionApiListBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBankTransactionsResponseClass, any>>;
|
|
318
|
+
}
|