@emilgroup/commission-sdk 1.0.0-beta.31 → 1.0.0-beta.33
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/.openapi-generator/FILES +2 -0
- package/README.md +2 -2
- package/api/commission-agreements-api.ts +133 -0
- package/api/commission-settlements-api.ts +8 -8
- package/api/commissions-api.ts +8 -8
- package/dist/api/commission-agreements-api.d.ts +75 -0
- package/dist/api/commission-agreements-api.js +105 -0
- package/dist/api/commission-settlements-api.d.ts +8 -8
- package/dist/api/commission-settlements-api.js +3 -3
- package/dist/api/commissions-api.d.ts +8 -8
- package/dist/api/commissions-api.js +3 -3
- package/dist/models/commission-agreement-class.d.ts +4 -2
- package/dist/models/commission-agreement-class.js +3 -1
- package/dist/models/create-commission-agreement-request-dto.d.ts +4 -2
- package/dist/models/create-commission-agreement-request-dto.js +3 -1
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/dist/models/patch-commission-agreement-status-request-dto.d.ts +37 -0
- package/dist/models/patch-commission-agreement-status-request-dto.js +22 -0
- package/dist/models/patch-commission-agreement-status-response-class.d.ts +25 -0
- package/dist/models/patch-commission-agreement-status-response-class.js +15 -0
- package/models/commission-agreement-class.ts +4 -2
- package/models/create-commission-agreement-request-dto.ts +4 -2
- package/models/index.ts +2 -0
- package/models/patch-commission-agreement-status-request-dto.ts +46 -0
- package/models/patch-commission-agreement-status-response-class.ts +31 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -65,6 +65,8 @@ models/list-commission-agreements-response-class.ts
|
|
|
65
65
|
models/list-commission-recipients-response-class.ts
|
|
66
66
|
models/list-commission-settlements-response-class.ts
|
|
67
67
|
models/list-commissions-response-class.ts
|
|
68
|
+
models/patch-commission-agreement-status-request-dto.ts
|
|
69
|
+
models/patch-commission-agreement-status-response-class.ts
|
|
68
70
|
models/publish-commission-settlements-request-dto.ts
|
|
69
71
|
models/publish-commission-settlements-response-class.ts
|
|
70
72
|
models/update-commission-agreement-product-request-dto.ts
|
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.33 --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.33
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `CommissionApi`.
|
|
@@ -29,6 +29,10 @@ import { GetCommissionAgreementResponseClass } from '../models';
|
|
|
29
29
|
// @ts-ignore
|
|
30
30
|
import { ListCommissionAgreementsResponseClass } from '../models';
|
|
31
31
|
// @ts-ignore
|
|
32
|
+
import { PatchCommissionAgreementStatusRequestDto } from '../models';
|
|
33
|
+
// @ts-ignore
|
|
34
|
+
import { PatchCommissionAgreementStatusResponseClass } from '../models';
|
|
35
|
+
// @ts-ignore
|
|
32
36
|
import { UpdateCommissionAgreementRequestDto } from '../models';
|
|
33
37
|
// @ts-ignore
|
|
34
38
|
import { UpdateCommissionAgreementResponseClass } from '../models';
|
|
@@ -258,6 +262,61 @@ export const CommissionAgreementsApiAxiosParamCreator = function (configuration?
|
|
|
258
262
|
options: localVarRequestOptions,
|
|
259
263
|
};
|
|
260
264
|
},
|
|
265
|
+
/**
|
|
266
|
+
* This will patch commission agreement status.
|
|
267
|
+
* @summary Update the commission agreement status
|
|
268
|
+
* @param {string} code
|
|
269
|
+
* @param {any} commissionAgreement Unique identifier for the object.
|
|
270
|
+
* @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
|
|
271
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
272
|
+
* @param {*} [options] Override http request option.
|
|
273
|
+
* @throws {RequiredError}
|
|
274
|
+
*/
|
|
275
|
+
patchCommissionAgreementStatus: async (code: string, commissionAgreement: any, patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
276
|
+
// verify required parameter 'code' is not null or undefined
|
|
277
|
+
assertParamExists('patchCommissionAgreementStatus', 'code', code)
|
|
278
|
+
// verify required parameter 'commissionAgreement' is not null or undefined
|
|
279
|
+
assertParamExists('patchCommissionAgreementStatus', 'commissionAgreement', commissionAgreement)
|
|
280
|
+
// verify required parameter 'patchCommissionAgreementStatusRequestDto' is not null or undefined
|
|
281
|
+
assertParamExists('patchCommissionAgreementStatus', 'patchCommissionAgreementStatusRequestDto', patchCommissionAgreementStatusRequestDto)
|
|
282
|
+
const localVarPath = `/commissionservice/v1/agreements/{code}/status`
|
|
283
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)))
|
|
284
|
+
.replace(`{${"commission agreement"}}`, encodeURIComponent(String(commissionAgreement)));
|
|
285
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
286
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
287
|
+
let baseOptions;
|
|
288
|
+
let baseAccessToken;
|
|
289
|
+
if (configuration) {
|
|
290
|
+
baseOptions = configuration.baseOptions;
|
|
291
|
+
baseAccessToken = configuration.accessToken;
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
295
|
+
const localVarHeaderParameter = {} as any;
|
|
296
|
+
const localVarQueryParameter = {} as any;
|
|
297
|
+
|
|
298
|
+
// authentication bearer required
|
|
299
|
+
// http bearer authentication required
|
|
300
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
301
|
+
|
|
302
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
303
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
309
|
+
|
|
310
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
311
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
312
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
313
|
+
localVarRequestOptions.data = serializeDataIfNeeded(patchCommissionAgreementStatusRequestDto, localVarRequestOptions, configuration)
|
|
314
|
+
|
|
315
|
+
return {
|
|
316
|
+
url: toPathString(localVarUrlObj),
|
|
317
|
+
options: localVarRequestOptions,
|
|
318
|
+
};
|
|
319
|
+
},
|
|
261
320
|
/**
|
|
262
321
|
* This will update commission agreement.
|
|
263
322
|
* @summary Update the commission agreement
|
|
@@ -374,6 +433,20 @@ export const CommissionAgreementsApiFp = function(configuration?: Configuration)
|
|
|
374
433
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAgreements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
375
434
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
376
435
|
},
|
|
436
|
+
/**
|
|
437
|
+
* This will patch commission agreement status.
|
|
438
|
+
* @summary Update the commission agreement status
|
|
439
|
+
* @param {string} code
|
|
440
|
+
* @param {any} commissionAgreement Unique identifier for the object.
|
|
441
|
+
* @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
|
|
442
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
443
|
+
* @param {*} [options] Override http request option.
|
|
444
|
+
* @throws {RequiredError}
|
|
445
|
+
*/
|
|
446
|
+
async patchCommissionAgreementStatus(code: string, commissionAgreement: any, patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchCommissionAgreementStatusResponseClass>> {
|
|
447
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.patchCommissionAgreementStatus(code, commissionAgreement, patchCommissionAgreementStatusRequestDto, authorization, options);
|
|
448
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
449
|
+
},
|
|
377
450
|
/**
|
|
378
451
|
* This will update commission agreement.
|
|
379
452
|
* @summary Update the commission agreement
|
|
@@ -448,6 +521,19 @@ export const CommissionAgreementsApiFactory = function (configuration?: Configur
|
|
|
448
521
|
listCommissionAgreements(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAgreementsResponseClass> {
|
|
449
522
|
return localVarFp.listCommissionAgreements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
450
523
|
},
|
|
524
|
+
/**
|
|
525
|
+
* This will patch commission agreement status.
|
|
526
|
+
* @summary Update the commission agreement status
|
|
527
|
+
* @param {string} code
|
|
528
|
+
* @param {any} commissionAgreement Unique identifier for the object.
|
|
529
|
+
* @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
|
|
530
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
531
|
+
* @param {*} [options] Override http request option.
|
|
532
|
+
* @throws {RequiredError}
|
|
533
|
+
*/
|
|
534
|
+
patchCommissionAgreementStatus(code: string, commissionAgreement: any, patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto, authorization?: string, options?: any): AxiosPromise<PatchCommissionAgreementStatusResponseClass> {
|
|
535
|
+
return localVarFp.patchCommissionAgreementStatus(code, commissionAgreement, patchCommissionAgreementStatusRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
536
|
+
},
|
|
451
537
|
/**
|
|
452
538
|
* This will update commission agreement.
|
|
453
539
|
* @summary Update the commission agreement
|
|
@@ -596,6 +682,41 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
|
|
|
596
682
|
readonly filters?: string
|
|
597
683
|
}
|
|
598
684
|
|
|
685
|
+
/**
|
|
686
|
+
* Request parameters for patchCommissionAgreementStatus operation in CommissionAgreementsApi.
|
|
687
|
+
* @export
|
|
688
|
+
* @interface CommissionAgreementsApiPatchCommissionAgreementStatusRequest
|
|
689
|
+
*/
|
|
690
|
+
export interface CommissionAgreementsApiPatchCommissionAgreementStatusRequest {
|
|
691
|
+
/**
|
|
692
|
+
*
|
|
693
|
+
* @type {string}
|
|
694
|
+
* @memberof CommissionAgreementsApiPatchCommissionAgreementStatus
|
|
695
|
+
*/
|
|
696
|
+
readonly code: string
|
|
697
|
+
|
|
698
|
+
/**
|
|
699
|
+
* Unique identifier for the object.
|
|
700
|
+
* @type {any}
|
|
701
|
+
* @memberof CommissionAgreementsApiPatchCommissionAgreementStatus
|
|
702
|
+
*/
|
|
703
|
+
readonly commissionAgreement: any
|
|
704
|
+
|
|
705
|
+
/**
|
|
706
|
+
*
|
|
707
|
+
* @type {PatchCommissionAgreementStatusRequestDto}
|
|
708
|
+
* @memberof CommissionAgreementsApiPatchCommissionAgreementStatus
|
|
709
|
+
*/
|
|
710
|
+
readonly patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto
|
|
711
|
+
|
|
712
|
+
/**
|
|
713
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
714
|
+
* @type {string}
|
|
715
|
+
* @memberof CommissionAgreementsApiPatchCommissionAgreementStatus
|
|
716
|
+
*/
|
|
717
|
+
readonly authorization?: string
|
|
718
|
+
}
|
|
719
|
+
|
|
599
720
|
/**
|
|
600
721
|
* Request parameters for updateCommissionAgreement operation in CommissionAgreementsApi.
|
|
601
722
|
* @export
|
|
@@ -679,6 +800,18 @@ export class CommissionAgreementsApi extends BaseAPI {
|
|
|
679
800
|
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));
|
|
680
801
|
}
|
|
681
802
|
|
|
803
|
+
/**
|
|
804
|
+
* This will patch commission agreement status.
|
|
805
|
+
* @summary Update the commission agreement status
|
|
806
|
+
* @param {CommissionAgreementsApiPatchCommissionAgreementStatusRequest} requestParameters Request parameters.
|
|
807
|
+
* @param {*} [options] Override http request option.
|
|
808
|
+
* @throws {RequiredError}
|
|
809
|
+
* @memberof CommissionAgreementsApi
|
|
810
|
+
*/
|
|
811
|
+
public patchCommissionAgreementStatus(requestParameters: CommissionAgreementsApiPatchCommissionAgreementStatusRequest, options?: AxiosRequestConfig) {
|
|
812
|
+
return CommissionAgreementsApiFp(this.configuration).patchCommissionAgreementStatus(requestParameters.code, requestParameters.commissionAgreement, requestParameters.patchCommissionAgreementStatusRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
813
|
+
}
|
|
814
|
+
|
|
682
815
|
/**
|
|
683
816
|
* This will update commission agreement.
|
|
684
817
|
* @summary Update the commission agreement
|
|
@@ -194,13 +194,13 @@ export const CommissionSettlementsApiAxiosParamCreator = function (configuration
|
|
|
194
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
195
|
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | '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
196
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
197
|
-
* @param {'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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.
|
|
197
|
+
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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
198
|
* @param {'commissions'} [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
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.
|
|
200
200
|
* @param {*} [options] Override http request option.
|
|
201
201
|
* @throws {RequiredError}
|
|
202
202
|
*/
|
|
203
|
-
listCommissionSettlements: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
203
|
+
listCommissionSettlements: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
204
204
|
const localVarPath = `/commissionservice/v1/commission-settlements`;
|
|
205
205
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
206
206
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -415,13 +415,13 @@ export const CommissionSettlementsApiFp = function(configuration?: Configuration
|
|
|
415
415
|
* @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.
|
|
416
416
|
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | '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.
|
|
417
417
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
418
|
-
* @param {'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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.
|
|
418
|
+
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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.
|
|
419
419
|
* @param {'commissions'} [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.
|
|
420
420
|
* @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
421
|
* @param {*} [options] Override http request option.
|
|
422
422
|
* @throws {RequiredError}
|
|
423
423
|
*/
|
|
424
|
-
async listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionSettlementsResponseClass>> {
|
|
424
|
+
async listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionSettlementsResponseClass>> {
|
|
425
425
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionSettlements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
426
426
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
427
427
|
},
|
|
@@ -502,13 +502,13 @@ export const CommissionSettlementsApiFactory = function (configuration?: Configu
|
|
|
502
502
|
* @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.
|
|
503
503
|
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | '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.
|
|
504
504
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
505
|
-
* @param {'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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.
|
|
505
|
+
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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.
|
|
506
506
|
* @param {'commissions'} [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.
|
|
507
507
|
* @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.
|
|
508
508
|
* @param {*} [options] Override http request option.
|
|
509
509
|
* @throws {RequiredError}
|
|
510
510
|
*/
|
|
511
|
-
listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: any): AxiosPromise<ListCommissionSettlementsResponseClass> {
|
|
511
|
+
listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: any): AxiosPromise<ListCommissionSettlementsResponseClass> {
|
|
512
512
|
return localVarFp.listCommissionSettlements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
513
513
|
},
|
|
514
514
|
/**
|
|
@@ -650,10 +650,10 @@ export interface CommissionSettlementsApiListCommissionSettlementsRequest {
|
|
|
650
650
|
|
|
651
651
|
/**
|
|
652
652
|
* 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.
|
|
653
|
-
* @type {'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'}
|
|
653
|
+
* @type {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'}
|
|
654
654
|
* @memberof CommissionSettlementsApiListCommissionSettlements
|
|
655
655
|
*/
|
|
656
|
-
readonly order?: 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'
|
|
656
|
+
readonly order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'
|
|
657
657
|
|
|
658
658
|
/**
|
|
659
659
|
* 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.
|
package/api/commissions-api.ts
CHANGED
|
@@ -190,13 +190,13 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
190
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
191
|
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
192
192
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
193
|
-
* @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
193
|
+
* @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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
194
|
* @param {'items' | 'agreement'} [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
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.
|
|
196
196
|
* @param {*} [options] Override http request option.
|
|
197
197
|
* @throws {RequiredError}
|
|
198
198
|
*/
|
|
199
|
-
listCommissions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
199
|
+
listCommissions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
200
200
|
const localVarPath = `/commissionservice/v1/commissions`;
|
|
201
201
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
202
202
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -364,13 +364,13 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
|
|
|
364
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
365
|
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
366
366
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
367
|
-
* @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
|
|
367
|
+
* @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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
368
|
* @param {'items' | 'agreement'} [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
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.
|
|
370
370
|
* @param {*} [options] Override http request option.
|
|
371
371
|
* @throws {RequiredError}
|
|
372
372
|
*/
|
|
373
|
-
async listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>> {
|
|
373
|
+
async listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>> {
|
|
374
374
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
375
375
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
376
376
|
},
|
|
@@ -439,13 +439,13 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
|
|
|
439
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
440
|
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
441
441
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
442
|
-
* @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
|
|
442
|
+
* @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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
443
|
* @param {'items' | 'agreement'} [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
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.
|
|
445
445
|
* @param {*} [options] Override http request option.
|
|
446
446
|
* @throws {RequiredError}
|
|
447
447
|
*/
|
|
448
|
-
listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass> {
|
|
448
|
+
listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass> {
|
|
449
449
|
return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
450
450
|
},
|
|
451
451
|
/**
|
|
@@ -576,10 +576,10 @@ export interface CommissionsApiListCommissionsRequest {
|
|
|
576
576
|
|
|
577
577
|
/**
|
|
578
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 {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'}
|
|
579
|
+
* @type {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'}
|
|
580
580
|
* @memberof CommissionsApiListCommissions
|
|
581
581
|
*/
|
|
582
|
-
readonly order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'
|
|
582
|
+
readonly order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'
|
|
583
583
|
|
|
584
584
|
/**
|
|
585
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.
|
|
@@ -16,6 +16,8 @@ import { CreateCommissionAgreementRequestDto } from '../models';
|
|
|
16
16
|
import { CreateCommissionAgreementResponseClass } from '../models';
|
|
17
17
|
import { GetCommissionAgreementResponseClass } from '../models';
|
|
18
18
|
import { ListCommissionAgreementsResponseClass } from '../models';
|
|
19
|
+
import { PatchCommissionAgreementStatusRequestDto } from '../models';
|
|
20
|
+
import { PatchCommissionAgreementStatusResponseClass } from '../models';
|
|
19
21
|
import { UpdateCommissionAgreementRequestDto } from '../models';
|
|
20
22
|
import { UpdateCommissionAgreementResponseClass } from '../models';
|
|
21
23
|
/**
|
|
@@ -66,6 +68,17 @@ export declare const CommissionAgreementsApiAxiosParamCreator: (configuration?:
|
|
|
66
68
|
* @throws {RequiredError}
|
|
67
69
|
*/
|
|
68
70
|
listCommissionAgreements: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
71
|
+
/**
|
|
72
|
+
* This will patch commission agreement status.
|
|
73
|
+
* @summary Update the commission agreement status
|
|
74
|
+
* @param {string} code
|
|
75
|
+
* @param {any} commissionAgreement Unique identifier for the object.
|
|
76
|
+
* @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
|
|
77
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
78
|
+
* @param {*} [options] Override http request option.
|
|
79
|
+
* @throws {RequiredError}
|
|
80
|
+
*/
|
|
81
|
+
patchCommissionAgreementStatus: (code: string, commissionAgreement: any, patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
82
|
/**
|
|
70
83
|
* This will update commission agreement.
|
|
71
84
|
* @summary Update the commission agreement
|
|
@@ -125,6 +138,17 @@ export declare const CommissionAgreementsApiFp: (configuration?: Configuration)
|
|
|
125
138
|
* @throws {RequiredError}
|
|
126
139
|
*/
|
|
127
140
|
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>>;
|
|
141
|
+
/**
|
|
142
|
+
* This will patch commission agreement status.
|
|
143
|
+
* @summary Update the commission agreement status
|
|
144
|
+
* @param {string} code
|
|
145
|
+
* @param {any} commissionAgreement Unique identifier for the object.
|
|
146
|
+
* @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
|
|
147
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
148
|
+
* @param {*} [options] Override http request option.
|
|
149
|
+
* @throws {RequiredError}
|
|
150
|
+
*/
|
|
151
|
+
patchCommissionAgreementStatus(code: string, commissionAgreement: any, patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchCommissionAgreementStatusResponseClass>>;
|
|
128
152
|
/**
|
|
129
153
|
* This will update commission agreement.
|
|
130
154
|
* @summary Update the commission agreement
|
|
@@ -184,6 +208,17 @@ export declare const CommissionAgreementsApiFactory: (configuration?: Configurat
|
|
|
184
208
|
* @throws {RequiredError}
|
|
185
209
|
*/
|
|
186
210
|
listCommissionAgreements(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAgreementsResponseClass>;
|
|
211
|
+
/**
|
|
212
|
+
* This will patch commission agreement status.
|
|
213
|
+
* @summary Update the commission agreement status
|
|
214
|
+
* @param {string} code
|
|
215
|
+
* @param {any} commissionAgreement Unique identifier for the object.
|
|
216
|
+
* @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
|
|
217
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
218
|
+
* @param {*} [options] Override http request option.
|
|
219
|
+
* @throws {RequiredError}
|
|
220
|
+
*/
|
|
221
|
+
patchCommissionAgreementStatus(code: string, commissionAgreement: any, patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto, authorization?: string, options?: any): AxiosPromise<PatchCommissionAgreementStatusResponseClass>;
|
|
187
222
|
/**
|
|
188
223
|
* This will update commission agreement.
|
|
189
224
|
* @summary Update the commission agreement
|
|
@@ -313,6 +348,37 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
|
|
|
313
348
|
*/
|
|
314
349
|
readonly filters?: string;
|
|
315
350
|
}
|
|
351
|
+
/**
|
|
352
|
+
* Request parameters for patchCommissionAgreementStatus operation in CommissionAgreementsApi.
|
|
353
|
+
* @export
|
|
354
|
+
* @interface CommissionAgreementsApiPatchCommissionAgreementStatusRequest
|
|
355
|
+
*/
|
|
356
|
+
export interface CommissionAgreementsApiPatchCommissionAgreementStatusRequest {
|
|
357
|
+
/**
|
|
358
|
+
*
|
|
359
|
+
* @type {string}
|
|
360
|
+
* @memberof CommissionAgreementsApiPatchCommissionAgreementStatus
|
|
361
|
+
*/
|
|
362
|
+
readonly code: string;
|
|
363
|
+
/**
|
|
364
|
+
* Unique identifier for the object.
|
|
365
|
+
* @type {any}
|
|
366
|
+
* @memberof CommissionAgreementsApiPatchCommissionAgreementStatus
|
|
367
|
+
*/
|
|
368
|
+
readonly commissionAgreement: any;
|
|
369
|
+
/**
|
|
370
|
+
*
|
|
371
|
+
* @type {PatchCommissionAgreementStatusRequestDto}
|
|
372
|
+
* @memberof CommissionAgreementsApiPatchCommissionAgreementStatus
|
|
373
|
+
*/
|
|
374
|
+
readonly patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto;
|
|
375
|
+
/**
|
|
376
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
377
|
+
* @type {string}
|
|
378
|
+
* @memberof CommissionAgreementsApiPatchCommissionAgreementStatus
|
|
379
|
+
*/
|
|
380
|
+
readonly authorization?: string;
|
|
381
|
+
}
|
|
316
382
|
/**
|
|
317
383
|
* Request parameters for updateCommissionAgreement operation in CommissionAgreementsApi.
|
|
318
384
|
* @export
|
|
@@ -381,6 +447,15 @@ export declare class CommissionAgreementsApi extends BaseAPI {
|
|
|
381
447
|
* @memberof CommissionAgreementsApi
|
|
382
448
|
*/
|
|
383
449
|
listCommissionAgreements(requestParameters?: CommissionAgreementsApiListCommissionAgreementsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionAgreementsResponseClass, any, {}>>;
|
|
450
|
+
/**
|
|
451
|
+
* This will patch commission agreement status.
|
|
452
|
+
* @summary Update the commission agreement status
|
|
453
|
+
* @param {CommissionAgreementsApiPatchCommissionAgreementStatusRequest} requestParameters Request parameters.
|
|
454
|
+
* @param {*} [options] Override http request option.
|
|
455
|
+
* @throws {RequiredError}
|
|
456
|
+
* @memberof CommissionAgreementsApi
|
|
457
|
+
*/
|
|
458
|
+
patchCommissionAgreementStatus(requestParameters: CommissionAgreementsApiPatchCommissionAgreementStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchCommissionAgreementStatusResponseClass, any, {}>>;
|
|
384
459
|
/**
|
|
385
460
|
* This will update commission agreement.
|
|
386
461
|
* @summary Update the commission agreement
|
|
@@ -315,6 +315,63 @@ var CommissionAgreementsApiAxiosParamCreator = function (configuration) {
|
|
|
315
315
|
});
|
|
316
316
|
});
|
|
317
317
|
},
|
|
318
|
+
/**
|
|
319
|
+
* This will patch commission agreement status.
|
|
320
|
+
* @summary Update the commission agreement status
|
|
321
|
+
* @param {string} code
|
|
322
|
+
* @param {any} commissionAgreement Unique identifier for the object.
|
|
323
|
+
* @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
|
|
324
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
325
|
+
* @param {*} [options] Override http request option.
|
|
326
|
+
* @throws {RequiredError}
|
|
327
|
+
*/
|
|
328
|
+
patchCommissionAgreementStatus: function (code, commissionAgreement, patchCommissionAgreementStatusRequestDto, authorization, options) {
|
|
329
|
+
if (options === void 0) { options = {}; }
|
|
330
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
331
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
332
|
+
return __generator(this, function (_a) {
|
|
333
|
+
switch (_a.label) {
|
|
334
|
+
case 0:
|
|
335
|
+
// verify required parameter 'code' is not null or undefined
|
|
336
|
+
(0, common_1.assertParamExists)('patchCommissionAgreementStatus', 'code', code);
|
|
337
|
+
// verify required parameter 'commissionAgreement' is not null or undefined
|
|
338
|
+
(0, common_1.assertParamExists)('patchCommissionAgreementStatus', 'commissionAgreement', commissionAgreement);
|
|
339
|
+
// verify required parameter 'patchCommissionAgreementStatusRequestDto' is not null or undefined
|
|
340
|
+
(0, common_1.assertParamExists)('patchCommissionAgreementStatus', 'patchCommissionAgreementStatusRequestDto', patchCommissionAgreementStatusRequestDto);
|
|
341
|
+
localVarPath = "/commissionservice/v1/agreements/{code}/status"
|
|
342
|
+
.replace("{".concat("code", "}"), encodeURIComponent(String(code)))
|
|
343
|
+
.replace("{".concat("commission agreement", "}"), encodeURIComponent(String(commissionAgreement)));
|
|
344
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
345
|
+
if (configuration) {
|
|
346
|
+
baseOptions = configuration.baseOptions;
|
|
347
|
+
baseAccessToken = configuration.accessToken;
|
|
348
|
+
}
|
|
349
|
+
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
|
|
350
|
+
localVarHeaderParameter = {};
|
|
351
|
+
localVarQueryParameter = {};
|
|
352
|
+
// authentication bearer required
|
|
353
|
+
// http bearer authentication required
|
|
354
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
355
|
+
case 1:
|
|
356
|
+
// authentication bearer required
|
|
357
|
+
// http bearer authentication required
|
|
358
|
+
_a.sent();
|
|
359
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
360
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
361
|
+
}
|
|
362
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
363
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
364
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
365
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
366
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(patchCommissionAgreementStatusRequestDto, localVarRequestOptions, configuration);
|
|
367
|
+
return [2 /*return*/, {
|
|
368
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
369
|
+
options: localVarRequestOptions,
|
|
370
|
+
}];
|
|
371
|
+
}
|
|
372
|
+
});
|
|
373
|
+
});
|
|
374
|
+
},
|
|
318
375
|
/**
|
|
319
376
|
* This will update commission agreement.
|
|
320
377
|
* @summary Update the commission agreement
|
|
@@ -469,6 +526,29 @@ var CommissionAgreementsApiFp = function (configuration) {
|
|
|
469
526
|
});
|
|
470
527
|
});
|
|
471
528
|
},
|
|
529
|
+
/**
|
|
530
|
+
* This will patch commission agreement status.
|
|
531
|
+
* @summary Update the commission agreement status
|
|
532
|
+
* @param {string} code
|
|
533
|
+
* @param {any} commissionAgreement Unique identifier for the object.
|
|
534
|
+
* @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
|
|
535
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
536
|
+
* @param {*} [options] Override http request option.
|
|
537
|
+
* @throws {RequiredError}
|
|
538
|
+
*/
|
|
539
|
+
patchCommissionAgreementStatus: function (code, commissionAgreement, patchCommissionAgreementStatusRequestDto, authorization, options) {
|
|
540
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
541
|
+
var localVarAxiosArgs;
|
|
542
|
+
return __generator(this, function (_a) {
|
|
543
|
+
switch (_a.label) {
|
|
544
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchCommissionAgreementStatus(code, commissionAgreement, patchCommissionAgreementStatusRequestDto, authorization, options)];
|
|
545
|
+
case 1:
|
|
546
|
+
localVarAxiosArgs = _a.sent();
|
|
547
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
548
|
+
}
|
|
549
|
+
});
|
|
550
|
+
});
|
|
551
|
+
},
|
|
472
552
|
/**
|
|
473
553
|
* This will update commission agreement.
|
|
474
554
|
* @summary Update the commission agreement
|
|
@@ -552,6 +632,19 @@ var CommissionAgreementsApiFactory = function (configuration, basePath, axios) {
|
|
|
552
632
|
listCommissionAgreements: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
553
633
|
return localVarFp.listCommissionAgreements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
554
634
|
},
|
|
635
|
+
/**
|
|
636
|
+
* This will patch commission agreement status.
|
|
637
|
+
* @summary Update the commission agreement status
|
|
638
|
+
* @param {string} code
|
|
639
|
+
* @param {any} commissionAgreement Unique identifier for the object.
|
|
640
|
+
* @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
|
|
641
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
642
|
+
* @param {*} [options] Override http request option.
|
|
643
|
+
* @throws {RequiredError}
|
|
644
|
+
*/
|
|
645
|
+
patchCommissionAgreementStatus: function (code, commissionAgreement, patchCommissionAgreementStatusRequestDto, authorization, options) {
|
|
646
|
+
return localVarFp.patchCommissionAgreementStatus(code, commissionAgreement, patchCommissionAgreementStatusRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
647
|
+
},
|
|
555
648
|
/**
|
|
556
649
|
* This will update commission agreement.
|
|
557
650
|
* @summary Update the commission agreement
|
|
@@ -627,6 +720,18 @@ var CommissionAgreementsApi = /** @class */ (function (_super) {
|
|
|
627
720
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
628
721
|
return (0, exports.CommissionAgreementsApiFp)(this.configuration).listCommissionAgreements(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); });
|
|
629
722
|
};
|
|
723
|
+
/**
|
|
724
|
+
* This will patch commission agreement status.
|
|
725
|
+
* @summary Update the commission agreement status
|
|
726
|
+
* @param {CommissionAgreementsApiPatchCommissionAgreementStatusRequest} requestParameters Request parameters.
|
|
727
|
+
* @param {*} [options] Override http request option.
|
|
728
|
+
* @throws {RequiredError}
|
|
729
|
+
* @memberof CommissionAgreementsApi
|
|
730
|
+
*/
|
|
731
|
+
CommissionAgreementsApi.prototype.patchCommissionAgreementStatus = function (requestParameters, options) {
|
|
732
|
+
var _this = this;
|
|
733
|
+
return (0, exports.CommissionAgreementsApiFp)(this.configuration).patchCommissionAgreementStatus(requestParameters.code, requestParameters.commissionAgreement, requestParameters.patchCommissionAgreementStatusRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
734
|
+
};
|
|
630
735
|
/**
|
|
631
736
|
* This will update commission agreement.
|
|
632
737
|
* @summary Update the commission agreement
|
|
@@ -61,13 +61,13 @@ export declare const CommissionSettlementsApiAxiosParamCreator: (configuration?:
|
|
|
61
61
|
* @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.
|
|
62
62
|
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | '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.
|
|
63
63
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
64
|
-
* @param {'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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.
|
|
64
|
+
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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.
|
|
65
65
|
* @param {'commissions'} [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.
|
|
66
66
|
* @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.
|
|
67
67
|
* @param {*} [options] Override http request option.
|
|
68
68
|
* @throws {RequiredError}
|
|
69
69
|
*/
|
|
70
|
-
listCommissionSettlements: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
70
|
+
listCommissionSettlements: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
71
71
|
/**
|
|
72
72
|
* This will publish multiple commission settlements.
|
|
73
73
|
* @summary Create the commission settlement publish
|
|
@@ -129,13 +129,13 @@ export declare const CommissionSettlementsApiFp: (configuration?: Configuration)
|
|
|
129
129
|
* @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.
|
|
130
130
|
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | '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.
|
|
131
131
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
132
|
-
* @param {'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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.
|
|
132
|
+
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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.
|
|
133
133
|
* @param {'commissions'} [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.
|
|
134
134
|
* @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.
|
|
135
135
|
* @param {*} [options] Override http request option.
|
|
136
136
|
* @throws {RequiredError}
|
|
137
137
|
*/
|
|
138
|
-
listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionSettlementsResponseClass>>;
|
|
138
|
+
listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionSettlementsResponseClass>>;
|
|
139
139
|
/**
|
|
140
140
|
* This will publish multiple commission settlements.
|
|
141
141
|
* @summary Create the commission settlement publish
|
|
@@ -197,13 +197,13 @@ export declare const CommissionSettlementsApiFactory: (configuration?: Configura
|
|
|
197
197
|
* @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.
|
|
198
198
|
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | '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.
|
|
199
199
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
200
|
-
* @param {'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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.
|
|
200
|
+
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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.
|
|
201
201
|
* @param {'commissions'} [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.
|
|
202
202
|
* @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.
|
|
203
203
|
* @param {*} [options] Override http request option.
|
|
204
204
|
* @throws {RequiredError}
|
|
205
205
|
*/
|
|
206
|
-
listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: any): AxiosPromise<ListCommissionSettlementsResponseClass>;
|
|
206
|
+
listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: any): AxiosPromise<ListCommissionSettlementsResponseClass>;
|
|
207
207
|
/**
|
|
208
208
|
* This will publish multiple commission settlements.
|
|
209
209
|
* @summary Create the commission settlement publish
|
|
@@ -325,10 +325,10 @@ export interface CommissionSettlementsApiListCommissionSettlementsRequest {
|
|
|
325
325
|
readonly search?: string;
|
|
326
326
|
/**
|
|
327
327
|
* 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.
|
|
328
|
-
* @type {'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'}
|
|
328
|
+
* @type {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'}
|
|
329
329
|
* @memberof CommissionSettlementsApiListCommissionSettlements
|
|
330
330
|
*/
|
|
331
|
-
readonly order?: 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt';
|
|
331
|
+
readonly order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt';
|
|
332
332
|
/**
|
|
333
333
|
* 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.
|
|
334
334
|
* @type {'commissions'}
|
|
@@ -251,7 +251,7 @@ var CommissionSettlementsApiAxiosParamCreator = function (configuration) {
|
|
|
251
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
252
|
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | '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
253
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
254
|
-
* @param {'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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.
|
|
254
|
+
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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
255
|
* @param {'commissions'} [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
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.
|
|
257
257
|
* @param {*} [options] Override http request option.
|
|
@@ -499,7 +499,7 @@ var CommissionSettlementsApiFp = function (configuration) {
|
|
|
499
499
|
* @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.
|
|
500
500
|
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | '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.
|
|
501
501
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
502
|
-
* @param {'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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.
|
|
502
|
+
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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.
|
|
503
503
|
* @param {'commissions'} [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.
|
|
504
504
|
* @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.
|
|
505
505
|
* @param {*} [options] Override http request option.
|
|
@@ -613,7 +613,7 @@ var CommissionSettlementsApiFactory = function (configuration, basePath, axios)
|
|
|
613
613
|
* @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.
|
|
614
614
|
* @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | '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.
|
|
615
615
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
616
|
-
* @param {'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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.
|
|
616
|
+
* @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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.
|
|
617
617
|
* @param {'commissions'} [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.
|
|
618
618
|
* @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.
|
|
619
619
|
* @param {*} [options] Override http request option.
|
|
@@ -59,13 +59,13 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
|
|
|
59
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
60
|
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
61
61
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
62
|
-
* @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
|
|
62
|
+
* @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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
63
|
* @param {'items' | 'agreement'} [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
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.
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
66
66
|
* @throws {RequiredError}
|
|
67
67
|
*/
|
|
68
|
-
listCommissions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
|
+
listCommissions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
69
|
/**
|
|
70
70
|
* This will update commission.
|
|
71
71
|
* @summary Update the commission
|
|
@@ -118,13 +118,13 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
|
|
|
118
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
119
|
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
120
120
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
121
|
-
* @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
|
|
121
|
+
* @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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
122
|
* @param {'items' | 'agreement'} [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
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.
|
|
124
124
|
* @param {*} [options] Override http request option.
|
|
125
125
|
* @throws {RequiredError}
|
|
126
126
|
*/
|
|
127
|
-
listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>>;
|
|
127
|
+
listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>>;
|
|
128
128
|
/**
|
|
129
129
|
* This will update commission.
|
|
130
130
|
* @summary Update the commission
|
|
@@ -177,13 +177,13 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
|
|
|
177
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
178
|
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
179
179
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
180
|
-
* @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
|
|
180
|
+
* @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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
181
|
* @param {'items' | 'agreement'} [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
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.
|
|
183
183
|
* @param {*} [options] Override http request option.
|
|
184
184
|
* @throws {RequiredError}
|
|
185
185
|
*/
|
|
186
|
-
listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass>;
|
|
186
|
+
listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass>;
|
|
187
187
|
/**
|
|
188
188
|
* This will update commission.
|
|
189
189
|
* @summary Update the commission
|
|
@@ -296,10 +296,10 @@ export interface CommissionsApiListCommissionsRequest {
|
|
|
296
296
|
readonly search?: string;
|
|
297
297
|
/**
|
|
298
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 {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'}
|
|
299
|
+
* @type {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'}
|
|
300
300
|
* @memberof CommissionsApiListCommissions
|
|
301
301
|
*/
|
|
302
|
-
readonly order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency';
|
|
302
|
+
readonly order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency';
|
|
303
303
|
/**
|
|
304
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.
|
|
305
305
|
* @type {'items' | 'agreement'}
|
|
@@ -251,7 +251,7 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
|
|
|
251
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
252
|
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
253
253
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
254
|
-
* @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
|
|
254
|
+
* @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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
255
|
* @param {'items' | 'agreement'} [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
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.
|
|
257
257
|
* @param {*} [options] Override http request option.
|
|
@@ -450,7 +450,7 @@ var CommissionsApiFp = function (configuration) {
|
|
|
450
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
451
|
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
452
452
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
453
|
-
* @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
|
|
453
|
+
* @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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
454
|
* @param {'items' | 'agreement'} [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
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.
|
|
456
456
|
* @param {*} [options] Override http request option.
|
|
@@ -543,7 +543,7 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
|
|
|
543
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
544
|
* @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
545
545
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
546
|
-
* @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
|
|
546
|
+
* @param {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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
547
|
* @param {'items' | 'agreement'} [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
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.
|
|
549
549
|
* @param {*} [options] Override http request option.
|
|
@@ -42,7 +42,7 @@ export interface CommissionAgreementClass {
|
|
|
42
42
|
*/
|
|
43
43
|
'commissionAgreementNumber': string;
|
|
44
44
|
/**
|
|
45
|
-
* Current status of the commission agreement (e.g., active,
|
|
45
|
+
* Current status of the commission agreement (e.g., draft, active, processing, archived)
|
|
46
46
|
* @type {string}
|
|
47
47
|
* @memberof CommissionAgreementClass
|
|
48
48
|
*/
|
|
@@ -97,8 +97,10 @@ export interface CommissionAgreementClass {
|
|
|
97
97
|
'updatedBy'?: string;
|
|
98
98
|
}
|
|
99
99
|
export declare const CommissionAgreementClassStatusEnum: {
|
|
100
|
+
readonly Draft: "draft";
|
|
100
101
|
readonly Active: "active";
|
|
101
|
-
readonly
|
|
102
|
+
readonly Processing: "processing";
|
|
103
|
+
readonly Archived: "archived";
|
|
102
104
|
};
|
|
103
105
|
export type CommissionAgreementClassStatusEnum = typeof CommissionAgreementClassStatusEnum[keyof typeof CommissionAgreementClassStatusEnum];
|
|
104
106
|
export declare const CommissionAgreementClassBillingFrequencyEnum: {
|
|
@@ -15,8 +15,10 @@
|
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
16
|
exports.CommissionAgreementClassBillingFrequencyEnum = exports.CommissionAgreementClassStatusEnum = void 0;
|
|
17
17
|
exports.CommissionAgreementClassStatusEnum = {
|
|
18
|
+
Draft: 'draft',
|
|
18
19
|
Active: 'active',
|
|
19
|
-
|
|
20
|
+
Processing: 'processing',
|
|
21
|
+
Archived: 'archived'
|
|
20
22
|
};
|
|
21
23
|
exports.CommissionAgreementClassBillingFrequencyEnum = {
|
|
22
24
|
Monthly: 'monthly',
|
|
@@ -29,7 +29,7 @@ export interface CreateCommissionAgreementRequestDto {
|
|
|
29
29
|
*/
|
|
30
30
|
'billingFrequency': CreateCommissionAgreementRequestDtoBillingFrequencyEnum;
|
|
31
31
|
/**
|
|
32
|
-
* Current status of the commission agreement (e.g., active,
|
|
32
|
+
* Current status of the commission agreement (e.g., draft, active, processing, archived)
|
|
33
33
|
* @type {string}
|
|
34
34
|
* @memberof CreateCommissionAgreementRequestDto
|
|
35
35
|
*/
|
|
@@ -72,7 +72,9 @@ export declare const CreateCommissionAgreementRequestDtoBillingFrequencyEnum: {
|
|
|
72
72
|
};
|
|
73
73
|
export type CreateCommissionAgreementRequestDtoBillingFrequencyEnum = typeof CreateCommissionAgreementRequestDtoBillingFrequencyEnum[keyof typeof CreateCommissionAgreementRequestDtoBillingFrequencyEnum];
|
|
74
74
|
export declare const CreateCommissionAgreementRequestDtoStatusEnum: {
|
|
75
|
+
readonly Draft: "draft";
|
|
75
76
|
readonly Active: "active";
|
|
76
|
-
readonly
|
|
77
|
+
readonly Processing: "processing";
|
|
78
|
+
readonly Archived: "archived";
|
|
77
79
|
};
|
|
78
80
|
export type CreateCommissionAgreementRequestDtoStatusEnum = typeof CreateCommissionAgreementRequestDtoStatusEnum[keyof typeof CreateCommissionAgreementRequestDtoStatusEnum];
|
|
@@ -20,6 +20,8 @@ exports.CreateCommissionAgreementRequestDtoBillingFrequencyEnum = {
|
|
|
20
20
|
Yearly: 'yearly'
|
|
21
21
|
};
|
|
22
22
|
exports.CreateCommissionAgreementRequestDtoStatusEnum = {
|
|
23
|
+
Draft: 'draft',
|
|
23
24
|
Active: 'active',
|
|
24
|
-
|
|
25
|
+
Processing: 'processing',
|
|
26
|
+
Archived: 'archived'
|
|
25
27
|
};
|
package/dist/models/index.d.ts
CHANGED
|
@@ -46,6 +46,8 @@ export * from './list-commission-agreements-response-class';
|
|
|
46
46
|
export * from './list-commission-recipients-response-class';
|
|
47
47
|
export * from './list-commission-settlements-response-class';
|
|
48
48
|
export * from './list-commissions-response-class';
|
|
49
|
+
export * from './patch-commission-agreement-status-request-dto';
|
|
50
|
+
export * from './patch-commission-agreement-status-response-class';
|
|
49
51
|
export * from './publish-commission-settlements-request-dto';
|
|
50
52
|
export * from './publish-commission-settlements-response-class';
|
|
51
53
|
export * from './update-commission-agreement-product-request-dto';
|
package/dist/models/index.js
CHANGED
|
@@ -62,6 +62,8 @@ __exportStar(require("./list-commission-agreements-response-class"), exports);
|
|
|
62
62
|
__exportStar(require("./list-commission-recipients-response-class"), exports);
|
|
63
63
|
__exportStar(require("./list-commission-settlements-response-class"), exports);
|
|
64
64
|
__exportStar(require("./list-commissions-response-class"), exports);
|
|
65
|
+
__exportStar(require("./patch-commission-agreement-status-request-dto"), exports);
|
|
66
|
+
__exportStar(require("./patch-commission-agreement-status-response-class"), exports);
|
|
65
67
|
__exportStar(require("./publish-commission-settlements-request-dto"), exports);
|
|
66
68
|
__exportStar(require("./publish-commission-settlements-response-class"), exports);
|
|
67
69
|
__exportStar(require("./update-commission-agreement-product-request-dto"), exports);
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL CommissionService
|
|
3
|
+
* The EMIL CommissionService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface PatchCommissionAgreementStatusRequestDto
|
|
16
|
+
*/
|
|
17
|
+
export interface PatchCommissionAgreementStatusRequestDto {
|
|
18
|
+
/**
|
|
19
|
+
* Unique code identifier for the commission agreement
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof PatchCommissionAgreementStatusRequestDto
|
|
22
|
+
*/
|
|
23
|
+
'code': string;
|
|
24
|
+
/**
|
|
25
|
+
* Status of the commission agreement. Valid values: draft, active, processing, archived
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof PatchCommissionAgreementStatusRequestDto
|
|
28
|
+
*/
|
|
29
|
+
'status': PatchCommissionAgreementStatusRequestDtoStatusEnum;
|
|
30
|
+
}
|
|
31
|
+
export declare const PatchCommissionAgreementStatusRequestDtoStatusEnum: {
|
|
32
|
+
readonly Draft: "draft";
|
|
33
|
+
readonly Active: "active";
|
|
34
|
+
readonly Processing: "processing";
|
|
35
|
+
readonly Archived: "archived";
|
|
36
|
+
};
|
|
37
|
+
export type PatchCommissionAgreementStatusRequestDtoStatusEnum = typeof PatchCommissionAgreementStatusRequestDtoStatusEnum[keyof typeof PatchCommissionAgreementStatusRequestDtoStatusEnum];
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* EMIL CommissionService
|
|
6
|
+
* The EMIL CommissionService API description
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
* Contact: kontakt@emil.de
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.PatchCommissionAgreementStatusRequestDtoStatusEnum = void 0;
|
|
17
|
+
exports.PatchCommissionAgreementStatusRequestDtoStatusEnum = {
|
|
18
|
+
Draft: 'draft',
|
|
19
|
+
Active: 'active',
|
|
20
|
+
Processing: 'processing',
|
|
21
|
+
Archived: 'archived'
|
|
22
|
+
};
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL CommissionService
|
|
3
|
+
* The EMIL CommissionService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { CommissionAgreementClass } from './commission-agreement-class';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface PatchCommissionAgreementStatusResponseClass
|
|
17
|
+
*/
|
|
18
|
+
export interface PatchCommissionAgreementStatusResponseClass {
|
|
19
|
+
/**
|
|
20
|
+
* The commission agreement with updated status
|
|
21
|
+
* @type {CommissionAgreementClass}
|
|
22
|
+
* @memberof PatchCommissionAgreementStatusResponseClass
|
|
23
|
+
*/
|
|
24
|
+
'commissionAgreement'?: CommissionAgreementClass;
|
|
25
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* EMIL CommissionService
|
|
6
|
+
* The EMIL CommissionService API description
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
* Contact: kontakt@emil.de
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -47,7 +47,7 @@ export interface CommissionAgreementClass {
|
|
|
47
47
|
*/
|
|
48
48
|
'commissionAgreementNumber': string;
|
|
49
49
|
/**
|
|
50
|
-
* Current status of the commission agreement (e.g., active,
|
|
50
|
+
* Current status of the commission agreement (e.g., draft, active, processing, archived)
|
|
51
51
|
* @type {string}
|
|
52
52
|
* @memberof CommissionAgreementClass
|
|
53
53
|
*/
|
|
@@ -103,8 +103,10 @@ export interface CommissionAgreementClass {
|
|
|
103
103
|
}
|
|
104
104
|
|
|
105
105
|
export const CommissionAgreementClassStatusEnum = {
|
|
106
|
+
Draft: 'draft',
|
|
106
107
|
Active: 'active',
|
|
107
|
-
|
|
108
|
+
Processing: 'processing',
|
|
109
|
+
Archived: 'archived'
|
|
108
110
|
} as const;
|
|
109
111
|
|
|
110
112
|
export type CommissionAgreementClassStatusEnum = typeof CommissionAgreementClassStatusEnum[keyof typeof CommissionAgreementClassStatusEnum];
|
|
@@ -34,7 +34,7 @@ export interface CreateCommissionAgreementRequestDto {
|
|
|
34
34
|
*/
|
|
35
35
|
'billingFrequency': CreateCommissionAgreementRequestDtoBillingFrequencyEnum;
|
|
36
36
|
/**
|
|
37
|
-
* Current status of the commission agreement (e.g., active,
|
|
37
|
+
* Current status of the commission agreement (e.g., draft, active, processing, archived)
|
|
38
38
|
* @type {string}
|
|
39
39
|
* @memberof CreateCommissionAgreementRequestDto
|
|
40
40
|
*/
|
|
@@ -79,8 +79,10 @@ export const CreateCommissionAgreementRequestDtoBillingFrequencyEnum = {
|
|
|
79
79
|
|
|
80
80
|
export type CreateCommissionAgreementRequestDtoBillingFrequencyEnum = typeof CreateCommissionAgreementRequestDtoBillingFrequencyEnum[keyof typeof CreateCommissionAgreementRequestDtoBillingFrequencyEnum];
|
|
81
81
|
export const CreateCommissionAgreementRequestDtoStatusEnum = {
|
|
82
|
+
Draft: 'draft',
|
|
82
83
|
Active: 'active',
|
|
83
|
-
|
|
84
|
+
Processing: 'processing',
|
|
85
|
+
Archived: 'archived'
|
|
84
86
|
} as const;
|
|
85
87
|
|
|
86
88
|
export type CreateCommissionAgreementRequestDtoStatusEnum = typeof CreateCommissionAgreementRequestDtoStatusEnum[keyof typeof CreateCommissionAgreementRequestDtoStatusEnum];
|
package/models/index.ts
CHANGED
|
@@ -46,6 +46,8 @@ export * from './list-commission-agreements-response-class';
|
|
|
46
46
|
export * from './list-commission-recipients-response-class';
|
|
47
47
|
export * from './list-commission-settlements-response-class';
|
|
48
48
|
export * from './list-commissions-response-class';
|
|
49
|
+
export * from './patch-commission-agreement-status-request-dto';
|
|
50
|
+
export * from './patch-commission-agreement-status-response-class';
|
|
49
51
|
export * from './publish-commission-settlements-request-dto';
|
|
50
52
|
export * from './publish-commission-settlements-response-class';
|
|
51
53
|
export * from './update-commission-agreement-product-request-dto';
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL CommissionService
|
|
5
|
+
* The EMIL CommissionService API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface PatchCommissionAgreementStatusRequestDto
|
|
21
|
+
*/
|
|
22
|
+
export interface PatchCommissionAgreementStatusRequestDto {
|
|
23
|
+
/**
|
|
24
|
+
* Unique code identifier for the commission agreement
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof PatchCommissionAgreementStatusRequestDto
|
|
27
|
+
*/
|
|
28
|
+
'code': string;
|
|
29
|
+
/**
|
|
30
|
+
* Status of the commission agreement. Valid values: draft, active, processing, archived
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof PatchCommissionAgreementStatusRequestDto
|
|
33
|
+
*/
|
|
34
|
+
'status': PatchCommissionAgreementStatusRequestDtoStatusEnum;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
export const PatchCommissionAgreementStatusRequestDtoStatusEnum = {
|
|
38
|
+
Draft: 'draft',
|
|
39
|
+
Active: 'active',
|
|
40
|
+
Processing: 'processing',
|
|
41
|
+
Archived: 'archived'
|
|
42
|
+
} as const;
|
|
43
|
+
|
|
44
|
+
export type PatchCommissionAgreementStatusRequestDtoStatusEnum = typeof PatchCommissionAgreementStatusRequestDtoStatusEnum[keyof typeof PatchCommissionAgreementStatusRequestDtoStatusEnum];
|
|
45
|
+
|
|
46
|
+
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL CommissionService
|
|
5
|
+
* The EMIL CommissionService API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import { CommissionAgreementClass } from './commission-agreement-class';
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @export
|
|
21
|
+
* @interface PatchCommissionAgreementStatusResponseClass
|
|
22
|
+
*/
|
|
23
|
+
export interface PatchCommissionAgreementStatusResponseClass {
|
|
24
|
+
/**
|
|
25
|
+
* The commission agreement with updated status
|
|
26
|
+
* @type {CommissionAgreementClass}
|
|
27
|
+
* @memberof PatchCommissionAgreementStatusResponseClass
|
|
28
|
+
*/
|
|
29
|
+
'commissionAgreement'?: CommissionAgreementClass;
|
|
30
|
+
}
|
|
31
|
+
|