@teemill/platform 0.24.0 → 0.27.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.
@@ -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<EnquiryExtraInputsInner>**](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
 
package/docs/OrdersApi.md CHANGED
@@ -354,6 +354,8 @@ let search: string; //Search term to filter based on order reference, customer n
354
354
  let start: string; //Start of date range to filter when orders were placed (optional) (default to undefined)
355
355
  let end: string; //End of date range to filter when orders were placed (optional) (default to undefined)
356
356
  let dateFilterType: 'createdAt' | 'updatedAt' | 'statusChangedAt'; //Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. (optional) (default to 'createdAt')
357
+ let maxOrderTotal: number; //The maximum value of the order (optional) (default to undefined)
358
+ let minOrderTotal: number; //The minimum value of the order (optional) (default to undefined)
357
359
 
358
360
  const { status, data } = await apiInstance.listOrders(
359
361
  project,
@@ -363,7 +365,9 @@ const { status, data } = await apiInstance.listOrders(
363
365
  search,
364
366
  start,
365
367
  end,
366
- dateFilterType
368
+ dateFilterType,
369
+ maxOrderTotal,
370
+ minOrderTotal
367
371
  );
368
372
  ```
369
373
 
@@ -379,6 +383,8 @@ const { status, data } = await apiInstance.listOrders(
379
383
  | **start** | [**string**] | Start of date range to filter when orders were placed | (optional) defaults to undefined|
380
384
  | **end** | [**string**] | End of date range to filter when orders were placed | (optional) defaults to undefined|
381
385
  | **dateFilterType** | [**&#39;createdAt&#39; | &#39;updatedAt&#39; | &#39;statusChangedAt&#39;**]**Array<&#39;createdAt&#39; &#124; &#39;updatedAt&#39; &#124; &#39;statusChangedAt&#39;>** | Specifies the type of date range filter to apply. Determines which date field the &#x60;start&#x60; and &#x60;end&#x60; fields should query. | (optional) defaults to 'createdAt'|
386
+ | **maxOrderTotal** | [**number**] | The maximum value of the order | (optional) defaults to undefined|
387
+ | **minOrderTotal** | [**number**] | The minimum value of the order | (optional) defaults to undefined|
382
388
 
383
389
 
384
390
  ### Return type
@@ -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)
package/index.ts 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.27.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@teemill/platform",
3
- "version": "0.24.0",
3
+ "version": "0.27.0",
4
4
  "description": "OpenAPI client for @teemill/platform",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {