@emilgroup/claim-sdk 1.34.0 → 1.34.1-beta.1

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/api/claims-api.ts CHANGED
@@ -45,7 +45,7 @@ import { UpdateClaimResponseClass } from '../models';
45
45
  export const ClaimsApiAxiosParamCreator = function (configuration?: Configuration) {
46
46
  return {
47
47
  /**
48
- * This will create a claim in the database
48
+ * This will create a claim in the database **Required Permissions** \"claim-management.claims.create\"
49
49
  * @summary Create the claim
50
50
  * @param {CreateClaimRequestDto} createClaimRequestDto
51
51
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -92,7 +92,7 @@ export const ClaimsApiAxiosParamCreator = function (configuration?: Configuratio
92
92
  };
93
93
  },
94
94
  /**
95
- * This will delete the requested claim from the database.
95
+ * This will delete the requested claim from the database. **Required Permissions** \"claim-management.claims.delete\"
96
96
  * @summary Delete the claim
97
97
  * @param {string} code
98
98
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -137,7 +137,7 @@ export const ClaimsApiAxiosParamCreator = function (configuration?: Configuratio
137
137
  };
138
138
  },
139
139
  /**
140
- * This will fetch the identified claim from the database by code
140
+ * This will fetch the identified claim from the database by code **Required Permissions** \"claim-management.claims.view\"
141
141
  * @summary Retrieve the claim
142
142
  * @param {string} code
143
143
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -182,7 +182,7 @@ export const ClaimsApiAxiosParamCreator = function (configuration?: Configuratio
182
182
  };
183
183
  },
184
184
  /**
185
- * This endpoint will calculate and get the regulation summary for a claim.
185
+ * This endpoint will calculate and get the regulation summary for a claim. **Required Permissions** \"claim-management.claims.view\", \"claim-management.regulations.view\"
186
186
  * @summary Retrieve the claim regulation summary
187
187
  * @param {string} code Unique identifier for the object.
188
188
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -227,11 +227,11 @@ export const ClaimsApiAxiosParamCreator = function (configuration?: Configuratio
227
227
  };
228
228
  },
229
229
  /**
230
- * Returns a list of claims you have previously created. The claims are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
230
+ * Returns a list of claims you have previously created. The claims are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"claim-management.claims.view\"
231
231
  * @summary List claims
232
232
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
233
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
234
- * @param {any} [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.
233
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
234
+ * @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.
235
235
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: policyNumber, productId, accountCode, insuredObjectId, policyCode</i>
236
236
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, policyCode, accountCode, productName, claimNumber, policyNumber, damageDate, notificationDate, description, status</i>
237
237
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, accountCode, status, claimNumber, policyNumber, damageDate, notificationDate, description, createdAt, updatedAt</i>
@@ -240,7 +240,7 @@ export const ClaimsApiAxiosParamCreator = function (configuration?: Configuratio
240
240
  * @param {*} [options] Override http request option.
241
241
  * @throws {RequiredError}
242
242
  */
243
- listClaims: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
243
+ listClaims: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
244
244
  const localVarPath = `/v1/claims`;
245
245
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
246
246
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -303,7 +303,7 @@ export const ClaimsApiAxiosParamCreator = function (configuration?: Configuratio
303
303
  };
304
304
  },
305
305
  /**
306
- * Updates the identified claim by setting the values of the provided parameters. Any parameters not provided will be left unchanged.
306
+ * Updates the identified claim by setting the values of the provided parameters. Any parameters not provided will be left unchanged. **Required Permissions** \"claim-management.claims.update\"
307
307
  * @summary Patch the claim
308
308
  * @param {string} code
309
309
  * @param {PatchClaimRequestDto} patchClaimRequestDto
@@ -354,7 +354,7 @@ export const ClaimsApiAxiosParamCreator = function (configuration?: Configuratio
354
354
  };
355
355
  },
356
356
  /**
357
- * This will update the identified claim in the database
357
+ * This will update the identified claim in the database **Required Permissions** \"claim-management.claims.update\"
358
358
  * @summary Update the claim
359
359
  * @param {string} code
360
360
  * @param {UpdateClaimRequestDto} updateClaimRequestDto
@@ -415,7 +415,7 @@ export const ClaimsApiFp = function(configuration?: Configuration) {
415
415
  const localVarAxiosParamCreator = ClaimsApiAxiosParamCreator(configuration)
416
416
  return {
417
417
  /**
418
- * This will create a claim in the database
418
+ * This will create a claim in the database **Required Permissions** \"claim-management.claims.create\"
419
419
  * @summary Create the claim
420
420
  * @param {CreateClaimRequestDto} createClaimRequestDto
421
421
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -427,7 +427,7 @@ export const ClaimsApiFp = function(configuration?: Configuration) {
427
427
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
428
428
  },
429
429
  /**
430
- * This will delete the requested claim from the database.
430
+ * This will delete the requested claim from the database. **Required Permissions** \"claim-management.claims.delete\"
431
431
  * @summary Delete the claim
432
432
  * @param {string} code
433
433
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -439,7 +439,7 @@ export const ClaimsApiFp = function(configuration?: Configuration) {
439
439
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
440
440
  },
441
441
  /**
442
- * This will fetch the identified claim from the database by code
442
+ * This will fetch the identified claim from the database by code **Required Permissions** \"claim-management.claims.view\"
443
443
  * @summary Retrieve the claim
444
444
  * @param {string} code
445
445
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -451,7 +451,7 @@ export const ClaimsApiFp = function(configuration?: Configuration) {
451
451
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
452
452
  },
453
453
  /**
454
- * This endpoint will calculate and get the regulation summary for a claim.
454
+ * This endpoint will calculate and get the regulation summary for a claim. **Required Permissions** \"claim-management.claims.view\", \"claim-management.regulations.view\"
455
455
  * @summary Retrieve the claim regulation summary
456
456
  * @param {string} code Unique identifier for the object.
457
457
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -463,11 +463,11 @@ export const ClaimsApiFp = function(configuration?: Configuration) {
463
463
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
464
464
  },
465
465
  /**
466
- * Returns a list of claims you have previously created. The claims are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
466
+ * Returns a list of claims you have previously created. The claims are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"claim-management.claims.view\"
467
467
  * @summary List claims
468
468
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
469
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
470
- * @param {any} [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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
469
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
470
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
471
471
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: policyNumber, productId, accountCode, insuredObjectId, policyCode&lt;/i&gt;
472
472
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, policyCode, accountCode, productName, claimNumber, policyNumber, damageDate, notificationDate, description, status&lt;/i&gt;
473
473
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, accountCode, status, claimNumber, policyNumber, damageDate, notificationDate, description, createdAt, updatedAt&lt;/i&gt;
@@ -476,12 +476,12 @@ export const ClaimsApiFp = function(configuration?: Configuration) {
476
476
  * @param {*} [options] Override http request option.
477
477
  * @throws {RequiredError}
478
478
  */
479
- async listClaims(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListClaimsResponseClass>> {
479
+ async listClaims(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListClaimsResponseClass>> {
480
480
  const localVarAxiosArgs = await localVarAxiosParamCreator.listClaims(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
481
481
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
482
482
  },
483
483
  /**
484
- * Updates the identified claim by setting the values of the provided parameters. Any parameters not provided will be left unchanged.
484
+ * Updates the identified claim by setting the values of the provided parameters. Any parameters not provided will be left unchanged. **Required Permissions** \"claim-management.claims.update\"
485
485
  * @summary Patch the claim
486
486
  * @param {string} code
487
487
  * @param {PatchClaimRequestDto} patchClaimRequestDto
@@ -494,7 +494,7 @@ export const ClaimsApiFp = function(configuration?: Configuration) {
494
494
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
495
495
  },
496
496
  /**
497
- * This will update the identified claim in the database
497
+ * This will update the identified claim in the database **Required Permissions** \"claim-management.claims.update\"
498
498
  * @summary Update the claim
499
499
  * @param {string} code
500
500
  * @param {UpdateClaimRequestDto} updateClaimRequestDto
@@ -517,7 +517,7 @@ export const ClaimsApiFactory = function (configuration?: Configuration, basePat
517
517
  const localVarFp = ClaimsApiFp(configuration)
518
518
  return {
519
519
  /**
520
- * This will create a claim in the database
520
+ * This will create a claim in the database **Required Permissions** \"claim-management.claims.create\"
521
521
  * @summary Create the claim
522
522
  * @param {CreateClaimRequestDto} createClaimRequestDto
523
523
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -528,7 +528,7 @@ export const ClaimsApiFactory = function (configuration?: Configuration, basePat
528
528
  return localVarFp.createClaim(createClaimRequestDto, authorization, options).then((request) => request(axios, basePath));
529
529
  },
530
530
  /**
531
- * This will delete the requested claim from the database.
531
+ * This will delete the requested claim from the database. **Required Permissions** \"claim-management.claims.delete\"
532
532
  * @summary Delete the claim
533
533
  * @param {string} code
534
534
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -539,7 +539,7 @@ export const ClaimsApiFactory = function (configuration?: Configuration, basePat
539
539
  return localVarFp.deleteClaim(code, authorization, options).then((request) => request(axios, basePath));
540
540
  },
541
541
  /**
542
- * This will fetch the identified claim from the database by code
542
+ * This will fetch the identified claim from the database by code **Required Permissions** \"claim-management.claims.view\"
543
543
  * @summary Retrieve the claim
544
544
  * @param {string} code
545
545
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -550,7 +550,7 @@ export const ClaimsApiFactory = function (configuration?: Configuration, basePat
550
550
  return localVarFp.getClaim(code, authorization, options).then((request) => request(axios, basePath));
551
551
  },
552
552
  /**
553
- * This endpoint will calculate and get the regulation summary for a claim.
553
+ * This endpoint will calculate and get the regulation summary for a claim. **Required Permissions** \"claim-management.claims.view\", \"claim-management.regulations.view\"
554
554
  * @summary Retrieve the claim regulation summary
555
555
  * @param {string} code Unique identifier for the object.
556
556
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -561,11 +561,11 @@ export const ClaimsApiFactory = function (configuration?: Configuration, basePat
561
561
  return localVarFp.getClaimRegulationSummary(code, authorization, options).then((request) => request(axios, basePath));
562
562
  },
563
563
  /**
564
- * Returns a list of claims you have previously created. The claims are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
564
+ * Returns a list of claims you have previously created. The claims are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"claim-management.claims.view\"
565
565
  * @summary List claims
566
566
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
567
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
568
- * @param {any} [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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
567
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
568
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
569
569
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: policyNumber, productId, accountCode, insuredObjectId, policyCode&lt;/i&gt;
570
570
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, policyCode, accountCode, productName, claimNumber, policyNumber, damageDate, notificationDate, description, status&lt;/i&gt;
571
571
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, accountCode, status, claimNumber, policyNumber, damageDate, notificationDate, description, createdAt, updatedAt&lt;/i&gt;
@@ -574,11 +574,11 @@ export const ClaimsApiFactory = function (configuration?: Configuration, basePat
574
574
  * @param {*} [options] Override http request option.
575
575
  * @throws {RequiredError}
576
576
  */
577
- listClaims(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListClaimsResponseClass> {
577
+ listClaims(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListClaimsResponseClass> {
578
578
  return localVarFp.listClaims(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
579
579
  },
580
580
  /**
581
- * Updates the identified claim by setting the values of the provided parameters. Any parameters not provided will be left unchanged.
581
+ * Updates the identified claim by setting the values of the provided parameters. Any parameters not provided will be left unchanged. **Required Permissions** \"claim-management.claims.update\"
582
582
  * @summary Patch the claim
583
583
  * @param {string} code
584
584
  * @param {PatchClaimRequestDto} patchClaimRequestDto
@@ -590,7 +590,7 @@ export const ClaimsApiFactory = function (configuration?: Configuration, basePat
590
590
  return localVarFp.patchClaim(code, patchClaimRequestDto, authorization, options).then((request) => request(axios, basePath));
591
591
  },
592
592
  /**
593
- * This will update the identified claim in the database
593
+ * This will update the identified claim in the database **Required Permissions** \"claim-management.claims.update\"
594
594
  * @summary Update the claim
595
595
  * @param {string} code
596
596
  * @param {UpdateClaimRequestDto} updateClaimRequestDto
@@ -703,17 +703,17 @@ export interface ClaimsApiListClaimsRequest {
703
703
 
704
704
  /**
705
705
  * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
706
- * @type {any}
706
+ * @type {number}
707
707
  * @memberof ClaimsApiListClaims
708
708
  */
709
- readonly pageSize?: any
709
+ readonly pageSize?: number
710
710
 
711
711
  /**
712
- * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
713
- * @type {any}
712
+ * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
713
+ * @type {string}
714
714
  * @memberof ClaimsApiListClaims
715
715
  */
716
- readonly pageToken?: any
716
+ readonly pageToken?: string
717
717
 
718
718
  /**
719
719
  * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: policyNumber, productId, accountCode, insuredObjectId, policyCode&lt;/i&gt;
@@ -815,7 +815,7 @@ export interface ClaimsApiUpdateClaimRequest {
815
815
  */
816
816
  export class ClaimsApi extends BaseAPI {
817
817
  /**
818
- * This will create a claim in the database
818
+ * This will create a claim in the database **Required Permissions** \"claim-management.claims.create\"
819
819
  * @summary Create the claim
820
820
  * @param {ClaimsApiCreateClaimRequest} requestParameters Request parameters.
821
821
  * @param {*} [options] Override http request option.
@@ -827,7 +827,7 @@ export class ClaimsApi extends BaseAPI {
827
827
  }
828
828
 
829
829
  /**
830
- * This will delete the requested claim from the database.
830
+ * This will delete the requested claim from the database. **Required Permissions** \"claim-management.claims.delete\"
831
831
  * @summary Delete the claim
832
832
  * @param {ClaimsApiDeleteClaimRequest} requestParameters Request parameters.
833
833
  * @param {*} [options] Override http request option.
@@ -839,7 +839,7 @@ export class ClaimsApi extends BaseAPI {
839
839
  }
840
840
 
841
841
  /**
842
- * This will fetch the identified claim from the database by code
842
+ * This will fetch the identified claim from the database by code **Required Permissions** \"claim-management.claims.view\"
843
843
  * @summary Retrieve the claim
844
844
  * @param {ClaimsApiGetClaimRequest} requestParameters Request parameters.
845
845
  * @param {*} [options] Override http request option.
@@ -851,7 +851,7 @@ export class ClaimsApi extends BaseAPI {
851
851
  }
852
852
 
853
853
  /**
854
- * This endpoint will calculate and get the regulation summary for a claim.
854
+ * This endpoint will calculate and get the regulation summary for a claim. **Required Permissions** \"claim-management.claims.view\", \"claim-management.regulations.view\"
855
855
  * @summary Retrieve the claim regulation summary
856
856
  * @param {ClaimsApiGetClaimRegulationSummaryRequest} requestParameters Request parameters.
857
857
  * @param {*} [options] Override http request option.
@@ -863,7 +863,7 @@ export class ClaimsApi extends BaseAPI {
863
863
  }
864
864
 
865
865
  /**
866
- * Returns a list of claims you have previously created. The claims are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
866
+ * Returns a list of claims you have previously created. The claims are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"claim-management.claims.view\"
867
867
  * @summary List claims
868
868
  * @param {ClaimsApiListClaimsRequest} requestParameters Request parameters.
869
869
  * @param {*} [options] Override http request option.
@@ -875,7 +875,7 @@ export class ClaimsApi extends BaseAPI {
875
875
  }
876
876
 
877
877
  /**
878
- * Updates the identified claim by setting the values of the provided parameters. Any parameters not provided will be left unchanged.
878
+ * Updates the identified claim by setting the values of the provided parameters. Any parameters not provided will be left unchanged. **Required Permissions** \"claim-management.claims.update\"
879
879
  * @summary Patch the claim
880
880
  * @param {ClaimsApiPatchClaimRequest} requestParameters Request parameters.
881
881
  * @param {*} [options] Override http request option.
@@ -887,7 +887,7 @@ export class ClaimsApi extends BaseAPI {
887
887
  }
888
888
 
889
889
  /**
890
- * This will update the identified claim in the database
890
+ * This will update the identified claim in the database **Required Permissions** \"claim-management.claims.update\"
891
891
  * @summary Update the claim
892
892
  * @param {ClaimsApiUpdateClaimRequest} requestParameters Request parameters.
893
893
  * @param {*} [options] Override http request option.
@@ -39,7 +39,7 @@ import { UpdateSettlementResponseClass } from '../models';
39
39
  export const SettlementsApiAxiosParamCreator = function (configuration?: Configuration) {
40
40
  return {
41
41
  /**
42
- * This will create a settlement against a claim in the database
42
+ * This will create a settlement against a claim in the database **Required Permissions** \"claim-management.claims.create\"
43
43
  * @summary Create the settlement
44
44
  * @param {CreateSettlementRequestDto} createSettlementRequestDto
45
45
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -86,7 +86,7 @@ export const SettlementsApiAxiosParamCreator = function (configuration?: Configu
86
86
  };
87
87
  },
88
88
  /**
89
- * This will delete the requested settlement from the database.
89
+ * This will delete the requested settlement from the database. **Required Permissions** \"claim-management.claims.delete\"
90
90
  * @summary Delete the settlement
91
91
  * @param {string} code
92
92
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -131,7 +131,7 @@ export const SettlementsApiAxiosParamCreator = function (configuration?: Configu
131
131
  };
132
132
  },
133
133
  /**
134
- * Retrieves the details of the settlement that was previously created. Supply the unique settlement code that was returned when you created it and Emil Api will return the corresponding settlement information.
134
+ * Retrieves the details of the settlement that was previously created. Supply the unique settlement code that was returned when you created it and Emil Api will return the corresponding settlement information. **Required Permissions** \"claim-management.claims.view\"
135
135
  * @summary Retrieve the settlement
136
136
  * @param {string} code
137
137
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -176,20 +176,20 @@ export const SettlementsApiAxiosParamCreator = function (configuration?: Configu
176
176
  };
177
177
  },
178
178
  /**
179
- * Returns a list of settlements you have previously created. The settlements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
179
+ * Returns a list of settlements you have previously created. The settlements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"claim-management.claims.view\"
180
180
  * @summary List settlements
181
181
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
182
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
183
- * @param {any} [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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
182
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
183
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
184
184
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: policyNumber, productId, accountCode, claimCode, InsuredObjectId&lt;/i&gt;
185
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
185
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
186
186
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: insuredObject, reserve, payment, recourse&lt;/i&gt;
187
187
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: claims&lt;i&gt;
188
188
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: policyNumber, productId, accountCode, claimCode, InsuredObjectId&lt;/i&gt;
189
189
  * @param {*} [options] Override http request option.
190
190
  * @throws {RequiredError}
191
191
  */
192
- listSettlements: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
192
+ listSettlements: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
193
193
  const localVarPath = `/v1/settlements`;
194
194
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
195
195
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -252,7 +252,7 @@ export const SettlementsApiAxiosParamCreator = function (configuration?: Configu
252
252
  };
253
253
  },
254
254
  /**
255
- * Updates the specified settlement by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
255
+ * Updates the specified settlement by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"claim-management.claims.update\"
256
256
  * @summary Update the settlement
257
257
  * @param {string} code
258
258
  * @param {UpdateSettlementRequestDto} updateSettlementRequestDto
@@ -313,7 +313,7 @@ export const SettlementsApiFp = function(configuration?: Configuration) {
313
313
  const localVarAxiosParamCreator = SettlementsApiAxiosParamCreator(configuration)
314
314
  return {
315
315
  /**
316
- * This will create a settlement against a claim in the database
316
+ * This will create a settlement against a claim in the database **Required Permissions** \"claim-management.claims.create\"
317
317
  * @summary Create the settlement
318
318
  * @param {CreateSettlementRequestDto} createSettlementRequestDto
319
319
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -325,7 +325,7 @@ export const SettlementsApiFp = function(configuration?: Configuration) {
325
325
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
326
326
  },
327
327
  /**
328
- * This will delete the requested settlement from the database.
328
+ * This will delete the requested settlement from the database. **Required Permissions** \"claim-management.claims.delete\"
329
329
  * @summary Delete the settlement
330
330
  * @param {string} code
331
331
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -337,7 +337,7 @@ export const SettlementsApiFp = function(configuration?: Configuration) {
337
337
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
338
338
  },
339
339
  /**
340
- * Retrieves the details of the settlement that was previously created. Supply the unique settlement code that was returned when you created it and Emil Api will return the corresponding settlement information.
340
+ * Retrieves the details of the settlement that was previously created. Supply the unique settlement code that was returned when you created it and Emil Api will return the corresponding settlement information. **Required Permissions** \"claim-management.claims.view\"
341
341
  * @summary Retrieve the settlement
342
342
  * @param {string} code
343
343
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -349,25 +349,25 @@ export const SettlementsApiFp = function(configuration?: Configuration) {
349
349
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
350
350
  },
351
351
  /**
352
- * Returns a list of settlements you have previously created. The settlements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
352
+ * Returns a list of settlements you have previously created. The settlements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"claim-management.claims.view\"
353
353
  * @summary List settlements
354
354
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
355
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
356
- * @param {any} [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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
355
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
356
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
357
357
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: policyNumber, productId, accountCode, claimCode, InsuredObjectId&lt;/i&gt;
358
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
358
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
359
359
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: insuredObject, reserve, payment, recourse&lt;/i&gt;
360
360
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: claims&lt;i&gt;
361
361
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: policyNumber, productId, accountCode, claimCode, InsuredObjectId&lt;/i&gt;
362
362
  * @param {*} [options] Override http request option.
363
363
  * @throws {RequiredError}
364
364
  */
365
- async listSettlements(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSettlementsResponseClass>> {
365
+ async listSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSettlementsResponseClass>> {
366
366
  const localVarAxiosArgs = await localVarAxiosParamCreator.listSettlements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
367
367
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
368
368
  },
369
369
  /**
370
- * Updates the specified settlement by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
370
+ * Updates the specified settlement by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"claim-management.claims.update\"
371
371
  * @summary Update the settlement
372
372
  * @param {string} code
373
373
  * @param {UpdateSettlementRequestDto} updateSettlementRequestDto
@@ -390,7 +390,7 @@ export const SettlementsApiFactory = function (configuration?: Configuration, ba
390
390
  const localVarFp = SettlementsApiFp(configuration)
391
391
  return {
392
392
  /**
393
- * This will create a settlement against a claim in the database
393
+ * This will create a settlement against a claim in the database **Required Permissions** \"claim-management.claims.create\"
394
394
  * @summary Create the settlement
395
395
  * @param {CreateSettlementRequestDto} createSettlementRequestDto
396
396
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -401,7 +401,7 @@ export const SettlementsApiFactory = function (configuration?: Configuration, ba
401
401
  return localVarFp.createSettlement(createSettlementRequestDto, authorization, options).then((request) => request(axios, basePath));
402
402
  },
403
403
  /**
404
- * This will delete the requested settlement from the database.
404
+ * This will delete the requested settlement from the database. **Required Permissions** \"claim-management.claims.delete\"
405
405
  * @summary Delete the settlement
406
406
  * @param {string} code
407
407
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -412,7 +412,7 @@ export const SettlementsApiFactory = function (configuration?: Configuration, ba
412
412
  return localVarFp.deleteSettlement(code, authorization, options).then((request) => request(axios, basePath));
413
413
  },
414
414
  /**
415
- * Retrieves the details of the settlement that was previously created. Supply the unique settlement code that was returned when you created it and Emil Api will return the corresponding settlement information.
415
+ * Retrieves the details of the settlement that was previously created. Supply the unique settlement code that was returned when you created it and Emil Api will return the corresponding settlement information. **Required Permissions** \"claim-management.claims.view\"
416
416
  * @summary Retrieve the settlement
417
417
  * @param {string} code
418
418
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -423,24 +423,24 @@ export const SettlementsApiFactory = function (configuration?: Configuration, ba
423
423
  return localVarFp.getSettlement(code, authorization, options).then((request) => request(axios, basePath));
424
424
  },
425
425
  /**
426
- * Returns a list of settlements you have previously created. The settlements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
426
+ * Returns a list of settlements you have previously created. The settlements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"claim-management.claims.view\"
427
427
  * @summary List settlements
428
428
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
429
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
430
- * @param {any} [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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
429
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
430
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
431
431
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: policyNumber, productId, accountCode, claimCode, InsuredObjectId&lt;/i&gt;
432
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
432
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
433
433
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: insuredObject, reserve, payment, recourse&lt;/i&gt;
434
434
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: claims&lt;i&gt;
435
435
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: policyNumber, productId, accountCode, claimCode, InsuredObjectId&lt;/i&gt;
436
436
  * @param {*} [options] Override http request option.
437
437
  * @throws {RequiredError}
438
438
  */
439
- listSettlements(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListSettlementsResponseClass> {
439
+ listSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListSettlementsResponseClass> {
440
440
  return localVarFp.listSettlements(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
441
441
  },
442
442
  /**
443
- * Updates the specified settlement by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
443
+ * Updates the specified settlement by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"claim-management.claims.update\"
444
444
  * @summary Update the settlement
445
445
  * @param {string} code
446
446
  * @param {UpdateSettlementRequestDto} updateSettlementRequestDto
@@ -532,17 +532,17 @@ export interface SettlementsApiListSettlementsRequest {
532
532
 
533
533
  /**
534
534
  * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
535
- * @type {any}
535
+ * @type {number}
536
536
  * @memberof SettlementsApiListSettlements
537
537
  */
538
- readonly pageSize?: any
538
+ readonly pageSize?: number
539
539
 
540
540
  /**
541
- * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
542
- * @type {any}
541
+ * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
542
+ * @type {string}
543
543
  * @memberof SettlementsApiListSettlements
544
544
  */
545
- readonly pageToken?: any
545
+ readonly pageToken?: string
546
546
 
547
547
  /**
548
548
  * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: policyNumber, productId, accountCode, claimCode, InsuredObjectId&lt;/i&gt;
@@ -553,10 +553,10 @@ export interface SettlementsApiListSettlementsRequest {
553
553
 
554
554
  /**
555
555
  * To search the list by any field, pass search&#x3D;xxx to fetch the result.
556
- * @type {any}
556
+ * @type {string}
557
557
  * @memberof SettlementsApiListSettlements
558
558
  */
559
- readonly search?: any
559
+ readonly search?: string
560
560
 
561
561
  /**
562
562
  * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: insuredObject, reserve, payment, recourse&lt;/i&gt;
@@ -616,7 +616,7 @@ export interface SettlementsApiUpdateSettlementRequest {
616
616
  */
617
617
  export class SettlementsApi extends BaseAPI {
618
618
  /**
619
- * This will create a settlement against a claim in the database
619
+ * This will create a settlement against a claim in the database **Required Permissions** \"claim-management.claims.create\"
620
620
  * @summary Create the settlement
621
621
  * @param {SettlementsApiCreateSettlementRequest} requestParameters Request parameters.
622
622
  * @param {*} [options] Override http request option.
@@ -628,7 +628,7 @@ export class SettlementsApi extends BaseAPI {
628
628
  }
629
629
 
630
630
  /**
631
- * This will delete the requested settlement from the database.
631
+ * This will delete the requested settlement from the database. **Required Permissions** \"claim-management.claims.delete\"
632
632
  * @summary Delete the settlement
633
633
  * @param {SettlementsApiDeleteSettlementRequest} requestParameters Request parameters.
634
634
  * @param {*} [options] Override http request option.
@@ -640,7 +640,7 @@ export class SettlementsApi extends BaseAPI {
640
640
  }
641
641
 
642
642
  /**
643
- * Retrieves the details of the settlement that was previously created. Supply the unique settlement code that was returned when you created it and Emil Api will return the corresponding settlement information.
643
+ * Retrieves the details of the settlement that was previously created. Supply the unique settlement code that was returned when you created it and Emil Api will return the corresponding settlement information. **Required Permissions** \"claim-management.claims.view\"
644
644
  * @summary Retrieve the settlement
645
645
  * @param {SettlementsApiGetSettlementRequest} requestParameters Request parameters.
646
646
  * @param {*} [options] Override http request option.
@@ -652,7 +652,7 @@ export class SettlementsApi extends BaseAPI {
652
652
  }
653
653
 
654
654
  /**
655
- * Returns a list of settlements you have previously created. The settlements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
655
+ * Returns a list of settlements you have previously created. The settlements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"claim-management.claims.view\"
656
656
  * @summary List settlements
657
657
  * @param {SettlementsApiListSettlementsRequest} requestParameters Request parameters.
658
658
  * @param {*} [options] Override http request option.
@@ -664,7 +664,7 @@ export class SettlementsApi extends BaseAPI {
664
664
  }
665
665
 
666
666
  /**
667
- * Updates the specified settlement by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
667
+ * Updates the specified settlement by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"claim-management.claims.update\"
668
668
  * @summary Update the settlement
669
669
  * @param {SettlementsApiUpdateSettlementRequest} requestParameters Request parameters.
670
670
  * @param {*} [options] Override http request option.