@emilgroup/commission-sdk-node 1.0.0-beta.1 → 1.0.0-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api/commission-agreement-versions-api.ts +67 -25
- package/api/commission-agreements-api.ts +55 -13
- package/api/commissions-api.ts +78 -22
- package/dist/api/commission-agreement-versions-api.d.ts +47 -20
- package/dist/api/commission-agreement-versions-api.js +38 -20
- package/dist/api/commission-agreements-api.d.ts +35 -8
- package/dist/api/commission-agreements-api.js +29 -11
- package/dist/api/commissions-api.d.ts +53 -17
- package/dist/api/commissions-api.js +41 -17
- package/package.json +1 -1
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/commission-sdk-node@1.0.0-beta.
|
|
20
|
+
npm install @emilgroup/commission-sdk-node@1.0.0-beta.3 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/commission-sdk-node@1.0.0-beta.
|
|
24
|
+
yarn add @emilgroup/commission-sdk-node@1.0.0-beta.3
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `CommissionApi`.
|
|
@@ -186,14 +186,17 @@ export const CommissionAgreementVersionsApiAxiosParamCreator = function (configu
|
|
|
186
186
|
* Retrieves a list of commission agreement versions.
|
|
187
187
|
* @summary List commission agreement versions
|
|
188
188
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
189
|
-
* @param {
|
|
190
|
-
* @param {string} [
|
|
191
|
-
* @param {string} [
|
|
192
|
-
* @param {string} [
|
|
189
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
190
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
191
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
192
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
193
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, createdAt, startDate, endDate</i>
|
|
194
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: agreements<i>
|
|
195
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
193
196
|
* @param {*} [options] Override http request option.
|
|
194
197
|
* @throws {RequiredError}
|
|
195
198
|
*/
|
|
196
|
-
listCommissionAgreementVersions: async (authorization?: string, filter?: string,
|
|
199
|
+
listCommissionAgreementVersions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
197
200
|
const localVarPath = `/commissionservice/v1/agreement-versions`;
|
|
198
201
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
199
202
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -212,12 +215,20 @@ export const CommissionAgreementVersionsApiAxiosParamCreator = function (configu
|
|
|
212
215
|
// http bearer authentication required
|
|
213
216
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
214
217
|
|
|
218
|
+
if (pageSize !== undefined) {
|
|
219
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
if (pageToken !== undefined) {
|
|
223
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
224
|
+
}
|
|
225
|
+
|
|
215
226
|
if (filter !== undefined) {
|
|
216
227
|
localVarQueryParameter['filter'] = filter;
|
|
217
228
|
}
|
|
218
229
|
|
|
219
|
-
if (
|
|
220
|
-
localVarQueryParameter['
|
|
230
|
+
if (search !== undefined) {
|
|
231
|
+
localVarQueryParameter['search'] = search;
|
|
221
232
|
}
|
|
222
233
|
|
|
223
234
|
if (order !== undefined) {
|
|
@@ -228,6 +239,10 @@ export const CommissionAgreementVersionsApiAxiosParamCreator = function (configu
|
|
|
228
239
|
localVarQueryParameter['expand'] = expand;
|
|
229
240
|
}
|
|
230
241
|
|
|
242
|
+
if (filters !== undefined) {
|
|
243
|
+
localVarQueryParameter['filters'] = filters;
|
|
244
|
+
}
|
|
245
|
+
|
|
231
246
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
232
247
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
233
248
|
}
|
|
@@ -294,15 +309,18 @@ export const CommissionAgreementVersionsApiFp = function(configuration?: Configu
|
|
|
294
309
|
* Retrieves a list of commission agreement versions.
|
|
295
310
|
* @summary List commission agreement versions
|
|
296
311
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
297
|
-
* @param {
|
|
298
|
-
* @param {string} [
|
|
299
|
-
* @param {string} [
|
|
300
|
-
* @param {string} [
|
|
312
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
313
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
314
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
315
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
316
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, createdAt, startDate, endDate</i>
|
|
317
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: agreements<i>
|
|
318
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
301
319
|
* @param {*} [options] Override http request option.
|
|
302
320
|
* @throws {RequiredError}
|
|
303
321
|
*/
|
|
304
|
-
async listCommissionAgreementVersions(authorization?: string, filter?: string,
|
|
305
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAgreementVersions(authorization, filter,
|
|
322
|
+
async listCommissionAgreementVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementVersionsResponseClass>> {
|
|
323
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAgreementVersions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
306
324
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
307
325
|
},
|
|
308
326
|
}
|
|
@@ -353,15 +371,18 @@ export const CommissionAgreementVersionsApiFactory = function (configuration?: C
|
|
|
353
371
|
* Retrieves a list of commission agreement versions.
|
|
354
372
|
* @summary List commission agreement versions
|
|
355
373
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
356
|
-
* @param {
|
|
357
|
-
* @param {string} [
|
|
358
|
-
* @param {string} [
|
|
359
|
-
* @param {string} [
|
|
374
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
375
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
376
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
377
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
378
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, createdAt, startDate, endDate</i>
|
|
379
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: agreements<i>
|
|
380
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
360
381
|
* @param {*} [options] Override http request option.
|
|
361
382
|
* @throws {RequiredError}
|
|
362
383
|
*/
|
|
363
|
-
listCommissionAgreementVersions(authorization?: string, filter?: string,
|
|
364
|
-
return localVarFp.listCommissionAgreementVersions(authorization, filter,
|
|
384
|
+
listCommissionAgreementVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAgreementVersionsResponseClass> {
|
|
385
|
+
return localVarFp.listCommissionAgreementVersions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
365
386
|
},
|
|
366
387
|
};
|
|
367
388
|
};
|
|
@@ -450,32 +471,53 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
450
471
|
readonly authorization?: string
|
|
451
472
|
|
|
452
473
|
/**
|
|
453
|
-
*
|
|
474
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
475
|
+
* @type {number}
|
|
476
|
+
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
477
|
+
*/
|
|
478
|
+
readonly pageSize?: number
|
|
479
|
+
|
|
480
|
+
/**
|
|
481
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
482
|
+
* @type {string}
|
|
483
|
+
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
484
|
+
*/
|
|
485
|
+
readonly pageToken?: string
|
|
486
|
+
|
|
487
|
+
/**
|
|
488
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
454
489
|
* @type {string}
|
|
455
490
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
456
491
|
*/
|
|
457
492
|
readonly filter?: string
|
|
458
493
|
|
|
459
494
|
/**
|
|
460
|
-
*
|
|
495
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
461
496
|
* @type {string}
|
|
462
497
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
463
498
|
*/
|
|
464
|
-
readonly
|
|
499
|
+
readonly search?: string
|
|
465
500
|
|
|
466
501
|
/**
|
|
467
|
-
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, startDate, endDate</i>
|
|
502
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, createdAt, startDate, endDate</i>
|
|
468
503
|
* @type {string}
|
|
469
504
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
470
505
|
*/
|
|
471
506
|
readonly order?: string
|
|
472
507
|
|
|
473
508
|
/**
|
|
474
|
-
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
509
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: agreements<i>
|
|
475
510
|
* @type {string}
|
|
476
511
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
477
512
|
*/
|
|
478
513
|
readonly expand?: string
|
|
514
|
+
|
|
515
|
+
/**
|
|
516
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
517
|
+
* @type {string}
|
|
518
|
+
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
519
|
+
*/
|
|
520
|
+
readonly filters?: string
|
|
479
521
|
}
|
|
480
522
|
|
|
481
523
|
/**
|
|
@@ -530,6 +572,6 @@ export class CommissionAgreementVersionsApi extends BaseAPI {
|
|
|
530
572
|
* @memberof CommissionAgreementVersionsApi
|
|
531
573
|
*/
|
|
532
574
|
public listCommissionAgreementVersions(requestParameters: CommissionAgreementVersionsApiListCommissionAgreementVersionsRequest = {}, options?: AxiosRequestConfig) {
|
|
533
|
-
return CommissionAgreementVersionsApiFp(this.configuration).listCommissionAgreementVersions(requestParameters.authorization, requestParameters.filter, requestParameters.
|
|
575
|
+
return CommissionAgreementVersionsApiFp(this.configuration).listCommissionAgreementVersions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
534
576
|
}
|
|
535
577
|
}
|
|
@@ -190,14 +190,17 @@ export const CommissionAgreementsApiAxiosParamCreator = function (configuration?
|
|
|
190
190
|
* Retrieves a list of commission agreements.
|
|
191
191
|
* @summary List commission agreements
|
|
192
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
194
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
193
195
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
|
|
194
|
-
* @param {string} [
|
|
196
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
195
197
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
196
198
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
199
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
|
|
197
200
|
* @param {*} [options] Override http request option.
|
|
198
201
|
* @throws {RequiredError}
|
|
199
202
|
*/
|
|
200
|
-
listCommissionAgreements: async (authorization?: string, filter?: string,
|
|
203
|
+
listCommissionAgreements: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
201
204
|
const localVarPath = `/commissionservice/v1/agreements`;
|
|
202
205
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
203
206
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -216,12 +219,20 @@ export const CommissionAgreementsApiAxiosParamCreator = function (configuration?
|
|
|
216
219
|
// http bearer authentication required
|
|
217
220
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
218
221
|
|
|
222
|
+
if (pageSize !== undefined) {
|
|
223
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
if (pageToken !== undefined) {
|
|
227
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
228
|
+
}
|
|
229
|
+
|
|
219
230
|
if (filter !== undefined) {
|
|
220
231
|
localVarQueryParameter['filter'] = filter;
|
|
221
232
|
}
|
|
222
233
|
|
|
223
|
-
if (
|
|
224
|
-
localVarQueryParameter['
|
|
234
|
+
if (search !== undefined) {
|
|
235
|
+
localVarQueryParameter['search'] = search;
|
|
225
236
|
}
|
|
226
237
|
|
|
227
238
|
if (order !== undefined) {
|
|
@@ -232,6 +243,10 @@ export const CommissionAgreementsApiAxiosParamCreator = function (configuration?
|
|
|
232
243
|
localVarQueryParameter['expand'] = expand;
|
|
233
244
|
}
|
|
234
245
|
|
|
246
|
+
if (filters !== undefined) {
|
|
247
|
+
localVarQueryParameter['filters'] = filters;
|
|
248
|
+
}
|
|
249
|
+
|
|
235
250
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
236
251
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
237
252
|
}
|
|
@@ -345,15 +360,18 @@ export const CommissionAgreementsApiFp = function(configuration?: Configuration)
|
|
|
345
360
|
* Retrieves a list of commission agreements.
|
|
346
361
|
* @summary List commission agreements
|
|
347
362
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
363
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
364
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
348
365
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
|
|
349
|
-
* @param {string} [
|
|
366
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
350
367
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
351
368
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
369
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
|
|
352
370
|
* @param {*} [options] Override http request option.
|
|
353
371
|
* @throws {RequiredError}
|
|
354
372
|
*/
|
|
355
|
-
async listCommissionAgreements(authorization?: string, filter?: string,
|
|
356
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAgreements(authorization, filter,
|
|
373
|
+
async listCommissionAgreements(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementsResponseClass>> {
|
|
374
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAgreements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
357
375
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
358
376
|
},
|
|
359
377
|
/**
|
|
@@ -416,15 +434,18 @@ export const CommissionAgreementsApiFactory = function (configuration?: Configur
|
|
|
416
434
|
* Retrieves a list of commission agreements.
|
|
417
435
|
* @summary List commission agreements
|
|
418
436
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
437
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
438
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
419
439
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
|
|
420
|
-
* @param {string} [
|
|
440
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
421
441
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
422
442
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
443
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
|
|
423
444
|
* @param {*} [options] Override http request option.
|
|
424
445
|
* @throws {RequiredError}
|
|
425
446
|
*/
|
|
426
|
-
listCommissionAgreements(authorization?: string, filter?: string,
|
|
427
|
-
return localVarFp.listCommissionAgreements(authorization, filter,
|
|
447
|
+
listCommissionAgreements(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAgreementsResponseClass> {
|
|
448
|
+
return localVarFp.listCommissionAgreements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
428
449
|
},
|
|
429
450
|
/**
|
|
430
451
|
* This will update commission agreement.
|
|
@@ -523,6 +544,20 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
|
|
|
523
544
|
*/
|
|
524
545
|
readonly authorization?: string
|
|
525
546
|
|
|
547
|
+
/**
|
|
548
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
549
|
+
* @type {number}
|
|
550
|
+
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
551
|
+
*/
|
|
552
|
+
readonly pageSize?: number
|
|
553
|
+
|
|
554
|
+
/**
|
|
555
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
556
|
+
* @type {string}
|
|
557
|
+
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
558
|
+
*/
|
|
559
|
+
readonly pageToken?: string
|
|
560
|
+
|
|
526
561
|
/**
|
|
527
562
|
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
|
|
528
563
|
* @type {string}
|
|
@@ -531,11 +566,11 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
|
|
|
531
566
|
readonly filter?: string
|
|
532
567
|
|
|
533
568
|
/**
|
|
534
|
-
*
|
|
569
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
535
570
|
* @type {string}
|
|
536
571
|
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
537
572
|
*/
|
|
538
|
-
readonly
|
|
573
|
+
readonly search?: string
|
|
539
574
|
|
|
540
575
|
/**
|
|
541
576
|
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
@@ -550,6 +585,13 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
|
|
|
550
585
|
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
551
586
|
*/
|
|
552
587
|
readonly expand?: string
|
|
588
|
+
|
|
589
|
+
/**
|
|
590
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt</i>
|
|
591
|
+
* @type {string}
|
|
592
|
+
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
593
|
+
*/
|
|
594
|
+
readonly filters?: string
|
|
553
595
|
}
|
|
554
596
|
|
|
555
597
|
/**
|
|
@@ -625,7 +667,7 @@ export class CommissionAgreementsApi extends BaseAPI {
|
|
|
625
667
|
* @memberof CommissionAgreementsApi
|
|
626
668
|
*/
|
|
627
669
|
public listCommissionAgreements(requestParameters: CommissionAgreementsApiListCommissionAgreementsRequest = {}, options?: AxiosRequestConfig) {
|
|
628
|
-
return CommissionAgreementsApiFp(this.configuration).listCommissionAgreements(requestParameters.authorization, requestParameters.filter, requestParameters.
|
|
670
|
+
return CommissionAgreementsApiFp(this.configuration).listCommissionAgreements(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
629
671
|
}
|
|
630
672
|
|
|
631
673
|
/**
|
package/api/commissions-api.ts
CHANGED
|
@@ -190,13 +190,17 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
190
190
|
* Retrieves a list of commissions.
|
|
191
191
|
* @summary List commissions
|
|
192
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
|
-
* @param {
|
|
194
|
-
* @param {
|
|
195
|
-
* @param {'
|
|
193
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
194
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
195
|
+
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
196
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
197
|
+
* @param {'createdAt'} [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.
|
|
198
|
+
* @param {'items'} [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.
|
|
199
|
+
* @param {string} [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.
|
|
196
200
|
* @param {*} [options] Override http request option.
|
|
197
201
|
* @throws {RequiredError}
|
|
198
202
|
*/
|
|
199
|
-
listCommissions: async (authorization?: string,
|
|
203
|
+
listCommissions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'createdAt', expand?: 'items', filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
200
204
|
const localVarPath = `/commissionservice/v1/commissions`;
|
|
201
205
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
202
206
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -215,18 +219,34 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
215
219
|
// http bearer authentication required
|
|
216
220
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
217
221
|
|
|
218
|
-
if (
|
|
219
|
-
localVarQueryParameter['
|
|
222
|
+
if (pageSize !== undefined) {
|
|
223
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
if (pageToken !== undefined) {
|
|
227
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
220
228
|
}
|
|
221
229
|
|
|
222
230
|
if (filter !== undefined) {
|
|
223
231
|
localVarQueryParameter['filter'] = filter;
|
|
224
232
|
}
|
|
225
233
|
|
|
234
|
+
if (search !== undefined) {
|
|
235
|
+
localVarQueryParameter['search'] = search;
|
|
236
|
+
}
|
|
237
|
+
|
|
238
|
+
if (order !== undefined) {
|
|
239
|
+
localVarQueryParameter['order'] = order;
|
|
240
|
+
}
|
|
241
|
+
|
|
226
242
|
if (expand !== undefined) {
|
|
227
243
|
localVarQueryParameter['expand'] = expand;
|
|
228
244
|
}
|
|
229
245
|
|
|
246
|
+
if (filters !== undefined) {
|
|
247
|
+
localVarQueryParameter['filters'] = filters;
|
|
248
|
+
}
|
|
249
|
+
|
|
230
250
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
231
251
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
232
252
|
}
|
|
@@ -344,14 +364,18 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
|
|
|
344
364
|
* Retrieves a list of commissions.
|
|
345
365
|
* @summary List commissions
|
|
346
366
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
347
|
-
* @param {
|
|
348
|
-
* @param {
|
|
349
|
-
* @param {'
|
|
367
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
368
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
369
|
+
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
370
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
371
|
+
* @param {'createdAt'} [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.
|
|
372
|
+
* @param {'items'} [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.
|
|
373
|
+
* @param {string} [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.
|
|
350
374
|
* @param {*} [options] Override http request option.
|
|
351
375
|
* @throws {RequiredError}
|
|
352
376
|
*/
|
|
353
|
-
async listCommissions(authorization?: string,
|
|
354
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization,
|
|
377
|
+
async listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'createdAt', expand?: 'items', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>> {
|
|
378
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
355
379
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
356
380
|
},
|
|
357
381
|
/**
|
|
@@ -415,14 +439,18 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
|
|
|
415
439
|
* Retrieves a list of commissions.
|
|
416
440
|
* @summary List commissions
|
|
417
441
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
418
|
-
* @param {
|
|
419
|
-
* @param {
|
|
420
|
-
* @param {'
|
|
442
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
443
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
444
|
+
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
445
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
446
|
+
* @param {'createdAt'} [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.
|
|
447
|
+
* @param {'items'} [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.
|
|
448
|
+
* @param {string} [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.
|
|
421
449
|
* @param {*} [options] Override http request option.
|
|
422
450
|
* @throws {RequiredError}
|
|
423
451
|
*/
|
|
424
|
-
listCommissions(authorization?: string,
|
|
425
|
-
return localVarFp.listCommissions(authorization,
|
|
452
|
+
listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'createdAt', expand?: 'items', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass> {
|
|
453
|
+
return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
426
454
|
},
|
|
427
455
|
/**
|
|
428
456
|
* This will update commission.
|
|
@@ -523,25 +551,53 @@ export interface CommissionsApiListCommissionsRequest {
|
|
|
523
551
|
readonly authorization?: string
|
|
524
552
|
|
|
525
553
|
/**
|
|
526
|
-
*
|
|
527
|
-
* @type {
|
|
554
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
555
|
+
* @type {number}
|
|
528
556
|
* @memberof CommissionsApiListCommissions
|
|
529
557
|
*/
|
|
530
|
-
readonly
|
|
558
|
+
readonly pageSize?: number
|
|
531
559
|
|
|
532
560
|
/**
|
|
533
|
-
*
|
|
561
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
562
|
+
* @type {string}
|
|
563
|
+
* @memberof CommissionsApiListCommissions
|
|
564
|
+
*/
|
|
565
|
+
readonly pageToken?: string
|
|
566
|
+
|
|
567
|
+
/**
|
|
568
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
534
569
|
* @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'}
|
|
535
570
|
* @memberof CommissionsApiListCommissions
|
|
536
571
|
*/
|
|
537
572
|
readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'
|
|
538
573
|
|
|
539
574
|
/**
|
|
540
|
-
*
|
|
575
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
576
|
+
* @type {string}
|
|
577
|
+
* @memberof CommissionsApiListCommissions
|
|
578
|
+
*/
|
|
579
|
+
readonly search?: string
|
|
580
|
+
|
|
581
|
+
/**
|
|
582
|
+
* 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.
|
|
583
|
+
* @type {'createdAt'}
|
|
584
|
+
* @memberof CommissionsApiListCommissions
|
|
585
|
+
*/
|
|
586
|
+
readonly order?: 'createdAt'
|
|
587
|
+
|
|
588
|
+
/**
|
|
589
|
+
* 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.
|
|
541
590
|
* @type {'items'}
|
|
542
591
|
* @memberof CommissionsApiListCommissions
|
|
543
592
|
*/
|
|
544
593
|
readonly expand?: 'items'
|
|
594
|
+
|
|
595
|
+
/**
|
|
596
|
+
* 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.
|
|
597
|
+
* @type {string}
|
|
598
|
+
* @memberof CommissionsApiListCommissions
|
|
599
|
+
*/
|
|
600
|
+
readonly filters?: string
|
|
545
601
|
}
|
|
546
602
|
|
|
547
603
|
/**
|
|
@@ -624,7 +680,7 @@ export class CommissionsApi extends BaseAPI {
|
|
|
624
680
|
* @memberof CommissionsApi
|
|
625
681
|
*/
|
|
626
682
|
public listCommissions(requestParameters: CommissionsApiListCommissionsRequest = {}, options?: AxiosRequestConfig) {
|
|
627
|
-
return CommissionsApiFp(this.configuration).listCommissions(requestParameters.authorization, requestParameters.
|
|
683
|
+
return CommissionsApiFp(this.configuration).listCommissions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
628
684
|
}
|
|
629
685
|
|
|
630
686
|
/**
|