@teemill/product-catalog 1.86.0 → 1.87.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.
@@ -2,7 +2,7 @@
2
2
  * Product Catalog API
3
3
  * Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.86.0
5
+ * The version of the OpenAPI document: 1.87.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
  * Product Catalog API
5
5
  * Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
6
6
  *
7
- * The version of the OpenAPI document: 1.86.0
7
+ * The version of the OpenAPI document: 1.87.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
  * Product Catalog API
3
3
  * Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.86.0
5
+ * The version of the OpenAPI document: 1.87.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -3,7 +3,7 @@
3
3
  * Product Catalog API
4
4
  * Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
5
5
  *
6
- * The version of the OpenAPI document: 1.86.0
6
+ * The version of the OpenAPI document: 1.87.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Product Catalog API
3
3
  * Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.86.0
5
+ * The version of the OpenAPI document: 1.87.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
  * Product Catalog API
5
5
  * Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
6
6
  *
7
- * The version of the OpenAPI document: 1.86.0
7
+ * The version of the OpenAPI document: 1.87.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
  * Product Catalog API
3
3
  * Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
4
4
  *
5
- * The version of the OpenAPI document: 1.86.0
5
+ * The version of the OpenAPI document: 1.87.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
  * Product Catalog API
6
6
  * Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
7
7
  *
8
- * The version of the OpenAPI document: 1.86.0
8
+ * The version of the OpenAPI document: 1.87.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -26,7 +26,7 @@ const apiInstance = new ProductAnalyticsApi(configuration);
26
26
 
27
27
  let project: string; //What project it is (default to undefined)
28
28
  let sortBy: Array<string>; //An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending. (optional) (default to undefined)
29
- let search: string; //Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas. (optional) (default to 'enabled:true')
29
+ let search: string; //Search query string to filter results. Supports field-specific filters like: \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'productType:<id>\', \'Multiple filters can be combined with spaces and commas.\' (optional) (default to undefined)
30
30
  let dateRangeStartDate: string; //Start date for the date range filter (ISO 8601 format) (optional) (default to undefined)
31
31
  let dateRangeEndDate: string; //End date for the date range filter (ISO 8601 format) (optional) (default to undefined)
32
32
  let minimumRevenue: number; //Filter to only include products with total revenue greater than or equal to this amount (optional) (default to undefined)
@@ -37,6 +37,10 @@ let minimumBasketPercent: number; //Filter to only include products where the av
37
37
  let maximumBasketPercent: number; //Filter to only include products where the average basket percentage is less than or equal to this value (optional) (default to undefined)
38
38
  let minimumTraffic: number; //Filter to only include products with total traffic greater than or equal to this number (optional) (default to undefined)
39
39
  let maximumTraffic: number; //Filter to only include products with total traffic less than or equal to this number (optional) (default to undefined)
40
+ let createdBefore: string; //Filter to only include products created before the given date (optional) (default to undefined)
41
+ let createdAfter: string; //Filter to only include products created after the given date (optional) (default to undefined)
42
+ let updatedBefore: string; //Filter to only include products updated before the given date (optional) (default to undefined)
43
+ let updatedAfter: string; //Filter to only include products updated after the given date (optional) (default to undefined)
40
44
 
41
45
  const { status, data } = await apiInstance.exportProductAnalytics(
42
46
  project,
@@ -51,7 +55,11 @@ const { status, data } = await apiInstance.exportProductAnalytics(
51
55
  minimumBasketPercent,
52
56
  maximumBasketPercent,
53
57
  minimumTraffic,
54
- maximumTraffic
58
+ maximumTraffic,
59
+ createdBefore,
60
+ createdAfter,
61
+ updatedBefore,
62
+ updatedAfter
55
63
  );
56
64
  ```
57
65
 
@@ -61,7 +69,7 @@ const { status, data } = await apiInstance.exportProductAnalytics(
61
69
  |------------- | ------------- | ------------- | -------------|
62
70
  | **project** | [**string**] | What project it is | defaults to undefined|
63
71
  | **sortBy** | **Array&lt;string&gt;** | 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|
64
- | **search** | [**string**] | Search query string to filter results. Supports field-specific filters like: \&#39;enabled:true\&#39;, \&#39;gfn_product_ids:&lt;id&gt;\&#39;, \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;includeArchived:false\&#39;, \&#39;hasSearchPhrase:false\&#39;, \&#39;inDataFeeds:true\&#39;, \&#39;aiOptimised:true\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;genderGroup:\&quot;male,female,unisex\&quot;\&#39;, \&#39;hasBarcode:true\&#39;, \&#39;onSale:true\&#39;, \&#39;type:product,template,bundle\&#39;, \&#39;collection:&lt;id&gt;\&#39;. Multiple filters can be combined with spaces and commas. | (optional) defaults to 'enabled:true'|
72
+ | **search** | [**string**] | Search query string to filter results. Supports field-specific filters like: \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;Multiple filters can be combined with spaces and commas.\&#39; | (optional) defaults to undefined|
65
73
  | **dateRangeStartDate** | [**string**] | Start date for the date range filter (ISO 8601 format) | (optional) defaults to undefined|
66
74
  | **dateRangeEndDate** | [**string**] | End date for the date range filter (ISO 8601 format) | (optional) defaults to undefined|
67
75
  | **minimumRevenue** | [**number**] | Filter to only include products with total revenue greater than or equal to this amount | (optional) defaults to undefined|
@@ -72,6 +80,10 @@ const { status, data } = await apiInstance.exportProductAnalytics(
72
80
  | **maximumBasketPercent** | [**number**] | Filter to only include products where the average basket percentage is less than or equal to this value | (optional) defaults to undefined|
73
81
  | **minimumTraffic** | [**number**] | Filter to only include products with total traffic greater than or equal to this number | (optional) defaults to undefined|
74
82
  | **maximumTraffic** | [**number**] | Filter to only include products with total traffic less than or equal to this number | (optional) defaults to undefined|
83
+ | **createdBefore** | [**string**] | Filter to only include products created before the given date | (optional) defaults to undefined|
84
+ | **createdAfter** | [**string**] | Filter to only include products created after the given date | (optional) defaults to undefined|
85
+ | **updatedBefore** | [**string**] | Filter to only include products updated before the given date | (optional) defaults to undefined|
86
+ | **updatedAfter** | [**string**] | Filter to only include products updated after the given date | (optional) defaults to undefined|
75
87
 
76
88
 
77
89
  ### Return type
@@ -172,7 +184,7 @@ const apiInstance = new ProductAnalyticsApi(configuration);
172
184
  let project: string; //What project it is (default to undefined)
173
185
  let pageToken: number; //Page reference token (optional) (default to 1)
174
186
  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)
175
- let search: string; //Search query string to filter results. Supports field-specific filters like: \'enabled:true\', \'gfn_product_ids:<id>\', \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'includeArchived:false\', \'hasSearchPhrase:false\', \'inDataFeeds:true\', \'aiOptimised:true\', \'productType:<id>\', \'genderGroup:\"male,female,unisex\"\', \'hasBarcode:true\', \'onSale:true\', \'type:product,template,bundle\', \'collection:<id>\'. Multiple filters can be combined with spaces and commas. (optional) (default to 'enabled:true')
187
+ let search: string; //Search query string to filter results. Supports field-specific filters like: \'tag:\"tag name\"\', \'internal_tag:\"internal tag name\"\', \'productType:<id>\', \'Multiple filters can be combined with spaces and commas.\' (optional) (default to undefined)
176
188
  let sortBy: Array<string>; //An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending. (optional) (default to undefined)
177
189
  let dateRangeStartDate: string; //Start date for the date range filter (ISO 8601 format) (optional) (default to undefined)
178
190
  let dateRangeEndDate: string; //End date for the date range filter (ISO 8601 format) (optional) (default to undefined)
@@ -184,6 +196,10 @@ let minimumBasketPercent: number; //Filter to only include products where the av
184
196
  let maximumBasketPercent: number; //Filter to only include products where the average basket percentage is less than or equal to this value (optional) (default to undefined)
185
197
  let minimumTraffic: number; //Filter to only include products with total traffic greater than or equal to this number (optional) (default to undefined)
186
198
  let maximumTraffic: number; //Filter to only include products with total traffic less than or equal to this number (optional) (default to undefined)
199
+ let createdBefore: string; //Filter to only include products created before the given date (optional) (default to undefined)
200
+ let createdAfter: string; //Filter to only include products created after the given date (optional) (default to undefined)
201
+ let updatedBefore: string; //Filter to only include products updated before the given date (optional) (default to undefined)
202
+ let updatedAfter: string; //Filter to only include products updated after the given date (optional) (default to undefined)
187
203
 
188
204
  const { status, data } = await apiInstance.listProductAnalytics(
189
205
  project,
@@ -200,7 +216,11 @@ const { status, data } = await apiInstance.listProductAnalytics(
200
216
  minimumBasketPercent,
201
217
  maximumBasketPercent,
202
218
  minimumTraffic,
203
- maximumTraffic
219
+ maximumTraffic,
220
+ createdBefore,
221
+ createdAfter,
222
+ updatedBefore,
223
+ updatedAfter
204
224
  );
205
225
  ```
206
226
 
@@ -211,7 +231,7 @@ const { status, data } = await apiInstance.listProductAnalytics(
211
231
  | **project** | [**string**] | What project it is | defaults to undefined|
212
232
  | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
213
233
  | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
214
- | **search** | [**string**] | Search query string to filter results. Supports field-specific filters like: \&#39;enabled:true\&#39;, \&#39;gfn_product_ids:&lt;id&gt;\&#39;, \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;includeArchived:false\&#39;, \&#39;hasSearchPhrase:false\&#39;, \&#39;inDataFeeds:true\&#39;, \&#39;aiOptimised:true\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;genderGroup:\&quot;male,female,unisex\&quot;\&#39;, \&#39;hasBarcode:true\&#39;, \&#39;onSale:true\&#39;, \&#39;type:product,template,bundle\&#39;, \&#39;collection:&lt;id&gt;\&#39;. Multiple filters can be combined with spaces and commas. | (optional) defaults to 'enabled:true'|
234
+ | **search** | [**string**] | Search query string to filter results. Supports field-specific filters like: \&#39;tag:\&quot;tag name\&quot;\&#39;, \&#39;internal_tag:\&quot;internal tag name\&quot;\&#39;, \&#39;productType:&lt;id&gt;\&#39;, \&#39;Multiple filters can be combined with spaces and commas.\&#39; | (optional) defaults to undefined|
215
235
  | **sortBy** | **Array&lt;string&gt;** | 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|
216
236
  | **dateRangeStartDate** | [**string**] | Start date for the date range filter (ISO 8601 format) | (optional) defaults to undefined|
217
237
  | **dateRangeEndDate** | [**string**] | End date for the date range filter (ISO 8601 format) | (optional) defaults to undefined|
@@ -223,6 +243,10 @@ const { status, data } = await apiInstance.listProductAnalytics(
223
243
  | **maximumBasketPercent** | [**number**] | Filter to only include products where the average basket percentage is less than or equal to this value | (optional) defaults to undefined|
224
244
  | **minimumTraffic** | [**number**] | Filter to only include products with total traffic greater than or equal to this number | (optional) defaults to undefined|
225
245
  | **maximumTraffic** | [**number**] | Filter to only include products with total traffic less than or equal to this number | (optional) defaults to undefined|
246
+ | **createdBefore** | [**string**] | Filter to only include products created before the given date | (optional) defaults to undefined|
247
+ | **createdAfter** | [**string**] | Filter to only include products created after the given date | (optional) defaults to undefined|
248
+ | **updatedBefore** | [**string**] | Filter to only include products updated before the given date | (optional) defaults to undefined|
249
+ | **updatedAfter** | [**string**] | Filter to only include products updated after the given date | (optional) defaults to undefined|
226
250
 
227
251
 
228
252
  ### Return type
@@ -0,0 +1,63 @@
1
+ # ProductCreatorsApi
2
+
3
+ All URIs are relative to *https://api.podos.io*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**listProductCreators**](#listproductcreators) | **GET** /v1/catalog/creators | List product creators|
8
+
9
+ # **listProductCreators**
10
+ > UserList listProductCreators()
11
+
12
+ Lists all the unique users that have created products for the given project.
13
+
14
+ ### Example
15
+
16
+ ```typescript
17
+ import {
18
+ ProductCreatorsApi,
19
+ Configuration
20
+ } from '@teemill/product-catalog';
21
+
22
+ const configuration = new Configuration();
23
+ const apiInstance = new ProductCreatorsApi(configuration);
24
+
25
+ let project: string; //What project it is (default to undefined)
26
+
27
+ const { status, data } = await apiInstance.listProductCreators(
28
+ project
29
+ );
30
+ ```
31
+
32
+ ### Parameters
33
+
34
+ |Name | Type | Description | Notes|
35
+ |------------- | ------------- | ------------- | -------------|
36
+ | **project** | [**string**] | What project it is | defaults to undefined|
37
+
38
+
39
+ ### Return type
40
+
41
+ **UserList**
42
+
43
+ ### Authorization
44
+
45
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
46
+
47
+ ### HTTP request headers
48
+
49
+ - **Content-Type**: Not defined
50
+ - **Accept**: application/json
51
+
52
+
53
+ ### HTTP response details
54
+ | Status code | Description | Response headers |
55
+ |-------------|-------------|------------------|
56
+ |**200** | Successfully retrieved a list of creators. | - |
57
+ |**400** | Failed validation. | - |
58
+ |**401** | Not authorised to access this resource. | - |
59
+ |**403** | Refuse to authorize. | - |
60
+ |**500** | Unknown server error. | - |
61
+
62
+ [[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)
63
+
@@ -0,0 +1,20 @@
1
+ # UserList
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **creators** | [**Array&lt;UserListCreatorsInner&gt;**](UserListCreatorsInner.md) | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { UserList } from '@teemill/product-catalog';
14
+
15
+ const instance: UserList = {
16
+ creators,
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)
@@ -0,0 +1,24 @@
1
+ # UserListCreatorsInner
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | Unique object identifier | [default to undefined]
9
+ **username** | **string** | The username of the product creator | [default to undefined]
10
+ **avatar** | [**UserListCreatorsInnerAvatar**](UserListCreatorsInnerAvatar.md) | | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { UserListCreatorsInner } from '@teemill/product-catalog';
16
+
17
+ const instance: UserListCreatorsInner = {
18
+ id,
19
+ username,
20
+ avatar,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # UserListCreatorsInnerAvatar
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **thumbnail** | **string** | URL to the thumbnail version of the avatar | [default to undefined]
9
+ **original** | **string** | URL to the original avatar image | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { UserListCreatorsInnerAvatar } from '@teemill/product-catalog';
15
+
16
+ const instance: UserListCreatorsInnerAvatar = {
17
+ thumbnail,
18
+ original,
19
+ };
20
+ ```
21
+
22
+ [[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
  * Product Catalog API
5
5
  * Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
6
6
  *
7
- * The version of the OpenAPI document: 1.86.0
7
+ * The version of the OpenAPI document: 1.87.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/product-catalog",
3
- "version": "1.86.0",
3
+ "version": "1.87.0",
4
4
  "description": "OpenAPI client for @teemill/product-catalog",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {