@emilgroup/accounting-sdk-node 1.16.1-beta.2 → 1.16.1-beta.4

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.
@@ -5,6 +5,7 @@ README.md
5
5
  api.ts
6
6
  api/booking-entries-api.ts
7
7
  api/financial-accounts-api.ts
8
+ api/financial-transactions-api.ts
8
9
  api/health-api.ts
9
10
  api/personal-accounts-api.ts
10
11
  base.ts
@@ -24,12 +25,14 @@ models/financial-transaction-class.ts
24
25
  models/financial-transaction-data-dto.ts
25
26
  models/get-booking-entry-response-class.ts
26
27
  models/get-financial-account-response-class.ts
28
+ models/get-financial-transaction-response-class.ts
27
29
  models/get-personal-account-response-class.ts
28
30
  models/index.ts
29
31
  models/inline-response200.ts
30
32
  models/inline-response503.ts
31
33
  models/list-booking-entries-response-class.ts
32
34
  models/list-financial-accounts-response-class.ts
35
+ models/list-financial-transactions-response-class.ts
33
36
  models/list-personal-accounts-response-class.ts
34
37
  models/personal-account-class.ts
35
38
  package.json
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/accounting-sdk-node@1.16.1-beta.2 --save
20
+ npm install @emilgroup/accounting-sdk-node@1.16.1-beta.4 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/accounting-sdk-node@1.16.1-beta.2
24
+ yarn add @emilgroup/accounting-sdk-node@1.16.1-beta.4
25
25
  ```
26
26
 
27
27
  And then you can import `FinancialAccountsApi`.
@@ -0,0 +1,369 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL AccountingService
5
+ * The EMIL AccountingService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
+ import { Configuration } from '../configuration';
18
+ // Some imports not used depending on template conditions
19
+ // @ts-ignore
20
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
+ // @ts-ignore
22
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
+ // @ts-ignore
24
+ import { GetFinancialTransactionResponseClass } from '../models';
25
+ // @ts-ignore
26
+ import { ListFinancialTransactionsResponseClass } from '../models';
27
+ // URLSearchParams not necessarily used
28
+ // @ts-ignore
29
+ import { URL, URLSearchParams } from 'url';
30
+ const FormData = require('form-data');
31
+ /**
32
+ * FinancialTransactionsApi - axios parameter creator
33
+ * @export
34
+ */
35
+ export const FinancialTransactionsApiAxiosParamCreator = function (configuration?: Configuration) {
36
+ return {
37
+ /**
38
+ * This endpoint gets a financial transaction.
39
+ * @summary Retrieve the financial transaction
40
+ * @param {string} code
41
+ * @param {string} expand
42
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
43
+ * @param {*} [options] Override http request option.
44
+ * @throws {RequiredError}
45
+ */
46
+ getFinancialTransaction: async (code: string, expand: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
47
+ // verify required parameter 'code' is not null or undefined
48
+ assertParamExists('getFinancialTransaction', 'code', code)
49
+ // verify required parameter 'expand' is not null or undefined
50
+ assertParamExists('getFinancialTransaction', 'expand', expand)
51
+ const localVarPath = `/accountingservice/v1/financial-transactions/{code}`
52
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
53
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
54
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
55
+ let baseOptions;
56
+ let baseAccessToken;
57
+ if (configuration) {
58
+ baseOptions = configuration.baseOptions;
59
+ baseAccessToken = configuration.accessToken;
60
+ }
61
+
62
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
63
+ const localVarHeaderParameter = {} as any;
64
+ const localVarQueryParameter = {} as any;
65
+
66
+ // authentication bearer required
67
+ // http bearer authentication required
68
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
69
+
70
+ if (expand !== undefined) {
71
+ localVarQueryParameter['expand'] = expand;
72
+ }
73
+
74
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
75
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
76
+ }
77
+
78
+
79
+
80
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
81
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
82
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
83
+
84
+ return {
85
+ url: toPathString(localVarUrlObj),
86
+ options: localVarRequestOptions,
87
+ };
88
+ },
89
+ /**
90
+ * This endpoint list financial transactions.
91
+ * @summary List financial transactions
92
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
93
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
94
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
95
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
96
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
97
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
98
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
99
+ * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
100
+ * @param {*} [options] Override http request option.
101
+ * @throws {RequiredError}
102
+ */
103
+ listFinancialTransactions: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
104
+ const localVarPath = `/accountingservice/v1/financial-transactions`;
105
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
106
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
107
+ let baseOptions;
108
+ let baseAccessToken;
109
+ if (configuration) {
110
+ baseOptions = configuration.baseOptions;
111
+ baseAccessToken = configuration.accessToken;
112
+ }
113
+
114
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
115
+ const localVarHeaderParameter = {} as any;
116
+ const localVarQueryParameter = {} as any;
117
+
118
+ // authentication bearer required
119
+ // http bearer authentication required
120
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
121
+
122
+ if (pageSize !== undefined) {
123
+ localVarQueryParameter['pageSize'] = pageSize;
124
+ }
125
+
126
+ if (pageToken !== undefined) {
127
+ localVarQueryParameter['pageToken'] = pageToken;
128
+ }
129
+
130
+ if (filter !== undefined) {
131
+ localVarQueryParameter['filter'] = filter;
132
+ }
133
+
134
+ if (search !== undefined) {
135
+ localVarQueryParameter['search'] = search;
136
+ }
137
+
138
+ if (order !== undefined) {
139
+ localVarQueryParameter['order'] = order;
140
+ }
141
+
142
+ if (expand !== undefined) {
143
+ localVarQueryParameter['expand'] = expand;
144
+ }
145
+
146
+ if (filters !== undefined) {
147
+ localVarQueryParameter['filters'] = filters;
148
+ }
149
+
150
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
151
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
152
+ }
153
+
154
+
155
+
156
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
157
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
158
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
159
+
160
+ return {
161
+ url: toPathString(localVarUrlObj),
162
+ options: localVarRequestOptions,
163
+ };
164
+ },
165
+ }
166
+ };
167
+
168
+ /**
169
+ * FinancialTransactionsApi - functional programming interface
170
+ * @export
171
+ */
172
+ export const FinancialTransactionsApiFp = function(configuration?: Configuration) {
173
+ const localVarAxiosParamCreator = FinancialTransactionsApiAxiosParamCreator(configuration)
174
+ return {
175
+ /**
176
+ * This endpoint gets a financial transaction.
177
+ * @summary Retrieve the financial transaction
178
+ * @param {string} code
179
+ * @param {string} expand
180
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
181
+ * @param {*} [options] Override http request option.
182
+ * @throws {RequiredError}
183
+ */
184
+ async getFinancialTransaction(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFinancialTransactionResponseClass>> {
185
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getFinancialTransaction(code, expand, authorization, options);
186
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
187
+ },
188
+ /**
189
+ * This endpoint list financial transactions.
190
+ * @summary List financial transactions
191
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
192
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
193
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
194
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
195
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
196
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
197
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
198
+ * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
199
+ * @param {*} [options] Override http request option.
200
+ * @throws {RequiredError}
201
+ */
202
+ async listFinancialTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialTransactionsResponseClass>> {
203
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
204
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
205
+ },
206
+ }
207
+ };
208
+
209
+ /**
210
+ * FinancialTransactionsApi - factory interface
211
+ * @export
212
+ */
213
+ export const FinancialTransactionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
214
+ const localVarFp = FinancialTransactionsApiFp(configuration)
215
+ return {
216
+ /**
217
+ * This endpoint gets a financial transaction.
218
+ * @summary Retrieve the financial transaction
219
+ * @param {string} code
220
+ * @param {string} expand
221
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
222
+ * @param {*} [options] Override http request option.
223
+ * @throws {RequiredError}
224
+ */
225
+ getFinancialTransaction(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetFinancialTransactionResponseClass> {
226
+ return localVarFp.getFinancialTransaction(code, expand, authorization, options).then((request) => request(axios, basePath));
227
+ },
228
+ /**
229
+ * This endpoint list financial transactions.
230
+ * @summary List financial transactions
231
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
232
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
233
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
234
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
235
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
236
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
237
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
238
+ * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
239
+ * @param {*} [options] Override http request option.
240
+ * @throws {RequiredError}
241
+ */
242
+ listFinancialTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListFinancialTransactionsResponseClass> {
243
+ return localVarFp.listFinancialTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
244
+ },
245
+ };
246
+ };
247
+
248
+ /**
249
+ * Request parameters for getFinancialTransaction operation in FinancialTransactionsApi.
250
+ * @export
251
+ * @interface FinancialTransactionsApiGetFinancialTransactionRequest
252
+ */
253
+ export interface FinancialTransactionsApiGetFinancialTransactionRequest {
254
+ /**
255
+ *
256
+ * @type {string}
257
+ * @memberof FinancialTransactionsApiGetFinancialTransaction
258
+ */
259
+ readonly code: string
260
+
261
+ /**
262
+ *
263
+ * @type {string}
264
+ * @memberof FinancialTransactionsApiGetFinancialTransaction
265
+ */
266
+ readonly expand: string
267
+
268
+ /**
269
+ * Bearer Token: provided by the login endpoint under the name accessToken.
270
+ * @type {string}
271
+ * @memberof FinancialTransactionsApiGetFinancialTransaction
272
+ */
273
+ readonly authorization?: string
274
+ }
275
+
276
+ /**
277
+ * Request parameters for listFinancialTransactions operation in FinancialTransactionsApi.
278
+ * @export
279
+ * @interface FinancialTransactionsApiListFinancialTransactionsRequest
280
+ */
281
+ export interface FinancialTransactionsApiListFinancialTransactionsRequest {
282
+ /**
283
+ * Bearer Token: provided by the login endpoint under the name accessToken.
284
+ * @type {string}
285
+ * @memberof FinancialTransactionsApiListFinancialTransactions
286
+ */
287
+ readonly authorization?: string
288
+
289
+ /**
290
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
291
+ * @type {any}
292
+ * @memberof FinancialTransactionsApiListFinancialTransactions
293
+ */
294
+ readonly pageSize?: any
295
+
296
+ /**
297
+ * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
298
+ * @type {any}
299
+ * @memberof FinancialTransactionsApiListFinancialTransactions
300
+ */
301
+ readonly pageToken?: any
302
+
303
+ /**
304
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
305
+ * @type {any}
306
+ * @memberof FinancialTransactionsApiListFinancialTransactions
307
+ */
308
+ readonly filter?: any
309
+
310
+ /**
311
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
312
+ * @type {any}
313
+ * @memberof FinancialTransactionsApiListFinancialTransactions
314
+ */
315
+ readonly search?: any
316
+
317
+ /**
318
+ * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
319
+ * @type {any}
320
+ * @memberof FinancialTransactionsApiListFinancialTransactions
321
+ */
322
+ readonly order?: any
323
+
324
+ /**
325
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
326
+ * @type {any}
327
+ * @memberof FinancialTransactionsApiListFinancialTransactions
328
+ */
329
+ readonly expand?: any
330
+
331
+ /**
332
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
333
+ * @type {any}
334
+ * @memberof FinancialTransactionsApiListFinancialTransactions
335
+ */
336
+ readonly filters?: any
337
+ }
338
+
339
+ /**
340
+ * FinancialTransactionsApi - object-oriented interface
341
+ * @export
342
+ * @class FinancialTransactionsApi
343
+ * @extends {BaseAPI}
344
+ */
345
+ export class FinancialTransactionsApi extends BaseAPI {
346
+ /**
347
+ * This endpoint gets a financial transaction.
348
+ * @summary Retrieve the financial transaction
349
+ * @param {FinancialTransactionsApiGetFinancialTransactionRequest} requestParameters Request parameters.
350
+ * @param {*} [options] Override http request option.
351
+ * @throws {RequiredError}
352
+ * @memberof FinancialTransactionsApi
353
+ */
354
+ public getFinancialTransaction(requestParameters: FinancialTransactionsApiGetFinancialTransactionRequest, options?: AxiosRequestConfig) {
355
+ return FinancialTransactionsApiFp(this.configuration).getFinancialTransaction(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
356
+ }
357
+
358
+ /**
359
+ * This endpoint list financial transactions.
360
+ * @summary List financial transactions
361
+ * @param {FinancialTransactionsApiListFinancialTransactionsRequest} requestParameters Request parameters.
362
+ * @param {*} [options] Override http request option.
363
+ * @throws {RequiredError}
364
+ * @memberof FinancialTransactionsApi
365
+ */
366
+ public listFinancialTransactions(requestParameters: FinancialTransactionsApiListFinancialTransactionsRequest = {}, options?: AxiosRequestConfig) {
367
+ return FinancialTransactionsApiFp(this.configuration).listFinancialTransactions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
368
+ }
369
+ }
package/api.ts CHANGED
@@ -26,12 +26,14 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
26
26
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
27
27
  import { BookingEntriesApi } from './api';
28
28
  import { FinancialAccountsApi } from './api';
29
+ import { FinancialTransactionsApi } from './api';
29
30
  import { HealthApi } from './api';
30
31
  import { PersonalAccountsApi } from './api';
31
32
 
32
33
 
33
34
  export * from './api/booking-entries-api';
34
35
  export * from './api/financial-accounts-api';
36
+ export * from './api/financial-transactions-api';
35
37
  export * from './api/health-api';
36
38
  export * from './api/personal-accounts-api';
37
39
 
@@ -0,0 +1,215 @@
1
+ /**
2
+ * EMIL AccountingService
3
+ * The EMIL AccountingService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { GetFinancialTransactionResponseClass } from '../models';
16
+ import { ListFinancialTransactionsResponseClass } from '../models';
17
+ /**
18
+ * FinancialTransactionsApi - axios parameter creator
19
+ * @export
20
+ */
21
+ export declare const FinancialTransactionsApiAxiosParamCreator: (configuration?: Configuration) => {
22
+ /**
23
+ * This endpoint gets a financial transaction.
24
+ * @summary Retrieve the financial transaction
25
+ * @param {string} code
26
+ * @param {string} expand
27
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
28
+ * @param {*} [options] Override http request option.
29
+ * @throws {RequiredError}
30
+ */
31
+ getFinancialTransaction: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
32
+ /**
33
+ * This endpoint list financial transactions.
34
+ * @summary List financial transactions
35
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
36
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
37
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
38
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
39
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
40
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
41
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
42
+ * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
43
+ * @param {*} [options] Override http request option.
44
+ * @throws {RequiredError}
45
+ */
46
+ listFinancialTransactions: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
47
+ };
48
+ /**
49
+ * FinancialTransactionsApi - functional programming interface
50
+ * @export
51
+ */
52
+ export declare const FinancialTransactionsApiFp: (configuration?: Configuration) => {
53
+ /**
54
+ * This endpoint gets a financial transaction.
55
+ * @summary Retrieve the financial transaction
56
+ * @param {string} code
57
+ * @param {string} expand
58
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
59
+ * @param {*} [options] Override http request option.
60
+ * @throws {RequiredError}
61
+ */
62
+ getFinancialTransaction(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFinancialTransactionResponseClass>>;
63
+ /**
64
+ * This endpoint list financial transactions.
65
+ * @summary List financial transactions
66
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
67
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
68
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
69
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
70
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
71
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
72
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
73
+ * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
74
+ * @param {*} [options] Override http request option.
75
+ * @throws {RequiredError}
76
+ */
77
+ listFinancialTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialTransactionsResponseClass>>;
78
+ };
79
+ /**
80
+ * FinancialTransactionsApi - factory interface
81
+ * @export
82
+ */
83
+ export declare const FinancialTransactionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
84
+ /**
85
+ * This endpoint gets a financial transaction.
86
+ * @summary Retrieve the financial transaction
87
+ * @param {string} code
88
+ * @param {string} expand
89
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
90
+ * @param {*} [options] Override http request option.
91
+ * @throws {RequiredError}
92
+ */
93
+ getFinancialTransaction(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetFinancialTransactionResponseClass>;
94
+ /**
95
+ * This endpoint list financial transactions.
96
+ * @summary List financial transactions
97
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
98
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
99
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
100
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
101
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
102
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
103
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
104
+ * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
105
+ * @param {*} [options] Override http request option.
106
+ * @throws {RequiredError}
107
+ */
108
+ listFinancialTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListFinancialTransactionsResponseClass>;
109
+ };
110
+ /**
111
+ * Request parameters for getFinancialTransaction operation in FinancialTransactionsApi.
112
+ * @export
113
+ * @interface FinancialTransactionsApiGetFinancialTransactionRequest
114
+ */
115
+ export interface FinancialTransactionsApiGetFinancialTransactionRequest {
116
+ /**
117
+ *
118
+ * @type {string}
119
+ * @memberof FinancialTransactionsApiGetFinancialTransaction
120
+ */
121
+ readonly code: string;
122
+ /**
123
+ *
124
+ * @type {string}
125
+ * @memberof FinancialTransactionsApiGetFinancialTransaction
126
+ */
127
+ readonly expand: string;
128
+ /**
129
+ * Bearer Token: provided by the login endpoint under the name accessToken.
130
+ * @type {string}
131
+ * @memberof FinancialTransactionsApiGetFinancialTransaction
132
+ */
133
+ readonly authorization?: string;
134
+ }
135
+ /**
136
+ * Request parameters for listFinancialTransactions operation in FinancialTransactionsApi.
137
+ * @export
138
+ * @interface FinancialTransactionsApiListFinancialTransactionsRequest
139
+ */
140
+ export interface FinancialTransactionsApiListFinancialTransactionsRequest {
141
+ /**
142
+ * Bearer Token: provided by the login endpoint under the name accessToken.
143
+ * @type {string}
144
+ * @memberof FinancialTransactionsApiListFinancialTransactions
145
+ */
146
+ readonly authorization?: string;
147
+ /**
148
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
149
+ * @type {any}
150
+ * @memberof FinancialTransactionsApiListFinancialTransactions
151
+ */
152
+ readonly pageSize?: any;
153
+ /**
154
+ * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
155
+ * @type {any}
156
+ * @memberof FinancialTransactionsApiListFinancialTransactions
157
+ */
158
+ readonly pageToken?: any;
159
+ /**
160
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
161
+ * @type {any}
162
+ * @memberof FinancialTransactionsApiListFinancialTransactions
163
+ */
164
+ readonly filter?: any;
165
+ /**
166
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
167
+ * @type {any}
168
+ * @memberof FinancialTransactionsApiListFinancialTransactions
169
+ */
170
+ readonly search?: any;
171
+ /**
172
+ * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
173
+ * @type {any}
174
+ * @memberof FinancialTransactionsApiListFinancialTransactions
175
+ */
176
+ readonly order?: any;
177
+ /**
178
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
179
+ * @type {any}
180
+ * @memberof FinancialTransactionsApiListFinancialTransactions
181
+ */
182
+ readonly expand?: any;
183
+ /**
184
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
185
+ * @type {any}
186
+ * @memberof FinancialTransactionsApiListFinancialTransactions
187
+ */
188
+ readonly filters?: any;
189
+ }
190
+ /**
191
+ * FinancialTransactionsApi - object-oriented interface
192
+ * @export
193
+ * @class FinancialTransactionsApi
194
+ * @extends {BaseAPI}
195
+ */
196
+ export declare class FinancialTransactionsApi extends BaseAPI {
197
+ /**
198
+ * This endpoint gets a financial transaction.
199
+ * @summary Retrieve the financial transaction
200
+ * @param {FinancialTransactionsApiGetFinancialTransactionRequest} requestParameters Request parameters.
201
+ * @param {*} [options] Override http request option.
202
+ * @throws {RequiredError}
203
+ * @memberof FinancialTransactionsApi
204
+ */
205
+ getFinancialTransaction(requestParameters: FinancialTransactionsApiGetFinancialTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFinancialTransactionResponseClass, any>>;
206
+ /**
207
+ * This endpoint list financial transactions.
208
+ * @summary List financial transactions
209
+ * @param {FinancialTransactionsApiListFinancialTransactionsRequest} requestParameters Request parameters.
210
+ * @param {*} [options] Override http request option.
211
+ * @throws {RequiredError}
212
+ * @memberof FinancialTransactionsApi
213
+ */
214
+ listFinancialTransactions(requestParameters?: FinancialTransactionsApiListFinancialTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFinancialTransactionsResponseClass, any>>;
215
+ }