@teemill/product-catalog 1.84.0 → 1.86.0

package/dist/esm/api.d.ts

@@ -2,7 +2,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.86.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,6 +13,33 @@ import type { Configuration } from './configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import type { RequestArgs } from './base';
 import { BaseAPI } from './base';
+export interface Action {
+    /**
+     * Unique object identifier
+     */
+    'id': string;
+    /**
+     * A reference to the action resource location
+     */
+    'ref': string;
+    /**
+     * The title of the action
+     */
+    'title': string;
+    'impact': ActionImpactEnum;
+    /**
+     * A reference to the task resource location
+     */
+    'taskRef': string | null;
+    'createdAt': string;
+    'updatedAt': string;
+}
+export declare const ActionImpactEnum: {
+    readonly High: "high";
+    readonly Medium: "medium";
+    readonly Low: "low";
+};
+export type ActionImpactEnum = typeof ActionImpactEnum[keyof typeof ActionImpactEnum];
 export interface AdditionalFile {
     /**
      * Publicly available file URL.
@@ -45,6 +72,15 @@ export interface AnalyticsItem {
      */
     'revenue': number;
 }
+export interface AnalyticsSummary {
+    /**
+     * A summary of the recommendations
+     */
+    'summary': string;
+    'recommendations': Array<Recommendation>;
+    'createdAt': string;
+    'updatedAt': string;
+}
 export interface ApiError {
     'code'?: string;
     'message': string;
@@ -1236,6 +1272,34 @@ export interface ProductsResponse {
      */
     'nextPageToken'?: number | null;
 }
+export interface Recommendation {
+    /**
+     * Unique object identifier
+     */
+    'id': string;
+    /**
+     * A reference to the recommendation resource location
+     */
+    'ref': string;
+    /**
+     * The reason for the recommendation
+     */
+    'reason': string;
+    /**
+     * The recommendation for the target
+     */
+    'recommendation': string;
+    'priority': RecommendationPriorityEnum;
+    'actions': Array<Action>;
+    'createdAt': string;
+    'updatedAt': string;
+}
+export declare const RecommendationPriorityEnum: {
+    readonly High: "high";
+    readonly Medium: "medium";
+    readonly Low: "low";
+};
+export type RecommendationPriorityEnum = typeof RecommendationPriorityEnum[keyof typeof RecommendationPriorityEnum];
 /**
  * Required price definition that defines the amount and currency.
  */
@@ -2500,22 +2564,52 @@ export declare const ProductAnalyticsApiAxiosParamCreator: (configuration?: Conf
      * Exports all products with analytics data in a CSV file.
      * @summary Export product analytics
      * @param {string} project What project it is
+     * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
+     * @param {string} [search] 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.
+     * @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
+     * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
+     * @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
+     * @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
+     * @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
+     * @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
+     * @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
+     * @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
+     * @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
+     * @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    exportProductAnalytics: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    exportProductAnalytics: (project: string, sortBy?: Array<string>, search?: string, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get the AI-generated summary of the product analytics for the given project.
+     * @summary Get product analytics summary
+     * @param {string} project What project it is
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductAnalyticsSummary: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Lists all product analytics items.
      * @summary List product analytics
      * @param {string} project What project it is
      * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
      * @param {string} [search] 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.
      * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
-     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
+     * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
+     * @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
+     * @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
+     * @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
+     * @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
+     * @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
+     * @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
+     * @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
+     * @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listProductAnalytics: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    listProductAnalytics: (project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * ProductAnalyticsApi - functional programming interface
@@ -2525,22 +2619,52 @@ export declare const ProductAnalyticsApiFp: (configuration?: Configuration) => {
      * Exports all products with analytics data in a CSV file.
      * @summary Export product analytics
      * @param {string} project What project it is
+     * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
+     * @param {string} [search] 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.
+     * @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
+     * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
+     * @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
+     * @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
+     * @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
+     * @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
+     * @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
+     * @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
+     * @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
+     * @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportProductAnalytics(project: string, sortBy?: Array<string>, search?: string, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    /**
+     * Get the AI-generated summary of the product analytics for the given project.
+     * @summary Get product analytics summary
+     * @param {string} project What project it is
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    exportProductAnalytics(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    getProductAnalyticsSummary(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AnalyticsSummary>>;
     /**
      * Lists all product analytics items.
      * @summary List product analytics
      * @param {string} project What project it is
      * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
      * @param {string} [search] 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.
      * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
-     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {string} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
+     * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
+     * @param {number} [minimumRevenue] Filter to only include products with total revenue greater than or equal to this amount
+     * @param {number} [maximumRevenue] Filter to only include products with total revenue less than or equal to this amount
+     * @param {number} [minimumSales] Filter to only include products with total sales greater than or equal to this number
+     * @param {number} [maximumSales] Filter to only include products with total sales less than or equal to this number
+     * @param {number} [minimumBasketPercent] Filter to only include products where the average basket percentage is greater than or equal to this value
+     * @param {number} [maximumBasketPercent] Filter to only include products where the average basket percentage is less than or equal to this value
+     * @param {number} [minimumTraffic] Filter to only include products with total traffic greater than or equal to this number
+     * @param {number} [maximumTraffic] Filter to only include products with total traffic less than or equal to this number
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listProductAnalytics(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductAnalyticsResponse>>;
+    listProductAnalytics(project: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<string>, dateRangeStartDate?: string, dateRangeEndDate?: string, minimumRevenue?: number, maximumRevenue?: number, minimumSales?: number, maximumSales?: number, minimumBasketPercent?: number, maximumBasketPercent?: number, minimumTraffic?: number, maximumTraffic?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductAnalyticsResponse>>;
 };
 /**
  * ProductAnalyticsApi - factory interface
@@ -2554,6 +2678,14 @@ export declare const ProductAnalyticsApiFactory: (configuration?: Configuration,
      * @throws {RequiredError}
      */
     exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
+    /**
+     * Get the AI-generated summary of the product analytics for the given project.
+     * @summary Get product analytics summary
+     * @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductAnalyticsSummary(requestParameters: ProductAnalyticsApiGetProductAnalyticsSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<AnalyticsSummary>;
     /**
      * Lists all product analytics items.
      * @summary List product analytics
@@ -2571,6 +2703,63 @@ export interface ProductAnalyticsApiExportProductAnalyticsRequest {
      * What project it is
      */
     readonly project: string;
+    /**
+     * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
+     */
+    readonly sortBy?: Array<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.
+     */
+    readonly search?: string;
+    /**
+     * Start date for the date range filter (ISO 8601 format)
+     */
+    readonly dateRangeStartDate?: string;
+    /**
+     * End date for the date range filter (ISO 8601 format)
+     */
+    readonly dateRangeEndDate?: string;
+    /**
+     * Filter to only include products with total revenue greater than or equal to this amount
+     */
+    readonly minimumRevenue?: number;
+    /**
+     * Filter to only include products with total revenue less than or equal to this amount
+     */
+    readonly maximumRevenue?: number;
+    /**
+     * Filter to only include products with total sales greater than or equal to this number
+     */
+    readonly minimumSales?: number;
+    /**
+     * Filter to only include products with total sales less than or equal to this number
+     */
+    readonly maximumSales?: number;
+    /**
+     * Filter to only include products where the average basket percentage is greater than or equal to this value
+     */
+    readonly minimumBasketPercent?: number;
+    /**
+     * Filter to only include products where the average basket percentage is less than or equal to this value
+     */
+    readonly maximumBasketPercent?: number;
+    /**
+     * Filter to only include products with total traffic greater than or equal to this number
+     */
+    readonly minimumTraffic?: number;
+    /**
+     * Filter to only include products with total traffic less than or equal to this number
+     */
+    readonly maximumTraffic?: number;
+}
+/**
+ * Request parameters for getProductAnalyticsSummary operation in ProductAnalyticsApi.
+ */
+export interface ProductAnalyticsApiGetProductAnalyticsSummaryRequest {
+    /**
+     * What project it is
+     */
+    readonly project: string;
 }
 /**
  * Request parameters for listProductAnalytics operation in ProductAnalyticsApi.
@@ -2584,6 +2773,10 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
      * Page reference token
      */
     readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     */
+    readonly pageSize?: number;
     /**
      * 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.
      */
@@ -2593,9 +2786,45 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
      */
     readonly sortBy?: Array<string>;
     /**
-     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * Start date for the date range filter (ISO 8601 format)
      */
-    readonly pageSize?: number;
+    readonly dateRangeStartDate?: string;
+    /**
+     * End date for the date range filter (ISO 8601 format)
+     */
+    readonly dateRangeEndDate?: string;
+    /**
+     * Filter to only include products with total revenue greater than or equal to this amount
+     */
+    readonly minimumRevenue?: number;
+    /**
+     * Filter to only include products with total revenue less than or equal to this amount
+     */
+    readonly maximumRevenue?: number;
+    /**
+     * Filter to only include products with total sales greater than or equal to this number
+     */
+    readonly minimumSales?: number;
+    /**
+     * Filter to only include products with total sales less than or equal to this number
+     */
+    readonly maximumSales?: number;
+    /**
+     * Filter to only include products where the average basket percentage is greater than or equal to this value
+     */
+    readonly minimumBasketPercent?: number;
+    /**
+     * Filter to only include products where the average basket percentage is less than or equal to this value
+     */
+    readonly maximumBasketPercent?: number;
+    /**
+     * Filter to only include products with total traffic greater than or equal to this number
+     */
+    readonly minimumTraffic?: number;
+    /**
+     * Filter to only include products with total traffic less than or equal to this number
+     */
+    readonly maximumTraffic?: number;
 }
 /**
  * ProductAnalyticsApi - object-oriented interface
@@ -2609,6 +2838,14 @@ export declare class ProductAnalyticsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     exportProductAnalytics(requestParameters: ProductAnalyticsApiExportProductAnalyticsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
+    /**
+     * Get the AI-generated summary of the product analytics for the given project.
+     * @summary Get product analytics summary
+     * @param {ProductAnalyticsApiGetProductAnalyticsSummaryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductAnalyticsSummary(requestParameters: ProductAnalyticsApiGetProductAnalyticsSummaryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AnalyticsSummary, any, {}>>;
     /**
      * Lists all product analytics items.
      * @summary List product analytics