@teemill/product-catalog 1.91.0 → 1.92.1
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/.openapi-generator/FILES +2 -1
- package/README.md +4 -3
- package/api.ts +297 -47
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +271 -41
- package/dist/api.js +35 -15
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +271 -41
- package/dist/esm/api.js +35 -15
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/Action.md +2 -1
- package/docs/AdditionalFile.md +1 -0
- package/docs/AnalyticsItem.md +1 -0
- package/docs/AnalyticsSummary.md +1 -0
- package/docs/ApiError.md +3 -2
- package/docs/Application.md +2 -1
- package/docs/ApplicationGroup.md +3 -2
- package/docs/ApplicationProperties.md +1 -0
- package/docs/ApplicationPropertiesPersonalization.md +1 -0
- package/docs/ApplicationSet.md +3 -2
- package/docs/ApplicationSetRecord.md +2 -1
- package/docs/ApplicationTechnologiesApi.md +7 -1
- package/docs/ApplicationTechnology.md +2 -1
- package/docs/BundleProduct.md +9 -8
- package/docs/CreateApplication.md +1 -0
- package/docs/CreateBundleProduct.md +2 -1
- package/docs/CreateProduct.md +3 -0
- package/docs/CreateProductRequest.md +3 -1
- package/docs/CreateProductVariant.md +1 -0
- package/docs/Image.md +2 -2
- package/docs/ImageFile.md +1 -0
- package/docs/Location.md +1 -0
- package/docs/NamedPrice.md +2 -1
- package/docs/OptimisationHistoryItem.md +3 -2
- package/docs/Product.md +11 -8
- package/docs/ProductAnalyticsApi.md +2 -2
- package/docs/ProductBundleItemsInner.md +8 -8
- package/docs/ProductCreatorsApi.md +7 -1
- package/docs/ProductStaticCollectionsInner.md +22 -0
- package/docs/ProductType.md +2 -1
- package/docs/ProductsApi.md +6 -6
- package/docs/Recommendation.md +2 -1
- package/docs/Stock.md +3 -2
- package/docs/TargetSearchPhraseData.md +1 -0
- package/docs/TextApplicationProperties.md +1 -0
- package/docs/TextApplicationPropertiesPersonalization.md +1 -0
- package/docs/UpdateProductRequest.md +4 -2
- package/docs/UpdateProductRequestBundleItemsInner.md +1 -1
- package/docs/UpdateProductsRequestProductsInner.md +2 -0
- package/docs/UpdateProductsRequestProductsInnerCollectionsInner.md +20 -0
- package/docs/UserList.md +2 -1
- package/docs/Variant.md +5 -4
- package/docs/VariantWholesaleCost.md +2 -2
- package/docs/Video.md +2 -2
- package/docs/VideoFile.md +1 -0
- package/index.ts +1 -1
- package/package.json +2 -2
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
# OptimisationHistoryItem
|
|
2
2
|
|
|
3
|
+
A record of an AI SEO optimisation performed on a product.
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
6
7
|
Name | Type | Description | Notes
|
|
7
8
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **string** |
|
|
9
|
-
**createdAt** | **string** |
|
|
9
|
+
**id** | **string** | The unique identifier of this optimisation. | [optional] [default to undefined]
|
|
10
|
+
**createdAt** | **string** | The timestamp when this optimisation was performed. | [optional] [default to undefined]
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
package/docs/Product.md
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
# Product
|
|
2
2
|
|
|
3
|
+
A catalog product listing that can be purchased, containing design applications, pricing, variants, and SEO metadata.
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
6
7
|
Name | Type | Description | Notes
|
|
7
8
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **string** |
|
|
9
|
-
**ref** | **string** | A reference to
|
|
10
|
-
**title** | **string** |
|
|
9
|
+
**id** | **string** | The unique identifier of the product. | [optional] [default to undefined]
|
|
10
|
+
**ref** | **string** | A URI reference to this product resource. | [optional] [default to undefined]
|
|
11
|
+
**title** | **string** | The display title of the product. | [default to undefined]
|
|
11
12
|
**description** | **string** | | [default to undefined]
|
|
12
13
|
**slug** | **string** | | [optional] [readonly] [default to undefined]
|
|
13
14
|
**brand** | **string** | | [optional] [default to undefined]
|
|
@@ -23,16 +24,16 @@ Name | Type | Description | Notes
|
|
|
23
24
|
**videos** | [**Array<Video>**](Video.md) | Videos | [optional] [default to undefined]
|
|
24
25
|
**variants** | [**Array<Variant>**](Variant.md) | Variants | [optional] [default to undefined]
|
|
25
26
|
**bundleItems** | [**Array<ProductBundleItemsInner>**](ProductBundleItemsInner.md) | Products in the bundle. | [optional] [default to undefined]
|
|
26
|
-
**retailPrice** | [**Price**](Price.md) |
|
|
27
|
-
**salePrice** | [**SalePrice**](SalePrice.md) |
|
|
27
|
+
**retailPrice** | [**Price**](Price.md) | The retail price of the product, including tax. Only provided if the product is a bundle. | [optional] [default to undefined]
|
|
28
|
+
**salePrice** | [**SalePrice**](SalePrice.md) | The sale price of the product, including tax. Only provided if the product is a bundle. | [optional] [default to undefined]
|
|
28
29
|
**additionalFiles** | [**Array<ProductAdditionalFilesInner>**](ProductAdditionalFilesInner.md) | Additional files attached to the product. | [optional] [default to undefined]
|
|
29
30
|
**applicationSets** | [**Array<ProductApplicationSetsInner>**](ProductApplicationSetsInner.md) | List of application sets associated with this product | [optional] [default to undefined]
|
|
30
31
|
**reviewScore** | **number** | The average review rating. This field is only present if included in the fields query parameter | [optional] [default to undefined]
|
|
31
32
|
**reviewCount** | **number** | A count of reviews. This field is only present if included in the fields query parameter | [optional] [default to undefined]
|
|
32
|
-
**sku** | **string** |
|
|
33
|
+
**sku** | **string** | A unique identifier for a specific variant (product + colour + size). | [optional] [default to undefined]
|
|
33
34
|
**sales** | **number** | A count of sales. This field is only present if included in the fields query parameter | [optional] [default to undefined]
|
|
34
|
-
**salesStart** | **string** |
|
|
35
|
-
**salesEnd** | **string** |
|
|
35
|
+
**salesStart** | **string** | The start of the window in which sales are counted | [optional] [default to undefined]
|
|
36
|
+
**salesEnd** | **string** | The end of the window in which sales are counted | [optional] [default to undefined]
|
|
36
37
|
**includeInDataFeeds** | **boolean** | | [optional] [default to undefined]
|
|
37
38
|
**shopifyId** | **number** | For use with the Shopify integration. The Shopify product ID that this product is linked to. | [optional] [default to undefined]
|
|
38
39
|
**warehouseProduct** | [**ProductWarehouseProduct**](ProductWarehouseProduct.md) | | [optional] [default to undefined]
|
|
@@ -46,6 +47,7 @@ Name | Type | Description | Notes
|
|
|
46
47
|
**createdBy** | **string** | The user ID of the user who created the product | [optional] [default to undefined]
|
|
47
48
|
**isDigital** | **boolean** | Whether the product is digital | [optional] [default to false]
|
|
48
49
|
**analytics** | [**ProductAnalytics**](ProductAnalytics.md) | | [optional] [default to undefined]
|
|
50
|
+
**staticCollections** | [**Array<ProductStaticCollectionsInner>**](ProductStaticCollectionsInner.md) | The static (non-dynamic/filter-based) collections this product belongs to. | [optional] [default to undefined]
|
|
49
51
|
|
|
50
52
|
## Example
|
|
51
53
|
|
|
@@ -94,6 +96,7 @@ const instance: Product = {
|
|
|
94
96
|
createdBy,
|
|
95
97
|
isDigital,
|
|
96
98
|
analytics,
|
|
99
|
+
staticCollections,
|
|
97
100
|
};
|
|
98
101
|
```
|
|
99
102
|
|
|
@@ -103,8 +103,8 @@ const { status, data } = await apiInstance.exportProductAnalytics(
|
|
|
103
103
|
### HTTP response details
|
|
104
104
|
| Status code | Description | Response headers |
|
|
105
105
|
|-------------|-------------|------------------|
|
|
106
|
-
|**200** | Returns the CSV export | - |
|
|
107
|
-
|**202** |
|
|
106
|
+
|**200** | The dataset is small enough to return immediately. Returns the CSV export directly. | - |
|
|
107
|
+
|**202** | The dataset is too large to return immediately. The export has been queued and a notification will be sent when it is ready for download. | - |
|
|
108
108
|
|**401** | Not authorised to access this resource. | - |
|
|
109
109
|
|**403** | Refuse to authorize. | - |
|
|
110
110
|
|**500** | Unknown server error. | - |
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **string** |
|
|
9
|
-
**ref** | **string** | A reference to
|
|
10
|
-
**title** | **string** |
|
|
8
|
+
**id** | **string** | The unique identifier of the bundle product. | [optional] [default to undefined]
|
|
9
|
+
**ref** | **string** | A URI reference to this bundle product resource. | [optional] [default to undefined]
|
|
10
|
+
**title** | **string** | The display title of the bundle product. | [default to undefined]
|
|
11
11
|
**description** | **string** | | [default to undefined]
|
|
12
12
|
**slug** | **string** | | [optional] [readonly] [default to undefined]
|
|
13
13
|
**brand** | **string** | | [optional] [default to undefined]
|
|
@@ -22,16 +22,16 @@ Name | Type | Description | Notes
|
|
|
22
22
|
**images** | [**Array<Image>**](Image.md) | Images | [optional] [default to undefined]
|
|
23
23
|
**videos** | [**Array<Video>**](Video.md) | Videos | [optional] [default to undefined]
|
|
24
24
|
**variants** | [**Array<Variant>**](Variant.md) | Variants | [optional] [default to undefined]
|
|
25
|
-
**retailPrice** | [**Price**](Price.md) |
|
|
26
|
-
**salePrice** | [**SalePrice**](SalePrice.md) |
|
|
25
|
+
**retailPrice** | [**Price**](Price.md) | The retail price of the product, including tax. Only provided if the product is a bundle. | [optional] [default to undefined]
|
|
26
|
+
**salePrice** | [**SalePrice**](SalePrice.md) | The sale price of the product, including tax. Only provided if the product is a bundle. | [optional] [default to undefined]
|
|
27
27
|
**additionalFiles** | [**Array<ProductAdditionalFilesInner>**](ProductAdditionalFilesInner.md) | Additional files attached to the product. | [optional] [default to undefined]
|
|
28
28
|
**applicationSets** | [**Array<ProductApplicationSetsInner>**](ProductApplicationSetsInner.md) | List of application sets associated with this product | [optional] [default to undefined]
|
|
29
29
|
**reviewScore** | **number** | The average review rating. This field is only present if included in the fields query parameter | [optional] [default to undefined]
|
|
30
30
|
**reviewCount** | **number** | A count of reviews. This field is only present if included in the fields query parameter | [optional] [default to undefined]
|
|
31
|
-
**sku** | **string** |
|
|
31
|
+
**sku** | **string** | A unique identifier for a specific variant (product + colour + size). | [optional] [default to undefined]
|
|
32
32
|
**sales** | **number** | A count of sales. This field is only present if included in the fields query parameter | [optional] [default to undefined]
|
|
33
|
-
**salesStart** | **string** |
|
|
34
|
-
**salesEnd** | **string** |
|
|
33
|
+
**salesStart** | **string** | The start of the window in which sales are counted | [optional] [default to undefined]
|
|
34
|
+
**salesEnd** | **string** | The end of the window in which sales are counted | [optional] [default to undefined]
|
|
35
35
|
**includeInDataFeeds** | **boolean** | | [optional] [default to undefined]
|
|
36
36
|
**shopifyId** | **number** | For use with the Shopify integration. The Shopify product ID that this product is linked to. | [optional] [default to undefined]
|
|
37
37
|
**warehouseProduct** | [**ProductWarehouseProduct**](ProductWarehouseProduct.md) | | [optional] [default to undefined]
|
|
@@ -23,9 +23,13 @@ const configuration = new Configuration();
|
|
|
23
23
|
const apiInstance = new ProductCreatorsApi(configuration);
|
|
24
24
|
|
|
25
25
|
let project: string; //What project it is (default to undefined)
|
|
26
|
+
let pageToken: number; //Page reference token (optional) (default to 1)
|
|
27
|
+
let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
|
|
26
28
|
|
|
27
29
|
const { status, data } = await apiInstance.listProductCreators(
|
|
28
|
-
project
|
|
30
|
+
project,
|
|
31
|
+
pageToken,
|
|
32
|
+
pageSize
|
|
29
33
|
);
|
|
30
34
|
```
|
|
31
35
|
|
|
@@ -34,6 +38,8 @@ const { status, data } = await apiInstance.listProductCreators(
|
|
|
34
38
|
|Name | Type | Description | Notes|
|
|
35
39
|
|------------- | ------------- | ------------- | -------------|
|
|
36
40
|
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
41
|
+
| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
|
|
42
|
+
| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
|
|
37
43
|
|
|
38
44
|
|
|
39
45
|
### Return type
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ProductStaticCollectionsInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**title** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ProductStaticCollectionsInner } from '@teemill/product-catalog';
|
|
15
|
+
|
|
16
|
+
const instance: ProductStaticCollectionsInner = {
|
|
17
|
+
id,
|
|
18
|
+
title,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/ProductType.md
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
# ProductType
|
|
2
2
|
|
|
3
|
+
A type of product available in the catalog (e.g. Printed T-Shirt, Embroidered Hoodie).
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
6
7
|
Name | Type | Description | Notes
|
|
7
8
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **string** |
|
|
9
|
+
**id** | **string** | The unique identifier of the product type. | [default to undefined]
|
|
9
10
|
**name** | **string** | Name of the product type | [default to undefined]
|
|
10
11
|
|
|
11
12
|
## Example
|
package/docs/ProductsApi.md
CHANGED
|
@@ -34,7 +34,7 @@ const configuration = new Configuration();
|
|
|
34
34
|
const apiInstance = new ProductsApi(configuration);
|
|
35
35
|
|
|
36
36
|
let project: string; //What project it is (default to undefined)
|
|
37
|
-
let createProductRequest: CreateProductRequest; // (optional)
|
|
37
|
+
let createProductRequest: CreateProductRequest; //The product to create, including title, variants, design applications, and pricing. (optional)
|
|
38
38
|
|
|
39
39
|
const { status, data } = await apiInstance.createProduct(
|
|
40
40
|
project,
|
|
@@ -46,7 +46,7 @@ const { status, data } = await apiInstance.createProduct(
|
|
|
46
46
|
|
|
47
47
|
|Name | Type | Description | Notes|
|
|
48
48
|
|------------- | ------------- | ------------- | -------------|
|
|
49
|
-
| **createProductRequest** | **CreateProductRequest**|
|
|
49
|
+
| **createProductRequest** | **CreateProductRequest**| The product to create, including title, variants, design applications, and pricing. | |
|
|
50
50
|
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
51
51
|
|
|
52
52
|
|
|
@@ -320,8 +320,8 @@ const { status, data } = await apiInstance.exportProducts(
|
|
|
320
320
|
### HTTP response details
|
|
321
321
|
| Status code | Description | Response headers |
|
|
322
322
|
|-------------|-------------|------------------|
|
|
323
|
-
|**200** | Returns the CSV export | - |
|
|
324
|
-
|**202** |
|
|
323
|
+
|**200** | The dataset is small enough to return immediately. Returns the CSV export directly. | - |
|
|
324
|
+
|**202** | The dataset is too large to return immediately. The export has been queued and a notification will be sent when it is ready for download. | - |
|
|
325
325
|
|**400** | Failed validation. | - |
|
|
326
326
|
|**401** | Not authorised to access this resource. | - |
|
|
327
327
|
|**403** | Refuse to authorize. | - |
|
|
@@ -657,7 +657,7 @@ const apiInstance = new ProductsApi(configuration);
|
|
|
657
657
|
|
|
658
658
|
let project: string; //What project it is (default to undefined)
|
|
659
659
|
let productId: string; //Product\'s unique identifier (default to undefined)
|
|
660
|
-
let updateProductRequest: UpdateProductRequest; // (optional)
|
|
660
|
+
let updateProductRequest: UpdateProductRequest; //The product fields to update. Only the fields provided will be modified. (optional)
|
|
661
661
|
|
|
662
662
|
const { status, data } = await apiInstance.updateProduct(
|
|
663
663
|
project,
|
|
@@ -670,7 +670,7 @@ const { status, data } = await apiInstance.updateProduct(
|
|
|
670
670
|
|
|
671
671
|
|Name | Type | Description | Notes|
|
|
672
672
|
|------------- | ------------- | ------------- | -------------|
|
|
673
|
-
| **updateProductRequest** | **UpdateProductRequest**|
|
|
673
|
+
| **updateProductRequest** | **UpdateProductRequest**| The product fields to update. Only the fields provided will be modified. | |
|
|
674
674
|
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
675
675
|
| **productId** | [**string**] | Product\'s unique identifier | defaults to undefined|
|
|
676
676
|
|
package/docs/Recommendation.md
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
# Recommendation
|
|
2
2
|
|
|
3
|
+
An AI-generated recommendation for improving product performance.
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
6
7
|
Name | Type | Description | Notes
|
|
7
8
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **string** |
|
|
9
|
+
**id** | **string** | The unique identifier of this recommendation. | [default to undefined]
|
|
9
10
|
**ref** | **string** | A reference to the recommendation resource location | [default to undefined]
|
|
10
11
|
**reason** | **string** | The reason for the recommendation | [default to undefined]
|
|
11
12
|
**recommendation** | **string** | The recommendation for the target | [default to undefined]
|
package/docs/Stock.md
CHANGED
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
# Stock
|
|
2
2
|
|
|
3
|
+
Stock availability information including total level and per-location breakdown.
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
6
7
|
Name | Type | Description | Notes
|
|
7
8
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**level** | **number** |
|
|
9
|
-
**locations** | [**Array<Location>**](Location.md) |
|
|
9
|
+
**level** | **number** | The current total stock level available for purchase. | [optional] [default to undefined]
|
|
10
|
+
**locations** | [**Array<Location>**](Location.md) | Stock levels broken down by warehouse location. | [optional] [default to undefined]
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -18,8 +18,8 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**internalTags** | **Array<string>** | Additional product tags used for internal searching and filtering. | [optional] [default to undefined]
|
|
19
19
|
**variants** | [**Array<CreateProductVariant>**](CreateProductVariant.md) | Variants | [optional] [default to undefined]
|
|
20
20
|
**bundleItems** | [**Array<UpdateProductRequestBundleItemsInner>**](UpdateProductRequestBundleItemsInner.md) | A list of products to be in this bundle. Only valid if the product is already a bundle. | [optional] [default to undefined]
|
|
21
|
-
**retailPrice** | [**Price**](Price.md) |
|
|
22
|
-
**salePrice** | [**SalePrice**](SalePrice.md) |
|
|
21
|
+
**retailPrice** | [**Price**](Price.md) | The retail price of the product, including tax. Only provided if the product is a bundle. | [optional] [default to undefined]
|
|
22
|
+
**salePrice** | [**SalePrice**](SalePrice.md) | The sale price of the product, including tax. Only provided if the product is a bundle. | [optional] [default to undefined]
|
|
23
23
|
**images** | [**Array<ImageFile>**](ImageFile.md) | Images to attach to the product. For example, photos of models using/wearing the product. | [optional] [default to undefined]
|
|
24
24
|
**videos** | [**Array<VideoFile>**](VideoFile.md) | Videos to attach to the product. | [optional] [default to undefined]
|
|
25
25
|
**additionalFiles** | [**Array<AdditionalFile>**](AdditionalFile.md) | Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc. | [optional] [default to undefined]
|
|
@@ -31,6 +31,7 @@ Name | Type | Description | Notes
|
|
|
31
31
|
**license** | [**UpdateProductsRequestProductsInnerLicense**](UpdateProductsRequestProductsInnerLicense.md) | | [optional] [default to undefined]
|
|
32
32
|
**integrationConnections** | [**Array<UpdateProductRequestIntegrationConnectionsInner>**](UpdateProductRequestIntegrationConnectionsInner.md) | Integration connections for the product | [optional] [default to undefined]
|
|
33
33
|
**showSaleBadge** | **boolean** | Whether to show a sale badge on the product | [optional] [default to true]
|
|
34
|
+
**collections** | [**Array<UpdateProductsRequestProductsInnerCollectionsInner>**](UpdateProductsRequestProductsInnerCollectionsInner.md) | An exclusive list of collection IDs to assign to the product. Replaces all existing static collection memberships. Requires the website integration. | [optional] [default to undefined]
|
|
34
35
|
|
|
35
36
|
## Example
|
|
36
37
|
|
|
@@ -64,6 +65,7 @@ const instance: UpdateProductRequest = {
|
|
|
64
65
|
license,
|
|
65
66
|
integrationConnections,
|
|
66
67
|
showSaleBadge,
|
|
68
|
+
collections,
|
|
67
69
|
};
|
|
68
70
|
```
|
|
69
71
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **string** |
|
|
8
|
+
**id** | **string** | The product UUID to include in the bundle | [optional] [default to undefined]
|
|
9
9
|
**config** | [**UpdateProductRequestBundleItemsInnerConfig**](UpdateProductRequestBundleItemsInnerConfig.md) | | [optional] [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**shopifyId** | **number** | 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. | [optional] [default to undefined]
|
|
20
20
|
**integrationConnections** | [**Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md) | | [optional] [default to undefined]
|
|
21
21
|
**showSaleBadge** | **boolean** | Whether to show a sale badge on the product | [optional] [default to true]
|
|
22
|
+
**collections** | [**Array<UpdateProductsRequestProductsInnerCollectionsInner>**](UpdateProductsRequestProductsInnerCollectionsInner.md) | An exclusive list of collection IDs to assign to the product. Replaces all existing static collection memberships. Requires the website integration. | [optional] [default to undefined]
|
|
22
23
|
**license** | [**UpdateProductsRequestProductsInnerLicense**](UpdateProductsRequestProductsInnerLicense.md) | | [optional] [default to undefined]
|
|
23
24
|
|
|
24
25
|
## Example
|
|
@@ -41,6 +42,7 @@ const instance: UpdateProductsRequestProductsInner = {
|
|
|
41
42
|
shopifyId,
|
|
42
43
|
integrationConnections,
|
|
43
44
|
showSaleBadge,
|
|
45
|
+
collections,
|
|
44
46
|
license,
|
|
45
47
|
};
|
|
46
48
|
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpdateProductsRequestProductsInnerCollectionsInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { UpdateProductsRequestProductsInnerCollectionsInner } from '@teemill/product-catalog';
|
|
14
|
+
|
|
15
|
+
const instance: UpdateProductsRequestProductsInnerCollectionsInner = {
|
|
16
|
+
id,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/UserList.md
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
# UserList
|
|
2
2
|
|
|
3
|
+
A list of users who have created products for the project.
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
6
7
|
Name | Type | Description | Notes
|
|
7
8
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**creators** | [**Array<UserListCreatorsInner>**](UserListCreatorsInner.md) |
|
|
9
|
+
**creators** | [**Array<UserListCreatorsInner>**](UserListCreatorsInner.md) | The list of product creators. | [default to undefined]
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
package/docs/Variant.md
CHANGED
|
@@ -1,14 +1,15 @@
|
|
|
1
1
|
# Variant
|
|
2
2
|
|
|
3
|
+
A specific colour/size combination of a catalog product with its own SKU, pricing, stock, and design applications.
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
6
7
|
Name | Type | Description | Notes
|
|
7
8
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **string** |
|
|
9
|
-
**attributes** | [**Array<Attribute>**](Attribute.md) |
|
|
10
|
-
**sku** | **string** |
|
|
11
|
-
**ref** | **string** | A reference to
|
|
9
|
+
**id** | **string** | The unique identifier of the variant. | [optional] [default to undefined]
|
|
10
|
+
**attributes** | [**Array<Attribute>**](Attribute.md) | The attributes (e.g. Colour, Size) that define this variant. | [default to undefined]
|
|
11
|
+
**sku** | **string** | The stock keeping unit code for this variant. | [default to undefined]
|
|
12
|
+
**ref** | **string** | A URI reference to this variant resource. | [optional] [default to undefined]
|
|
12
13
|
**product** | [**VariantProduct**](VariantProduct.md) | | [optional] [default to undefined]
|
|
13
14
|
**sortOrder** | **number** | | [optional] [readonly] [default to undefined]
|
|
14
15
|
**retailPrice** | [**Price**](Price.md) | | [optional] [default to undefined]
|
|
@@ -5,10 +5,10 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**item** | [**RequiredPrice**](RequiredPrice.md) |
|
|
8
|
+
**item** | [**RequiredPrice**](RequiredPrice.md) | The cost of the variant alone | [default to undefined]
|
|
9
9
|
**applications** | [**Array<NamedPrice>**](NamedPrice.md) | A breakdown of the cost per application | [default to undefined]
|
|
10
10
|
**handling** | [**Array<NamedPrice>**](NamedPrice.md) | a breakdown of the cost per handling fee | [default to undefined]
|
|
11
|
-
**fulfillment** | [**RequiredPrice**](RequiredPrice.md) |
|
|
11
|
+
**fulfillment** | [**RequiredPrice**](RequiredPrice.md) | The total cost of fulfillment for the variant. This includes the cost of the variant, the cost of the applications, and the cost of the handling fees. | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
package/docs/Video.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# Video
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A video associated with a product.
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **string** |
|
|
9
|
+
**id** | **string** | The unique identifier of the video. | [optional] [default to undefined]
|
|
10
10
|
**src** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**alt** | **string** | | [optional] [default to undefined]
|
|
12
12
|
**sortOrder** | **number** | | [optional] [default to undefined]
|
package/docs/VideoFile.md
CHANGED
package/index.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog
|
|
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 product from the GFN Catalog, 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.92.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@teemill/product-catalog",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.92.1",
|
|
4
4
|
"description": "OpenAPI client for @teemill/product-catalog",
|
|
5
5
|
"author": "OpenAPI-Generator Contributors",
|
|
6
6
|
"repository": {
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
"prepare": "npm run build"
|
|
25
25
|
},
|
|
26
26
|
"dependencies": {
|
|
27
|
-
"axios": "1.
|
|
27
|
+
"axios": "1.15.0"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
30
|
"@types/node": "12.11.5 - 12.20.42",
|