@emilgroup/claim-sdk-node 1.17.1 → 1.17.2-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api/claim-partner-roles-api.ts +41 -41
- package/api/claim-partners-api.ts +55 -55
- package/api/claim-statuses-api.ts +33 -33
- package/api/claims-api.ts +37 -37
- package/api/settlements-api.ts +39 -39
- package/dist/api/claim-partner-roles-api.d.ts +41 -41
- package/dist/api/claim-partner-roles-api.js +23 -23
- package/dist/api/claim-partners-api.d.ts +51 -51
- package/dist/api/claim-partners-api.js +32 -32
- package/dist/api/claim-statuses-api.d.ts +33 -33
- package/dist/api/claim-statuses-api.js +20 -20
- package/dist/api/claims-api.d.ts +37 -37
- package/dist/api/claims-api.js +19 -19
- package/dist/api/settlements-api.d.ts +39 -39
- package/dist/api/settlements-api.js +23 -23
- package/package.json +1 -1
package/dist/api/claims-api.d.ts
CHANGED
|
@@ -53,20 +53,20 @@ export declare const ClaimsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
53
53
|
*/
|
|
54
54
|
getClaim: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
55
|
/**
|
|
56
|
-
* Returns a list of claims you have previously created.
|
|
56
|
+
* 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.
|
|
57
57
|
* @summary List claims
|
|
58
58
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
59
59
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
60
60
|
* @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.
|
|
61
|
-
* @param {
|
|
62
|
-
* @param {
|
|
63
|
-
* @param {
|
|
64
|
-
* @param {
|
|
65
|
-
* @param {
|
|
61
|
+
* @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>
|
|
62
|
+
* @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>
|
|
63
|
+
* @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>
|
|
64
|
+
* @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.<br/> <br/> <i>Allowed values: partners.<i>
|
|
65
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyNumber, productId, accountCode, insuredObjectId, policyCode</i>
|
|
66
66
|
* @param {*} [options] Override http request option.
|
|
67
67
|
* @throws {RequiredError}
|
|
68
68
|
*/
|
|
69
|
-
listClaims: (authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
69
|
+
listClaims: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
70
70
|
/**
|
|
71
71
|
* Updates the identified claim by setting the values of the provided parameters. Any parameters not provided will be left unchanged.
|
|
72
72
|
* @summary Patch the claim
|
|
@@ -121,20 +121,20 @@ export declare const ClaimsApiFp: (configuration?: Configuration) => {
|
|
|
121
121
|
*/
|
|
122
122
|
getClaim(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetClaimResponseClass>>;
|
|
123
123
|
/**
|
|
124
|
-
* Returns a list of claims you have previously created.
|
|
124
|
+
* 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.
|
|
125
125
|
* @summary List claims
|
|
126
126
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
127
127
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
128
128
|
* @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.
|
|
129
|
-
* @param {
|
|
130
|
-
* @param {
|
|
131
|
-
* @param {
|
|
132
|
-
* @param {
|
|
133
|
-
* @param {
|
|
129
|
+
* @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>
|
|
130
|
+
* @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>
|
|
131
|
+
* @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>
|
|
132
|
+
* @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.<br/> <br/> <i>Allowed values: partners.<i>
|
|
133
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyNumber, productId, accountCode, insuredObjectId, policyCode</i>
|
|
134
134
|
* @param {*} [options] Override http request option.
|
|
135
135
|
* @throws {RequiredError}
|
|
136
136
|
*/
|
|
137
|
-
listClaims(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
137
|
+
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>>;
|
|
138
138
|
/**
|
|
139
139
|
* Updates the identified claim by setting the values of the provided parameters. Any parameters not provided will be left unchanged.
|
|
140
140
|
* @summary Patch the claim
|
|
@@ -189,20 +189,20 @@ export declare const ClaimsApiFactory: (configuration?: Configuration, basePath?
|
|
|
189
189
|
*/
|
|
190
190
|
getClaim(code: string, authorization?: string, options?: any): AxiosPromise<GetClaimResponseClass>;
|
|
191
191
|
/**
|
|
192
|
-
* Returns a list of claims you have previously created.
|
|
192
|
+
* 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.
|
|
193
193
|
* @summary List claims
|
|
194
194
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
195
195
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
196
196
|
* @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.
|
|
197
|
-
* @param {
|
|
198
|
-
* @param {
|
|
199
|
-
* @param {
|
|
200
|
-
* @param {
|
|
201
|
-
* @param {
|
|
197
|
+
* @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>
|
|
198
|
+
* @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>
|
|
199
|
+
* @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>
|
|
200
|
+
* @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.<br/> <br/> <i>Allowed values: partners.<i>
|
|
201
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyNumber, productId, accountCode, insuredObjectId, policyCode</i>
|
|
202
202
|
* @param {*} [options] Override http request option.
|
|
203
203
|
* @throws {RequiredError}
|
|
204
204
|
*/
|
|
205
|
-
listClaims(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
205
|
+
listClaims(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListClaimsResponseClass>;
|
|
206
206
|
/**
|
|
207
207
|
* Updates the identified claim by setting the values of the provided parameters. Any parameters not provided will be left unchanged.
|
|
208
208
|
* @summary Patch the claim
|
|
@@ -306,35 +306,35 @@ export interface ClaimsApiListClaimsRequest {
|
|
|
306
306
|
*/
|
|
307
307
|
readonly pageToken?: any;
|
|
308
308
|
/**
|
|
309
|
-
* Filter the response by one or multiple fields.
|
|
310
|
-
* @type {
|
|
309
|
+
* 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>
|
|
310
|
+
* @type {string}
|
|
311
311
|
* @memberof ClaimsApiListClaims
|
|
312
312
|
*/
|
|
313
|
-
readonly filter?:
|
|
313
|
+
readonly filter?: string;
|
|
314
314
|
/**
|
|
315
|
-
* Search the
|
|
316
|
-
* @type {
|
|
315
|
+
* 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>
|
|
316
|
+
* @type {string}
|
|
317
317
|
* @memberof ClaimsApiListClaims
|
|
318
318
|
*/
|
|
319
|
-
readonly search?:
|
|
319
|
+
readonly search?: string;
|
|
320
320
|
/**
|
|
321
|
-
*
|
|
322
|
-
* @type {
|
|
321
|
+
* 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>
|
|
322
|
+
* @type {string}
|
|
323
323
|
* @memberof ClaimsApiListClaims
|
|
324
324
|
*/
|
|
325
|
-
readonly order?:
|
|
325
|
+
readonly order?: string;
|
|
326
326
|
/**
|
|
327
|
-
*
|
|
328
|
-
* @type {
|
|
327
|
+
* 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.<br/> <br/> <i>Allowed values: partners.<i>
|
|
328
|
+
* @type {string}
|
|
329
329
|
* @memberof ClaimsApiListClaims
|
|
330
330
|
*/
|
|
331
|
-
readonly expand?:
|
|
331
|
+
readonly expand?: string;
|
|
332
332
|
/**
|
|
333
|
-
* Filters the response by one or multiple fields.
|
|
334
|
-
* @type {
|
|
333
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyNumber, productId, accountCode, insuredObjectId, policyCode</i>
|
|
334
|
+
* @type {string}
|
|
335
335
|
* @memberof ClaimsApiListClaims
|
|
336
336
|
*/
|
|
337
|
-
readonly filters?:
|
|
337
|
+
readonly filters?: string;
|
|
338
338
|
}
|
|
339
339
|
/**
|
|
340
340
|
* Request parameters for patchClaim operation in ClaimsApi.
|
|
@@ -421,7 +421,7 @@ export declare class ClaimsApi extends BaseAPI {
|
|
|
421
421
|
*/
|
|
422
422
|
getClaim(requestParameters: ClaimsApiGetClaimRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetClaimResponseClass, any>>;
|
|
423
423
|
/**
|
|
424
|
-
* Returns a list of claims you have previously created.
|
|
424
|
+
* 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.
|
|
425
425
|
* @summary List claims
|
|
426
426
|
* @param {ClaimsApiListClaimsRequest} requestParameters Request parameters.
|
|
427
427
|
* @param {*} [options] Override http request option.
|
package/dist/api/claims-api.js
CHANGED
|
@@ -242,16 +242,16 @@ var ClaimsApiAxiosParamCreator = function (configuration) {
|
|
|
242
242
|
});
|
|
243
243
|
},
|
|
244
244
|
/**
|
|
245
|
-
* Returns a list of claims you have previously created.
|
|
245
|
+
* 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.
|
|
246
246
|
* @summary List claims
|
|
247
247
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
248
248
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
249
249
|
* @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.
|
|
250
|
-
* @param {
|
|
251
|
-
* @param {
|
|
252
|
-
* @param {
|
|
253
|
-
* @param {
|
|
254
|
-
* @param {
|
|
250
|
+
* @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>
|
|
251
|
+
* @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>
|
|
252
|
+
* @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>
|
|
253
|
+
* @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.<br/> <br/> <i>Allowed values: partners.<i>
|
|
254
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyNumber, productId, accountCode, insuredObjectId, policyCode</i>
|
|
255
255
|
* @param {*} [options] Override http request option.
|
|
256
256
|
* @throws {RequiredError}
|
|
257
257
|
*/
|
|
@@ -493,16 +493,16 @@ var ClaimsApiFp = function (configuration) {
|
|
|
493
493
|
});
|
|
494
494
|
},
|
|
495
495
|
/**
|
|
496
|
-
* Returns a list of claims you have previously created.
|
|
496
|
+
* 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.
|
|
497
497
|
* @summary List claims
|
|
498
498
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
499
499
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
500
500
|
* @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.
|
|
501
|
-
* @param {
|
|
502
|
-
* @param {
|
|
503
|
-
* @param {
|
|
504
|
-
* @param {
|
|
505
|
-
* @param {
|
|
501
|
+
* @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>
|
|
502
|
+
* @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>
|
|
503
|
+
* @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>
|
|
504
|
+
* @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.<br/> <br/> <i>Allowed values: partners.<i>
|
|
505
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyNumber, productId, accountCode, insuredObjectId, policyCode</i>
|
|
506
506
|
* @param {*} [options] Override http request option.
|
|
507
507
|
* @throws {RequiredError}
|
|
508
508
|
*/
|
|
@@ -607,16 +607,16 @@ var ClaimsApiFactory = function (configuration, basePath, axios) {
|
|
|
607
607
|
return localVarFp.getClaim(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
608
608
|
},
|
|
609
609
|
/**
|
|
610
|
-
* Returns a list of claims you have previously created.
|
|
610
|
+
* 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.
|
|
611
611
|
* @summary List claims
|
|
612
612
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
613
613
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
614
614
|
* @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.
|
|
615
|
-
* @param {
|
|
616
|
-
* @param {
|
|
617
|
-
* @param {
|
|
618
|
-
* @param {
|
|
619
|
-
* @param {
|
|
615
|
+
* @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>
|
|
616
|
+
* @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>
|
|
617
|
+
* @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>
|
|
618
|
+
* @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.<br/> <br/> <i>Allowed values: partners.<i>
|
|
619
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyNumber, productId, accountCode, insuredObjectId, policyCode</i>
|
|
620
620
|
* @param {*} [options] Override http request option.
|
|
621
621
|
* @throws {RequiredError}
|
|
622
622
|
*/
|
|
@@ -698,7 +698,7 @@ var ClaimsApi = /** @class */ (function (_super) {
|
|
|
698
698
|
return (0, exports.ClaimsApiFp)(this.configuration).getClaim(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
699
699
|
};
|
|
700
700
|
/**
|
|
701
|
-
* Returns a list of claims you have previously created.
|
|
701
|
+
* 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.
|
|
702
702
|
* @summary List claims
|
|
703
703
|
* @param {ClaimsApiListClaimsRequest} requestParameters Request parameters.
|
|
704
704
|
* @param {*} [options] Override http request option.
|
|
@@ -42,7 +42,7 @@ export declare const SettlementsApiAxiosParamCreator: (configuration?: Configura
|
|
|
42
42
|
*/
|
|
43
43
|
deleteSettlement: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
44
|
/**
|
|
45
|
-
* Retrieves the details of the settlement that was previously created. Supply the unique settlement code
|
|
45
|
+
* 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.
|
|
46
46
|
* @summary Retrieve the settlement
|
|
47
47
|
* @param {string} code
|
|
48
48
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -51,20 +51,20 @@ export declare const SettlementsApiAxiosParamCreator: (configuration?: Configura
|
|
|
51
51
|
*/
|
|
52
52
|
getSettlement: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
53
|
/**
|
|
54
|
-
* Returns a list of settlements you have previously created.
|
|
54
|
+
* 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.
|
|
55
55
|
* @summary List settlements
|
|
56
56
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
57
57
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
58
58
|
* @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.
|
|
59
|
-
* @param {
|
|
60
|
-
* @param {any} [search]
|
|
61
|
-
* @param {
|
|
62
|
-
* @param {
|
|
63
|
-
* @param {
|
|
59
|
+
* @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, claimCode, InsuredObjectId</i>
|
|
60
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
61
|
+
* @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: insuredObject, reserve, payment, recourse</i>
|
|
62
|
+
* @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.<br/> <br/> <i>Allowed values: claims.<i>
|
|
63
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyNumber, productId, accountCode, claimCode, InsuredObjectId</i>
|
|
64
64
|
* @param {*} [options] Override http request option.
|
|
65
65
|
* @throws {RequiredError}
|
|
66
66
|
*/
|
|
67
|
-
listSettlements: (authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
67
|
+
listSettlements: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
68
|
/**
|
|
69
69
|
* Updates the specified settlement by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
70
70
|
* @summary Update the settlement
|
|
@@ -100,7 +100,7 @@ export declare const SettlementsApiFp: (configuration?: Configuration) => {
|
|
|
100
100
|
*/
|
|
101
101
|
deleteSettlement(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
102
102
|
/**
|
|
103
|
-
* Retrieves the details of the settlement that was previously created. Supply the unique settlement code
|
|
103
|
+
* 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.
|
|
104
104
|
* @summary Retrieve the settlement
|
|
105
105
|
* @param {string} code
|
|
106
106
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -109,20 +109,20 @@ export declare const SettlementsApiFp: (configuration?: Configuration) => {
|
|
|
109
109
|
*/
|
|
110
110
|
getSettlement(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettlementResponseClass>>;
|
|
111
111
|
/**
|
|
112
|
-
* Returns a list of settlements you have previously created.
|
|
112
|
+
* 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.
|
|
113
113
|
* @summary List settlements
|
|
114
114
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
115
115
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
116
116
|
* @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.
|
|
117
|
-
* @param {
|
|
118
|
-
* @param {any} [search]
|
|
119
|
-
* @param {
|
|
120
|
-
* @param {
|
|
121
|
-
* @param {
|
|
117
|
+
* @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, claimCode, InsuredObjectId</i>
|
|
118
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
119
|
+
* @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: insuredObject, reserve, payment, recourse</i>
|
|
120
|
+
* @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.<br/> <br/> <i>Allowed values: claims.<i>
|
|
121
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyNumber, productId, accountCode, claimCode, InsuredObjectId</i>
|
|
122
122
|
* @param {*} [options] Override http request option.
|
|
123
123
|
* @throws {RequiredError}
|
|
124
124
|
*/
|
|
125
|
-
listSettlements(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
125
|
+
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>>;
|
|
126
126
|
/**
|
|
127
127
|
* Updates the specified settlement by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
128
128
|
* @summary Update the settlement
|
|
@@ -158,7 +158,7 @@ export declare const SettlementsApiFactory: (configuration?: Configuration, base
|
|
|
158
158
|
*/
|
|
159
159
|
deleteSettlement(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
160
160
|
/**
|
|
161
|
-
* Retrieves the details of the settlement that was previously created. Supply the unique settlement code
|
|
161
|
+
* 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.
|
|
162
162
|
* @summary Retrieve the settlement
|
|
163
163
|
* @param {string} code
|
|
164
164
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -167,20 +167,20 @@ export declare const SettlementsApiFactory: (configuration?: Configuration, base
|
|
|
167
167
|
*/
|
|
168
168
|
getSettlement(code: string, authorization?: string, options?: any): AxiosPromise<GetSettlementResponseClass>;
|
|
169
169
|
/**
|
|
170
|
-
* Returns a list of settlements you have previously created.
|
|
170
|
+
* 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.
|
|
171
171
|
* @summary List settlements
|
|
172
172
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
173
173
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
174
174
|
* @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.
|
|
175
|
-
* @param {
|
|
176
|
-
* @param {any} [search]
|
|
177
|
-
* @param {
|
|
178
|
-
* @param {
|
|
179
|
-
* @param {
|
|
175
|
+
* @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, claimCode, InsuredObjectId</i>
|
|
176
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
177
|
+
* @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: insuredObject, reserve, payment, recourse</i>
|
|
178
|
+
* @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.<br/> <br/> <i>Allowed values: claims.<i>
|
|
179
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyNumber, productId, accountCode, claimCode, InsuredObjectId</i>
|
|
180
180
|
* @param {*} [options] Override http request option.
|
|
181
181
|
* @throws {RequiredError}
|
|
182
182
|
*/
|
|
183
|
-
listSettlements(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
183
|
+
listSettlements(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListSettlementsResponseClass>;
|
|
184
184
|
/**
|
|
185
185
|
* Updates the specified settlement by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
186
186
|
* @summary Update the settlement
|
|
@@ -274,35 +274,35 @@ export interface SettlementsApiListSettlementsRequest {
|
|
|
274
274
|
*/
|
|
275
275
|
readonly pageToken?: any;
|
|
276
276
|
/**
|
|
277
|
-
* Filter the response by one or multiple fields.
|
|
278
|
-
* @type {
|
|
277
|
+
* 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, claimCode, InsuredObjectId</i>
|
|
278
|
+
* @type {string}
|
|
279
279
|
* @memberof SettlementsApiListSettlements
|
|
280
280
|
*/
|
|
281
|
-
readonly filter?:
|
|
281
|
+
readonly filter?: string;
|
|
282
282
|
/**
|
|
283
|
-
*
|
|
283
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
284
284
|
* @type {any}
|
|
285
285
|
* @memberof SettlementsApiListSettlements
|
|
286
286
|
*/
|
|
287
287
|
readonly search?: any;
|
|
288
288
|
/**
|
|
289
|
-
*
|
|
290
|
-
* @type {
|
|
289
|
+
* 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: insuredObject, reserve, payment, recourse</i>
|
|
290
|
+
* @type {string}
|
|
291
291
|
* @memberof SettlementsApiListSettlements
|
|
292
292
|
*/
|
|
293
|
-
readonly order?:
|
|
293
|
+
readonly order?: string;
|
|
294
294
|
/**
|
|
295
|
-
*
|
|
296
|
-
* @type {
|
|
295
|
+
* 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.<br/> <br/> <i>Allowed values: claims.<i>
|
|
296
|
+
* @type {string}
|
|
297
297
|
* @memberof SettlementsApiListSettlements
|
|
298
298
|
*/
|
|
299
|
-
readonly expand?:
|
|
299
|
+
readonly expand?: string;
|
|
300
300
|
/**
|
|
301
|
-
* Filters the response by one or multiple fields.
|
|
302
|
-
* @type {
|
|
301
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyNumber, productId, accountCode, claimCode, InsuredObjectId</i>
|
|
302
|
+
* @type {string}
|
|
303
303
|
* @memberof SettlementsApiListSettlements
|
|
304
304
|
*/
|
|
305
|
-
readonly filters?:
|
|
305
|
+
readonly filters?: string;
|
|
306
306
|
}
|
|
307
307
|
/**
|
|
308
308
|
* Request parameters for updateSettlement operation in SettlementsApi.
|
|
@@ -355,7 +355,7 @@ export declare class SettlementsApi extends BaseAPI {
|
|
|
355
355
|
*/
|
|
356
356
|
deleteSettlement(requestParameters: SettlementsApiDeleteSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
357
357
|
/**
|
|
358
|
-
* Retrieves the details of the settlement that was previously created. Supply the unique settlement code
|
|
358
|
+
* 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.
|
|
359
359
|
* @summary Retrieve the settlement
|
|
360
360
|
* @param {SettlementsApiGetSettlementRequest} requestParameters Request parameters.
|
|
361
361
|
* @param {*} [options] Override http request option.
|
|
@@ -364,7 +364,7 @@ export declare class SettlementsApi extends BaseAPI {
|
|
|
364
364
|
*/
|
|
365
365
|
getSettlement(requestParameters: SettlementsApiGetSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettlementResponseClass, any>>;
|
|
366
366
|
/**
|
|
367
|
-
* Returns a list of settlements you have previously created.
|
|
367
|
+
* 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.
|
|
368
368
|
* @summary List settlements
|
|
369
369
|
* @param {SettlementsApiListSettlementsRequest} requestParameters Request parameters.
|
|
370
370
|
* @param {*} [options] Override http request option.
|