@teemill/product-catalog 1.33.0 → 1.34.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.
package/dist/common.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.33.0
5
+ * The version of the OpenAPI document: 1.34.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.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.33.0
8
+ * The version of the OpenAPI document: 1.34.0
9
9
  *
10
10
  *
11
11
  * 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.33.0
5
+ * The version of the OpenAPI document: 1.34.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.33.0
8
+ * The version of the OpenAPI document: 1.34.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/api.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.33.0
5
+ * The version of the OpenAPI document: 1.34.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1593,7 +1593,7 @@ export declare const ApplicationSetsApiAxiosParamCreator: (configuration?: Confi
1593
1593
  * @summary List application sets
1594
1594
  * @param {string} project What project it is
1595
1595
  * @param {number} [pageToken] Page reference token
1596
- * @param {string} [search] Search term to filter based on product tags.
1596
+ * @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas.
1597
1597
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1598
1598
  * @param {*} [options] Override http request option.
1599
1599
  * @throws {RequiredError}
@@ -1647,7 +1647,7 @@ export declare const ApplicationSetsApiFp: (configuration?: Configuration) => {
1647
1647
  * @summary List application sets
1648
1648
  * @param {string} project What project it is
1649
1649
  * @param {number} [pageToken] Page reference token
1650
- * @param {string} [search] Search term to filter based on product tags.
1650
+ * @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas.
1651
1651
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1652
1652
  * @param {*} [options] Override http request option.
1653
1653
  * @throws {RequiredError}
@@ -1786,7 +1786,7 @@ export interface ApplicationSetsApiListApplicationSetsRequest {
1786
1786
  */
1787
1787
  readonly pageToken?: number;
1788
1788
  /**
1789
- * Search term to filter based on product tags.
1789
+ * Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', and \'tag:\"tag name\"\'. Multiple filters can be combined with spaces and commas.
1790
1790
  * @type {string}
1791
1791
  * @memberof ApplicationSetsApiListApplicationSets
1792
1792
  */
@@ -1910,27 +1910,27 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
1910
1910
  */
1911
1911
  getProduct: (project: string, productId: string, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1912
1912
  /**
1913
- * Lists all enabled store listing products attached to the given project.
1914
- * @summary List products
1913
+ * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
1914
+ * @summary Import products
1915
1915
  * @param {string} project What project it is
1916
- * @param {number} [pageToken] Page reference token
1917
- * @param {string} [search] Search term to filter based on product tags.
1918
- * @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.
1919
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1920
- * @param {string} [fields] Filter response fields to only include a subset of the resource.
1916
+ * @param {string} [body] A data URL of a CSV file containing data for one or more products.
1921
1917
  * @param {*} [options] Override http request option.
1922
1918
  * @throws {RequiredError}
1923
1919
  */
1924
- getProducts: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1920
+ importProducts: (project: string, body?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1925
1921
  /**
1926
- * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
1927
- * @summary Import products
1922
+ * Lists all store listing products attached to the given project.
1923
+ * @summary List products
1928
1924
  * @param {string} project What project it is
1929
- * @param {string} [body] A data URL of a CSV file containing data for one or more products.
1925
+ * @param {number} [pageToken] Page reference token
1926
+ * @param {string} [search] Search query string to filter results. Supports field-specific filters like \&#39;enabled:true\&#39;, \&#39;uuid:&lt;id&gt;\&#39;, \&#39;name:\&quot;product name\&quot;\&#39;, and \&#39;tag:\&quot;tag name\&quot;\&#39;. Multiple filters can be combined with spaces and commas.
1927
+ * @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.
1928
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1929
+ * @param {string} [fields] Filter response fields to only include a subset of the resource.
1930
1930
  * @param {*} [options] Override http request option.
1931
1931
  * @throws {RequiredError}
1932
1932
  */
1933
- importProducts: (project: string, body?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1933
+ listProducts: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1934
1934
  /**
1935
1935
  * Updates a product by a given ID.
1936
1936
  * @summary Update product
@@ -1976,27 +1976,27 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
1976
1976
  */
1977
1977
  getProduct(project: string, productId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>>;
1978
1978
  /**
1979
- * Lists all enabled store listing products attached to the given project.
1980
- * @summary List products
1979
+ * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
1980
+ * @summary Import products
1981
1981
  * @param {string} project What project it is
1982
- * @param {number} [pageToken] Page reference token
1983
- * @param {string} [search] Search term to filter based on product tags.
1984
- * @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.
1985
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1986
- * @param {string} [fields] Filter response fields to only include a subset of the resource.
1982
+ * @param {string} [body] A data URL of a CSV file containing data for one or more products.
1987
1983
  * @param {*} [options] Override http request option.
1988
1984
  * @throws {RequiredError}
1989
1985
  */
1990
- getProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
1986
+ importProducts(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportProducts200Response>>;
1991
1987
  /**
1992
- * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
1993
- * @summary Import products
1988
+ * Lists all store listing products attached to the given project.
1989
+ * @summary List products
1994
1990
  * @param {string} project What project it is
1995
- * @param {string} [body] A data URL of a CSV file containing data for one or more products.
1991
+ * @param {number} [pageToken] Page reference token
1992
+ * @param {string} [search] Search query string to filter results. Supports field-specific filters like \&#39;enabled:true\&#39;, \&#39;uuid:&lt;id&gt;\&#39;, \&#39;name:\&quot;product name\&quot;\&#39;, and \&#39;tag:\&quot;tag name\&quot;\&#39;. Multiple filters can be combined with spaces and commas.
1993
+ * @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.
1994
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1995
+ * @param {string} [fields] Filter response fields to only include a subset of the resource.
1996
1996
  * @param {*} [options] Override http request option.
1997
1997
  * @throws {RequiredError}
1998
1998
  */
1999
- importProducts(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportProducts200Response>>;
1999
+ listProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
2000
2000
  /**
2001
2001
  * Updates a product by a given ID.
2002
2002
  * @summary Update product
@@ -2037,14 +2037,6 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
2037
2037
  * @throws {RequiredError}
2038
2038
  */
2039
2039
  getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
2040
- /**
2041
- * Lists all enabled store listing products attached to the given project.
2042
- * @summary List products
2043
- * @param {ProductsApiGetProductsRequest} requestParameters Request parameters.
2044
- * @param {*} [options] Override http request option.
2045
- * @throws {RequiredError}
2046
- */
2047
- getProducts(requestParameters: ProductsApiGetProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse>;
2048
2040
  /**
2049
2041
  * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
2050
2042
  * @summary Import products
@@ -2053,6 +2045,14 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
2053
2045
  * @throws {RequiredError}
2054
2046
  */
2055
2047
  importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImportProducts200Response>;
2048
+ /**
2049
+ * Lists all store listing products attached to the given project.
2050
+ * @summary List products
2051
+ * @param {ProductsApiListProductsRequest} requestParameters Request parameters.
2052
+ * @param {*} [options] Override http request option.
2053
+ * @throws {RequiredError}
2054
+ */
2055
+ listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse>;
2056
2056
  /**
2057
2057
  * Updates a product by a given ID.
2058
2058
  * @summary Update product
@@ -2126,67 +2126,67 @@ export interface ProductsApiGetProductRequest {
2126
2126
  readonly fields?: string;
2127
2127
  }
2128
2128
  /**
2129
- * Request parameters for getProducts operation in ProductsApi.
2129
+ * Request parameters for importProducts operation in ProductsApi.
2130
+ * @export
2131
+ * @interface ProductsApiImportProductsRequest
2132
+ */
2133
+ export interface ProductsApiImportProductsRequest {
2134
+ /**
2135
+ * What project it is
2136
+ * @type {string}
2137
+ * @memberof ProductsApiImportProducts
2138
+ */
2139
+ readonly project: string;
2140
+ /**
2141
+ * A data URL of a CSV file containing data for one or more products.
2142
+ * @type {string}
2143
+ * @memberof ProductsApiImportProducts
2144
+ */
2145
+ readonly body?: string;
2146
+ }
2147
+ /**
2148
+ * Request parameters for listProducts operation in ProductsApi.
2130
2149
  * @export
2131
- * @interface ProductsApiGetProductsRequest
2150
+ * @interface ProductsApiListProductsRequest
2132
2151
  */
2133
- export interface ProductsApiGetProductsRequest {
2152
+ export interface ProductsApiListProductsRequest {
2134
2153
  /**
2135
2154
  * What project it is
2136
2155
  * @type {string}
2137
- * @memberof ProductsApiGetProducts
2156
+ * @memberof ProductsApiListProducts
2138
2157
  */
2139
2158
  readonly project: string;
2140
2159
  /**
2141
2160
  * Page reference token
2142
2161
  * @type {number}
2143
- * @memberof ProductsApiGetProducts
2162
+ * @memberof ProductsApiListProducts
2144
2163
  */
2145
2164
  readonly pageToken?: number;
2146
2165
  /**
2147
- * Search term to filter based on product tags.
2166
+ * Search query string to filter results. Supports field-specific filters like \&#39;enabled:true\&#39;, \&#39;uuid:&lt;id&gt;\&#39;, \&#39;name:\&quot;product name\&quot;\&#39;, and \&#39;tag:\&quot;tag name\&quot;\&#39;. Multiple filters can be combined with spaces and commas.
2148
2167
  * @type {string}
2149
- * @memberof ProductsApiGetProducts
2168
+ * @memberof ProductsApiListProducts
2150
2169
  */
2151
2170
  readonly search?: string;
2152
2171
  /**
2153
2172
  * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
2154
2173
  * @type {Array<string>}
2155
- * @memberof ProductsApiGetProducts
2174
+ * @memberof ProductsApiListProducts
2156
2175
  */
2157
2176
  readonly sortBy?: Array<string>;
2158
2177
  /**
2159
2178
  * Max page size. This is the maximum page size that will be returned, but it might be smaller.
2160
2179
  * @type {number}
2161
- * @memberof ProductsApiGetProducts
2180
+ * @memberof ProductsApiListProducts
2162
2181
  */
2163
2182
  readonly pageSize?: number;
2164
2183
  /**
2165
2184
  * Filter response fields to only include a subset of the resource.
2166
2185
  * @type {string}
2167
- * @memberof ProductsApiGetProducts
2186
+ * @memberof ProductsApiListProducts
2168
2187
  */
2169
2188
  readonly fields?: string;
2170
2189
  }
2171
- /**
2172
- * Request parameters for importProducts operation in ProductsApi.
2173
- * @export
2174
- * @interface ProductsApiImportProductsRequest
2175
- */
2176
- export interface ProductsApiImportProductsRequest {
2177
- /**
2178
- * What project it is
2179
- * @type {string}
2180
- * @memberof ProductsApiImportProducts
2181
- */
2182
- readonly project: string;
2183
- /**
2184
- * A data URL of a CSV file containing data for one or more products.
2185
- * @type {string}
2186
- * @memberof ProductsApiImportProducts
2187
- */
2188
- readonly body?: string;
2189
- }
2190
2190
  /**
2191
2191
  * Request parameters for updateProduct operation in ProductsApi.
2192
2192
  * @export
@@ -2247,23 +2247,23 @@ export declare class ProductsApi extends BaseAPI {
2247
2247
  */
2248
2248
  getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
2249
2249
  /**
2250
- * Lists all enabled store listing products attached to the given project.
2251
- * @summary List products
2252
- * @param {ProductsApiGetProductsRequest} requestParameters Request parameters.
2250
+ * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
2251
+ * @summary Import products
2252
+ * @param {ProductsApiImportProductsRequest} requestParameters Request parameters.
2253
2253
  * @param {*} [options] Override http request option.
2254
2254
  * @throws {RequiredError}
2255
2255
  * @memberof ProductsApi
2256
2256
  */
2257
- getProducts(requestParameters: ProductsApiGetProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductsResponse, any>>;
2257
+ importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportProducts200Response, any>>;
2258
2258
  /**
2259
- * Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
2260
- * @summary Import products
2261
- * @param {ProductsApiImportProductsRequest} requestParameters Request parameters.
2259
+ * Lists all store listing products attached to the given project.
2260
+ * @summary List products
2261
+ * @param {ProductsApiListProductsRequest} requestParameters Request parameters.
2262
2262
  * @param {*} [options] Override http request option.
2263
2263
  * @throws {RequiredError}
2264
2264
  * @memberof ProductsApi
2265
2265
  */
2266
- importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportProducts200Response, any>>;
2266
+ listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductsResponse, any>>;
2267
2267
  /**
2268
2268
  * Updates a product by a given ID.
2269
2269
  * @summary Update product
@@ -2293,7 +2293,7 @@ export declare const VariantsApiAxiosParamCreator: (configuration?: Configuratio
2293
2293
  * Lists all variants that belong to enabled products attached to the given project.
2294
2294
  * @summary List variants
2295
2295
  * @param {string} project What project it is
2296
- * @param {string} [search] Search term to filter based on product tags.
2296
+ * @param {string} [search] Search query string to filter results. Supports field-specific filters like \&#39;enabled:true\&#39;, \&#39;uuid:&lt;id&gt;\&#39;, \&#39;name:\&quot;product name\&quot;\&#39;, and \&#39;tag:\&quot;tag name\&quot;\&#39;. Multiple filters can be combined with spaces and commas.
2297
2297
  * @param {number} [pageToken] Page reference token
2298
2298
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2299
2299
  * @param {string} [fields] Filter response fields to only include a subset of the resource.
@@ -2321,7 +2321,7 @@ export declare const VariantsApiFp: (configuration?: Configuration) => {
2321
2321
  * Lists all variants that belong to enabled products attached to the given project.
2322
2322
  * @summary List variants
2323
2323
  * @param {string} project What project it is
2324
- * @param {string} [search] Search term to filter based on product tags.
2324
+ * @param {string} [search] Search query string to filter results. Supports field-specific filters like \&#39;enabled:true\&#39;, \&#39;uuid:&lt;id&gt;\&#39;, \&#39;name:\&quot;product name\&quot;\&#39;, and \&#39;tag:\&quot;tag name\&quot;\&#39;. Multiple filters can be combined with spaces and commas.
2325
2325
  * @param {number} [pageToken] Page reference token
2326
2326
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2327
2327
  * @param {string} [fields] Filter response fields to only include a subset of the resource.
@@ -2390,7 +2390,7 @@ export interface VariantsApiListVariantsRequest {
2390
2390
  */
2391
2391
  readonly project: string;
2392
2392
  /**
2393
- * Search term to filter based on product tags.
2393
+ * Search query string to filter results. Supports field-specific filters like \&#39;enabled:true\&#39;, \&#39;uuid:&lt;id&gt;\&#39;, \&#39;name:\&quot;product name\&quot;\&#39;, and \&#39;tag:\&quot;tag name\&quot;\&#39;. Multiple filters can be combined with spaces and commas.
2394
2394
  * @type {string}
2395
2395
  * @memberof VariantsApiListVariants
2396
2396
  */