@emilgroup/public-api-sdk-node 1.27.0 → 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
@@ -0,0 +1,96 @@
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 { GetBookingFunnelResponseClass } from '../models';
16
+ /**
17
+ * BookingFunnelsApi - axios parameter creator
18
+ * @export
19
+ */
20
+ export declare const BookingFunnelsApiAxiosParamCreator: (configuration?: Configuration) => {
21
+ /**
22
+ * Retrieves the details of the booking funnel that was previously created. Supply the unique booking funnel code that was returned when you created it and Emil Api will return the corresponding booking funnel information.
23
+ * @summary Retrieve the booking funnel
24
+ * @param {string} code Unique identifier for the object.
25
+ * @param {string} [authorization] Bearer Token
26
+ * @param {*} [options] Override http request option.
27
+ * @throws {RequiredError}
28
+ */
29
+ getBookingFunnel: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
30
+ };
31
+ /**
32
+ * BookingFunnelsApi - functional programming interface
33
+ * @export
34
+ */
35
+ export declare const BookingFunnelsApiFp: (configuration?: Configuration) => {
36
+ /**
37
+ * Retrieves the details of the booking funnel that was previously created. Supply the unique booking funnel code that was returned when you created it and Emil Api will return the corresponding booking funnel information.
38
+ * @summary Retrieve the booking funnel
39
+ * @param {string} code Unique identifier for the object.
40
+ * @param {string} [authorization] Bearer Token
41
+ * @param {*} [options] Override http request option.
42
+ * @throws {RequiredError}
43
+ */
44
+ getBookingFunnel(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBookingFunnelResponseClass>>;
45
+ };
46
+ /**
47
+ * BookingFunnelsApi - factory interface
48
+ * @export
49
+ */
50
+ export declare const BookingFunnelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
51
+ /**
52
+ * Retrieves the details of the booking funnel that was previously created. Supply the unique booking funnel code that was returned when you created it and Emil Api will return the corresponding booking funnel information.
53
+ * @summary Retrieve the booking funnel
54
+ * @param {string} code Unique identifier for the object.
55
+ * @param {string} [authorization] Bearer Token
56
+ * @param {*} [options] Override http request option.
57
+ * @throws {RequiredError}
58
+ */
59
+ getBookingFunnel(code: string, authorization?: string, options?: any): AxiosPromise<GetBookingFunnelResponseClass>;
60
+ };
61
+ /**
62
+ * Request parameters for getBookingFunnel operation in BookingFunnelsApi.
63
+ * @export
64
+ * @interface BookingFunnelsApiGetBookingFunnelRequest
65
+ */
66
+ export interface BookingFunnelsApiGetBookingFunnelRequest {
67
+ /**
68
+ * Unique identifier for the object.
69
+ * @type {string}
70
+ * @memberof BookingFunnelsApiGetBookingFunnel
71
+ */
72
+ readonly code: string;
73
+ /**
74
+ * Bearer Token
75
+ * @type {string}
76
+ * @memberof BookingFunnelsApiGetBookingFunnel
77
+ */
78
+ readonly authorization?: string;
79
+ }
80
+ /**
81
+ * BookingFunnelsApi - object-oriented interface
82
+ * @export
83
+ * @class BookingFunnelsApi
84
+ * @extends {BaseAPI}
85
+ */
86
+ export declare class BookingFunnelsApi extends BaseAPI {
87
+ /**
88
+ * Retrieves the details of the booking funnel that was previously created. Supply the unique booking funnel code that was returned when you created it and Emil Api will return the corresponding booking funnel information.
89
+ * @summary Retrieve the booking funnel
90
+ * @param {BookingFunnelsApiGetBookingFunnelRequest} requestParameters Request parameters.
91
+ * @param {*} [options] Override http request option.
92
+ * @throws {RequiredError}
93
+ * @memberof BookingFunnelsApi
94
+ */
95
+ getBookingFunnel(requestParameters: BookingFunnelsApiGetBookingFunnelRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBookingFunnelResponseClass, any>>;
96
+ }
@@ -0,0 +1,227 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Emil PublicAPI
6
+ * The Emil Public API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __extends = (this && this.__extends) || (function () {
16
+ var extendStatics = function (d, b) {
17
+ extendStatics = Object.setPrototypeOf ||
18
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
19
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
20
+ return extendStatics(d, b);
21
+ };
22
+ return function (d, b) {
23
+ if (typeof b !== "function" && b !== null)
24
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
25
+ extendStatics(d, b);
26
+ function __() { this.constructor = d; }
27
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
28
+ };
29
+ })();
30
+ var __assign = (this && this.__assign) || function () {
31
+ __assign = Object.assign || function(t) {
32
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
33
+ s = arguments[i];
34
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
35
+ t[p] = s[p];
36
+ }
37
+ return t;
38
+ };
39
+ return __assign.apply(this, arguments);
40
+ };
41
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
42
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
43
+ return new (P || (P = Promise))(function (resolve, reject) {
44
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
45
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
46
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
47
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
48
+ });
49
+ };
50
+ var __generator = (this && this.__generator) || function (thisArg, body) {
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
52
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
+ function verb(n) { return function (v) { return step([n, v]); }; }
54
+ function step(op) {
55
+ if (f) throw new TypeError("Generator is already executing.");
56
+ while (g && (g = 0, op[0] && (_ = 0)), _) try {
57
+ if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
58
+ if (y = 0, t) op = [op[0] & 2, t.value];
59
+ switch (op[0]) {
60
+ case 0: case 1: t = op; break;
61
+ case 4: _.label++; return { value: op[1], done: false };
62
+ case 5: _.label++; y = op[1]; op = [0]; continue;
63
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
64
+ default:
65
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
66
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
67
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
68
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
69
+ if (t[2]) _.ops.pop();
70
+ _.trys.pop(); continue;
71
+ }
72
+ op = body.call(thisArg, _);
73
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
74
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
75
+ }
76
+ };
77
+ var __importDefault = (this && this.__importDefault) || function (mod) {
78
+ return (mod && mod.__esModule) ? mod : { "default": mod };
79
+ };
80
+ Object.defineProperty(exports, "__esModule", { value: true });
81
+ exports.BookingFunnelsApi = exports.BookingFunnelsApiFactory = exports.BookingFunnelsApiFp = exports.BookingFunnelsApiAxiosParamCreator = void 0;
82
+ var axios_1 = __importDefault(require("axios"));
83
+ // Some imports not used depending on template conditions
84
+ // @ts-ignore
85
+ var common_1 = require("../common");
86
+ // @ts-ignore
87
+ var base_1 = require("../base");
88
+ // URLSearchParams not necessarily used
89
+ // @ts-ignore
90
+ var url_1 = require("url");
91
+ var FormData = require('form-data');
92
+ /**
93
+ * BookingFunnelsApi - axios parameter creator
94
+ * @export
95
+ */
96
+ var BookingFunnelsApiAxiosParamCreator = function (configuration) {
97
+ var _this = this;
98
+ return {
99
+ /**
100
+ * Retrieves the details of the booking funnel that was previously created. Supply the unique booking funnel code that was returned when you created it and Emil Api will return the corresponding booking funnel information.
101
+ * @summary Retrieve the booking funnel
102
+ * @param {string} code Unique identifier for the object.
103
+ * @param {string} [authorization] Bearer Token
104
+ * @param {*} [options] Override http request option.
105
+ * @throws {RequiredError}
106
+ */
107
+ getBookingFunnel: function (code, authorization, options) {
108
+ if (options === void 0) { options = {}; }
109
+ return __awaiter(_this, void 0, void 0, function () {
110
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
111
+ return __generator(this, function (_a) {
112
+ switch (_a.label) {
113
+ case 0:
114
+ // verify required parameter 'code' is not null or undefined
115
+ (0, common_1.assertParamExists)('getBookingFunnel', 'code', code);
116
+ localVarPath = "/publicapi/v1/booking-funnels/{code}"
117
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
118
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
119
+ if (configuration) {
120
+ baseOptions = configuration.baseOptions;
121
+ baseAccessToken = configuration.accessToken;
122
+ }
123
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
124
+ localVarHeaderParameter = {};
125
+ localVarQueryParameter = {};
126
+ // authentication bearer required
127
+ // http bearer authentication required
128
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
129
+ case 1:
130
+ // authentication bearer required
131
+ // http bearer authentication required
132
+ _a.sent();
133
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
134
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
135
+ }
136
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
137
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
138
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
139
+ return [2 /*return*/, {
140
+ url: (0, common_1.toPathString)(localVarUrlObj),
141
+ options: localVarRequestOptions,
142
+ }];
143
+ }
144
+ });
145
+ });
146
+ },
147
+ };
148
+ };
149
+ exports.BookingFunnelsApiAxiosParamCreator = BookingFunnelsApiAxiosParamCreator;
150
+ /**
151
+ * BookingFunnelsApi - functional programming interface
152
+ * @export
153
+ */
154
+ var BookingFunnelsApiFp = function (configuration) {
155
+ var localVarAxiosParamCreator = (0, exports.BookingFunnelsApiAxiosParamCreator)(configuration);
156
+ return {
157
+ /**
158
+ * Retrieves the details of the booking funnel that was previously created. Supply the unique booking funnel code that was returned when you created it and Emil Api will return the corresponding booking funnel information.
159
+ * @summary Retrieve the booking funnel
160
+ * @param {string} code Unique identifier for the object.
161
+ * @param {string} [authorization] Bearer Token
162
+ * @param {*} [options] Override http request option.
163
+ * @throws {RequiredError}
164
+ */
165
+ getBookingFunnel: function (code, authorization, options) {
166
+ return __awaiter(this, void 0, void 0, function () {
167
+ var localVarAxiosArgs;
168
+ return __generator(this, function (_a) {
169
+ switch (_a.label) {
170
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getBookingFunnel(code, authorization, options)];
171
+ case 1:
172
+ localVarAxiosArgs = _a.sent();
173
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
174
+ }
175
+ });
176
+ });
177
+ },
178
+ };
179
+ };
180
+ exports.BookingFunnelsApiFp = BookingFunnelsApiFp;
181
+ /**
182
+ * BookingFunnelsApi - factory interface
183
+ * @export
184
+ */
185
+ var BookingFunnelsApiFactory = function (configuration, basePath, axios) {
186
+ var localVarFp = (0, exports.BookingFunnelsApiFp)(configuration);
187
+ return {
188
+ /**
189
+ * Retrieves the details of the booking funnel that was previously created. Supply the unique booking funnel code that was returned when you created it and Emil Api will return the corresponding booking funnel information.
190
+ * @summary Retrieve the booking funnel
191
+ * @param {string} code Unique identifier for the object.
192
+ * @param {string} [authorization] Bearer Token
193
+ * @param {*} [options] Override http request option.
194
+ * @throws {RequiredError}
195
+ */
196
+ getBookingFunnel: function (code, authorization, options) {
197
+ return localVarFp.getBookingFunnel(code, authorization, options).then(function (request) { return request(axios, basePath); });
198
+ },
199
+ };
200
+ };
201
+ exports.BookingFunnelsApiFactory = BookingFunnelsApiFactory;
202
+ /**
203
+ * BookingFunnelsApi - object-oriented interface
204
+ * @export
205
+ * @class BookingFunnelsApi
206
+ * @extends {BaseAPI}
207
+ */
208
+ var BookingFunnelsApi = /** @class */ (function (_super) {
209
+ __extends(BookingFunnelsApi, _super);
210
+ function BookingFunnelsApi() {
211
+ return _super !== null && _super.apply(this, arguments) || this;
212
+ }
213
+ /**
214
+ * Retrieves the details of the booking funnel that was previously created. Supply the unique booking funnel code that was returned when you created it and Emil Api will return the corresponding booking funnel information.
215
+ * @summary Retrieve the booking funnel
216
+ * @param {BookingFunnelsApiGetBookingFunnelRequest} requestParameters Request parameters.
217
+ * @param {*} [options] Override http request option.
218
+ * @throws {RequiredError}
219
+ * @memberof BookingFunnelsApi
220
+ */
221
+ BookingFunnelsApi.prototype.getBookingFunnel = function (requestParameters, options) {
222
+ var _this = this;
223
+ return (0, exports.BookingFunnelsApiFp)(this.configuration).getBookingFunnel(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
224
+ };
225
+ return BookingFunnelsApi;
226
+ }(base_1.BaseAPI));
227
+ exports.BookingFunnelsApi = BookingFunnelsApi;
@@ -62,7 +62,7 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
62
62
  */
63
63
  downloadProductDocumentUrl: (productCode: string, code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
64
64
  /**
65
- * 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.
65
+ * 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.
66
66
  * @summary List documents
67
67
  * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
68
68
  * @param {string} [authorization] Bearer Token
@@ -75,20 +75,21 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
75
75
  */
76
76
  listDocuments: (filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
77
77
  /**
78
- * 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.
78
+ * 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.
79
79
  * @summary List product documents
80
80
  * @param {string} productCode
81
81
  * @param {string} [authorization] Bearer Token
82
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
82
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
83
83
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
84
84
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
85
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
85
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
86
86
  * @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.
87
87
  * @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.
88
+ * @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.
88
89
  * @param {*} [options] Override http request option.
89
90
  * @throws {RequiredError}
90
91
  */
91
- listProductDocuments: (productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
92
+ listProductDocuments: (productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
92
93
  /**
93
94
  * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
94
95
  * @summary Upload documents using pre-signed URL
@@ -143,7 +144,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
143
144
  */
144
145
  downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>>;
145
146
  /**
146
- * 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.
147
+ * 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.
147
148
  * @summary List documents
148
149
  * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
149
150
  * @param {string} [authorization] Bearer Token
@@ -156,20 +157,21 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
156
157
  */
157
158
  listDocuments(filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>>;
158
159
  /**
159
- * 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.
160
+ * 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.
160
161
  * @summary List product documents
161
162
  * @param {string} productCode
162
163
  * @param {string} [authorization] Bearer Token
163
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
164
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
164
165
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
165
166
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
166
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
167
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
167
168
  * @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.
168
169
  * @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.
170
+ * @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.
169
171
  * @param {*} [options] Override http request option.
170
172
  * @throws {RequiredError}
171
173
  */
172
- listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>>;
174
+ listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>>;
173
175
  /**
174
176
  * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
175
177
  * @summary Upload documents using pre-signed URL
@@ -224,7 +226,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
224
226
  */
225
227
  downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass>;
226
228
  /**
227
- * 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.
229
+ * 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.
228
230
  * @summary List documents
229
231
  * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
230
232
  * @param {string} [authorization] Bearer Token
@@ -237,20 +239,21 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
237
239
  */
238
240
  listDocuments(filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocumentsResponseClass>;
239
241
  /**
240
- * 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.
242
+ * 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.
241
243
  * @summary List product documents
242
244
  * @param {string} productCode
243
245
  * @param {string} [authorization] Bearer Token
244
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
246
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
245
247
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
246
248
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
247
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
249
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
248
250
  * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
249
251
  * @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.
252
+ * @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
253
  * @param {*} [options] Override http request option.
251
254
  * @throws {RequiredError}
252
255
  */
253
- listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
256
+ listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
254
257
  /**
255
258
  * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
256
259
  * @summary Upload documents using pre-signed URL
@@ -411,7 +414,7 @@ export interface DocumentsApiListProductDocumentsRequest {
411
414
  */
412
415
  readonly authorization?: string;
413
416
  /**
414
- * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
417
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
415
418
  * @type {any}
416
419
  * @memberof DocumentsApiListProductDocuments
417
420
  */
@@ -429,7 +432,7 @@ export interface DocumentsApiListProductDocumentsRequest {
429
432
  */
430
433
  readonly filter?: any;
431
434
  /**
432
- * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
435
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
433
436
  * @type {any}
434
437
  * @memberof DocumentsApiListProductDocuments
435
438
  */
@@ -446,6 +449,12 @@ export interface DocumentsApiListProductDocumentsRequest {
446
449
  * @memberof DocumentsApiListProductDocuments
447
450
  */
448
451
  readonly expand?: any;
452
+ /**
453
+ * 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.
454
+ * @type {any}
455
+ * @memberof DocumentsApiListProductDocuments
456
+ */
457
+ readonly filters?: any;
449
458
  }
450
459
  /**
451
460
  * Request parameters for preSignedPost operation in DocumentsApi.
@@ -510,7 +519,7 @@ export declare class DocumentsApi extends BaseAPI {
510
519
  */
511
520
  downloadProductDocumentUrl(requestParameters: DocumentsApiDownloadProductDocumentUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductDocumentDownloadUrlResponseClass, any>>;
512
521
  /**
513
- * 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.
522
+ * 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.
514
523
  * @summary List documents
515
524
  * @param {DocumentsApiListDocumentsRequest} requestParameters Request parameters.
516
525
  * @param {*} [options] Override http request option.
@@ -519,7 +528,7 @@ export declare class DocumentsApi extends BaseAPI {
519
528
  */
520
529
  listDocuments(requestParameters: DocumentsApiListDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocumentsResponseClass, any>>;
521
530
  /**
522
- * 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.
531
+ * 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.
523
532
  * @summary List product documents
524
533
  * @param {DocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
525
534
  * @param {*} [options] Override http request option.