@teemill/product-catalog 1.90.2 → 1.92.0

package/dist/esm/configuration.js

@@ -3,7 +3,7 @@
  * Product Catalog
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
  *
- * The version of the OpenAPI document: 1.90.2
+ * The version of the OpenAPI document: 1.92.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.d.ts

@@ -2,7 +2,7 @@
  * Product Catalog
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
  *
- * The version of the OpenAPI document: 1.90.2
+ * The version of the OpenAPI document: 1.92.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.js

@@ -4,7 +4,7 @@
  * Product Catalog
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
  *
- * The version of the OpenAPI document: 1.90.2
+ * The version of the OpenAPI document: 1.92.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.d.ts

@@ -2,7 +2,7 @@
  * Product Catalog
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
  *
- * The version of the OpenAPI document: 1.90.2
+ * The version of the OpenAPI document: 1.92.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.js

@@ -5,7 +5,7 @@
  * Product Catalog
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
  *
- * The version of the OpenAPI document: 1.90.2
+ * The version of the OpenAPI document: 1.92.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/CreateProduct.md

@@ -23,6 +23,7 @@ Name | Type | Description | Notes
 **applicationSets** | **Array<string>** | List of application set UUIDs to associate with this product | [optional] [default to undefined]
 **includeInDataFeeds** | **boolean** | Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising. | [optional] [default to true]
 **shopifyId** | **number** | For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one. | [optional] [default to undefined]
+**collections** | [**Array<UpdateProductsRequestProductsInnerCollectionsInner>**](UpdateProductsRequestProductsInnerCollectionsInner.md) | An exclusive list of collection IDs to assign to the product. Replaces all existing static collection memberships. Requires the website integration. | [optional] [default to undefined]
 **metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
 **personalizationTemplate** | **string** | A JSON object that defines the personalization template for the product. | [optional] [default to undefined]
 **license** | [**UpdateProductsRequestProductsInnerLicense**](UpdateProductsRequestProductsInnerLicense.md) |  | [optional] [default to undefined]
@@ -51,6 +52,7 @@ const instance: CreateProduct = {
     applicationSets,
     includeInDataFeeds,
     shopifyId,
+    collections,
     metafields,
     personalizationTemplate,
     license,

package/docs/CreateProductRequest.md

@@ -23,6 +23,7 @@ Name | Type | Description | Notes
 **applicationSets** | **Array<string>** | List of application set UUIDs to associate with this product | [optional] [default to undefined]
 **includeInDataFeeds** | **boolean** | Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising. | [optional] [default to true]
 **shopifyId** | **number** | For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one. | [optional] [default to undefined]
+**collections** | [**Array<UpdateProductsRequestProductsInnerCollectionsInner>**](UpdateProductsRequestProductsInnerCollectionsInner.md) | An exclusive list of collection IDs to assign to the product. Replaces all existing static collection memberships. Requires the website integration. | [optional] [default to undefined]
 **metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
 **personalizationTemplate** | **string** | A JSON object that defines the personalization template for the product. | [optional] [default to undefined]
 **license** | [**UpdateProductsRequestProductsInnerLicense**](UpdateProductsRequestProductsInnerLicense.md) |  | [optional] [default to undefined]
@@ -56,6 +57,7 @@ const instance: CreateProductRequest = {
     applicationSets,
     includeInDataFeeds,
     shopifyId,
+    collections,
     metafields,
     personalizationTemplate,
     license,

package/docs/Product.md

@@ -45,6 +45,8 @@ Name | Type | Description | Notes
 **license** | [**License**](License.md) |  | [optional] [default to undefined]
 **createdBy** | **string** | The user ID of the user who created the product | [optional] [default to undefined]
 **isDigital** | **boolean** | Whether the product is digital | [optional] [default to false]
+**analytics** | [**ProductAnalytics**](ProductAnalytics.md) |  | [optional] [default to undefined]
+**staticCollections** | [**Array<ProductStaticCollectionsInner>**](ProductStaticCollectionsInner.md) | The static (non-dynamic/filter-based) collections this product belongs to. | [optional] [default to undefined]
 
 ## Example
 
@@ -92,6 +94,8 @@ const instance: Product = {
     license,
     createdBy,
     isDigital,
+    analytics,
+    staticCollections,
 };
 ```
 

package/docs/ProductAnalytics.md

@@ -0,0 +1,29 @@
+# ProductAnalytics
+
+Product analytics metrics. Only present when \'analytics\' is included in the fields query parameter.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**revenue** | **number** | Total revenue for this product within the date range | [optional] [default to undefined]
+**sales** | **number** | Total number of sales for this product within the date range | [optional] [default to undefined]
+**traffic** | **number** | Total page views for this product within the date range | [optional] [default to undefined]
+**conversionRate** | **number** | Conversion rate as a percentage (sales / traffic * 100) | [optional] [default to undefined]
+**basketRate** | **number** | Basket rate as a percentage (cart adds / traffic * 100) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductAnalytics } from '@teemill/product-catalog';
+
+const instance: ProductAnalytics = {
+    revenue,
+    sales,
+    traffic,
+    conversionRate,
+    basketRate,
+};
+```
+
+[[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/docs/ProductStaticCollectionsInner.md

@@ -0,0 +1,22 @@
+# ProductStaticCollectionsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductStaticCollectionsInner } from '@teemill/product-catalog';
+
+const instance: ProductStaticCollectionsInner = {
+    id,
+    title,
+};
+```
+
+[[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/docs/ProductsApi.md

@@ -478,6 +478,20 @@ let maxRetailPrice: number; //Specify the maximum retail price to filter by. Pro
 let minRetailPrice: number; //Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value. (optional) (default to undefined)
 let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 10)
 let fields: string; //Filter response fields to only include a subset of the resource. (optional) (default to undefined)
+let dateRangeStartDate: string; //Start date for the date range filter (ISO 8601 format) (optional) (default to undefined)
+let dateRangeEndDate: string; //End date for the date range filter (ISO 8601 format) (optional) (default to undefined)
+let minimumRevenue: number; //Filter to only include products with total revenue greater than or equal to this amount (optional) (default to undefined)
+let maximumRevenue: number; //Filter to only include products with total revenue less than or equal to this amount (optional) (default to undefined)
+let minimumSales: number; //Filter to only include products with total sales greater than or equal to this number (optional) (default to undefined)
+let maximumSales: number; //Filter to only include products with total sales less than or equal to this number (optional) (default to undefined)
+let minimumBasketPercent: number; //Filter to only include products where the average basket percentage is greater than or equal to this value (optional) (default to undefined)
+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)
+let minimumTraffic: number; //Filter to only include products with total traffic greater than or equal to this number (optional) (default to undefined)
+let maximumTraffic: number; //Filter to only include products with total traffic less than or equal to this number (optional) (default to undefined)
+let createdBefore: string; //Filter to only include products created before the given date (optional) (default to undefined)
+let createdAfter: string; //Filter to only include products created after the given date (optional) (default to undefined)
+let updatedBefore: string; //Filter to only include products updated before the given date (optional) (default to undefined)
+let updatedAfter: string; //Filter to only include products updated after the given date (optional) (default to undefined)
 
 const { status, data } = await apiInstance.listProducts(
     project,
@@ -490,7 +504,21 @@ const { status, data } = await apiInstance.listProducts(
     maxRetailPrice,
     minRetailPrice,
     pageSize,
-    fields
+    fields,
+    dateRangeStartDate,
+    dateRangeEndDate,
+    minimumRevenue,
+    maximumRevenue,
+    minimumSales,
+    maximumSales,
+    minimumBasketPercent,
+    maximumBasketPercent,
+    minimumTraffic,
+    maximumTraffic,
+    createdBefore,
+    createdAfter,
+    updatedBefore,
+    updatedAfter
 );
 ```
 
@@ -509,6 +537,20 @@ const { status, data } = await apiInstance.listProducts(
 | **minRetailPrice** | [**number**] | Specify the minimum retail price to filter by. Products will be included so long as either at least one variant or the product itself (in the case of bundles) has a retail price greater than or equal to the specified value. | (optional) defaults to undefined|
 | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 10|
 | **fields** | [**string**] | Filter response fields to only include a subset of the resource. | (optional) defaults to undefined|
+| **dateRangeStartDate** | [**string**] | Start date for the date range filter (ISO 8601 format) | (optional) defaults to undefined|
+| **dateRangeEndDate** | [**string**] | End date for the date range filter (ISO 8601 format) | (optional) defaults to undefined|
+| **minimumRevenue** | [**number**] | Filter to only include products with total revenue greater than or equal to this amount | (optional) defaults to undefined|
+| **maximumRevenue** | [**number**] | Filter to only include products with total revenue less than or equal to this amount | (optional) defaults to undefined|
+| **minimumSales** | [**number**] | Filter to only include products with total sales greater than or equal to this number | (optional) defaults to undefined|
+| **maximumSales** | [**number**] | Filter to only include products with total sales less than or equal to this number | (optional) defaults to undefined|
+| **minimumBasketPercent** | [**number**] | Filter to only include products where the average basket percentage is greater than or equal to this value | (optional) defaults to undefined|
+| **maximumBasketPercent** | [**number**] | Filter to only include products where the average basket percentage is less than or equal to this value | (optional) defaults to undefined|
+| **minimumTraffic** | [**number**] | Filter to only include products with total traffic greater than or equal to this number | (optional) defaults to undefined|
+| **maximumTraffic** | [**number**] | Filter to only include products with total traffic less than or equal to this number | (optional) defaults to undefined|
+| **createdBefore** | [**string**] | Filter to only include products created before the given date | (optional) defaults to undefined|
+| **createdAfter** | [**string**] | Filter to only include products created after the given date | (optional) defaults to undefined|
+| **updatedBefore** | [**string**] | Filter to only include products updated before the given date | (optional) defaults to undefined|
+| **updatedAfter** | [**string**] | Filter to only include products updated after the given date | (optional) defaults to undefined|
 
 
 ### Return type

package/docs/UpdateProductRequest.md

@@ -31,6 +31,7 @@ Name | Type | Description | Notes
 **license** | [**UpdateProductsRequestProductsInnerLicense**](UpdateProductsRequestProductsInnerLicense.md) |  | [optional] [default to undefined]
 **integrationConnections** | [**Array<UpdateProductRequestIntegrationConnectionsInner>**](UpdateProductRequestIntegrationConnectionsInner.md) | Integration connections for the product | [optional] [default to undefined]
 **showSaleBadge** | **boolean** | Whether to show a sale badge on the product | [optional] [default to true]
+**collections** | [**Array<UpdateProductsRequestProductsInnerCollectionsInner>**](UpdateProductsRequestProductsInnerCollectionsInner.md) | An exclusive list of collection IDs to assign to the product. Replaces all existing static collection memberships. Requires the website integration. | [optional] [default to undefined]
 
 ## Example
 
@@ -64,6 +65,7 @@ const instance: UpdateProductRequest = {
     license,
     integrationConnections,
     showSaleBadge,
+    collections,
 };
 ```
 

package/docs/UpdateProductsRequestProductsInner.md

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
 **shopifyId** | **number** | For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one. | [optional] [default to undefined]
 **integrationConnections** | [**Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md) |  | [optional] [default to undefined]
 **showSaleBadge** | **boolean** | Whether to show a sale badge on the product | [optional] [default to true]
+**collections** | [**Array<UpdateProductsRequestProductsInnerCollectionsInner>**](UpdateProductsRequestProductsInnerCollectionsInner.md) | An exclusive list of collection IDs to assign to the product. Replaces all existing static collection memberships. Requires the website integration. | [optional] [default to undefined]
 **license** | [**UpdateProductsRequestProductsInnerLicense**](UpdateProductsRequestProductsInnerLicense.md) |  | [optional] [default to undefined]
 
 ## Example
@@ -41,6 +42,7 @@ const instance: UpdateProductsRequestProductsInner = {
     shopifyId,
     integrationConnections,
     showSaleBadge,
+    collections,
     license,
 };
 ```

package/docs/UpdateProductsRequestProductsInnerCollectionsInner.md

@@ -0,0 +1,20 @@
+# UpdateProductsRequestProductsInnerCollectionsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateProductsRequestProductsInnerCollectionsInner } from '@teemill/product-catalog';
+
+const instance: UpdateProductsRequestProductsInnerCollectionsInner = {
+    id,
+};
+```
+
+[[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

@@ -4,7 +4,7 @@
  * Product Catalog
  * 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 product from the GFN Catalog, plus listing information such as title, description and tags.
  *
- * The version of the OpenAPI document: 1.90.2
+ * The version of the OpenAPI document: 1.92.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/product-catalog",
-  "version": "1.90.2",
+  "version": "1.92.0",
   "description": "OpenAPI client for @teemill/product-catalog",
   "author": "OpenAPI-Generator Contributors",
   "repository": {