@emilgroup/commission-sdk-node 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-node@1.0.0-beta.
|
|
20
|
+
npm install @emilgroup/commission-sdk-node@1.0.0-beta.33 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/commission-sdk-node@1.0.0-beta.
|
|
24
|
+
yarn add @emilgroup/commission-sdk-node@1.0.0-beta.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';
|
|
@@ -262,6 +266,61 @@ export const CommissionAgreementsApiAxiosParamCreator = function (configuration?
|
|
|
262
266
|
options: localVarRequestOptions,
|
|
263
267
|
};
|
|
264
268
|
},
|
|
269
|
+
/**
|
|
270
|
+
* This will patch commission agreement status.
|
|
271
|
+
* @summary Update the commission agreement status
|
|
272
|
+
* @param {string} code
|
|
273
|
+
* @param {any} commissionAgreement Unique identifier for the object.
|
|
274
|
+
* @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
|
|
275
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
276
|
+
* @param {*} [options] Override http request option.
|
|
277
|
+
* @throws {RequiredError}
|
|
278
|
+
*/
|
|
279
|
+
patchCommissionAgreementStatus: async (code: string, commissionAgreement: any, patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
280
|
+
// verify required parameter 'code' is not null or undefined
|
|
281
|
+
assertParamExists('patchCommissionAgreementStatus', 'code', code)
|
|
282
|
+
// verify required parameter 'commissionAgreement' is not null or undefined
|
|
283
|
+
assertParamExists('patchCommissionAgreementStatus', 'commissionAgreement', commissionAgreement)
|
|
284
|
+
// verify required parameter 'patchCommissionAgreementStatusRequestDto' is not null or undefined
|
|
285
|
+
assertParamExists('patchCommissionAgreementStatus', 'patchCommissionAgreementStatusRequestDto', patchCommissionAgreementStatusRequestDto)
|
|
286
|
+
const localVarPath = `/commissionservice/v1/agreements/{code}/status`
|
|
287
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)))
|
|
288
|
+
.replace(`{${"commission agreement"}}`, encodeURIComponent(String(commissionAgreement)));
|
|
289
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
290
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
291
|
+
let baseOptions;
|
|
292
|
+
let baseAccessToken;
|
|
293
|
+
if (configuration) {
|
|
294
|
+
baseOptions = configuration.baseOptions;
|
|
295
|
+
baseAccessToken = configuration.accessToken;
|
|
296
|
+
}
|
|
297
|
+
|
|
298
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
299
|
+
const localVarHeaderParameter = {} as any;
|
|
300
|
+
const localVarQueryParameter = {} as any;
|
|
301
|
+
|
|
302
|
+
// authentication bearer required
|
|
303
|
+
// http bearer authentication required
|
|
304
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
305
|
+
|
|
306
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
307
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
308
|
+
}
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
313
|
+
|
|
314
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
315
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
316
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
317
|
+
localVarRequestOptions.data = serializeDataIfNeeded(patchCommissionAgreementStatusRequestDto, localVarRequestOptions, configuration)
|
|
318
|
+
|
|
319
|
+
return {
|
|
320
|
+
url: toPathString(localVarUrlObj),
|
|
321
|
+
options: localVarRequestOptions,
|
|
322
|
+
};
|
|
323
|
+
},
|
|
265
324
|
/**
|
|
266
325
|
* This will update commission agreement.
|
|
267
326
|
* @summary Update the commission agreement
|
|
@@ -378,6 +437,20 @@ export const CommissionAgreementsApiFp = function(configuration?: Configuration)
|
|
|
378
437
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAgreements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
379
438
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
380
439
|
},
|
|
440
|
+
/**
|
|
441
|
+
* This will patch commission agreement status.
|
|
442
|
+
* @summary Update the commission agreement status
|
|
443
|
+
* @param {string} code
|
|
444
|
+
* @param {any} commissionAgreement Unique identifier for the object.
|
|
445
|
+
* @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
|
|
446
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
447
|
+
* @param {*} [options] Override http request option.
|
|
448
|
+
* @throws {RequiredError}
|
|
449
|
+
*/
|
|
450
|
+
async patchCommissionAgreementStatus(code: string, commissionAgreement: any, patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchCommissionAgreementStatusResponseClass>> {
|
|
451
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.patchCommissionAgreementStatus(code, commissionAgreement, patchCommissionAgreementStatusRequestDto, authorization, options);
|
|
452
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
453
|
+
},
|
|
381
454
|
/**
|
|
382
455
|
* This will update commission agreement.
|
|
383
456
|
* @summary Update the commission agreement
|
|
@@ -452,6 +525,19 @@ export const CommissionAgreementsApiFactory = function (configuration?: Configur
|
|
|
452
525
|
listCommissionAgreements(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAgreementsResponseClass> {
|
|
453
526
|
return localVarFp.listCommissionAgreements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
454
527
|
},
|
|
528
|
+
/**
|
|
529
|
+
* This will patch commission agreement status.
|
|
530
|
+
* @summary Update the commission agreement status
|
|
531
|
+
* @param {string} code
|
|
532
|
+
* @param {any} commissionAgreement Unique identifier for the object.
|
|
533
|
+
* @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
|
|
534
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
535
|
+
* @param {*} [options] Override http request option.
|
|
536
|
+
* @throws {RequiredError}
|
|
537
|
+
*/
|
|
538
|
+
patchCommissionAgreementStatus(code: string, commissionAgreement: any, patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto, authorization?: string, options?: any): AxiosPromise<PatchCommissionAgreementStatusResponseClass> {
|
|
539
|
+
return localVarFp.patchCommissionAgreementStatus(code, commissionAgreement, patchCommissionAgreementStatusRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
540
|
+
},
|
|
455
541
|
/**
|
|
456
542
|
* This will update commission agreement.
|
|
457
543
|
* @summary Update the commission agreement
|
|
@@ -600,6 +686,41 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
|
|
|
600
686
|
readonly filters?: string
|
|
601
687
|
}
|
|
602
688
|
|
|
689
|
+
/**
|
|
690
|
+
* Request parameters for patchCommissionAgreementStatus operation in CommissionAgreementsApi.
|
|
691
|
+
* @export
|
|
692
|
+
* @interface CommissionAgreementsApiPatchCommissionAgreementStatusRequest
|
|
693
|
+
*/
|
|
694
|
+
export interface CommissionAgreementsApiPatchCommissionAgreementStatusRequest {
|
|
695
|
+
/**
|
|
696
|
+
*
|
|
697
|
+
* @type {string}
|
|
698
|
+
* @memberof CommissionAgreementsApiPatchCommissionAgreementStatus
|
|
699
|
+
*/
|
|
700
|
+
readonly code: string
|
|
701
|
+
|
|
702
|
+
/**
|
|
703
|
+
* Unique identifier for the object.
|
|
704
|
+
* @type {any}
|
|
705
|
+
* @memberof CommissionAgreementsApiPatchCommissionAgreementStatus
|
|
706
|
+
*/
|
|
707
|
+
readonly commissionAgreement: any
|
|
708
|
+
|
|
709
|
+
/**
|
|
710
|
+
*
|
|
711
|
+
* @type {PatchCommissionAgreementStatusRequestDto}
|
|
712
|
+
* @memberof CommissionAgreementsApiPatchCommissionAgreementStatus
|
|
713
|
+
*/
|
|
714
|
+
readonly patchCommissionAgreementStatusRequestDto: PatchCommissionAgreementStatusRequestDto
|
|
715
|
+
|
|
716
|
+
/**
|
|
717
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
718
|
+
* @type {string}
|
|
719
|
+
* @memberof CommissionAgreementsApiPatchCommissionAgreementStatus
|
|
720
|
+
*/
|
|
721
|
+
readonly authorization?: string
|
|
722
|
+
}
|
|
723
|
+
|
|
603
724
|
/**
|
|
604
725
|
* Request parameters for updateCommissionAgreement operation in CommissionAgreementsApi.
|
|
605
726
|
* @export
|
|
@@ -683,6 +804,18 @@ export class CommissionAgreementsApi extends BaseAPI {
|
|
|
683
804
|
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));
|
|
684
805
|
}
|
|
685
806
|
|
|
807
|
+
/**
|
|
808
|
+
* This will patch commission agreement status.
|
|
809
|
+
* @summary Update the commission agreement status
|
|
810
|
+
* @param {CommissionAgreementsApiPatchCommissionAgreementStatusRequest} requestParameters Request parameters.
|
|
811
|
+
* @param {*} [options] Override http request option.
|
|
812
|
+
* @throws {RequiredError}
|
|
813
|
+
* @memberof CommissionAgreementsApi
|
|
814
|
+
*/
|
|
815
|
+
public patchCommissionAgreementStatus(requestParameters: CommissionAgreementsApiPatchCommissionAgreementStatusRequest, options?: AxiosRequestConfig) {
|
|
816
|
+
return CommissionAgreementsApiFp(this.configuration).patchCommissionAgreementStatus(requestParameters.code, requestParameters.commissionAgreement, requestParameters.patchCommissionAgreementStatusRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
817
|
+
}
|
|
818
|
+
|
|
686
819
|
/**
|
|
687
820
|
* This will update commission agreement.
|
|
688
821
|
* @summary Update the commission agreement
|
|
@@ -198,13 +198,13 @@ export const CommissionSettlementsApiAxiosParamCreator = function (configuration
|
|
|
198
198
|
* @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.
|
|
199
199
|
* @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.
|
|
200
200
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
201
|
-
* @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.
|
|
201
|
+
* @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.
|
|
202
202
|
* @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.
|
|
203
203
|
* @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.
|
|
204
204
|
* @param {*} [options] Override http request option.
|
|
205
205
|
* @throws {RequiredError}
|
|
206
206
|
*/
|
|
207
|
-
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> => {
|
|
207
|
+
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> => {
|
|
208
208
|
const localVarPath = `/commissionservice/v1/commission-settlements`;
|
|
209
209
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
210
210
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -419,13 +419,13 @@ export const CommissionSettlementsApiFp = function(configuration?: Configuration
|
|
|
419
419
|
* @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.
|
|
420
420
|
* @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.
|
|
421
421
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
422
|
-
* @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.
|
|
422
|
+
* @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.
|
|
423
423
|
* @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.
|
|
424
424
|
* @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.
|
|
425
425
|
* @param {*} [options] Override http request option.
|
|
426
426
|
* @throws {RequiredError}
|
|
427
427
|
*/
|
|
428
|
-
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>> {
|
|
428
|
+
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>> {
|
|
429
429
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionSettlements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
430
430
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
431
431
|
},
|
|
@@ -506,13 +506,13 @@ export const CommissionSettlementsApiFactory = function (configuration?: Configu
|
|
|
506
506
|
* @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.
|
|
507
507
|
* @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.
|
|
508
508
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
509
|
-
* @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.
|
|
509
|
+
* @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.
|
|
510
510
|
* @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.
|
|
511
511
|
* @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.
|
|
512
512
|
* @param {*} [options] Override http request option.
|
|
513
513
|
* @throws {RequiredError}
|
|
514
514
|
*/
|
|
515
|
-
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> {
|
|
515
|
+
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> {
|
|
516
516
|
return localVarFp.listCommissionSettlements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
517
517
|
},
|
|
518
518
|
/**
|
|
@@ -654,10 +654,10 @@ export interface CommissionSettlementsApiListCommissionSettlementsRequest {
|
|
|
654
654
|
|
|
655
655
|
/**
|
|
656
656
|
* 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.
|
|
657
|
-
* @type {'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'}
|
|
657
|
+
* @type {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'}
|
|
658
658
|
* @memberof CommissionSettlementsApiListCommissionSettlements
|
|
659
659
|
*/
|
|
660
|
-
readonly order?: 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'
|
|
660
|
+
readonly order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'
|
|
661
661
|
|
|
662
662
|
/**
|
|
663
663
|
* 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
|
@@ -194,13 +194,13 @@ export const CommissionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
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' | '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.
|
|
196
196
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
197
|
-
* @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.
|
|
197
|
+
* @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.
|
|
198
198
|
* @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.
|
|
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
|
-
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> => {
|
|
203
|
+
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> => {
|
|
204
204
|
const localVarPath = `/commissionservice/v1/commissions`;
|
|
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);
|
|
@@ -368,13 +368,13 @@ export const CommissionsApiFp = function(configuration?: Configuration) {
|
|
|
368
368
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
369
369
|
* @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.
|
|
370
370
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
371
|
-
* @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.
|
|
371
|
+
* @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.
|
|
372
372
|
* @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.
|
|
373
373
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
374
374
|
* @param {*} [options] Override http request option.
|
|
375
375
|
* @throws {RequiredError}
|
|
376
376
|
*/
|
|
377
|
-
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>> {
|
|
377
|
+
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>> {
|
|
378
378
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
379
379
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
380
380
|
},
|
|
@@ -443,13 +443,13 @@ export const CommissionsApiFactory = function (configuration?: Configuration, ba
|
|
|
443
443
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
444
444
|
* @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.
|
|
445
445
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
446
|
-
* @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.
|
|
446
|
+
* @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.
|
|
447
447
|
* @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.
|
|
448
448
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
449
449
|
* @param {*} [options] Override http request option.
|
|
450
450
|
* @throws {RequiredError}
|
|
451
451
|
*/
|
|
452
|
-
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> {
|
|
452
|
+
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> {
|
|
453
453
|
return localVarFp.listCommissions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
454
454
|
},
|
|
455
455
|
/**
|
|
@@ -580,10 +580,10 @@ export interface CommissionsApiListCommissionsRequest {
|
|
|
580
580
|
|
|
581
581
|
/**
|
|
582
582
|
* The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
583
|
-
* @type {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'}
|
|
583
|
+
* @type {'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'}
|
|
584
584
|
* @memberof CommissionsApiListCommissions
|
|
585
585
|
*/
|
|
586
|
-
readonly order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'amount' | 'status' | 'agreement.billingFrequency'
|
|
586
|
+
readonly order?: 'agreement.commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'
|
|
587
587
|
|
|
588
588
|
/**
|
|
589
589
|
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
@@ -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
|
|
@@ -319,6 +319,63 @@ var CommissionAgreementsApiAxiosParamCreator = function (configuration) {
|
|
|
319
319
|
});
|
|
320
320
|
});
|
|
321
321
|
},
|
|
322
|
+
/**
|
|
323
|
+
* This will patch commission agreement status.
|
|
324
|
+
* @summary Update the commission agreement status
|
|
325
|
+
* @param {string} code
|
|
326
|
+
* @param {any} commissionAgreement Unique identifier for the object.
|
|
327
|
+
* @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
|
|
328
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
329
|
+
* @param {*} [options] Override http request option.
|
|
330
|
+
* @throws {RequiredError}
|
|
331
|
+
*/
|
|
332
|
+
patchCommissionAgreementStatus: function (code, commissionAgreement, patchCommissionAgreementStatusRequestDto, authorization, options) {
|
|
333
|
+
if (options === void 0) { options = {}; }
|
|
334
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
335
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
336
|
+
return __generator(this, function (_a) {
|
|
337
|
+
switch (_a.label) {
|
|
338
|
+
case 0:
|
|
339
|
+
// verify required parameter 'code' is not null or undefined
|
|
340
|
+
(0, common_1.assertParamExists)('patchCommissionAgreementStatus', 'code', code);
|
|
341
|
+
// verify required parameter 'commissionAgreement' is not null or undefined
|
|
342
|
+
(0, common_1.assertParamExists)('patchCommissionAgreementStatus', 'commissionAgreement', commissionAgreement);
|
|
343
|
+
// verify required parameter 'patchCommissionAgreementStatusRequestDto' is not null or undefined
|
|
344
|
+
(0, common_1.assertParamExists)('patchCommissionAgreementStatus', 'patchCommissionAgreementStatusRequestDto', patchCommissionAgreementStatusRequestDto);
|
|
345
|
+
localVarPath = "/commissionservice/v1/agreements/{code}/status"
|
|
346
|
+
.replace("{".concat("code", "}"), encodeURIComponent(String(code)))
|
|
347
|
+
.replace("{".concat("commission agreement", "}"), encodeURIComponent(String(commissionAgreement)));
|
|
348
|
+
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
349
|
+
if (configuration) {
|
|
350
|
+
baseOptions = configuration.baseOptions;
|
|
351
|
+
baseAccessToken = configuration.accessToken;
|
|
352
|
+
}
|
|
353
|
+
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
|
|
354
|
+
localVarHeaderParameter = {};
|
|
355
|
+
localVarQueryParameter = {};
|
|
356
|
+
// authentication bearer required
|
|
357
|
+
// http bearer authentication required
|
|
358
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
359
|
+
case 1:
|
|
360
|
+
// authentication bearer required
|
|
361
|
+
// http bearer authentication required
|
|
362
|
+
_a.sent();
|
|
363
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
364
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
365
|
+
}
|
|
366
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
367
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
368
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
369
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
370
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(patchCommissionAgreementStatusRequestDto, localVarRequestOptions, configuration);
|
|
371
|
+
return [2 /*return*/, {
|
|
372
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
373
|
+
options: localVarRequestOptions,
|
|
374
|
+
}];
|
|
375
|
+
}
|
|
376
|
+
});
|
|
377
|
+
});
|
|
378
|
+
},
|
|
322
379
|
/**
|
|
323
380
|
* This will update commission agreement.
|
|
324
381
|
* @summary Update the commission agreement
|
|
@@ -473,6 +530,29 @@ var CommissionAgreementsApiFp = function (configuration) {
|
|
|
473
530
|
});
|
|
474
531
|
});
|
|
475
532
|
},
|
|
533
|
+
/**
|
|
534
|
+
* This will patch commission agreement status.
|
|
535
|
+
* @summary Update the commission agreement status
|
|
536
|
+
* @param {string} code
|
|
537
|
+
* @param {any} commissionAgreement Unique identifier for the object.
|
|
538
|
+
* @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
|
|
539
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
540
|
+
* @param {*} [options] Override http request option.
|
|
541
|
+
* @throws {RequiredError}
|
|
542
|
+
*/
|
|
543
|
+
patchCommissionAgreementStatus: function (code, commissionAgreement, patchCommissionAgreementStatusRequestDto, authorization, options) {
|
|
544
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
545
|
+
var localVarAxiosArgs;
|
|
546
|
+
return __generator(this, function (_a) {
|
|
547
|
+
switch (_a.label) {
|
|
548
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchCommissionAgreementStatus(code, commissionAgreement, patchCommissionAgreementStatusRequestDto, authorization, options)];
|
|
549
|
+
case 1:
|
|
550
|
+
localVarAxiosArgs = _a.sent();
|
|
551
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
552
|
+
}
|
|
553
|
+
});
|
|
554
|
+
});
|
|
555
|
+
},
|
|
476
556
|
/**
|
|
477
557
|
* This will update commission agreement.
|
|
478
558
|
* @summary Update the commission agreement
|
|
@@ -556,6 +636,19 @@ var CommissionAgreementsApiFactory = function (configuration, basePath, axios) {
|
|
|
556
636
|
listCommissionAgreements: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
557
637
|
return localVarFp.listCommissionAgreements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
558
638
|
},
|
|
639
|
+
/**
|
|
640
|
+
* This will patch commission agreement status.
|
|
641
|
+
* @summary Update the commission agreement status
|
|
642
|
+
* @param {string} code
|
|
643
|
+
* @param {any} commissionAgreement Unique identifier for the object.
|
|
644
|
+
* @param {PatchCommissionAgreementStatusRequestDto} patchCommissionAgreementStatusRequestDto
|
|
645
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
646
|
+
* @param {*} [options] Override http request option.
|
|
647
|
+
* @throws {RequiredError}
|
|
648
|
+
*/
|
|
649
|
+
patchCommissionAgreementStatus: function (code, commissionAgreement, patchCommissionAgreementStatusRequestDto, authorization, options) {
|
|
650
|
+
return localVarFp.patchCommissionAgreementStatus(code, commissionAgreement, patchCommissionAgreementStatusRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
651
|
+
},
|
|
559
652
|
/**
|
|
560
653
|
* This will update commission agreement.
|
|
561
654
|
* @summary Update the commission agreement
|
|
@@ -631,6 +724,18 @@ var CommissionAgreementsApi = /** @class */ (function (_super) {
|
|
|
631
724
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
632
725
|
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); });
|
|
633
726
|
};
|
|
727
|
+
/**
|
|
728
|
+
* This will patch commission agreement status.
|
|
729
|
+
* @summary Update the commission agreement status
|
|
730
|
+
* @param {CommissionAgreementsApiPatchCommissionAgreementStatusRequest} requestParameters Request parameters.
|
|
731
|
+
* @param {*} [options] Override http request option.
|
|
732
|
+
* @throws {RequiredError}
|
|
733
|
+
* @memberof CommissionAgreementsApi
|
|
734
|
+
*/
|
|
735
|
+
CommissionAgreementsApi.prototype.patchCommissionAgreementStatus = function (requestParameters, options) {
|
|
736
|
+
var _this = this;
|
|
737
|
+
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); });
|
|
738
|
+
};
|
|
634
739
|
/**
|
|
635
740
|
* This will update commission agreement.
|
|
636
741
|
* @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'}
|
|
@@ -255,7 +255,7 @@ var CommissionSettlementsApiAxiosParamCreator = function (configuration) {
|
|
|
255
255
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
256
256
|
* @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.
|
|
257
257
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
258
|
-
* @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.
|
|
258
|
+
* @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.
|
|
259
259
|
* @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.
|
|
260
260
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
261
261
|
* @param {*} [options] Override http request option.
|
|
@@ -503,7 +503,7 @@ var CommissionSettlementsApiFp = function (configuration) {
|
|
|
503
503
|
* @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.
|
|
504
504
|
* @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.
|
|
505
505
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
506
|
-
* @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.
|
|
506
|
+
* @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.
|
|
507
507
|
* @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.
|
|
508
508
|
* @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.
|
|
509
509
|
* @param {*} [options] Override http request option.
|
|
@@ -617,7 +617,7 @@ var CommissionSettlementsApiFactory = function (configuration, basePath, axios)
|
|
|
617
617
|
* @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.
|
|
618
618
|
* @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.
|
|
619
619
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
620
|
-
* @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.
|
|
620
|
+
* @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.
|
|
621
621
|
* @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.
|
|
622
622
|
* @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.
|
|
623
623
|
* @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'}
|
|
@@ -255,7 +255,7 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
|
|
|
255
255
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
256
256
|
* @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.
|
|
257
257
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
258
|
-
* @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.
|
|
258
|
+
* @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.
|
|
259
259
|
* @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.
|
|
260
260
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
261
261
|
* @param {*} [options] Override http request option.
|
|
@@ -454,7 +454,7 @@ var CommissionsApiFp = function (configuration) {
|
|
|
454
454
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
455
455
|
* @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.
|
|
456
456
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
457
|
-
* @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.
|
|
457
|
+
* @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.
|
|
458
458
|
* @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.
|
|
459
459
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
460
460
|
* @param {*} [options] Override http request option.
|
|
@@ -547,7 +547,7 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
|
|
|
547
547
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
548
548
|
* @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.
|
|
549
549
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
550
|
-
* @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.
|
|
550
|
+
* @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.
|
|
551
551
|
* @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.
|
|
552
552
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
553
553
|
* @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
|
+
|