@emilgroup/accounting-sdk 1.16.1-beta.3 → 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@1.16.1-beta.3 --save
20
+ npm install @emilgroup/accounting-sdk@1.16.1-beta.4 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/accounting-sdk@1.16.1-beta.3
24
+ yarn add @emilgroup/accounting-sdk@1.16.1-beta.4
25
25
  ```
26
26
 
27
27
  And then you can import `FinancialAccountsApi`.
@@ -0,0 +1,365 @@
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
+ /**
28
+ * FinancialTransactionsApi - axios parameter creator
29
+ * @export
30
+ */
31
+ export const FinancialTransactionsApiAxiosParamCreator = function (configuration?: Configuration) {
32
+ return {
33
+ /**
34
+ * This endpoint gets a financial transaction.
35
+ * @summary Retrieve the financial transaction
36
+ * @param {string} code
37
+ * @param {string} expand
38
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
39
+ * @param {*} [options] Override http request option.
40
+ * @throws {RequiredError}
41
+ */
42
+ getFinancialTransaction: async (code: string, expand: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
43
+ // verify required parameter 'code' is not null or undefined
44
+ assertParamExists('getFinancialTransaction', 'code', code)
45
+ // verify required parameter 'expand' is not null or undefined
46
+ assertParamExists('getFinancialTransaction', 'expand', expand)
47
+ const localVarPath = `/accountingservice/v1/financial-transactions/{code}`
48
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
49
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
50
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
51
+ let baseOptions;
52
+ let baseAccessToken;
53
+ if (configuration) {
54
+ baseOptions = configuration.baseOptions;
55
+ baseAccessToken = configuration.accessToken;
56
+ }
57
+
58
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
59
+ const localVarHeaderParameter = {} as any;
60
+ const localVarQueryParameter = {} as any;
61
+
62
+ // authentication bearer required
63
+ // http bearer authentication required
64
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
65
+
66
+ if (expand !== undefined) {
67
+ localVarQueryParameter['expand'] = expand;
68
+ }
69
+
70
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
71
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
72
+ }
73
+
74
+
75
+
76
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
77
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
78
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
79
+
80
+ return {
81
+ url: toPathString(localVarUrlObj),
82
+ options: localVarRequestOptions,
83
+ };
84
+ },
85
+ /**
86
+ * This endpoint list financial transactions.
87
+ * @summary List financial transactions
88
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
89
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
90
+ * @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.
91
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
92
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
93
+ * @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.
94
+ * @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.
95
+ * @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.
96
+ * @param {*} [options] Override http request option.
97
+ * @throws {RequiredError}
98
+ */
99
+ listFinancialTransactions: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
100
+ const localVarPath = `/accountingservice/v1/financial-transactions`;
101
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
102
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
103
+ let baseOptions;
104
+ let baseAccessToken;
105
+ if (configuration) {
106
+ baseOptions = configuration.baseOptions;
107
+ baseAccessToken = configuration.accessToken;
108
+ }
109
+
110
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
111
+ const localVarHeaderParameter = {} as any;
112
+ const localVarQueryParameter = {} as any;
113
+
114
+ // authentication bearer required
115
+ // http bearer authentication required
116
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
117
+
118
+ if (pageSize !== undefined) {
119
+ localVarQueryParameter['pageSize'] = pageSize;
120
+ }
121
+
122
+ if (pageToken !== undefined) {
123
+ localVarQueryParameter['pageToken'] = pageToken;
124
+ }
125
+
126
+ if (filter !== undefined) {
127
+ localVarQueryParameter['filter'] = filter;
128
+ }
129
+
130
+ if (search !== undefined) {
131
+ localVarQueryParameter['search'] = search;
132
+ }
133
+
134
+ if (order !== undefined) {
135
+ localVarQueryParameter['order'] = order;
136
+ }
137
+
138
+ if (expand !== undefined) {
139
+ localVarQueryParameter['expand'] = expand;
140
+ }
141
+
142
+ if (filters !== undefined) {
143
+ localVarQueryParameter['filters'] = filters;
144
+ }
145
+
146
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
147
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
148
+ }
149
+
150
+
151
+
152
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
153
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
154
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
155
+
156
+ return {
157
+ url: toPathString(localVarUrlObj),
158
+ options: localVarRequestOptions,
159
+ };
160
+ },
161
+ }
162
+ };
163
+
164
+ /**
165
+ * FinancialTransactionsApi - functional programming interface
166
+ * @export
167
+ */
168
+ export const FinancialTransactionsApiFp = function(configuration?: Configuration) {
169
+ const localVarAxiosParamCreator = FinancialTransactionsApiAxiosParamCreator(configuration)
170
+ return {
171
+ /**
172
+ * This endpoint gets a financial transaction.
173
+ * @summary Retrieve the financial transaction
174
+ * @param {string} code
175
+ * @param {string} expand
176
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
177
+ * @param {*} [options] Override http request option.
178
+ * @throws {RequiredError}
179
+ */
180
+ async getFinancialTransaction(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFinancialTransactionResponseClass>> {
181
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getFinancialTransaction(code, expand, authorization, options);
182
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
183
+ },
184
+ /**
185
+ * This endpoint list financial transactions.
186
+ * @summary List financial transactions
187
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
188
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
189
+ * @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.
190
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
191
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
192
+ * @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.
193
+ * @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.
194
+ * @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.
195
+ * @param {*} [options] Override http request option.
196
+ * @throws {RequiredError}
197
+ */
198
+ 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>> {
199
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
200
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
201
+ },
202
+ }
203
+ };
204
+
205
+ /**
206
+ * FinancialTransactionsApi - factory interface
207
+ * @export
208
+ */
209
+ export const FinancialTransactionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
210
+ const localVarFp = FinancialTransactionsApiFp(configuration)
211
+ return {
212
+ /**
213
+ * This endpoint gets a financial transaction.
214
+ * @summary Retrieve the financial transaction
215
+ * @param {string} code
216
+ * @param {string} expand
217
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
218
+ * @param {*} [options] Override http request option.
219
+ * @throws {RequiredError}
220
+ */
221
+ getFinancialTransaction(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetFinancialTransactionResponseClass> {
222
+ return localVarFp.getFinancialTransaction(code, expand, authorization, options).then((request) => request(axios, basePath));
223
+ },
224
+ /**
225
+ * This endpoint list financial transactions.
226
+ * @summary List financial transactions
227
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
228
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
229
+ * @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.
230
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
231
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
232
+ * @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.
233
+ * @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.
234
+ * @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.
235
+ * @param {*} [options] Override http request option.
236
+ * @throws {RequiredError}
237
+ */
238
+ listFinancialTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListFinancialTransactionsResponseClass> {
239
+ return localVarFp.listFinancialTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
240
+ },
241
+ };
242
+ };
243
+
244
+ /**
245
+ * Request parameters for getFinancialTransaction operation in FinancialTransactionsApi.
246
+ * @export
247
+ * @interface FinancialTransactionsApiGetFinancialTransactionRequest
248
+ */
249
+ export interface FinancialTransactionsApiGetFinancialTransactionRequest {
250
+ /**
251
+ *
252
+ * @type {string}
253
+ * @memberof FinancialTransactionsApiGetFinancialTransaction
254
+ */
255
+ readonly code: string
256
+
257
+ /**
258
+ *
259
+ * @type {string}
260
+ * @memberof FinancialTransactionsApiGetFinancialTransaction
261
+ */
262
+ readonly expand: string
263
+
264
+ /**
265
+ * Bearer Token: provided by the login endpoint under the name accessToken.
266
+ * @type {string}
267
+ * @memberof FinancialTransactionsApiGetFinancialTransaction
268
+ */
269
+ readonly authorization?: string
270
+ }
271
+
272
+ /**
273
+ * Request parameters for listFinancialTransactions operation in FinancialTransactionsApi.
274
+ * @export
275
+ * @interface FinancialTransactionsApiListFinancialTransactionsRequest
276
+ */
277
+ export interface FinancialTransactionsApiListFinancialTransactionsRequest {
278
+ /**
279
+ * Bearer Token: provided by the login endpoint under the name accessToken.
280
+ * @type {string}
281
+ * @memberof FinancialTransactionsApiListFinancialTransactions
282
+ */
283
+ readonly authorization?: string
284
+
285
+ /**
286
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
287
+ * @type {any}
288
+ * @memberof FinancialTransactionsApiListFinancialTransactions
289
+ */
290
+ readonly pageSize?: any
291
+
292
+ /**
293
+ * 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.
294
+ * @type {any}
295
+ * @memberof FinancialTransactionsApiListFinancialTransactions
296
+ */
297
+ readonly pageToken?: any
298
+
299
+ /**
300
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
301
+ * @type {any}
302
+ * @memberof FinancialTransactionsApiListFinancialTransactions
303
+ */
304
+ readonly filter?: any
305
+
306
+ /**
307
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
308
+ * @type {any}
309
+ * @memberof FinancialTransactionsApiListFinancialTransactions
310
+ */
311
+ readonly search?: any
312
+
313
+ /**
314
+ * 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.
315
+ * @type {any}
316
+ * @memberof FinancialTransactionsApiListFinancialTransactions
317
+ */
318
+ readonly order?: any
319
+
320
+ /**
321
+ * 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.
322
+ * @type {any}
323
+ * @memberof FinancialTransactionsApiListFinancialTransactions
324
+ */
325
+ readonly expand?: any
326
+
327
+ /**
328
+ * 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.
329
+ * @type {any}
330
+ * @memberof FinancialTransactionsApiListFinancialTransactions
331
+ */
332
+ readonly filters?: any
333
+ }
334
+
335
+ /**
336
+ * FinancialTransactionsApi - object-oriented interface
337
+ * @export
338
+ * @class FinancialTransactionsApi
339
+ * @extends {BaseAPI}
340
+ */
341
+ export class FinancialTransactionsApi extends BaseAPI {
342
+ /**
343
+ * This endpoint gets a financial transaction.
344
+ * @summary Retrieve the financial transaction
345
+ * @param {FinancialTransactionsApiGetFinancialTransactionRequest} requestParameters Request parameters.
346
+ * @param {*} [options] Override http request option.
347
+ * @throws {RequiredError}
348
+ * @memberof FinancialTransactionsApi
349
+ */
350
+ public getFinancialTransaction(requestParameters: FinancialTransactionsApiGetFinancialTransactionRequest, options?: AxiosRequestConfig) {
351
+ return FinancialTransactionsApiFp(this.configuration).getFinancialTransaction(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
352
+ }
353
+
354
+ /**
355
+ * This endpoint list financial transactions.
356
+ * @summary List financial transactions
357
+ * @param {FinancialTransactionsApiListFinancialTransactionsRequest} requestParameters Request parameters.
358
+ * @param {*} [options] Override http request option.
359
+ * @throws {RequiredError}
360
+ * @memberof FinancialTransactionsApi
361
+ */
362
+ public listFinancialTransactions(requestParameters: FinancialTransactionsApiListFinancialTransactionsRequest = {}, options?: AxiosRequestConfig) {
363
+ 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));
364
+ }
365
+ }
package/api.ts CHANGED
@@ -22,12 +22,14 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
23
23
  import { BookingEntriesApi } from './api';
24
24
  import { FinancialAccountsApi } from './api';
25
+ import { FinancialTransactionsApi } from './api';
25
26
  import { HealthApi } from './api';
26
27
  import { PersonalAccountsApi } from './api';
27
28
 
28
29
 
29
30
  export * from './api/booking-entries-api';
30
31
  export * from './api/financial-accounts-api';
32
+ export * from './api/financial-transactions-api';
31
33
  export * from './api/health-api';
32
34
  export * from './api/personal-accounts-api';
33
35
 
@@ -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
+ }