@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/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/product-catalog@1.
|
|
1
|
+
## @teemill/product-catalog@1.35.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/product-catalog@1.
|
|
39
|
+
npm install @teemill/product-catalog@1.35.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
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).
|
|
@@ -544,6 +544,12 @@ export interface CreateProductRequest {
|
|
|
544
544
|
* @memberof CreateProductRequest
|
|
545
545
|
*/
|
|
546
546
|
'includeInDataFeeds'?: boolean;
|
|
547
|
+
/**
|
|
548
|
+
* 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.
|
|
549
|
+
* @type {number}
|
|
550
|
+
* @memberof CreateProductRequest
|
|
551
|
+
*/
|
|
552
|
+
'shopifyId'?: number;
|
|
547
553
|
/**
|
|
548
554
|
* Key/value pairs that can be used to store additional information about the product
|
|
549
555
|
* @type {Array<MetaField>}
|
|
@@ -663,6 +669,12 @@ export interface CreateProductVariant {
|
|
|
663
669
|
* @memberof CreateProductVariant
|
|
664
670
|
*/
|
|
665
671
|
'applicationSets'?: Array<string>;
|
|
672
|
+
/**
|
|
673
|
+
* 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.
|
|
674
|
+
* @type {number}
|
|
675
|
+
* @memberof CreateProductVariant
|
|
676
|
+
*/
|
|
677
|
+
'shopifyId'?: number;
|
|
666
678
|
}
|
|
667
679
|
/**
|
|
668
680
|
*
|
|
@@ -1044,6 +1056,12 @@ export interface Product {
|
|
|
1044
1056
|
* @memberof Product
|
|
1045
1057
|
*/
|
|
1046
1058
|
'includeInDataFeeds'?: boolean;
|
|
1059
|
+
/**
|
|
1060
|
+
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
1061
|
+
* @type {number}
|
|
1062
|
+
* @memberof Product
|
|
1063
|
+
*/
|
|
1064
|
+
'shopifyId'?: number;
|
|
1047
1065
|
/**
|
|
1048
1066
|
*
|
|
1049
1067
|
* @type {ProductWarehouseProduct}
|
|
@@ -1379,6 +1397,12 @@ export interface UpdateProductRequest {
|
|
|
1379
1397
|
* @memberof UpdateProductRequest
|
|
1380
1398
|
*/
|
|
1381
1399
|
'includeInDataFeeds'?: boolean;
|
|
1400
|
+
/**
|
|
1401
|
+
* 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.
|
|
1402
|
+
* @type {number}
|
|
1403
|
+
* @memberof UpdateProductRequest
|
|
1404
|
+
*/
|
|
1405
|
+
'shopifyId'?: number;
|
|
1382
1406
|
/**
|
|
1383
1407
|
* Key/value pairs that can be used to store additional information about the product
|
|
1384
1408
|
* @type {Array<MetaField>}
|
|
@@ -1488,6 +1512,12 @@ export interface Variant {
|
|
|
1488
1512
|
* @memberof Variant
|
|
1489
1513
|
*/
|
|
1490
1514
|
'gtin'?: string | null;
|
|
1515
|
+
/**
|
|
1516
|
+
* For use with the Shopify integration. The Shopify variant ID that this variant is linked to.
|
|
1517
|
+
* @type {number}
|
|
1518
|
+
* @memberof Variant
|
|
1519
|
+
*/
|
|
1520
|
+
'shopifyId'?: number;
|
|
1491
1521
|
/**
|
|
1492
1522
|
* Key/value pairs that can be used to store additional information about the variant
|
|
1493
1523
|
* @type {Array<MetaField>}
|
|
@@ -2349,21 +2379,17 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
2349
2379
|
};
|
|
2350
2380
|
},
|
|
2351
2381
|
/**
|
|
2352
|
-
*
|
|
2353
|
-
* @summary
|
|
2382
|
+
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
2383
|
+
* @summary Import products
|
|
2354
2384
|
* @param {string} project What project it is
|
|
2355
|
-
* @param {
|
|
2356
|
-
* @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.
|
|
2357
|
-
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2358
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2359
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
2385
|
+
* @param {string} [body] A data URL of a CSV file containing data for one or more products.
|
|
2360
2386
|
* @param {*} [options] Override http request option.
|
|
2361
2387
|
* @throws {RequiredError}
|
|
2362
2388
|
*/
|
|
2363
|
-
|
|
2389
|
+
importProducts: async (project: string, body?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2364
2390
|
// verify required parameter 'project' is not null or undefined
|
|
2365
|
-
assertParamExists('
|
|
2366
|
-
const localVarPath = `/v1/catalog/products`;
|
|
2391
|
+
assertParamExists('importProducts', 'project', project)
|
|
2392
|
+
const localVarPath = `/v1/catalog/products/import`;
|
|
2367
2393
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2368
2394
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2369
2395
|
let baseOptions;
|
|
@@ -2371,7 +2397,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
2371
2397
|
baseOptions = configuration.baseOptions;
|
|
2372
2398
|
}
|
|
2373
2399
|
|
|
2374
|
-
const localVarRequestOptions = { method: '
|
|
2400
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
2375
2401
|
const localVarHeaderParameter = {} as any;
|
|
2376
2402
|
const localVarQueryParameter = {} as any;
|
|
2377
2403
|
|
|
@@ -2386,31 +2412,14 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
2386
2412
|
localVarQueryParameter['project'] = project;
|
|
2387
2413
|
}
|
|
2388
2414
|
|
|
2389
|
-
if (pageToken !== undefined) {
|
|
2390
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
2391
|
-
}
|
|
2392
|
-
|
|
2393
|
-
if (search !== undefined) {
|
|
2394
|
-
localVarQueryParameter['search'] = search;
|
|
2395
|
-
}
|
|
2396
|
-
|
|
2397
|
-
if (sortBy) {
|
|
2398
|
-
localVarQueryParameter['sortBy'] = sortBy;
|
|
2399
|
-
}
|
|
2400
|
-
|
|
2401
|
-
if (pageSize !== undefined) {
|
|
2402
|
-
localVarQueryParameter['pageSize'] = pageSize;
|
|
2403
|
-
}
|
|
2404
|
-
|
|
2405
|
-
if (fields !== undefined) {
|
|
2406
|
-
localVarQueryParameter['fields'] = fields;
|
|
2407
|
-
}
|
|
2408
|
-
|
|
2409
2415
|
|
|
2410
2416
|
|
|
2417
|
+
localVarHeaderParameter['Content-Type'] = 'text/csv';
|
|
2418
|
+
|
|
2411
2419
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2412
2420
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2413
2421
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2422
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
|
|
2414
2423
|
|
|
2415
2424
|
return {
|
|
2416
2425
|
url: toPathString(localVarUrlObj),
|
|
@@ -2418,17 +2427,21 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
2418
2427
|
};
|
|
2419
2428
|
},
|
|
2420
2429
|
/**
|
|
2421
|
-
*
|
|
2422
|
-
* @summary
|
|
2430
|
+
* Lists all store listing products attached to the given project.
|
|
2431
|
+
* @summary List products
|
|
2423
2432
|
* @param {string} project What project it is
|
|
2424
|
-
* @param {
|
|
2433
|
+
* @param {number} [pageToken] Page reference token
|
|
2434
|
+
* @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.
|
|
2435
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2436
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2437
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
2425
2438
|
* @param {*} [options] Override http request option.
|
|
2426
2439
|
* @throws {RequiredError}
|
|
2427
2440
|
*/
|
|
2428
|
-
|
|
2441
|
+
listProducts: async (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2429
2442
|
// verify required parameter 'project' is not null or undefined
|
|
2430
|
-
assertParamExists('
|
|
2431
|
-
const localVarPath = `/v1/catalog/products
|
|
2443
|
+
assertParamExists('listProducts', 'project', project)
|
|
2444
|
+
const localVarPath = `/v1/catalog/products`;
|
|
2432
2445
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2433
2446
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2434
2447
|
let baseOptions;
|
|
@@ -2436,7 +2449,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
2436
2449
|
baseOptions = configuration.baseOptions;
|
|
2437
2450
|
}
|
|
2438
2451
|
|
|
2439
|
-
const localVarRequestOptions = { method: '
|
|
2452
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2440
2453
|
const localVarHeaderParameter = {} as any;
|
|
2441
2454
|
const localVarQueryParameter = {} as any;
|
|
2442
2455
|
|
|
@@ -2451,14 +2464,31 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
2451
2464
|
localVarQueryParameter['project'] = project;
|
|
2452
2465
|
}
|
|
2453
2466
|
|
|
2467
|
+
if (pageToken !== undefined) {
|
|
2468
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
2469
|
+
}
|
|
2470
|
+
|
|
2471
|
+
if (search !== undefined) {
|
|
2472
|
+
localVarQueryParameter['search'] = search;
|
|
2473
|
+
}
|
|
2454
2474
|
|
|
2455
|
-
|
|
2456
|
-
|
|
2475
|
+
if (sortBy) {
|
|
2476
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
2477
|
+
}
|
|
2478
|
+
|
|
2479
|
+
if (pageSize !== undefined) {
|
|
2480
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
2481
|
+
}
|
|
2482
|
+
|
|
2483
|
+
if (fields !== undefined) {
|
|
2484
|
+
localVarQueryParameter['fields'] = fields;
|
|
2485
|
+
}
|
|
2457
2486
|
|
|
2487
|
+
|
|
2488
|
+
|
|
2458
2489
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2459
2490
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2460
2491
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2461
|
-
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
|
|
2462
2492
|
|
|
2463
2493
|
return {
|
|
2464
2494
|
url: toPathString(localVarUrlObj),
|
|
@@ -2571,35 +2601,35 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
2571
2601
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2572
2602
|
},
|
|
2573
2603
|
/**
|
|
2574
|
-
*
|
|
2575
|
-
* @summary
|
|
2604
|
+
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
2605
|
+
* @summary Import products
|
|
2576
2606
|
* @param {string} project What project it is
|
|
2577
|
-
* @param {
|
|
2578
|
-
* @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.
|
|
2579
|
-
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2580
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2581
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
2607
|
+
* @param {string} [body] A data URL of a CSV file containing data for one or more products.
|
|
2582
2608
|
* @param {*} [options] Override http request option.
|
|
2583
2609
|
* @throws {RequiredError}
|
|
2584
2610
|
*/
|
|
2585
|
-
async
|
|
2586
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
2611
|
+
async importProducts(project: string, body?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportProducts200Response>> {
|
|
2612
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.importProducts(project, body, options);
|
|
2587
2613
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2588
|
-
const localVarOperationServerBasePath = operationServerMap['ProductsApi.
|
|
2614
|
+
const localVarOperationServerBasePath = operationServerMap['ProductsApi.importProducts']?.[localVarOperationServerIndex]?.url;
|
|
2589
2615
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2590
2616
|
},
|
|
2591
2617
|
/**
|
|
2592
|
-
*
|
|
2593
|
-
* @summary
|
|
2618
|
+
* Lists all store listing products attached to the given project.
|
|
2619
|
+
* @summary List products
|
|
2594
2620
|
* @param {string} project What project it is
|
|
2595
|
-
* @param {
|
|
2621
|
+
* @param {number} [pageToken] Page reference token
|
|
2622
|
+
* @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.
|
|
2623
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2624
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2625
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
2596
2626
|
* @param {*} [options] Override http request option.
|
|
2597
2627
|
* @throws {RequiredError}
|
|
2598
2628
|
*/
|
|
2599
|
-
async
|
|
2600
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
2629
|
+
async listProducts(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>> {
|
|
2630
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProducts(project, pageToken, search, sortBy, pageSize, fields, options);
|
|
2601
2631
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2602
|
-
const localVarOperationServerBasePath = operationServerMap['ProductsApi.
|
|
2632
|
+
const localVarOperationServerBasePath = operationServerMap['ProductsApi.listProducts']?.[localVarOperationServerIndex]?.url;
|
|
2603
2633
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2604
2634
|
},
|
|
2605
2635
|
/**
|
|
@@ -2657,16 +2687,6 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
2657
2687
|
getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product> {
|
|
2658
2688
|
return localVarFp.getProduct(requestParameters.project, requestParameters.productId, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
2659
2689
|
},
|
|
2660
|
-
/**
|
|
2661
|
-
* Lists all enabled store listing products attached to the given project.
|
|
2662
|
-
* @summary List products
|
|
2663
|
-
* @param {ProductsApiGetProductsRequest} requestParameters Request parameters.
|
|
2664
|
-
* @param {*} [options] Override http request option.
|
|
2665
|
-
* @throws {RequiredError}
|
|
2666
|
-
*/
|
|
2667
|
-
getProducts(requestParameters: ProductsApiGetProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse> {
|
|
2668
|
-
return localVarFp.getProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
2669
|
-
},
|
|
2670
2690
|
/**
|
|
2671
2691
|
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
2672
2692
|
* @summary Import products
|
|
@@ -2677,6 +2697,16 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
2677
2697
|
importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImportProducts200Response> {
|
|
2678
2698
|
return localVarFp.importProducts(requestParameters.project, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
2679
2699
|
},
|
|
2700
|
+
/**
|
|
2701
|
+
* Lists all store listing products attached to the given project.
|
|
2702
|
+
* @summary List products
|
|
2703
|
+
* @param {ProductsApiListProductsRequest} requestParameters Request parameters.
|
|
2704
|
+
* @param {*} [options] Override http request option.
|
|
2705
|
+
* @throws {RequiredError}
|
|
2706
|
+
*/
|
|
2707
|
+
listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse> {
|
|
2708
|
+
return localVarFp.listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
2709
|
+
},
|
|
2680
2710
|
/**
|
|
2681
2711
|
* Updates a product by a given ID.
|
|
2682
2712
|
* @summary Update product
|
|
@@ -2761,75 +2791,75 @@ export interface ProductsApiGetProductRequest {
|
|
|
2761
2791
|
}
|
|
2762
2792
|
|
|
2763
2793
|
/**
|
|
2764
|
-
* Request parameters for
|
|
2794
|
+
* Request parameters for importProducts operation in ProductsApi.
|
|
2765
2795
|
* @export
|
|
2766
|
-
* @interface
|
|
2796
|
+
* @interface ProductsApiImportProductsRequest
|
|
2767
2797
|
*/
|
|
2768
|
-
export interface
|
|
2798
|
+
export interface ProductsApiImportProductsRequest {
|
|
2769
2799
|
/**
|
|
2770
2800
|
* What project it is
|
|
2771
2801
|
* @type {string}
|
|
2772
|
-
* @memberof
|
|
2802
|
+
* @memberof ProductsApiImportProducts
|
|
2803
|
+
*/
|
|
2804
|
+
readonly project: string
|
|
2805
|
+
|
|
2806
|
+
/**
|
|
2807
|
+
* A data URL of a CSV file containing data for one or more products.
|
|
2808
|
+
* @type {string}
|
|
2809
|
+
* @memberof ProductsApiImportProducts
|
|
2810
|
+
*/
|
|
2811
|
+
readonly body?: string
|
|
2812
|
+
}
|
|
2813
|
+
|
|
2814
|
+
/**
|
|
2815
|
+
* Request parameters for listProducts operation in ProductsApi.
|
|
2816
|
+
* @export
|
|
2817
|
+
* @interface ProductsApiListProductsRequest
|
|
2818
|
+
*/
|
|
2819
|
+
export interface ProductsApiListProductsRequest {
|
|
2820
|
+
/**
|
|
2821
|
+
* What project it is
|
|
2822
|
+
* @type {string}
|
|
2823
|
+
* @memberof ProductsApiListProducts
|
|
2773
2824
|
*/
|
|
2774
2825
|
readonly project: string
|
|
2775
2826
|
|
|
2776
2827
|
/**
|
|
2777
2828
|
* Page reference token
|
|
2778
2829
|
* @type {number}
|
|
2779
|
-
* @memberof
|
|
2830
|
+
* @memberof ProductsApiListProducts
|
|
2780
2831
|
*/
|
|
2781
2832
|
readonly pageToken?: number
|
|
2782
2833
|
|
|
2783
2834
|
/**
|
|
2784
2835
|
* 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.
|
|
2785
2836
|
* @type {string}
|
|
2786
|
-
* @memberof
|
|
2837
|
+
* @memberof ProductsApiListProducts
|
|
2787
2838
|
*/
|
|
2788
2839
|
readonly search?: string
|
|
2789
2840
|
|
|
2790
2841
|
/**
|
|
2791
2842
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2792
2843
|
* @type {Array<string>}
|
|
2793
|
-
* @memberof
|
|
2844
|
+
* @memberof ProductsApiListProducts
|
|
2794
2845
|
*/
|
|
2795
2846
|
readonly sortBy?: Array<string>
|
|
2796
2847
|
|
|
2797
2848
|
/**
|
|
2798
2849
|
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2799
2850
|
* @type {number}
|
|
2800
|
-
* @memberof
|
|
2851
|
+
* @memberof ProductsApiListProducts
|
|
2801
2852
|
*/
|
|
2802
2853
|
readonly pageSize?: number
|
|
2803
2854
|
|
|
2804
2855
|
/**
|
|
2805
2856
|
* Filter response fields to only include a subset of the resource.
|
|
2806
2857
|
* @type {string}
|
|
2807
|
-
* @memberof
|
|
2858
|
+
* @memberof ProductsApiListProducts
|
|
2808
2859
|
*/
|
|
2809
2860
|
readonly fields?: string
|
|
2810
2861
|
}
|
|
2811
2862
|
|
|
2812
|
-
/**
|
|
2813
|
-
* Request parameters for importProducts operation in ProductsApi.
|
|
2814
|
-
* @export
|
|
2815
|
-
* @interface ProductsApiImportProductsRequest
|
|
2816
|
-
*/
|
|
2817
|
-
export interface ProductsApiImportProductsRequest {
|
|
2818
|
-
/**
|
|
2819
|
-
* What project it is
|
|
2820
|
-
* @type {string}
|
|
2821
|
-
* @memberof ProductsApiImportProducts
|
|
2822
|
-
*/
|
|
2823
|
-
readonly project: string
|
|
2824
|
-
|
|
2825
|
-
/**
|
|
2826
|
-
* A data URL of a CSV file containing data for one or more products.
|
|
2827
|
-
* @type {string}
|
|
2828
|
-
* @memberof ProductsApiImportProducts
|
|
2829
|
-
*/
|
|
2830
|
-
readonly body?: string
|
|
2831
|
-
}
|
|
2832
|
-
|
|
2833
2863
|
/**
|
|
2834
2864
|
* Request parameters for updateProduct operation in ProductsApi.
|
|
2835
2865
|
* @export
|
|
@@ -2902,27 +2932,27 @@ export class ProductsApi extends BaseAPI {
|
|
|
2902
2932
|
}
|
|
2903
2933
|
|
|
2904
2934
|
/**
|
|
2905
|
-
*
|
|
2906
|
-
* @summary
|
|
2907
|
-
* @param {
|
|
2935
|
+
* Initiates a product import from a CSV file. The result will be available as a notification within the dashboard.
|
|
2936
|
+
* @summary Import products
|
|
2937
|
+
* @param {ProductsApiImportProductsRequest} requestParameters Request parameters.
|
|
2908
2938
|
* @param {*} [options] Override http request option.
|
|
2909
2939
|
* @throws {RequiredError}
|
|
2910
2940
|
* @memberof ProductsApi
|
|
2911
2941
|
*/
|
|
2912
|
-
public
|
|
2913
|
-
return ProductsApiFp(this.configuration).
|
|
2942
|
+
public importProducts(requestParameters: ProductsApiImportProductsRequest, options?: RawAxiosRequestConfig) {
|
|
2943
|
+
return ProductsApiFp(this.configuration).importProducts(requestParameters.project, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
2914
2944
|
}
|
|
2915
2945
|
|
|
2916
2946
|
/**
|
|
2917
|
-
*
|
|
2918
|
-
* @summary
|
|
2919
|
-
* @param {
|
|
2947
|
+
* Lists all store listing products attached to the given project.
|
|
2948
|
+
* @summary List products
|
|
2949
|
+
* @param {ProductsApiListProductsRequest} requestParameters Request parameters.
|
|
2920
2950
|
* @param {*} [options] Override http request option.
|
|
2921
2951
|
* @throws {RequiredError}
|
|
2922
2952
|
* @memberof ProductsApi
|
|
2923
2953
|
*/
|
|
2924
|
-
public
|
|
2925
|
-
return ProductsApiFp(this.configuration).
|
|
2954
|
+
public listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig) {
|
|
2955
|
+
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));
|
|
2926
2956
|
}
|
|
2927
2957
|
|
|
2928
2958
|
/**
|
package/base.ts
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/common.ts
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/configuration.ts
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).
|
|
@@ -89,7 +89,13 @@ export class Configuration {
|
|
|
89
89
|
this.accessToken = param.accessToken;
|
|
90
90
|
this.basePath = param.basePath;
|
|
91
91
|
this.serverIndex = param.serverIndex;
|
|
92
|
-
this.baseOptions =
|
|
92
|
+
this.baseOptions = {
|
|
93
|
+
headers: {
|
|
94
|
+
...param.baseOptions?.headers,
|
|
95
|
+
'User-Agent': "OpenAPI-Generator/1.35.0/typescript-axios"
|
|
96
|
+
},
|
|
97
|
+
...param.baseOptions
|
|
98
|
+
};
|
|
93
99
|
this.formDataCtor = param.formDataCtor;
|
|
94
100
|
}
|
|
95
101
|
|