@teemill/platform 0.24.0 → 0.26.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/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.24.0
7
+ * The version of the OpenAPI document: 0.26.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -68,7 +68,10 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
68
68
  * @summary Export customers
69
69
  * @param {string} project Project unique identifier
70
70
  * @param {string} platformId The platform identifier
71
+ * @param {Array<string>} [countries] Filter customers by country code
72
+ * @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
71
73
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
74
+ * @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
72
75
  * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
73
76
  * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
74
77
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
@@ -76,7 +79,7 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
76
79
  * @param {*} [options] Override http request option.
77
80
  * @throws {RequiredError}
78
81
  */
79
- exportCustomers: (project_1, platformId_1, totalOrderCount_1, lifetimeValue_1, sortBy_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, totalOrderCount_1, lifetimeValue_1, sortBy_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, totalOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options = {}) {
82
+ exportCustomers: (project_1, platformId_1, countries_1, gender_1, totalOrderCount_1, refundedOrderCount_1, lifetimeValue_1, sortBy_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, countries_1, gender_1, totalOrderCount_1, refundedOrderCount_1, lifetimeValue_1, sortBy_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, countries, gender, totalOrderCount, refundedOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options = {}) {
80
83
  // verify required parameter 'project' is not null or undefined
81
84
  assertParamExists('exportCustomers', 'project', project);
82
85
  // verify required parameter 'platformId' is not null or undefined
@@ -100,9 +103,18 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
100
103
  if (project !== undefined) {
101
104
  localVarQueryParameter['project'] = project;
102
105
  }
106
+ if (countries) {
107
+ localVarQueryParameter['countries'] = countries;
108
+ }
109
+ if (gender !== undefined) {
110
+ localVarQueryParameter['gender'] = gender;
111
+ }
103
112
  if (totalOrderCount !== undefined) {
104
113
  localVarQueryParameter['totalOrderCount'] = totalOrderCount;
105
114
  }
115
+ if (refundedOrderCount !== undefined) {
116
+ localVarQueryParameter['refundedOrderCount'] = refundedOrderCount;
117
+ }
106
118
  if (lifetimeValue !== undefined) {
107
119
  localVarQueryParameter['lifetimeValue'] = lifetimeValue;
108
120
  }
@@ -178,14 +190,17 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
178
190
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
179
191
  * @param {string} [search] Search term to filter results
180
192
  * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
193
+ * @param {Array<string>} [countries] Filter customers by country code
194
+ * @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
181
195
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
196
+ * @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
182
197
  * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
183
198
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
184
199
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
185
200
  * @param {*} [options] Override http request option.
186
201
  * @throws {RequiredError}
187
202
  */
188
- listCustomers: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, totalOrderCount_1, lifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, totalOrderCount_1, lifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options = {}) {
203
+ listCustomers: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, countries_1, gender_1, totalOrderCount_1, refundedOrderCount_1, lifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, countries_1, gender_1, totalOrderCount_1, refundedOrderCount_1, lifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, sortBy, countries, gender, totalOrderCount, refundedOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options = {}) {
189
204
  // verify required parameter 'project' is not null or undefined
190
205
  assertParamExists('listCustomers', 'project', project);
191
206
  // verify required parameter 'platformId' is not null or undefined
@@ -221,9 +236,18 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
221
236
  if (sortBy) {
222
237
  localVarQueryParameter['sortBy'] = sortBy;
223
238
  }
239
+ if (countries) {
240
+ localVarQueryParameter['countries'] = countries;
241
+ }
242
+ if (gender !== undefined) {
243
+ localVarQueryParameter['gender'] = gender;
244
+ }
224
245
  if (totalOrderCount !== undefined) {
225
246
  localVarQueryParameter['totalOrderCount'] = totalOrderCount;
226
247
  }
248
+ if (refundedOrderCount !== undefined) {
249
+ localVarQueryParameter['refundedOrderCount'] = refundedOrderCount;
250
+ }
227
251
  if (lifetimeValue !== undefined) {
228
252
  localVarQueryParameter['lifetimeValue'] = lifetimeValue;
229
253
  }
@@ -257,7 +281,10 @@ export const CustomersApiFp = function (configuration) {
257
281
  * @summary Export customers
258
282
  * @param {string} project Project unique identifier
259
283
  * @param {string} platformId The platform identifier
284
+ * @param {Array<string>} [countries] Filter customers by country code
285
+ * @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
260
286
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
287
+ * @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
261
288
  * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
262
289
  * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
263
290
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
@@ -265,10 +292,10 @@ export const CustomersApiFp = function (configuration) {
265
292
  * @param {*} [options] Override http request option.
266
293
  * @throws {RequiredError}
267
294
  */
268
- exportCustomers(project, platformId, totalOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options) {
295
+ exportCustomers(project, platformId, countries, gender, totalOrderCount, refundedOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options) {
269
296
  return __awaiter(this, void 0, void 0, function* () {
270
297
  var _a, _b, _c;
271
- const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomers(project, platformId, totalOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options);
298
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomers(project, platformId, countries, gender, totalOrderCount, refundedOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options);
272
299
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
273
300
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomersApi.exportCustomers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
274
301
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -301,17 +328,20 @@ export const CustomersApiFp = function (configuration) {
301
328
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
302
329
  * @param {string} [search] Search term to filter results
303
330
  * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
331
+ * @param {Array<string>} [countries] Filter customers by country code
332
+ * @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
304
333
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
334
+ * @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
305
335
  * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
306
336
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
307
337
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
308
338
  * @param {*} [options] Override http request option.
309
339
  * @throws {RequiredError}
310
340
  */
311
- listCustomers(project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options) {
341
+ listCustomers(project, platformId, pageToken, pageSize, search, sortBy, countries, gender, totalOrderCount, refundedOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options) {
312
342
  return __awaiter(this, void 0, void 0, function* () {
313
343
  var _a, _b, _c;
314
- const localVarAxiosArgs = yield localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
344
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, countries, gender, totalOrderCount, refundedOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
315
345
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
316
346
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomersApi.listCustomers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
317
347
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -334,7 +364,7 @@ export const CustomersApiFactory = function (configuration, basePath, axios) {
334
364
  * @throws {RequiredError}
335
365
  */
336
366
  exportCustomers(requestParameters, options) {
337
- return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
367
+ return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.countries, requestParameters.gender, requestParameters.totalOrderCount, requestParameters.refundedOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
338
368
  },
339
369
  /**
340
370
  * Get a customer for a platform by a given customer ID.
@@ -354,7 +384,7 @@ export const CustomersApiFactory = function (configuration, basePath, axios) {
354
384
  * @throws {RequiredError}
355
385
  */
356
386
  listCustomers(requestParameters, options) {
357
- return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
387
+ return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.gender, requestParameters.totalOrderCount, requestParameters.refundedOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
358
388
  },
359
389
  };
360
390
  };
@@ -374,7 +404,7 @@ export class CustomersApi extends BaseAPI {
374
404
  * @memberof CustomersApi
375
405
  */
376
406
  exportCustomers(requestParameters, options) {
377
- return CustomersApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
407
+ return CustomersApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.countries, requestParameters.gender, requestParameters.totalOrderCount, requestParameters.refundedOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
378
408
  }
379
409
  /**
380
410
  * Get a customer for a platform by a given customer ID.
@@ -396,9 +426,16 @@ export class CustomersApi extends BaseAPI {
396
426
  * @memberof CustomersApi
397
427
  */
398
428
  listCustomers(requestParameters, options) {
399
- return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
429
+ return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.gender, requestParameters.totalOrderCount, requestParameters.refundedOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
400
430
  }
401
431
  }
432
+ /**
433
+ * @export
434
+ */
435
+ export const ExportCustomersGenderEnum = {
436
+ Male: 'male',
437
+ Female: 'female'
438
+ };
402
439
  /**
403
440
  * @export
404
441
  */
@@ -407,6 +444,8 @@ export const ExportCustomersSortByEnum = {
407
444
  LifetimeValue2: '-lifetimeValue',
408
445
  TotalOrderCount: '+totalOrderCount',
409
446
  TotalOrderCount2: '-totalOrderCount',
447
+ RefundedOrderCount: '+refundedOrderCount',
448
+ RefundedOrderCount2: '-refundedOrderCount',
410
449
  LastPurchased: '+lastPurchased',
411
450
  LastPurchased2: '-lastPurchased'
412
451
  };
@@ -418,9 +457,18 @@ export const ListCustomersSortByEnum = {
418
457
  LifetimeValue2: '-lifetimeValue',
419
458
  TotalOrderCount: '+totalOrderCount',
420
459
  TotalOrderCount2: '-totalOrderCount',
460
+ RefundedOrderCount: '+refundedOrderCount',
461
+ RefundedOrderCount2: '-refundedOrderCount',
421
462
  LastPurchased: '+lastPurchased',
422
463
  LastPurchased2: '-lastPurchased'
423
464
  };
465
+ /**
466
+ * @export
467
+ */
468
+ export const ListCustomersGenderEnum = {
469
+ Male: 'male',
470
+ Female: 'female'
471
+ };
424
472
  /**
425
473
  * EnquiriesApi - axios parameter creator
426
474
  * @export
@@ -623,6 +671,55 @@ export const EnquiriesApiAxiosParamCreator = function (configuration) {
623
671
  options: localVarRequestOptions,
624
672
  };
625
673
  }),
674
+ /**
675
+ * Update a customer enquiry
676
+ * @summary Update customer enquiry
677
+ * @param {string} project Project unique identifier
678
+ * @param {string} platformId The platform identifier
679
+ * @param {string} enquiryId The enquiry identifier
680
+ * @param {UpdateCustomerEnquiryRequest} updateCustomerEnquiryRequest Enquiry update
681
+ * @param {*} [options] Override http request option.
682
+ * @throws {RequiredError}
683
+ */
684
+ updateCustomerEnquiry: (project_1, platformId_1, enquiryId_1, updateCustomerEnquiryRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, enquiryId_1, updateCustomerEnquiryRequest_1, ...args_1], void 0, function* (project, platformId, enquiryId, updateCustomerEnquiryRequest, options = {}) {
685
+ // verify required parameter 'project' is not null or undefined
686
+ assertParamExists('updateCustomerEnquiry', 'project', project);
687
+ // verify required parameter 'platformId' is not null or undefined
688
+ assertParamExists('updateCustomerEnquiry', 'platformId', platformId);
689
+ // verify required parameter 'enquiryId' is not null or undefined
690
+ assertParamExists('updateCustomerEnquiry', 'enquiryId', enquiryId);
691
+ // verify required parameter 'updateCustomerEnquiryRequest' is not null or undefined
692
+ assertParamExists('updateCustomerEnquiry', 'updateCustomerEnquiryRequest', updateCustomerEnquiryRequest);
693
+ const localVarPath = `/v1/platform/{platformId}/customers/enquiries/{enquiryId}`
694
+ .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
695
+ .replace(`{${"enquiryId"}}`, encodeURIComponent(String(enquiryId)));
696
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
697
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
698
+ let baseOptions;
699
+ if (configuration) {
700
+ baseOptions = configuration.baseOptions;
701
+ }
702
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
703
+ const localVarHeaderParameter = {};
704
+ const localVarQueryParameter = {};
705
+ // authentication session-oauth required
706
+ // oauth required
707
+ yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
708
+ // authentication api-key required
709
+ yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
710
+ if (project !== undefined) {
711
+ localVarQueryParameter['project'] = project;
712
+ }
713
+ localVarHeaderParameter['Content-Type'] = 'application/json';
714
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
715
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
716
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
717
+ localVarRequestOptions.data = serializeDataIfNeeded(updateCustomerEnquiryRequest, localVarRequestOptions, configuration);
718
+ return {
719
+ url: toPathString(localVarUrlObj),
720
+ options: localVarRequestOptions,
721
+ };
722
+ }),
626
723
  };
627
724
  };
628
725
  /**
@@ -708,6 +805,25 @@ export const EnquiriesApiFp = function (configuration) {
708
805
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
709
806
  });
710
807
  },
808
+ /**
809
+ * Update a customer enquiry
810
+ * @summary Update customer enquiry
811
+ * @param {string} project Project unique identifier
812
+ * @param {string} platformId The platform identifier
813
+ * @param {string} enquiryId The enquiry identifier
814
+ * @param {UpdateCustomerEnquiryRequest} updateCustomerEnquiryRequest Enquiry update
815
+ * @param {*} [options] Override http request option.
816
+ * @throws {RequiredError}
817
+ */
818
+ updateCustomerEnquiry(project, platformId, enquiryId, updateCustomerEnquiryRequest, options) {
819
+ return __awaiter(this, void 0, void 0, function* () {
820
+ var _a, _b, _c;
821
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.updateCustomerEnquiry(project, platformId, enquiryId, updateCustomerEnquiryRequest, options);
822
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
823
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EnquiriesApi.updateCustomerEnquiry']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
824
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
825
+ });
826
+ },
711
827
  };
712
828
  };
713
829
  /**
@@ -757,6 +873,16 @@ export const EnquiriesApiFactory = function (configuration, basePath, axios) {
757
873
  listCustomerEnquiryLogs(requestParameters, options) {
758
874
  return localVarFp.listCustomerEnquiryLogs(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(axios, basePath));
759
875
  },
876
+ /**
877
+ * Update a customer enquiry
878
+ * @summary Update customer enquiry
879
+ * @param {EnquiriesApiUpdateCustomerEnquiryRequest} requestParameters Request parameters.
880
+ * @param {*} [options] Override http request option.
881
+ * @throws {RequiredError}
882
+ */
883
+ updateCustomerEnquiry(requestParameters, options) {
884
+ return localVarFp.updateCustomerEnquiry(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, requestParameters.updateCustomerEnquiryRequest, options).then((request) => request(axios, basePath));
885
+ },
760
886
  };
761
887
  };
762
888
  /**
@@ -810,6 +936,17 @@ export class EnquiriesApi extends BaseAPI {
810
936
  listCustomerEnquiryLogs(requestParameters, options) {
811
937
  return EnquiriesApiFp(this.configuration).listCustomerEnquiryLogs(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(this.axios, this.basePath));
812
938
  }
939
+ /**
940
+ * Update a customer enquiry
941
+ * @summary Update customer enquiry
942
+ * @param {EnquiriesApiUpdateCustomerEnquiryRequest} requestParameters Request parameters.
943
+ * @param {*} [options] Override http request option.
944
+ * @throws {RequiredError}
945
+ * @memberof EnquiriesApi
946
+ */
947
+ updateCustomerEnquiry(requestParameters, options) {
948
+ return EnquiriesApiFp(this.configuration).updateCustomerEnquiry(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, requestParameters.updateCustomerEnquiryRequest, options).then((request) => request(this.axios, this.basePath));
949
+ }
813
950
  }
814
951
  /**
815
952
  * OrdersApi - axios parameter creator
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.24.0
5
+ * The version of the OpenAPI document: 0.26.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.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.24.0
7
+ * The version of the OpenAPI document: 0.26.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.24.0
5
+ * The version of the OpenAPI document: 0.26.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.24.0
7
+ * The version of the OpenAPI document: 0.26.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.24.0
5
+ * The version of the OpenAPI document: 0.26.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.24.0
7
+ * The version of the OpenAPI document: 0.26.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.24.0
5
+ * The version of the OpenAPI document: 0.26.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/index.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.24.0
7
+ * The version of the OpenAPI document: 0.26.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.24.0
5
+ * The version of the OpenAPI document: 0.26.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Platform API
6
6
  * Manage Your podOS platform
7
7
  *
8
- * The version of the OpenAPI document: 0.24.0
8
+ * The version of the OpenAPI document: 0.26.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -26,16 +26,22 @@ const apiInstance = new CustomersApi(configuration);
26
26
 
27
27
  let project: string; //Project unique identifier (default to undefined)
28
28
  let platformId: string; //The platform identifier (default to undefined)
29
+ let countries: Array<string>; //Filter customers by country code (optional) (default to undefined)
30
+ let gender: 'male' | 'female'; //Filter customers by gender equal to the value provided (optional) (default to undefined)
29
31
  let totalOrderCount: number; //Filter customers by total order count equal to the value provided (optional) (default to undefined)
32
+ let refundedOrderCount: number; //Filter customers by refunded order count equal to the value provided (optional) (default to undefined)
30
33
  let lifetimeValue: number; //Filter customers by lifetime value less than or equal to the value provided (optional) (default to undefined)
31
- let sortBy: Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>; //An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending. (optional) (default to undefined)
34
+ let sortBy: Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased'>; //An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending. (optional) (default to undefined)
32
35
  let lastPurchasedStart: string; //Start of date range to filter customers by last purchase date (optional) (default to undefined)
33
36
  let lastPurchasedEnd: string; //End of date range to filter customers by last purchase date (optional) (default to undefined)
34
37
 
35
38
  const { status, data } = await apiInstance.exportCustomers(
36
39
  project,
37
40
  platformId,
41
+ countries,
42
+ gender,
38
43
  totalOrderCount,
44
+ refundedOrderCount,
39
45
  lifetimeValue,
40
46
  sortBy,
41
47
  lastPurchasedStart,
@@ -49,9 +55,12 @@ const { status, data } = await apiInstance.exportCustomers(
49
55
  |------------- | ------------- | ------------- | -------------|
50
56
  | **project** | [**string**] | Project unique identifier | defaults to undefined|
51
57
  | **platformId** | [**string**] | The platform identifier | defaults to undefined|
58
+ | **countries** | **Array&lt;string&gt;** | Filter customers by country code | (optional) defaults to undefined|
59
+ | **gender** | [**&#39;male&#39; | &#39;female&#39;**]**Array<&#39;male&#39; &#124; &#39;female&#39;>** | Filter customers by gender equal to the value provided | (optional) defaults to undefined|
52
60
  | **totalOrderCount** | [**number**] | Filter customers by total order count equal to the value provided | (optional) defaults to undefined|
61
+ | **refundedOrderCount** | [**number**] | Filter customers by refunded order count equal to the value provided | (optional) defaults to undefined|
53
62
  | **lifetimeValue** | [**number**] | Filter customers by lifetime value less than or equal to the value provided | (optional) defaults to undefined|
54
- | **sortBy** | **Array<&#39;+lifetimeValue&#39; &#124; &#39;-lifetimeValue&#39; &#124; &#39;+totalOrderCount&#39; &#124; &#39;-totalOrderCount&#39; &#124; &#39;+lastPurchased&#39; &#124; &#39;-lastPurchased&#39;>** | An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending. | (optional) defaults to undefined|
63
+ | **sortBy** | **Array<&#39;+lifetimeValue&#39; &#124; &#39;-lifetimeValue&#39; &#124; &#39;+totalOrderCount&#39; &#124; &#39;-totalOrderCount&#39; &#124; &#39;+refundedOrderCount&#39; &#124; &#39;-refundedOrderCount&#39; &#124; &#39;+lastPurchased&#39; &#124; &#39;-lastPurchased&#39;>** | An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending. | (optional) defaults to undefined|
55
64
  | **lastPurchasedStart** | [**string**] | Start of date range to filter customers by last purchase date | (optional) defaults to undefined|
56
65
  | **lastPurchasedEnd** | [**string**] | End of date range to filter customers by last purchase date | (optional) defaults to undefined|
57
66
 
@@ -165,8 +174,11 @@ let platformId: string; //The platform identifier (default to undefined)
165
174
  let pageToken: number; //Page reference token (optional) (default to 1)
166
175
  let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
167
176
  let search: string; //Search term to filter results (optional) (default to undefined)
168
- let sortBy: Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>; //An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending. (optional) (default to undefined)
177
+ let sortBy: Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased'>; //An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending. (optional) (default to undefined)
178
+ let countries: Array<string>; //Filter customers by country code (optional) (default to undefined)
179
+ let gender: 'male' | 'female'; //Filter customers by gender equal to the value provided (optional) (default to undefined)
169
180
  let totalOrderCount: number; //Filter customers by total order count equal to the value provided (optional) (default to undefined)
181
+ let refundedOrderCount: number; //Filter customers by refunded order count equal to the value provided (optional) (default to undefined)
170
182
  let lifetimeValue: number; //Filter customers by lifetime value less than or equal to the value provided (optional) (default to undefined)
171
183
  let lastPurchasedStart: string; //Start of date range to filter customers by last purchase date (optional) (default to undefined)
172
184
  let lastPurchasedEnd: string; //End of date range to filter customers by last purchase date (optional) (default to undefined)
@@ -178,7 +190,10 @@ const { status, data } = await apiInstance.listCustomers(
178
190
  pageSize,
179
191
  search,
180
192
  sortBy,
193
+ countries,
194
+ gender,
181
195
  totalOrderCount,
196
+ refundedOrderCount,
182
197
  lifetimeValue,
183
198
  lastPurchasedStart,
184
199
  lastPurchasedEnd
@@ -194,8 +209,11 @@ const { status, data } = await apiInstance.listCustomers(
194
209
  | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
195
210
  | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
196
211
  | **search** | [**string**] | Search term to filter results | (optional) defaults to undefined|
197
- | **sortBy** | **Array<&#39;+lifetimeValue&#39; &#124; &#39;-lifetimeValue&#39; &#124; &#39;+totalOrderCount&#39; &#124; &#39;-totalOrderCount&#39; &#124; &#39;+lastPurchased&#39; &#124; &#39;-lastPurchased&#39;>** | An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending. | (optional) defaults to undefined|
212
+ | **sortBy** | **Array<&#39;+lifetimeValue&#39; &#124; &#39;-lifetimeValue&#39; &#124; &#39;+totalOrderCount&#39; &#124; &#39;-totalOrderCount&#39; &#124; &#39;+refundedOrderCount&#39; &#124; &#39;-refundedOrderCount&#39; &#124; &#39;+lastPurchased&#39; &#124; &#39;-lastPurchased&#39;>** | An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending. | (optional) defaults to undefined|
213
+ | **countries** | **Array&lt;string&gt;** | Filter customers by country code | (optional) defaults to undefined|
214
+ | **gender** | [**&#39;male&#39; | &#39;female&#39;**]**Array<&#39;male&#39; &#124; &#39;female&#39;>** | Filter customers by gender equal to the value provided | (optional) defaults to undefined|
198
215
  | **totalOrderCount** | [**number**] | Filter customers by total order count equal to the value provided | (optional) defaults to undefined|
216
+ | **refundedOrderCount** | [**number**] | Filter customers by refunded order count equal to the value provided | (optional) defaults to undefined|
199
217
  | **lifetimeValue** | [**number**] | Filter customers by lifetime value less than or equal to the value provided | (optional) defaults to undefined|
200
218
  | **lastPurchasedStart** | [**string**] | Start of date range to filter customers by last purchase date | (optional) defaults to undefined|
201
219
  | **lastPurchasedEnd** | [**string**] | End of date range to filter customers by last purchase date | (optional) defaults to undefined|
@@ -8,6 +8,7 @@ All URIs are relative to *https://localhost:8080*
8
8
  |[**getCustomerEnquiry**](#getcustomerenquiry) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId} | Get customer enquiry|
9
9
  |[**listCustomerEnquiries**](#listcustomerenquiries) | **GET** /v1/platform/{platformId}/customers/enquiries | List customer enquiries|
10
10
  |[**listCustomerEnquiryLogs**](#listcustomerenquirylogs) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/logs | List customer enquiry Logs|
11
+ |[**updateCustomerEnquiry**](#updatecustomerenquiry) | **PATCH** /v1/platform/{platformId}/customers/enquiries/{enquiryId} | Update customer enquiry|
11
12
 
12
13
  # **createChatChannel**
13
14
  > CreateChatChannel200Response createChatChannel()
@@ -265,3 +266,69 @@ const { status, data } = await apiInstance.listCustomerEnquiryLogs(
265
266
 
266
267
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
267
268
 
269
+ # **updateCustomerEnquiry**
270
+ > Enquiry updateCustomerEnquiry(updateCustomerEnquiryRequest)
271
+
272
+ Update a customer enquiry
273
+
274
+ ### Example
275
+
276
+ ```typescript
277
+ import {
278
+ EnquiriesApi,
279
+ Configuration,
280
+ UpdateCustomerEnquiryRequest
281
+ } from '@teemill/platform';
282
+
283
+ const configuration = new Configuration();
284
+ const apiInstance = new EnquiriesApi(configuration);
285
+
286
+ let project: string; //Project unique identifier (default to undefined)
287
+ let platformId: string; //The platform identifier (default to undefined)
288
+ let enquiryId: string; //The enquiry identifier (default to undefined)
289
+ let updateCustomerEnquiryRequest: UpdateCustomerEnquiryRequest; //Enquiry update
290
+
291
+ const { status, data } = await apiInstance.updateCustomerEnquiry(
292
+ project,
293
+ platformId,
294
+ enquiryId,
295
+ updateCustomerEnquiryRequest
296
+ );
297
+ ```
298
+
299
+ ### Parameters
300
+
301
+ |Name | Type | Description | Notes|
302
+ |------------- | ------------- | ------------- | -------------|
303
+ | **updateCustomerEnquiryRequest** | **UpdateCustomerEnquiryRequest**| Enquiry update | |
304
+ | **project** | [**string**] | Project unique identifier | defaults to undefined|
305
+ | **platformId** | [**string**] | The platform identifier | defaults to undefined|
306
+ | **enquiryId** | [**string**] | The enquiry identifier | defaults to undefined|
307
+
308
+
309
+ ### Return type
310
+
311
+ **Enquiry**
312
+
313
+ ### Authorization
314
+
315
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
316
+
317
+ ### HTTP request headers
318
+
319
+ - **Content-Type**: application/json
320
+ - **Accept**: application/json
321
+
322
+
323
+ ### HTTP response details
324
+ | Status code | Description | Response headers |
325
+ |-------------|-------------|------------------|
326
+ |**200** | Enquiry updated successfully | - |
327
+ |**400** | Failed validation | - |
328
+ |**401** | Not authorised to access this resource | - |
329
+ |**403** | Refuse to authorize | - |
330
+ |**404** | Resource not found | - |
331
+ |**500** | Unknown server error | - |
332
+
333
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
334
+
package/docs/Enquiry.md CHANGED
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
18
18
  **read** | **boolean** | | [default to undefined]
19
19
  **extraInputs** | [**Array&lt;EnquiryExtraInputsInner&gt;**](EnquiryExtraInputsInner.md) | | [default to undefined]
20
20
  **chatChannelRef** | **string** | Reference to the chat channel resource | [optional] [default to undefined]
21
+ **owner** | **string** | The unique id of the user who owns the enquiry | [default to undefined]
21
22
 
22
23
  ## Example
23
24
 
@@ -38,6 +39,7 @@ const instance: Enquiry = {
38
39
  read,
39
40
  extraInputs,
40
41
  chatChannelRef,
42
+ owner,
41
43
  };
42
44
  ```
43
45
 
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **lifetimeValue** | **number** | | [default to undefined]
9
9
  **totalOrderCount** | **number** | | [default to undefined]
10
+ **refundedOrderCount** | **number** | | [default to undefined]
10
11
  **lastPurchased** | **string** | | [default to undefined]
11
12
 
12
13
  ## Example
@@ -17,6 +18,7 @@ import { Statistics } from '@teemill/platform';
17
18
  const instance: Statistics = {
18
19
  lifetimeValue,
19
20
  totalOrderCount,
21
+ refundedOrderCount,
20
22
  lastPurchased,
21
23
  };
22
24
  ```
@@ -0,0 +1,20 @@
1
+ # UpdateCustomerEnquiryRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **owner** | **string** | The unique id of the user who owns the enquiry | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { UpdateCustomerEnquiryRequest } from '@teemill/platform';
14
+
15
+ const instance: UpdateCustomerEnquiryRequest = {
16
+ owner,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)