@teemill/platform 0.10.0 → 0.11.1
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/README.md +2 -2
- package/api.ts +1017 -196
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +8 -2
- package/dist/api.d.ts +465 -1
- package/dist/api.js +548 -2
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +3 -2
- package/dist/esm/api.d.ts +465 -1
- package/dist/esm/api.js +543 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +3 -2
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Platform API
|
|
5
5
|
* Manage Your podOS platform
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.11.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -66,6 +66,294 @@ export const VariantAttributeThumbnailTypeEnum = {
|
|
|
66
66
|
Color: 'color',
|
|
67
67
|
Image: 'image'
|
|
68
68
|
};
|
|
69
|
+
/**
|
|
70
|
+
* CustomersApi - axios parameter creator
|
|
71
|
+
* @export
|
|
72
|
+
*/
|
|
73
|
+
export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
74
|
+
return {
|
|
75
|
+
/**
|
|
76
|
+
* Export customers as a CSV file
|
|
77
|
+
* @summary Export customers
|
|
78
|
+
* @param {string} project Project unique identifier
|
|
79
|
+
* @param {string} platformId The platform identifier
|
|
80
|
+
* @param {*} [options] Override http request option.
|
|
81
|
+
* @throws {RequiredError}
|
|
82
|
+
*/
|
|
83
|
+
exportCustomers: (project_1, platformId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, ...args_1], void 0, function* (project, platformId, options = {}) {
|
|
84
|
+
// verify required parameter 'project' is not null or undefined
|
|
85
|
+
assertParamExists('exportCustomers', 'project', project);
|
|
86
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
87
|
+
assertParamExists('exportCustomers', 'platformId', platformId);
|
|
88
|
+
const localVarPath = `/v1/platform/{platformId}/customers/export`
|
|
89
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
90
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
91
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
92
|
+
let baseOptions;
|
|
93
|
+
if (configuration) {
|
|
94
|
+
baseOptions = configuration.baseOptions;
|
|
95
|
+
}
|
|
96
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
97
|
+
const localVarHeaderParameter = {};
|
|
98
|
+
const localVarQueryParameter = {};
|
|
99
|
+
// authentication session-oauth required
|
|
100
|
+
// oauth required
|
|
101
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
102
|
+
// authentication api-key required
|
|
103
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
104
|
+
if (project !== undefined) {
|
|
105
|
+
localVarQueryParameter['project'] = project;
|
|
106
|
+
}
|
|
107
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
108
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
109
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
110
|
+
return {
|
|
111
|
+
url: toPathString(localVarUrlObj),
|
|
112
|
+
options: localVarRequestOptions,
|
|
113
|
+
};
|
|
114
|
+
}),
|
|
115
|
+
/**
|
|
116
|
+
* Get a customer for a platform by a given customer ID.
|
|
117
|
+
* @summary Get customer
|
|
118
|
+
* @param {string} project Project unique identifier
|
|
119
|
+
* @param {string} platformId The platform identifier
|
|
120
|
+
* @param {string} customerId The customer identifier
|
|
121
|
+
* @param {*} [options] Override http request option.
|
|
122
|
+
* @throws {RequiredError}
|
|
123
|
+
*/
|
|
124
|
+
getCustomer: (project_1, platformId_1, customerId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, customerId_1, ...args_1], void 0, function* (project, platformId, customerId, options = {}) {
|
|
125
|
+
// verify required parameter 'project' is not null or undefined
|
|
126
|
+
assertParamExists('getCustomer', 'project', project);
|
|
127
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
128
|
+
assertParamExists('getCustomer', 'platformId', platformId);
|
|
129
|
+
// verify required parameter 'customerId' is not null or undefined
|
|
130
|
+
assertParamExists('getCustomer', 'customerId', customerId);
|
|
131
|
+
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}`
|
|
132
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
133
|
+
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
134
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
135
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
136
|
+
let baseOptions;
|
|
137
|
+
if (configuration) {
|
|
138
|
+
baseOptions = configuration.baseOptions;
|
|
139
|
+
}
|
|
140
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
141
|
+
const localVarHeaderParameter = {};
|
|
142
|
+
const localVarQueryParameter = {};
|
|
143
|
+
// authentication session-oauth required
|
|
144
|
+
// oauth required
|
|
145
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
146
|
+
// authentication api-key required
|
|
147
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
148
|
+
if (project !== undefined) {
|
|
149
|
+
localVarQueryParameter['project'] = project;
|
|
150
|
+
}
|
|
151
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
152
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
153
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
154
|
+
return {
|
|
155
|
+
url: toPathString(localVarUrlObj),
|
|
156
|
+
options: localVarRequestOptions,
|
|
157
|
+
};
|
|
158
|
+
}),
|
|
159
|
+
/**
|
|
160
|
+
* List customers for a platform
|
|
161
|
+
* @summary List customers
|
|
162
|
+
* @param {string} project Project unique identifier
|
|
163
|
+
* @param {string} platformId The platform identifier
|
|
164
|
+
* @param {number} [pageToken] Page reference token
|
|
165
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
166
|
+
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
167
|
+
* @param {*} [options] Override http request option.
|
|
168
|
+
* @throws {RequiredError}
|
|
169
|
+
*/
|
|
170
|
+
listCustomers: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, options = {}) {
|
|
171
|
+
// verify required parameter 'project' is not null or undefined
|
|
172
|
+
assertParamExists('listCustomers', 'project', project);
|
|
173
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
174
|
+
assertParamExists('listCustomers', 'platformId', platformId);
|
|
175
|
+
const localVarPath = `/v1/platform/{platformId}/customers`
|
|
176
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
177
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
178
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
179
|
+
let baseOptions;
|
|
180
|
+
if (configuration) {
|
|
181
|
+
baseOptions = configuration.baseOptions;
|
|
182
|
+
}
|
|
183
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
184
|
+
const localVarHeaderParameter = {};
|
|
185
|
+
const localVarQueryParameter = {};
|
|
186
|
+
// authentication session-oauth required
|
|
187
|
+
// oauth required
|
|
188
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
189
|
+
// authentication api-key required
|
|
190
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
191
|
+
if (project !== undefined) {
|
|
192
|
+
localVarQueryParameter['project'] = project;
|
|
193
|
+
}
|
|
194
|
+
if (pageToken !== undefined) {
|
|
195
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
196
|
+
}
|
|
197
|
+
if (pageSize !== undefined) {
|
|
198
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
199
|
+
}
|
|
200
|
+
if (search !== undefined) {
|
|
201
|
+
localVarQueryParameter['search'] = search;
|
|
202
|
+
}
|
|
203
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
204
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
205
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
206
|
+
return {
|
|
207
|
+
url: toPathString(localVarUrlObj),
|
|
208
|
+
options: localVarRequestOptions,
|
|
209
|
+
};
|
|
210
|
+
}),
|
|
211
|
+
};
|
|
212
|
+
};
|
|
213
|
+
/**
|
|
214
|
+
* CustomersApi - functional programming interface
|
|
215
|
+
* @export
|
|
216
|
+
*/
|
|
217
|
+
export const CustomersApiFp = function (configuration) {
|
|
218
|
+
const localVarAxiosParamCreator = CustomersApiAxiosParamCreator(configuration);
|
|
219
|
+
return {
|
|
220
|
+
/**
|
|
221
|
+
* Export customers as a CSV file
|
|
222
|
+
* @summary Export customers
|
|
223
|
+
* @param {string} project Project unique identifier
|
|
224
|
+
* @param {string} platformId The platform identifier
|
|
225
|
+
* @param {*} [options] Override http request option.
|
|
226
|
+
* @throws {RequiredError}
|
|
227
|
+
*/
|
|
228
|
+
exportCustomers(project, platformId, options) {
|
|
229
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
230
|
+
var _a, _b, _c;
|
|
231
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomers(project, platformId, options);
|
|
232
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
233
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomersApi.exportCustomers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
234
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
235
|
+
});
|
|
236
|
+
},
|
|
237
|
+
/**
|
|
238
|
+
* Get a customer for a platform by a given customer ID.
|
|
239
|
+
* @summary Get customer
|
|
240
|
+
* @param {string} project Project unique identifier
|
|
241
|
+
* @param {string} platformId The platform identifier
|
|
242
|
+
* @param {string} customerId The customer identifier
|
|
243
|
+
* @param {*} [options] Override http request option.
|
|
244
|
+
* @throws {RequiredError}
|
|
245
|
+
*/
|
|
246
|
+
getCustomer(project, platformId, customerId, options) {
|
|
247
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
248
|
+
var _a, _b, _c;
|
|
249
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getCustomer(project, platformId, customerId, options);
|
|
250
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
251
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomersApi.getCustomer']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
252
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
253
|
+
});
|
|
254
|
+
},
|
|
255
|
+
/**
|
|
256
|
+
* List customers for a platform
|
|
257
|
+
* @summary List customers
|
|
258
|
+
* @param {string} project Project unique identifier
|
|
259
|
+
* @param {string} platformId The platform identifier
|
|
260
|
+
* @param {number} [pageToken] Page reference token
|
|
261
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
262
|
+
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
263
|
+
* @param {*} [options] Override http request option.
|
|
264
|
+
* @throws {RequiredError}
|
|
265
|
+
*/
|
|
266
|
+
listCustomers(project, platformId, pageToken, pageSize, search, options) {
|
|
267
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
268
|
+
var _a, _b, _c;
|
|
269
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, options);
|
|
270
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
271
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomersApi.listCustomers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
272
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
273
|
+
});
|
|
274
|
+
},
|
|
275
|
+
};
|
|
276
|
+
};
|
|
277
|
+
/**
|
|
278
|
+
* CustomersApi - factory interface
|
|
279
|
+
* @export
|
|
280
|
+
*/
|
|
281
|
+
export const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
282
|
+
const localVarFp = CustomersApiFp(configuration);
|
|
283
|
+
return {
|
|
284
|
+
/**
|
|
285
|
+
* Export customers as a CSV file
|
|
286
|
+
* @summary Export customers
|
|
287
|
+
* @param {CustomersApiExportCustomersRequest} requestParameters Request parameters.
|
|
288
|
+
* @param {*} [options] Override http request option.
|
|
289
|
+
* @throws {RequiredError}
|
|
290
|
+
*/
|
|
291
|
+
exportCustomers(requestParameters, options) {
|
|
292
|
+
return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(axios, basePath));
|
|
293
|
+
},
|
|
294
|
+
/**
|
|
295
|
+
* Get a customer for a platform by a given customer ID.
|
|
296
|
+
* @summary Get customer
|
|
297
|
+
* @param {CustomersApiGetCustomerRequest} requestParameters Request parameters.
|
|
298
|
+
* @param {*} [options] Override http request option.
|
|
299
|
+
* @throws {RequiredError}
|
|
300
|
+
*/
|
|
301
|
+
getCustomer(requestParameters, options) {
|
|
302
|
+
return localVarFp.getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
303
|
+
},
|
|
304
|
+
/**
|
|
305
|
+
* List customers for a platform
|
|
306
|
+
* @summary List customers
|
|
307
|
+
* @param {CustomersApiListCustomersRequest} requestParameters Request parameters.
|
|
308
|
+
* @param {*} [options] Override http request option.
|
|
309
|
+
* @throws {RequiredError}
|
|
310
|
+
*/
|
|
311
|
+
listCustomers(requestParameters, options) {
|
|
312
|
+
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
313
|
+
},
|
|
314
|
+
};
|
|
315
|
+
};
|
|
316
|
+
/**
|
|
317
|
+
* CustomersApi - object-oriented interface
|
|
318
|
+
* @export
|
|
319
|
+
* @class CustomersApi
|
|
320
|
+
* @extends {BaseAPI}
|
|
321
|
+
*/
|
|
322
|
+
export class CustomersApi extends BaseAPI {
|
|
323
|
+
/**
|
|
324
|
+
* Export customers as a CSV file
|
|
325
|
+
* @summary Export customers
|
|
326
|
+
* @param {CustomersApiExportCustomersRequest} requestParameters Request parameters.
|
|
327
|
+
* @param {*} [options] Override http request option.
|
|
328
|
+
* @throws {RequiredError}
|
|
329
|
+
* @memberof CustomersApi
|
|
330
|
+
*/
|
|
331
|
+
exportCustomers(requestParameters, options) {
|
|
332
|
+
return CustomersApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(this.axios, this.basePath));
|
|
333
|
+
}
|
|
334
|
+
/**
|
|
335
|
+
* Get a customer for a platform by a given customer ID.
|
|
336
|
+
* @summary Get customer
|
|
337
|
+
* @param {CustomersApiGetCustomerRequest} requestParameters Request parameters.
|
|
338
|
+
* @param {*} [options] Override http request option.
|
|
339
|
+
* @throws {RequiredError}
|
|
340
|
+
* @memberof CustomersApi
|
|
341
|
+
*/
|
|
342
|
+
getCustomer(requestParameters, options) {
|
|
343
|
+
return CustomersApiFp(this.configuration).getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
344
|
+
}
|
|
345
|
+
/**
|
|
346
|
+
* List customers for a platform
|
|
347
|
+
* @summary List customers
|
|
348
|
+
* @param {CustomersApiListCustomersRequest} requestParameters Request parameters.
|
|
349
|
+
* @param {*} [options] Override http request option.
|
|
350
|
+
* @throws {RequiredError}
|
|
351
|
+
* @memberof CustomersApi
|
|
352
|
+
*/
|
|
353
|
+
listCustomers(requestParameters, options) {
|
|
354
|
+
return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
355
|
+
}
|
|
356
|
+
}
|
|
69
357
|
/**
|
|
70
358
|
* OrdersApi - axios parameter creator
|
|
71
359
|
* @export
|
|
@@ -650,6 +938,46 @@ export class OrdersApi extends BaseAPI {
|
|
|
650
938
|
*/
|
|
651
939
|
export const PlatformApiAxiosParamCreator = function (configuration) {
|
|
652
940
|
return {
|
|
941
|
+
/**
|
|
942
|
+
* Export customers as a CSV file
|
|
943
|
+
* @summary Export customers
|
|
944
|
+
* @param {string} project Project unique identifier
|
|
945
|
+
* @param {string} platformId The platform identifier
|
|
946
|
+
* @param {*} [options] Override http request option.
|
|
947
|
+
* @throws {RequiredError}
|
|
948
|
+
*/
|
|
949
|
+
exportCustomers: (project_1, platformId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, ...args_1], void 0, function* (project, platformId, options = {}) {
|
|
950
|
+
// verify required parameter 'project' is not null or undefined
|
|
951
|
+
assertParamExists('exportCustomers', 'project', project);
|
|
952
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
953
|
+
assertParamExists('exportCustomers', 'platformId', platformId);
|
|
954
|
+
const localVarPath = `/v1/platform/{platformId}/customers/export`
|
|
955
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
956
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
957
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
958
|
+
let baseOptions;
|
|
959
|
+
if (configuration) {
|
|
960
|
+
baseOptions = configuration.baseOptions;
|
|
961
|
+
}
|
|
962
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
963
|
+
const localVarHeaderParameter = {};
|
|
964
|
+
const localVarQueryParameter = {};
|
|
965
|
+
// authentication session-oauth required
|
|
966
|
+
// oauth required
|
|
967
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
968
|
+
// authentication api-key required
|
|
969
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
970
|
+
if (project !== undefined) {
|
|
971
|
+
localVarQueryParameter['project'] = project;
|
|
972
|
+
}
|
|
973
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
974
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
975
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
976
|
+
return {
|
|
977
|
+
url: toPathString(localVarUrlObj),
|
|
978
|
+
options: localVarRequestOptions,
|
|
979
|
+
};
|
|
980
|
+
}),
|
|
653
981
|
/**
|
|
654
982
|
* Export orders as a CSV file
|
|
655
983
|
* @summary Export orders
|
|
@@ -708,6 +1036,50 @@ export const PlatformApiAxiosParamCreator = function (configuration) {
|
|
|
708
1036
|
options: localVarRequestOptions,
|
|
709
1037
|
};
|
|
710
1038
|
}),
|
|
1039
|
+
/**
|
|
1040
|
+
* Get a customer for a platform by a given customer ID.
|
|
1041
|
+
* @summary Get customer
|
|
1042
|
+
* @param {string} project Project unique identifier
|
|
1043
|
+
* @param {string} platformId The platform identifier
|
|
1044
|
+
* @param {string} customerId The customer identifier
|
|
1045
|
+
* @param {*} [options] Override http request option.
|
|
1046
|
+
* @throws {RequiredError}
|
|
1047
|
+
*/
|
|
1048
|
+
getCustomer: (project_1, platformId_1, customerId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, customerId_1, ...args_1], void 0, function* (project, platformId, customerId, options = {}) {
|
|
1049
|
+
// verify required parameter 'project' is not null or undefined
|
|
1050
|
+
assertParamExists('getCustomer', 'project', project);
|
|
1051
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1052
|
+
assertParamExists('getCustomer', 'platformId', platformId);
|
|
1053
|
+
// verify required parameter 'customerId' is not null or undefined
|
|
1054
|
+
assertParamExists('getCustomer', 'customerId', customerId);
|
|
1055
|
+
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}`
|
|
1056
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1057
|
+
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
1058
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1059
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1060
|
+
let baseOptions;
|
|
1061
|
+
if (configuration) {
|
|
1062
|
+
baseOptions = configuration.baseOptions;
|
|
1063
|
+
}
|
|
1064
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1065
|
+
const localVarHeaderParameter = {};
|
|
1066
|
+
const localVarQueryParameter = {};
|
|
1067
|
+
// authentication session-oauth required
|
|
1068
|
+
// oauth required
|
|
1069
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1070
|
+
// authentication api-key required
|
|
1071
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1072
|
+
if (project !== undefined) {
|
|
1073
|
+
localVarQueryParameter['project'] = project;
|
|
1074
|
+
}
|
|
1075
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1076
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1077
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1078
|
+
return {
|
|
1079
|
+
url: toPathString(localVarUrlObj),
|
|
1080
|
+
options: localVarRequestOptions,
|
|
1081
|
+
};
|
|
1082
|
+
}),
|
|
711
1083
|
/**
|
|
712
1084
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
713
1085
|
* @summary Get fulfillment
|
|
@@ -876,6 +1248,58 @@ export const PlatformApiAxiosParamCreator = function (configuration) {
|
|
|
876
1248
|
options: localVarRequestOptions,
|
|
877
1249
|
};
|
|
878
1250
|
}),
|
|
1251
|
+
/**
|
|
1252
|
+
* List customers for a platform
|
|
1253
|
+
* @summary List customers
|
|
1254
|
+
* @param {string} project Project unique identifier
|
|
1255
|
+
* @param {string} platformId The platform identifier
|
|
1256
|
+
* @param {number} [pageToken] Page reference token
|
|
1257
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1258
|
+
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1259
|
+
* @param {*} [options] Override http request option.
|
|
1260
|
+
* @throws {RequiredError}
|
|
1261
|
+
*/
|
|
1262
|
+
listCustomers: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, options = {}) {
|
|
1263
|
+
// verify required parameter 'project' is not null or undefined
|
|
1264
|
+
assertParamExists('listCustomers', 'project', project);
|
|
1265
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1266
|
+
assertParamExists('listCustomers', 'platformId', platformId);
|
|
1267
|
+
const localVarPath = `/v1/platform/{platformId}/customers`
|
|
1268
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
1269
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1270
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1271
|
+
let baseOptions;
|
|
1272
|
+
if (configuration) {
|
|
1273
|
+
baseOptions = configuration.baseOptions;
|
|
1274
|
+
}
|
|
1275
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
1276
|
+
const localVarHeaderParameter = {};
|
|
1277
|
+
const localVarQueryParameter = {};
|
|
1278
|
+
// authentication session-oauth required
|
|
1279
|
+
// oauth required
|
|
1280
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
1281
|
+
// authentication api-key required
|
|
1282
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
1283
|
+
if (project !== undefined) {
|
|
1284
|
+
localVarQueryParameter['project'] = project;
|
|
1285
|
+
}
|
|
1286
|
+
if (pageToken !== undefined) {
|
|
1287
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
1288
|
+
}
|
|
1289
|
+
if (pageSize !== undefined) {
|
|
1290
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1291
|
+
}
|
|
1292
|
+
if (search !== undefined) {
|
|
1293
|
+
localVarQueryParameter['search'] = search;
|
|
1294
|
+
}
|
|
1295
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1296
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1297
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
1298
|
+
return {
|
|
1299
|
+
url: toPathString(localVarUrlObj),
|
|
1300
|
+
options: localVarRequestOptions,
|
|
1301
|
+
};
|
|
1302
|
+
}),
|
|
879
1303
|
/**
|
|
880
1304
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
881
1305
|
* @summary List orders
|
|
@@ -1137,6 +1561,23 @@ export const PlatformApiAxiosParamCreator = function (configuration) {
|
|
|
1137
1561
|
export const PlatformApiFp = function (configuration) {
|
|
1138
1562
|
const localVarAxiosParamCreator = PlatformApiAxiosParamCreator(configuration);
|
|
1139
1563
|
return {
|
|
1564
|
+
/**
|
|
1565
|
+
* Export customers as a CSV file
|
|
1566
|
+
* @summary Export customers
|
|
1567
|
+
* @param {string} project Project unique identifier
|
|
1568
|
+
* @param {string} platformId The platform identifier
|
|
1569
|
+
* @param {*} [options] Override http request option.
|
|
1570
|
+
* @throws {RequiredError}
|
|
1571
|
+
*/
|
|
1572
|
+
exportCustomers(project, platformId, options) {
|
|
1573
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1574
|
+
var _a, _b, _c;
|
|
1575
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomers(project, platformId, options);
|
|
1576
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1577
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PlatformApi.exportCustomers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1578
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1579
|
+
});
|
|
1580
|
+
},
|
|
1140
1581
|
/**
|
|
1141
1582
|
* Export orders as a CSV file
|
|
1142
1583
|
* @summary Export orders
|
|
@@ -1157,6 +1598,24 @@ export const PlatformApiFp = function (configuration) {
|
|
|
1157
1598
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1158
1599
|
});
|
|
1159
1600
|
},
|
|
1601
|
+
/**
|
|
1602
|
+
* Get a customer for a platform by a given customer ID.
|
|
1603
|
+
* @summary Get customer
|
|
1604
|
+
* @param {string} project Project unique identifier
|
|
1605
|
+
* @param {string} platformId The platform identifier
|
|
1606
|
+
* @param {string} customerId The customer identifier
|
|
1607
|
+
* @param {*} [options] Override http request option.
|
|
1608
|
+
* @throws {RequiredError}
|
|
1609
|
+
*/
|
|
1610
|
+
getCustomer(project, platformId, customerId, options) {
|
|
1611
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1612
|
+
var _a, _b, _c;
|
|
1613
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getCustomer(project, platformId, customerId, options);
|
|
1614
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1615
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PlatformApi.getCustomer']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1616
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1617
|
+
});
|
|
1618
|
+
},
|
|
1160
1619
|
/**
|
|
1161
1620
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
1162
1621
|
* @summary Get fulfillment
|
|
@@ -1227,6 +1686,26 @@ export const PlatformApiFp = function (configuration) {
|
|
|
1227
1686
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1228
1687
|
});
|
|
1229
1688
|
},
|
|
1689
|
+
/**
|
|
1690
|
+
* List customers for a platform
|
|
1691
|
+
* @summary List customers
|
|
1692
|
+
* @param {string} project Project unique identifier
|
|
1693
|
+
* @param {string} platformId The platform identifier
|
|
1694
|
+
* @param {number} [pageToken] Page reference token
|
|
1695
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1696
|
+
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1697
|
+
* @param {*} [options] Override http request option.
|
|
1698
|
+
* @throws {RequiredError}
|
|
1699
|
+
*/
|
|
1700
|
+
listCustomers(project, platformId, pageToken, pageSize, search, options) {
|
|
1701
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1702
|
+
var _a, _b, _c;
|
|
1703
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, options);
|
|
1704
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1705
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PlatformApi.listCustomers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1706
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1707
|
+
});
|
|
1708
|
+
},
|
|
1230
1709
|
/**
|
|
1231
1710
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
1232
1711
|
* @summary List orders
|
|
@@ -1332,6 +1811,16 @@ export const PlatformApiFp = function (configuration) {
|
|
|
1332
1811
|
export const PlatformApiFactory = function (configuration, basePath, axios) {
|
|
1333
1812
|
const localVarFp = PlatformApiFp(configuration);
|
|
1334
1813
|
return {
|
|
1814
|
+
/**
|
|
1815
|
+
* Export customers as a CSV file
|
|
1816
|
+
* @summary Export customers
|
|
1817
|
+
* @param {PlatformApiExportCustomersRequest} requestParameters Request parameters.
|
|
1818
|
+
* @param {*} [options] Override http request option.
|
|
1819
|
+
* @throws {RequiredError}
|
|
1820
|
+
*/
|
|
1821
|
+
exportCustomers(requestParameters, options) {
|
|
1822
|
+
return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(axios, basePath));
|
|
1823
|
+
},
|
|
1335
1824
|
/**
|
|
1336
1825
|
* Export orders as a CSV file
|
|
1337
1826
|
* @summary Export orders
|
|
@@ -1342,6 +1831,16 @@ export const PlatformApiFactory = function (configuration, basePath, axios) {
|
|
|
1342
1831
|
exportOrders(requestParameters, options) {
|
|
1343
1832
|
return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
1344
1833
|
},
|
|
1834
|
+
/**
|
|
1835
|
+
* Get a customer for a platform by a given customer ID.
|
|
1836
|
+
* @summary Get customer
|
|
1837
|
+
* @param {PlatformApiGetCustomerRequest} requestParameters Request parameters.
|
|
1838
|
+
* @param {*} [options] Override http request option.
|
|
1839
|
+
* @throws {RequiredError}
|
|
1840
|
+
*/
|
|
1841
|
+
getCustomer(requestParameters, options) {
|
|
1842
|
+
return localVarFp.getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
1843
|
+
},
|
|
1345
1844
|
/**
|
|
1346
1845
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
1347
1846
|
* @summary Get fulfillment
|
|
@@ -1382,6 +1881,16 @@ export const PlatformApiFactory = function (configuration, basePath, axios) {
|
|
|
1382
1881
|
listAvailableFulfillers(requestParameters, options) {
|
|
1383
1882
|
return localVarFp.listAvailableFulfillers(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(axios, basePath));
|
|
1384
1883
|
},
|
|
1884
|
+
/**
|
|
1885
|
+
* List customers for a platform
|
|
1886
|
+
* @summary List customers
|
|
1887
|
+
* @param {PlatformApiListCustomersRequest} requestParameters Request parameters.
|
|
1888
|
+
* @param {*} [options] Override http request option.
|
|
1889
|
+
* @throws {RequiredError}
|
|
1890
|
+
*/
|
|
1891
|
+
listCustomers(requestParameters, options) {
|
|
1892
|
+
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
1893
|
+
},
|
|
1385
1894
|
/**
|
|
1386
1895
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
1387
1896
|
* @summary List orders
|
|
@@ -1441,6 +1950,17 @@ export const PlatformApiFactory = function (configuration, basePath, axios) {
|
|
|
1441
1950
|
* @extends {BaseAPI}
|
|
1442
1951
|
*/
|
|
1443
1952
|
export class PlatformApi extends BaseAPI {
|
|
1953
|
+
/**
|
|
1954
|
+
* Export customers as a CSV file
|
|
1955
|
+
* @summary Export customers
|
|
1956
|
+
* @param {PlatformApiExportCustomersRequest} requestParameters Request parameters.
|
|
1957
|
+
* @param {*} [options] Override http request option.
|
|
1958
|
+
* @throws {RequiredError}
|
|
1959
|
+
* @memberof PlatformApi
|
|
1960
|
+
*/
|
|
1961
|
+
exportCustomers(requestParameters, options) {
|
|
1962
|
+
return PlatformApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(this.axios, this.basePath));
|
|
1963
|
+
}
|
|
1444
1964
|
/**
|
|
1445
1965
|
* Export orders as a CSV file
|
|
1446
1966
|
* @summary Export orders
|
|
@@ -1452,6 +1972,17 @@ export class PlatformApi extends BaseAPI {
|
|
|
1452
1972
|
exportOrders(requestParameters, options) {
|
|
1453
1973
|
return PlatformApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
1454
1974
|
}
|
|
1975
|
+
/**
|
|
1976
|
+
* Get a customer for a platform by a given customer ID.
|
|
1977
|
+
* @summary Get customer
|
|
1978
|
+
* @param {PlatformApiGetCustomerRequest} requestParameters Request parameters.
|
|
1979
|
+
* @param {*} [options] Override http request option.
|
|
1980
|
+
* @throws {RequiredError}
|
|
1981
|
+
* @memberof PlatformApi
|
|
1982
|
+
*/
|
|
1983
|
+
getCustomer(requestParameters, options) {
|
|
1984
|
+
return PlatformApiFp(this.configuration).getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
1985
|
+
}
|
|
1455
1986
|
/**
|
|
1456
1987
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
1457
1988
|
* @summary Get fulfillment
|
|
@@ -1496,6 +2027,17 @@ export class PlatformApi extends BaseAPI {
|
|
|
1496
2027
|
listAvailableFulfillers(requestParameters, options) {
|
|
1497
2028
|
return PlatformApiFp(this.configuration).listAvailableFulfillers(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(this.axios, this.basePath));
|
|
1498
2029
|
}
|
|
2030
|
+
/**
|
|
2031
|
+
* List customers for a platform
|
|
2032
|
+
* @summary List customers
|
|
2033
|
+
* @param {PlatformApiListCustomersRequest} requestParameters Request parameters.
|
|
2034
|
+
* @param {*} [options] Override http request option.
|
|
2035
|
+
* @throws {RequiredError}
|
|
2036
|
+
* @memberof PlatformApi
|
|
2037
|
+
*/
|
|
2038
|
+
listCustomers(requestParameters, options) {
|
|
2039
|
+
return PlatformApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
2040
|
+
}
|
|
1499
2041
|
/**
|
|
1500
2042
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
1501
2043
|
* @summary List orders
|
package/dist/esm/base.d.ts
CHANGED
package/dist/esm/base.js
CHANGED
package/dist/esm/common.d.ts
CHANGED