@emilgroup/public-api-sdk 1.25.1 → 1.27.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 (82) 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 +56 -28
  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 +6 -1
  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 +40 -22
  13. package/dist/api/documents-api.js +38 -26
  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.d.ts +1 -0
  23. package/dist/base.js +5 -1
  24. package/dist/models/address-field-score-class.d.ts +10 -10
  25. package/dist/models/booking-funnel-class.d.ts +90 -0
  26. package/dist/models/booking-funnel-class.js +15 -0
  27. package/dist/models/create-account-request-dto.d.ts +1 -1
  28. package/dist/models/create-account-request-dto.js +1 -1
  29. package/dist/models/create-document-request-dto.d.ts +2 -2
  30. package/dist/models/create-lead-request-dto.d.ts +13 -1
  31. package/dist/models/create-presigned-post-request-dto.d.ts +2 -2
  32. package/dist/models/document-class.d.ts +1 -1
  33. package/dist/models/filter-named-range-response-class.d.ts +42 -0
  34. package/dist/models/filter-named-range-response-class.js +15 -0
  35. package/dist/models/get-booking-funnel-response-class.d.ts +25 -0
  36. package/dist/models/get-booking-funnel-response-class.js +15 -0
  37. package/dist/models/index.d.ts +7 -0
  38. package/dist/models/index.js +7 -0
  39. package/dist/models/initiate-email-verification-dto.d.ts +1 -1
  40. package/dist/models/insured-object-type-class.d.ts +1 -1
  41. package/dist/models/lead-account-class.d.ts +1 -1
  42. package/dist/models/lead-account-class.js +1 -1
  43. package/dist/models/lead-class.d.ts +7 -0
  44. package/dist/models/lead-policy-object-class.d.ts +2 -2
  45. package/dist/models/partner-class.d.ts +60 -0
  46. package/dist/models/partner-class.js +15 -0
  47. package/dist/models/partner-link-class.d.ts +86 -0
  48. package/dist/models/partner-link-class.js +15 -0
  49. package/dist/models/partner-role-class.d.ts +54 -0
  50. package/dist/models/partner-role-class.js +15 -0
  51. package/dist/models/product-class.d.ts +1 -1
  52. package/dist/models/product-document-class.d.ts +14 -2
  53. package/dist/models/product-factor-for-version-class.d.ts +4 -3
  54. package/dist/models/product-factor-value-for-version-class.d.ts +42 -0
  55. package/dist/models/product-factor-value-for-version-class.js +15 -0
  56. package/dist/models/send-notification-request-dto.d.ts +1 -1
  57. package/dist/models/update-lead-request-dto.d.ts +1 -1
  58. package/models/address-field-score-class.ts +10 -10
  59. package/models/booking-funnel-class.ts +96 -0
  60. package/models/create-account-request-dto.ts +1 -1
  61. package/models/create-document-request-dto.ts +2 -2
  62. package/models/create-lead-request-dto.ts +13 -1
  63. package/models/create-presigned-post-request-dto.ts +2 -2
  64. package/models/document-class.ts +1 -1
  65. package/models/filter-named-range-response-class.ts +48 -0
  66. package/models/get-booking-funnel-response-class.ts +31 -0
  67. package/models/index.ts +7 -0
  68. package/models/initiate-email-verification-dto.ts +1 -1
  69. package/models/insured-object-type-class.ts +1 -1
  70. package/models/lead-account-class.ts +1 -1
  71. package/models/lead-class.ts +7 -0
  72. package/models/lead-policy-object-class.ts +2 -2
  73. package/models/partner-class.ts +66 -0
  74. package/models/partner-link-class.ts +92 -0
  75. package/models/partner-role-class.ts +60 -0
  76. package/models/product-class.ts +1 -1
  77. package/models/product-document-class.ts +14 -2
  78. package/models/product-factor-for-version-class.ts +4 -3
  79. package/models/product-factor-value-for-version-class.ts +48 -0
  80. package/models/send-notification-request-dto.ts +1 -1
  81. package/models/update-lead-request-dto.ts +1 -1
  82. 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,223 @@
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
+ /**
89
+ * BookingFunnelsApi - axios parameter creator
90
+ * @export
91
+ */
92
+ var BookingFunnelsApiAxiosParamCreator = function (configuration) {
93
+ var _this = this;
94
+ return {
95
+ /**
96
+ * 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.
97
+ * @summary Retrieve the booking funnel
98
+ * @param {string} code Unique identifier for the object.
99
+ * @param {string} [authorization] Bearer Token
100
+ * @param {*} [options] Override http request option.
101
+ * @throws {RequiredError}
102
+ */
103
+ getBookingFunnel: function (code, authorization, options) {
104
+ if (options === void 0) { options = {}; }
105
+ return __awaiter(_this, void 0, void 0, function () {
106
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
107
+ return __generator(this, function (_a) {
108
+ switch (_a.label) {
109
+ case 0:
110
+ // verify required parameter 'code' is not null or undefined
111
+ (0, common_1.assertParamExists)('getBookingFunnel', 'code', code);
112
+ localVarPath = "/publicapi/v1/booking-funnels/{code}"
113
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
114
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
115
+ if (configuration) {
116
+ baseOptions = configuration.baseOptions;
117
+ baseAccessToken = configuration.accessToken;
118
+ }
119
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
120
+ localVarHeaderParameter = {};
121
+ localVarQueryParameter = {};
122
+ // authentication bearer required
123
+ // http bearer authentication required
124
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
125
+ case 1:
126
+ // authentication bearer required
127
+ // http bearer authentication required
128
+ _a.sent();
129
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
130
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
131
+ }
132
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
133
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
134
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
135
+ return [2 /*return*/, {
136
+ url: (0, common_1.toPathString)(localVarUrlObj),
137
+ options: localVarRequestOptions,
138
+ }];
139
+ }
140
+ });
141
+ });
142
+ },
143
+ };
144
+ };
145
+ exports.BookingFunnelsApiAxiosParamCreator = BookingFunnelsApiAxiosParamCreator;
146
+ /**
147
+ * BookingFunnelsApi - functional programming interface
148
+ * @export
149
+ */
150
+ var BookingFunnelsApiFp = function (configuration) {
151
+ var localVarAxiosParamCreator = (0, exports.BookingFunnelsApiAxiosParamCreator)(configuration);
152
+ return {
153
+ /**
154
+ * 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.
155
+ * @summary Retrieve the booking funnel
156
+ * @param {string} code Unique identifier for the object.
157
+ * @param {string} [authorization] Bearer Token
158
+ * @param {*} [options] Override http request option.
159
+ * @throws {RequiredError}
160
+ */
161
+ getBookingFunnel: function (code, authorization, options) {
162
+ return __awaiter(this, void 0, void 0, function () {
163
+ var localVarAxiosArgs;
164
+ return __generator(this, function (_a) {
165
+ switch (_a.label) {
166
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getBookingFunnel(code, authorization, options)];
167
+ case 1:
168
+ localVarAxiosArgs = _a.sent();
169
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
170
+ }
171
+ });
172
+ });
173
+ },
174
+ };
175
+ };
176
+ exports.BookingFunnelsApiFp = BookingFunnelsApiFp;
177
+ /**
178
+ * BookingFunnelsApi - factory interface
179
+ * @export
180
+ */
181
+ var BookingFunnelsApiFactory = function (configuration, basePath, axios) {
182
+ var localVarFp = (0, exports.BookingFunnelsApiFp)(configuration);
183
+ return {
184
+ /**
185
+ * 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.
186
+ * @summary Retrieve the booking funnel
187
+ * @param {string} code Unique identifier for the object.
188
+ * @param {string} [authorization] Bearer Token
189
+ * @param {*} [options] Override http request option.
190
+ * @throws {RequiredError}
191
+ */
192
+ getBookingFunnel: function (code, authorization, options) {
193
+ return localVarFp.getBookingFunnel(code, authorization, options).then(function (request) { return request(axios, basePath); });
194
+ },
195
+ };
196
+ };
197
+ exports.BookingFunnelsApiFactory = BookingFunnelsApiFactory;
198
+ /**
199
+ * BookingFunnelsApi - object-oriented interface
200
+ * @export
201
+ * @class BookingFunnelsApi
202
+ * @extends {BaseAPI}
203
+ */
204
+ var BookingFunnelsApi = /** @class */ (function (_super) {
205
+ __extends(BookingFunnelsApi, _super);
206
+ function BookingFunnelsApi() {
207
+ return _super !== null && _super.apply(this, arguments) || this;
208
+ }
209
+ /**
210
+ * 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.
211
+ * @summary Retrieve the booking funnel
212
+ * @param {BookingFunnelsApiGetBookingFunnelRequest} requestParameters Request parameters.
213
+ * @param {*} [options] Override http request option.
214
+ * @throws {RequiredError}
215
+ * @memberof BookingFunnelsApi
216
+ */
217
+ BookingFunnelsApi.prototype.getBookingFunnel = function (requestParameters, options) {
218
+ var _this = this;
219
+ return (0, exports.BookingFunnelsApiFp)(this.configuration).getBookingFunnel(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
220
+ };
221
+ return BookingFunnelsApi;
222
+ }(base_1.BaseAPI));
223
+ exports.BookingFunnelsApi = BookingFunnelsApi;
@@ -57,12 +57,13 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
57
57
  * @param {string} productCode
58
58
  * @param {string} code
59
59
  * @param {string} [authorization] Bearer Token
60
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
60
61
  * @param {*} [options] Override http request option.
61
62
  * @throws {RequiredError}
62
63
  */
63
- downloadProductDocumentUrl: (productCode: string, code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
64
+ downloadProductDocumentUrl: (productCode: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig) => Promise<RequestArgs>;
64
65
  /**
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
+ * 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
67
  * @summary List documents
67
68
  * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
68
69
  * @param {string} [authorization] Bearer Token
@@ -75,20 +76,21 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
75
76
  */
76
77
  listDocuments: (filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
77
78
  /**
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
+ * 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
80
  * @summary List product documents
80
81
  * @param {string} productCode
81
82
  * @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.
83
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
83
84
  * @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
85
  * @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.
86
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
86
87
  * @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
88
  * @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.
89
+ * @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
90
  * @param {*} [options] Override http request option.
89
91
  * @throws {RequiredError}
90
92
  */
91
- listProductDocuments: (productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
93
+ listProductDocuments: (productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
92
94
  /**
93
95
  * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
94
96
  * @summary Upload documents using pre-signed URL
@@ -138,12 +140,13 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
138
140
  * @param {string} productCode
139
141
  * @param {string} code
140
142
  * @param {string} [authorization] Bearer Token
143
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
141
144
  * @param {*} [options] Override http request option.
142
145
  * @throws {RequiredError}
143
146
  */
144
- downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>>;
147
+ downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>>;
145
148
  /**
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.
149
+ * 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
150
  * @summary List documents
148
151
  * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
149
152
  * @param {string} [authorization] Bearer Token
@@ -156,20 +159,21 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
156
159
  */
157
160
  listDocuments(filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>>;
158
161
  /**
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.
162
+ * 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
163
  * @summary List product documents
161
164
  * @param {string} productCode
162
165
  * @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.
166
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
164
167
  * @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
168
  * @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.
169
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
167
170
  * @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
171
  * @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.
172
+ * @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
173
  * @param {*} [options] Override http request option.
170
174
  * @throws {RequiredError}
171
175
  */
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>>;
176
+ 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
177
  /**
174
178
  * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
175
179
  * @summary Upload documents using pre-signed URL
@@ -219,12 +223,13 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
219
223
  * @param {string} productCode
220
224
  * @param {string} code
221
225
  * @param {string} [authorization] Bearer Token
226
+ * @param {'attachment' | 'inline'} [contentDisposition] Content disposition override. Default will be depending on the document type.
222
227
  * @param {*} [options] Override http request option.
223
228
  * @throws {RequiredError}
224
229
  */
225
- downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass>;
230
+ downloadProductDocumentUrl(productCode: string, code: string, authorization?: string, contentDisposition?: 'attachment' | 'inline', options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass>;
226
231
  /**
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.
232
+ * 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
233
  * @summary List documents
229
234
  * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
230
235
  * @param {string} [authorization] Bearer Token
@@ -237,20 +242,21 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
237
242
  */
238
243
  listDocuments(filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocumentsResponseClass>;
239
244
  /**
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.
245
+ * 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
246
  * @summary List product documents
242
247
  * @param {string} productCode
243
248
  * @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.
249
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
245
250
  * @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
251
  * @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.
252
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
248
253
  * @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
254
  * @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.
255
+ * @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
256
  * @param {*} [options] Override http request option.
251
257
  * @throws {RequiredError}
252
258
  */
253
- listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
259
+ listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
254
260
  /**
255
261
  * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
256
262
  * @summary Upload documents using pre-signed URL
@@ -348,6 +354,12 @@ export interface DocumentsApiDownloadProductDocumentUrlRequest {
348
354
  * @memberof DocumentsApiDownloadProductDocumentUrl
349
355
  */
350
356
  readonly authorization?: string;
357
+ /**
358
+ * Content disposition override. Default will be depending on the document type.
359
+ * @type {'attachment' | 'inline'}
360
+ * @memberof DocumentsApiDownloadProductDocumentUrl
361
+ */
362
+ readonly contentDisposition?: 'attachment' | 'inline';
351
363
  }
352
364
  /**
353
365
  * Request parameters for listDocuments operation in DocumentsApi.
@@ -411,7 +423,7 @@ export interface DocumentsApiListProductDocumentsRequest {
411
423
  */
412
424
  readonly authorization?: string;
413
425
  /**
414
- * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
426
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
415
427
  * @type {any}
416
428
  * @memberof DocumentsApiListProductDocuments
417
429
  */
@@ -429,7 +441,7 @@ export interface DocumentsApiListProductDocumentsRequest {
429
441
  */
430
442
  readonly filter?: any;
431
443
  /**
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.
444
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
433
445
  * @type {any}
434
446
  * @memberof DocumentsApiListProductDocuments
435
447
  */
@@ -446,6 +458,12 @@ export interface DocumentsApiListProductDocumentsRequest {
446
458
  * @memberof DocumentsApiListProductDocuments
447
459
  */
448
460
  readonly expand?: any;
461
+ /**
462
+ * 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.
463
+ * @type {any}
464
+ * @memberof DocumentsApiListProductDocuments
465
+ */
466
+ readonly filters?: any;
449
467
  }
450
468
  /**
451
469
  * Request parameters for preSignedPost operation in DocumentsApi.
@@ -510,7 +528,7 @@ export declare class DocumentsApi extends BaseAPI {
510
528
  */
511
529
  downloadProductDocumentUrl(requestParameters: DocumentsApiDownloadProductDocumentUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductDocumentDownloadUrlResponseClass, any>>;
512
530
  /**
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.
531
+ * 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
532
  * @summary List documents
515
533
  * @param {DocumentsApiListDocumentsRequest} requestParameters Request parameters.
516
534
  * @param {*} [options] Override http request option.
@@ -519,7 +537,7 @@ export declare class DocumentsApi extends BaseAPI {
519
537
  */
520
538
  listDocuments(requestParameters: DocumentsApiListDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocumentsResponseClass, any>>;
521
539
  /**
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.
540
+ * 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
541
  * @summary List product documents
524
542
  * @param {DocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
525
543
  * @param {*} [options] Override http request option.