@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/README.md +2 -2
- package/api.ts +115 -115
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +76 -76
- package/dist/api.js +76 -76
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +76 -76
- package/dist/esm/api.js +76 -76
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/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.
|
|
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
|
|
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
|
|
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
|
|
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
|
-
*
|
|
1914
|
-
* @summary
|
|
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 {
|
|
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 \'-\' for descending order or \'+\' 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
|
-
|
|
1920
|
+
importProducts: (project: string, body?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1925
1921
|
/**
|
|
1926
|
-
*
|
|
1927
|
-
* @summary
|
|
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 {
|
|
1925
|
+
* @param {number} [pageToken] Page reference token
|
|
1926
|
+
* @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.
|
|
1927
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' 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
|
-
|
|
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
|
-
*
|
|
1980
|
-
* @summary
|
|
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 {
|
|
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 \'-\' for descending order or \'+\' 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
|
-
|
|
1986
|
+
importProducts(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportProducts200Response>>;
|
|
1991
1987
|
/**
|
|
1992
|
-
*
|
|
1993
|
-
* @summary
|
|
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 {
|
|
1991
|
+
* @param {number} [pageToken] Page reference token
|
|
1992
|
+
* @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.
|
|
1993
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' 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
|
-
|
|
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
|
|
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
|
|
2150
|
+
* @interface ProductsApiListProductsRequest
|
|
2132
2151
|
*/
|
|
2133
|
-
export interface
|
|
2152
|
+
export interface ProductsApiListProductsRequest {
|
|
2134
2153
|
/**
|
|
2135
2154
|
* What project it is
|
|
2136
2155
|
* @type {string}
|
|
2137
|
-
* @memberof
|
|
2156
|
+
* @memberof ProductsApiListProducts
|
|
2138
2157
|
*/
|
|
2139
2158
|
readonly project: string;
|
|
2140
2159
|
/**
|
|
2141
2160
|
* Page reference token
|
|
2142
2161
|
* @type {number}
|
|
2143
|
-
* @memberof
|
|
2162
|
+
* @memberof ProductsApiListProducts
|
|
2144
2163
|
*/
|
|
2145
2164
|
readonly pageToken?: number;
|
|
2146
2165
|
/**
|
|
2147
|
-
* Search
|
|
2166
|
+
* 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.
|
|
2148
2167
|
* @type {string}
|
|
2149
|
-
* @memberof
|
|
2168
|
+
* @memberof ProductsApiListProducts
|
|
2150
2169
|
*/
|
|
2151
2170
|
readonly search?: string;
|
|
2152
2171
|
/**
|
|
2153
2172
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2154
2173
|
* @type {Array<string>}
|
|
2155
|
-
* @memberof
|
|
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
|
|
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
|
|
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
|
-
*
|
|
2251
|
-
* @summary
|
|
2252
|
-
* @param {
|
|
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
|
-
|
|
2257
|
+
importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportProducts200Response, any>>;
|
|
2258
2258
|
/**
|
|
2259
|
-
*
|
|
2260
|
-
* @summary
|
|
2261
|
-
* @param {
|
|
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
|
-
|
|
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
|
|
2296
|
+
* @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.
|
|
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
|
|
2324
|
+
* @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.
|
|
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
|
|
2393
|
+
* 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.
|
|
2394
2394
|
* @type {string}
|
|
2395
2395
|
* @memberof VariantsApiListVariants
|
|
2396
2396
|
*/
|
package/dist/api.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.
|
|
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).
|
|
@@ -213,7 +213,7 @@ const ApplicationSetsApiAxiosParamCreator = function (configuration) {
|
|
|
213
213
|
* @summary List application sets
|
|
214
214
|
* @param {string} project What project it is
|
|
215
215
|
* @param {number} [pageToken] Page reference token
|
|
216
|
-
* @param {string} [search] Search
|
|
216
|
+
* @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.
|
|
217
217
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
218
218
|
* @param {*} [options] Override http request option.
|
|
219
219
|
* @throws {RequiredError}
|
|
@@ -365,7 +365,7 @@ const ApplicationSetsApiFp = function (configuration) {
|
|
|
365
365
|
* @summary List application sets
|
|
366
366
|
* @param {string} project What project it is
|
|
367
367
|
* @param {number} [pageToken] Page reference token
|
|
368
|
-
* @param {string} [search] Search
|
|
368
|
+
* @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.
|
|
369
369
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
370
370
|
* @param {*} [options] Override http request option.
|
|
371
371
|
* @throws {RequiredError}
|
|
@@ -654,28 +654,24 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
654
654
|
};
|
|
655
655
|
}),
|
|
656
656
|
/**
|
|
657
|
-
*
|
|
658
|
-
* @summary
|
|
657
|
+
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
658
|
+
* @summary Import products
|
|
659
659
|
* @param {string} project What project it is
|
|
660
|
-
* @param {
|
|
661
|
-
* @param {string} [search] Search term to filter based on product tags.
|
|
662
|
-
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
663
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
664
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
660
|
+
* @param {string} [body] A data URL of a CSV file containing data for one or more products.
|
|
665
661
|
* @param {*} [options] Override http request option.
|
|
666
662
|
* @throws {RequiredError}
|
|
667
663
|
*/
|
|
668
|
-
|
|
664
|
+
importProducts: (project_1, body_1, ...args_1) => __awaiter(this, [project_1, body_1, ...args_1], void 0, function* (project, body, options = {}) {
|
|
669
665
|
// verify required parameter 'project' is not null or undefined
|
|
670
|
-
(0, common_1.assertParamExists)('
|
|
671
|
-
const localVarPath = `/v1/catalog/products`;
|
|
666
|
+
(0, common_1.assertParamExists)('importProducts', 'project', project);
|
|
667
|
+
const localVarPath = `/v1/catalog/products/import`;
|
|
672
668
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
673
669
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
674
670
|
let baseOptions;
|
|
675
671
|
if (configuration) {
|
|
676
672
|
baseOptions = configuration.baseOptions;
|
|
677
673
|
}
|
|
678
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
674
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
679
675
|
const localVarHeaderParameter = {};
|
|
680
676
|
const localVarQueryParameter = {};
|
|
681
677
|
// authentication session-oauth required
|
|
@@ -686,48 +682,39 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
686
682
|
if (project !== undefined) {
|
|
687
683
|
localVarQueryParameter['project'] = project;
|
|
688
684
|
}
|
|
689
|
-
|
|
690
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
691
|
-
}
|
|
692
|
-
if (search !== undefined) {
|
|
693
|
-
localVarQueryParameter['search'] = search;
|
|
694
|
-
}
|
|
695
|
-
if (sortBy) {
|
|
696
|
-
localVarQueryParameter['sortBy'] = sortBy;
|
|
697
|
-
}
|
|
698
|
-
if (pageSize !== undefined) {
|
|
699
|
-
localVarQueryParameter['pageSize'] = pageSize;
|
|
700
|
-
}
|
|
701
|
-
if (fields !== undefined) {
|
|
702
|
-
localVarQueryParameter['fields'] = fields;
|
|
703
|
-
}
|
|
685
|
+
localVarHeaderParameter['Content-Type'] = 'text/csv';
|
|
704
686
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
705
687
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
706
688
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
689
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
|
|
707
690
|
return {
|
|
708
691
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
709
692
|
options: localVarRequestOptions,
|
|
710
693
|
};
|
|
711
694
|
}),
|
|
712
695
|
/**
|
|
713
|
-
*
|
|
714
|
-
* @summary
|
|
696
|
+
* Lists all store listing products attached to the given project.
|
|
697
|
+
* @summary List products
|
|
715
698
|
* @param {string} project What project it is
|
|
716
|
-
* @param {
|
|
699
|
+
* @param {number} [pageToken] Page reference token
|
|
700
|
+
* @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.
|
|
701
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
702
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
703
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
717
704
|
* @param {*} [options] Override http request option.
|
|
718
705
|
* @throws {RequiredError}
|
|
719
706
|
*/
|
|
720
|
-
|
|
707
|
+
listProducts: (project_1, pageToken_1, search_1, sortBy_1, pageSize_1, fields_1, ...args_1) => __awaiter(this, [project_1, pageToken_1, search_1, sortBy_1, pageSize_1, fields_1, ...args_1], void 0, function* (project, pageToken, search, sortBy, pageSize, fields, options = {}) {
|
|
721
708
|
// verify required parameter 'project' is not null or undefined
|
|
722
|
-
(0, common_1.assertParamExists)('
|
|
723
|
-
const localVarPath = `/v1/catalog/products
|
|
709
|
+
(0, common_1.assertParamExists)('listProducts', 'project', project);
|
|
710
|
+
const localVarPath = `/v1/catalog/products`;
|
|
724
711
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
725
712
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
726
713
|
let baseOptions;
|
|
727
714
|
if (configuration) {
|
|
728
715
|
baseOptions = configuration.baseOptions;
|
|
729
716
|
}
|
|
730
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
717
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
731
718
|
const localVarHeaderParameter = {};
|
|
732
719
|
const localVarQueryParameter = {};
|
|
733
720
|
// authentication session-oauth required
|
|
@@ -738,11 +725,24 @@ const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
738
725
|
if (project !== undefined) {
|
|
739
726
|
localVarQueryParameter['project'] = project;
|
|
740
727
|
}
|
|
741
|
-
|
|
728
|
+
if (pageToken !== undefined) {
|
|
729
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
730
|
+
}
|
|
731
|
+
if (search !== undefined) {
|
|
732
|
+
localVarQueryParameter['search'] = search;
|
|
733
|
+
}
|
|
734
|
+
if (sortBy) {
|
|
735
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
736
|
+
}
|
|
737
|
+
if (pageSize !== undefined) {
|
|
738
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
739
|
+
}
|
|
740
|
+
if (fields !== undefined) {
|
|
741
|
+
localVarQueryParameter['fields'] = fields;
|
|
742
|
+
}
|
|
742
743
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
743
744
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
744
745
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
745
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
|
|
746
746
|
return {
|
|
747
747
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
748
748
|
options: localVarRequestOptions,
|
|
@@ -854,40 +854,40 @@ const ProductsApiFp = function (configuration) {
|
|
|
854
854
|
});
|
|
855
855
|
},
|
|
856
856
|
/**
|
|
857
|
-
*
|
|
858
|
-
* @summary
|
|
857
|
+
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
858
|
+
* @summary Import products
|
|
859
859
|
* @param {string} project What project it is
|
|
860
|
-
* @param {
|
|
861
|
-
* @param {string} [search] Search term to filter based on product tags.
|
|
862
|
-
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
863
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
864
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
860
|
+
* @param {string} [body] A data URL of a CSV file containing data for one or more products.
|
|
865
861
|
* @param {*} [options] Override http request option.
|
|
866
862
|
* @throws {RequiredError}
|
|
867
863
|
*/
|
|
868
|
-
|
|
864
|
+
importProducts(project, body, options) {
|
|
869
865
|
return __awaiter(this, void 0, void 0, function* () {
|
|
870
866
|
var _a, _b, _c;
|
|
871
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
867
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.importProducts(project, body, options);
|
|
872
868
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
873
|
-
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductsApi.
|
|
869
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductsApi.importProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
874
870
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
875
871
|
});
|
|
876
872
|
},
|
|
877
873
|
/**
|
|
878
|
-
*
|
|
879
|
-
* @summary
|
|
874
|
+
* Lists all store listing products attached to the given project.
|
|
875
|
+
* @summary List products
|
|
880
876
|
* @param {string} project What project it is
|
|
881
|
-
* @param {
|
|
877
|
+
* @param {number} [pageToken] Page reference token
|
|
878
|
+
* @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.
|
|
879
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
880
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
881
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
882
882
|
* @param {*} [options] Override http request option.
|
|
883
883
|
* @throws {RequiredError}
|
|
884
884
|
*/
|
|
885
|
-
|
|
885
|
+
listProducts(project, pageToken, search, sortBy, pageSize, fields, options) {
|
|
886
886
|
return __awaiter(this, void 0, void 0, function* () {
|
|
887
887
|
var _a, _b, _c;
|
|
888
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
888
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, pageSize, fields, options);
|
|
889
889
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
890
|
-
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductsApi.
|
|
890
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductsApi.listProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
891
891
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
892
892
|
});
|
|
893
893
|
},
|
|
@@ -949,16 +949,6 @@ const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
949
949
|
getProduct(requestParameters, options) {
|
|
950
950
|
return localVarFp.getProduct(requestParameters.project, requestParameters.productId, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
951
951
|
},
|
|
952
|
-
/**
|
|
953
|
-
* Lists all enabled store listing products attached to the given project.
|
|
954
|
-
* @summary List products
|
|
955
|
-
* @param {ProductsApiGetProductsRequest} requestParameters Request parameters.
|
|
956
|
-
* @param {*} [options] Override http request option.
|
|
957
|
-
* @throws {RequiredError}
|
|
958
|
-
*/
|
|
959
|
-
getProducts(requestParameters, options) {
|
|
960
|
-
return localVarFp.getProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
961
|
-
},
|
|
962
952
|
/**
|
|
963
953
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
964
954
|
* @summary Import products
|
|
@@ -969,6 +959,16 @@ const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
969
959
|
importProducts(requestParameters, options) {
|
|
970
960
|
return localVarFp.importProducts(requestParameters.project, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
971
961
|
},
|
|
962
|
+
/**
|
|
963
|
+
* Lists all store listing products attached to the given project.
|
|
964
|
+
* @summary List products
|
|
965
|
+
* @param {ProductsApiListProductsRequest} requestParameters Request parameters.
|
|
966
|
+
* @param {*} [options] Override http request option.
|
|
967
|
+
* @throws {RequiredError}
|
|
968
|
+
*/
|
|
969
|
+
listProducts(requestParameters, options) {
|
|
970
|
+
return localVarFp.listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
971
|
+
},
|
|
972
972
|
/**
|
|
973
973
|
* Updates a product by a given ID.
|
|
974
974
|
* @summary Update product
|
|
@@ -1023,26 +1023,26 @@ class ProductsApi extends base_1.BaseAPI {
|
|
|
1023
1023
|
return (0, exports.ProductsApiFp)(this.configuration).getProduct(requestParameters.project, requestParameters.productId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
1024
1024
|
}
|
|
1025
1025
|
/**
|
|
1026
|
-
*
|
|
1027
|
-
* @summary
|
|
1028
|
-
* @param {
|
|
1026
|
+
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
1027
|
+
* @summary Import products
|
|
1028
|
+
* @param {ProductsApiImportProductsRequest} requestParameters Request parameters.
|
|
1029
1029
|
* @param {*} [options] Override http request option.
|
|
1030
1030
|
* @throws {RequiredError}
|
|
1031
1031
|
* @memberof ProductsApi
|
|
1032
1032
|
*/
|
|
1033
|
-
|
|
1034
|
-
return (0, exports.ProductsApiFp)(this.configuration).
|
|
1033
|
+
importProducts(requestParameters, options) {
|
|
1034
|
+
return (0, exports.ProductsApiFp)(this.configuration).importProducts(requestParameters.project, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
1035
1035
|
}
|
|
1036
1036
|
/**
|
|
1037
|
-
*
|
|
1038
|
-
* @summary
|
|
1039
|
-
* @param {
|
|
1037
|
+
* Lists all store listing products attached to the given project.
|
|
1038
|
+
* @summary List products
|
|
1039
|
+
* @param {ProductsApiListProductsRequest} requestParameters Request parameters.
|
|
1040
1040
|
* @param {*} [options] Override http request option.
|
|
1041
1041
|
* @throws {RequiredError}
|
|
1042
1042
|
* @memberof ProductsApi
|
|
1043
1043
|
*/
|
|
1044
|
-
|
|
1045
|
-
return (0, exports.ProductsApiFp)(this.configuration).
|
|
1044
|
+
listProducts(requestParameters, options) {
|
|
1045
|
+
return (0, exports.ProductsApiFp)(this.configuration).listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
1046
1046
|
}
|
|
1047
1047
|
/**
|
|
1048
1048
|
* Updates a product by a given ID.
|
|
@@ -1111,7 +1111,7 @@ const VariantsApiAxiosParamCreator = function (configuration) {
|
|
|
1111
1111
|
* Lists all variants that belong to enabled products attached to the given project.
|
|
1112
1112
|
* @summary List variants
|
|
1113
1113
|
* @param {string} project What project it is
|
|
1114
|
-
* @param {string} [search] Search
|
|
1114
|
+
* @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.
|
|
1115
1115
|
* @param {number} [pageToken] Page reference token
|
|
1116
1116
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1117
1117
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
@@ -1191,7 +1191,7 @@ const VariantsApiFp = function (configuration) {
|
|
|
1191
1191
|
* Lists all variants that belong to enabled products attached to the given project.
|
|
1192
1192
|
* @summary List variants
|
|
1193
1193
|
* @param {string} project What project it is
|
|
1194
|
-
* @param {string} [search] Search
|
|
1194
|
+
* @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.
|
|
1195
1195
|
* @param {number} [pageToken] Page reference token
|
|
1196
1196
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1197
1197
|
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
package/dist/base.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.
|
|
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/base.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.
|
|
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).
|