@teemill/product-catalog 1.86.0 → 1.87.0

package/dist/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.86.0
+ * The version of the OpenAPI document: 1.87.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1831,6 +1831,30 @@ export declare const UpdateProductsRequestProductsInnerVariantsInnerSalePriceCur
     readonly Gbp: "GBP";
 };
 export type UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum];
+export interface UserList {
+    'creators': Array<UserListCreatorsInner>;
+}
+export interface UserListCreatorsInner {
+    /**
+     * Unique object identifier
+     */
+    'id': string;
+    /**
+     * The username of the product creator
+     */
+    'username': string;
+    'avatar': UserListCreatorsInnerAvatar;
+}
+export interface UserListCreatorsInnerAvatar {
+    /**
+     * URL to the thumbnail version of the avatar
+     */
+    'thumbnail': string | null;
+    /**
+     * URL to the original avatar image
+     */
+    'original': string | null;
+}
 export interface Variant {
     /**
      * Unique object identifier
@@ -2565,7 +2589,7 @@ export declare const ProductAnalyticsApiAxiosParamCreator: (configuration?: Conf
      * @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} [search] 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;
      * @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
@@ -2576,10 +2600,14 @@ export declare const ProductAnalyticsApiAxiosParamCreator: (configuration?: Conf
      * @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 {string} [createdBefore] Filter to only include products created before the given date
+     * @param {string} [createdAfter] Filter to only include products created after the given date
+     * @param {string} [updatedBefore] Filter to only include products updated before the given date
+     * @param {string} [updatedAfter] Filter to only include products updated after the given date
      * @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<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, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get the AI-generated summary of the product analytics for the given project.
      * @summary Get product analytics summary
@@ -2594,7 +2622,7 @@ export declare const ProductAnalyticsApiAxiosParamCreator: (configuration?: Conf
      * @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 {string} [search] 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;
      * @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} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
      * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
@@ -2606,10 +2634,14 @@ export declare const ProductAnalyticsApiAxiosParamCreator: (configuration?: Conf
      * @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 {string} [createdBefore] Filter to only include products created before the given date
+     * @param {string} [createdAfter] Filter to only include products created after the given date
+     * @param {string} [updatedBefore] Filter to only include products updated before the given date
+     * @param {string} [updatedAfter] Filter to only include products updated after the given date
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    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>;
+    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, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * ProductAnalyticsApi - functional programming interface
@@ -2620,7 +2652,7 @@ export declare const ProductAnalyticsApiFp: (configuration?: Configuration) => {
      * @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} [search] 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;
      * @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
@@ -2631,10 +2663,14 @@ export declare const ProductAnalyticsApiFp: (configuration?: Configuration) => {
      * @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 {string} [createdBefore] Filter to only include products created before the given date
+     * @param {string} [createdAfter] Filter to only include products created after the given date
+     * @param {string} [updatedBefore] Filter to only include products updated before the given date
+     * @param {string} [updatedAfter] Filter to only include products updated after the given date
      * @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>>;
+    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, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, 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
@@ -2649,7 +2685,7 @@ export declare const ProductAnalyticsApiFp: (configuration?: Configuration) => {
      * @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 {string} [search] 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;
      * @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} [dateRangeStartDate] Start date for the date range filter (ISO 8601 format)
      * @param {string} [dateRangeEndDate] End date for the date range filter (ISO 8601 format)
@@ -2661,10 +2697,14 @@ export declare const ProductAnalyticsApiFp: (configuration?: Configuration) => {
      * @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 {string} [createdBefore] Filter to only include products created before the given date
+     * @param {string} [createdAfter] Filter to only include products created after the given date
+     * @param {string} [updatedBefore] Filter to only include products updated before the given date
+     * @param {string} [updatedAfter] Filter to only include products updated after the given date
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    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>>;
+    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, createdBefore?: string, createdAfter?: string, updatedBefore?: string, updatedAfter?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductAnalyticsResponse>>;
 };
 /**
  * ProductAnalyticsApi - factory interface
@@ -2708,7 +2748,7 @@ export interface ProductAnalyticsApiExportProductAnalyticsRequest {
      */
     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.
+     * 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;
      */
     readonly search?: string;
     /**
@@ -2751,6 +2791,22 @@ export interface ProductAnalyticsApiExportProductAnalyticsRequest {
      * Filter to only include products with total traffic less than or equal to this number
      */
     readonly maximumTraffic?: number;
+    /**
+     * Filter to only include products created before the given date
+     */
+    readonly createdBefore?: string;
+    /**
+     * Filter to only include products created after the given date
+     */
+    readonly createdAfter?: string;
+    /**
+     * Filter to only include products updated before the given date
+     */
+    readonly updatedBefore?: string;
+    /**
+     * Filter to only include products updated after the given date
+     */
+    readonly updatedAfter?: string;
 }
 /**
  * Request parameters for getProductAnalyticsSummary operation in ProductAnalyticsApi.
@@ -2778,7 +2834,7 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
      */
     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.
+     * 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;
      */
     readonly search?: string;
     /**
@@ -2825,6 +2881,22 @@ export interface ProductAnalyticsApiListProductAnalyticsRequest {
      * Filter to only include products with total traffic less than or equal to this number
      */
     readonly maximumTraffic?: number;
+    /**
+     * Filter to only include products created before the given date
+     */
+    readonly createdBefore?: string;
+    /**
+     * Filter to only include products created after the given date
+     */
+    readonly createdAfter?: string;
+    /**
+     * Filter to only include products updated before the given date
+     */
+    readonly updatedBefore?: string;
+    /**
+     * Filter to only include products updated after the given date
+     */
+    readonly updatedAfter?: string;
 }
 /**
  * ProductAnalyticsApi - object-oriented interface
@@ -2855,6 +2927,67 @@ export declare class ProductAnalyticsApi extends BaseAPI {
      */
     listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductAnalyticsResponse, any, {}>>;
 }
+/**
+ * ProductCreatorsApi - axios parameter creator
+ */
+export declare const ProductCreatorsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Lists all the unique users that have created products for the given project.
+     * @summary List product creators
+     * @param {string} project What project it is
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listProductCreators: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ProductCreatorsApi - functional programming interface
+ */
+export declare const ProductCreatorsApiFp: (configuration?: Configuration) => {
+    /**
+     * Lists all the unique users that have created products for the given project.
+     * @summary List product creators
+     * @param {string} project What project it is
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listProductCreators(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserList>>;
+};
+/**
+ * ProductCreatorsApi - factory interface
+ */
+export declare const ProductCreatorsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Lists all the unique users that have created products for the given project.
+     * @summary List product creators
+     * @param {ProductCreatorsApiListProductCreatorsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listProductCreators(requestParameters: ProductCreatorsApiListProductCreatorsRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserList>;
+};
+/**
+ * Request parameters for listProductCreators operation in ProductCreatorsApi.
+ */
+export interface ProductCreatorsApiListProductCreatorsRequest {
+    /**
+     * What project it is
+     */
+    readonly project: string;
+}
+/**
+ * ProductCreatorsApi - object-oriented interface
+ */
+export declare class ProductCreatorsApi extends BaseAPI {
+    /**
+     * Lists all the unique users that have created products for the given project.
+     * @summary List product creators
+     * @param {ProductCreatorsApiListProductCreatorsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listProductCreators(requestParameters: ProductCreatorsApiListProductCreatorsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserList, any, {}>>;
+}
 /**
  * ProductTypesApi - axios parameter creator
  */