@teemill/product-catalog 1.84.0 → 1.85.0

package/docs/ProductAnalyticsApi.md

@@ -24,9 +24,33 @@ const configuration = new Configuration();
 const apiInstance = new ProductAnalyticsApi(configuration);
 
 let project: string; //What project it is (default to undefined)
+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)
+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')
+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)
 
 const { status, data } = await apiInstance.exportProductAnalytics(
-    project
+    project,
+    sortBy,
+    search,
+    dateRangeStartDate,
+    dateRangeEndDate,
+    minimumRevenue,
+    maximumRevenue,
+    minimumSales,
+    maximumSales,
+    minimumBasketPercent,
+    maximumBasketPercent,
+    minimumTraffic,
+    maximumTraffic
 );
 ```
 
@@ -35,6 +59,18 @@ const { status, data } = await apiInstance.exportProductAnalytics(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **project** | [**string**] | What project it is | defaults to undefined|
+| **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|
+| **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'|
+| **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|
 
 
 ### Return type
@@ -80,16 +116,36 @@ const apiInstance = new ProductAnalyticsApi(configuration);
 
 let project: string; //What project it is (default to undefined)
 let pageToken: number; //Page reference token (optional) (default to 1)
+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)
 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')
 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)
-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)
+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)
 
 const { status, data } = await apiInstance.listProductAnalytics(
     project,
     pageToken,
+    pageSize,
     search,
     sortBy,
-    pageSize
+    dateRangeStartDate,
+    dateRangeEndDate,
+    minimumRevenue,
+    maximumRevenue,
+    minimumSales,
+    maximumSales,
+    minimumBasketPercent,
+    maximumBasketPercent,
+    minimumTraffic,
+    maximumTraffic
 );
 ```
 
@@ -99,9 +155,19 @@ const { status, data } = await apiInstance.listProductAnalytics(
 |------------- | ------------- | ------------- | -------------|
 | **project** | [**string**] | What project it is | defaults to undefined|
 | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
+| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
 | **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'|
 | **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|
-| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
+| **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|
 
 
 ### Return type

package/index.ts

@@ -4,7 +4,7 @@
  * Product Catalog API
  * 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.
  *
- * The version of the OpenAPI document: 1.84.0
+ * The version of the OpenAPI document: 1.85.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.84.0",
+  "version": "1.85.0",
   "description": "OpenAPI client for @teemill/product-catalog",
   "author": "OpenAPI-Generator Contributors",
   "repository": {