@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
|
@@ -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';
|
|
@@ -45,11 +47,56 @@ const FormData = require('form-data');
|
|
|
45
47
|
export const BankTransactionApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
46
48
|
return {
|
|
47
49
|
/**
|
|
48
|
-
*
|
|
50
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
51
|
+
* @summary Invoice Match Suggestion
|
|
52
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
53
|
+
* @param {string} [authorization] Bearer Token
|
|
54
|
+
* @param {*} [options] Override http request option.
|
|
55
|
+
* @throws {RequiredError}
|
|
56
|
+
*/
|
|
57
|
+
generateInvoiceMatchSuggestion: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
58
|
+
// verify required parameter 'code' is not null or undefined
|
|
59
|
+
assertParamExists('generateInvoiceMatchSuggestion', 'code', code)
|
|
60
|
+
const localVarPath = `/paymentservice/v1/tenant/bank-transactions/{code}/generate-invoice-match-suggestion`
|
|
61
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
62
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
63
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
64
|
+
let baseOptions;
|
|
65
|
+
let baseAccessToken;
|
|
66
|
+
if (configuration) {
|
|
67
|
+
baseOptions = configuration.baseOptions;
|
|
68
|
+
baseAccessToken = configuration.accessToken;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
72
|
+
const localVarHeaderParameter = {} as any;
|
|
73
|
+
const localVarQueryParameter = {} as any;
|
|
74
|
+
|
|
75
|
+
// authentication bearer required
|
|
76
|
+
// http bearer authentication required
|
|
77
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
78
|
+
|
|
79
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
80
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
86
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
87
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
88
|
+
|
|
89
|
+
return {
|
|
90
|
+
url: toPathString(localVarUrlObj),
|
|
91
|
+
options: localVarRequestOptions,
|
|
92
|
+
};
|
|
93
|
+
},
|
|
94
|
+
/**
|
|
95
|
+
* 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\"
|
|
49
96
|
* @summary Retrieve the bank transaction
|
|
50
97
|
* @param {string} code
|
|
51
98
|
* @param {string} [authorization] Bearer Token
|
|
52
|
-
* @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>
|
|
99
|
+
* @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>
|
|
53
100
|
* @param {*} [options] Override http request option.
|
|
54
101
|
* @throws {RequiredError}
|
|
55
102
|
*/
|
|
@@ -95,9 +142,9 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
95
142
|
};
|
|
96
143
|
},
|
|
97
144
|
/**
|
|
98
|
-
* This will import bank transactions from a
|
|
145
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
99
146
|
* @summary Create the bank transactions
|
|
100
|
-
* @param {any} file
|
|
147
|
+
* @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
|
|
101
148
|
* @param {string} [authorization] Bearer Token
|
|
102
149
|
* @param {*} [options] Override http request option.
|
|
103
150
|
* @throws {RequiredError}
|
|
@@ -148,7 +195,7 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
148
195
|
};
|
|
149
196
|
},
|
|
150
197
|
/**
|
|
151
|
-
* Links a bank transaction with an invoice
|
|
198
|
+
* Links a bank transaction with an invoice **Required Permissions** \"payment-management.bank-accounts.create\"
|
|
152
199
|
* @summary Link bank transaction
|
|
153
200
|
* @param {string} code Code of the bank transaction to link
|
|
154
201
|
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
@@ -199,18 +246,20 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
199
246
|
};
|
|
200
247
|
},
|
|
201
248
|
/**
|
|
202
|
-
* 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.
|
|
249
|
+
* 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\"
|
|
203
250
|
* @summary List bank transactions
|
|
204
251
|
* @param {string} [authorization] Bearer Token
|
|
205
|
-
* @param {
|
|
206
|
-
* @param {string} [
|
|
252
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
253
|
+
* @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.
|
|
254
|
+
* @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>
|
|
207
255
|
* @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>
|
|
208
|
-
* @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,
|
|
209
|
-
* @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>
|
|
256
|
+
* @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>
|
|
257
|
+
* @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>
|
|
258
|
+
* @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>
|
|
210
259
|
* @param {*} [options] Override http request option.
|
|
211
260
|
* @throws {RequiredError}
|
|
212
261
|
*/
|
|
213
|
-
listBankTransactions: async (authorization?: string,
|
|
262
|
+
listBankTransactions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
214
263
|
const localVarPath = `/paymentservice/v1/tenant/bank-transactions`;
|
|
215
264
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
216
265
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -229,12 +278,16 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
229
278
|
// http bearer authentication required
|
|
230
279
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
231
280
|
|
|
232
|
-
if (
|
|
233
|
-
localVarQueryParameter['
|
|
281
|
+
if (pageSize !== undefined) {
|
|
282
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
234
283
|
}
|
|
235
284
|
|
|
236
|
-
if (
|
|
237
|
-
localVarQueryParameter['
|
|
285
|
+
if (pageToken !== undefined) {
|
|
286
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
287
|
+
}
|
|
288
|
+
|
|
289
|
+
if (filter !== undefined) {
|
|
290
|
+
localVarQueryParameter['filter'] = filter;
|
|
238
291
|
}
|
|
239
292
|
|
|
240
293
|
if (search !== undefined) {
|
|
@@ -249,6 +302,10 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
249
302
|
localVarQueryParameter['expand'] = expand;
|
|
250
303
|
}
|
|
251
304
|
|
|
305
|
+
if (filters !== undefined) {
|
|
306
|
+
localVarQueryParameter['filters'] = filters;
|
|
307
|
+
}
|
|
308
|
+
|
|
252
309
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
253
310
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
254
311
|
}
|
|
@@ -265,7 +322,7 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
265
322
|
};
|
|
266
323
|
},
|
|
267
324
|
/**
|
|
268
|
-
* Unlinks an already linked bank transaction
|
|
325
|
+
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
269
326
|
* @summary Unlink bank transaction
|
|
270
327
|
* @param {string} code Code of the bank transaction to unlink
|
|
271
328
|
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
@@ -326,11 +383,23 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
326
383
|
const localVarAxiosParamCreator = BankTransactionApiAxiosParamCreator(configuration)
|
|
327
384
|
return {
|
|
328
385
|
/**
|
|
329
|
-
*
|
|
386
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
387
|
+
* @summary Invoice Match Suggestion
|
|
388
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
389
|
+
* @param {string} [authorization] Bearer Token
|
|
390
|
+
* @param {*} [options] Override http request option.
|
|
391
|
+
* @throws {RequiredError}
|
|
392
|
+
*/
|
|
393
|
+
async generateInvoiceMatchSuggestion(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateInvoiceMatchSuggestionsResponseClass>> {
|
|
394
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.generateInvoiceMatchSuggestion(code, authorization, options);
|
|
395
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
396
|
+
},
|
|
397
|
+
/**
|
|
398
|
+
* 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\"
|
|
330
399
|
* @summary Retrieve the bank transaction
|
|
331
400
|
* @param {string} code
|
|
332
401
|
* @param {string} [authorization] Bearer Token
|
|
333
|
-
* @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>
|
|
402
|
+
* @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>
|
|
334
403
|
* @param {*} [options] Override http request option.
|
|
335
404
|
* @throws {RequiredError}
|
|
336
405
|
*/
|
|
@@ -339,9 +408,9 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
339
408
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
340
409
|
},
|
|
341
410
|
/**
|
|
342
|
-
* This will import bank transactions from a
|
|
411
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
343
412
|
* @summary Create the bank transactions
|
|
344
|
-
* @param {any} file
|
|
413
|
+
* @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
|
|
345
414
|
* @param {string} [authorization] Bearer Token
|
|
346
415
|
* @param {*} [options] Override http request option.
|
|
347
416
|
* @throws {RequiredError}
|
|
@@ -351,7 +420,7 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
351
420
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
352
421
|
},
|
|
353
422
|
/**
|
|
354
|
-
* Links a bank transaction with an invoice
|
|
423
|
+
* Links a bank transaction with an invoice **Required Permissions** \"payment-management.bank-accounts.create\"
|
|
355
424
|
* @summary Link bank transaction
|
|
356
425
|
* @param {string} code Code of the bank transaction to link
|
|
357
426
|
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
@@ -364,23 +433,25 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
364
433
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
365
434
|
},
|
|
366
435
|
/**
|
|
367
|
-
* 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.
|
|
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. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
368
437
|
* @summary List bank transactions
|
|
369
438
|
* @param {string} [authorization] Bearer Token
|
|
370
|
-
* @param {
|
|
371
|
-
* @param {string} [
|
|
439
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
440
|
+
* @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.
|
|
441
|
+
* @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>
|
|
372
442
|
* @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>
|
|
373
|
-
* @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,
|
|
374
|
-
* @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>
|
|
443
|
+
* @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>
|
|
444
|
+
* @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>
|
|
445
|
+
* @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>
|
|
375
446
|
* @param {*} [options] Override http request option.
|
|
376
447
|
* @throws {RequiredError}
|
|
377
448
|
*/
|
|
378
|
-
async listBankTransactions(authorization?: string,
|
|
379
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listBankTransactions(authorization,
|
|
449
|
+
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>> {
|
|
450
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listBankTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
380
451
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
381
452
|
},
|
|
382
453
|
/**
|
|
383
|
-
* Unlinks an already linked bank transaction
|
|
454
|
+
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
384
455
|
* @summary Unlink bank transaction
|
|
385
456
|
* @param {string} code Code of the bank transaction to unlink
|
|
386
457
|
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
@@ -403,11 +474,22 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
403
474
|
const localVarFp = BankTransactionApiFp(configuration)
|
|
404
475
|
return {
|
|
405
476
|
/**
|
|
406
|
-
*
|
|
477
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
478
|
+
* @summary Invoice Match Suggestion
|
|
479
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
480
|
+
* @param {string} [authorization] Bearer Token
|
|
481
|
+
* @param {*} [options] Override http request option.
|
|
482
|
+
* @throws {RequiredError}
|
|
483
|
+
*/
|
|
484
|
+
generateInvoiceMatchSuggestion(code: string, authorization?: string, options?: any): AxiosPromise<GenerateInvoiceMatchSuggestionsResponseClass> {
|
|
485
|
+
return localVarFp.generateInvoiceMatchSuggestion(code, authorization, options).then((request) => request(axios, basePath));
|
|
486
|
+
},
|
|
487
|
+
/**
|
|
488
|
+
* 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\"
|
|
407
489
|
* @summary Retrieve the bank transaction
|
|
408
490
|
* @param {string} code
|
|
409
491
|
* @param {string} [authorization] Bearer Token
|
|
410
|
-
* @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>
|
|
492
|
+
* @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>
|
|
411
493
|
* @param {*} [options] Override http request option.
|
|
412
494
|
* @throws {RequiredError}
|
|
413
495
|
*/
|
|
@@ -415,9 +497,9 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
415
497
|
return localVarFp.getBankTransaction(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
416
498
|
},
|
|
417
499
|
/**
|
|
418
|
-
* This will import bank transactions from a
|
|
500
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
419
501
|
* @summary Create the bank transactions
|
|
420
|
-
* @param {any} file
|
|
502
|
+
* @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
|
|
421
503
|
* @param {string} [authorization] Bearer Token
|
|
422
504
|
* @param {*} [options] Override http request option.
|
|
423
505
|
* @throws {RequiredError}
|
|
@@ -426,7 +508,7 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
426
508
|
return localVarFp.importBankTransactions(file, authorization, options).then((request) => request(axios, basePath));
|
|
427
509
|
},
|
|
428
510
|
/**
|
|
429
|
-
* Links a bank transaction with an invoice
|
|
511
|
+
* Links a bank transaction with an invoice **Required Permissions** \"payment-management.bank-accounts.create\"
|
|
430
512
|
* @summary Link bank transaction
|
|
431
513
|
* @param {string} code Code of the bank transaction to link
|
|
432
514
|
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
@@ -438,22 +520,24 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
438
520
|
return localVarFp.linkBankTransaction(code, linkBankTransactionRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
|
|
439
521
|
},
|
|
440
522
|
/**
|
|
441
|
-
* 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.
|
|
523
|
+
* 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\"
|
|
442
524
|
* @summary List bank transactions
|
|
443
525
|
* @param {string} [authorization] Bearer Token
|
|
444
|
-
* @param {
|
|
445
|
-
* @param {string} [
|
|
526
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
527
|
+
* @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.
|
|
528
|
+
* @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>
|
|
446
529
|
* @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>
|
|
447
|
-
* @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,
|
|
448
|
-
* @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>
|
|
530
|
+
* @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>
|
|
531
|
+
* @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>
|
|
532
|
+
* @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>
|
|
449
533
|
* @param {*} [options] Override http request option.
|
|
450
534
|
* @throws {RequiredError}
|
|
451
535
|
*/
|
|
452
|
-
listBankTransactions(authorization?: string,
|
|
453
|
-
return localVarFp.listBankTransactions(authorization,
|
|
536
|
+
listBankTransactions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListBankTransactionsResponseClass> {
|
|
537
|
+
return localVarFp.listBankTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
454
538
|
},
|
|
455
539
|
/**
|
|
456
|
-
* Unlinks an already linked bank transaction
|
|
540
|
+
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
457
541
|
* @summary Unlink bank transaction
|
|
458
542
|
* @param {string} code Code of the bank transaction to unlink
|
|
459
543
|
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
@@ -467,6 +551,27 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
467
551
|
};
|
|
468
552
|
};
|
|
469
553
|
|
|
554
|
+
/**
|
|
555
|
+
* Request parameters for generateInvoiceMatchSuggestion operation in BankTransactionApi.
|
|
556
|
+
* @export
|
|
557
|
+
* @interface BankTransactionApiGenerateInvoiceMatchSuggestionRequest
|
|
558
|
+
*/
|
|
559
|
+
export interface BankTransactionApiGenerateInvoiceMatchSuggestionRequest {
|
|
560
|
+
/**
|
|
561
|
+
* Code of the bank transaction to generate match suggestions for
|
|
562
|
+
* @type {string}
|
|
563
|
+
* @memberof BankTransactionApiGenerateInvoiceMatchSuggestion
|
|
564
|
+
*/
|
|
565
|
+
readonly code: string
|
|
566
|
+
|
|
567
|
+
/**
|
|
568
|
+
* Bearer Token
|
|
569
|
+
* @type {string}
|
|
570
|
+
* @memberof BankTransactionApiGenerateInvoiceMatchSuggestion
|
|
571
|
+
*/
|
|
572
|
+
readonly authorization?: string
|
|
573
|
+
}
|
|
574
|
+
|
|
470
575
|
/**
|
|
471
576
|
* Request parameters for getBankTransaction operation in BankTransactionApi.
|
|
472
577
|
* @export
|
|
@@ -488,7 +593,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
488
593
|
readonly authorization?: string
|
|
489
594
|
|
|
490
595
|
/**
|
|
491
|
-
* 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>
|
|
596
|
+
* 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>
|
|
492
597
|
* @type {string}
|
|
493
598
|
* @memberof BankTransactionApiGetBankTransaction
|
|
494
599
|
*/
|
|
@@ -502,7 +607,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
502
607
|
*/
|
|
503
608
|
export interface BankTransactionApiImportBankTransactionsRequest {
|
|
504
609
|
/**
|
|
505
|
-
*
|
|
610
|
+
* 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
|
|
506
611
|
* @type {any}
|
|
507
612
|
* @memberof BankTransactionApiImportBankTransactions
|
|
508
613
|
*/
|
|
@@ -558,18 +663,25 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
558
663
|
readonly authorization?: string
|
|
559
664
|
|
|
560
665
|
/**
|
|
561
|
-
*
|
|
666
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
667
|
+
* @type {number}
|
|
668
|
+
* @memberof BankTransactionApiListBankTransactions
|
|
669
|
+
*/
|
|
670
|
+
readonly pageSize?: number
|
|
671
|
+
|
|
672
|
+
/**
|
|
673
|
+
* 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.
|
|
562
674
|
* @type {string}
|
|
563
675
|
* @memberof BankTransactionApiListBankTransactions
|
|
564
676
|
*/
|
|
565
|
-
readonly
|
|
677
|
+
readonly pageToken?: string
|
|
566
678
|
|
|
567
679
|
/**
|
|
568
|
-
*
|
|
680
|
+
* 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>
|
|
569
681
|
* @type {string}
|
|
570
682
|
* @memberof BankTransactionApiListBankTransactions
|
|
571
683
|
*/
|
|
572
|
-
readonly
|
|
684
|
+
readonly filter?: string
|
|
573
685
|
|
|
574
686
|
/**
|
|
575
687
|
* 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>
|
|
@@ -579,18 +691,25 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
579
691
|
readonly search?: string
|
|
580
692
|
|
|
581
693
|
/**
|
|
582
|
-
* 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,
|
|
694
|
+
* 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>
|
|
583
695
|
* @type {string}
|
|
584
696
|
* @memberof BankTransactionApiListBankTransactions
|
|
585
697
|
*/
|
|
586
698
|
readonly order?: string
|
|
587
699
|
|
|
588
700
|
/**
|
|
589
|
-
* 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>
|
|
701
|
+
* 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>
|
|
590
702
|
* @type {string}
|
|
591
703
|
* @memberof BankTransactionApiListBankTransactions
|
|
592
704
|
*/
|
|
593
705
|
readonly expand?: string
|
|
706
|
+
|
|
707
|
+
/**
|
|
708
|
+
* 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>
|
|
709
|
+
* @type {string}
|
|
710
|
+
* @memberof BankTransactionApiListBankTransactions
|
|
711
|
+
*/
|
|
712
|
+
readonly filters?: string
|
|
594
713
|
}
|
|
595
714
|
|
|
596
715
|
/**
|
|
@@ -629,7 +748,19 @@ export interface BankTransactionApiUnlinkBankTransactionRequest {
|
|
|
629
748
|
*/
|
|
630
749
|
export class BankTransactionApi extends BaseAPI {
|
|
631
750
|
/**
|
|
632
|
-
*
|
|
751
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
752
|
+
* @summary Invoice Match Suggestion
|
|
753
|
+
* @param {BankTransactionApiGenerateInvoiceMatchSuggestionRequest} requestParameters Request parameters.
|
|
754
|
+
* @param {*} [options] Override http request option.
|
|
755
|
+
* @throws {RequiredError}
|
|
756
|
+
* @memberof BankTransactionApi
|
|
757
|
+
*/
|
|
758
|
+
public generateInvoiceMatchSuggestion(requestParameters: BankTransactionApiGenerateInvoiceMatchSuggestionRequest, options?: AxiosRequestConfig) {
|
|
759
|
+
return BankTransactionApiFp(this.configuration).generateInvoiceMatchSuggestion(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
760
|
+
}
|
|
761
|
+
|
|
762
|
+
/**
|
|
763
|
+
* 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\"
|
|
633
764
|
* @summary Retrieve the bank transaction
|
|
634
765
|
* @param {BankTransactionApiGetBankTransactionRequest} requestParameters Request parameters.
|
|
635
766
|
* @param {*} [options] Override http request option.
|
|
@@ -641,7 +772,7 @@ export class BankTransactionApi extends BaseAPI {
|
|
|
641
772
|
}
|
|
642
773
|
|
|
643
774
|
/**
|
|
644
|
-
* This will import bank transactions from a
|
|
775
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
645
776
|
* @summary Create the bank transactions
|
|
646
777
|
* @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
|
|
647
778
|
* @param {*} [options] Override http request option.
|
|
@@ -653,7 +784,7 @@ export class BankTransactionApi extends BaseAPI {
|
|
|
653
784
|
}
|
|
654
785
|
|
|
655
786
|
/**
|
|
656
|
-
* Links a bank transaction with an invoice
|
|
787
|
+
* Links a bank transaction with an invoice **Required Permissions** \"payment-management.bank-accounts.create\"
|
|
657
788
|
* @summary Link bank transaction
|
|
658
789
|
* @param {BankTransactionApiLinkBankTransactionRequest} requestParameters Request parameters.
|
|
659
790
|
* @param {*} [options] Override http request option.
|
|
@@ -665,7 +796,7 @@ export class BankTransactionApi extends BaseAPI {
|
|
|
665
796
|
}
|
|
666
797
|
|
|
667
798
|
/**
|
|
668
|
-
* 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.
|
|
799
|
+
* 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\"
|
|
669
800
|
* @summary List bank transactions
|
|
670
801
|
* @param {BankTransactionApiListBankTransactionsRequest} requestParameters Request parameters.
|
|
671
802
|
* @param {*} [options] Override http request option.
|
|
@@ -673,11 +804,11 @@ export class BankTransactionApi extends BaseAPI {
|
|
|
673
804
|
* @memberof BankTransactionApi
|
|
674
805
|
*/
|
|
675
806
|
public listBankTransactions(requestParameters: BankTransactionApiListBankTransactionsRequest = {}, options?: AxiosRequestConfig) {
|
|
676
|
-
return BankTransactionApiFp(this.configuration).listBankTransactions(requestParameters.authorization, requestParameters.
|
|
807
|
+
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));
|
|
677
808
|
}
|
|
678
809
|
|
|
679
810
|
/**
|
|
680
|
-
* Unlinks an already linked bank transaction
|
|
811
|
+
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
681
812
|
* @summary Unlink bank transaction
|
|
682
813
|
* @param {BankTransactionApiUnlinkBankTransactionRequest} requestParameters Request parameters.
|
|
683
814
|
* @param {*} [options] Override http request option.
|