@emilgroup/payment-sdk 1.13.1-beta.8 → 1.13.1-beta.81
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 +20 -1
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +55 -13
- package/api/bank-orders-api.ts +691 -0
- package/api/bank-transaction-api.ts +177 -63
- package/api/payment-methods-api.ts +59 -17
- package/api/payment-reminders-api.ts +55 -13
- package/api/payments-api.ts +188 -21
- package/api/refunds-api.ts +45 -17
- package/api/tenant-bank-account-api.ts +45 -17
- package/api.ts +2 -0
- package/base.ts +52 -3
- package/dist/api/bank-accounts-api.d.ts +35 -8
- package/dist/api/bank-accounts-api.js +29 -11
- 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 +110 -46
- package/dist/api/bank-transaction-api.js +141 -44
- package/dist/api/payment-methods-api.d.ts +39 -12
- package/dist/api/payment-methods-api.js +32 -14
- package/dist/api/payment-reminders-api.d.ts +35 -8
- package/dist/api/payment-reminders-api.js +29 -11
- package/dist/api/payments-api.d.ts +112 -16
- package/dist/api/payments-api.js +141 -18
- package/dist/api/refunds-api.d.ts +28 -10
- package/dist/api/refunds-api.js +24 -12
- package/dist/api/tenant-bank-account-api.d.ts +28 -10
- package/dist/api/tenant-bank-account-api.js +24 -12
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/base.d.ts +10 -1
- package/dist/base.js +46 -2
- package/dist/models/bank-order-class.d.ts +115 -0
- package/dist/models/bank-transaction-class-without-expand-properties.d.ts +30 -11
- package/dist/models/bank-transaction-class-without-expand-properties.js +5 -0
- package/dist/models/bank-transaction-class.d.ts +47 -14
- package/dist/models/bank-transaction-class.js +5 -0
- package/dist/models/bank-transaction-invoice-class.d.ts +54 -0
- package/dist/models/bank-transaction-invoice-class.js +15 -0
- package/dist/models/bank-transfer-dto.d.ts +25 -0
- package/dist/models/bank-transfer-dto.js +15 -0
- package/dist/models/billing-address-dto.d.ts +48 -0
- package/dist/models/billing-address-dto.js +15 -0
- package/dist/models/complete-adyen-payment-setup-request-dto.d.ts +2 -0
- package/dist/models/complete-adyen-payment-setup-request-dto.js +3 -1
- package/dist/models/complete-eis-payment-setup-request-dto.d.ts +36 -0
- package/dist/models/complete-eis-payment-setup-request-dto.js +15 -0
- package/dist/models/complete-payment-setup-request-dto.d.ts +7 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +2 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.js +3 -1
- 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-order-dto.d.ts +48 -0
- package/dist/models/create-payment-order-dto.js +15 -0
- package/dist/models/create-payment-order-request-dto.d.ts +48 -0
- package/dist/models/create-payment-order-request-dto.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 +22 -1
- package/dist/models/create-psp-payment-method-request-dto.js +3 -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 +19 -1
- package/dist/models/index.js +19 -1
- 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-eis-payment-setup-request-dto.d.ts +36 -0
- package/dist/models/initiate-eis-payment-setup-request-dto.js +15 -0
- package/dist/models/initiate-payment-setup-request-dto.d.ts +3 -2
- package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/{unlink-bank-transaction-request-dto-rest.d.ts → invoice-allocation-dto.d.ts} +10 -4
- package/dist/models/invoice-allocation-dto.js +15 -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/link-bank-transaction-request-dto-rest.d.ts +4 -3
- 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-method-class.d.ts +6 -0
- 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 +33 -2
- package/dist/models/unlinked-bank-transaction-response-class.js +5 -0
- package/dist/models/update-bank-order-request-dto.d.ts +62 -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 +33 -11
- package/models/bank-transaction-class.ts +50 -14
- package/models/bank-transaction-invoice-class.ts +60 -0
- package/models/bank-transfer-dto.ts +31 -0
- package/models/billing-address-dto.ts +54 -0
- package/models/complete-adyen-payment-setup-request-dto.ts +3 -1
- package/models/complete-eis-payment-setup-request-dto.ts +42 -0
- package/models/complete-payment-setup-request-dto.ts +7 -0
- package/models/complete-stripe-payment-setup-request-dto.ts +3 -1
- package/models/create-bank-order-request-dto.ts +84 -0
- package/models/create-bank-order-response-class.ts +31 -0
- package/models/create-payment-order-dto.ts +54 -0
- package/models/create-payment-order-request-dto.ts +54 -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 +23 -2
- 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 +19 -1
- 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-eis-payment-setup-request-dto.ts +42 -0
- package/models/initiate-payment-setup-request-dto.ts +3 -2
- package/models/initiate-stripe-payment-setup-request-dto.ts +6 -0
- package/models/{unlink-bank-transaction-request-dto-rest.ts → invoice-allocation-dto.ts} +10 -4
- package/models/invoice-match-suggestion-class.ts +66 -0
- package/models/link-bank-transaction-request-dto-rest.ts +4 -3
- 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-method-class.ts +6 -0
- 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 +36 -2
- package/models/update-bank-order-request-dto.ts +71 -0
- package/models/update-bank-order-response-class.ts +31 -0
- package/package.json +1 -1
- package/tsconfig.json +1 -0
- /package/dist/models/{unlink-bank-transaction-request-dto-rest.js → bank-order-class.js} +0 -0
|
@@ -12,32 +12,41 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { GenerateInvoiceMatchSuggestionsResponseClass } from '../models';
|
|
15
16
|
import { GetBankTransactionsResponseClass } from '../models';
|
|
16
17
|
import { ImportBankTransactionsResponseClass } from '../models';
|
|
17
18
|
import { LinkBankTransactionRequestDtoRest } from '../models';
|
|
18
19
|
import { LinkBankTransactionsResponseClass } from '../models';
|
|
19
20
|
import { ListBankTransactionsResponseClass } from '../models';
|
|
20
|
-
import { UnlinkBankTransactionRequestDtoRest } from '../models';
|
|
21
21
|
import { UnlinkBankTransactionsResponseClass } from '../models';
|
|
22
22
|
/**
|
|
23
23
|
* BankTransactionApi - axios parameter creator
|
|
24
24
|
* @export
|
|
25
25
|
*/
|
|
26
26
|
export declare const BankTransactionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
27
|
+
/**
|
|
28
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
29
|
+
* @summary Invoice Match Suggestion
|
|
30
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
31
|
+
* @param {string} [authorization] Bearer Token
|
|
32
|
+
* @param {*} [options] Override http request option.
|
|
33
|
+
* @throws {RequiredError}
|
|
34
|
+
*/
|
|
35
|
+
generateInvoiceMatchSuggestion: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
27
36
|
/**
|
|
28
37
|
* 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\"
|
|
29
38
|
* @summary Retrieve the bank transaction
|
|
30
39
|
* @param {string} code
|
|
31
40
|
* @param {string} [authorization] Bearer Token
|
|
32
|
-
* @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>
|
|
41
|
+
* @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, linkedBankOrder, bankTransactionInvoices<i>
|
|
33
42
|
* @param {*} [options] Override http request option.
|
|
34
43
|
* @throws {RequiredError}
|
|
35
44
|
*/
|
|
36
45
|
getBankTransaction: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
46
|
/**
|
|
38
|
-
* This will import bank transactions from a
|
|
47
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
39
48
|
* @summary Create the bank transactions
|
|
40
|
-
* @param {any} file
|
|
49
|
+
* @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
|
|
41
50
|
* @param {string} [authorization] Bearer Token
|
|
42
51
|
* @param {*} [options] Override http request option.
|
|
43
52
|
* @throws {RequiredError}
|
|
@@ -57,45 +66,55 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
57
66
|
* 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\"
|
|
58
67
|
* @summary List bank transactions
|
|
59
68
|
* @param {string} [authorization] Bearer Token
|
|
60
|
-
* @param {
|
|
61
|
-
* @param {string} [
|
|
69
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
70
|
+
* @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.
|
|
71
|
+
* @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>
|
|
62
72
|
* @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>
|
|
63
|
-
* @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,
|
|
64
|
-
* @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>
|
|
73
|
+
* @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>
|
|
74
|
+
* @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, linkedBankOrder, bankTransactionInvoices<i>
|
|
75
|
+
* @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>
|
|
65
76
|
* @param {*} [options] Override http request option.
|
|
66
77
|
* @throws {RequiredError}
|
|
67
78
|
*/
|
|
68
|
-
listBankTransactions: (authorization?: string,
|
|
79
|
+
listBankTransactions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
80
|
/**
|
|
70
81
|
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
71
82
|
* @summary Unlink bank transaction
|
|
72
83
|
* @param {string} code Code of the bank transaction to unlink
|
|
73
|
-
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
74
84
|
* @param {string} [authorization] Bearer Token
|
|
75
85
|
* @param {*} [options] Override http request option.
|
|
76
86
|
* @throws {RequiredError}
|
|
77
87
|
*/
|
|
78
|
-
unlinkBankTransaction: (code: string,
|
|
88
|
+
unlinkBankTransaction: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
79
89
|
};
|
|
80
90
|
/**
|
|
81
91
|
* BankTransactionApi - functional programming interface
|
|
82
92
|
* @export
|
|
83
93
|
*/
|
|
84
94
|
export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
95
|
+
/**
|
|
96
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
97
|
+
* @summary Invoice Match Suggestion
|
|
98
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
99
|
+
* @param {string} [authorization] Bearer Token
|
|
100
|
+
* @param {*} [options] Override http request option.
|
|
101
|
+
* @throws {RequiredError}
|
|
102
|
+
*/
|
|
103
|
+
generateInvoiceMatchSuggestion(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateInvoiceMatchSuggestionsResponseClass>>;
|
|
85
104
|
/**
|
|
86
105
|
* 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\"
|
|
87
106
|
* @summary Retrieve the bank transaction
|
|
88
107
|
* @param {string} code
|
|
89
108
|
* @param {string} [authorization] Bearer Token
|
|
90
|
-
* @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>
|
|
109
|
+
* @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, linkedBankOrder, bankTransactionInvoices<i>
|
|
91
110
|
* @param {*} [options] Override http request option.
|
|
92
111
|
* @throws {RequiredError}
|
|
93
112
|
*/
|
|
94
113
|
getBankTransaction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankTransactionsResponseClass>>;
|
|
95
114
|
/**
|
|
96
|
-
* This will import bank transactions from a
|
|
115
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
97
116
|
* @summary Create the bank transactions
|
|
98
|
-
* @param {any} file
|
|
117
|
+
* @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
|
|
99
118
|
* @param {string} [authorization] Bearer Token
|
|
100
119
|
* @param {*} [options] Override http request option.
|
|
101
120
|
* @throws {RequiredError}
|
|
@@ -115,45 +134,55 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
|
115
134
|
* 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\"
|
|
116
135
|
* @summary List bank transactions
|
|
117
136
|
* @param {string} [authorization] Bearer Token
|
|
118
|
-
* @param {
|
|
119
|
-
* @param {string} [
|
|
137
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
138
|
+
* @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.
|
|
139
|
+
* @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>
|
|
120
140
|
* @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>
|
|
121
|
-
* @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,
|
|
122
|
-
* @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>
|
|
141
|
+
* @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>
|
|
142
|
+
* @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, linkedBankOrder, bankTransactionInvoices<i>
|
|
143
|
+
* @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>
|
|
123
144
|
* @param {*} [options] Override http request option.
|
|
124
145
|
* @throws {RequiredError}
|
|
125
146
|
*/
|
|
126
|
-
listBankTransactions(authorization?: string,
|
|
147
|
+
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>>;
|
|
127
148
|
/**
|
|
128
149
|
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
129
150
|
* @summary Unlink bank transaction
|
|
130
151
|
* @param {string} code Code of the bank transaction to unlink
|
|
131
|
-
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
132
152
|
* @param {string} [authorization] Bearer Token
|
|
133
153
|
* @param {*} [options] Override http request option.
|
|
134
154
|
* @throws {RequiredError}
|
|
135
155
|
*/
|
|
136
|
-
unlinkBankTransaction(code: string,
|
|
156
|
+
unlinkBankTransaction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UnlinkBankTransactionsResponseClass>>;
|
|
137
157
|
};
|
|
138
158
|
/**
|
|
139
159
|
* BankTransactionApi - factory interface
|
|
140
160
|
* @export
|
|
141
161
|
*/
|
|
142
162
|
export declare const BankTransactionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
163
|
+
/**
|
|
164
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
165
|
+
* @summary Invoice Match Suggestion
|
|
166
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
167
|
+
* @param {string} [authorization] Bearer Token
|
|
168
|
+
* @param {*} [options] Override http request option.
|
|
169
|
+
* @throws {RequiredError}
|
|
170
|
+
*/
|
|
171
|
+
generateInvoiceMatchSuggestion(code: string, authorization?: string, options?: any): AxiosPromise<GenerateInvoiceMatchSuggestionsResponseClass>;
|
|
143
172
|
/**
|
|
144
173
|
* 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\"
|
|
145
174
|
* @summary Retrieve the bank transaction
|
|
146
175
|
* @param {string} code
|
|
147
176
|
* @param {string} [authorization] Bearer Token
|
|
148
|
-
* @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>
|
|
177
|
+
* @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, linkedBankOrder, bankTransactionInvoices<i>
|
|
149
178
|
* @param {*} [options] Override http request option.
|
|
150
179
|
* @throws {RequiredError}
|
|
151
180
|
*/
|
|
152
181
|
getBankTransaction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetBankTransactionsResponseClass>;
|
|
153
182
|
/**
|
|
154
|
-
* This will import bank transactions from a
|
|
183
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
155
184
|
* @summary Create the bank transactions
|
|
156
|
-
* @param {any} file
|
|
185
|
+
* @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
|
|
157
186
|
* @param {string} [authorization] Bearer Token
|
|
158
187
|
* @param {*} [options] Override http request option.
|
|
159
188
|
* @throws {RequiredError}
|
|
@@ -173,26 +202,46 @@ export declare const BankTransactionApiFactory: (configuration?: Configuration,
|
|
|
173
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. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
174
203
|
* @summary List bank transactions
|
|
175
204
|
* @param {string} [authorization] Bearer Token
|
|
176
|
-
* @param {
|
|
177
|
-
* @param {string} [
|
|
205
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
206
|
+
* @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.
|
|
207
|
+
* @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>
|
|
178
208
|
* @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>
|
|
179
|
-
* @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,
|
|
180
|
-
* @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>
|
|
209
|
+
* @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>
|
|
210
|
+
* @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, linkedBankOrder, bankTransactionInvoices<i>
|
|
211
|
+
* @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>
|
|
181
212
|
* @param {*} [options] Override http request option.
|
|
182
213
|
* @throws {RequiredError}
|
|
183
214
|
*/
|
|
184
|
-
listBankTransactions(authorization?: string,
|
|
215
|
+
listBankTransactions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListBankTransactionsResponseClass>;
|
|
185
216
|
/**
|
|
186
217
|
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
187
218
|
* @summary Unlink bank transaction
|
|
188
219
|
* @param {string} code Code of the bank transaction to unlink
|
|
189
|
-
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
190
220
|
* @param {string} [authorization] Bearer Token
|
|
191
221
|
* @param {*} [options] Override http request option.
|
|
192
222
|
* @throws {RequiredError}
|
|
193
223
|
*/
|
|
194
|
-
unlinkBankTransaction(code: string,
|
|
224
|
+
unlinkBankTransaction(code: string, authorization?: string, options?: any): AxiosPromise<UnlinkBankTransactionsResponseClass>;
|
|
195
225
|
};
|
|
226
|
+
/**
|
|
227
|
+
* Request parameters for generateInvoiceMatchSuggestion operation in BankTransactionApi.
|
|
228
|
+
* @export
|
|
229
|
+
* @interface BankTransactionApiGenerateInvoiceMatchSuggestionRequest
|
|
230
|
+
*/
|
|
231
|
+
export interface BankTransactionApiGenerateInvoiceMatchSuggestionRequest {
|
|
232
|
+
/**
|
|
233
|
+
* Code of the bank transaction to generate match suggestions for
|
|
234
|
+
* @type {string}
|
|
235
|
+
* @memberof BankTransactionApiGenerateInvoiceMatchSuggestion
|
|
236
|
+
*/
|
|
237
|
+
readonly code: string;
|
|
238
|
+
/**
|
|
239
|
+
* Bearer Token
|
|
240
|
+
* @type {string}
|
|
241
|
+
* @memberof BankTransactionApiGenerateInvoiceMatchSuggestion
|
|
242
|
+
*/
|
|
243
|
+
readonly authorization?: string;
|
|
244
|
+
}
|
|
196
245
|
/**
|
|
197
246
|
* Request parameters for getBankTransaction operation in BankTransactionApi.
|
|
198
247
|
* @export
|
|
@@ -212,7 +261,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
212
261
|
*/
|
|
213
262
|
readonly authorization?: string;
|
|
214
263
|
/**
|
|
215
|
-
* 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>
|
|
264
|
+
* 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, linkedBankOrder, bankTransactionInvoices<i>
|
|
216
265
|
* @type {string}
|
|
217
266
|
* @memberof BankTransactionApiGetBankTransaction
|
|
218
267
|
*/
|
|
@@ -225,7 +274,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
225
274
|
*/
|
|
226
275
|
export interface BankTransactionApiImportBankTransactionsRequest {
|
|
227
276
|
/**
|
|
228
|
-
*
|
|
277
|
+
* 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
|
|
229
278
|
* @type {any}
|
|
230
279
|
* @memberof BankTransactionApiImportBankTransactions
|
|
231
280
|
*/
|
|
@@ -275,17 +324,23 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
275
324
|
*/
|
|
276
325
|
readonly authorization?: string;
|
|
277
326
|
/**
|
|
278
|
-
*
|
|
327
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
328
|
+
* @type {number}
|
|
329
|
+
* @memberof BankTransactionApiListBankTransactions
|
|
330
|
+
*/
|
|
331
|
+
readonly pageSize?: number;
|
|
332
|
+
/**
|
|
333
|
+
* 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.
|
|
279
334
|
* @type {string}
|
|
280
335
|
* @memberof BankTransactionApiListBankTransactions
|
|
281
336
|
*/
|
|
282
|
-
readonly
|
|
337
|
+
readonly pageToken?: string;
|
|
283
338
|
/**
|
|
284
|
-
*
|
|
339
|
+
* 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>
|
|
285
340
|
* @type {string}
|
|
286
341
|
* @memberof BankTransactionApiListBankTransactions
|
|
287
342
|
*/
|
|
288
|
-
readonly
|
|
343
|
+
readonly filter?: string;
|
|
289
344
|
/**
|
|
290
345
|
* 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>
|
|
291
346
|
* @type {string}
|
|
@@ -293,17 +348,23 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
293
348
|
*/
|
|
294
349
|
readonly search?: string;
|
|
295
350
|
/**
|
|
296
|
-
* 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,
|
|
351
|
+
* 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>
|
|
297
352
|
* @type {string}
|
|
298
353
|
* @memberof BankTransactionApiListBankTransactions
|
|
299
354
|
*/
|
|
300
355
|
readonly order?: string;
|
|
301
356
|
/**
|
|
302
|
-
* 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>
|
|
357
|
+
* 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, linkedBankOrder, bankTransactionInvoices<i>
|
|
303
358
|
* @type {string}
|
|
304
359
|
* @memberof BankTransactionApiListBankTransactions
|
|
305
360
|
*/
|
|
306
361
|
readonly expand?: string;
|
|
362
|
+
/**
|
|
363
|
+
* 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>
|
|
364
|
+
* @type {string}
|
|
365
|
+
* @memberof BankTransactionApiListBankTransactions
|
|
366
|
+
*/
|
|
367
|
+
readonly filters?: string;
|
|
307
368
|
}
|
|
308
369
|
/**
|
|
309
370
|
* Request parameters for unlinkBankTransaction operation in BankTransactionApi.
|
|
@@ -317,12 +378,6 @@ export interface BankTransactionApiUnlinkBankTransactionRequest {
|
|
|
317
378
|
* @memberof BankTransactionApiUnlinkBankTransaction
|
|
318
379
|
*/
|
|
319
380
|
readonly code: string;
|
|
320
|
-
/**
|
|
321
|
-
*
|
|
322
|
-
* @type {UnlinkBankTransactionRequestDtoRest}
|
|
323
|
-
* @memberof BankTransactionApiUnlinkBankTransaction
|
|
324
|
-
*/
|
|
325
|
-
readonly unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest;
|
|
326
381
|
/**
|
|
327
382
|
* Bearer Token
|
|
328
383
|
* @type {string}
|
|
@@ -337,6 +392,15 @@ export interface BankTransactionApiUnlinkBankTransactionRequest {
|
|
|
337
392
|
* @extends {BaseAPI}
|
|
338
393
|
*/
|
|
339
394
|
export declare class BankTransactionApi extends BaseAPI {
|
|
395
|
+
/**
|
|
396
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
397
|
+
* @summary Invoice Match Suggestion
|
|
398
|
+
* @param {BankTransactionApiGenerateInvoiceMatchSuggestionRequest} requestParameters Request parameters.
|
|
399
|
+
* @param {*} [options] Override http request option.
|
|
400
|
+
* @throws {RequiredError}
|
|
401
|
+
* @memberof BankTransactionApi
|
|
402
|
+
*/
|
|
403
|
+
generateInvoiceMatchSuggestion(requestParameters: BankTransactionApiGenerateInvoiceMatchSuggestionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateInvoiceMatchSuggestionsResponseClass, any>>;
|
|
340
404
|
/**
|
|
341
405
|
* 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\"
|
|
342
406
|
* @summary Retrieve the bank transaction
|
|
@@ -347,7 +411,7 @@ export declare class BankTransactionApi extends BaseAPI {
|
|
|
347
411
|
*/
|
|
348
412
|
getBankTransaction(requestParameters: BankTransactionApiGetBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankTransactionsResponseClass, any>>;
|
|
349
413
|
/**
|
|
350
|
-
* This will import bank transactions from a
|
|
414
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
351
415
|
* @summary Create the bank transactions
|
|
352
416
|
* @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
|
|
353
417
|
* @param {*} [options] Override http request option.
|