@emilgroup/public-api-sdk 1.6.0 → 1.8.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 (45) hide show
  1. package/.openapi-generator/FILES +9 -0
  2. package/README.md +2 -2
  3. package/api/address-completions-validations-api.ts +348 -0
  4. package/api/documents-api.ts +189 -14
  5. package/api.ts +2 -0
  6. package/dist/api/address-completions-validations-api.d.ts +197 -0
  7. package/dist/api/address-completions-validations-api.js +357 -0
  8. package/dist/api/documents-api.d.ts +111 -10
  9. package/dist/api/documents-api.js +131 -8
  10. package/dist/api.d.ts +1 -0
  11. package/dist/api.js +1 -0
  12. package/dist/models/address-completion-item-class.d.ts +49 -0
  13. package/dist/models/address-completion-item-class.js +15 -0
  14. package/dist/models/address-completion-response-class.d.ts +25 -0
  15. package/dist/models/address-completion-response-class.js +15 -0
  16. package/dist/models/address-field-score-class.d.ts +48 -0
  17. package/dist/models/address-field-score-class.js +15 -0
  18. package/dist/models/create-lead-request-dto.d.ts +12 -12
  19. package/dist/models/index.d.ts +8 -0
  20. package/dist/models/index.js +8 -0
  21. package/dist/models/insured-object-class.d.ts +7 -7
  22. package/dist/models/lead-class.d.ts +6 -0
  23. package/dist/models/list-product-documents-response-class.d.ts +31 -0
  24. package/dist/models/list-product-documents-response-class.js +15 -0
  25. package/dist/models/product-document-class.d.ts +91 -0
  26. package/dist/models/product-document-class.js +28 -0
  27. package/dist/models/structured-address-class.d.ts +54 -0
  28. package/dist/models/structured-address-class.js +15 -0
  29. package/dist/models/suggested-address-details-class.d.ts +90 -0
  30. package/dist/models/suggested-address-details-class.js +15 -0
  31. package/dist/models/validate-address-response-class.d.ts +50 -0
  32. package/dist/models/validate-address-response-class.js +15 -0
  33. package/models/address-completion-item-class.ts +55 -0
  34. package/models/address-completion-response-class.ts +31 -0
  35. package/models/address-field-score-class.ts +54 -0
  36. package/models/create-lead-request-dto.ts +12 -12
  37. package/models/index.ts +8 -0
  38. package/models/insured-object-class.ts +7 -7
  39. package/models/lead-class.ts +6 -0
  40. package/models/list-product-documents-response-class.ts +37 -0
  41. package/models/product-document-class.ts +100 -0
  42. package/models/structured-address-class.ts +60 -0
  43. package/models/suggested-address-details-class.ts +96 -0
  44. package/models/validate-address-response-class.ts +56 -0
  45. package/package.json +1 -1
@@ -0,0 +1,357 @@
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.AddressCompletionsValidationsApi = exports.AddressCompletionsValidationsApiFactory = exports.AddressCompletionsValidationsApiFp = exports.AddressCompletionsValidationsApiAxiosParamCreator = 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
+ * AddressCompletionsValidationsApi - axios parameter creator
90
+ * @export
91
+ */
92
+ var AddressCompletionsValidationsApiAxiosParamCreator = function (configuration) {
93
+ var _this = this;
94
+ return {
95
+ /**
96
+ * This will return a list of address completions based on the provided partial address.
97
+ * @summary Retrieve the address
98
+ * @param {string} partialAddress
99
+ * @param {string} [authorization] Bearer Token
100
+ * @param {*} [options] Override http request option.
101
+ * @throws {RequiredError}
102
+ */
103
+ listAddressCompletions: function (partialAddress, 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 'partialAddress' is not null or undefined
111
+ (0, common_1.assertParamExists)('listAddressCompletions', 'partialAddress', partialAddress);
112
+ localVarPath = "/publicapi/v1/addresses/completions";
113
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
114
+ if (configuration) {
115
+ baseOptions = configuration.baseOptions;
116
+ baseAccessToken = configuration.accessToken;
117
+ }
118
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
119
+ localVarHeaderParameter = {};
120
+ localVarQueryParameter = {};
121
+ // authentication bearer required
122
+ // http bearer authentication required
123
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
124
+ case 1:
125
+ // authentication bearer required
126
+ // http bearer authentication required
127
+ _a.sent();
128
+ if (partialAddress !== undefined) {
129
+ localVarQueryParameter['partialAddress'] = partialAddress;
130
+ }
131
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
132
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
133
+ }
134
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
135
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
136
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
137
+ return [2 /*return*/, {
138
+ url: (0, common_1.toPathString)(localVarUrlObj),
139
+ options: localVarRequestOptions,
140
+ }];
141
+ }
142
+ });
143
+ });
144
+ },
145
+ /**
146
+ * This will return a response whether the provided address is valid or not.
147
+ * @summary Retrieve the Address validation
148
+ * @param {string} city The city of the address
149
+ * @param {string} country The country of the address
150
+ * @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long
151
+ * @param {string} street The street of the address
152
+ * @param {string} houseNumber The house number of the address
153
+ * @param {string} [authorization] Bearer Token
154
+ * @param {string} [completeAddress] The complete address to validate
155
+ * @param {*} [options] Override http request option.
156
+ * @throws {RequiredError}
157
+ */
158
+ validateAddress: function (city, country, postalCode, street, houseNumber, authorization, completeAddress, options) {
159
+ if (options === void 0) { options = {}; }
160
+ return __awaiter(_this, void 0, void 0, function () {
161
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
162
+ return __generator(this, function (_a) {
163
+ switch (_a.label) {
164
+ case 0:
165
+ // verify required parameter 'city' is not null or undefined
166
+ (0, common_1.assertParamExists)('validateAddress', 'city', city);
167
+ // verify required parameter 'country' is not null or undefined
168
+ (0, common_1.assertParamExists)('validateAddress', 'country', country);
169
+ // verify required parameter 'postalCode' is not null or undefined
170
+ (0, common_1.assertParamExists)('validateAddress', 'postalCode', postalCode);
171
+ // verify required parameter 'street' is not null or undefined
172
+ (0, common_1.assertParamExists)('validateAddress', 'street', street);
173
+ // verify required parameter 'houseNumber' is not null or undefined
174
+ (0, common_1.assertParamExists)('validateAddress', 'houseNumber', houseNumber);
175
+ localVarPath = "/publicapi/v1/addresses/validation";
176
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
177
+ if (configuration) {
178
+ baseOptions = configuration.baseOptions;
179
+ baseAccessToken = configuration.accessToken;
180
+ }
181
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
182
+ localVarHeaderParameter = {};
183
+ localVarQueryParameter = {};
184
+ // authentication bearer required
185
+ // http bearer authentication required
186
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
187
+ case 1:
188
+ // authentication bearer required
189
+ // http bearer authentication required
190
+ _a.sent();
191
+ if (completeAddress !== undefined) {
192
+ localVarQueryParameter['completeAddress'] = completeAddress;
193
+ }
194
+ if (city !== undefined) {
195
+ localVarQueryParameter['city'] = city;
196
+ }
197
+ if (country !== undefined) {
198
+ localVarQueryParameter['country'] = country;
199
+ }
200
+ if (postalCode !== undefined) {
201
+ localVarQueryParameter['postalCode'] = postalCode;
202
+ }
203
+ if (street !== undefined) {
204
+ localVarQueryParameter['street'] = street;
205
+ }
206
+ if (houseNumber !== undefined) {
207
+ localVarQueryParameter['houseNumber'] = houseNumber;
208
+ }
209
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
210
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
211
+ }
212
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
213
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
214
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
215
+ return [2 /*return*/, {
216
+ url: (0, common_1.toPathString)(localVarUrlObj),
217
+ options: localVarRequestOptions,
218
+ }];
219
+ }
220
+ });
221
+ });
222
+ },
223
+ };
224
+ };
225
+ exports.AddressCompletionsValidationsApiAxiosParamCreator = AddressCompletionsValidationsApiAxiosParamCreator;
226
+ /**
227
+ * AddressCompletionsValidationsApi - functional programming interface
228
+ * @export
229
+ */
230
+ var AddressCompletionsValidationsApiFp = function (configuration) {
231
+ var localVarAxiosParamCreator = (0, exports.AddressCompletionsValidationsApiAxiosParamCreator)(configuration);
232
+ return {
233
+ /**
234
+ * This will return a list of address completions based on the provided partial address.
235
+ * @summary Retrieve the address
236
+ * @param {string} partialAddress
237
+ * @param {string} [authorization] Bearer Token
238
+ * @param {*} [options] Override http request option.
239
+ * @throws {RequiredError}
240
+ */
241
+ listAddressCompletions: function (partialAddress, authorization, options) {
242
+ return __awaiter(this, void 0, void 0, function () {
243
+ var localVarAxiosArgs;
244
+ return __generator(this, function (_a) {
245
+ switch (_a.label) {
246
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listAddressCompletions(partialAddress, authorization, options)];
247
+ case 1:
248
+ localVarAxiosArgs = _a.sent();
249
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
250
+ }
251
+ });
252
+ });
253
+ },
254
+ /**
255
+ * This will return a response whether the provided address is valid or not.
256
+ * @summary Retrieve the Address validation
257
+ * @param {string} city The city of the address
258
+ * @param {string} country The country of the address
259
+ * @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long
260
+ * @param {string} street The street of the address
261
+ * @param {string} houseNumber The house number of the address
262
+ * @param {string} [authorization] Bearer Token
263
+ * @param {string} [completeAddress] The complete address to validate
264
+ * @param {*} [options] Override http request option.
265
+ * @throws {RequiredError}
266
+ */
267
+ validateAddress: function (city, country, postalCode, street, houseNumber, authorization, completeAddress, options) {
268
+ return __awaiter(this, void 0, void 0, function () {
269
+ var localVarAxiosArgs;
270
+ return __generator(this, function (_a) {
271
+ switch (_a.label) {
272
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.validateAddress(city, country, postalCode, street, houseNumber, authorization, completeAddress, options)];
273
+ case 1:
274
+ localVarAxiosArgs = _a.sent();
275
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
276
+ }
277
+ });
278
+ });
279
+ },
280
+ };
281
+ };
282
+ exports.AddressCompletionsValidationsApiFp = AddressCompletionsValidationsApiFp;
283
+ /**
284
+ * AddressCompletionsValidationsApi - factory interface
285
+ * @export
286
+ */
287
+ var AddressCompletionsValidationsApiFactory = function (configuration, basePath, axios) {
288
+ var localVarFp = (0, exports.AddressCompletionsValidationsApiFp)(configuration);
289
+ return {
290
+ /**
291
+ * This will return a list of address completions based on the provided partial address.
292
+ * @summary Retrieve the address
293
+ * @param {string} partialAddress
294
+ * @param {string} [authorization] Bearer Token
295
+ * @param {*} [options] Override http request option.
296
+ * @throws {RequiredError}
297
+ */
298
+ listAddressCompletions: function (partialAddress, authorization, options) {
299
+ return localVarFp.listAddressCompletions(partialAddress, authorization, options).then(function (request) { return request(axios, basePath); });
300
+ },
301
+ /**
302
+ * This will return a response whether the provided address is valid or not.
303
+ * @summary Retrieve the Address validation
304
+ * @param {string} city The city of the address
305
+ * @param {string} country The country of the address
306
+ * @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long
307
+ * @param {string} street The street of the address
308
+ * @param {string} houseNumber The house number of the address
309
+ * @param {string} [authorization] Bearer Token
310
+ * @param {string} [completeAddress] The complete address to validate
311
+ * @param {*} [options] Override http request option.
312
+ * @throws {RequiredError}
313
+ */
314
+ validateAddress: function (city, country, postalCode, street, houseNumber, authorization, completeAddress, options) {
315
+ return localVarFp.validateAddress(city, country, postalCode, street, houseNumber, authorization, completeAddress, options).then(function (request) { return request(axios, basePath); });
316
+ },
317
+ };
318
+ };
319
+ exports.AddressCompletionsValidationsApiFactory = AddressCompletionsValidationsApiFactory;
320
+ /**
321
+ * AddressCompletionsValidationsApi - object-oriented interface
322
+ * @export
323
+ * @class AddressCompletionsValidationsApi
324
+ * @extends {BaseAPI}
325
+ */
326
+ var AddressCompletionsValidationsApi = /** @class */ (function (_super) {
327
+ __extends(AddressCompletionsValidationsApi, _super);
328
+ function AddressCompletionsValidationsApi() {
329
+ return _super !== null && _super.apply(this, arguments) || this;
330
+ }
331
+ /**
332
+ * This will return a list of address completions based on the provided partial address.
333
+ * @summary Retrieve the address
334
+ * @param {AddressCompletionsValidationsApiListAddressCompletionsRequest} requestParameters Request parameters.
335
+ * @param {*} [options] Override http request option.
336
+ * @throws {RequiredError}
337
+ * @memberof AddressCompletionsValidationsApi
338
+ */
339
+ AddressCompletionsValidationsApi.prototype.listAddressCompletions = function (requestParameters, options) {
340
+ var _this = this;
341
+ return (0, exports.AddressCompletionsValidationsApiFp)(this.configuration).listAddressCompletions(requestParameters.partialAddress, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
342
+ };
343
+ /**
344
+ * This will return a response whether the provided address is valid or not.
345
+ * @summary Retrieve the Address validation
346
+ * @param {AddressCompletionsValidationsApiValidateAddressRequest} requestParameters Request parameters.
347
+ * @param {*} [options] Override http request option.
348
+ * @throws {RequiredError}
349
+ * @memberof AddressCompletionsValidationsApi
350
+ */
351
+ AddressCompletionsValidationsApi.prototype.validateAddress = function (requestParameters, options) {
352
+ var _this = this;
353
+ return (0, exports.AddressCompletionsValidationsApiFp)(this.configuration).validateAddress(requestParameters.city, requestParameters.country, requestParameters.postalCode, requestParameters.street, requestParameters.houseNumber, requestParameters.authorization, requestParameters.completeAddress, options).then(function (request) { return request(_this.axios, _this.basePath); });
354
+ };
355
+ return AddressCompletionsValidationsApi;
356
+ }(base_1.BaseAPI));
357
+ exports.AddressCompletionsValidationsApi = AddressCompletionsValidationsApi;
@@ -14,6 +14,7 @@ import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreateDocumentRequestDto } from '../models';
16
16
  import { ListDocumentsResponseClass } from '../models';
17
+ import { ListProductDocumentsResponseClass } from '../models';
17
18
  /**
18
19
  * DocumentsApi - axios parameter creator
19
20
  * @export
@@ -40,6 +41,20 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
40
41
  /**
41
42
  * 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.
42
43
  * @summary List documents
44
+ * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
45
+ * @param {string} [authorization] Bearer Token
46
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
47
+ * @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.
48
+ * @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.
49
+ * @param {string} [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.
50
+ * @param {*} [options] Override http request option.
51
+ * @throws {RequiredError}
52
+ */
53
+ listDocuments: (filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
54
+ /**
55
+ * 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.
56
+ * @summary List product documents
57
+ * @param {string} productCode
43
58
  * @param {string} [authorization] Bearer Token
44
59
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
45
60
  * @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.
@@ -50,7 +65,7 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
50
65
  * @param {*} [options] Override http request option.
51
66
  * @throws {RequiredError}
52
67
  */
53
- listDocuments: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
68
+ listProductDocuments: (productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
54
69
  };
55
70
  /**
56
71
  * DocumentsApi - functional programming interface
@@ -78,6 +93,20 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
78
93
  /**
79
94
  * 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.
80
95
  * @summary List documents
96
+ * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
97
+ * @param {string} [authorization] Bearer Token
98
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
99
+ * @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.
100
+ * @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.
101
+ * @param {string} [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.
102
+ * @param {*} [options] Override http request option.
103
+ * @throws {RequiredError}
104
+ */
105
+ listDocuments(filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>>;
106
+ /**
107
+ * 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.
108
+ * @summary List product documents
109
+ * @param {string} productCode
81
110
  * @param {string} [authorization] Bearer Token
82
111
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
83
112
  * @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.
@@ -88,7 +117,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
88
117
  * @param {*} [options] Override http request option.
89
118
  * @throws {RequiredError}
90
119
  */
91
- listDocuments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>>;
120
+ 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>>;
92
121
  };
93
122
  /**
94
123
  * DocumentsApi - factory interface
@@ -116,6 +145,20 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
116
145
  /**
117
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.
118
147
  * @summary List documents
148
+ * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
149
+ * @param {string} [authorization] Bearer Token
150
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
151
+ * @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.
152
+ * @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.
153
+ * @param {string} [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.
154
+ * @param {*} [options] Override http request option.
155
+ * @throws {RequiredError}
156
+ */
157
+ listDocuments(filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocumentsResponseClass>;
158
+ /**
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
+ * @summary List product documents
161
+ * @param {string} productCode
119
162
  * @param {string} [authorization] Bearer Token
120
163
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
121
164
  * @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.
@@ -126,7 +169,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
126
169
  * @param {*} [options] Override http request option.
127
170
  * @throws {RequiredError}
128
171
  */
129
- listDocuments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListDocumentsResponseClass>;
172
+ listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
130
173
  };
131
174
  /**
132
175
  * Request parameters for createTemporaryDocument operation in DocumentsApi.
@@ -172,6 +215,12 @@ export interface DocumentsApiDownloadDocumentRequest {
172
215
  * @interface DocumentsApiListDocumentsRequest
173
216
  */
174
217
  export interface DocumentsApiListDocumentsRequest {
218
+ /**
219
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
220
+ * @type {string}
221
+ * @memberof DocumentsApiListDocuments
222
+ */
223
+ readonly filter: string;
175
224
  /**
176
225
  * Bearer Token
177
226
  * @type {string}
@@ -180,38 +229,81 @@ export interface DocumentsApiListDocumentsRequest {
180
229
  readonly authorization?: string;
181
230
  /**
182
231
  * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
183
- * @type {any}
232
+ * @type {number}
233
+ * @memberof DocumentsApiListDocuments
234
+ */
235
+ readonly pageSize?: number;
236
+ /**
237
+ * 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.
238
+ * @type {string}
239
+ * @memberof DocumentsApiListDocuments
240
+ */
241
+ readonly pageToken?: string;
242
+ /**
243
+ * 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.
244
+ * @type {string}
184
245
  * @memberof DocumentsApiListDocuments
185
246
  */
247
+ readonly order?: string;
248
+ /**
249
+ * 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.
250
+ * @type {string}
251
+ * @memberof DocumentsApiListDocuments
252
+ */
253
+ readonly expand?: string;
254
+ }
255
+ /**
256
+ * Request parameters for listProductDocuments operation in DocumentsApi.
257
+ * @export
258
+ * @interface DocumentsApiListProductDocumentsRequest
259
+ */
260
+ export interface DocumentsApiListProductDocumentsRequest {
261
+ /**
262
+ *
263
+ * @type {string}
264
+ * @memberof DocumentsApiListProductDocuments
265
+ */
266
+ readonly productCode: string;
267
+ /**
268
+ * Bearer Token
269
+ * @type {string}
270
+ * @memberof DocumentsApiListProductDocuments
271
+ */
272
+ readonly authorization?: string;
273
+ /**
274
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
275
+ * @type {any}
276
+ * @memberof DocumentsApiListProductDocuments
277
+ */
186
278
  readonly pageSize?: any;
187
279
  /**
188
280
  * 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.
189
281
  * @type {any}
190
- * @memberof DocumentsApiListDocuments
282
+ * @memberof DocumentsApiListProductDocuments
191
283
  */
192
284
  readonly pageToken?: any;
193
285
  /**
194
286
  * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
195
287
  * @type {any}
196
- * @memberof DocumentsApiListDocuments
288
+ * @memberof DocumentsApiListProductDocuments
197
289
  */
198
290
  readonly filter?: any;
199
291
  /**
200
292
  * 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.
201
293
  * @type {any}
202
- * @memberof DocumentsApiListDocuments
294
+ * @memberof DocumentsApiListProductDocuments
203
295
  */
204
296
  readonly search?: any;
205
297
  /**
206
298
  * 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.
207
299
  * @type {any}
208
- * @memberof DocumentsApiListDocuments
300
+ * @memberof DocumentsApiListProductDocuments
209
301
  */
210
302
  readonly order?: any;
211
303
  /**
212
304
  * 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.
213
305
  * @type {any}
214
- * @memberof DocumentsApiListDocuments
306
+ * @memberof DocumentsApiListProductDocuments
215
307
  */
216
308
  readonly expand?: any;
217
309
  }
@@ -248,5 +340,14 @@ export declare class DocumentsApi extends BaseAPI {
248
340
  * @throws {RequiredError}
249
341
  * @memberof DocumentsApi
250
342
  */
251
- listDocuments(requestParameters?: DocumentsApiListDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocumentsResponseClass, any>>;
343
+ listDocuments(requestParameters: DocumentsApiListDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocumentsResponseClass, any>>;
344
+ /**
345
+ * 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.
346
+ * @summary List product documents
347
+ * @param {DocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
348
+ * @param {*} [options] Override http request option.
349
+ * @throws {RequiredError}
350
+ * @memberof DocumentsApi
351
+ */
352
+ listProductDocuments(requestParameters: DocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductDocumentsResponseClass, any>>;
252
353
  }