@emilgroup/public-api-sdk 1.25.1 → 1.26.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 (81) hide show
  1. package/.openapi-generator/FILES +9 -0
  2. package/README.md +2 -2
  3. package/api/booking-funnels-api.ts +161 -0
  4. package/api/documents-api.ts +36 -22
  5. package/api/leads-api.ts +4 -4
  6. package/api/named-ranges-api.ts +250 -0
  7. package/api/products-api.ts +65 -38
  8. package/api.ts +4 -0
  9. package/base.ts +1 -0
  10. package/dist/api/booking-funnels-api.d.ts +96 -0
  11. package/dist/api/booking-funnels-api.js +223 -0
  12. package/dist/api/documents-api.d.ts +28 -19
  13. package/dist/api/documents-api.js +26 -20
  14. package/dist/api/leads-api.d.ts +4 -4
  15. package/dist/api/leads-api.js +4 -4
  16. package/dist/api/named-ranges-api.d.ts +150 -0
  17. package/dist/api/named-ranges-api.js +263 -0
  18. package/dist/api/products-api.d.ts +49 -31
  19. package/dist/api/products-api.js +47 -36
  20. package/dist/api.d.ts +2 -0
  21. package/dist/api.js +2 -0
  22. package/dist/base.js +1 -0
  23. package/dist/models/address-field-score-class.d.ts +10 -10
  24. package/dist/models/booking-funnel-class.d.ts +90 -0
  25. package/dist/models/booking-funnel-class.js +15 -0
  26. package/dist/models/create-account-request-dto.d.ts +1 -1
  27. package/dist/models/create-account-request-dto.js +1 -1
  28. package/dist/models/create-document-request-dto.d.ts +2 -2
  29. package/dist/models/create-lead-request-dto.d.ts +13 -1
  30. package/dist/models/create-presigned-post-request-dto.d.ts +2 -2
  31. package/dist/models/document-class.d.ts +1 -1
  32. package/dist/models/filter-named-range-response-class.d.ts +42 -0
  33. package/dist/models/filter-named-range-response-class.js +15 -0
  34. package/dist/models/get-booking-funnel-response-class.d.ts +25 -0
  35. package/dist/models/get-booking-funnel-response-class.js +15 -0
  36. package/dist/models/index.d.ts +7 -0
  37. package/dist/models/index.js +7 -0
  38. package/dist/models/initiate-email-verification-dto.d.ts +1 -1
  39. package/dist/models/insured-object-type-class.d.ts +1 -1
  40. package/dist/models/lead-account-class.d.ts +1 -1
  41. package/dist/models/lead-account-class.js +1 -1
  42. package/dist/models/lead-class.d.ts +7 -0
  43. package/dist/models/lead-policy-object-class.d.ts +2 -2
  44. package/dist/models/partner-class.d.ts +60 -0
  45. package/dist/models/partner-class.js +15 -0
  46. package/dist/models/partner-link-class.d.ts +86 -0
  47. package/dist/models/partner-link-class.js +15 -0
  48. package/dist/models/partner-role-class.d.ts +54 -0
  49. package/dist/models/partner-role-class.js +15 -0
  50. package/dist/models/product-class.d.ts +1 -1
  51. package/dist/models/product-document-class.d.ts +14 -2
  52. package/dist/models/product-factor-for-version-class.d.ts +4 -3
  53. package/dist/models/product-factor-value-for-version-class.d.ts +42 -0
  54. package/dist/models/product-factor-value-for-version-class.js +15 -0
  55. package/dist/models/send-notification-request-dto.d.ts +1 -1
  56. package/dist/models/update-lead-request-dto.d.ts +1 -1
  57. package/models/address-field-score-class.ts +10 -10
  58. package/models/booking-funnel-class.ts +96 -0
  59. package/models/create-account-request-dto.ts +1 -1
  60. package/models/create-document-request-dto.ts +2 -2
  61. package/models/create-lead-request-dto.ts +13 -1
  62. package/models/create-presigned-post-request-dto.ts +2 -2
  63. package/models/document-class.ts +1 -1
  64. package/models/filter-named-range-response-class.ts +48 -0
  65. package/models/get-booking-funnel-response-class.ts +31 -0
  66. package/models/index.ts +7 -0
  67. package/models/initiate-email-verification-dto.ts +1 -1
  68. package/models/insured-object-type-class.ts +1 -1
  69. package/models/lead-account-class.ts +1 -1
  70. package/models/lead-class.ts +7 -0
  71. package/models/lead-policy-object-class.ts +2 -2
  72. package/models/partner-class.ts +66 -0
  73. package/models/partner-link-class.ts +92 -0
  74. package/models/partner-role-class.ts +60 -0
  75. package/models/product-class.ts +1 -1
  76. package/models/product-document-class.ts +14 -2
  77. package/models/product-factor-for-version-class.ts +4 -3
  78. package/models/product-factor-value-for-version-class.ts +48 -0
  79. package/models/send-notification-request-dto.ts +1 -1
  80. package/models/update-lead-request-dto.ts +1 -1
  81. package/package.json +1 -1
@@ -294,7 +294,7 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
294
294
  });
295
295
  },
296
296
  /**
297
- * 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.
297
+ * 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.
298
298
  * @summary List documents
299
299
  * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
300
300
  * @param {string} [authorization] Bearer Token
@@ -360,20 +360,21 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
360
360
  });
361
361
  },
362
362
  /**
363
- * 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.
363
+ * 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.
364
364
  * @summary List product documents
365
365
  * @param {string} productCode
366
366
  * @param {string} [authorization] Bearer Token
367
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
367
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
368
368
  * @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.
369
369
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
370
- * @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.
370
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
371
371
  * @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.
372
372
  * @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.
373
+ * @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.
373
374
  * @param {*} [options] Override http request option.
374
375
  * @throws {RequiredError}
375
376
  */
376
- listProductDocuments: function (productCode, authorization, pageSize, pageToken, filter, search, order, expand, options) {
377
+ listProductDocuments: function (productCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
377
378
  if (options === void 0) { options = {}; }
378
379
  return __awaiter(_this, void 0, void 0, function () {
379
380
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -417,6 +418,9 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
417
418
  if (expand !== undefined) {
418
419
  localVarQueryParameter['expand'] = expand;
419
420
  }
421
+ if (filters !== undefined) {
422
+ localVarQueryParameter['filters'] = filters;
423
+ }
420
424
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
421
425
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
422
426
  }
@@ -577,7 +581,7 @@ var DocumentsApiFp = function (configuration) {
577
581
  });
578
582
  },
579
583
  /**
580
- * 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.
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.
581
585
  * @summary List documents
582
586
  * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
583
587
  * @param {string} [authorization] Bearer Token
@@ -602,25 +606,26 @@ var DocumentsApiFp = function (configuration) {
602
606
  });
603
607
  },
604
608
  /**
605
- * 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.
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.
606
610
  * @summary List product documents
607
611
  * @param {string} productCode
608
612
  * @param {string} [authorization] Bearer Token
609
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
613
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
610
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.
611
615
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
612
- * @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.
616
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
613
617
  * @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.
614
618
  * @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.
619
+ * @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.
615
620
  * @param {*} [options] Override http request option.
616
621
  * @throws {RequiredError}
617
622
  */
618
- listProductDocuments: function (productCode, authorization, pageSize, pageToken, filter, search, order, expand, options) {
623
+ listProductDocuments: function (productCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
619
624
  return __awaiter(this, void 0, void 0, function () {
620
625
  var localVarAxiosArgs;
621
626
  return __generator(this, function (_a) {
622
627
  switch (_a.label) {
623
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, options)];
628
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
624
629
  case 1:
625
630
  localVarAxiosArgs = _a.sent();
626
631
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -706,7 +711,7 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
706
711
  return localVarFp.downloadProductDocumentUrl(productCode, code, authorization, options).then(function (request) { return request(axios, basePath); });
707
712
  },
708
713
  /**
709
- * 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
+ * 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.
710
715
  * @summary List documents
711
716
  * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
712
717
  * @param {string} [authorization] Bearer Token
@@ -721,21 +726,22 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
721
726
  return localVarFp.listDocuments(filter, authorization, pageSize, pageToken, order, expand, options).then(function (request) { return request(axios, basePath); });
722
727
  },
723
728
  /**
724
- * 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
+ * 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.
725
730
  * @summary List product documents
726
731
  * @param {string} productCode
727
732
  * @param {string} [authorization] Bearer Token
728
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
733
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
729
734
  * @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.
730
735
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
731
- * @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.
736
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
732
737
  * @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.
733
738
  * @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.
739
+ * @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.
734
740
  * @param {*} [options] Override http request option.
735
741
  * @throws {RequiredError}
736
742
  */
737
- listProductDocuments: function (productCode, authorization, pageSize, pageToken, filter, search, order, expand, options) {
738
- return localVarFp.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
743
+ listProductDocuments: function (productCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
744
+ return localVarFp.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
739
745
  },
740
746
  /**
741
747
  * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
@@ -811,7 +817,7 @@ var DocumentsApi = /** @class */ (function (_super) {
811
817
  return (0, exports.DocumentsApiFp)(this.configuration).downloadProductDocumentUrl(requestParameters.productCode, requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
812
818
  };
813
819
  /**
814
- * 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.
820
+ * 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.
815
821
  * @summary List documents
816
822
  * @param {DocumentsApiListDocumentsRequest} requestParameters Request parameters.
817
823
  * @param {*} [options] Override http request option.
@@ -823,7 +829,7 @@ var DocumentsApi = /** @class */ (function (_super) {
823
829
  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); });
824
830
  };
825
831
  /**
826
- * 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.
832
+ * 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.
827
833
  * @summary List product documents
828
834
  * @param {DocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
829
835
  * @param {*} [options] Override http request option.
@@ -832,7 +838,7 @@ var DocumentsApi = /** @class */ (function (_super) {
832
838
  */
833
839
  DocumentsApi.prototype.listProductDocuments = function (requestParameters, options) {
834
840
  var _this = this;
835
- 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); });
841
+ 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); });
836
842
  };
837
843
  /**
838
844
  * 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.
@@ -240,7 +240,7 @@ var LeadsApiAxiosParamCreator = function (configuration) {
240
240
  });
241
241
  },
242
242
  /**
243
- * 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.
243
+ * 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.
244
244
  * @summary Retrieve the lead
245
245
  * @param {string} code Unique identifier for the object.
246
246
  * @param {string} [authorization] Bearer Token
@@ -511,7 +511,7 @@ var LeadsApiFp = function (configuration) {
511
511
  });
512
512
  },
513
513
  /**
514
- * 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.
514
+ * 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.
515
515
  * @summary Retrieve the lead
516
516
  * @param {string} code Unique identifier for the object.
517
517
  * @param {string} [authorization] Bearer Token
@@ -639,7 +639,7 @@ var LeadsApiFactory = function (configuration, basePath, axios) {
639
639
  return localVarFp.createLeadSync(createLeadRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
640
640
  },
641
641
  /**
642
- * 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.
642
+ * 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.
643
643
  * @summary Retrieve the lead
644
644
  * @param {string} code Unique identifier for the object.
645
645
  * @param {string} [authorization] Bearer Token
@@ -734,7 +734,7 @@ var LeadsApi = /** @class */ (function (_super) {
734
734
  return (0, exports.LeadsApiFp)(this.configuration).createLeadSync(requestParameters.createLeadRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
735
735
  };
736
736
  /**
737
- * 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.
737
+ * 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.
738
738
  * @summary Retrieve the lead
739
739
  * @param {LeadsApiGetLeadRequest} requestParameters Request parameters.
740
740
  * @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
+ }