@teemill/product-catalog 1.33.1 → 1.35.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 +138 -108
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +8 -2
- package/dist/api.d.ts +97 -67
- package/dist/api.js +72 -72
- 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 +3 -2
- package/dist/esm/api.d.ts +97 -67
- package/dist/esm/api.js +72 -72
- 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 +3 -2
- 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/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.
|
|
5
|
+
* The version of the OpenAPI document: 1.35.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -523,6 +523,12 @@ export interface CreateProductRequest {
|
|
|
523
523
|
* @memberof CreateProductRequest
|
|
524
524
|
*/
|
|
525
525
|
'includeInDataFeeds'?: boolean;
|
|
526
|
+
/**
|
|
527
|
+
* For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one.
|
|
528
|
+
* @type {number}
|
|
529
|
+
* @memberof CreateProductRequest
|
|
530
|
+
*/
|
|
531
|
+
'shopifyId'?: number;
|
|
526
532
|
/**
|
|
527
533
|
* Key/value pairs that can be used to store additional information about the product
|
|
528
534
|
* @type {Array<MetaField>}
|
|
@@ -642,6 +648,12 @@ export interface CreateProductVariant {
|
|
|
642
648
|
* @memberof CreateProductVariant
|
|
643
649
|
*/
|
|
644
650
|
'applicationSets'?: Array<string>;
|
|
651
|
+
/**
|
|
652
|
+
* For use with the Shopify integration. Use this to provide a Shopify variant ID to link to an existing Shopify variant rather than creating a new one.
|
|
653
|
+
* @type {number}
|
|
654
|
+
* @memberof CreateProductVariant
|
|
655
|
+
*/
|
|
656
|
+
'shopifyId'?: number;
|
|
645
657
|
}
|
|
646
658
|
/**
|
|
647
659
|
*
|
|
@@ -1011,6 +1023,12 @@ export interface Product {
|
|
|
1011
1023
|
* @memberof Product
|
|
1012
1024
|
*/
|
|
1013
1025
|
'includeInDataFeeds'?: boolean;
|
|
1026
|
+
/**
|
|
1027
|
+
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
1028
|
+
* @type {number}
|
|
1029
|
+
* @memberof Product
|
|
1030
|
+
*/
|
|
1031
|
+
'shopifyId'?: number;
|
|
1014
1032
|
/**
|
|
1015
1033
|
*
|
|
1016
1034
|
* @type {ProductWarehouseProduct}
|
|
@@ -1346,6 +1364,12 @@ export interface UpdateProductRequest {
|
|
|
1346
1364
|
* @memberof UpdateProductRequest
|
|
1347
1365
|
*/
|
|
1348
1366
|
'includeInDataFeeds'?: boolean;
|
|
1367
|
+
/**
|
|
1368
|
+
* For use with the Shopify integration. Use this to provide a Shopify product ID to link to an existing Shopify product rather than creating a new one.
|
|
1369
|
+
* @type {number}
|
|
1370
|
+
* @memberof UpdateProductRequest
|
|
1371
|
+
*/
|
|
1372
|
+
'shopifyId'?: number;
|
|
1349
1373
|
/**
|
|
1350
1374
|
* Key/value pairs that can be used to store additional information about the product
|
|
1351
1375
|
* @type {Array<MetaField>}
|
|
@@ -1455,6 +1479,12 @@ export interface Variant {
|
|
|
1455
1479
|
* @memberof Variant
|
|
1456
1480
|
*/
|
|
1457
1481
|
'gtin'?: string | null;
|
|
1482
|
+
/**
|
|
1483
|
+
* For use with the Shopify integration. The Shopify variant ID that this variant is linked to.
|
|
1484
|
+
* @type {number}
|
|
1485
|
+
* @memberof Variant
|
|
1486
|
+
*/
|
|
1487
|
+
'shopifyId'?: number;
|
|
1458
1488
|
/**
|
|
1459
1489
|
* Key/value pairs that can be used to store additional information about the variant
|
|
1460
1490
|
* @type {Array<MetaField>}
|
|
@@ -1910,7 +1940,16 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1910
1940
|
*/
|
|
1911
1941
|
getProduct: (project: string, productId: string, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1912
1942
|
/**
|
|
1913
|
-
*
|
|
1943
|
+
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
1944
|
+
* @summary Import products
|
|
1945
|
+
* @param {string} project What project it is
|
|
1946
|
+
* @param {string} [body] A data URL of a CSV file containing data for one or more products.
|
|
1947
|
+
* @param {*} [options] Override http request option.
|
|
1948
|
+
* @throws {RequiredError}
|
|
1949
|
+
*/
|
|
1950
|
+
importProducts: (project: string, body?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1951
|
+
/**
|
|
1952
|
+
* Lists all store listing products attached to the given project.
|
|
1914
1953
|
* @summary List products
|
|
1915
1954
|
* @param {string} project What project it is
|
|
1916
1955
|
* @param {number} [pageToken] Page reference token
|
|
@@ -1921,16 +1960,7 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
1921
1960
|
* @param {*} [options] Override http request option.
|
|
1922
1961
|
* @throws {RequiredError}
|
|
1923
1962
|
*/
|
|
1924
|
-
|
|
1925
|
-
/**
|
|
1926
|
-
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
1927
|
-
* @summary Import products
|
|
1928
|
-
* @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.
|
|
1930
|
-
* @param {*} [options] Override http request option.
|
|
1931
|
-
* @throws {RequiredError}
|
|
1932
|
-
*/
|
|
1933
|
-
importProducts: (project: string, body?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1963
|
+
listProducts: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1934
1964
|
/**
|
|
1935
1965
|
* Updates a product by a given ID.
|
|
1936
1966
|
* @summary Update product
|
|
@@ -1976,7 +2006,16 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
1976
2006
|
*/
|
|
1977
2007
|
getProduct(project: string, productId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>>;
|
|
1978
2008
|
/**
|
|
1979
|
-
*
|
|
2009
|
+
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
2010
|
+
* @summary Import products
|
|
2011
|
+
* @param {string} project What project it is
|
|
2012
|
+
* @param {string} [body] A data URL of a CSV file containing data for one or more products.
|
|
2013
|
+
* @param {*} [options] Override http request option.
|
|
2014
|
+
* @throws {RequiredError}
|
|
2015
|
+
*/
|
|
2016
|
+
importProducts(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportProducts200Response>>;
|
|
2017
|
+
/**
|
|
2018
|
+
* Lists all store listing products attached to the given project.
|
|
1980
2019
|
* @summary List products
|
|
1981
2020
|
* @param {string} project What project it is
|
|
1982
2021
|
* @param {number} [pageToken] Page reference token
|
|
@@ -1987,16 +2026,7 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
1987
2026
|
* @param {*} [options] Override http request option.
|
|
1988
2027
|
* @throws {RequiredError}
|
|
1989
2028
|
*/
|
|
1990
|
-
|
|
1991
|
-
/**
|
|
1992
|
-
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
1993
|
-
* @summary Import products
|
|
1994
|
-
* @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.
|
|
1996
|
-
* @param {*} [options] Override http request option.
|
|
1997
|
-
* @throws {RequiredError}
|
|
1998
|
-
*/
|
|
1999
|
-
importProducts(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportProducts200Response>>;
|
|
2029
|
+
listProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>>;
|
|
2000
2030
|
/**
|
|
2001
2031
|
* Updates a product by a given ID.
|
|
2002
2032
|
* @summary Update product
|
|
@@ -2037,14 +2067,6 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
2037
2067
|
* @throws {RequiredError}
|
|
2038
2068
|
*/
|
|
2039
2069
|
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
2070
|
/**
|
|
2049
2071
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
2050
2072
|
* @summary Import products
|
|
@@ -2053,6 +2075,14 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
2053
2075
|
* @throws {RequiredError}
|
|
2054
2076
|
*/
|
|
2055
2077
|
importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImportProducts200Response>;
|
|
2078
|
+
/**
|
|
2079
|
+
* Lists all store listing products attached to the given project.
|
|
2080
|
+
* @summary List products
|
|
2081
|
+
* @param {ProductsApiListProductsRequest} requestParameters Request parameters.
|
|
2082
|
+
* @param {*} [options] Override http request option.
|
|
2083
|
+
* @throws {RequiredError}
|
|
2084
|
+
*/
|
|
2085
|
+
listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse>;
|
|
2056
2086
|
/**
|
|
2057
2087
|
* Updates a product by a given ID.
|
|
2058
2088
|
* @summary Update product
|
|
@@ -2126,67 +2156,67 @@ export interface ProductsApiGetProductRequest {
|
|
|
2126
2156
|
readonly fields?: string;
|
|
2127
2157
|
}
|
|
2128
2158
|
/**
|
|
2129
|
-
* Request parameters for
|
|
2159
|
+
* Request parameters for importProducts operation in ProductsApi.
|
|
2130
2160
|
* @export
|
|
2131
|
-
* @interface
|
|
2161
|
+
* @interface ProductsApiImportProductsRequest
|
|
2132
2162
|
*/
|
|
2133
|
-
export interface
|
|
2163
|
+
export interface ProductsApiImportProductsRequest {
|
|
2134
2164
|
/**
|
|
2135
2165
|
* What project it is
|
|
2136
2166
|
* @type {string}
|
|
2137
|
-
* @memberof
|
|
2167
|
+
* @memberof ProductsApiImportProducts
|
|
2168
|
+
*/
|
|
2169
|
+
readonly project: string;
|
|
2170
|
+
/**
|
|
2171
|
+
* A data URL of a CSV file containing data for one or more products.
|
|
2172
|
+
* @type {string}
|
|
2173
|
+
* @memberof ProductsApiImportProducts
|
|
2174
|
+
*/
|
|
2175
|
+
readonly body?: string;
|
|
2176
|
+
}
|
|
2177
|
+
/**
|
|
2178
|
+
* Request parameters for listProducts operation in ProductsApi.
|
|
2179
|
+
* @export
|
|
2180
|
+
* @interface ProductsApiListProductsRequest
|
|
2181
|
+
*/
|
|
2182
|
+
export interface ProductsApiListProductsRequest {
|
|
2183
|
+
/**
|
|
2184
|
+
* What project it is
|
|
2185
|
+
* @type {string}
|
|
2186
|
+
* @memberof ProductsApiListProducts
|
|
2138
2187
|
*/
|
|
2139
2188
|
readonly project: string;
|
|
2140
2189
|
/**
|
|
2141
2190
|
* Page reference token
|
|
2142
2191
|
* @type {number}
|
|
2143
|
-
* @memberof
|
|
2192
|
+
* @memberof ProductsApiListProducts
|
|
2144
2193
|
*/
|
|
2145
2194
|
readonly pageToken?: number;
|
|
2146
2195
|
/**
|
|
2147
2196
|
* 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
2197
|
* @type {string}
|
|
2149
|
-
* @memberof
|
|
2198
|
+
* @memberof ProductsApiListProducts
|
|
2150
2199
|
*/
|
|
2151
2200
|
readonly search?: string;
|
|
2152
2201
|
/**
|
|
2153
2202
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2154
2203
|
* @type {Array<string>}
|
|
2155
|
-
* @memberof
|
|
2204
|
+
* @memberof ProductsApiListProducts
|
|
2156
2205
|
*/
|
|
2157
2206
|
readonly sortBy?: Array<string>;
|
|
2158
2207
|
/**
|
|
2159
2208
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2160
2209
|
* @type {number}
|
|
2161
|
-
* @memberof
|
|
2210
|
+
* @memberof ProductsApiListProducts
|
|
2162
2211
|
*/
|
|
2163
2212
|
readonly pageSize?: number;
|
|
2164
2213
|
/**
|
|
2165
2214
|
* Filter response fields to only include a subset of the resource.
|
|
2166
2215
|
* @type {string}
|
|
2167
|
-
* @memberof
|
|
2216
|
+
* @memberof ProductsApiListProducts
|
|
2168
2217
|
*/
|
|
2169
2218
|
readonly fields?: string;
|
|
2170
2219
|
}
|
|
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
2220
|
/**
|
|
2191
2221
|
* Request parameters for updateProduct operation in ProductsApi.
|
|
2192
2222
|
* @export
|
|
@@ -2247,23 +2277,23 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
2247
2277
|
*/
|
|
2248
2278
|
getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
2249
2279
|
/**
|
|
2250
|
-
*
|
|
2251
|
-
* @summary
|
|
2252
|
-
* @param {
|
|
2280
|
+
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
2281
|
+
* @summary Import products
|
|
2282
|
+
* @param {ProductsApiImportProductsRequest} requestParameters Request parameters.
|
|
2253
2283
|
* @param {*} [options] Override http request option.
|
|
2254
2284
|
* @throws {RequiredError}
|
|
2255
2285
|
* @memberof ProductsApi
|
|
2256
2286
|
*/
|
|
2257
|
-
|
|
2287
|
+
importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportProducts200Response, any>>;
|
|
2258
2288
|
/**
|
|
2259
|
-
*
|
|
2260
|
-
* @summary
|
|
2261
|
-
* @param {
|
|
2289
|
+
* Lists all store listing products attached to the given project.
|
|
2290
|
+
* @summary List products
|
|
2291
|
+
* @param {ProductsApiListProductsRequest} requestParameters Request parameters.
|
|
2262
2292
|
* @param {*} [options] Override http request option.
|
|
2263
2293
|
* @throws {RequiredError}
|
|
2264
2294
|
* @memberof ProductsApi
|
|
2265
2295
|
*/
|
|
2266
|
-
|
|
2296
|
+
listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductsResponse, any>>;
|
|
2267
2297
|
/**
|
|
2268
2298
|
* Updates a product by a given ID.
|
|
2269
2299
|
* @summary Update product
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog API
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.35.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -647,28 +647,24 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
647
647
|
};
|
|
648
648
|
}),
|
|
649
649
|
/**
|
|
650
|
-
*
|
|
651
|
-
* @summary
|
|
650
|
+
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
651
|
+
* @summary Import products
|
|
652
652
|
* @param {string} project What project it is
|
|
653
|
-
* @param {
|
|
654
|
-
* @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.
|
|
655
|
-
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
656
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
657
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
653
|
+
* @param {string} [body] A data URL of a CSV file containing data for one or more products.
|
|
658
654
|
* @param {*} [options] Override http request option.
|
|
659
655
|
* @throws {RequiredError}
|
|
660
656
|
*/
|
|
661
|
-
|
|
657
|
+
importProducts: (project_1, body_1, ...args_1) => __awaiter(this, [project_1, body_1, ...args_1], void 0, function* (project, body, options = {}) {
|
|
662
658
|
// verify required parameter 'project' is not null or undefined
|
|
663
|
-
assertParamExists('
|
|
664
|
-
const localVarPath = `/v1/catalog/products`;
|
|
659
|
+
assertParamExists('importProducts', 'project', project);
|
|
660
|
+
const localVarPath = `/v1/catalog/products/import`;
|
|
665
661
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
666
662
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
667
663
|
let baseOptions;
|
|
668
664
|
if (configuration) {
|
|
669
665
|
baseOptions = configuration.baseOptions;
|
|
670
666
|
}
|
|
671
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
667
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
672
668
|
const localVarHeaderParameter = {};
|
|
673
669
|
const localVarQueryParameter = {};
|
|
674
670
|
// authentication session-oauth required
|
|
@@ -679,48 +675,39 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
679
675
|
if (project !== undefined) {
|
|
680
676
|
localVarQueryParameter['project'] = project;
|
|
681
677
|
}
|
|
682
|
-
|
|
683
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
684
|
-
}
|
|
685
|
-
if (search !== undefined) {
|
|
686
|
-
localVarQueryParameter['search'] = search;
|
|
687
|
-
}
|
|
688
|
-
if (sortBy) {
|
|
689
|
-
localVarQueryParameter['sortBy'] = sortBy;
|
|
690
|
-
}
|
|
691
|
-
if (pageSize !== undefined) {
|
|
692
|
-
localVarQueryParameter['pageSize'] = pageSize;
|
|
693
|
-
}
|
|
694
|
-
if (fields !== undefined) {
|
|
695
|
-
localVarQueryParameter['fields'] = fields;
|
|
696
|
-
}
|
|
678
|
+
localVarHeaderParameter['Content-Type'] = 'text/csv';
|
|
697
679
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
698
680
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
699
681
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
682
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
700
683
|
return {
|
|
701
684
|
url: toPathString(localVarUrlObj),
|
|
702
685
|
options: localVarRequestOptions,
|
|
703
686
|
};
|
|
704
687
|
}),
|
|
705
688
|
/**
|
|
706
|
-
*
|
|
707
|
-
* @summary
|
|
689
|
+
* Lists all store listing products attached to the given project.
|
|
690
|
+
* @summary List products
|
|
708
691
|
* @param {string} project What project it is
|
|
709
|
-
* @param {
|
|
692
|
+
* @param {number} [pageToken] Page reference token
|
|
693
|
+
* @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.
|
|
694
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
695
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
696
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
710
697
|
* @param {*} [options] Override http request option.
|
|
711
698
|
* @throws {RequiredError}
|
|
712
699
|
*/
|
|
713
|
-
|
|
700
|
+
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 = {}) {
|
|
714
701
|
// verify required parameter 'project' is not null or undefined
|
|
715
|
-
assertParamExists('
|
|
716
|
-
const localVarPath = `/v1/catalog/products
|
|
702
|
+
assertParamExists('listProducts', 'project', project);
|
|
703
|
+
const localVarPath = `/v1/catalog/products`;
|
|
717
704
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
718
705
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
719
706
|
let baseOptions;
|
|
720
707
|
if (configuration) {
|
|
721
708
|
baseOptions = configuration.baseOptions;
|
|
722
709
|
}
|
|
723
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: '
|
|
710
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
724
711
|
const localVarHeaderParameter = {};
|
|
725
712
|
const localVarQueryParameter = {};
|
|
726
713
|
// authentication session-oauth required
|
|
@@ -731,11 +718,24 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
731
718
|
if (project !== undefined) {
|
|
732
719
|
localVarQueryParameter['project'] = project;
|
|
733
720
|
}
|
|
734
|
-
|
|
721
|
+
if (pageToken !== undefined) {
|
|
722
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
723
|
+
}
|
|
724
|
+
if (search !== undefined) {
|
|
725
|
+
localVarQueryParameter['search'] = search;
|
|
726
|
+
}
|
|
727
|
+
if (sortBy) {
|
|
728
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
729
|
+
}
|
|
730
|
+
if (pageSize !== undefined) {
|
|
731
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
732
|
+
}
|
|
733
|
+
if (fields !== undefined) {
|
|
734
|
+
localVarQueryParameter['fields'] = fields;
|
|
735
|
+
}
|
|
735
736
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
736
737
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
737
738
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
738
|
-
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
739
739
|
return {
|
|
740
740
|
url: toPathString(localVarUrlObj),
|
|
741
741
|
options: localVarRequestOptions,
|
|
@@ -846,40 +846,40 @@ export const ProductsApiFp = function (configuration) {
|
|
|
846
846
|
});
|
|
847
847
|
},
|
|
848
848
|
/**
|
|
849
|
-
*
|
|
850
|
-
* @summary
|
|
849
|
+
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
850
|
+
* @summary Import products
|
|
851
851
|
* @param {string} project What project it is
|
|
852
|
-
* @param {
|
|
853
|
-
* @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.
|
|
854
|
-
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
855
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
856
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
852
|
+
* @param {string} [body] A data URL of a CSV file containing data for one or more products.
|
|
857
853
|
* @param {*} [options] Override http request option.
|
|
858
854
|
* @throws {RequiredError}
|
|
859
855
|
*/
|
|
860
|
-
|
|
856
|
+
importProducts(project, body, options) {
|
|
861
857
|
return __awaiter(this, void 0, void 0, function* () {
|
|
862
858
|
var _a, _b, _c;
|
|
863
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
859
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.importProducts(project, body, options);
|
|
864
860
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
865
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductsApi.
|
|
861
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductsApi.importProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
866
862
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
867
863
|
});
|
|
868
864
|
},
|
|
869
865
|
/**
|
|
870
|
-
*
|
|
871
|
-
* @summary
|
|
866
|
+
* Lists all store listing products attached to the given project.
|
|
867
|
+
* @summary List products
|
|
872
868
|
* @param {string} project What project it is
|
|
873
|
-
* @param {
|
|
869
|
+
* @param {number} [pageToken] Page reference token
|
|
870
|
+
* @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.
|
|
871
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
872
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
873
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
874
874
|
* @param {*} [options] Override http request option.
|
|
875
875
|
* @throws {RequiredError}
|
|
876
876
|
*/
|
|
877
|
-
|
|
877
|
+
listProducts(project, pageToken, search, sortBy, pageSize, fields, options) {
|
|
878
878
|
return __awaiter(this, void 0, void 0, function* () {
|
|
879
879
|
var _a, _b, _c;
|
|
880
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
880
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, pageSize, fields, options);
|
|
881
881
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
882
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductsApi.
|
|
882
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductsApi.listProducts']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
883
883
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
884
884
|
});
|
|
885
885
|
},
|
|
@@ -940,16 +940,6 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
940
940
|
getProduct(requestParameters, options) {
|
|
941
941
|
return localVarFp.getProduct(requestParameters.project, requestParameters.productId, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
942
942
|
},
|
|
943
|
-
/**
|
|
944
|
-
* Lists all enabled store listing products attached to the given project.
|
|
945
|
-
* @summary List products
|
|
946
|
-
* @param {ProductsApiGetProductsRequest} requestParameters Request parameters.
|
|
947
|
-
* @param {*} [options] Override http request option.
|
|
948
|
-
* @throws {RequiredError}
|
|
949
|
-
*/
|
|
950
|
-
getProducts(requestParameters, options) {
|
|
951
|
-
return localVarFp.getProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
952
|
-
},
|
|
953
943
|
/**
|
|
954
944
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
955
945
|
* @summary Import products
|
|
@@ -960,6 +950,16 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
960
950
|
importProducts(requestParameters, options) {
|
|
961
951
|
return localVarFp.importProducts(requestParameters.project, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
962
952
|
},
|
|
953
|
+
/**
|
|
954
|
+
* Lists all store listing products attached to the given project.
|
|
955
|
+
* @summary List products
|
|
956
|
+
* @param {ProductsApiListProductsRequest} requestParameters Request parameters.
|
|
957
|
+
* @param {*} [options] Override http request option.
|
|
958
|
+
* @throws {RequiredError}
|
|
959
|
+
*/
|
|
960
|
+
listProducts(requestParameters, options) {
|
|
961
|
+
return localVarFp.listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
962
|
+
},
|
|
963
963
|
/**
|
|
964
964
|
* Updates a product by a given ID.
|
|
965
965
|
* @summary Update product
|
|
@@ -1013,26 +1013,26 @@ export class ProductsApi extends BaseAPI {
|
|
|
1013
1013
|
return ProductsApiFp(this.configuration).getProduct(requestParameters.project, requestParameters.productId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
1014
1014
|
}
|
|
1015
1015
|
/**
|
|
1016
|
-
*
|
|
1017
|
-
* @summary
|
|
1018
|
-
* @param {
|
|
1016
|
+
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
1017
|
+
* @summary Import products
|
|
1018
|
+
* @param {ProductsApiImportProductsRequest} requestParameters Request parameters.
|
|
1019
1019
|
* @param {*} [options] Override http request option.
|
|
1020
1020
|
* @throws {RequiredError}
|
|
1021
1021
|
* @memberof ProductsApi
|
|
1022
1022
|
*/
|
|
1023
|
-
|
|
1024
|
-
return ProductsApiFp(this.configuration).
|
|
1023
|
+
importProducts(requestParameters, options) {
|
|
1024
|
+
return ProductsApiFp(this.configuration).importProducts(requestParameters.project, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
1025
1025
|
}
|
|
1026
1026
|
/**
|
|
1027
|
-
*
|
|
1028
|
-
* @summary
|
|
1029
|
-
* @param {
|
|
1027
|
+
* Lists all store listing products attached to the given project.
|
|
1028
|
+
* @summary List products
|
|
1029
|
+
* @param {ProductsApiListProductsRequest} requestParameters Request parameters.
|
|
1030
1030
|
* @param {*} [options] Override http request option.
|
|
1031
1031
|
* @throws {RequiredError}
|
|
1032
1032
|
* @memberof ProductsApi
|
|
1033
1033
|
*/
|
|
1034
|
-
|
|
1035
|
-
return ProductsApiFp(this.configuration).
|
|
1034
|
+
listProducts(requestParameters, options) {
|
|
1035
|
+
return ProductsApiFp(this.configuration).listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
1036
1036
|
}
|
|
1037
1037
|
/**
|
|
1038
1038
|
* Updates a product by a given ID.
|
package/dist/esm/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.35.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog API
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.35.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/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.
|
|
5
|
+
* The version of the OpenAPI document: 1.35.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog API
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.35.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* 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.
|
|
5
|
+
* The version of the OpenAPI document: 1.35.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog API
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.35.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -13,13 +13,14 @@
|
|
|
13
13
|
*/
|
|
14
14
|
export class Configuration {
|
|
15
15
|
constructor(param = {}) {
|
|
16
|
+
var _a;
|
|
16
17
|
this.apiKey = param.apiKey;
|
|
17
18
|
this.username = param.username;
|
|
18
19
|
this.password = param.password;
|
|
19
20
|
this.accessToken = param.accessToken;
|
|
20
21
|
this.basePath = param.basePath;
|
|
21
22
|
this.serverIndex = param.serverIndex;
|
|
22
|
-
this.baseOptions = param.baseOptions;
|
|
23
|
+
this.baseOptions = Object.assign({ headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': "OpenAPI-Generator/1.35.0/typescript-axios" }) }, param.baseOptions);
|
|
23
24
|
this.formDataCtor = param.formDataCtor;
|
|
24
25
|
}
|
|
25
26
|
/**
|