@emilgroup/claim-sdk 1.17.1 → 1.17.2-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.
@@ -190,7 +190,7 @@ var SettlementsApiAxiosParamCreator = function (configuration) {
190
190
  });
191
191
  },
192
192
  /**
193
- * 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.
193
+ * 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.
194
194
  * @summary Retrieve the settlement
195
195
  * @param {string} code
196
196
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -238,16 +238,16 @@ var SettlementsApiAxiosParamCreator = function (configuration) {
238
238
  });
239
239
  },
240
240
  /**
241
- * 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.
241
+ * 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.
242
242
  * @summary List settlements
243
243
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
244
244
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
245
245
  * @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.
246
- * @param {'policyNumber' | 'productId' | 'accountCode' | 'claimCode' | 'InsuredObjectId'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
247
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
248
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
249
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
250
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
246
+ * @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>
247
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
248
+ * @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>
249
+ * @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>
250
+ * @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>
251
251
  * @param {*} [options] Override http request option.
252
252
  * @throws {RequiredError}
253
253
  */
@@ -415,7 +415,7 @@ var SettlementsApiFp = function (configuration) {
415
415
  });
416
416
  },
417
417
  /**
418
- * 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.
418
+ * 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.
419
419
  * @summary Retrieve the settlement
420
420
  * @param {string} code
421
421
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -436,16 +436,16 @@ var SettlementsApiFp = function (configuration) {
436
436
  });
437
437
  },
438
438
  /**
439
- * 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.
439
+ * 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.
440
440
  * @summary List settlements
441
441
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
442
442
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
443
443
  * @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.
444
- * @param {'policyNumber' | 'productId' | 'accountCode' | 'claimCode' | 'InsuredObjectId'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
445
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
446
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
447
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
448
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
444
+ * @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>
445
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
446
+ * @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>
447
+ * @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>
448
+ * @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>
449
449
  * @param {*} [options] Override http request option.
450
450
  * @throws {RequiredError}
451
451
  */
@@ -517,7 +517,7 @@ var SettlementsApiFactory = function (configuration, basePath, axios) {
517
517
  return localVarFp.deleteSettlement(code, authorization, options).then(function (request) { return request(axios, basePath); });
518
518
  },
519
519
  /**
520
- * 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.
520
+ * 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.
521
521
  * @summary Retrieve the settlement
522
522
  * @param {string} code
523
523
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -528,16 +528,16 @@ var SettlementsApiFactory = function (configuration, basePath, axios) {
528
528
  return localVarFp.getSettlement(code, authorization, options).then(function (request) { return request(axios, basePath); });
529
529
  },
530
530
  /**
531
- * 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.
531
+ * 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.
532
532
  * @summary List settlements
533
533
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
534
534
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
535
535
  * @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.
536
- * @param {'policyNumber' | 'productId' | 'accountCode' | 'claimCode' | 'InsuredObjectId'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
537
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
538
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
539
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
540
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
536
+ * @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>
537
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
538
+ * @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>
539
+ * @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>
540
+ * @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>
541
541
  * @param {*} [options] Override http request option.
542
542
  * @throws {RequiredError}
543
543
  */
@@ -595,7 +595,7 @@ var SettlementsApi = /** @class */ (function (_super) {
595
595
  return (0, exports.SettlementsApiFp)(this.configuration).deleteSettlement(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
596
596
  };
597
597
  /**
598
- * 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.
598
+ * 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.
599
599
  * @summary Retrieve the settlement
600
600
  * @param {SettlementsApiGetSettlementRequest} requestParameters Request parameters.
601
601
  * @param {*} [options] Override http request option.
@@ -607,7 +607,7 @@ var SettlementsApi = /** @class */ (function (_super) {
607
607
  return (0, exports.SettlementsApiFp)(this.configuration).getSettlement(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
608
608
  };
609
609
  /**
610
- * 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.
610
+ * 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.
611
611
  * @summary List settlements
612
612
  * @param {SettlementsApiListSettlementsRequest} requestParameters Request parameters.
613
613
  * @param {*} [options] Override http request option.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/claim-sdk",
3
- "version": "1.17.1",
3
+ "version": "1.17.2-beta.1",
4
4
  "description": "OpenAPI client for @emilgroup/claim-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [