@emilgroup/commission-sdk 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@1.0.0-beta.
|
|
20
|
+
npm install @emilgroup/commission-sdk@1.0.0-beta.2 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/commission-sdk@1.0.0-beta.
|
|
24
|
+
yarn add @emilgroup/commission-sdk@1.0.0-beta.2
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `CommissionApi`.
|
package/api/commissions-api.ts
CHANGED
|
@@ -186,13 +186,17 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
186
186
|
* Retrieves a list of commissions.
|
|
187
187
|
* @summary List commissions
|
|
188
188
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
189
|
-
* @param {
|
|
190
|
-
* @param {
|
|
191
|
-
* @param {'
|
|
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 {'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.
|
|
192
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
193
|
+
* @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.
|
|
194
|
+
* @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.
|
|
195
|
+
* @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.
|
|
192
196
|
* @param {*} [options] Override http request option.
|
|
193
197
|
* @throws {RequiredError}
|
|
194
198
|
*/
|
|
195
|
-
listCommissions: async (authorization?: string,
|
|
199
|
+
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> => {
|
|
196
200
|
const localVarPath = `/commissionservice/v1/commissions`;
|
|
197
201
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
198
202
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -211,18 +215,34 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
211
215
|
// http bearer authentication required
|
|
212
216
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
213
217
|
|
|
214
|
-
if (
|
|
215
|
-
localVarQueryParameter['
|
|
218
|
+
if (pageSize !== undefined) {
|
|
219
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
if (pageToken !== undefined) {
|
|
223
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
216
224
|
}
|
|
217
225
|
|
|
218
226
|
if (filter !== undefined) {
|
|
219
227
|
localVarQueryParameter['filter'] = filter;
|
|
220
228
|
}
|
|
221
229
|
|
|
230
|
+
if (search !== undefined) {
|
|
231
|
+
localVarQueryParameter['search'] = search;
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
if (order !== undefined) {
|
|
235
|
+
localVarQueryParameter['order'] = order;
|
|
236
|
+
}
|
|
237
|
+
|
|
222
238
|
if (expand !== undefined) {
|
|
223
239
|
localVarQueryParameter['expand'] = expand;
|
|
224
240
|
}
|
|
225
241
|
|
|
242
|
+
if (filters !== undefined) {
|
|
243
|
+
localVarQueryParameter['filters'] = filters;
|
|
244
|
+
}
|
|
245
|
+
|
|
226
246
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
227
247
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
228
248
|
}
|
|
@@ -340,14 +360,18 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
|
|
|
340
360
|
* Retrieves a list of commissions.
|
|
341
361
|
* @summary List commissions
|
|
342
362
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
343
|
-
* @param {
|
|
344
|
-
* @param {
|
|
345
|
-
* @param {'
|
|
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.
|
|
365
|
+
* @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.
|
|
366
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
367
|
+
* @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.
|
|
368
|
+
* @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.
|
|
369
|
+
* @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.
|
|
346
370
|
* @param {*} [options] Override http request option.
|
|
347
371
|
* @throws {RequiredError}
|
|
348
372
|
*/
|
|
349
|
-
async listCommissions(authorization?: string,
|
|
350
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization,
|
|
373
|
+
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>> {
|
|
374
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
351
375
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
352
376
|
},
|
|
353
377
|
/**
|
|
@@ -411,14 +435,18 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
|
|
|
411
435
|
* Retrieves a list of commissions.
|
|
412
436
|
* @summary List commissions
|
|
413
437
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
414
|
-
* @param {
|
|
415
|
-
* @param {
|
|
416
|
-
* @param {'
|
|
438
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
439
|
+
* @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.
|
|
440
|
+
* @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.
|
|
441
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
442
|
+
* @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.
|
|
443
|
+
* @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.
|
|
444
|
+
* @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.
|
|
417
445
|
* @param {*} [options] Override http request option.
|
|
418
446
|
* @throws {RequiredError}
|
|
419
447
|
*/
|
|
420
|
-
listCommissions(authorization?: string,
|
|
421
|
-
return localVarFp.listCommissions(authorization,
|
|
448
|
+
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> {
|
|
449
|
+
return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
422
450
|
},
|
|
423
451
|
/**
|
|
424
452
|
* This will update commission.
|
|
@@ -519,25 +547,53 @@ export interface CommissionsApiListCommissionsRequest {
|
|
|
519
547
|
readonly authorization?: string
|
|
520
548
|
|
|
521
549
|
/**
|
|
522
|
-
*
|
|
523
|
-
* @type {
|
|
550
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
551
|
+
* @type {number}
|
|
524
552
|
* @memberof CommissionsApiListCommissions
|
|
525
553
|
*/
|
|
526
|
-
readonly
|
|
554
|
+
readonly pageSize?: number
|
|
527
555
|
|
|
528
556
|
/**
|
|
529
|
-
*
|
|
557
|
+
* 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.
|
|
558
|
+
* @type {string}
|
|
559
|
+
* @memberof CommissionsApiListCommissions
|
|
560
|
+
*/
|
|
561
|
+
readonly pageToken?: string
|
|
562
|
+
|
|
563
|
+
/**
|
|
564
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
530
565
|
* @type {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'}
|
|
531
566
|
* @memberof CommissionsApiListCommissions
|
|
532
567
|
*/
|
|
533
568
|
readonly filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'
|
|
534
569
|
|
|
535
570
|
/**
|
|
536
|
-
*
|
|
571
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
572
|
+
* @type {string}
|
|
573
|
+
* @memberof CommissionsApiListCommissions
|
|
574
|
+
*/
|
|
575
|
+
readonly search?: string
|
|
576
|
+
|
|
577
|
+
/**
|
|
578
|
+
* 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.
|
|
579
|
+
* @type {'createdAt'}
|
|
580
|
+
* @memberof CommissionsApiListCommissions
|
|
581
|
+
*/
|
|
582
|
+
readonly order?: 'createdAt'
|
|
583
|
+
|
|
584
|
+
/**
|
|
585
|
+
* 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.
|
|
537
586
|
* @type {'items'}
|
|
538
587
|
* @memberof CommissionsApiListCommissions
|
|
539
588
|
*/
|
|
540
589
|
readonly expand?: 'items'
|
|
590
|
+
|
|
591
|
+
/**
|
|
592
|
+
* 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.
|
|
593
|
+
* @type {string}
|
|
594
|
+
* @memberof CommissionsApiListCommissions
|
|
595
|
+
*/
|
|
596
|
+
readonly filters?: string
|
|
541
597
|
}
|
|
542
598
|
|
|
543
599
|
/**
|
|
@@ -620,7 +676,7 @@ export class CommissionsApi extends BaseAPI {
|
|
|
620
676
|
* @memberof CommissionsApi
|
|
621
677
|
*/
|
|
622
678
|
public listCommissions(requestParameters: CommissionsApiListCommissionsRequest = {}, options?: AxiosRequestConfig) {
|
|
623
|
-
return CommissionsApiFp(this.configuration).listCommissions(requestParameters.authorization, requestParameters.
|
|
679
|
+
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));
|
|
624
680
|
}
|
|
625
681
|
|
|
626
682
|
/**
|
|
@@ -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.
|
|
@@ -247,13 +247,17 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
|
|
|
247
247
|
* Retrieves a list of commissions.
|
|
248
248
|
* @summary List commissions
|
|
249
249
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
250
|
-
* @param {
|
|
251
|
-
* @param {
|
|
252
|
-
* @param {'
|
|
250
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
251
|
+
* @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.
|
|
252
|
+
* @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.
|
|
253
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
254
|
+
* @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.
|
|
255
|
+
* @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.
|
|
256
|
+
* @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.
|
|
253
257
|
* @param {*} [options] Override http request option.
|
|
254
258
|
* @throws {RequiredError}
|
|
255
259
|
*/
|
|
256
|
-
listCommissions: function (authorization,
|
|
260
|
+
listCommissions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
257
261
|
if (options === void 0) { options = {}; }
|
|
258
262
|
return __awaiter(_this, void 0, void 0, function () {
|
|
259
263
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -276,15 +280,27 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
|
|
|
276
280
|
// authentication bearer required
|
|
277
281
|
// http bearer authentication required
|
|
278
282
|
_a.sent();
|
|
279
|
-
if (
|
|
280
|
-
localVarQueryParameter['
|
|
283
|
+
if (pageSize !== undefined) {
|
|
284
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
285
|
+
}
|
|
286
|
+
if (pageToken !== undefined) {
|
|
287
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
281
288
|
}
|
|
282
289
|
if (filter !== undefined) {
|
|
283
290
|
localVarQueryParameter['filter'] = filter;
|
|
284
291
|
}
|
|
292
|
+
if (search !== undefined) {
|
|
293
|
+
localVarQueryParameter['search'] = search;
|
|
294
|
+
}
|
|
295
|
+
if (order !== undefined) {
|
|
296
|
+
localVarQueryParameter['order'] = order;
|
|
297
|
+
}
|
|
285
298
|
if (expand !== undefined) {
|
|
286
299
|
localVarQueryParameter['expand'] = expand;
|
|
287
300
|
}
|
|
301
|
+
if (filters !== undefined) {
|
|
302
|
+
localVarQueryParameter['filters'] = filters;
|
|
303
|
+
}
|
|
288
304
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
289
305
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
290
306
|
}
|
|
@@ -430,18 +446,22 @@ var CommissionsApiFp = function (configuration) {
|
|
|
430
446
|
* Retrieves a list of commissions.
|
|
431
447
|
* @summary List commissions
|
|
432
448
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
433
|
-
* @param {
|
|
434
|
-
* @param {
|
|
435
|
-
* @param {'
|
|
449
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
450
|
+
* @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.
|
|
451
|
+
* @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.
|
|
452
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
453
|
+
* @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.
|
|
454
|
+
* @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.
|
|
455
|
+
* @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.
|
|
436
456
|
* @param {*} [options] Override http request option.
|
|
437
457
|
* @throws {RequiredError}
|
|
438
458
|
*/
|
|
439
|
-
listCommissions: function (authorization,
|
|
459
|
+
listCommissions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
440
460
|
return __awaiter(this, void 0, void 0, function () {
|
|
441
461
|
var localVarAxiosArgs;
|
|
442
462
|
return __generator(this, function (_a) {
|
|
443
463
|
switch (_a.label) {
|
|
444
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listCommissions(authorization,
|
|
464
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
445
465
|
case 1:
|
|
446
466
|
localVarAxiosArgs = _a.sent();
|
|
447
467
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -519,14 +539,18 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
|
|
|
519
539
|
* Retrieves a list of commissions.
|
|
520
540
|
* @summary List commissions
|
|
521
541
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
522
|
-
* @param {
|
|
523
|
-
* @param {
|
|
524
|
-
* @param {'
|
|
542
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
543
|
+
* @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.
|
|
544
|
+
* @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.
|
|
545
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
546
|
+
* @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.
|
|
547
|
+
* @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.
|
|
548
|
+
* @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.
|
|
525
549
|
* @param {*} [options] Override http request option.
|
|
526
550
|
* @throws {RequiredError}
|
|
527
551
|
*/
|
|
528
|
-
listCommissions: function (authorization,
|
|
529
|
-
return localVarFp.listCommissions(authorization,
|
|
552
|
+
listCommissions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
553
|
+
return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
530
554
|
},
|
|
531
555
|
/**
|
|
532
556
|
* This will update commission.
|
|
@@ -601,7 +625,7 @@ var CommissionsApi = /** @class */ (function (_super) {
|
|
|
601
625
|
CommissionsApi.prototype.listCommissions = function (requestParameters, options) {
|
|
602
626
|
var _this = this;
|
|
603
627
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
604
|
-
return (0, exports.CommissionsApiFp)(this.configuration).listCommissions(requestParameters.authorization, requestParameters.
|
|
628
|
+
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); });
|
|
605
629
|
};
|
|
606
630
|
/**
|
|
607
631
|
* This will update commission.
|