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