@teemill/product-catalog 1.34.0 → 1.36.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 +348 -82
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +8 -2
- package/dist/api.d.ts +286 -73
- package/dist/api.js +87 -8
- 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 +286 -73
- package/dist/esm/api.js +86 -7
- 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.36.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.36.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.36.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>}
|
|
@@ -623,22 +629,22 @@ export interface CreateProductRequestVideosInner {
|
|
|
623
629
|
export interface CreateProductVariant {
|
|
624
630
|
/**
|
|
625
631
|
* Attributes associated to a variant such as Colour and Size.
|
|
626
|
-
* @type {Array<
|
|
632
|
+
* @type {Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>}
|
|
627
633
|
* @memberof CreateProductVariant
|
|
628
634
|
*/
|
|
629
|
-
'attributes': Array<
|
|
635
|
+
'attributes': Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>;
|
|
630
636
|
/**
|
|
631
637
|
*
|
|
632
|
-
* @type {
|
|
638
|
+
* @type {UpdateProductsRequestProductsInnerVariantsInnerRetailPrice}
|
|
633
639
|
* @memberof CreateProductVariant
|
|
634
640
|
*/
|
|
635
|
-
'retailPrice':
|
|
641
|
+
'retailPrice': UpdateProductsRequestProductsInnerVariantsInnerRetailPrice;
|
|
636
642
|
/**
|
|
637
643
|
*
|
|
638
|
-
* @type {
|
|
644
|
+
* @type {UpdateProductsRequestProductsInnerVariantsInnerSalePrice}
|
|
639
645
|
* @memberof CreateProductVariant
|
|
640
646
|
*/
|
|
641
|
-
'salePrice'?:
|
|
647
|
+
'salePrice'?: UpdateProductsRequestProductsInnerVariantsInnerSalePrice;
|
|
642
648
|
/**
|
|
643
649
|
* A custom stock keeping unit for the variant.
|
|
644
650
|
* @type {string}
|
|
@@ -663,34 +669,19 @@ export interface CreateProductVariant {
|
|
|
663
669
|
* @memberof CreateProductVariant
|
|
664
670
|
*/
|
|
665
671
|
'applicationSets'?: Array<string>;
|
|
666
|
-
}
|
|
667
|
-
/**
|
|
668
|
-
*
|
|
669
|
-
* @export
|
|
670
|
-
* @interface CreateProductVariantAttributesInner
|
|
671
|
-
*/
|
|
672
|
-
export interface CreateProductVariantAttributesInner {
|
|
673
672
|
/**
|
|
674
|
-
*
|
|
673
|
+
* The GTIN (Global Trade Item Number) or EAN (European Article Number) of the variant. Please note that a barcode can only be attached after it\'s been uploaded it via the Barcodes module.
|
|
675
674
|
* @type {string}
|
|
676
|
-
* @memberof
|
|
675
|
+
* @memberof CreateProductVariant
|
|
677
676
|
*/
|
|
678
|
-
'
|
|
677
|
+
'gtin'?: string | null;
|
|
679
678
|
/**
|
|
680
|
-
*
|
|
681
|
-
* @type {
|
|
682
|
-
* @memberof
|
|
679
|
+
* 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.
|
|
680
|
+
* @type {number}
|
|
681
|
+
* @memberof CreateProductVariant
|
|
683
682
|
*/
|
|
684
|
-
'
|
|
683
|
+
'shopifyId'?: number;
|
|
685
684
|
}
|
|
686
|
-
|
|
687
|
-
export const CreateProductVariantAttributesInnerNameEnum = {
|
|
688
|
-
Size: 'Size',
|
|
689
|
-
Colour: 'Colour'
|
|
690
|
-
} as const;
|
|
691
|
-
|
|
692
|
-
export type CreateProductVariantAttributesInnerNameEnum = typeof CreateProductVariantAttributesInnerNameEnum[keyof typeof CreateProductVariantAttributesInnerNameEnum];
|
|
693
|
-
|
|
694
685
|
/**
|
|
695
686
|
*
|
|
696
687
|
* @export
|
|
@@ -704,58 +695,6 @@ export interface CreateProductVariantImagesInner {
|
|
|
704
695
|
*/
|
|
705
696
|
'src'?: string;
|
|
706
697
|
}
|
|
707
|
-
/**
|
|
708
|
-
* Variant retail price including tax.
|
|
709
|
-
* @export
|
|
710
|
-
* @interface CreateProductVariantRetailPrice
|
|
711
|
-
*/
|
|
712
|
-
export interface CreateProductVariantRetailPrice {
|
|
713
|
-
/**
|
|
714
|
-
* Price including tax in the specified currency.
|
|
715
|
-
* @type {number}
|
|
716
|
-
* @memberof CreateProductVariantRetailPrice
|
|
717
|
-
*/
|
|
718
|
-
'amount': number;
|
|
719
|
-
/**
|
|
720
|
-
* Currency code for the currency the price is valued in.
|
|
721
|
-
* @type {string}
|
|
722
|
-
* @memberof CreateProductVariantRetailPrice
|
|
723
|
-
*/
|
|
724
|
-
'currencyCode': CreateProductVariantRetailPriceCurrencyCodeEnum;
|
|
725
|
-
}
|
|
726
|
-
|
|
727
|
-
export const CreateProductVariantRetailPriceCurrencyCodeEnum = {
|
|
728
|
-
Gbp: 'GBP'
|
|
729
|
-
} as const;
|
|
730
|
-
|
|
731
|
-
export type CreateProductVariantRetailPriceCurrencyCodeEnum = typeof CreateProductVariantRetailPriceCurrencyCodeEnum[keyof typeof CreateProductVariantRetailPriceCurrencyCodeEnum];
|
|
732
|
-
|
|
733
|
-
/**
|
|
734
|
-
* Variant discounted price including tax.
|
|
735
|
-
* @export
|
|
736
|
-
* @interface CreateProductVariantSalePrice
|
|
737
|
-
*/
|
|
738
|
-
export interface CreateProductVariantSalePrice {
|
|
739
|
-
/**
|
|
740
|
-
* Sale price including tax in the specified currency.
|
|
741
|
-
* @type {number}
|
|
742
|
-
* @memberof CreateProductVariantSalePrice
|
|
743
|
-
*/
|
|
744
|
-
'amount': number;
|
|
745
|
-
/**
|
|
746
|
-
* Currency code for the currency the sale price is valued in.
|
|
747
|
-
* @type {string}
|
|
748
|
-
* @memberof CreateProductVariantSalePrice
|
|
749
|
-
*/
|
|
750
|
-
'currencyCode': CreateProductVariantSalePriceCurrencyCodeEnum;
|
|
751
|
-
}
|
|
752
|
-
|
|
753
|
-
export const CreateProductVariantSalePriceCurrencyCodeEnum = {
|
|
754
|
-
Gbp: 'GBP'
|
|
755
|
-
} as const;
|
|
756
|
-
|
|
757
|
-
export type CreateProductVariantSalePriceCurrencyCodeEnum = typeof CreateProductVariantSalePriceCurrencyCodeEnum[keyof typeof CreateProductVariantSalePriceCurrencyCodeEnum];
|
|
758
|
-
|
|
759
698
|
/**
|
|
760
699
|
* Image description
|
|
761
700
|
* @export
|
|
@@ -1044,6 +983,12 @@ export interface Product {
|
|
|
1044
983
|
* @memberof Product
|
|
1045
984
|
*/
|
|
1046
985
|
'includeInDataFeeds'?: boolean;
|
|
986
|
+
/**
|
|
987
|
+
* For use with the Shopify integration. The Shopify product ID that this product is linked to.
|
|
988
|
+
* @type {number}
|
|
989
|
+
* @memberof Product
|
|
990
|
+
*/
|
|
991
|
+
'shopifyId'?: number;
|
|
1047
992
|
/**
|
|
1048
993
|
*
|
|
1049
994
|
* @type {ProductWarehouseProduct}
|
|
@@ -1379,6 +1324,12 @@ export interface UpdateProductRequest {
|
|
|
1379
1324
|
* @memberof UpdateProductRequest
|
|
1380
1325
|
*/
|
|
1381
1326
|
'includeInDataFeeds'?: boolean;
|
|
1327
|
+
/**
|
|
1328
|
+
* 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.
|
|
1329
|
+
* @type {number}
|
|
1330
|
+
* @memberof UpdateProductRequest
|
|
1331
|
+
*/
|
|
1332
|
+
'shopifyId'?: number;
|
|
1382
1333
|
/**
|
|
1383
1334
|
* Key/value pairs that can be used to store additional information about the product
|
|
1384
1335
|
* @type {Array<MetaField>}
|
|
@@ -1386,6 +1337,208 @@ export interface UpdateProductRequest {
|
|
|
1386
1337
|
*/
|
|
1387
1338
|
'metafields'?: Array<MetaField>;
|
|
1388
1339
|
}
|
|
1340
|
+
/**
|
|
1341
|
+
*
|
|
1342
|
+
* @export
|
|
1343
|
+
* @interface UpdateProductsRequest
|
|
1344
|
+
*/
|
|
1345
|
+
export interface UpdateProductsRequest {
|
|
1346
|
+
/**
|
|
1347
|
+
*
|
|
1348
|
+
* @type {Array<UpdateProductsRequestProductsInner>}
|
|
1349
|
+
* @memberof UpdateProductsRequest
|
|
1350
|
+
*/
|
|
1351
|
+
'products'?: Array<UpdateProductsRequestProductsInner>;
|
|
1352
|
+
}
|
|
1353
|
+
/**
|
|
1354
|
+
*
|
|
1355
|
+
* @export
|
|
1356
|
+
* @interface UpdateProductsRequestProductsInner
|
|
1357
|
+
*/
|
|
1358
|
+
export interface UpdateProductsRequestProductsInner {
|
|
1359
|
+
/**
|
|
1360
|
+
* Unique object identifier
|
|
1361
|
+
* @type {string}
|
|
1362
|
+
* @memberof UpdateProductsRequestProductsInner
|
|
1363
|
+
*/
|
|
1364
|
+
'id': string;
|
|
1365
|
+
/**
|
|
1366
|
+
* Product title
|
|
1367
|
+
* @type {string}
|
|
1368
|
+
* @memberof UpdateProductsRequestProductsInner
|
|
1369
|
+
*/
|
|
1370
|
+
'title'?: string;
|
|
1371
|
+
/**
|
|
1372
|
+
* Product description
|
|
1373
|
+
* @type {string}
|
|
1374
|
+
* @memberof UpdateProductsRequestProductsInner
|
|
1375
|
+
*/
|
|
1376
|
+
'description'?: string;
|
|
1377
|
+
/**
|
|
1378
|
+
* Whether the product is enabled.
|
|
1379
|
+
* @type {boolean}
|
|
1380
|
+
* @memberof UpdateProductsRequestProductsInner
|
|
1381
|
+
*/
|
|
1382
|
+
'enabled'?: boolean;
|
|
1383
|
+
/**
|
|
1384
|
+
*
|
|
1385
|
+
* @type {CreateProductRequestSeoMetadata}
|
|
1386
|
+
* @memberof UpdateProductsRequestProductsInner
|
|
1387
|
+
*/
|
|
1388
|
+
'seoMetadata'?: CreateProductRequestSeoMetadata;
|
|
1389
|
+
/**
|
|
1390
|
+
* The primary target search phrase for the product that you wish to rank for in search engine results. **Note:** This field requires the website integration
|
|
1391
|
+
* @type {string}
|
|
1392
|
+
* @memberof UpdateProductsRequestProductsInner
|
|
1393
|
+
*/
|
|
1394
|
+
'targetSearchPhrase'?: string;
|
|
1395
|
+
/**
|
|
1396
|
+
* Synonyms for the target search phrase. **Note:** This field requires the website integration
|
|
1397
|
+
* @type {Array<string>}
|
|
1398
|
+
* @memberof UpdateProductsRequestProductsInner
|
|
1399
|
+
*/
|
|
1400
|
+
'targetSearchPhraseSynonyms'?: Array<string>;
|
|
1401
|
+
/**
|
|
1402
|
+
* Additional product tags used for searching and filtering.
|
|
1403
|
+
* @type {Array<string>}
|
|
1404
|
+
* @memberof UpdateProductsRequestProductsInner
|
|
1405
|
+
*/
|
|
1406
|
+
'tags'?: Array<string>;
|
|
1407
|
+
/**
|
|
1408
|
+
* List of variants to update.
|
|
1409
|
+
* @type {Array<UpdateProductsRequestProductsInnerVariantsInner>}
|
|
1410
|
+
* @memberof UpdateProductsRequestProductsInner
|
|
1411
|
+
*/
|
|
1412
|
+
'variants'?: Array<UpdateProductsRequestProductsInnerVariantsInner>;
|
|
1413
|
+
/**
|
|
1414
|
+
* Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising.
|
|
1415
|
+
* @type {boolean}
|
|
1416
|
+
* @memberof UpdateProductsRequestProductsInner
|
|
1417
|
+
*/
|
|
1418
|
+
'includeInDataFeeds'?: boolean;
|
|
1419
|
+
/**
|
|
1420
|
+
* 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.
|
|
1421
|
+
* @type {number}
|
|
1422
|
+
* @memberof UpdateProductsRequestProductsInner
|
|
1423
|
+
*/
|
|
1424
|
+
'shopifyId'?: number;
|
|
1425
|
+
}
|
|
1426
|
+
/**
|
|
1427
|
+
*
|
|
1428
|
+
* @export
|
|
1429
|
+
* @interface UpdateProductsRequestProductsInnerVariantsInner
|
|
1430
|
+
*/
|
|
1431
|
+
export interface UpdateProductsRequestProductsInnerVariantsInner {
|
|
1432
|
+
/**
|
|
1433
|
+
* Attributes associated to a variant such as Colour and Size.
|
|
1434
|
+
* @type {Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>}
|
|
1435
|
+
* @memberof UpdateProductsRequestProductsInnerVariantsInner
|
|
1436
|
+
*/
|
|
1437
|
+
'attributes': Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>;
|
|
1438
|
+
/**
|
|
1439
|
+
*
|
|
1440
|
+
* @type {UpdateProductsRequestProductsInnerVariantsInnerRetailPrice}
|
|
1441
|
+
* @memberof UpdateProductsRequestProductsInnerVariantsInner
|
|
1442
|
+
*/
|
|
1443
|
+
'retailPrice': UpdateProductsRequestProductsInnerVariantsInnerRetailPrice;
|
|
1444
|
+
/**
|
|
1445
|
+
*
|
|
1446
|
+
* @type {UpdateProductsRequestProductsInnerVariantsInnerSalePrice}
|
|
1447
|
+
* @memberof UpdateProductsRequestProductsInnerVariantsInner
|
|
1448
|
+
*/
|
|
1449
|
+
'salePrice'?: UpdateProductsRequestProductsInnerVariantsInnerSalePrice;
|
|
1450
|
+
/**
|
|
1451
|
+
* The GTIN (Global Trade Item Number) or EAN (European Article Number) of the variant. Please note that a barcode can only be attached after it\'s been uploaded it via the Barcodes module.
|
|
1452
|
+
* @type {string}
|
|
1453
|
+
* @memberof UpdateProductsRequestProductsInnerVariantsInner
|
|
1454
|
+
*/
|
|
1455
|
+
'gtin'?: string | null;
|
|
1456
|
+
/**
|
|
1457
|
+
* 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.
|
|
1458
|
+
* @type {number}
|
|
1459
|
+
* @memberof UpdateProductsRequestProductsInnerVariantsInner
|
|
1460
|
+
*/
|
|
1461
|
+
'shopifyId'?: number;
|
|
1462
|
+
}
|
|
1463
|
+
/**
|
|
1464
|
+
*
|
|
1465
|
+
* @export
|
|
1466
|
+
* @interface UpdateProductsRequestProductsInnerVariantsInnerAttributesInner
|
|
1467
|
+
*/
|
|
1468
|
+
export interface UpdateProductsRequestProductsInnerVariantsInnerAttributesInner {
|
|
1469
|
+
/**
|
|
1470
|
+
* Attribute name
|
|
1471
|
+
* @type {string}
|
|
1472
|
+
* @memberof UpdateProductsRequestProductsInnerVariantsInnerAttributesInner
|
|
1473
|
+
*/
|
|
1474
|
+
'name': UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum;
|
|
1475
|
+
/**
|
|
1476
|
+
* Attribute value
|
|
1477
|
+
* @type {string}
|
|
1478
|
+
* @memberof UpdateProductsRequestProductsInnerVariantsInnerAttributesInner
|
|
1479
|
+
*/
|
|
1480
|
+
'value': string;
|
|
1481
|
+
}
|
|
1482
|
+
|
|
1483
|
+
export const UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = {
|
|
1484
|
+
Size: 'Size',
|
|
1485
|
+
Colour: 'Colour'
|
|
1486
|
+
} as const;
|
|
1487
|
+
|
|
1488
|
+
export type UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerAttributesInnerNameEnum];
|
|
1489
|
+
|
|
1490
|
+
/**
|
|
1491
|
+
* Variant retail price including tax.
|
|
1492
|
+
* @export
|
|
1493
|
+
* @interface UpdateProductsRequestProductsInnerVariantsInnerRetailPrice
|
|
1494
|
+
*/
|
|
1495
|
+
export interface UpdateProductsRequestProductsInnerVariantsInnerRetailPrice {
|
|
1496
|
+
/**
|
|
1497
|
+
* Price including tax in the specified currency.
|
|
1498
|
+
* @type {number}
|
|
1499
|
+
* @memberof UpdateProductsRequestProductsInnerVariantsInnerRetailPrice
|
|
1500
|
+
*/
|
|
1501
|
+
'amount': number;
|
|
1502
|
+
/**
|
|
1503
|
+
* Currency code for the currency the price is valued in.
|
|
1504
|
+
* @type {string}
|
|
1505
|
+
* @memberof UpdateProductsRequestProductsInnerVariantsInnerRetailPrice
|
|
1506
|
+
*/
|
|
1507
|
+
'currencyCode': UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum;
|
|
1508
|
+
}
|
|
1509
|
+
|
|
1510
|
+
export const UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = {
|
|
1511
|
+
Gbp: 'GBP'
|
|
1512
|
+
} as const;
|
|
1513
|
+
|
|
1514
|
+
export type UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerRetailPriceCurrencyCodeEnum];
|
|
1515
|
+
|
|
1516
|
+
/**
|
|
1517
|
+
* Variant discounted price including tax.
|
|
1518
|
+
* @export
|
|
1519
|
+
* @interface UpdateProductsRequestProductsInnerVariantsInnerSalePrice
|
|
1520
|
+
*/
|
|
1521
|
+
export interface UpdateProductsRequestProductsInnerVariantsInnerSalePrice {
|
|
1522
|
+
/**
|
|
1523
|
+
* Sale price including tax in the specified currency.
|
|
1524
|
+
* @type {number}
|
|
1525
|
+
* @memberof UpdateProductsRequestProductsInnerVariantsInnerSalePrice
|
|
1526
|
+
*/
|
|
1527
|
+
'amount': number;
|
|
1528
|
+
/**
|
|
1529
|
+
* Currency code for the currency the sale price is valued in.
|
|
1530
|
+
* @type {string}
|
|
1531
|
+
* @memberof UpdateProductsRequestProductsInnerVariantsInnerSalePrice
|
|
1532
|
+
*/
|
|
1533
|
+
'currencyCode': UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum;
|
|
1534
|
+
}
|
|
1535
|
+
|
|
1536
|
+
export const UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = {
|
|
1537
|
+
Gbp: 'GBP'
|
|
1538
|
+
} as const;
|
|
1539
|
+
|
|
1540
|
+
export type UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum = typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum[keyof typeof UpdateProductsRequestProductsInnerVariantsInnerSalePriceCurrencyCodeEnum];
|
|
1541
|
+
|
|
1389
1542
|
/**
|
|
1390
1543
|
*
|
|
1391
1544
|
* @export
|
|
@@ -1483,11 +1636,17 @@ export interface Variant {
|
|
|
1483
1636
|
*/
|
|
1484
1637
|
'applications'?: Array<Application>;
|
|
1485
1638
|
/**
|
|
1486
|
-
* Global Trade Item Number
|
|
1639
|
+
* The GTIN (Global Trade Item Number) or EAN (European Article Number) of the variant. Please note that a barcode can only be attached after it\'s been uploaded it via the Barcodes module.
|
|
1487
1640
|
* @type {string}
|
|
1488
1641
|
* @memberof Variant
|
|
1489
1642
|
*/
|
|
1490
1643
|
'gtin'?: string | null;
|
|
1644
|
+
/**
|
|
1645
|
+
* For use with the Shopify integration. The Shopify variant ID that this variant is linked to.
|
|
1646
|
+
* @type {number}
|
|
1647
|
+
* @memberof Variant
|
|
1648
|
+
*/
|
|
1649
|
+
'shopifyId'?: number;
|
|
1491
1650
|
/**
|
|
1492
1651
|
* Key/value pairs that can be used to store additional information about the variant
|
|
1493
1652
|
* @type {Array<MetaField>}
|
|
@@ -2512,6 +2671,56 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
2512
2671
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2513
2672
|
localVarRequestOptions.data = serializeDataIfNeeded(updateProductRequest, localVarRequestOptions, configuration)
|
|
2514
2673
|
|
|
2674
|
+
return {
|
|
2675
|
+
url: toPathString(localVarUrlObj),
|
|
2676
|
+
options: localVarRequestOptions,
|
|
2677
|
+
};
|
|
2678
|
+
},
|
|
2679
|
+
/**
|
|
2680
|
+
* Updates catalog products for the given project.
|
|
2681
|
+
* @summary Update products
|
|
2682
|
+
* @param {string} project What project it is
|
|
2683
|
+
* @param {UpdateProductsRequest} updateProductsRequest Update products in bulk.
|
|
2684
|
+
* @param {*} [options] Override http request option.
|
|
2685
|
+
* @throws {RequiredError}
|
|
2686
|
+
*/
|
|
2687
|
+
updateProducts: async (project: string, updateProductsRequest: UpdateProductsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2688
|
+
// verify required parameter 'project' is not null or undefined
|
|
2689
|
+
assertParamExists('updateProducts', 'project', project)
|
|
2690
|
+
// verify required parameter 'updateProductsRequest' is not null or undefined
|
|
2691
|
+
assertParamExists('updateProducts', 'updateProductsRequest', updateProductsRequest)
|
|
2692
|
+
const localVarPath = `/v1/catalog/products`;
|
|
2693
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2694
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2695
|
+
let baseOptions;
|
|
2696
|
+
if (configuration) {
|
|
2697
|
+
baseOptions = configuration.baseOptions;
|
|
2698
|
+
}
|
|
2699
|
+
|
|
2700
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
2701
|
+
const localVarHeaderParameter = {} as any;
|
|
2702
|
+
const localVarQueryParameter = {} as any;
|
|
2703
|
+
|
|
2704
|
+
// authentication session-oauth required
|
|
2705
|
+
// oauth required
|
|
2706
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2707
|
+
|
|
2708
|
+
// authentication api-key required
|
|
2709
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2710
|
+
|
|
2711
|
+
if (project !== undefined) {
|
|
2712
|
+
localVarQueryParameter['project'] = project;
|
|
2713
|
+
}
|
|
2714
|
+
|
|
2715
|
+
|
|
2716
|
+
|
|
2717
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2718
|
+
|
|
2719
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2720
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2721
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2722
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateProductsRequest, localVarRequestOptions, configuration)
|
|
2723
|
+
|
|
2515
2724
|
return {
|
|
2516
2725
|
url: toPathString(localVarUrlObj),
|
|
2517
2726
|
options: localVarRequestOptions,
|
|
@@ -2617,6 +2826,20 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
2617
2826
|
const localVarOperationServerBasePath = operationServerMap['ProductsApi.updateProduct']?.[localVarOperationServerIndex]?.url;
|
|
2618
2827
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2619
2828
|
},
|
|
2829
|
+
/**
|
|
2830
|
+
* Updates catalog products for the given project.
|
|
2831
|
+
* @summary Update products
|
|
2832
|
+
* @param {string} project What project it is
|
|
2833
|
+
* @param {UpdateProductsRequest} updateProductsRequest Update products in bulk.
|
|
2834
|
+
* @param {*} [options] Override http request option.
|
|
2835
|
+
* @throws {RequiredError}
|
|
2836
|
+
*/
|
|
2837
|
+
async updateProducts(project: string, updateProductsRequest: UpdateProductsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductsResponse>> {
|
|
2838
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateProducts(project, updateProductsRequest, options);
|
|
2839
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2840
|
+
const localVarOperationServerBasePath = operationServerMap['ProductsApi.updateProducts']?.[localVarOperationServerIndex]?.url;
|
|
2841
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2842
|
+
},
|
|
2620
2843
|
}
|
|
2621
2844
|
};
|
|
2622
2845
|
|
|
@@ -2687,6 +2910,16 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
2687
2910
|
updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product> {
|
|
2688
2911
|
return localVarFp.updateProduct(requestParameters.project, requestParameters.productId, requestParameters.updateProductRequest, options).then((request) => request(axios, basePath));
|
|
2689
2912
|
},
|
|
2913
|
+
/**
|
|
2914
|
+
* Updates catalog products for the given project.
|
|
2915
|
+
* @summary Update products
|
|
2916
|
+
* @param {ProductsApiUpdateProductsRequest} requestParameters Request parameters.
|
|
2917
|
+
* @param {*} [options] Override http request option.
|
|
2918
|
+
* @throws {RequiredError}
|
|
2919
|
+
*/
|
|
2920
|
+
updateProducts(requestParameters: ProductsApiUpdateProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse> {
|
|
2921
|
+
return localVarFp.updateProducts(requestParameters.project, requestParameters.updateProductsRequest, options).then((request) => request(axios, basePath));
|
|
2922
|
+
},
|
|
2690
2923
|
};
|
|
2691
2924
|
};
|
|
2692
2925
|
|
|
@@ -2858,6 +3091,27 @@ export interface ProductsApiUpdateProductRequest {
|
|
|
2858
3091
|
readonly updateProductRequest?: UpdateProductRequest
|
|
2859
3092
|
}
|
|
2860
3093
|
|
|
3094
|
+
/**
|
|
3095
|
+
* Request parameters for updateProducts operation in ProductsApi.
|
|
3096
|
+
* @export
|
|
3097
|
+
* @interface ProductsApiUpdateProductsRequest
|
|
3098
|
+
*/
|
|
3099
|
+
export interface ProductsApiUpdateProductsRequest {
|
|
3100
|
+
/**
|
|
3101
|
+
* What project it is
|
|
3102
|
+
* @type {string}
|
|
3103
|
+
* @memberof ProductsApiUpdateProducts
|
|
3104
|
+
*/
|
|
3105
|
+
readonly project: string
|
|
3106
|
+
|
|
3107
|
+
/**
|
|
3108
|
+
* Update products in bulk.
|
|
3109
|
+
* @type {UpdateProductsRequest}
|
|
3110
|
+
* @memberof ProductsApiUpdateProducts
|
|
3111
|
+
*/
|
|
3112
|
+
readonly updateProductsRequest: UpdateProductsRequest
|
|
3113
|
+
}
|
|
3114
|
+
|
|
2861
3115
|
/**
|
|
2862
3116
|
* ProductsApi - object-oriented interface
|
|
2863
3117
|
* @export
|
|
@@ -2936,6 +3190,18 @@ export class ProductsApi extends BaseAPI {
|
|
|
2936
3190
|
public updateProduct(requestParameters: ProductsApiUpdateProductRequest, options?: RawAxiosRequestConfig) {
|
|
2937
3191
|
return ProductsApiFp(this.configuration).updateProduct(requestParameters.project, requestParameters.productId, requestParameters.updateProductRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2938
3192
|
}
|
|
3193
|
+
|
|
3194
|
+
/**
|
|
3195
|
+
* Updates catalog products for the given project.
|
|
3196
|
+
* @summary Update products
|
|
3197
|
+
* @param {ProductsApiUpdateProductsRequest} requestParameters Request parameters.
|
|
3198
|
+
* @param {*} [options] Override http request option.
|
|
3199
|
+
* @throws {RequiredError}
|
|
3200
|
+
* @memberof ProductsApi
|
|
3201
|
+
*/
|
|
3202
|
+
public updateProducts(requestParameters: ProductsApiUpdateProductsRequest, options?: RawAxiosRequestConfig) {
|
|
3203
|
+
return ProductsApiFp(this.configuration).updateProducts(requestParameters.project, requestParameters.updateProductsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3204
|
+
}
|
|
2939
3205
|
}
|
|
2940
3206
|
|
|
2941
3207
|
|
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.36.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.36.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.36.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.36.0/typescript-axios"
|
|
96
|
+
},
|
|
97
|
+
...param.baseOptions
|
|
98
|
+
};
|
|
93
99
|
this.formDataCtor = param.formDataCtor;
|
|
94
100
|
}
|
|
95
101
|
|