@emilgroup/accounting-sdk-node 1.0.1-beta.0 → 1.0.1-beta.2

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.
Files changed (32) hide show
  1. package/.openapi-generator/FILES +7 -0
  2. package/README.md +2 -2
  3. package/api/financial-accounts-api.ts +12 -6
  4. package/api/transactions-api.ts +192 -2
  5. package/dist/api/financial-accounts-api.d.ts +12 -9
  6. package/dist/api/transactions-api.d.ts +114 -3
  7. package/dist/api/transactions-api.js +129 -0
  8. package/dist/models/create-financial-account-response-class.d.ts +25 -0
  9. package/dist/models/create-financial-account-response-class.js +15 -0
  10. package/dist/models/create-transaction-response-class.d.ts +25 -0
  11. package/dist/models/create-transaction-response-class.js +15 -0
  12. package/dist/models/financial-account-class.d.ts +86 -0
  13. package/dist/models/financial-account-class.js +23 -0
  14. package/dist/models/get-financial-account-response-class.d.ts +25 -0
  15. package/dist/models/get-financial-account-response-class.js +15 -0
  16. package/dist/models/index.d.ts +7 -0
  17. package/dist/models/index.js +7 -0
  18. package/dist/models/list-financial-accounts-response-class.d.ts +31 -0
  19. package/dist/models/list-financial-accounts-response-class.js +15 -0
  20. package/dist/models/list-transactions-response-class.d.ts +31 -0
  21. package/dist/models/list-transactions-response-class.js +15 -0
  22. package/dist/models/transaction-class.d.ts +78 -0
  23. package/dist/models/transaction-class.js +15 -0
  24. package/models/create-financial-account-response-class.ts +31 -0
  25. package/models/create-transaction-response-class.ts +31 -0
  26. package/models/financial-account-class.ts +95 -0
  27. package/models/get-financial-account-response-class.ts +31 -0
  28. package/models/index.ts +7 -0
  29. package/models/list-financial-accounts-response-class.ts +37 -0
  30. package/models/list-transactions-response-class.ts +37 -0
  31. package/models/transaction-class.ts +84 -0
  32. package/package.json +1 -1
@@ -12,10 +12,17 @@ configuration.ts
12
12
  git_push.sh
13
13
  index.ts
14
14
  models/create-financial-account-request-dto.ts
15
+ models/create-financial-account-response-class.ts
15
16
  models/create-transaction-request-dto.ts
17
+ models/create-transaction-response-class.ts
16
18
  models/entry-data-dto.ts
19
+ models/financial-account-class.ts
20
+ models/get-financial-account-response-class.ts
17
21
  models/index.ts
18
22
  models/inline-response200.ts
19
23
  models/inline-response503.ts
24
+ models/list-financial-accounts-response-class.ts
25
+ models/list-transactions-response-class.ts
26
+ models/transaction-class.ts
20
27
  package.json
21
28
  tsconfig.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.0.1-beta.0 --save
20
+ npm install @emilgroup/accounting-sdk-node@1.0.1-beta.2 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/accounting-sdk-node@1.0.1-beta.0
24
+ yarn add @emilgroup/accounting-sdk-node@1.0.1-beta.2
25
25
  ```
26
26
 
27
27
  And then you can import `FinancialAccountsApi`.
@@ -22,6 +22,12 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
23
  // @ts-ignore
24
24
  import { CreateFinancialAccountRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { CreateFinancialAccountResponseClass } from '../models';
27
+ // @ts-ignore
28
+ import { GetFinancialAccountResponseClass } from '../models';
29
+ // @ts-ignore
30
+ import { ListFinancialAccountsResponseClass } from '../models';
25
31
  // URLSearchParams not necessarily used
26
32
  // @ts-ignore
27
33
  import { URL, URLSearchParams } from 'url';
@@ -270,7 +276,7 @@ export const FinancialAccountsApiFp = function(configuration?: Configuration) {
270
276
  * @param {*} [options] Override http request option.
271
277
  * @throws {RequiredError}
272
278
  */
273
- async createFinancialAccount(createFinancialAccountRequestDto: CreateFinancialAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
279
+ async createFinancialAccount(createFinancialAccountRequestDto: CreateFinancialAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFinancialAccountResponseClass>> {
274
280
  const localVarAxiosArgs = await localVarAxiosParamCreator.createFinancialAccount(createFinancialAccountRequestDto, authorization, options);
275
281
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
276
282
  },
@@ -295,7 +301,7 @@ export const FinancialAccountsApiFp = function(configuration?: Configuration) {
295
301
  * @param {*} [options] Override http request option.
296
302
  * @throws {RequiredError}
297
303
  */
298
- async getFinancialAccount(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
304
+ async getFinancialAccount(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFinancialAccountResponseClass>> {
299
305
  const localVarAxiosArgs = await localVarAxiosParamCreator.getFinancialAccount(code, expand, authorization, options);
300
306
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
301
307
  },
@@ -313,7 +319,7 @@ export const FinancialAccountsApiFp = function(configuration?: Configuration) {
313
319
  * @param {*} [options] Override http request option.
314
320
  * @throws {RequiredError}
315
321
  */
316
- async listFinancialAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
322
+ async listFinancialAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialAccountsResponseClass>> {
317
323
  const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
318
324
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
319
325
  },
@@ -335,7 +341,7 @@ export const FinancialAccountsApiFactory = function (configuration?: Configurati
335
341
  * @param {*} [options] Override http request option.
336
342
  * @throws {RequiredError}
337
343
  */
338
- createFinancialAccount(createFinancialAccountRequestDto: CreateFinancialAccountRequestDto, authorization?: string, options?: any): AxiosPromise<void> {
344
+ createFinancialAccount(createFinancialAccountRequestDto: CreateFinancialAccountRequestDto, authorization?: string, options?: any): AxiosPromise<CreateFinancialAccountResponseClass> {
339
345
  return localVarFp.createFinancialAccount(createFinancialAccountRequestDto, authorization, options).then((request) => request(axios, basePath));
340
346
  },
341
347
  /**
@@ -358,7 +364,7 @@ export const FinancialAccountsApiFactory = function (configuration?: Configurati
358
364
  * @param {*} [options] Override http request option.
359
365
  * @throws {RequiredError}
360
366
  */
361
- getFinancialAccount(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<void> {
367
+ getFinancialAccount(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetFinancialAccountResponseClass> {
362
368
  return localVarFp.getFinancialAccount(code, expand, authorization, options).then((request) => request(axios, basePath));
363
369
  },
364
370
  /**
@@ -375,7 +381,7 @@ export const FinancialAccountsApiFactory = function (configuration?: Configurati
375
381
  * @param {*} [options] Override http request option.
376
382
  * @throws {RequiredError}
377
383
  */
378
- listFinancialAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: any): AxiosPromise<void> {
384
+ listFinancialAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: any): AxiosPromise<ListFinancialAccountsResponseClass> {
379
385
  return localVarFp.listFinancialAccounts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
380
386
  },
381
387
  };
@@ -22,6 +22,10 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
23
  // @ts-ignore
24
24
  import { CreateTransactionRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { CreateTransactionResponseClass } from '../models';
27
+ // @ts-ignore
28
+ import { ListTransactionsResponseClass } from '../models';
25
29
  // URLSearchParams not necessarily used
26
30
  // @ts-ignore
27
31
  import { URL, URLSearchParams } from 'url';
@@ -74,6 +78,82 @@ export const TransactionsApiAxiosParamCreator = function (configuration?: Config
74
78
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
75
79
  localVarRequestOptions.data = serializeDataIfNeeded(createTransactionRequestDto, localVarRequestOptions, configuration)
76
80
 
81
+ return {
82
+ url: toPathString(localVarUrlObj),
83
+ options: localVarRequestOptions,
84
+ };
85
+ },
86
+ /**
87
+ * Returns a list of Transactions you have previously created. The Transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
88
+ * @summary List Transactions
89
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
90
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
91
+ * @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.
92
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, date, reference, policyNumber, accountNumber&lt;/i&gt;
93
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
94
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, date, reference, policyNumber, accountNumber, updatedAt, createdAt&lt;/i&gt;
95
+ * @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.
96
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, date, reference, policyNumber, accountNumber&lt;/i&gt;
97
+ * @param {*} [options] Override http request option.
98
+ * @throws {RequiredError}
99
+ */
100
+ listTransactions: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
101
+ const localVarPath = `/accountingservice/v1/transactions`;
102
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
103
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
104
+ let baseOptions;
105
+ let baseAccessToken;
106
+ if (configuration) {
107
+ baseOptions = configuration.baseOptions;
108
+ baseAccessToken = configuration.accessToken;
109
+ }
110
+
111
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
112
+ const localVarHeaderParameter = {} as any;
113
+ const localVarQueryParameter = {} as any;
114
+
115
+ // authentication bearer required
116
+ // http bearer authentication required
117
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
118
+
119
+ if (pageSize !== undefined) {
120
+ localVarQueryParameter['pageSize'] = pageSize;
121
+ }
122
+
123
+ if (pageToken !== undefined) {
124
+ localVarQueryParameter['pageToken'] = pageToken;
125
+ }
126
+
127
+ if (filter !== undefined) {
128
+ localVarQueryParameter['filter'] = filter;
129
+ }
130
+
131
+ if (search !== undefined) {
132
+ localVarQueryParameter['search'] = search;
133
+ }
134
+
135
+ if (order !== undefined) {
136
+ localVarQueryParameter['order'] = order;
137
+ }
138
+
139
+ if (expand !== undefined) {
140
+ localVarQueryParameter['expand'] = expand;
141
+ }
142
+
143
+ if (filters !== undefined) {
144
+ localVarQueryParameter['filters'] = filters;
145
+ }
146
+
147
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
148
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
149
+ }
150
+
151
+
152
+
153
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
154
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
155
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
156
+
77
157
  return {
78
158
  url: toPathString(localVarUrlObj),
79
159
  options: localVarRequestOptions,
@@ -97,10 +177,28 @@ export const TransactionsApiFp = function(configuration?: Configuration) {
97
177
  * @param {*} [options] Override http request option.
98
178
  * @throws {RequiredError}
99
179
  */
100
- async createTransaction(createTransactionRequestDto: CreateTransactionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
180
+ async createTransaction(createTransactionRequestDto: CreateTransactionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTransactionResponseClass>> {
101
181
  const localVarAxiosArgs = await localVarAxiosParamCreator.createTransaction(createTransactionRequestDto, authorization, options);
102
182
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
103
183
  },
184
+ /**
185
+ * Returns a list of Transactions you have previously created. The Transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
186
+ * @summary List 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 {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, date, reference, policyNumber, accountNumber&lt;/i&gt;
191
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
192
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, date, reference, policyNumber, accountNumber, updatedAt, createdAt&lt;/i&gt;
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 {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, date, reference, policyNumber, accountNumber&lt;/i&gt;
195
+ * @param {*} [options] Override http request option.
196
+ * @throws {RequiredError}
197
+ */
198
+ async listTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransactionsResponseClass>> {
199
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
200
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
201
+ },
104
202
  }
105
203
  };
106
204
 
@@ -119,9 +217,26 @@ export const TransactionsApiFactory = function (configuration?: Configuration, b
119
217
  * @param {*} [options] Override http request option.
120
218
  * @throws {RequiredError}
121
219
  */
122
- createTransaction(createTransactionRequestDto: CreateTransactionRequestDto, authorization?: string, options?: any): AxiosPromise<void> {
220
+ createTransaction(createTransactionRequestDto: CreateTransactionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateTransactionResponseClass> {
123
221
  return localVarFp.createTransaction(createTransactionRequestDto, authorization, options).then((request) => request(axios, basePath));
124
222
  },
223
+ /**
224
+ * Returns a list of Transactions you have previously created. The Transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
225
+ * @summary List Transactions
226
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
227
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
228
+ * @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.
229
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, date, reference, policyNumber, accountNumber&lt;/i&gt;
230
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
231
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, date, reference, policyNumber, accountNumber, updatedAt, createdAt&lt;/i&gt;
232
+ * @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.
233
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, date, reference, policyNumber, accountNumber&lt;/i&gt;
234
+ * @param {*} [options] Override http request option.
235
+ * @throws {RequiredError}
236
+ */
237
+ listTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: any): AxiosPromise<ListTransactionsResponseClass> {
238
+ return localVarFp.listTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
239
+ },
125
240
  };
126
241
  };
127
242
 
@@ -146,6 +261,69 @@ export interface TransactionsApiCreateTransactionRequest {
146
261
  readonly authorization?: string
147
262
  }
148
263
 
264
+ /**
265
+ * Request parameters for listTransactions operation in TransactionsApi.
266
+ * @export
267
+ * @interface TransactionsApiListTransactionsRequest
268
+ */
269
+ export interface TransactionsApiListTransactionsRequest {
270
+ /**
271
+ * Bearer Token: provided by the login endpoint under the name accessToken.
272
+ * @type {string}
273
+ * @memberof TransactionsApiListTransactions
274
+ */
275
+ readonly authorization?: string
276
+
277
+ /**
278
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
279
+ * @type {any}
280
+ * @memberof TransactionsApiListTransactions
281
+ */
282
+ readonly pageSize?: any
283
+
284
+ /**
285
+ * 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.
286
+ * @type {any}
287
+ * @memberof TransactionsApiListTransactions
288
+ */
289
+ readonly pageToken?: any
290
+
291
+ /**
292
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, date, reference, policyNumber, accountNumber&lt;/i&gt;
293
+ * @type {string}
294
+ * @memberof TransactionsApiListTransactions
295
+ */
296
+ readonly filter?: string
297
+
298
+ /**
299
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
300
+ * @type {any}
301
+ * @memberof TransactionsApiListTransactions
302
+ */
303
+ readonly search?: any
304
+
305
+ /**
306
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, date, reference, policyNumber, accountNumber, updatedAt, createdAt&lt;/i&gt;
307
+ * @type {string}
308
+ * @memberof TransactionsApiListTransactions
309
+ */
310
+ readonly order?: string
311
+
312
+ /**
313
+ * 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.
314
+ * @type {any}
315
+ * @memberof TransactionsApiListTransactions
316
+ */
317
+ readonly expand?: any
318
+
319
+ /**
320
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, date, reference, policyNumber, accountNumber&lt;/i&gt;
321
+ * @type {string}
322
+ * @memberof TransactionsApiListTransactions
323
+ */
324
+ readonly filters?: string
325
+ }
326
+
149
327
  /**
150
328
  * TransactionsApi - object-oriented interface
151
329
  * @export
@@ -164,4 +342,16 @@ export class TransactionsApi extends BaseAPI {
164
342
  public createTransaction(requestParameters: TransactionsApiCreateTransactionRequest, options?: AxiosRequestConfig) {
165
343
  return TransactionsApiFp(this.configuration).createTransaction(requestParameters.createTransactionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
166
344
  }
345
+
346
+ /**
347
+ * Returns a list of Transactions you have previously created. The Transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
348
+ * @summary List Transactions
349
+ * @param {TransactionsApiListTransactionsRequest} requestParameters Request parameters.
350
+ * @param {*} [options] Override http request option.
351
+ * @throws {RequiredError}
352
+ * @memberof TransactionsApi
353
+ */
354
+ public listTransactions(requestParameters: TransactionsApiListTransactionsRequest = {}, options?: AxiosRequestConfig) {
355
+ return TransactionsApiFp(this.configuration).listTransactions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
356
+ }
167
357
  }
@@ -13,6 +13,9 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreateFinancialAccountRequestDto } from '../models';
16
+ import { CreateFinancialAccountResponseClass } from '../models';
17
+ import { GetFinancialAccountResponseClass } from '../models';
18
+ import { ListFinancialAccountsResponseClass } from '../models';
16
19
  /**
17
20
  * FinancialAccountsApi - axios parameter creator
18
21
  * @export
@@ -75,7 +78,7 @@ export declare const FinancialAccountsApiFp: (configuration?: Configuration) =>
75
78
  * @param {*} [options] Override http request option.
76
79
  * @throws {RequiredError}
77
80
  */
78
- createFinancialAccount(createFinancialAccountRequestDto: CreateFinancialAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
81
+ createFinancialAccount(createFinancialAccountRequestDto: CreateFinancialAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFinancialAccountResponseClass>>;
79
82
  /**
80
83
  * Permanently deletes the account. Supply the unique code that was returned when you created the account and this will delete it.
81
84
  * @summary Delete the account
@@ -94,7 +97,7 @@ export declare const FinancialAccountsApiFp: (configuration?: Configuration) =>
94
97
  * @param {*} [options] Override http request option.
95
98
  * @throws {RequiredError}
96
99
  */
97
- getFinancialAccount(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
100
+ getFinancialAccount(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFinancialAccountResponseClass>>;
98
101
  /**
99
102
  * Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
100
103
  * @summary List Financial Accounts
@@ -109,7 +112,7 @@ export declare const FinancialAccountsApiFp: (configuration?: Configuration) =>
109
112
  * @param {*} [options] Override http request option.
110
113
  * @throws {RequiredError}
111
114
  */
112
- listFinancialAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
115
+ listFinancialAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialAccountsResponseClass>>;
113
116
  };
114
117
  /**
115
118
  * FinancialAccountsApi - factory interface
@@ -124,7 +127,7 @@ export declare const FinancialAccountsApiFactory: (configuration?: Configuration
124
127
  * @param {*} [options] Override http request option.
125
128
  * @throws {RequiredError}
126
129
  */
127
- createFinancialAccount(createFinancialAccountRequestDto: CreateFinancialAccountRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
130
+ createFinancialAccount(createFinancialAccountRequestDto: CreateFinancialAccountRequestDto, authorization?: string, options?: any): AxiosPromise<CreateFinancialAccountResponseClass>;
128
131
  /**
129
132
  * Permanently deletes the account. Supply the unique code that was returned when you created the account and this will delete it.
130
133
  * @summary Delete the account
@@ -143,7 +146,7 @@ export declare const FinancialAccountsApiFactory: (configuration?: Configuration
143
146
  * @param {*} [options] Override http request option.
144
147
  * @throws {RequiredError}
145
148
  */
146
- getFinancialAccount(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<void>;
149
+ getFinancialAccount(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetFinancialAccountResponseClass>;
147
150
  /**
148
151
  * Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
149
152
  * @summary List Financial Accounts
@@ -158,7 +161,7 @@ export declare const FinancialAccountsApiFactory: (configuration?: Configuration
158
161
  * @param {*} [options] Override http request option.
159
162
  * @throws {RequiredError}
160
163
  */
161
- listFinancialAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: any): AxiosPromise<void>;
164
+ listFinancialAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: any): AxiosPromise<ListFinancialAccountsResponseClass>;
162
165
  };
163
166
  /**
164
167
  * Request parameters for createFinancialAccount operation in FinancialAccountsApi.
@@ -293,7 +296,7 @@ export declare class FinancialAccountsApi extends BaseAPI {
293
296
  * @throws {RequiredError}
294
297
  * @memberof FinancialAccountsApi
295
298
  */
296
- createFinancialAccount(requestParameters: FinancialAccountsApiCreateFinancialAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
299
+ createFinancialAccount(requestParameters: FinancialAccountsApiCreateFinancialAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateFinancialAccountResponseClass, any>>;
297
300
  /**
298
301
  * Permanently deletes the account. Supply the unique code that was returned when you created the account and this will delete it.
299
302
  * @summary Delete the account
@@ -311,7 +314,7 @@ export declare class FinancialAccountsApi extends BaseAPI {
311
314
  * @throws {RequiredError}
312
315
  * @memberof FinancialAccountsApi
313
316
  */
314
- getFinancialAccount(requestParameters: FinancialAccountsApiGetFinancialAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
317
+ getFinancialAccount(requestParameters: FinancialAccountsApiGetFinancialAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFinancialAccountResponseClass, any>>;
315
318
  /**
316
319
  * Returns a list of Financial Accounts you have previously created. The Financial Accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
317
320
  * @summary List Financial Accounts
@@ -320,5 +323,5 @@ export declare class FinancialAccountsApi extends BaseAPI {
320
323
  * @throws {RequiredError}
321
324
  * @memberof FinancialAccountsApi
322
325
  */
323
- listFinancialAccounts(requestParameters?: FinancialAccountsApiListFinancialAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
326
+ listFinancialAccounts(requestParameters?: FinancialAccountsApiListFinancialAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFinancialAccountsResponseClass, any>>;
324
327
  }
@@ -13,6 +13,8 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreateTransactionRequestDto } from '../models';
16
+ import { CreateTransactionResponseClass } from '../models';
17
+ import { ListTransactionsResponseClass } from '../models';
16
18
  /**
17
19
  * TransactionsApi - axios parameter creator
18
20
  * @export
@@ -27,6 +29,21 @@ export declare const TransactionsApiAxiosParamCreator: (configuration?: Configur
27
29
  * @throws {RequiredError}
28
30
  */
29
31
  createTransaction: (createTransactionRequestDto: CreateTransactionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
32
+ /**
33
+ * Returns a list of Transactions you have previously created. The Transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
34
+ * @summary List 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 {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, date, reference, policyNumber, accountNumber&lt;/i&gt;
39
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
40
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, date, reference, policyNumber, accountNumber, updatedAt, createdAt&lt;/i&gt;
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 {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, date, reference, policyNumber, accountNumber&lt;/i&gt;
43
+ * @param {*} [options] Override http request option.
44
+ * @throws {RequiredError}
45
+ */
46
+ listTransactions: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
30
47
  };
31
48
  /**
32
49
  * TransactionsApi - functional programming interface
@@ -41,7 +58,22 @@ export declare const TransactionsApiFp: (configuration?: Configuration) => {
41
58
  * @param {*} [options] Override http request option.
42
59
  * @throws {RequiredError}
43
60
  */
44
- createTransaction(createTransactionRequestDto: CreateTransactionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
61
+ createTransaction(createTransactionRequestDto: CreateTransactionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTransactionResponseClass>>;
62
+ /**
63
+ * Returns a list of Transactions you have previously created. The Transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
64
+ * @summary List Transactions
65
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
66
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
67
+ * @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.
68
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, date, reference, policyNumber, accountNumber&lt;/i&gt;
69
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
70
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, date, reference, policyNumber, accountNumber, updatedAt, createdAt&lt;/i&gt;
71
+ * @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.
72
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, date, reference, policyNumber, accountNumber&lt;/i&gt;
73
+ * @param {*} [options] Override http request option.
74
+ * @throws {RequiredError}
75
+ */
76
+ listTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransactionsResponseClass>>;
45
77
  };
46
78
  /**
47
79
  * TransactionsApi - factory interface
@@ -56,7 +88,22 @@ export declare const TransactionsApiFactory: (configuration?: Configuration, bas
56
88
  * @param {*} [options] Override http request option.
57
89
  * @throws {RequiredError}
58
90
  */
59
- createTransaction(createTransactionRequestDto: CreateTransactionRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
91
+ createTransaction(createTransactionRequestDto: CreateTransactionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateTransactionResponseClass>;
92
+ /**
93
+ * Returns a list of Transactions you have previously created. The Transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
94
+ * @summary List Transactions
95
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
96
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
97
+ * @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.
98
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, date, reference, policyNumber, accountNumber&lt;/i&gt;
99
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
100
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, date, reference, policyNumber, accountNumber, updatedAt, createdAt&lt;/i&gt;
101
+ * @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.
102
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, date, reference, policyNumber, accountNumber&lt;/i&gt;
103
+ * @param {*} [options] Override http request option.
104
+ * @throws {RequiredError}
105
+ */
106
+ listTransactions(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: any): AxiosPromise<ListTransactionsResponseClass>;
60
107
  };
61
108
  /**
62
109
  * Request parameters for createTransaction operation in TransactionsApi.
@@ -77,6 +124,61 @@ export interface TransactionsApiCreateTransactionRequest {
77
124
  */
78
125
  readonly authorization?: string;
79
126
  }
127
+ /**
128
+ * Request parameters for listTransactions operation in TransactionsApi.
129
+ * @export
130
+ * @interface TransactionsApiListTransactionsRequest
131
+ */
132
+ export interface TransactionsApiListTransactionsRequest {
133
+ /**
134
+ * Bearer Token: provided by the login endpoint under the name accessToken.
135
+ * @type {string}
136
+ * @memberof TransactionsApiListTransactions
137
+ */
138
+ readonly authorization?: string;
139
+ /**
140
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
141
+ * @type {any}
142
+ * @memberof TransactionsApiListTransactions
143
+ */
144
+ readonly pageSize?: any;
145
+ /**
146
+ * 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.
147
+ * @type {any}
148
+ * @memberof TransactionsApiListTransactions
149
+ */
150
+ readonly pageToken?: any;
151
+ /**
152
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, date, reference, policyNumber, accountNumber&lt;/i&gt;
153
+ * @type {string}
154
+ * @memberof TransactionsApiListTransactions
155
+ */
156
+ readonly filter?: string;
157
+ /**
158
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
159
+ * @type {any}
160
+ * @memberof TransactionsApiListTransactions
161
+ */
162
+ readonly search?: any;
163
+ /**
164
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, date, reference, policyNumber, accountNumber, updatedAt, createdAt&lt;/i&gt;
165
+ * @type {string}
166
+ * @memberof TransactionsApiListTransactions
167
+ */
168
+ readonly order?: string;
169
+ /**
170
+ * 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.
171
+ * @type {any}
172
+ * @memberof TransactionsApiListTransactions
173
+ */
174
+ readonly expand?: any;
175
+ /**
176
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, date, reference, policyNumber, accountNumber&lt;/i&gt;
177
+ * @type {string}
178
+ * @memberof TransactionsApiListTransactions
179
+ */
180
+ readonly filters?: string;
181
+ }
80
182
  /**
81
183
  * TransactionsApi - object-oriented interface
82
184
  * @export
@@ -92,5 +194,14 @@ export declare class TransactionsApi extends BaseAPI {
92
194
  * @throws {RequiredError}
93
195
  * @memberof TransactionsApi
94
196
  */
95
- createTransaction(requestParameters: TransactionsApiCreateTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
197
+ createTransaction(requestParameters: TransactionsApiCreateTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTransactionResponseClass, any>>;
198
+ /**
199
+ * Returns a list of Transactions you have previously created. The Transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
200
+ * @summary List Transactions
201
+ * @param {TransactionsApiListTransactionsRequest} requestParameters Request parameters.
202
+ * @param {*} [options] Override http request option.
203
+ * @throws {RequiredError}
204
+ * @memberof TransactionsApi
205
+ */
206
+ listTransactions(requestParameters?: TransactionsApiListTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTransactionsResponseClass, any>>;
96
207
  }