@emilgroup/payment-sdk-node 1.21.1-beta.2 → 1.21.1-beta.20
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 +695 -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 +646 -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
|
@@ -97,11 +97,59 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
97
97
|
var _this = this;
|
|
98
98
|
return {
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
101
|
+
* @summary Invoice Match Suggestion
|
|
102
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
103
|
+
* @param {string} [authorization] Bearer Token
|
|
104
|
+
* @param {*} [options] Override http request option.
|
|
105
|
+
* @throws {RequiredError}
|
|
106
|
+
*/
|
|
107
|
+
generateInvoiceMatchSuggestion: function (code, authorization, options) {
|
|
108
|
+
if (options === void 0) { options = {}; }
|
|
109
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
110
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
111
|
+
return __generator(this, function (_a) {
|
|
112
|
+
switch (_a.label) {
|
|
113
|
+
case 0:
|
|
114
|
+
// verify required parameter 'code' is not null or undefined
|
|
115
|
+
(0, common_1.assertParamExists)('generateInvoiceMatchSuggestion', 'code', code);
|
|
116
|
+
localVarPath = "/paymentservice/v1/tenant/bank-transactions/{code}/generate-invoice-match-suggestion"
|
|
117
|
+
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
118
|
+
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
119
|
+
if (configuration) {
|
|
120
|
+
baseOptions = configuration.baseOptions;
|
|
121
|
+
baseAccessToken = configuration.accessToken;
|
|
122
|
+
}
|
|
123
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
124
|
+
localVarHeaderParameter = {};
|
|
125
|
+
localVarQueryParameter = {};
|
|
126
|
+
// authentication bearer required
|
|
127
|
+
// http bearer authentication required
|
|
128
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
129
|
+
case 1:
|
|
130
|
+
// authentication bearer required
|
|
131
|
+
// http bearer authentication required
|
|
132
|
+
_a.sent();
|
|
133
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
134
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
135
|
+
}
|
|
136
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
137
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
138
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
139
|
+
return [2 /*return*/, {
|
|
140
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
141
|
+
options: localVarRequestOptions,
|
|
142
|
+
}];
|
|
143
|
+
}
|
|
144
|
+
});
|
|
145
|
+
});
|
|
146
|
+
},
|
|
147
|
+
/**
|
|
148
|
+
* 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\"
|
|
101
149
|
* @summary Retrieve the bank transaction
|
|
102
150
|
* @param {string} code
|
|
103
151
|
* @param {string} [authorization] Bearer Token
|
|
104
|
-
* @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>
|
|
152
|
+
* @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>
|
|
105
153
|
* @param {*} [options] Override http request option.
|
|
106
154
|
* @throws {RequiredError}
|
|
107
155
|
*/
|
|
@@ -149,9 +197,9 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
149
197
|
});
|
|
150
198
|
},
|
|
151
199
|
/**
|
|
152
|
-
* This will import bank transactions from a
|
|
200
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
153
201
|
* @summary Create the bank transactions
|
|
154
|
-
* @param {any} file
|
|
202
|
+
* @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
|
|
155
203
|
* @param {string} [authorization] Bearer Token
|
|
156
204
|
* @param {*} [options] Override http request option.
|
|
157
205
|
* @throws {RequiredError}
|
|
@@ -202,7 +250,7 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
202
250
|
});
|
|
203
251
|
},
|
|
204
252
|
/**
|
|
205
|
-
* Links a bank transaction with an invoice
|
|
253
|
+
* Links a bank transaction with an invoice **Required Permissions** \"payment-management.bank-accounts.create\"
|
|
206
254
|
* @summary Link bank transaction
|
|
207
255
|
* @param {string} code Code of the bank transaction to link
|
|
208
256
|
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
@@ -255,18 +303,20 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
255
303
|
});
|
|
256
304
|
},
|
|
257
305
|
/**
|
|
258
|
-
* 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.
|
|
306
|
+
* 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\"
|
|
259
307
|
* @summary List bank transactions
|
|
260
308
|
* @param {string} [authorization] Bearer Token
|
|
261
|
-
* @param {
|
|
262
|
-
* @param {string} [
|
|
309
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
310
|
+
* @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.
|
|
311
|
+
* @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>
|
|
263
312
|
* @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>
|
|
264
|
-
* @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,
|
|
265
|
-
* @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>
|
|
313
|
+
* @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>
|
|
314
|
+
* @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>
|
|
315
|
+
* @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>
|
|
266
316
|
* @param {*} [options] Override http request option.
|
|
267
317
|
* @throws {RequiredError}
|
|
268
318
|
*/
|
|
269
|
-
listBankTransactions: function (authorization,
|
|
319
|
+
listBankTransactions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
270
320
|
if (options === void 0) { options = {}; }
|
|
271
321
|
return __awaiter(_this, void 0, void 0, function () {
|
|
272
322
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -289,12 +339,15 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
289
339
|
// authentication bearer required
|
|
290
340
|
// http bearer authentication required
|
|
291
341
|
_a.sent();
|
|
342
|
+
if (pageSize !== undefined) {
|
|
343
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
344
|
+
}
|
|
345
|
+
if (pageToken !== undefined) {
|
|
346
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
347
|
+
}
|
|
292
348
|
if (filter !== undefined) {
|
|
293
349
|
localVarQueryParameter['filter'] = filter;
|
|
294
350
|
}
|
|
295
|
-
if (filters !== undefined) {
|
|
296
|
-
localVarQueryParameter['filters'] = filters;
|
|
297
|
-
}
|
|
298
351
|
if (search !== undefined) {
|
|
299
352
|
localVarQueryParameter['search'] = search;
|
|
300
353
|
}
|
|
@@ -304,6 +357,9 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
304
357
|
if (expand !== undefined) {
|
|
305
358
|
localVarQueryParameter['expand'] = expand;
|
|
306
359
|
}
|
|
360
|
+
if (filters !== undefined) {
|
|
361
|
+
localVarQueryParameter['filters'] = filters;
|
|
362
|
+
}
|
|
307
363
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
308
364
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
309
365
|
}
|
|
@@ -319,7 +375,7 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
319
375
|
});
|
|
320
376
|
},
|
|
321
377
|
/**
|
|
322
|
-
* Unlinks an already linked bank transaction
|
|
378
|
+
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
323
379
|
* @summary Unlink bank transaction
|
|
324
380
|
* @param {string} code Code of the bank transaction to unlink
|
|
325
381
|
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
@@ -382,11 +438,32 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
382
438
|
var localVarAxiosParamCreator = (0, exports.BankTransactionApiAxiosParamCreator)(configuration);
|
|
383
439
|
return {
|
|
384
440
|
/**
|
|
385
|
-
*
|
|
441
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
442
|
+
* @summary Invoice Match Suggestion
|
|
443
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
444
|
+
* @param {string} [authorization] Bearer Token
|
|
445
|
+
* @param {*} [options] Override http request option.
|
|
446
|
+
* @throws {RequiredError}
|
|
447
|
+
*/
|
|
448
|
+
generateInvoiceMatchSuggestion: function (code, authorization, options) {
|
|
449
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
450
|
+
var localVarAxiosArgs;
|
|
451
|
+
return __generator(this, function (_a) {
|
|
452
|
+
switch (_a.label) {
|
|
453
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.generateInvoiceMatchSuggestion(code, authorization, options)];
|
|
454
|
+
case 1:
|
|
455
|
+
localVarAxiosArgs = _a.sent();
|
|
456
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
457
|
+
}
|
|
458
|
+
});
|
|
459
|
+
});
|
|
460
|
+
},
|
|
461
|
+
/**
|
|
462
|
+
* 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\"
|
|
386
463
|
* @summary Retrieve the bank transaction
|
|
387
464
|
* @param {string} code
|
|
388
465
|
* @param {string} [authorization] Bearer Token
|
|
389
|
-
* @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>
|
|
466
|
+
* @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>
|
|
390
467
|
* @param {*} [options] Override http request option.
|
|
391
468
|
* @throws {RequiredError}
|
|
392
469
|
*/
|
|
@@ -404,9 +481,9 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
404
481
|
});
|
|
405
482
|
},
|
|
406
483
|
/**
|
|
407
|
-
* This will import bank transactions from a
|
|
484
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
408
485
|
* @summary Create the bank transactions
|
|
409
|
-
* @param {any} file
|
|
486
|
+
* @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
|
|
410
487
|
* @param {string} [authorization] Bearer Token
|
|
411
488
|
* @param {*} [options] Override http request option.
|
|
412
489
|
* @throws {RequiredError}
|
|
@@ -425,7 +502,7 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
425
502
|
});
|
|
426
503
|
},
|
|
427
504
|
/**
|
|
428
|
-
* Links a bank transaction with an invoice
|
|
505
|
+
* Links a bank transaction with an invoice **Required Permissions** \"payment-management.bank-accounts.create\"
|
|
429
506
|
* @summary Link bank transaction
|
|
430
507
|
* @param {string} code Code of the bank transaction to link
|
|
431
508
|
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
@@ -447,23 +524,25 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
447
524
|
});
|
|
448
525
|
},
|
|
449
526
|
/**
|
|
450
|
-
* 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.
|
|
527
|
+
* 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\"
|
|
451
528
|
* @summary List bank transactions
|
|
452
529
|
* @param {string} [authorization] Bearer Token
|
|
453
|
-
* @param {
|
|
454
|
-
* @param {string} [
|
|
530
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
531
|
+
* @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.
|
|
532
|
+
* @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>
|
|
455
533
|
* @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>
|
|
456
|
-
* @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,
|
|
457
|
-
* @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>
|
|
534
|
+
* @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>
|
|
535
|
+
* @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>
|
|
536
|
+
* @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>
|
|
458
537
|
* @param {*} [options] Override http request option.
|
|
459
538
|
* @throws {RequiredError}
|
|
460
539
|
*/
|
|
461
|
-
listBankTransactions: function (authorization,
|
|
540
|
+
listBankTransactions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
462
541
|
return __awaiter(this, void 0, void 0, function () {
|
|
463
542
|
var localVarAxiosArgs;
|
|
464
543
|
return __generator(this, function (_a) {
|
|
465
544
|
switch (_a.label) {
|
|
466
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listBankTransactions(authorization,
|
|
545
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listBankTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
467
546
|
case 1:
|
|
468
547
|
localVarAxiosArgs = _a.sent();
|
|
469
548
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -472,7 +551,7 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
472
551
|
});
|
|
473
552
|
},
|
|
474
553
|
/**
|
|
475
|
-
* Unlinks an already linked bank transaction
|
|
554
|
+
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
476
555
|
* @summary Unlink bank transaction
|
|
477
556
|
* @param {string} code Code of the bank transaction to unlink
|
|
478
557
|
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
@@ -504,11 +583,22 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
504
583
|
var localVarFp = (0, exports.BankTransactionApiFp)(configuration);
|
|
505
584
|
return {
|
|
506
585
|
/**
|
|
507
|
-
*
|
|
586
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
587
|
+
* @summary Invoice Match Suggestion
|
|
588
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
589
|
+
* @param {string} [authorization] Bearer Token
|
|
590
|
+
* @param {*} [options] Override http request option.
|
|
591
|
+
* @throws {RequiredError}
|
|
592
|
+
*/
|
|
593
|
+
generateInvoiceMatchSuggestion: function (code, authorization, options) {
|
|
594
|
+
return localVarFp.generateInvoiceMatchSuggestion(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
595
|
+
},
|
|
596
|
+
/**
|
|
597
|
+
* 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\"
|
|
508
598
|
* @summary Retrieve the bank transaction
|
|
509
599
|
* @param {string} code
|
|
510
600
|
* @param {string} [authorization] Bearer Token
|
|
511
|
-
* @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>
|
|
601
|
+
* @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>
|
|
512
602
|
* @param {*} [options] Override http request option.
|
|
513
603
|
* @throws {RequiredError}
|
|
514
604
|
*/
|
|
@@ -516,9 +606,9 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
516
606
|
return localVarFp.getBankTransaction(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
517
607
|
},
|
|
518
608
|
/**
|
|
519
|
-
* This will import bank transactions from a
|
|
609
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
520
610
|
* @summary Create the bank transactions
|
|
521
|
-
* @param {any} file
|
|
611
|
+
* @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
|
|
522
612
|
* @param {string} [authorization] Bearer Token
|
|
523
613
|
* @param {*} [options] Override http request option.
|
|
524
614
|
* @throws {RequiredError}
|
|
@@ -527,7 +617,7 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
527
617
|
return localVarFp.importBankTransactions(file, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
528
618
|
},
|
|
529
619
|
/**
|
|
530
|
-
* Links a bank transaction with an invoice
|
|
620
|
+
* Links a bank transaction with an invoice **Required Permissions** \"payment-management.bank-accounts.create\"
|
|
531
621
|
* @summary Link bank transaction
|
|
532
622
|
* @param {string} code Code of the bank transaction to link
|
|
533
623
|
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
@@ -539,22 +629,24 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
539
629
|
return localVarFp.linkBankTransaction(code, linkBankTransactionRequestDtoRest, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
540
630
|
},
|
|
541
631
|
/**
|
|
542
|
-
* 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.
|
|
632
|
+
* 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\"
|
|
543
633
|
* @summary List bank transactions
|
|
544
634
|
* @param {string} [authorization] Bearer Token
|
|
545
|
-
* @param {
|
|
546
|
-
* @param {string} [
|
|
635
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
636
|
+
* @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.
|
|
637
|
+
* @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>
|
|
547
638
|
* @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>
|
|
548
|
-
* @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,
|
|
549
|
-
* @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>
|
|
639
|
+
* @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>
|
|
640
|
+
* @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>
|
|
641
|
+
* @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>
|
|
550
642
|
* @param {*} [options] Override http request option.
|
|
551
643
|
* @throws {RequiredError}
|
|
552
644
|
*/
|
|
553
|
-
listBankTransactions: function (authorization,
|
|
554
|
-
return localVarFp.listBankTransactions(authorization,
|
|
645
|
+
listBankTransactions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
646
|
+
return localVarFp.listBankTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
555
647
|
},
|
|
556
648
|
/**
|
|
557
|
-
* Unlinks an already linked bank transaction
|
|
649
|
+
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
558
650
|
* @summary Unlink bank transaction
|
|
559
651
|
* @param {string} code Code of the bank transaction to unlink
|
|
560
652
|
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
@@ -580,7 +672,19 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
580
672
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
581
673
|
}
|
|
582
674
|
/**
|
|
583
|
-
*
|
|
675
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
676
|
+
* @summary Invoice Match Suggestion
|
|
677
|
+
* @param {BankTransactionApiGenerateInvoiceMatchSuggestionRequest} requestParameters Request parameters.
|
|
678
|
+
* @param {*} [options] Override http request option.
|
|
679
|
+
* @throws {RequiredError}
|
|
680
|
+
* @memberof BankTransactionApi
|
|
681
|
+
*/
|
|
682
|
+
BankTransactionApi.prototype.generateInvoiceMatchSuggestion = function (requestParameters, options) {
|
|
683
|
+
var _this = this;
|
|
684
|
+
return (0, exports.BankTransactionApiFp)(this.configuration).generateInvoiceMatchSuggestion(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
685
|
+
};
|
|
686
|
+
/**
|
|
687
|
+
* 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\"
|
|
584
688
|
* @summary Retrieve the bank transaction
|
|
585
689
|
* @param {BankTransactionApiGetBankTransactionRequest} requestParameters Request parameters.
|
|
586
690
|
* @param {*} [options] Override http request option.
|
|
@@ -592,7 +696,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
592
696
|
return (0, exports.BankTransactionApiFp)(this.configuration).getBankTransaction(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
593
697
|
};
|
|
594
698
|
/**
|
|
595
|
-
* This will import bank transactions from a
|
|
699
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
596
700
|
* @summary Create the bank transactions
|
|
597
701
|
* @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
|
|
598
702
|
* @param {*} [options] Override http request option.
|
|
@@ -604,7 +708,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
604
708
|
return (0, exports.BankTransactionApiFp)(this.configuration).importBankTransactions(requestParameters.file, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
605
709
|
};
|
|
606
710
|
/**
|
|
607
|
-
* Links a bank transaction with an invoice
|
|
711
|
+
* Links a bank transaction with an invoice **Required Permissions** \"payment-management.bank-accounts.create\"
|
|
608
712
|
* @summary Link bank transaction
|
|
609
713
|
* @param {BankTransactionApiLinkBankTransactionRequest} requestParameters Request parameters.
|
|
610
714
|
* @param {*} [options] Override http request option.
|
|
@@ -616,7 +720,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
616
720
|
return (0, exports.BankTransactionApiFp)(this.configuration).linkBankTransaction(requestParameters.code, requestParameters.linkBankTransactionRequestDtoRest, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
617
721
|
};
|
|
618
722
|
/**
|
|
619
|
-
* 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.
|
|
723
|
+
* 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\"
|
|
620
724
|
* @summary List bank transactions
|
|
621
725
|
* @param {BankTransactionApiListBankTransactionsRequest} requestParameters Request parameters.
|
|
622
726
|
* @param {*} [options] Override http request option.
|
|
@@ -626,10 +730,10 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
626
730
|
BankTransactionApi.prototype.listBankTransactions = function (requestParameters, options) {
|
|
627
731
|
var _this = this;
|
|
628
732
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
629
|
-
return (0, exports.BankTransactionApiFp)(this.configuration).listBankTransactions(requestParameters.authorization, requestParameters.
|
|
733
|
+
return (0, exports.BankTransactionApiFp)(this.configuration).listBankTransactions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
630
734
|
};
|
|
631
735
|
/**
|
|
632
|
-
* Unlinks an already linked bank transaction
|
|
736
|
+
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
633
737
|
* @summary Unlink bank transaction
|
|
634
738
|
* @param {BankTransactionApiUnlinkBankTransactionRequest} requestParameters Request parameters.
|
|
635
739
|
* @param {*} [options] Override http request option.
|