@emilgroup/public-api-sdk-node 1.27.1 → 1.28.0

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.
Files changed (79) hide show
  1. package/.openapi-generator/FILES +9 -0
  2. package/README.md +2 -2
  3. package/api/booking-funnels-api.ts +165 -0
  4. package/api/documents-api.ts +36 -22
  5. package/api/leads-api.ts +4 -4
  6. package/api/named-ranges-api.ts +254 -0
  7. package/api/products-api.ts +65 -38
  8. package/api.ts +4 -0
  9. package/dist/api/booking-funnels-api.d.ts +96 -0
  10. package/dist/api/booking-funnels-api.js +227 -0
  11. package/dist/api/documents-api.d.ts +28 -19
  12. package/dist/api/documents-api.js +26 -20
  13. package/dist/api/leads-api.d.ts +4 -4
  14. package/dist/api/leads-api.js +4 -4
  15. package/dist/api/named-ranges-api.d.ts +150 -0
  16. package/dist/api/named-ranges-api.js +267 -0
  17. package/dist/api/products-api.d.ts +49 -31
  18. package/dist/api/products-api.js +47 -36
  19. package/dist/api.d.ts +2 -0
  20. package/dist/api.js +2 -0
  21. package/dist/models/address-field-score-class.d.ts +10 -10
  22. package/dist/models/booking-funnel-class.d.ts +90 -0
  23. package/dist/models/booking-funnel-class.js +15 -0
  24. package/dist/models/create-account-request-dto.d.ts +1 -1
  25. package/dist/models/create-account-request-dto.js +1 -1
  26. package/dist/models/create-document-request-dto.d.ts +2 -2
  27. package/dist/models/create-lead-request-dto.d.ts +13 -1
  28. package/dist/models/create-presigned-post-request-dto.d.ts +2 -2
  29. package/dist/models/document-class.d.ts +1 -1
  30. package/dist/models/filter-named-range-response-class.d.ts +42 -0
  31. package/dist/models/filter-named-range-response-class.js +15 -0
  32. package/dist/models/get-booking-funnel-response-class.d.ts +25 -0
  33. package/dist/models/get-booking-funnel-response-class.js +15 -0
  34. package/dist/models/index.d.ts +7 -0
  35. package/dist/models/index.js +7 -0
  36. package/dist/models/initiate-email-verification-dto.d.ts +1 -1
  37. package/dist/models/insured-object-type-class.d.ts +1 -1
  38. package/dist/models/lead-account-class.d.ts +1 -1
  39. package/dist/models/lead-account-class.js +1 -1
  40. package/dist/models/lead-class.d.ts +7 -0
  41. package/dist/models/lead-policy-object-class.d.ts +2 -2
  42. package/dist/models/partner-class.d.ts +60 -0
  43. package/dist/models/partner-class.js +15 -0
  44. package/dist/models/partner-link-class.d.ts +86 -0
  45. package/dist/models/partner-link-class.js +15 -0
  46. package/dist/models/partner-role-class.d.ts +54 -0
  47. package/dist/models/partner-role-class.js +15 -0
  48. package/dist/models/product-class.d.ts +1 -1
  49. package/dist/models/product-document-class.d.ts +14 -2
  50. package/dist/models/product-factor-for-version-class.d.ts +4 -3
  51. package/dist/models/product-factor-value-for-version-class.d.ts +42 -0
  52. package/dist/models/product-factor-value-for-version-class.js +15 -0
  53. package/dist/models/send-notification-request-dto.d.ts +1 -1
  54. package/dist/models/update-lead-request-dto.d.ts +1 -1
  55. package/models/address-field-score-class.ts +10 -10
  56. package/models/booking-funnel-class.ts +96 -0
  57. package/models/create-account-request-dto.ts +1 -1
  58. package/models/create-document-request-dto.ts +2 -2
  59. package/models/create-lead-request-dto.ts +13 -1
  60. package/models/create-presigned-post-request-dto.ts +2 -2
  61. package/models/document-class.ts +1 -1
  62. package/models/filter-named-range-response-class.ts +48 -0
  63. package/models/get-booking-funnel-response-class.ts +31 -0
  64. package/models/index.ts +7 -0
  65. package/models/initiate-email-verification-dto.ts +1 -1
  66. package/models/insured-object-type-class.ts +1 -1
  67. package/models/lead-account-class.ts +1 -1
  68. package/models/lead-class.ts +7 -0
  69. package/models/lead-policy-object-class.ts +2 -2
  70. package/models/partner-class.ts +66 -0
  71. package/models/partner-link-class.ts +92 -0
  72. package/models/partner-role-class.ts +60 -0
  73. package/models/product-class.ts +1 -1
  74. package/models/product-document-class.ts +14 -2
  75. package/models/product-factor-for-version-class.ts +4 -3
  76. package/models/product-factor-value-for-version-class.ts +48 -0
  77. package/models/send-notification-request-dto.ts +1 -1
  78. package/models/update-lead-request-dto.ts +1 -1
  79. package/package.json +1 -1
@@ -298,7 +298,7 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
298
298
  });
299
299
  },
300
300
  /**
301
- * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
301
+ * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
302
302
  * @summary List documents
303
303
  * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
304
304
  * @param {string} [authorization] Bearer Token
@@ -364,20 +364,21 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
364
364
  });
365
365
  },
366
366
  /**
367
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
367
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
368
368
  * @summary List product documents
369
369
  * @param {string} productCode
370
370
  * @param {string} [authorization] Bearer Token
371
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
371
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
372
372
  * @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.
373
373
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
374
- * @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.
374
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
375
375
  * @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.
376
376
  * @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.
377
+ * @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.
377
378
  * @param {*} [options] Override http request option.
378
379
  * @throws {RequiredError}
379
380
  */
380
- listProductDocuments: function (productCode, authorization, pageSize, pageToken, filter, search, order, expand, options) {
381
+ listProductDocuments: function (productCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
381
382
  if (options === void 0) { options = {}; }
382
383
  return __awaiter(_this, void 0, void 0, function () {
383
384
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -421,6 +422,9 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
421
422
  if (expand !== undefined) {
422
423
  localVarQueryParameter['expand'] = expand;
423
424
  }
425
+ if (filters !== undefined) {
426
+ localVarQueryParameter['filters'] = filters;
427
+ }
424
428
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
425
429
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
426
430
  }
@@ -581,7 +585,7 @@ var DocumentsApiFp = function (configuration) {
581
585
  });
582
586
  },
583
587
  /**
584
- * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
588
+ * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
585
589
  * @summary List documents
586
590
  * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
587
591
  * @param {string} [authorization] Bearer Token
@@ -606,25 +610,26 @@ var DocumentsApiFp = function (configuration) {
606
610
  });
607
611
  },
608
612
  /**
609
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
613
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
610
614
  * @summary List product documents
611
615
  * @param {string} productCode
612
616
  * @param {string} [authorization] Bearer Token
613
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
617
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
614
618
  * @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
619
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
616
- * @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.
620
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
617
621
  * @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.
618
622
  * @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.
623
+ * @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.
619
624
  * @param {*} [options] Override http request option.
620
625
  * @throws {RequiredError}
621
626
  */
622
- listProductDocuments: function (productCode, authorization, pageSize, pageToken, filter, search, order, expand, options) {
627
+ listProductDocuments: function (productCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
623
628
  return __awaiter(this, void 0, void 0, function () {
624
629
  var localVarAxiosArgs;
625
630
  return __generator(this, function (_a) {
626
631
  switch (_a.label) {
627
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, options)];
632
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
628
633
  case 1:
629
634
  localVarAxiosArgs = _a.sent();
630
635
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -710,7 +715,7 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
710
715
  return localVarFp.downloadProductDocumentUrl(productCode, code, authorization, options).then(function (request) { return request(axios, basePath); });
711
716
  },
712
717
  /**
713
- * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
718
+ * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
714
719
  * @summary List documents
715
720
  * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
716
721
  * @param {string} [authorization] Bearer Token
@@ -725,21 +730,22 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
725
730
  return localVarFp.listDocuments(filter, authorization, pageSize, pageToken, order, expand, options).then(function (request) { return request(axios, basePath); });
726
731
  },
727
732
  /**
728
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
733
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
729
734
  * @summary List product documents
730
735
  * @param {string} productCode
731
736
  * @param {string} [authorization] Bearer Token
732
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
737
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
733
738
  * @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.
734
739
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
735
- * @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.
740
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
736
741
  * @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.
737
742
  * @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.
743
+ * @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.
738
744
  * @param {*} [options] Override http request option.
739
745
  * @throws {RequiredError}
740
746
  */
741
- listProductDocuments: function (productCode, authorization, pageSize, pageToken, filter, search, order, expand, options) {
742
- return localVarFp.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
747
+ listProductDocuments: function (productCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
748
+ return localVarFp.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
743
749
  },
744
750
  /**
745
751
  * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
@@ -815,7 +821,7 @@ var DocumentsApi = /** @class */ (function (_super) {
815
821
  return (0, exports.DocumentsApiFp)(this.configuration).downloadProductDocumentUrl(requestParameters.productCode, requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
816
822
  };
817
823
  /**
818
- * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
824
+ * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
819
825
  * @summary List documents
820
826
  * @param {DocumentsApiListDocumentsRequest} requestParameters Request parameters.
821
827
  * @param {*} [options] Override http request option.
@@ -827,7 +833,7 @@ var DocumentsApi = /** @class */ (function (_super) {
827
833
  return (0, exports.DocumentsApiFp)(this.configuration).listDocuments(requestParameters.filter, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
828
834
  };
829
835
  /**
830
- * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
836
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
831
837
  * @summary List product documents
832
838
  * @param {DocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
833
839
  * @param {*} [options] Override http request option.
@@ -836,7 +842,7 @@ var DocumentsApi = /** @class */ (function (_super) {
836
842
  */
837
843
  DocumentsApi.prototype.listProductDocuments = function (requestParameters, options) {
838
844
  var _this = this;
839
- return (0, exports.DocumentsApiFp)(this.configuration).listProductDocuments(requestParameters.productCode, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
845
+ return (0, exports.DocumentsApiFp)(this.configuration).listProductDocuments(requestParameters.productCode, 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); });
840
846
  };
841
847
  /**
842
848
  * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
@@ -52,7 +52,7 @@ export declare const LeadsApiAxiosParamCreator: (configuration?: Configuration)
52
52
  */
53
53
  createLeadSync: (createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
54
54
  /**
55
- * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
55
+ * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
56
56
  * @summary Retrieve the lead
57
57
  * @param {string} code Unique identifier for the object.
58
58
  * @param {string} [authorization] Bearer Token
@@ -122,7 +122,7 @@ export declare const LeadsApiFp: (configuration?: Configuration) => {
122
122
  */
123
123
  createLeadSync(createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateLeadResponseClass>>;
124
124
  /**
125
- * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
125
+ * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
126
126
  * @summary Retrieve the lead
127
127
  * @param {string} code Unique identifier for the object.
128
128
  * @param {string} [authorization] Bearer Token
@@ -192,7 +192,7 @@ export declare const LeadsApiFactory: (configuration?: Configuration, basePath?:
192
192
  */
193
193
  createLeadSync(createLeadRequestDto: CreateLeadRequestDto, authorization?: string, options?: any): AxiosPromise<CreateLeadResponseClass>;
194
194
  /**
195
- * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
195
+ * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
196
196
  * @summary Retrieve the lead
197
197
  * @param {string} code Unique identifier for the object.
198
198
  * @param {string} [authorization] Bearer Token
@@ -403,7 +403,7 @@ export declare class LeadsApi extends BaseAPI {
403
403
  */
404
404
  createLeadSync(requestParameters: LeadsApiCreateLeadSyncRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateLeadResponseClass, any>>;
405
405
  /**
406
- * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
406
+ * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
407
407
  * @summary Retrieve the lead
408
408
  * @param {LeadsApiGetLeadRequest} requestParameters Request parameters.
409
409
  * @param {*} [options] Override http request option.
@@ -244,7 +244,7 @@ var LeadsApiAxiosParamCreator = function (configuration) {
244
244
  });
245
245
  },
246
246
  /**
247
- * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
247
+ * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
248
248
  * @summary Retrieve the lead
249
249
  * @param {string} code Unique identifier for the object.
250
250
  * @param {string} [authorization] Bearer Token
@@ -515,7 +515,7 @@ var LeadsApiFp = function (configuration) {
515
515
  });
516
516
  },
517
517
  /**
518
- * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
518
+ * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
519
519
  * @summary Retrieve the lead
520
520
  * @param {string} code Unique identifier for the object.
521
521
  * @param {string} [authorization] Bearer Token
@@ -643,7 +643,7 @@ var LeadsApiFactory = function (configuration, basePath, axios) {
643
643
  return localVarFp.createLeadSync(createLeadRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
644
644
  },
645
645
  /**
646
- * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
646
+ * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
647
647
  * @summary Retrieve the lead
648
648
  * @param {string} code Unique identifier for the object.
649
649
  * @param {string} [authorization] Bearer Token
@@ -738,7 +738,7 @@ var LeadsApi = /** @class */ (function (_super) {
738
738
  return (0, exports.LeadsApiFp)(this.configuration).createLeadSync(requestParameters.createLeadRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
739
739
  };
740
740
  /**
741
- * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
741
+ * Retrieves the details of the lead that was previously created. Supply the unique lead code that was returned when you created it and Emil Api will return the corresponding lead information.
742
742
  * @summary Retrieve the lead
743
743
  * @param {LeadsApiGetLeadRequest} requestParameters Request parameters.
744
744
  * @param {*} [options] Override http request option.
@@ -0,0 +1,150 @@
1
+ /**
2
+ * Emil PublicAPI
3
+ * The Emil Public API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { FilterNamedRangeResponseClass } from '../models';
16
+ /**
17
+ * NamedRangesApi - axios parameter creator
18
+ * @export
19
+ */
20
+ export declare const NamedRangesApiAxiosParamCreator: (configuration?: Configuration) => {
21
+ /**
22
+ * Returns a list of named range file records you have previously created. The named range file records are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
23
+ * @summary List named range file records
24
+ * @param {string} productSlug A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
25
+ * @param {string} name Name of Named Range.
26
+ * @param {string} [authorization] Bearer Token
27
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
28
+ * @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.
29
+ * @param {string} [filters] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
30
+ * @param {string} [search] Search the list by any field.
31
+ * @param {string} [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.
32
+ * @param {*} [options] Override http request option.
33
+ * @throws {RequiredError}
34
+ */
35
+ filterNamedRange: (productSlug: string, name: string, authorization?: string, pageSize?: number, pageToken?: string, filters?: string, search?: string, order?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
36
+ };
37
+ /**
38
+ * NamedRangesApi - functional programming interface
39
+ * @export
40
+ */
41
+ export declare const NamedRangesApiFp: (configuration?: Configuration) => {
42
+ /**
43
+ * Returns a list of named range file records you have previously created. The named range file records are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
44
+ * @summary List named range file records
45
+ * @param {string} productSlug A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
46
+ * @param {string} name Name of Named Range.
47
+ * @param {string} [authorization] Bearer Token
48
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
49
+ * @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.
50
+ * @param {string} [filters] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
51
+ * @param {string} [search] Search the list by any field.
52
+ * @param {string} [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.
53
+ * @param {*} [options] Override http request option.
54
+ * @throws {RequiredError}
55
+ */
56
+ filterNamedRange(productSlug: string, name: string, authorization?: string, pageSize?: number, pageToken?: string, filters?: string, search?: string, order?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FilterNamedRangeResponseClass>>;
57
+ };
58
+ /**
59
+ * NamedRangesApi - factory interface
60
+ * @export
61
+ */
62
+ export declare const NamedRangesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
63
+ /**
64
+ * Returns a list of named range file records you have previously created. The named range file records are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
65
+ * @summary List named range file records
66
+ * @param {string} productSlug A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
67
+ * @param {string} name Name of Named Range.
68
+ * @param {string} [authorization] Bearer Token
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
+ * @param {string} [filters] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
72
+ * @param {string} [search] Search the list by any field.
73
+ * @param {string} [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.
74
+ * @param {*} [options] Override http request option.
75
+ * @throws {RequiredError}
76
+ */
77
+ filterNamedRange(productSlug: string, name: string, authorization?: string, pageSize?: number, pageToken?: string, filters?: string, search?: string, order?: string, options?: any): AxiosPromise<FilterNamedRangeResponseClass>;
78
+ };
79
+ /**
80
+ * Request parameters for filterNamedRange operation in NamedRangesApi.
81
+ * @export
82
+ * @interface NamedRangesApiFilterNamedRangeRequest
83
+ */
84
+ export interface NamedRangesApiFilterNamedRangeRequest {
85
+ /**
86
+ * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
87
+ * @type {string}
88
+ * @memberof NamedRangesApiFilterNamedRange
89
+ */
90
+ readonly productSlug: string;
91
+ /**
92
+ * Name of Named Range.
93
+ * @type {string}
94
+ * @memberof NamedRangesApiFilterNamedRange
95
+ */
96
+ readonly name: string;
97
+ /**
98
+ * Bearer Token
99
+ * @type {string}
100
+ * @memberof NamedRangesApiFilterNamedRange
101
+ */
102
+ readonly authorization?: string;
103
+ /**
104
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
105
+ * @type {number}
106
+ * @memberof NamedRangesApiFilterNamedRange
107
+ */
108
+ readonly pageSize?: number;
109
+ /**
110
+ * 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.
111
+ * @type {string}
112
+ * @memberof NamedRangesApiFilterNamedRange
113
+ */
114
+ readonly pageToken?: string;
115
+ /**
116
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
117
+ * @type {string}
118
+ * @memberof NamedRangesApiFilterNamedRange
119
+ */
120
+ readonly filters?: string;
121
+ /**
122
+ * Search the list by any field.
123
+ * @type {string}
124
+ * @memberof NamedRangesApiFilterNamedRange
125
+ */
126
+ readonly search?: string;
127
+ /**
128
+ * 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.
129
+ * @type {string}
130
+ * @memberof NamedRangesApiFilterNamedRange
131
+ */
132
+ readonly order?: string;
133
+ }
134
+ /**
135
+ * NamedRangesApi - object-oriented interface
136
+ * @export
137
+ * @class NamedRangesApi
138
+ * @extends {BaseAPI}
139
+ */
140
+ export declare class NamedRangesApi extends BaseAPI {
141
+ /**
142
+ * Returns a list of named range file records you have previously created. The named range file records are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
143
+ * @summary List named range file records
144
+ * @param {NamedRangesApiFilterNamedRangeRequest} requestParameters Request parameters.
145
+ * @param {*} [options] Override http request option.
146
+ * @throws {RequiredError}
147
+ * @memberof NamedRangesApi
148
+ */
149
+ filterNamedRange(requestParameters: NamedRangesApiFilterNamedRangeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<FilterNamedRangeResponseClass, any>>;
150
+ }