@emilgroup/payment-sdk 1.4.1-beta.30 → 1.4.1-beta.31
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 +5 -15
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +34 -38
- package/api/bank-transaction-api.ts +73 -77
- package/api/{default-api.ts → health-check-api.ts} +21 -17
- package/api/payment-methods-api.ts +52 -70
- package/api/payment-reminders-api.ts +63 -49
- package/api/payments-api.ts +52 -70
- package/api/refunds-api.ts +76 -88
- package/api/tenant-bank-account-api.ts +79 -63
- package/api/webhooks-api.ts +16 -12
- package/api.ts +2 -2
- package/dist/api/bank-accounts-api.d.ts +37 -39
- package/dist/api/bank-accounts-api.js +18 -18
- package/dist/api/bank-transaction-api.d.ts +77 -79
- package/dist/api/bank-transaction-api.js +45 -45
- package/dist/api/health-check-api.d.ts +70 -0
- package/dist/api/{default-api.js → health-check-api.js} +30 -26
- package/dist/api/payment-methods-api.d.ts +49 -58
- package/dist/api/payment-methods-api.js +32 -42
- package/dist/api/payment-reminders-api.d.ts +55 -46
- package/dist/api/payment-reminders-api.js +40 -34
- package/dist/api/payments-api.d.ts +49 -58
- package/dist/api/payments-api.js +32 -42
- package/dist/api/refunds-api.d.ts +76 -76
- package/dist/api/refunds-api.js +51 -49
- package/dist/api/tenant-bank-account-api.d.ts +71 -61
- package/dist/api/tenant-bank-account-api.js +51 -45
- package/dist/api/webhooks-api.d.ts +16 -12
- package/dist/api/webhooks-api.js +14 -10
- package/dist/api.d.ts +1 -1
- package/dist/api.js +1 -1
- package/dist/models/{bank-transaction-response-class.d.ts → bank-transaction-class-without-expand-properties.d.ts} +20 -34
- package/dist/models/create-tenant-bank-account-response-class.d.ts +4 -4
- package/dist/models/get-tenant-bank-account-response-class.d.ts +4 -4
- package/dist/models/index.d.ts +4 -14
- package/dist/models/index.js +4 -14
- package/dist/models/list-tenant-bank-account-response-class.d.ts +5 -5
- package/dist/models/{tenant-bank-account-response-class.d.ts → tenant-bank-account-class-without-expand-properties.d.ts} +10 -10
- package/dist/models/tenant-bank-account-class.d.ts +73 -0
- package/dist/models/{get-bank-account-response-class.d.ts → update-tenant-bank-account-response-class.d.ts} +7 -7
- package/models/{bank-transaction-response-class.ts → bank-transaction-class-without-expand-properties.ts} +20 -34
- package/models/create-tenant-bank-account-response-class.ts +4 -4
- package/models/get-tenant-bank-account-response-class.ts +4 -4
- package/models/index.ts +4 -14
- package/models/list-tenant-bank-account-response-class.ts +5 -5
- package/models/{tenant-bank-account-response-class.ts → tenant-bank-account-class-without-expand-properties.ts} +10 -10
- package/models/tenant-bank-account-class.ts +79 -0
- package/models/{create-refund-response-class.ts → update-tenant-bank-account-response-class.ts} +7 -7
- package/package.json +1 -1
- package/dist/api/default-api.d.ts +0 -66
- package/dist/models/bank-account-class.d.ts +0 -73
- package/dist/models/create-refund-response-class.d.ts +0 -25
- package/dist/models/get-bank-transactions-response-class.d.ts +0 -25
- package/dist/models/get-bank-transactions-response-class.js +0 -15
- package/dist/models/get-refund-response-class.d.ts +0 -25
- package/dist/models/get-refund-response-class.js +0 -15
- package/dist/models/get-request-dto.d.ts +0 -30
- package/dist/models/get-request-dto.js +0 -15
- package/dist/models/list-bank-transactions-response-class.d.ts +0 -31
- package/dist/models/list-bank-transactions-response-class.js +0 -15
- package/dist/models/list-refunds-response-class.d.ts +0 -31
- package/dist/models/list-refunds-response-class.js +0 -15
- package/dist/models/primary-bank-account-response-class.d.ts +0 -42
- package/dist/models/primary-bank-account-response-class.js +0 -15
- package/dist/models/refund-class.d.ts +0 -105
- package/dist/models/refund-class.js +0 -29
- package/dist/models/tenant-bank-account-response-class.js +0 -15
- package/dist/models/transaction-class.d.ts +0 -54
- package/dist/models/transaction-class.js +0 -15
- package/dist/models/update-bank-account-response-class.d.ts +0 -25
- package/dist/models/update-bank-account-response-class.js +0 -15
- package/models/bank-account-class.ts +0 -79
- package/models/get-bank-account-response-class.ts +0 -31
- package/models/get-bank-transactions-response-class.ts +0 -31
- package/models/get-refund-response-class.ts +0 -31
- package/models/get-request-dto.ts +0 -36
- package/models/list-bank-transactions-response-class.ts +0 -37
- package/models/list-refunds-response-class.ts +0 -37
- package/models/primary-bank-account-response-class.ts +0 -48
- package/models/refund-class.ts +0 -115
- package/models/transaction-class.ts +0 -60
- package/models/update-bank-account-response-class.ts +0 -31
- /package/dist/models/{bank-account-class.js → bank-transaction-class-without-expand-properties.js} +0 -0
- /package/dist/models/{bank-transaction-response-class.js → tenant-bank-account-class-without-expand-properties.js} +0 -0
- /package/dist/models/{create-refund-response-class.js → tenant-bank-account-class.js} +0 -0
- /package/dist/models/{get-bank-account-response-class.js → update-tenant-bank-account-response-class.js} +0 -0
|
@@ -12,9 +12,7 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
-
import { GetBankTransactionsResponseClass } from '../models';
|
|
16
15
|
import { LinkBankTransactionRequestDtoRest } from '../models';
|
|
17
|
-
import { ListBankTransactionsResponseClass } from '../models';
|
|
18
16
|
import { UnlinkBankTransactionRequestDtoRest } from '../models';
|
|
19
17
|
/**
|
|
20
18
|
* BankTransactionApi - axios parameter creator
|
|
@@ -22,17 +20,17 @@ import { UnlinkBankTransactionRequestDtoRest } from '../models';
|
|
|
22
20
|
*/
|
|
23
21
|
export declare const BankTransactionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
22
|
/**
|
|
25
|
-
* Retrieves the details of the
|
|
26
|
-
* @summary Retrieve the
|
|
27
|
-
* @param {string} code
|
|
23
|
+
* 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.
|
|
24
|
+
* @summary Retrieve the bank transaction
|
|
25
|
+
* @param {string} code Unique identifier for the object.
|
|
28
26
|
* @param {string} [authorization] Bearer Token
|
|
29
|
-
* @param {string} [expand] Expand the
|
|
27
|
+
* @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>
|
|
30
28
|
* @param {*} [options] Override http request option.
|
|
31
29
|
* @throws {RequiredError}
|
|
32
30
|
*/
|
|
33
31
|
getBankTransaction: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
32
|
/**
|
|
35
|
-
*
|
|
33
|
+
* This will import bank transactions from a swift MT940 file
|
|
36
34
|
* @summary Create the bank transactions
|
|
37
35
|
* @param {any} file Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.<br/> Allowed Content Types: text/plain, application/octet-stream
|
|
38
36
|
* @param {string} [authorization] Bearer Token
|
|
@@ -42,7 +40,7 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
42
40
|
importBankTransactions: (file: any, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43
41
|
/**
|
|
44
42
|
* Links a bank transaction with an invoice
|
|
45
|
-
* @summary Link
|
|
43
|
+
* @summary Link bank transaction
|
|
46
44
|
* @param {string} code Code of the bank transaction to link
|
|
47
45
|
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
48
46
|
* @param {string} [authorization] Bearer Token
|
|
@@ -51,23 +49,23 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
51
49
|
*/
|
|
52
50
|
linkBankTransaction: (code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
51
|
/**
|
|
54
|
-
* Returns a list of bank transactions you have previously created.
|
|
52
|
+
* 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.
|
|
55
53
|
* @summary List bank transactions
|
|
56
54
|
* @param {string} [authorization] Bearer Token
|
|
57
55
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
58
56
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
59
|
-
* @param {
|
|
60
|
-
* @param {
|
|
61
|
-
* @param {
|
|
62
|
-
* @param {
|
|
63
|
-
* @param {
|
|
57
|
+
* @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, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
58
|
+
* @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>
|
|
59
|
+
* @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, amount, transactionDate, entryDate</i>
|
|
60
|
+
* @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>
|
|
61
|
+
* @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, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
64
62
|
* @param {*} [options] Override http request option.
|
|
65
63
|
* @throws {RequiredError}
|
|
66
64
|
*/
|
|
67
|
-
listBankTransactions: (authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
65
|
+
listBankTransactions: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
66
|
/**
|
|
69
67
|
* Unlinks an already linked bank transaction
|
|
70
|
-
* @summary Unlink
|
|
68
|
+
* @summary Unlink bank transaction
|
|
71
69
|
* @param {string} code Code of the bank transaction to unlink
|
|
72
70
|
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
73
71
|
* @param {string} [authorization] Bearer Token
|
|
@@ -82,59 +80,59 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
82
80
|
*/
|
|
83
81
|
export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
84
82
|
/**
|
|
85
|
-
* Retrieves the details of the
|
|
86
|
-
* @summary Retrieve the
|
|
87
|
-
* @param {string} code
|
|
83
|
+
* 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.
|
|
84
|
+
* @summary Retrieve the bank transaction
|
|
85
|
+
* @param {string} code Unique identifier for the object.
|
|
88
86
|
* @param {string} [authorization] Bearer Token
|
|
89
|
-
* @param {string} [expand] Expand the
|
|
87
|
+
* @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>
|
|
90
88
|
* @param {*} [options] Override http request option.
|
|
91
89
|
* @throws {RequiredError}
|
|
92
90
|
*/
|
|
93
|
-
getBankTransaction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
91
|
+
getBankTransaction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
94
92
|
/**
|
|
95
|
-
*
|
|
93
|
+
* This will import bank transactions from a swift MT940 file
|
|
96
94
|
* @summary Create the bank transactions
|
|
97
95
|
* @param {any} file Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.<br/> Allowed Content Types: text/plain, application/octet-stream
|
|
98
96
|
* @param {string} [authorization] Bearer Token
|
|
99
97
|
* @param {*} [options] Override http request option.
|
|
100
98
|
* @throws {RequiredError}
|
|
101
99
|
*/
|
|
102
|
-
importBankTransactions(file: any, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
100
|
+
importBankTransactions(file: any, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
103
101
|
/**
|
|
104
102
|
* Links a bank transaction with an invoice
|
|
105
|
-
* @summary Link
|
|
103
|
+
* @summary Link bank transaction
|
|
106
104
|
* @param {string} code Code of the bank transaction to link
|
|
107
105
|
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
108
106
|
* @param {string} [authorization] Bearer Token
|
|
109
107
|
* @param {*} [options] Override http request option.
|
|
110
108
|
* @throws {RequiredError}
|
|
111
109
|
*/
|
|
112
|
-
linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
110
|
+
linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
113
111
|
/**
|
|
114
|
-
* Returns a list of bank transactions you have previously created.
|
|
112
|
+
* 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.
|
|
115
113
|
* @summary List bank transactions
|
|
116
114
|
* @param {string} [authorization] Bearer Token
|
|
117
115
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
118
116
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
119
|
-
* @param {
|
|
120
|
-
* @param {
|
|
121
|
-
* @param {
|
|
122
|
-
* @param {
|
|
123
|
-
* @param {
|
|
117
|
+
* @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, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
118
|
+
* @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>
|
|
119
|
+
* @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, amount, transactionDate, entryDate</i>
|
|
120
|
+
* @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>
|
|
121
|
+
* @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, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
124
122
|
* @param {*} [options] Override http request option.
|
|
125
123
|
* @throws {RequiredError}
|
|
126
124
|
*/
|
|
127
|
-
listBankTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
125
|
+
listBankTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
128
126
|
/**
|
|
129
127
|
* Unlinks an already linked bank transaction
|
|
130
|
-
* @summary Unlink
|
|
128
|
+
* @summary Unlink bank transaction
|
|
131
129
|
* @param {string} code Code of the bank transaction to unlink
|
|
132
130
|
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
133
131
|
* @param {string} [authorization] Bearer Token
|
|
134
132
|
* @param {*} [options] Override http request option.
|
|
135
133
|
* @throws {RequiredError}
|
|
136
134
|
*/
|
|
137
|
-
unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
135
|
+
unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
138
136
|
};
|
|
139
137
|
/**
|
|
140
138
|
* BankTransactionApi - factory interface
|
|
@@ -142,59 +140,59 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
|
142
140
|
*/
|
|
143
141
|
export declare const BankTransactionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
144
142
|
/**
|
|
145
|
-
* Retrieves the details of the
|
|
146
|
-
* @summary Retrieve the
|
|
147
|
-
* @param {string} code
|
|
143
|
+
* 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.
|
|
144
|
+
* @summary Retrieve the bank transaction
|
|
145
|
+
* @param {string} code Unique identifier for the object.
|
|
148
146
|
* @param {string} [authorization] Bearer Token
|
|
149
|
-
* @param {string} [expand] Expand the
|
|
147
|
+
* @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>
|
|
150
148
|
* @param {*} [options] Override http request option.
|
|
151
149
|
* @throws {RequiredError}
|
|
152
150
|
*/
|
|
153
|
-
getBankTransaction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<
|
|
151
|
+
getBankTransaction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<void>;
|
|
154
152
|
/**
|
|
155
|
-
*
|
|
153
|
+
* This will import bank transactions from a swift MT940 file
|
|
156
154
|
* @summary Create the bank transactions
|
|
157
155
|
* @param {any} file Swift MT940 file to import bank transactions from. Extension must be .txt or .sta.<br/> Allowed Content Types: text/plain, application/octet-stream
|
|
158
156
|
* @param {string} [authorization] Bearer Token
|
|
159
157
|
* @param {*} [options] Override http request option.
|
|
160
158
|
* @throws {RequiredError}
|
|
161
159
|
*/
|
|
162
|
-
importBankTransactions(file: any, authorization?: string, options?: any): AxiosPromise<
|
|
160
|
+
importBankTransactions(file: any, authorization?: string, options?: any): AxiosPromise<void>;
|
|
163
161
|
/**
|
|
164
162
|
* Links a bank transaction with an invoice
|
|
165
|
-
* @summary Link
|
|
163
|
+
* @summary Link bank transaction
|
|
166
164
|
* @param {string} code Code of the bank transaction to link
|
|
167
165
|
* @param {LinkBankTransactionRequestDtoRest} linkBankTransactionRequestDtoRest
|
|
168
166
|
* @param {string} [authorization] Bearer Token
|
|
169
167
|
* @param {*} [options] Override http request option.
|
|
170
168
|
* @throws {RequiredError}
|
|
171
169
|
*/
|
|
172
|
-
linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<
|
|
170
|
+
linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<void>;
|
|
173
171
|
/**
|
|
174
|
-
* Returns a list of bank transactions you have previously created.
|
|
172
|
+
* 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.
|
|
175
173
|
* @summary List bank transactions
|
|
176
174
|
* @param {string} [authorization] Bearer Token
|
|
177
175
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
178
176
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
179
|
-
* @param {
|
|
180
|
-
* @param {
|
|
181
|
-
* @param {
|
|
182
|
-
* @param {
|
|
183
|
-
* @param {
|
|
177
|
+
* @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, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
178
|
+
* @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, amount, transactionDate, entryDate</i>
|
|
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>
|
|
181
|
+
* @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, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
184
182
|
* @param {*} [options] Override http request option.
|
|
185
183
|
* @throws {RequiredError}
|
|
186
184
|
*/
|
|
187
|
-
listBankTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
185
|
+
listBankTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void>;
|
|
188
186
|
/**
|
|
189
187
|
* Unlinks an already linked bank transaction
|
|
190
|
-
* @summary Unlink
|
|
188
|
+
* @summary Unlink bank transaction
|
|
191
189
|
* @param {string} code Code of the bank transaction to unlink
|
|
192
190
|
* @param {UnlinkBankTransactionRequestDtoRest} unlinkBankTransactionRequestDtoRest
|
|
193
191
|
* @param {string} [authorization] Bearer Token
|
|
194
192
|
* @param {*} [options] Override http request option.
|
|
195
193
|
* @throws {RequiredError}
|
|
196
194
|
*/
|
|
197
|
-
unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<
|
|
195
|
+
unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<void>;
|
|
198
196
|
};
|
|
199
197
|
/**
|
|
200
198
|
* Request parameters for getBankTransaction operation in BankTransactionApi.
|
|
@@ -203,7 +201,7 @@ export declare const BankTransactionApiFactory: (configuration?: Configuration,
|
|
|
203
201
|
*/
|
|
204
202
|
export interface BankTransactionApiGetBankTransactionRequest {
|
|
205
203
|
/**
|
|
206
|
-
*
|
|
204
|
+
* Unique identifier for the object.
|
|
207
205
|
* @type {string}
|
|
208
206
|
* @memberof BankTransactionApiGetBankTransaction
|
|
209
207
|
*/
|
|
@@ -215,7 +213,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
215
213
|
*/
|
|
216
214
|
readonly authorization?: string;
|
|
217
215
|
/**
|
|
218
|
-
* Expand the
|
|
216
|
+
* 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>
|
|
219
217
|
* @type {string}
|
|
220
218
|
* @memberof BankTransactionApiGetBankTransaction
|
|
221
219
|
*/
|
|
@@ -290,35 +288,35 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
290
288
|
*/
|
|
291
289
|
readonly pageToken?: any;
|
|
292
290
|
/**
|
|
293
|
-
* Filter the response by one or multiple fields.
|
|
294
|
-
* @type {
|
|
291
|
+
* 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, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
292
|
+
* @type {string}
|
|
295
293
|
* @memberof BankTransactionApiListBankTransactions
|
|
296
294
|
*/
|
|
297
|
-
readonly filter?:
|
|
295
|
+
readonly filter?: string;
|
|
298
296
|
/**
|
|
299
|
-
*
|
|
300
|
-
* @type {
|
|
297
|
+
* 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>
|
|
298
|
+
* @type {string}
|
|
301
299
|
* @memberof BankTransactionApiListBankTransactions
|
|
302
300
|
*/
|
|
303
|
-
readonly search?:
|
|
301
|
+
readonly search?: string;
|
|
304
302
|
/**
|
|
305
|
-
*
|
|
306
|
-
* @type {
|
|
303
|
+
* 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, amount, transactionDate, entryDate</i>
|
|
304
|
+
* @type {string}
|
|
307
305
|
* @memberof BankTransactionApiListBankTransactions
|
|
308
306
|
*/
|
|
309
|
-
readonly order?:
|
|
307
|
+
readonly order?: string;
|
|
310
308
|
/**
|
|
311
|
-
* Expand the
|
|
312
|
-
* @type {
|
|
309
|
+
* 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>
|
|
310
|
+
* @type {string}
|
|
313
311
|
* @memberof BankTransactionApiListBankTransactions
|
|
314
312
|
*/
|
|
315
|
-
readonly expand?:
|
|
313
|
+
readonly expand?: string;
|
|
316
314
|
/**
|
|
317
|
-
* Filters the response by one or multiple fields.
|
|
318
|
-
* @type {
|
|
315
|
+
* 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, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
316
|
+
* @type {string}
|
|
319
317
|
* @memberof BankTransactionApiListBankTransactions
|
|
320
318
|
*/
|
|
321
|
-
readonly filters?:
|
|
319
|
+
readonly filters?: string;
|
|
322
320
|
}
|
|
323
321
|
/**
|
|
324
322
|
* Request parameters for unlinkBankTransaction operation in BankTransactionApi.
|
|
@@ -353,34 +351,34 @@ export interface BankTransactionApiUnlinkBankTransactionRequest {
|
|
|
353
351
|
*/
|
|
354
352
|
export declare class BankTransactionApi extends BaseAPI {
|
|
355
353
|
/**
|
|
356
|
-
* Retrieves the details of the
|
|
357
|
-
* @summary Retrieve the
|
|
354
|
+
* 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.
|
|
355
|
+
* @summary Retrieve the bank transaction
|
|
358
356
|
* @param {BankTransactionApiGetBankTransactionRequest} requestParameters Request parameters.
|
|
359
357
|
* @param {*} [options] Override http request option.
|
|
360
358
|
* @throws {RequiredError}
|
|
361
359
|
* @memberof BankTransactionApi
|
|
362
360
|
*/
|
|
363
|
-
getBankTransaction(requestParameters: BankTransactionApiGetBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
361
|
+
getBankTransaction(requestParameters: BankTransactionApiGetBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
364
362
|
/**
|
|
365
|
-
*
|
|
363
|
+
* This will import bank transactions from a swift MT940 file
|
|
366
364
|
* @summary Create the bank transactions
|
|
367
365
|
* @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
|
|
368
366
|
* @param {*} [options] Override http request option.
|
|
369
367
|
* @throws {RequiredError}
|
|
370
368
|
* @memberof BankTransactionApi
|
|
371
369
|
*/
|
|
372
|
-
importBankTransactions(requestParameters: BankTransactionApiImportBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
370
|
+
importBankTransactions(requestParameters: BankTransactionApiImportBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
373
371
|
/**
|
|
374
372
|
* Links a bank transaction with an invoice
|
|
375
|
-
* @summary Link
|
|
373
|
+
* @summary Link bank transaction
|
|
376
374
|
* @param {BankTransactionApiLinkBankTransactionRequest} requestParameters Request parameters.
|
|
377
375
|
* @param {*} [options] Override http request option.
|
|
378
376
|
* @throws {RequiredError}
|
|
379
377
|
* @memberof BankTransactionApi
|
|
380
378
|
*/
|
|
381
|
-
linkBankTransaction(requestParameters: BankTransactionApiLinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
379
|
+
linkBankTransaction(requestParameters: BankTransactionApiLinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
382
380
|
/**
|
|
383
|
-
* Returns a list of bank transactions you have previously created.
|
|
381
|
+
* 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.
|
|
384
382
|
* @summary List bank transactions
|
|
385
383
|
* @param {BankTransactionApiListBankTransactionsRequest} requestParameters Request parameters.
|
|
386
384
|
* @param {*} [options] Override http request option.
|
|
@@ -390,11 +388,11 @@ export declare class BankTransactionApi extends BaseAPI {
|
|
|
390
388
|
listBankTransactions(requestParameters?: BankTransactionApiListBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
391
389
|
/**
|
|
392
390
|
* Unlinks an already linked bank transaction
|
|
393
|
-
* @summary Unlink
|
|
391
|
+
* @summary Unlink bank transaction
|
|
394
392
|
* @param {BankTransactionApiUnlinkBankTransactionRequest} requestParameters Request parameters.
|
|
395
393
|
* @param {*} [options] Override http request option.
|
|
396
394
|
* @throws {RequiredError}
|
|
397
395
|
* @memberof BankTransactionApi
|
|
398
396
|
*/
|
|
399
|
-
unlinkBankTransaction(requestParameters: BankTransactionApiUnlinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
397
|
+
unlinkBankTransaction(requestParameters: BankTransactionApiUnlinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
400
398
|
}
|