@emilgroup/commission-sdk-node 1.0.0-beta.1 → 1.0.0-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.
- package/README.md +2 -2
- package/api/commissions-api.ts +78 -22
- 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.2 --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.2
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `CommissionApi`.
|
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
|
/**
|
|
@@ -55,13 +55,17 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
55
55
|
* Retrieves a list of commissions.
|
|
56
56
|
* @summary List commissions
|
|
57
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
|
-
* @param {
|
|
59
|
-
* @param {
|
|
60
|
-
* @param {'
|
|
58
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
|
+
* @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.
|
|
60
|
+
* @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.
|
|
61
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
62
|
+
* @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.
|
|
63
|
+
* @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.
|
|
64
|
+
* @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.
|
|
61
65
|
* @param {*} [options] Override http request option.
|
|
62
66
|
* @throws {RequiredError}
|
|
63
67
|
*/
|
|
64
|
-
listCommissions: (authorization?: string,
|
|
68
|
+
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<RequestArgs>;
|
|
65
69
|
/**
|
|
66
70
|
* This will update commission.
|
|
67
71
|
* @summary Update the commission
|
|
@@ -110,13 +114,17 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
|
|
|
110
114
|
* Retrieves a list of commissions.
|
|
111
115
|
* @summary List commissions
|
|
112
116
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
113
|
-
* @param {
|
|
114
|
-
* @param {
|
|
115
|
-
* @param {'
|
|
117
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
118
|
+
* @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.
|
|
119
|
+
* @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.
|
|
120
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
121
|
+
* @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.
|
|
122
|
+
* @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.
|
|
123
|
+
* @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.
|
|
116
124
|
* @param {*} [options] Override http request option.
|
|
117
125
|
* @throws {RequiredError}
|
|
118
126
|
*/
|
|
119
|
-
listCommissions(authorization?: string,
|
|
127
|
+
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>>;
|
|
120
128
|
/**
|
|
121
129
|
* This will update commission.
|
|
122
130
|
* @summary Update the commission
|
|
@@ -165,13 +173,17 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
|
|
|
165
173
|
* Retrieves a list of commissions.
|
|
166
174
|
* @summary List commissions
|
|
167
175
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
168
|
-
* @param {
|
|
169
|
-
* @param {
|
|
170
|
-
* @param {'
|
|
176
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
177
|
+
* @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.
|
|
178
|
+
* @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.
|
|
179
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
180
|
+
* @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.
|
|
181
|
+
* @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.
|
|
182
|
+
* @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.
|
|
171
183
|
* @param {*} [options] Override http request option.
|
|
172
184
|
* @throws {RequiredError}
|
|
173
185
|
*/
|
|
174
|
-
listCommissions(authorization?: string,
|
|
186
|
+
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>;
|
|
175
187
|
/**
|
|
176
188
|
* This will update commission.
|
|
177
189
|
* @summary Update the commission
|
|
@@ -259,23 +271,47 @@ export interface CommissionsApiListCommissionsRequest {
|
|
|
259
271
|
*/
|
|
260
272
|
readonly authorization?: string;
|
|
261
273
|
/**
|
|
262
|
-
*
|
|
263
|
-
* @type {
|
|
274
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
275
|
+
* @type {number}
|
|
264
276
|
* @memberof CommissionsApiListCommissions
|
|
265
277
|
*/
|
|
266
|
-
readonly
|
|
278
|
+
readonly pageSize?: number;
|
|
267
279
|
/**
|
|
268
|
-
*
|
|
280
|
+
* 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.
|
|
281
|
+
* @type {string}
|
|
282
|
+
* @memberof CommissionsApiListCommissions
|
|
283
|
+
*/
|
|
284
|
+
readonly pageToken?: string;
|
|
285
|
+
/**
|
|
286
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
269
287
|
* @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'}
|
|
270
288
|
* @memberof CommissionsApiListCommissions
|
|
271
289
|
*/
|
|
272
290
|
readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt';
|
|
273
291
|
/**
|
|
274
|
-
*
|
|
292
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
293
|
+
* @type {string}
|
|
294
|
+
* @memberof CommissionsApiListCommissions
|
|
295
|
+
*/
|
|
296
|
+
readonly search?: string;
|
|
297
|
+
/**
|
|
298
|
+
* 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.
|
|
299
|
+
* @type {'createdAt'}
|
|
300
|
+
* @memberof CommissionsApiListCommissions
|
|
301
|
+
*/
|
|
302
|
+
readonly order?: 'createdAt';
|
|
303
|
+
/**
|
|
304
|
+
* 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.
|
|
275
305
|
* @type {'items'}
|
|
276
306
|
* @memberof CommissionsApiListCommissions
|
|
277
307
|
*/
|
|
278
308
|
readonly expand?: 'items';
|
|
309
|
+
/**
|
|
310
|
+
* 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.
|
|
311
|
+
* @type {string}
|
|
312
|
+
* @memberof CommissionsApiListCommissions
|
|
313
|
+
*/
|
|
314
|
+
readonly filters?: string;
|
|
279
315
|
}
|
|
280
316
|
/**
|
|
281
317
|
* Request parameters for updateCommission operation in CommissionsApi.
|
|
@@ -251,13 +251,17 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
|
|
|
251
251
|
* Retrieves a list of commissions.
|
|
252
252
|
* @summary List commissions
|
|
253
253
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
254
|
-
* @param {
|
|
255
|
-
* @param {
|
|
256
|
-
* @param {'
|
|
254
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
255
|
+
* @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.
|
|
256
|
+
* @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.
|
|
257
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
258
|
+
* @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.
|
|
259
|
+
* @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.
|
|
260
|
+
* @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.
|
|
257
261
|
* @param {*} [options] Override http request option.
|
|
258
262
|
* @throws {RequiredError}
|
|
259
263
|
*/
|
|
260
|
-
listCommissions: function (authorization,
|
|
264
|
+
listCommissions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
261
265
|
if (options === void 0) { options = {}; }
|
|
262
266
|
return __awaiter(_this, void 0, void 0, function () {
|
|
263
267
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -280,15 +284,27 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
|
|
|
280
284
|
// authentication bearer required
|
|
281
285
|
// http bearer authentication required
|
|
282
286
|
_a.sent();
|
|
283
|
-
if (
|
|
284
|
-
localVarQueryParameter['
|
|
287
|
+
if (pageSize !== undefined) {
|
|
288
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
289
|
+
}
|
|
290
|
+
if (pageToken !== undefined) {
|
|
291
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
285
292
|
}
|
|
286
293
|
if (filter !== undefined) {
|
|
287
294
|
localVarQueryParameter['filter'] = filter;
|
|
288
295
|
}
|
|
296
|
+
if (search !== undefined) {
|
|
297
|
+
localVarQueryParameter['search'] = search;
|
|
298
|
+
}
|
|
299
|
+
if (order !== undefined) {
|
|
300
|
+
localVarQueryParameter['order'] = order;
|
|
301
|
+
}
|
|
289
302
|
if (expand !== undefined) {
|
|
290
303
|
localVarQueryParameter['expand'] = expand;
|
|
291
304
|
}
|
|
305
|
+
if (filters !== undefined) {
|
|
306
|
+
localVarQueryParameter['filters'] = filters;
|
|
307
|
+
}
|
|
292
308
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
293
309
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
294
310
|
}
|
|
@@ -434,18 +450,22 @@ var CommissionsApiFp = function (configuration) {
|
|
|
434
450
|
* Retrieves a list of commissions.
|
|
435
451
|
* @summary List commissions
|
|
436
452
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
437
|
-
* @param {
|
|
438
|
-
* @param {
|
|
439
|
-
* @param {'
|
|
453
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
454
|
+
* @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.
|
|
455
|
+
* @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.
|
|
456
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
457
|
+
* @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.
|
|
458
|
+
* @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.
|
|
459
|
+
* @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.
|
|
440
460
|
* @param {*} [options] Override http request option.
|
|
441
461
|
* @throws {RequiredError}
|
|
442
462
|
*/
|
|
443
|
-
listCommissions: function (authorization,
|
|
463
|
+
listCommissions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
444
464
|
return __awaiter(this, void 0, void 0, function () {
|
|
445
465
|
var localVarAxiosArgs;
|
|
446
466
|
return __generator(this, function (_a) {
|
|
447
467
|
switch (_a.label) {
|
|
448
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listCommissions(authorization,
|
|
468
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
449
469
|
case 1:
|
|
450
470
|
localVarAxiosArgs = _a.sent();
|
|
451
471
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -523,14 +543,18 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
|
|
|
523
543
|
* Retrieves a list of commissions.
|
|
524
544
|
* @summary List commissions
|
|
525
545
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
526
|
-
* @param {
|
|
527
|
-
* @param {
|
|
528
|
-
* @param {'
|
|
546
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
547
|
+
* @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.
|
|
548
|
+
* @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.
|
|
549
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
550
|
+
* @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.
|
|
551
|
+
* @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.
|
|
552
|
+
* @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.
|
|
529
553
|
* @param {*} [options] Override http request option.
|
|
530
554
|
* @throws {RequiredError}
|
|
531
555
|
*/
|
|
532
|
-
listCommissions: function (authorization,
|
|
533
|
-
return localVarFp.listCommissions(authorization,
|
|
556
|
+
listCommissions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
557
|
+
return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
534
558
|
},
|
|
535
559
|
/**
|
|
536
560
|
* This will update commission.
|
|
@@ -605,7 +629,7 @@ var CommissionsApi = /** @class */ (function (_super) {
|
|
|
605
629
|
CommissionsApi.prototype.listCommissions = function (requestParameters, options) {
|
|
606
630
|
var _this = this;
|
|
607
631
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
608
|
-
return (0, exports.CommissionsApiFp)(this.configuration).listCommissions(requestParameters.authorization, requestParameters.
|
|
632
|
+
return (0, exports.CommissionsApiFp)(this.configuration).listCommissions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
609
633
|
};
|
|
610
634
|
/**
|
|
611
635
|
* This will update commission.
|