@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.
@@ -27,7 +27,7 @@ import { UpdateClaimResponseClass } from '../models';
27
27
  */
28
28
  export declare const ClaimsApiAxiosParamCreator: (configuration?: Configuration) => {
29
29
  /**
30
- * This will create a claim in the database
30
+ * This will create a claim in the database **Required Permissions** \"claim-management.claims.create\"
31
31
  * @summary Create the claim
32
32
  * @param {CreateClaimRequestDto} createClaimRequestDto
33
33
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -36,7 +36,7 @@ export declare const ClaimsApiAxiosParamCreator: (configuration?: Configuration)
36
36
  */
37
37
  createClaim: (createClaimRequestDto: CreateClaimRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
38
38
  /**
39
- * This will delete the requested claim from the database.
39
+ * This will delete the requested claim from the database. **Required Permissions** \"claim-management.claims.delete\"
40
40
  * @summary Delete the claim
41
41
  * @param {string} code
42
42
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -45,7 +45,7 @@ export declare const ClaimsApiAxiosParamCreator: (configuration?: Configuration)
45
45
  */
46
46
  deleteClaim: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
47
47
  /**
48
- * This will fetch the identified claim from the database by code
48
+ * This will fetch the identified claim from the database by code **Required Permissions** \"claim-management.claims.view\"
49
49
  * @summary Retrieve the claim
50
50
  * @param {string} code
51
51
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -54,7 +54,7 @@ export declare const ClaimsApiAxiosParamCreator: (configuration?: Configuration)
54
54
  */
55
55
  getClaim: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
56
56
  /**
57
- * This endpoint will calculate and get the regulation summary for a claim.
57
+ * This endpoint will calculate and get the regulation summary for a claim. **Required Permissions** \"claim-management.claims.view\", \"claim-management.regulations.view\"
58
58
  * @summary Retrieve the claim regulation summary
59
59
  * @param {string} code Unique identifier for the object.
60
60
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -63,11 +63,11 @@ export declare const ClaimsApiAxiosParamCreator: (configuration?: Configuration)
63
63
  */
64
64
  getClaimRegulationSummary: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
65
65
  /**
66
- * 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.
66
+ * 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\"
67
67
  * @summary List claims
68
68
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
69
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
70
- * @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.
69
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
70
+ * @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.
71
71
  * @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;
72
72
  * @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;
73
73
  * @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;
@@ -76,9 +76,9 @@ export declare const ClaimsApiAxiosParamCreator: (configuration?: Configuration)
76
76
  * @param {*} [options] Override http request option.
77
77
  * @throws {RequiredError}
78
78
  */
79
- listClaims: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
79
+ listClaims: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
80
80
  /**
81
- * Updates the identified claim by setting the values of the provided parameters. Any parameters not provided will be left unchanged.
81
+ * 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\"
82
82
  * @summary Patch the claim
83
83
  * @param {string} code
84
84
  * @param {PatchClaimRequestDto} patchClaimRequestDto
@@ -88,7 +88,7 @@ export declare const ClaimsApiAxiosParamCreator: (configuration?: Configuration)
88
88
  */
89
89
  patchClaim: (code: string, patchClaimRequestDto: PatchClaimRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
90
90
  /**
91
- * This will update the identified claim in the database
91
+ * This will update the identified claim in the database **Required Permissions** \"claim-management.claims.update\"
92
92
  * @summary Update the claim
93
93
  * @param {string} code
94
94
  * @param {UpdateClaimRequestDto} updateClaimRequestDto
@@ -104,7 +104,7 @@ export declare const ClaimsApiAxiosParamCreator: (configuration?: Configuration)
104
104
  */
105
105
  export declare const ClaimsApiFp: (configuration?: Configuration) => {
106
106
  /**
107
- * This will create a claim in the database
107
+ * This will create a claim in the database **Required Permissions** \"claim-management.claims.create\"
108
108
  * @summary Create the claim
109
109
  * @param {CreateClaimRequestDto} createClaimRequestDto
110
110
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -113,7 +113,7 @@ export declare const ClaimsApiFp: (configuration?: Configuration) => {
113
113
  */
114
114
  createClaim(createClaimRequestDto: CreateClaimRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateClaimResponseClass>>;
115
115
  /**
116
- * This will delete the requested claim from the database.
116
+ * This will delete the requested claim from the database. **Required Permissions** \"claim-management.claims.delete\"
117
117
  * @summary Delete the claim
118
118
  * @param {string} code
119
119
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -122,7 +122,7 @@ export declare const ClaimsApiFp: (configuration?: Configuration) => {
122
122
  */
123
123
  deleteClaim(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
124
124
  /**
125
- * This will fetch the identified claim from the database by code
125
+ * This will fetch the identified claim from the database by code **Required Permissions** \"claim-management.claims.view\"
126
126
  * @summary Retrieve the claim
127
127
  * @param {string} code
128
128
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -131,7 +131,7 @@ export declare const ClaimsApiFp: (configuration?: Configuration) => {
131
131
  */
132
132
  getClaim(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetClaimResponseClass>>;
133
133
  /**
134
- * This endpoint will calculate and get the regulation summary for a claim.
134
+ * This endpoint will calculate and get the regulation summary for a claim. **Required Permissions** \"claim-management.claims.view\", \"claim-management.regulations.view\"
135
135
  * @summary Retrieve the claim regulation summary
136
136
  * @param {string} code Unique identifier for the object.
137
137
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -140,11 +140,11 @@ export declare const ClaimsApiFp: (configuration?: Configuration) => {
140
140
  */
141
141
  getClaimRegulationSummary(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RegulationSummaryResponseClass>>;
142
142
  /**
143
- * 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.
143
+ * 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\"
144
144
  * @summary List claims
145
145
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
146
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
147
- * @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.
146
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
147
+ * @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.
148
148
  * @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;
149
149
  * @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;
150
150
  * @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;
@@ -153,9 +153,9 @@ export declare const ClaimsApiFp: (configuration?: Configuration) => {
153
153
  * @param {*} [options] Override http request option.
154
154
  * @throws {RequiredError}
155
155
  */
156
- 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>>;
156
+ 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>>;
157
157
  /**
158
- * Updates the identified claim by setting the values of the provided parameters. Any parameters not provided will be left unchanged.
158
+ * 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\"
159
159
  * @summary Patch the claim
160
160
  * @param {string} code
161
161
  * @param {PatchClaimRequestDto} patchClaimRequestDto
@@ -165,7 +165,7 @@ export declare const ClaimsApiFp: (configuration?: Configuration) => {
165
165
  */
166
166
  patchClaim(code: string, patchClaimRequestDto: PatchClaimRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchClaimResponseClass>>;
167
167
  /**
168
- * This will update the identified claim in the database
168
+ * This will update the identified claim in the database **Required Permissions** \"claim-management.claims.update\"
169
169
  * @summary Update the claim
170
170
  * @param {string} code
171
171
  * @param {UpdateClaimRequestDto} updateClaimRequestDto
@@ -181,7 +181,7 @@ export declare const ClaimsApiFp: (configuration?: Configuration) => {
181
181
  */
182
182
  export declare const ClaimsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
183
183
  /**
184
- * This will create a claim in the database
184
+ * This will create a claim in the database **Required Permissions** \"claim-management.claims.create\"
185
185
  * @summary Create the claim
186
186
  * @param {CreateClaimRequestDto} createClaimRequestDto
187
187
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -190,7 +190,7 @@ export declare const ClaimsApiFactory: (configuration?: Configuration, basePath?
190
190
  */
191
191
  createClaim(createClaimRequestDto: CreateClaimRequestDto, authorization?: string, options?: any): AxiosPromise<CreateClaimResponseClass>;
192
192
  /**
193
- * This will delete the requested claim from the database.
193
+ * This will delete the requested claim from the database. **Required Permissions** \"claim-management.claims.delete\"
194
194
  * @summary Delete the claim
195
195
  * @param {string} code
196
196
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -199,7 +199,7 @@ export declare const ClaimsApiFactory: (configuration?: Configuration, basePath?
199
199
  */
200
200
  deleteClaim(code: string, authorization?: string, options?: any): AxiosPromise<void>;
201
201
  /**
202
- * This will fetch the identified claim from the database by code
202
+ * This will fetch the identified claim from the database by code **Required Permissions** \"claim-management.claims.view\"
203
203
  * @summary Retrieve the claim
204
204
  * @param {string} code
205
205
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -208,7 +208,7 @@ export declare const ClaimsApiFactory: (configuration?: Configuration, basePath?
208
208
  */
209
209
  getClaim(code: string, authorization?: string, options?: any): AxiosPromise<GetClaimResponseClass>;
210
210
  /**
211
- * This endpoint will calculate and get the regulation summary for a claim.
211
+ * This endpoint will calculate and get the regulation summary for a claim. **Required Permissions** \"claim-management.claims.view\", \"claim-management.regulations.view\"
212
212
  * @summary Retrieve the claim regulation summary
213
213
  * @param {string} code Unique identifier for the object.
214
214
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -217,11 +217,11 @@ export declare const ClaimsApiFactory: (configuration?: Configuration, basePath?
217
217
  */
218
218
  getClaimRegulationSummary(code: string, authorization?: string, options?: any): AxiosPromise<RegulationSummaryResponseClass>;
219
219
  /**
220
- * 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.
220
+ * 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\"
221
221
  * @summary List claims
222
222
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
223
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
224
- * @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.
223
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
224
+ * @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.
225
225
  * @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;
226
226
  * @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;
227
227
  * @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;
@@ -230,9 +230,9 @@ export declare const ClaimsApiFactory: (configuration?: Configuration, basePath?
230
230
  * @param {*} [options] Override http request option.
231
231
  * @throws {RequiredError}
232
232
  */
233
- listClaims(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListClaimsResponseClass>;
233
+ listClaims(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListClaimsResponseClass>;
234
234
  /**
235
- * Updates the identified claim by setting the values of the provided parameters. Any parameters not provided will be left unchanged.
235
+ * 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\"
236
236
  * @summary Patch the claim
237
237
  * @param {string} code
238
238
  * @param {PatchClaimRequestDto} patchClaimRequestDto
@@ -242,7 +242,7 @@ export declare const ClaimsApiFactory: (configuration?: Configuration, basePath?
242
242
  */
243
243
  patchClaim(code: string, patchClaimRequestDto: PatchClaimRequestDto, authorization?: string, options?: any): AxiosPromise<PatchClaimResponseClass>;
244
244
  /**
245
- * This will update the identified claim in the database
245
+ * This will update the identified claim in the database **Required Permissions** \"claim-management.claims.update\"
246
246
  * @summary Update the claim
247
247
  * @param {string} code
248
248
  * @param {UpdateClaimRequestDto} updateClaimRequestDto
@@ -342,16 +342,16 @@ export interface ClaimsApiListClaimsRequest {
342
342
  readonly authorization?: string;
343
343
  /**
344
344
  * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
345
- * @type {any}
345
+ * @type {number}
346
346
  * @memberof ClaimsApiListClaims
347
347
  */
348
- readonly pageSize?: any;
348
+ readonly pageSize?: number;
349
349
  /**
350
- * 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.
351
- * @type {any}
350
+ * 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.
351
+ * @type {string}
352
352
  * @memberof ClaimsApiListClaims
353
353
  */
354
- readonly pageToken?: any;
354
+ readonly pageToken?: string;
355
355
  /**
356
356
  * 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;
357
357
  * @type {string}
@@ -441,7 +441,7 @@ export interface ClaimsApiUpdateClaimRequest {
441
441
  */
442
442
  export declare class ClaimsApi extends BaseAPI {
443
443
  /**
444
- * This will create a claim in the database
444
+ * This will create a claim in the database **Required Permissions** \"claim-management.claims.create\"
445
445
  * @summary Create the claim
446
446
  * @param {ClaimsApiCreateClaimRequest} requestParameters Request parameters.
447
447
  * @param {*} [options] Override http request option.
@@ -450,7 +450,7 @@ export declare class ClaimsApi extends BaseAPI {
450
450
  */
451
451
  createClaim(requestParameters: ClaimsApiCreateClaimRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateClaimResponseClass, any>>;
452
452
  /**
453
- * This will delete the requested claim from the database.
453
+ * This will delete the requested claim from the database. **Required Permissions** \"claim-management.claims.delete\"
454
454
  * @summary Delete the claim
455
455
  * @param {ClaimsApiDeleteClaimRequest} requestParameters Request parameters.
456
456
  * @param {*} [options] Override http request option.
@@ -459,7 +459,7 @@ export declare class ClaimsApi extends BaseAPI {
459
459
  */
460
460
  deleteClaim(requestParameters: ClaimsApiDeleteClaimRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
461
461
  /**
462
- * This will fetch the identified claim from the database by code
462
+ * This will fetch the identified claim from the database by code **Required Permissions** \"claim-management.claims.view\"
463
463
  * @summary Retrieve the claim
464
464
  * @param {ClaimsApiGetClaimRequest} requestParameters Request parameters.
465
465
  * @param {*} [options] Override http request option.
@@ -468,7 +468,7 @@ export declare class ClaimsApi extends BaseAPI {
468
468
  */
469
469
  getClaim(requestParameters: ClaimsApiGetClaimRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetClaimResponseClass, any>>;
470
470
  /**
471
- * This endpoint will calculate and get the regulation summary for a claim.
471
+ * This endpoint will calculate and get the regulation summary for a claim. **Required Permissions** \"claim-management.claims.view\", \"claim-management.regulations.view\"
472
472
  * @summary Retrieve the claim regulation summary
473
473
  * @param {ClaimsApiGetClaimRegulationSummaryRequest} requestParameters Request parameters.
474
474
  * @param {*} [options] Override http request option.
@@ -477,7 +477,7 @@ export declare class ClaimsApi extends BaseAPI {
477
477
  */
478
478
  getClaimRegulationSummary(requestParameters: ClaimsApiGetClaimRegulationSummaryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RegulationSummaryResponseClass, any>>;
479
479
  /**
480
- * 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.
480
+ * 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\"
481
481
  * @summary List claims
482
482
  * @param {ClaimsApiListClaimsRequest} requestParameters Request parameters.
483
483
  * @param {*} [options] Override http request option.
@@ -486,7 +486,7 @@ export declare class ClaimsApi extends BaseAPI {
486
486
  */
487
487
  listClaims(requestParameters?: ClaimsApiListClaimsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListClaimsResponseClass, any>>;
488
488
  /**
489
- * Updates the identified claim by setting the values of the provided parameters. Any parameters not provided will be left unchanged.
489
+ * 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\"
490
490
  * @summary Patch the claim
491
491
  * @param {ClaimsApiPatchClaimRequest} requestParameters Request parameters.
492
492
  * @param {*} [options] Override http request option.
@@ -495,7 +495,7 @@ export declare class ClaimsApi extends BaseAPI {
495
495
  */
496
496
  patchClaim(requestParameters: ClaimsApiPatchClaimRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchClaimResponseClass, any>>;
497
497
  /**
498
- * This will update the identified claim in the database
498
+ * This will update the identified claim in the database **Required Permissions** \"claim-management.claims.update\"
499
499
  * @summary Update the claim
500
500
  * @param {ClaimsApiUpdateClaimRequest} requestParameters Request parameters.
501
501
  * @param {*} [options] Override http request option.
@@ -93,7 +93,7 @@ var ClaimsApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * This will create a claim in the database
96
+ * This will create a claim in the database **Required Permissions** \"claim-management.claims.create\"
97
97
  * @summary Create the claim
98
98
  * @param {CreateClaimRequestDto} createClaimRequestDto
99
99
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -142,7 +142,7 @@ var ClaimsApiAxiosParamCreator = function (configuration) {
142
142
  });
143
143
  },
144
144
  /**
145
- * This will delete the requested claim from the database.
145
+ * This will delete the requested claim from the database. **Required Permissions** \"claim-management.claims.delete\"
146
146
  * @summary Delete the claim
147
147
  * @param {string} code
148
148
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -190,7 +190,7 @@ var ClaimsApiAxiosParamCreator = function (configuration) {
190
190
  });
191
191
  },
192
192
  /**
193
- * This will fetch the identified claim from the database by code
193
+ * This will fetch the identified claim from the database by code **Required Permissions** \"claim-management.claims.view\"
194
194
  * @summary Retrieve the claim
195
195
  * @param {string} code
196
196
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -238,7 +238,7 @@ var ClaimsApiAxiosParamCreator = function (configuration) {
238
238
  });
239
239
  },
240
240
  /**
241
- * This endpoint will calculate and get the regulation summary for a claim.
241
+ * This endpoint will calculate and get the regulation summary for a claim. **Required Permissions** \"claim-management.claims.view\", \"claim-management.regulations.view\"
242
242
  * @summary Retrieve the claim regulation summary
243
243
  * @param {string} code Unique identifier for the object.
244
244
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -286,11 +286,11 @@ var ClaimsApiAxiosParamCreator = function (configuration) {
286
286
  });
287
287
  },
288
288
  /**
289
- * 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.
289
+ * 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\"
290
290
  * @summary List claims
291
291
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
292
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
293
- * @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.
292
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
293
+ * @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.
294
294
  * @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;
295
295
  * @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;
296
296
  * @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;
@@ -358,7 +358,7 @@ var ClaimsApiAxiosParamCreator = function (configuration) {
358
358
  });
359
359
  },
360
360
  /**
361
- * Updates the identified claim by setting the values of the provided parameters. Any parameters not provided will be left unchanged.
361
+ * 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\"
362
362
  * @summary Patch the claim
363
363
  * @param {string} code
364
364
  * @param {PatchClaimRequestDto} patchClaimRequestDto
@@ -411,7 +411,7 @@ var ClaimsApiAxiosParamCreator = function (configuration) {
411
411
  });
412
412
  },
413
413
  /**
414
- * This will update the identified claim in the database
414
+ * This will update the identified claim in the database **Required Permissions** \"claim-management.claims.update\"
415
415
  * @summary Update the claim
416
416
  * @param {string} code
417
417
  * @param {UpdateClaimRequestDto} updateClaimRequestDto
@@ -474,7 +474,7 @@ var ClaimsApiFp = function (configuration) {
474
474
  var localVarAxiosParamCreator = (0, exports.ClaimsApiAxiosParamCreator)(configuration);
475
475
  return {
476
476
  /**
477
- * This will create a claim in the database
477
+ * This will create a claim in the database **Required Permissions** \"claim-management.claims.create\"
478
478
  * @summary Create the claim
479
479
  * @param {CreateClaimRequestDto} createClaimRequestDto
480
480
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -495,7 +495,7 @@ var ClaimsApiFp = function (configuration) {
495
495
  });
496
496
  },
497
497
  /**
498
- * This will delete the requested claim from the database.
498
+ * This will delete the requested claim from the database. **Required Permissions** \"claim-management.claims.delete\"
499
499
  * @summary Delete the claim
500
500
  * @param {string} code
501
501
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -516,7 +516,7 @@ var ClaimsApiFp = function (configuration) {
516
516
  });
517
517
  },
518
518
  /**
519
- * This will fetch the identified claim from the database by code
519
+ * This will fetch the identified claim from the database by code **Required Permissions** \"claim-management.claims.view\"
520
520
  * @summary Retrieve the claim
521
521
  * @param {string} code
522
522
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -537,7 +537,7 @@ var ClaimsApiFp = function (configuration) {
537
537
  });
538
538
  },
539
539
  /**
540
- * This endpoint will calculate and get the regulation summary for a claim.
540
+ * This endpoint will calculate and get the regulation summary for a claim. **Required Permissions** \"claim-management.claims.view\", \"claim-management.regulations.view\"
541
541
  * @summary Retrieve the claim regulation summary
542
542
  * @param {string} code Unique identifier for the object.
543
543
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -558,11 +558,11 @@ var ClaimsApiFp = function (configuration) {
558
558
  });
559
559
  },
560
560
  /**
561
- * 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.
561
+ * 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\"
562
562
  * @summary List claims
563
563
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
564
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
565
- * @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.
564
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
565
+ * @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.
566
566
  * @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;
567
567
  * @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;
568
568
  * @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;
@@ -585,7 +585,7 @@ var ClaimsApiFp = function (configuration) {
585
585
  });
586
586
  },
587
587
  /**
588
- * Updates the identified claim by setting the values of the provided parameters. Any parameters not provided will be left unchanged.
588
+ * 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\"
589
589
  * @summary Patch the claim
590
590
  * @param {string} code
591
591
  * @param {PatchClaimRequestDto} patchClaimRequestDto
@@ -607,7 +607,7 @@ var ClaimsApiFp = function (configuration) {
607
607
  });
608
608
  },
609
609
  /**
610
- * This will update the identified claim in the database
610
+ * This will update the identified claim in the database **Required Permissions** \"claim-management.claims.update\"
611
611
  * @summary Update the claim
612
612
  * @param {string} code
613
613
  * @param {UpdateClaimRequestDto} updateClaimRequestDto
@@ -639,7 +639,7 @@ var ClaimsApiFactory = function (configuration, basePath, axios) {
639
639
  var localVarFp = (0, exports.ClaimsApiFp)(configuration);
640
640
  return {
641
641
  /**
642
- * This will create a claim in the database
642
+ * This will create a claim in the database **Required Permissions** \"claim-management.claims.create\"
643
643
  * @summary Create the claim
644
644
  * @param {CreateClaimRequestDto} createClaimRequestDto
645
645
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -650,7 +650,7 @@ var ClaimsApiFactory = function (configuration, basePath, axios) {
650
650
  return localVarFp.createClaim(createClaimRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
651
651
  },
652
652
  /**
653
- * This will delete the requested claim from the database.
653
+ * This will delete the requested claim from the database. **Required Permissions** \"claim-management.claims.delete\"
654
654
  * @summary Delete the claim
655
655
  * @param {string} code
656
656
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -661,7 +661,7 @@ var ClaimsApiFactory = function (configuration, basePath, axios) {
661
661
  return localVarFp.deleteClaim(code, authorization, options).then(function (request) { return request(axios, basePath); });
662
662
  },
663
663
  /**
664
- * This will fetch the identified claim from the database by code
664
+ * This will fetch the identified claim from the database by code **Required Permissions** \"claim-management.claims.view\"
665
665
  * @summary Retrieve the claim
666
666
  * @param {string} code
667
667
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -672,7 +672,7 @@ var ClaimsApiFactory = function (configuration, basePath, axios) {
672
672
  return localVarFp.getClaim(code, authorization, options).then(function (request) { return request(axios, basePath); });
673
673
  },
674
674
  /**
675
- * This endpoint will calculate and get the regulation summary for a claim.
675
+ * This endpoint will calculate and get the regulation summary for a claim. **Required Permissions** \"claim-management.claims.view\", \"claim-management.regulations.view\"
676
676
  * @summary Retrieve the claim regulation summary
677
677
  * @param {string} code Unique identifier for the object.
678
678
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -683,11 +683,11 @@ var ClaimsApiFactory = function (configuration, basePath, axios) {
683
683
  return localVarFp.getClaimRegulationSummary(code, authorization, options).then(function (request) { return request(axios, basePath); });
684
684
  },
685
685
  /**
686
- * 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.
686
+ * 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\"
687
687
  * @summary List claims
688
688
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
689
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
690
- * @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.
689
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
690
+ * @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.
691
691
  * @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;
692
692
  * @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;
693
693
  * @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;
@@ -700,7 +700,7 @@ var ClaimsApiFactory = function (configuration, basePath, axios) {
700
700
  return localVarFp.listClaims(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
701
701
  },
702
702
  /**
703
- * Updates the identified claim by setting the values of the provided parameters. Any parameters not provided will be left unchanged.
703
+ * 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\"
704
704
  * @summary Patch the claim
705
705
  * @param {string} code
706
706
  * @param {PatchClaimRequestDto} patchClaimRequestDto
@@ -712,7 +712,7 @@ var ClaimsApiFactory = function (configuration, basePath, axios) {
712
712
  return localVarFp.patchClaim(code, patchClaimRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
713
713
  },
714
714
  /**
715
- * This will update the identified claim in the database
715
+ * This will update the identified claim in the database **Required Permissions** \"claim-management.claims.update\"
716
716
  * @summary Update the claim
717
717
  * @param {string} code
718
718
  * @param {UpdateClaimRequestDto} updateClaimRequestDto
@@ -738,7 +738,7 @@ var ClaimsApi = /** @class */ (function (_super) {
738
738
  return _super !== null && _super.apply(this, arguments) || this;
739
739
  }
740
740
  /**
741
- * This will create a claim in the database
741
+ * This will create a claim in the database **Required Permissions** \"claim-management.claims.create\"
742
742
  * @summary Create the claim
743
743
  * @param {ClaimsApiCreateClaimRequest} requestParameters Request parameters.
744
744
  * @param {*} [options] Override http request option.
@@ -750,7 +750,7 @@ var ClaimsApi = /** @class */ (function (_super) {
750
750
  return (0, exports.ClaimsApiFp)(this.configuration).createClaim(requestParameters.createClaimRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
751
751
  };
752
752
  /**
753
- * This will delete the requested claim from the database.
753
+ * This will delete the requested claim from the database. **Required Permissions** \"claim-management.claims.delete\"
754
754
  * @summary Delete the claim
755
755
  * @param {ClaimsApiDeleteClaimRequest} requestParameters Request parameters.
756
756
  * @param {*} [options] Override http request option.
@@ -762,7 +762,7 @@ var ClaimsApi = /** @class */ (function (_super) {
762
762
  return (0, exports.ClaimsApiFp)(this.configuration).deleteClaim(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
763
763
  };
764
764
  /**
765
- * This will fetch the identified claim from the database by code
765
+ * This will fetch the identified claim from the database by code **Required Permissions** \"claim-management.claims.view\"
766
766
  * @summary Retrieve the claim
767
767
  * @param {ClaimsApiGetClaimRequest} requestParameters Request parameters.
768
768
  * @param {*} [options] Override http request option.
@@ -774,7 +774,7 @@ var ClaimsApi = /** @class */ (function (_super) {
774
774
  return (0, exports.ClaimsApiFp)(this.configuration).getClaim(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
775
775
  };
776
776
  /**
777
- * This endpoint will calculate and get the regulation summary for a claim.
777
+ * This endpoint will calculate and get the regulation summary for a claim. **Required Permissions** \"claim-management.claims.view\", \"claim-management.regulations.view\"
778
778
  * @summary Retrieve the claim regulation summary
779
779
  * @param {ClaimsApiGetClaimRegulationSummaryRequest} requestParameters Request parameters.
780
780
  * @param {*} [options] Override http request option.
@@ -786,7 +786,7 @@ var ClaimsApi = /** @class */ (function (_super) {
786
786
  return (0, exports.ClaimsApiFp)(this.configuration).getClaimRegulationSummary(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
787
787
  };
788
788
  /**
789
- * 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.
789
+ * 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\"
790
790
  * @summary List claims
791
791
  * @param {ClaimsApiListClaimsRequest} requestParameters Request parameters.
792
792
  * @param {*} [options] Override http request option.
@@ -799,7 +799,7 @@ var ClaimsApi = /** @class */ (function (_super) {
799
799
  return (0, exports.ClaimsApiFp)(this.configuration).listClaims(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); });
800
800
  };
801
801
  /**
802
- * Updates the identified claim by setting the values of the provided parameters. Any parameters not provided will be left unchanged.
802
+ * 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\"
803
803
  * @summary Patch the claim
804
804
  * @param {ClaimsApiPatchClaimRequest} requestParameters Request parameters.
805
805
  * @param {*} [options] Override http request option.
@@ -811,7 +811,7 @@ var ClaimsApi = /** @class */ (function (_super) {
811
811
  return (0, exports.ClaimsApiFp)(this.configuration).patchClaim(requestParameters.code, requestParameters.patchClaimRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
812
812
  };
813
813
  /**
814
- * This will update the identified claim in the database
814
+ * This will update the identified claim in the database **Required Permissions** \"claim-management.claims.update\"
815
815
  * @summary Update the claim
816
816
  * @param {ClaimsApiUpdateClaimRequest} requestParameters Request parameters.
817
817
  * @param {*} [options] Override http request option.