@emilgroup/payment-sdk 1.13.1-beta.2 → 1.13.1-beta.21
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 +12 -0
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +79 -37
- package/api/bank-orders-api.ts +691 -0
- package/api/bank-transaction-api.ts +187 -56
- package/api/payment-methods-api.ts +67 -25
- package/api/payment-reminders-api.ts +85 -43
- package/api/payment-setup-api.ts +8 -8
- package/api/payments-api.ts +67 -25
- package/api/refunds-api.ts +57 -29
- package/api/tenant-bank-account-api.ts +45 -17
- package/api/webhooks-api.ts +4 -4
- package/api.ts +2 -0
- package/base.ts +1 -1
- package/dist/api/bank-accounts-api.d.ts +59 -32
- package/dist/api/bank-accounts-api.js +53 -35
- package/dist/api/bank-orders-api.d.ts +393 -0
- package/dist/api/bank-orders-api.js +642 -0
- package/dist/api/bank-transaction-api.d.ts +123 -49
- package/dist/api/bank-transaction-api.js +151 -47
- package/dist/api/payment-methods-api.d.ts +47 -20
- package/dist/api/payment-methods-api.js +41 -23
- package/dist/api/payment-reminders-api.d.ts +61 -34
- package/dist/api/payment-reminders-api.js +54 -36
- package/dist/api/payment-setup-api.d.ts +8 -8
- package/dist/api/payment-setup-api.js +8 -8
- package/dist/api/payments-api.d.ts +47 -20
- package/dist/api/payments-api.js +41 -23
- package/dist/api/refunds-api.d.ts +40 -22
- package/dist/api/refunds-api.js +36 -24
- package/dist/api/tenant-bank-account-api.d.ts +28 -10
- package/dist/api/tenant-bank-account-api.js +24 -12
- package/dist/api/webhooks-api.d.ts +4 -4
- package/dist/api/webhooks-api.js +4 -4
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/bank-order-class.d.ts +115 -0
- package/dist/models/bank-order-class.js +15 -0
- package/dist/models/bank-transaction-class-without-expand-properties.d.ts +8 -2
- package/dist/models/bank-transaction-class.d.ts +22 -2
- package/dist/models/create-bank-order-request-dto.d.ts +74 -0
- package/dist/models/create-bank-order-request-dto.js +28 -0
- package/dist/models/create-bank-order-response-class.d.ts +25 -0
- package/dist/models/create-bank-order-response-class.js +15 -0
- package/dist/models/create-payment-reminder-request-dto.d.ts +7 -1
- package/dist/models/create-payment-request-dto.d.ts +7 -1
- package/dist/models/create-psp-payment-method-request-dto.d.ts +7 -1
- package/dist/models/deactivated-payment-reminder-class.d.ts +7 -1
- package/dist/models/financial-account-class.d.ts +111 -0
- package/dist/models/financial-account-class.js +24 -0
- package/dist/models/generate-invoice-match-suggestions-response-class.d.ts +25 -0
- package/dist/models/generate-invoice-match-suggestions-response-class.js +15 -0
- package/dist/models/get-bank-order-response-class.d.ts +25 -0
- package/dist/models/get-bank-order-response-class.js +15 -0
- package/dist/models/index.d.ts +11 -0
- package/dist/models/index.js +11 -0
- package/dist/models/initiate-adyen-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/invoice-match-suggestion-class.d.ts +60 -0
- package/dist/models/invoice-match-suggestion-class.js +15 -0
- package/dist/models/list-bank-orders-response-class.d.ts +31 -0
- package/dist/models/list-bank-orders-response-class.js +15 -0
- package/dist/models/payment-class-without-expand-properties.d.ts +7 -1
- package/dist/models/payment-class.d.ts +7 -1
- package/dist/models/payment-reminder-class.d.ts +7 -1
- package/dist/models/refund-class.d.ts +7 -1
- package/dist/models/suggestion-generation-progress-class.d.ts +43 -0
- package/dist/models/suggestion-generation-progress-class.js +22 -0
- package/dist/models/unlinked-bank-transaction-response-class.d.ts +8 -2
- package/dist/models/update-bank-order-request-dto.d.ts +56 -0
- package/dist/models/update-bank-order-request-dto.js +23 -0
- package/dist/models/update-bank-order-response-class.d.ts +25 -0
- package/dist/models/update-bank-order-response-class.js +15 -0
- package/models/bank-order-class.ts +121 -0
- package/models/bank-transaction-class-without-expand-properties.ts +8 -2
- package/models/bank-transaction-class.ts +22 -2
- package/models/create-bank-order-request-dto.ts +84 -0
- package/models/create-bank-order-response-class.ts +31 -0
- package/models/create-payment-reminder-request-dto.ts +7 -1
- package/models/create-payment-request-dto.ts +7 -1
- package/models/create-psp-payment-method-request-dto.ts +7 -1
- package/models/deactivated-payment-reminder-class.ts +7 -1
- package/models/financial-account-class.ts +120 -0
- package/models/generate-invoice-match-suggestions-response-class.ts +31 -0
- package/models/get-bank-order-response-class.ts +31 -0
- package/models/index.ts +11 -0
- package/models/initiate-adyen-payment-setup-request-dto.ts +6 -0
- package/models/initiate-braintree-payment-setup-request-dto.ts +6 -0
- package/models/initiate-stripe-payment-setup-request-dto.ts +6 -0
- package/models/invoice-match-suggestion-class.ts +66 -0
- package/models/list-bank-orders-response-class.ts +37 -0
- package/models/payment-class-without-expand-properties.ts +7 -1
- package/models/payment-class.ts +7 -1
- package/models/payment-reminder-class.ts +7 -1
- package/models/refund-class.ts +7 -1
- package/models/suggestion-generation-progress-class.ts +52 -0
- package/models/unlinked-bank-transaction-response-class.ts +8 -2
- package/models/update-bank-order-request-dto.ts +65 -0
- package/models/update-bank-order-response-class.ts +31 -0
- package/package.json +1 -1
- package/tsconfig.json +1 -0
|
@@ -21,6 +21,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
21
21
|
// @ts-ignore
|
|
22
22
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
23
|
// @ts-ignore
|
|
24
|
+
import { GenerateInvoiceMatchSuggestionsResponseClass } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
24
26
|
import { GetBankTransactionsResponseClass } from '../models';
|
|
25
27
|
// @ts-ignore
|
|
26
28
|
import { ImportBankTransactionsResponseClass } from '../models';
|
|
@@ -41,11 +43,56 @@ import { UnlinkBankTransactionsResponseClass } from '../models';
|
|
|
41
43
|
export const BankTransactionApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
42
44
|
return {
|
|
43
45
|
/**
|
|
44
|
-
*
|
|
46
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
47
|
+
* @summary Invoice Match Suggestion
|
|
48
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
49
|
+
* @param {string} [authorization] Bearer Token
|
|
50
|
+
* @param {*} [options] Override http request option.
|
|
51
|
+
* @throws {RequiredError}
|
|
52
|
+
*/
|
|
53
|
+
generateInvoiceMatchSuggestion: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54
|
+
// verify required parameter 'code' is not null or undefined
|
|
55
|
+
assertParamExists('generateInvoiceMatchSuggestion', 'code', code)
|
|
56
|
+
const localVarPath = `/paymentservice/v1/tenant/bank-transactions/{code}/generate-invoice-match-suggestion`
|
|
57
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
58
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
59
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
60
|
+
let baseOptions;
|
|
61
|
+
let baseAccessToken;
|
|
62
|
+
if (configuration) {
|
|
63
|
+
baseOptions = configuration.baseOptions;
|
|
64
|
+
baseAccessToken = configuration.accessToken;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
68
|
+
const localVarHeaderParameter = {} as any;
|
|
69
|
+
const localVarQueryParameter = {} as any;
|
|
70
|
+
|
|
71
|
+
// authentication bearer required
|
|
72
|
+
// http bearer authentication required
|
|
73
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
74
|
+
|
|
75
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
76
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
82
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
83
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
84
|
+
|
|
85
|
+
return {
|
|
86
|
+
url: toPathString(localVarUrlObj),
|
|
87
|
+
options: localVarRequestOptions,
|
|
88
|
+
};
|
|
89
|
+
},
|
|
90
|
+
/**
|
|
91
|
+
* 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. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
45
92
|
* @summary Retrieve the bank transaction
|
|
46
93
|
* @param {string} code
|
|
47
94
|
* @param {string} [authorization] Bearer Token
|
|
48
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
95
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
49
96
|
* @param {*} [options] Override http request option.
|
|
50
97
|
* @throws {RequiredError}
|
|
51
98
|
*/
|
|
@@ -91,9 +138,9 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
91
138
|
};
|
|
92
139
|
},
|
|
93
140
|
/**
|
|
94
|
-
* This will import bank transactions from a
|
|
141
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
95
142
|
* @summary Create the bank transactions
|
|
96
|
-
* @param {any} file
|
|
143
|
+
* @param {any} file MT940/CAMT.053 file to import bank transactions from. Extension must be .txt .sta or .xml.<br/> Allowed Content Types: text/plain, application/octet-stream, application/xml, text/xml
|
|
97
144
|
* @param {string} [authorization] Bearer Token
|
|
98
145
|
* @param {*} [options] Override http request option.
|
|
99
146
|
* @throws {RequiredError}
|
|
@@ -143,7 +190,7 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
143
190
|
};
|
|
144
191
|
},
|
|
145
192
|
/**
|
|
146
|
-
* Links a bank transaction with an invoice
|
|
193
|
+
* Links a bank transaction with an invoice **Required Permissions** \"payment-management.bank-accounts.create\"
|
|
147
194
|
* @summary Link bank transaction
|
|
148
195
|
* @param {string} code Code of the bank transaction to link
|
|
149
196
|
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
@@ -194,18 +241,20 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
194
241
|
};
|
|
195
242
|
},
|
|
196
243
|
/**
|
|
197
|
-
* 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.
|
|
244
|
+
* 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. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
198
245
|
* @summary List bank transactions
|
|
199
246
|
* @param {string} [authorization] Bearer Token
|
|
200
|
-
* @param {
|
|
201
|
-
* @param {string} [
|
|
247
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
248
|
+
* @param {string} [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
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
202
250
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
|
|
203
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt,
|
|
204
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
251
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, transactionDate, entryDate</i>
|
|
252
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
253
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
205
254
|
* @param {*} [options] Override http request option.
|
|
206
255
|
* @throws {RequiredError}
|
|
207
256
|
*/
|
|
208
|
-
listBankTransactions: async (authorization?: string,
|
|
257
|
+
listBankTransactions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
209
258
|
const localVarPath = `/paymentservice/v1/tenant/bank-transactions`;
|
|
210
259
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
211
260
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -224,12 +273,16 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
224
273
|
// http bearer authentication required
|
|
225
274
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
226
275
|
|
|
227
|
-
if (
|
|
228
|
-
localVarQueryParameter['
|
|
276
|
+
if (pageSize !== undefined) {
|
|
277
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
229
278
|
}
|
|
230
279
|
|
|
231
|
-
if (
|
|
232
|
-
localVarQueryParameter['
|
|
280
|
+
if (pageToken !== undefined) {
|
|
281
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
282
|
+
}
|
|
283
|
+
|
|
284
|
+
if (filter !== undefined) {
|
|
285
|
+
localVarQueryParameter['filter'] = filter;
|
|
233
286
|
}
|
|
234
287
|
|
|
235
288
|
if (search !== undefined) {
|
|
@@ -244,6 +297,10 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
244
297
|
localVarQueryParameter['expand'] = expand;
|
|
245
298
|
}
|
|
246
299
|
|
|
300
|
+
if (filters !== undefined) {
|
|
301
|
+
localVarQueryParameter['filters'] = filters;
|
|
302
|
+
}
|
|
303
|
+
|
|
247
304
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
248
305
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
249
306
|
}
|
|
@@ -260,7 +317,7 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
260
317
|
};
|
|
261
318
|
},
|
|
262
319
|
/**
|
|
263
|
-
* Unlinks an already linked bank transaction
|
|
320
|
+
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
264
321
|
* @summary Unlink bank transaction
|
|
265
322
|
* @param {string} code Code of the bank transaction to unlink
|
|
266
323
|
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
@@ -321,11 +378,23 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
321
378
|
const localVarAxiosParamCreator = BankTransactionApiAxiosParamCreator(configuration)
|
|
322
379
|
return {
|
|
323
380
|
/**
|
|
324
|
-
*
|
|
381
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
382
|
+
* @summary Invoice Match Suggestion
|
|
383
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
384
|
+
* @param {string} [authorization] Bearer Token
|
|
385
|
+
* @param {*} [options] Override http request option.
|
|
386
|
+
* @throws {RequiredError}
|
|
387
|
+
*/
|
|
388
|
+
async generateInvoiceMatchSuggestion(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateInvoiceMatchSuggestionsResponseClass>> {
|
|
389
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.generateInvoiceMatchSuggestion(code, authorization, options);
|
|
390
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
391
|
+
},
|
|
392
|
+
/**
|
|
393
|
+
* 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. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
325
394
|
* @summary Retrieve the bank transaction
|
|
326
395
|
* @param {string} code
|
|
327
396
|
* @param {string} [authorization] Bearer Token
|
|
328
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
397
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
329
398
|
* @param {*} [options] Override http request option.
|
|
330
399
|
* @throws {RequiredError}
|
|
331
400
|
*/
|
|
@@ -334,9 +403,9 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
334
403
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
335
404
|
},
|
|
336
405
|
/**
|
|
337
|
-
* This will import bank transactions from a
|
|
406
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
338
407
|
* @summary Create the bank transactions
|
|
339
|
-
* @param {any} file
|
|
408
|
+
* @param {any} file MT940/CAMT.053 file to import bank transactions from. Extension must be .txt .sta or .xml.<br/> Allowed Content Types: text/plain, application/octet-stream, application/xml, text/xml
|
|
340
409
|
* @param {string} [authorization] Bearer Token
|
|
341
410
|
* @param {*} [options] Override http request option.
|
|
342
411
|
* @throws {RequiredError}
|
|
@@ -346,7 +415,7 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
346
415
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
347
416
|
},
|
|
348
417
|
/**
|
|
349
|
-
* Links a bank transaction with an invoice
|
|
418
|
+
* Links a bank transaction with an invoice **Required Permissions** \"payment-management.bank-accounts.create\"
|
|
350
419
|
* @summary Link bank transaction
|
|
351
420
|
* @param {string} code Code of the bank transaction to link
|
|
352
421
|
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
@@ -359,23 +428,25 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
359
428
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
360
429
|
},
|
|
361
430
|
/**
|
|
362
|
-
* 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.
|
|
431
|
+
* 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. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
363
432
|
* @summary List bank transactions
|
|
364
433
|
* @param {string} [authorization] Bearer Token
|
|
365
|
-
* @param {
|
|
366
|
-
* @param {string} [
|
|
434
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
435
|
+
* @param {string} [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.
|
|
436
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
367
437
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
|
|
368
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt,
|
|
369
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
438
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, transactionDate, entryDate</i>
|
|
439
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
440
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
370
441
|
* @param {*} [options] Override http request option.
|
|
371
442
|
* @throws {RequiredError}
|
|
372
443
|
*/
|
|
373
|
-
async listBankTransactions(authorization?: string,
|
|
374
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listBankTransactions(authorization,
|
|
444
|
+
async listBankTransactions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBankTransactionsResponseClass>> {
|
|
445
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listBankTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
375
446
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
376
447
|
},
|
|
377
448
|
/**
|
|
378
|
-
* Unlinks an already linked bank transaction
|
|
449
|
+
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
379
450
|
* @summary Unlink bank transaction
|
|
380
451
|
* @param {string} code Code of the bank transaction to unlink
|
|
381
452
|
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
@@ -398,11 +469,22 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
398
469
|
const localVarFp = BankTransactionApiFp(configuration)
|
|
399
470
|
return {
|
|
400
471
|
/**
|
|
401
|
-
*
|
|
472
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
473
|
+
* @summary Invoice Match Suggestion
|
|
474
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
475
|
+
* @param {string} [authorization] Bearer Token
|
|
476
|
+
* @param {*} [options] Override http request option.
|
|
477
|
+
* @throws {RequiredError}
|
|
478
|
+
*/
|
|
479
|
+
generateInvoiceMatchSuggestion(code: string, authorization?: string, options?: any): AxiosPromise<GenerateInvoiceMatchSuggestionsResponseClass> {
|
|
480
|
+
return localVarFp.generateInvoiceMatchSuggestion(code, authorization, options).then((request) => request(axios, basePath));
|
|
481
|
+
},
|
|
482
|
+
/**
|
|
483
|
+
* 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. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
402
484
|
* @summary Retrieve the bank transaction
|
|
403
485
|
* @param {string} code
|
|
404
486
|
* @param {string} [authorization] Bearer Token
|
|
405
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
487
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
406
488
|
* @param {*} [options] Override http request option.
|
|
407
489
|
* @throws {RequiredError}
|
|
408
490
|
*/
|
|
@@ -410,9 +492,9 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
410
492
|
return localVarFp.getBankTransaction(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
411
493
|
},
|
|
412
494
|
/**
|
|
413
|
-
* This will import bank transactions from a
|
|
495
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
414
496
|
* @summary Create the bank transactions
|
|
415
|
-
* @param {any} file
|
|
497
|
+
* @param {any} file MT940/CAMT.053 file to import bank transactions from. Extension must be .txt .sta or .xml.<br/> Allowed Content Types: text/plain, application/octet-stream, application/xml, text/xml
|
|
416
498
|
* @param {string} [authorization] Bearer Token
|
|
417
499
|
* @param {*} [options] Override http request option.
|
|
418
500
|
* @throws {RequiredError}
|
|
@@ -421,7 +503,7 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
421
503
|
return localVarFp.importBankTransactions(file, authorization, options).then((request) => request(axios, basePath));
|
|
422
504
|
},
|
|
423
505
|
/**
|
|
424
|
-
* Links a bank transaction with an invoice
|
|
506
|
+
* Links a bank transaction with an invoice **Required Permissions** \"payment-management.bank-accounts.create\"
|
|
425
507
|
* @summary Link bank transaction
|
|
426
508
|
* @param {string} code Code of the bank transaction to link
|
|
427
509
|
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
@@ -433,22 +515,24 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
433
515
|
return localVarFp.linkBankTransaction(code, linkBankTransactionRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
|
|
434
516
|
},
|
|
435
517
|
/**
|
|
436
|
-
* 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.
|
|
518
|
+
* 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. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
437
519
|
* @summary List bank transactions
|
|
438
520
|
* @param {string} [authorization] Bearer Token
|
|
439
|
-
* @param {
|
|
440
|
-
* @param {string} [
|
|
521
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
522
|
+
* @param {string} [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.
|
|
523
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
441
524
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
|
|
442
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt,
|
|
443
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
525
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, transactionDate, entryDate</i>
|
|
526
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
527
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
444
528
|
* @param {*} [options] Override http request option.
|
|
445
529
|
* @throws {RequiredError}
|
|
446
530
|
*/
|
|
447
|
-
listBankTransactions(authorization?: string,
|
|
448
|
-
return localVarFp.listBankTransactions(authorization,
|
|
531
|
+
listBankTransactions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListBankTransactionsResponseClass> {
|
|
532
|
+
return localVarFp.listBankTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
449
533
|
},
|
|
450
534
|
/**
|
|
451
|
-
* Unlinks an already linked bank transaction
|
|
535
|
+
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
452
536
|
* @summary Unlink bank transaction
|
|
453
537
|
* @param {string} code Code of the bank transaction to unlink
|
|
454
538
|
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
@@ -462,6 +546,27 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
462
546
|
};
|
|
463
547
|
};
|
|
464
548
|
|
|
549
|
+
/**
|
|
550
|
+
* Request parameters for generateInvoiceMatchSuggestion operation in BankTransactionApi.
|
|
551
|
+
* @export
|
|
552
|
+
* @interface BankTransactionApiGenerateInvoiceMatchSuggestionRequest
|
|
553
|
+
*/
|
|
554
|
+
export interface BankTransactionApiGenerateInvoiceMatchSuggestionRequest {
|
|
555
|
+
/**
|
|
556
|
+
* Code of the bank transaction to generate match suggestions for
|
|
557
|
+
* @type {string}
|
|
558
|
+
* @memberof BankTransactionApiGenerateInvoiceMatchSuggestion
|
|
559
|
+
*/
|
|
560
|
+
readonly code: string
|
|
561
|
+
|
|
562
|
+
/**
|
|
563
|
+
* Bearer Token
|
|
564
|
+
* @type {string}
|
|
565
|
+
* @memberof BankTransactionApiGenerateInvoiceMatchSuggestion
|
|
566
|
+
*/
|
|
567
|
+
readonly authorization?: string
|
|
568
|
+
}
|
|
569
|
+
|
|
465
570
|
/**
|
|
466
571
|
* Request parameters for getBankTransaction operation in BankTransactionApi.
|
|
467
572
|
* @export
|
|
@@ -483,7 +588,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
483
588
|
readonly authorization?: string
|
|
484
589
|
|
|
485
590
|
/**
|
|
486
|
-
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
591
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
487
592
|
* @type {string}
|
|
488
593
|
* @memberof BankTransactionApiGetBankTransaction
|
|
489
594
|
*/
|
|
@@ -497,7 +602,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
497
602
|
*/
|
|
498
603
|
export interface BankTransactionApiImportBankTransactionsRequest {
|
|
499
604
|
/**
|
|
500
|
-
*
|
|
605
|
+
* MT940/CAMT.053 file to import bank transactions from. Extension must be .txt .sta or .xml.<br/> Allowed Content Types: text/plain, application/octet-stream, application/xml, text/xml
|
|
501
606
|
* @type {any}
|
|
502
607
|
* @memberof BankTransactionApiImportBankTransactions
|
|
503
608
|
*/
|
|
@@ -553,18 +658,25 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
553
658
|
readonly authorization?: string
|
|
554
659
|
|
|
555
660
|
/**
|
|
556
|
-
*
|
|
661
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
662
|
+
* @type {number}
|
|
663
|
+
* @memberof BankTransactionApiListBankTransactions
|
|
664
|
+
*/
|
|
665
|
+
readonly pageSize?: number
|
|
666
|
+
|
|
667
|
+
/**
|
|
668
|
+
* 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.
|
|
557
669
|
* @type {string}
|
|
558
670
|
* @memberof BankTransactionApiListBankTransactions
|
|
559
671
|
*/
|
|
560
|
-
readonly
|
|
672
|
+
readonly pageToken?: string
|
|
561
673
|
|
|
562
674
|
/**
|
|
563
|
-
*
|
|
675
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
564
676
|
* @type {string}
|
|
565
677
|
* @memberof BankTransactionApiListBankTransactions
|
|
566
678
|
*/
|
|
567
|
-
readonly
|
|
679
|
+
readonly filter?: string
|
|
568
680
|
|
|
569
681
|
/**
|
|
570
682
|
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
|
|
@@ -574,18 +686,25 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
574
686
|
readonly search?: string
|
|
575
687
|
|
|
576
688
|
/**
|
|
577
|
-
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt,
|
|
689
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, transactionDate, entryDate</i>
|
|
578
690
|
* @type {string}
|
|
579
691
|
* @memberof BankTransactionApiListBankTransactions
|
|
580
692
|
*/
|
|
581
693
|
readonly order?: string
|
|
582
694
|
|
|
583
695
|
/**
|
|
584
|
-
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
696
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
585
697
|
* @type {string}
|
|
586
698
|
* @memberof BankTransactionApiListBankTransactions
|
|
587
699
|
*/
|
|
588
700
|
readonly expand?: string
|
|
701
|
+
|
|
702
|
+
/**
|
|
703
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, bankAccountId, bankAccountNumber, messageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
704
|
+
* @type {string}
|
|
705
|
+
* @memberof BankTransactionApiListBankTransactions
|
|
706
|
+
*/
|
|
707
|
+
readonly filters?: string
|
|
589
708
|
}
|
|
590
709
|
|
|
591
710
|
/**
|
|
@@ -624,7 +743,19 @@ export interface BankTransactionApiUnlinkBankTransactionRequest {
|
|
|
624
743
|
*/
|
|
625
744
|
export class BankTransactionApi extends BaseAPI {
|
|
626
745
|
/**
|
|
627
|
-
*
|
|
746
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
747
|
+
* @summary Invoice Match Suggestion
|
|
748
|
+
* @param {BankTransactionApiGenerateInvoiceMatchSuggestionRequest} requestParameters Request parameters.
|
|
749
|
+
* @param {*} [options] Override http request option.
|
|
750
|
+
* @throws {RequiredError}
|
|
751
|
+
* @memberof BankTransactionApi
|
|
752
|
+
*/
|
|
753
|
+
public generateInvoiceMatchSuggestion(requestParameters: BankTransactionApiGenerateInvoiceMatchSuggestionRequest, options?: AxiosRequestConfig) {
|
|
754
|
+
return BankTransactionApiFp(this.configuration).generateInvoiceMatchSuggestion(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
755
|
+
}
|
|
756
|
+
|
|
757
|
+
/**
|
|
758
|
+
* 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. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
628
759
|
* @summary Retrieve the bank transaction
|
|
629
760
|
* @param {BankTransactionApiGetBankTransactionRequest} requestParameters Request parameters.
|
|
630
761
|
* @param {*} [options] Override http request option.
|
|
@@ -636,7 +767,7 @@ export class BankTransactionApi extends BaseAPI {
|
|
|
636
767
|
}
|
|
637
768
|
|
|
638
769
|
/**
|
|
639
|
-
* This will import bank transactions from a
|
|
770
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
640
771
|
* @summary Create the bank transactions
|
|
641
772
|
* @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
|
|
642
773
|
* @param {*} [options] Override http request option.
|
|
@@ -648,7 +779,7 @@ export class BankTransactionApi extends BaseAPI {
|
|
|
648
779
|
}
|
|
649
780
|
|
|
650
781
|
/**
|
|
651
|
-
* Links a bank transaction with an invoice
|
|
782
|
+
* Links a bank transaction with an invoice **Required Permissions** \"payment-management.bank-accounts.create\"
|
|
652
783
|
* @summary Link bank transaction
|
|
653
784
|
* @param {BankTransactionApiLinkBankTransactionRequest} requestParameters Request parameters.
|
|
654
785
|
* @param {*} [options] Override http request option.
|
|
@@ -660,7 +791,7 @@ export class BankTransactionApi extends BaseAPI {
|
|
|
660
791
|
}
|
|
661
792
|
|
|
662
793
|
/**
|
|
663
|
-
* 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.
|
|
794
|
+
* 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. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
664
795
|
* @summary List bank transactions
|
|
665
796
|
* @param {BankTransactionApiListBankTransactionsRequest} requestParameters Request parameters.
|
|
666
797
|
* @param {*} [options] Override http request option.
|
|
@@ -668,11 +799,11 @@ export class BankTransactionApi extends BaseAPI {
|
|
|
668
799
|
* @memberof BankTransactionApi
|
|
669
800
|
*/
|
|
670
801
|
public listBankTransactions(requestParameters: BankTransactionApiListBankTransactionsRequest = {}, options?: AxiosRequestConfig) {
|
|
671
|
-
return BankTransactionApiFp(this.configuration).listBankTransactions(requestParameters.authorization, requestParameters.
|
|
802
|
+
return BankTransactionApiFp(this.configuration).listBankTransactions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
672
803
|
}
|
|
673
804
|
|
|
674
805
|
/**
|
|
675
|
-
* Unlinks an already linked bank transaction
|
|
806
|
+
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
676
807
|
* @summary Unlink bank transaction
|
|
677
808
|
* @param {BankTransactionApiUnlinkBankTransactionRequest} requestParameters Request parameters.
|
|
678
809
|
* @param {*} [options] Override http request option.
|