@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.
@@ -194,7 +194,7 @@ var SettlementsApiAxiosParamCreator = function (configuration) {
194
194
  });
195
195
  },
196
196
  /**
197
- * 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.
197
+ * 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.
198
198
  * @summary Retrieve the settlement
199
199
  * @param {string} code
200
200
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -242,16 +242,16 @@ var SettlementsApiAxiosParamCreator = function (configuration) {
242
242
  });
243
243
  },
244
244
  /**
245
- * 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.
245
+ * 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.
246
246
  * @summary List settlements
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 {'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.
251
- * @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.
252
- * @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.
253
- * @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.
254
- * @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.
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, claimCode, InsuredObjectId</i>
251
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
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: insuredObject, reserve, payment, recourse</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: claims.<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, claimCode, InsuredObjectId</i>
255
255
  * @param {*} [options] Override http request option.
256
256
  * @throws {RequiredError}
257
257
  */
@@ -419,7 +419,7 @@ var SettlementsApiFp = function (configuration) {
419
419
  });
420
420
  },
421
421
  /**
422
- * 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.
422
+ * 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.
423
423
  * @summary Retrieve the settlement
424
424
  * @param {string} code
425
425
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -440,16 +440,16 @@ var SettlementsApiFp = function (configuration) {
440
440
  });
441
441
  },
442
442
  /**
443
- * 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.
443
+ * 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.
444
444
  * @summary List settlements
445
445
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
446
446
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
447
447
  * @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.
448
- * @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.
449
- * @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.
450
- * @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.
451
- * @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.
452
- * @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.
448
+ * @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>
449
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
450
+ * @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>
451
+ * @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>
452
+ * @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>
453
453
  * @param {*} [options] Override http request option.
454
454
  * @throws {RequiredError}
455
455
  */
@@ -521,7 +521,7 @@ var SettlementsApiFactory = function (configuration, basePath, axios) {
521
521
  return localVarFp.deleteSettlement(code, authorization, options).then(function (request) { return request(axios, basePath); });
522
522
  },
523
523
  /**
524
- * 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.
524
+ * 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.
525
525
  * @summary Retrieve the settlement
526
526
  * @param {string} code
527
527
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -532,16 +532,16 @@ var SettlementsApiFactory = function (configuration, basePath, axios) {
532
532
  return localVarFp.getSettlement(code, authorization, options).then(function (request) { return request(axios, basePath); });
533
533
  },
534
534
  /**
535
- * 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.
535
+ * 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.
536
536
  * @summary List settlements
537
537
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
538
538
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
539
539
  * @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.
540
- * @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.
541
- * @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.
542
- * @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.
543
- * @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.
544
- * @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.
540
+ * @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>
541
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
542
+ * @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>
543
+ * @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>
544
+ * @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>
545
545
  * @param {*} [options] Override http request option.
546
546
  * @throws {RequiredError}
547
547
  */
@@ -599,7 +599,7 @@ var SettlementsApi = /** @class */ (function (_super) {
599
599
  return (0, exports.SettlementsApiFp)(this.configuration).deleteSettlement(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
600
600
  };
601
601
  /**
602
- * 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.
602
+ * 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.
603
603
  * @summary Retrieve the settlement
604
604
  * @param {SettlementsApiGetSettlementRequest} requestParameters Request parameters.
605
605
  * @param {*} [options] Override http request option.
@@ -611,7 +611,7 @@ var SettlementsApi = /** @class */ (function (_super) {
611
611
  return (0, exports.SettlementsApiFp)(this.configuration).getSettlement(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
612
612
  };
613
613
  /**
614
- * 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.
614
+ * 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.
615
615
  * @summary List settlements
616
616
  * @param {SettlementsApiListSettlementsRequest} requestParameters Request parameters.
617
617
  * @param {*} [options] Override http request option.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/claim-sdk-node",
3
- "version": "1.17.1",
3
+ "version": "1.17.2-beta.3",
4
4
  "description": "OpenAPI client for @emilgroup/claim-sdk-node",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [