@emilgroup/customer-sdk-node 1.9.0 → 1.10.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.
- package/.openapi-generator/FILES +6 -0
- package/README.md +2 -2
- package/api/authentication-api.ts +601 -0
- package/api/claims-api.ts +16 -16
- package/api/customers-api.ts +72 -1770
- package/api/documents-api.ts +442 -0
- package/api/invites-api.ts +443 -0
- package/api/invoices-api.ts +245 -0
- package/api/payments-api.ts +277 -0
- package/api/policies-api.ts +16 -16
- package/api/products-api.ts +19 -19
- package/api.ts +10 -0
- package/dist/api/authentication-api.d.ts +332 -0
- package/dist/api/authentication-api.js +604 -0
- package/dist/api/claims-api.d.ts +16 -16
- package/dist/api/claims-api.js +12 -12
- package/dist/api/customers-api.d.ts +0 -954
- package/dist/api/customers-api.js +20 -1381
- package/dist/api/documents-api.d.ts +262 -0
- package/dist/api/documents-api.js +417 -0
- package/dist/api/invites-api.d.ts +248 -0
- package/dist/api/invites-api.js +456 -0
- package/dist/api/invoices-api.d.ts +150 -0
- package/dist/api/invoices-api.js +253 -0
- package/dist/api/payments-api.d.ts +162 -0
- package/dist/api/payments-api.js +306 -0
- package/dist/api/policies-api.d.ts +16 -16
- package/dist/api/policies-api.js +12 -12
- package/dist/api/products-api.d.ts +20 -20
- package/dist/api/products-api.js +12 -12
- package/dist/api.d.ts +5 -0
- package/dist/api.js +5 -0
- package/dist/models/account-class.d.ts +26 -1
- package/dist/models/account-class.js +7 -0
- package/dist/models/create-account-request-dto.d.ts +39 -9
- package/dist/models/create-account-request-dto.js +11 -1
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/dist/models/list-policies-response-class.d.ts +4 -4
- package/dist/models/list-products-response-class.d.ts +31 -0
- package/dist/models/list-products-response-class.js +15 -0
- package/models/account-class.ts +29 -1
- package/models/create-account-request-dto.ts +41 -9
- package/models/index.ts +1 -0
- package/models/list-policies-response-class.ts +4 -4
- package/models/list-products-response-class.ts +37 -0
- package/package.json +2 -2
|
@@ -0,0 +1,306 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* EMIL CustomerService
|
|
6
|
+
* The EMIL CustomerService 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.PaymentsApi = exports.PaymentsApiFactory = exports.PaymentsApiFp = exports.PaymentsApiAxiosParamCreator = 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
|
+
* PaymentsApi - axios parameter creator
|
|
94
|
+
* @export
|
|
95
|
+
*/
|
|
96
|
+
var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
97
|
+
var _this = this;
|
|
98
|
+
return {
|
|
99
|
+
/**
|
|
100
|
+
* Request to complete a payment change by customer.
|
|
101
|
+
* @summary Request payment setup complete by customer
|
|
102
|
+
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
103
|
+
* @param {CompletePaymentSetupPspRequest} completePaymentSetupPspRequest
|
|
104
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
105
|
+
* @param {*} [options] Override http request option.
|
|
106
|
+
* @throws {RequiredError}
|
|
107
|
+
*/
|
|
108
|
+
completePaymentSetup: function (customerCode, completePaymentSetupPspRequest, authorization, options) {
|
|
109
|
+
if (options === void 0) { options = {}; }
|
|
110
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
111
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
112
|
+
return __generator(this, function (_a) {
|
|
113
|
+
// verify required parameter 'customerCode' is not null or undefined
|
|
114
|
+
(0, common_1.assertParamExists)('completePaymentSetup', 'customerCode', customerCode);
|
|
115
|
+
// verify required parameter 'completePaymentSetupPspRequest' is not null or undefined
|
|
116
|
+
(0, common_1.assertParamExists)('completePaymentSetup', 'completePaymentSetupPspRequest', completePaymentSetupPspRequest);
|
|
117
|
+
localVarPath = "/v1/customers/{customerCode}/payment_setup/complete"
|
|
118
|
+
.replace("{".concat("customerCode", "}"), encodeURIComponent(String(customerCode)));
|
|
119
|
+
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
120
|
+
if (configuration) {
|
|
121
|
+
baseOptions = configuration.baseOptions;
|
|
122
|
+
baseAccessToken = configuration.accessToken;
|
|
123
|
+
}
|
|
124
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
125
|
+
localVarHeaderParameter = {};
|
|
126
|
+
localVarQueryParameter = {};
|
|
127
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
128
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
129
|
+
}
|
|
130
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
131
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
132
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
133
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
134
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(completePaymentSetupPspRequest, localVarRequestOptions, configuration);
|
|
135
|
+
return [2 /*return*/, {
|
|
136
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
137
|
+
options: localVarRequestOptions,
|
|
138
|
+
}];
|
|
139
|
+
});
|
|
140
|
+
});
|
|
141
|
+
},
|
|
142
|
+
/**
|
|
143
|
+
* Request to initiate a payment change by customer.
|
|
144
|
+
* @summary Request payment setup initiation by customer
|
|
145
|
+
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
146
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
147
|
+
* @param {*} [options] Override http request option.
|
|
148
|
+
* @throws {RequiredError}
|
|
149
|
+
*/
|
|
150
|
+
initiatePaymentSetup: function (customerCode, authorization, options) {
|
|
151
|
+
if (options === void 0) { options = {}; }
|
|
152
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
153
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
154
|
+
return __generator(this, function (_a) {
|
|
155
|
+
// verify required parameter 'customerCode' is not null or undefined
|
|
156
|
+
(0, common_1.assertParamExists)('initiatePaymentSetup', 'customerCode', customerCode);
|
|
157
|
+
localVarPath = "/v1/customers/{customerCode}/payment_setup/initiate"
|
|
158
|
+
.replace("{".concat("customerCode", "}"), encodeURIComponent(String(customerCode)));
|
|
159
|
+
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
160
|
+
if (configuration) {
|
|
161
|
+
baseOptions = configuration.baseOptions;
|
|
162
|
+
baseAccessToken = configuration.accessToken;
|
|
163
|
+
}
|
|
164
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
165
|
+
localVarHeaderParameter = {};
|
|
166
|
+
localVarQueryParameter = {};
|
|
167
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
168
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
169
|
+
}
|
|
170
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
171
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
172
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
173
|
+
return [2 /*return*/, {
|
|
174
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
175
|
+
options: localVarRequestOptions,
|
|
176
|
+
}];
|
|
177
|
+
});
|
|
178
|
+
});
|
|
179
|
+
},
|
|
180
|
+
};
|
|
181
|
+
};
|
|
182
|
+
exports.PaymentsApiAxiosParamCreator = PaymentsApiAxiosParamCreator;
|
|
183
|
+
/**
|
|
184
|
+
* PaymentsApi - functional programming interface
|
|
185
|
+
* @export
|
|
186
|
+
*/
|
|
187
|
+
var PaymentsApiFp = function (configuration) {
|
|
188
|
+
var localVarAxiosParamCreator = (0, exports.PaymentsApiAxiosParamCreator)(configuration);
|
|
189
|
+
return {
|
|
190
|
+
/**
|
|
191
|
+
* Request to complete a payment change by customer.
|
|
192
|
+
* @summary Request payment setup complete by customer
|
|
193
|
+
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
194
|
+
* @param {CompletePaymentSetupPspRequest} completePaymentSetupPspRequest
|
|
195
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
196
|
+
* @param {*} [options] Override http request option.
|
|
197
|
+
* @throws {RequiredError}
|
|
198
|
+
*/
|
|
199
|
+
completePaymentSetup: function (customerCode, completePaymentSetupPspRequest, authorization, options) {
|
|
200
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
201
|
+
var localVarAxiosArgs;
|
|
202
|
+
return __generator(this, function (_a) {
|
|
203
|
+
switch (_a.label) {
|
|
204
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.completePaymentSetup(customerCode, completePaymentSetupPspRequest, authorization, options)];
|
|
205
|
+
case 1:
|
|
206
|
+
localVarAxiosArgs = _a.sent();
|
|
207
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
208
|
+
}
|
|
209
|
+
});
|
|
210
|
+
});
|
|
211
|
+
},
|
|
212
|
+
/**
|
|
213
|
+
* Request to initiate a payment change by customer.
|
|
214
|
+
* @summary Request payment setup initiation by customer
|
|
215
|
+
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
216
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
217
|
+
* @param {*} [options] Override http request option.
|
|
218
|
+
* @throws {RequiredError}
|
|
219
|
+
*/
|
|
220
|
+
initiatePaymentSetup: function (customerCode, authorization, options) {
|
|
221
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
222
|
+
var localVarAxiosArgs;
|
|
223
|
+
return __generator(this, function (_a) {
|
|
224
|
+
switch (_a.label) {
|
|
225
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.initiatePaymentSetup(customerCode, authorization, options)];
|
|
226
|
+
case 1:
|
|
227
|
+
localVarAxiosArgs = _a.sent();
|
|
228
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
229
|
+
}
|
|
230
|
+
});
|
|
231
|
+
});
|
|
232
|
+
},
|
|
233
|
+
};
|
|
234
|
+
};
|
|
235
|
+
exports.PaymentsApiFp = PaymentsApiFp;
|
|
236
|
+
/**
|
|
237
|
+
* PaymentsApi - factory interface
|
|
238
|
+
* @export
|
|
239
|
+
*/
|
|
240
|
+
var PaymentsApiFactory = function (configuration, basePath, axios) {
|
|
241
|
+
var localVarFp = (0, exports.PaymentsApiFp)(configuration);
|
|
242
|
+
return {
|
|
243
|
+
/**
|
|
244
|
+
* Request to complete a payment change by customer.
|
|
245
|
+
* @summary Request payment setup complete by customer
|
|
246
|
+
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
247
|
+
* @param {CompletePaymentSetupPspRequest} completePaymentSetupPspRequest
|
|
248
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
249
|
+
* @param {*} [options] Override http request option.
|
|
250
|
+
* @throws {RequiredError}
|
|
251
|
+
*/
|
|
252
|
+
completePaymentSetup: function (customerCode, completePaymentSetupPspRequest, authorization, options) {
|
|
253
|
+
return localVarFp.completePaymentSetup(customerCode, completePaymentSetupPspRequest, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
254
|
+
},
|
|
255
|
+
/**
|
|
256
|
+
* Request to initiate a payment change by customer.
|
|
257
|
+
* @summary Request payment setup initiation by customer
|
|
258
|
+
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
259
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
260
|
+
* @param {*} [options] Override http request option.
|
|
261
|
+
* @throws {RequiredError}
|
|
262
|
+
*/
|
|
263
|
+
initiatePaymentSetup: function (customerCode, authorization, options) {
|
|
264
|
+
return localVarFp.initiatePaymentSetup(customerCode, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
265
|
+
},
|
|
266
|
+
};
|
|
267
|
+
};
|
|
268
|
+
exports.PaymentsApiFactory = PaymentsApiFactory;
|
|
269
|
+
/**
|
|
270
|
+
* PaymentsApi - object-oriented interface
|
|
271
|
+
* @export
|
|
272
|
+
* @class PaymentsApi
|
|
273
|
+
* @extends {BaseAPI}
|
|
274
|
+
*/
|
|
275
|
+
var PaymentsApi = /** @class */ (function (_super) {
|
|
276
|
+
__extends(PaymentsApi, _super);
|
|
277
|
+
function PaymentsApi() {
|
|
278
|
+
return _super !== null && _super.apply(this, arguments) || this;
|
|
279
|
+
}
|
|
280
|
+
/**
|
|
281
|
+
* Request to complete a payment change by customer.
|
|
282
|
+
* @summary Request payment setup complete by customer
|
|
283
|
+
* @param {PaymentsApiCompletePaymentSetupRequest} requestParameters Request parameters.
|
|
284
|
+
* @param {*} [options] Override http request option.
|
|
285
|
+
* @throws {RequiredError}
|
|
286
|
+
* @memberof PaymentsApi
|
|
287
|
+
*/
|
|
288
|
+
PaymentsApi.prototype.completePaymentSetup = function (requestParameters, options) {
|
|
289
|
+
var _this = this;
|
|
290
|
+
return (0, exports.PaymentsApiFp)(this.configuration).completePaymentSetup(requestParameters.customerCode, requestParameters.completePaymentSetupPspRequest, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
291
|
+
};
|
|
292
|
+
/**
|
|
293
|
+
* Request to initiate a payment change by customer.
|
|
294
|
+
* @summary Request payment setup initiation by customer
|
|
295
|
+
* @param {PaymentsApiInitiatePaymentSetupRequest} requestParameters Request parameters.
|
|
296
|
+
* @param {*} [options] Override http request option.
|
|
297
|
+
* @throws {RequiredError}
|
|
298
|
+
* @memberof PaymentsApi
|
|
299
|
+
*/
|
|
300
|
+
PaymentsApi.prototype.initiatePaymentSetup = function (requestParameters, options) {
|
|
301
|
+
var _this = this;
|
|
302
|
+
return (0, exports.PaymentsApiFp)(this.configuration).initiatePaymentSetup(requestParameters.customerCode, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
303
|
+
};
|
|
304
|
+
return PaymentsApi;
|
|
305
|
+
}(base_1.BaseAPI));
|
|
306
|
+
exports.PaymentsApi = PaymentsApi;
|
|
@@ -52,12 +52,12 @@ export declare const PoliciesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
52
52
|
* List all the policies that belong to a customer, the policies can be filtered by policy code, policy number.
|
|
53
53
|
* @summary List policies of a customer
|
|
54
54
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
55
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
56
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
55
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
56
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
57
57
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
58
58
|
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
59
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
60
|
-
* @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
|
|
59
|
+
* @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.
|
|
60
|
+
* @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.
|
|
61
61
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
62
62
|
* @param {*} [options] Override http request option.
|
|
63
63
|
* @throws {RequiredError}
|
|
@@ -137,12 +137,12 @@ export declare const PoliciesApiFp: (configuration?: Configuration) => {
|
|
|
137
137
|
* List all the policies that belong to a customer, the policies can be filtered by policy code, policy number.
|
|
138
138
|
* @summary List policies of a customer
|
|
139
139
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
140
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
141
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
140
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
141
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
142
142
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
143
143
|
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
144
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
145
|
-
* @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
|
|
144
|
+
* @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.
|
|
145
|
+
* @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.
|
|
146
146
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
147
147
|
* @param {*} [options] Override http request option.
|
|
148
148
|
* @throws {RequiredError}
|
|
@@ -222,12 +222,12 @@ export declare const PoliciesApiFactory: (configuration?: Configuration, basePat
|
|
|
222
222
|
* List all the policies that belong to a customer, the policies can be filtered by policy code, policy number.
|
|
223
223
|
* @summary List policies of a customer
|
|
224
224
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
225
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
226
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
225
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
226
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
227
227
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
228
228
|
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
229
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
230
|
-
* @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
|
|
229
|
+
* @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.
|
|
230
|
+
* @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.
|
|
231
231
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
232
232
|
* @param {*} [options] Override http request option.
|
|
233
233
|
* @throws {RequiredError}
|
|
@@ -351,13 +351,13 @@ export interface PoliciesApiListPoliciesRequest {
|
|
|
351
351
|
*/
|
|
352
352
|
readonly customerCode: string;
|
|
353
353
|
/**
|
|
354
|
-
* A limit on the number of objects to be returned.
|
|
354
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
355
355
|
* @type {any}
|
|
356
356
|
* @memberof PoliciesApiListPolicies
|
|
357
357
|
*/
|
|
358
358
|
readonly pageSize?: any;
|
|
359
359
|
/**
|
|
360
|
-
* A cursor for use in pagination.
|
|
360
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
361
361
|
* @type {any}
|
|
362
362
|
* @memberof PoliciesApiListPolicies
|
|
363
363
|
*/
|
|
@@ -375,13 +375,13 @@ export interface PoliciesApiListPoliciesRequest {
|
|
|
375
375
|
*/
|
|
376
376
|
readonly search?: any;
|
|
377
377
|
/**
|
|
378
|
-
* The order parameter determines how the results should be sorted according to a specified field.
|
|
378
|
+
* 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.
|
|
379
379
|
* @type {any}
|
|
380
380
|
* @memberof PoliciesApiListPolicies
|
|
381
381
|
*/
|
|
382
382
|
readonly order?: any;
|
|
383
383
|
/**
|
|
384
|
-
* 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
|
|
384
|
+
* 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.
|
|
385
385
|
* @type {any}
|
|
386
386
|
* @memberof PoliciesApiListPolicies
|
|
387
387
|
*/
|
package/dist/api/policies-api.js
CHANGED
|
@@ -192,12 +192,12 @@ var PoliciesApiAxiosParamCreator = function (configuration) {
|
|
|
192
192
|
* List all the policies that belong to a customer, the policies can be filtered by policy code, policy number.
|
|
193
193
|
* @summary List policies of a customer
|
|
194
194
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
195
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
196
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
195
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
196
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
197
197
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
198
198
|
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
199
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
200
|
-
* @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
|
|
199
|
+
* @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.
|
|
200
|
+
* @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.
|
|
201
201
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
202
202
|
* @param {*} [options] Override http request option.
|
|
203
203
|
* @throws {RequiredError}
|
|
@@ -489,12 +489,12 @@ var PoliciesApiFp = function (configuration) {
|
|
|
489
489
|
* List all the policies that belong to a customer, the policies can be filtered by policy code, policy number.
|
|
490
490
|
* @summary List policies of a customer
|
|
491
491
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
492
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
493
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
492
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
493
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
494
494
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
495
495
|
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
496
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
497
|
-
* @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
|
|
496
|
+
* @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.
|
|
497
|
+
* @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.
|
|
498
498
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
499
499
|
* @param {*} [options] Override http request option.
|
|
500
500
|
* @throws {RequiredError}
|
|
@@ -642,12 +642,12 @@ var PoliciesApiFactory = function (configuration, basePath, axios) {
|
|
|
642
642
|
* List all the policies that belong to a customer, the policies can be filtered by policy code, policy number.
|
|
643
643
|
* @summary List policies of a customer
|
|
644
644
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
645
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
646
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
645
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
646
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
647
647
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
648
648
|
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
649
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
650
|
-
* @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
|
|
649
|
+
* @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.
|
|
650
|
+
* @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.
|
|
651
651
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
652
652
|
* @param {*} [options] Override http request option.
|
|
653
653
|
* @throws {RequiredError}
|
|
@@ -13,7 +13,7 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { GetProductResponseClass } from '../models';
|
|
16
|
-
import {
|
|
16
|
+
import { ListProductsResponseClass } from '../models';
|
|
17
17
|
/**
|
|
18
18
|
* ProductsApi - axios parameter creator
|
|
19
19
|
* @export
|
|
@@ -33,12 +33,12 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
33
33
|
* List all the products that a customer can insure, the products can be filtered by product code, product number.
|
|
34
34
|
* @summary List products available to insure for a customer
|
|
35
35
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
36
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
37
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
36
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
37
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
38
38
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
39
39
|
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
40
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
41
|
-
* @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
|
|
40
|
+
* @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.
|
|
41
|
+
* @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.
|
|
42
42
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
43
43
|
* @param {*} [options] Override http request option.
|
|
44
44
|
* @throws {RequiredError}
|
|
@@ -64,17 +64,17 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
64
64
|
* List all the products that a customer can insure, the products can be filtered by product code, product number.
|
|
65
65
|
* @summary List products available to insure for a customer
|
|
66
66
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
67
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
68
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
67
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
68
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
69
69
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
70
70
|
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
71
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
72
|
-
* @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
|
|
71
|
+
* @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.
|
|
72
|
+
* @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.
|
|
73
73
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
74
74
|
* @param {*} [options] Override http request option.
|
|
75
75
|
* @throws {RequiredError}
|
|
76
76
|
*/
|
|
77
|
-
listProducts(customerCode: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
77
|
+
listProducts(customerCode: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductsResponseClass>>;
|
|
78
78
|
};
|
|
79
79
|
/**
|
|
80
80
|
* ProductsApi - factory interface
|
|
@@ -95,17 +95,17 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
95
95
|
* List all the products that a customer can insure, the products can be filtered by product code, product number.
|
|
96
96
|
* @summary List products available to insure for a customer
|
|
97
97
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer.
|
|
98
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
99
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
98
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
99
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
100
100
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
101
101
|
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
102
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
103
|
-
* @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
|
|
102
|
+
* @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.
|
|
103
|
+
* @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.
|
|
104
104
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
105
105
|
* @param {*} [options] Override http request option.
|
|
106
106
|
* @throws {RequiredError}
|
|
107
107
|
*/
|
|
108
|
-
listProducts(customerCode: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, authorization?: string, options?: any): AxiosPromise<
|
|
108
|
+
listProducts(customerCode: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, authorization?: string, options?: any): AxiosPromise<ListProductsResponseClass>;
|
|
109
109
|
};
|
|
110
110
|
/**
|
|
111
111
|
* Request parameters for getProduct operation in ProductsApi.
|
|
@@ -145,13 +145,13 @@ export interface ProductsApiListProductsRequest {
|
|
|
145
145
|
*/
|
|
146
146
|
readonly customerCode: string;
|
|
147
147
|
/**
|
|
148
|
-
* A limit on the number of objects to be returned.
|
|
148
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
149
149
|
* @type {any}
|
|
150
150
|
* @memberof ProductsApiListProducts
|
|
151
151
|
*/
|
|
152
152
|
readonly pageSize?: any;
|
|
153
153
|
/**
|
|
154
|
-
* A cursor for use in pagination.
|
|
154
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
155
155
|
* @type {any}
|
|
156
156
|
* @memberof ProductsApiListProducts
|
|
157
157
|
*/
|
|
@@ -169,13 +169,13 @@ export interface ProductsApiListProductsRequest {
|
|
|
169
169
|
*/
|
|
170
170
|
readonly search?: any;
|
|
171
171
|
/**
|
|
172
|
-
* The order parameter determines how the results should be sorted according to a specified field.
|
|
172
|
+
* 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.
|
|
173
173
|
* @type {any}
|
|
174
174
|
* @memberof ProductsApiListProducts
|
|
175
175
|
*/
|
|
176
176
|
readonly order?: any;
|
|
177
177
|
/**
|
|
178
|
-
* 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
|
|
178
|
+
* 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.
|
|
179
179
|
* @type {any}
|
|
180
180
|
* @memberof ProductsApiListProducts
|
|
181
181
|
*/
|
|
@@ -211,5 +211,5 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
211
211
|
* @throws {RequiredError}
|
|
212
212
|
* @memberof ProductsApi
|
|
213
213
|
*/
|
|
214
|
-
listProducts(requestParameters: ProductsApiListProductsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
214
|
+
listProducts(requestParameters: ProductsApiListProductsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductsResponseClass, any>>;
|
|
215
215
|
}
|