@teemill/product-catalog 1.92.0 → 1.92.1

package/docs/Product.md

@@ -1,13 +1,14 @@
 # Product
 
+A catalog product listing that can be purchased, containing design applications, pricing, variants, and SEO metadata.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | Unique object identifier | [optional] [default to undefined]
-**ref** | **string** | A reference to the resource location | [optional] [default to undefined]
-**title** | **string** |  | [default to undefined]
+**id** | **string** | The unique identifier of the product. | [optional] [default to undefined]
+**ref** | **string** | A URI reference to this product resource. | [optional] [default to undefined]
+**title** | **string** | The display title of the product. | [default to undefined]
 **description** | **string** |  | [default to undefined]
 **slug** | **string** |  | [optional] [readonly] [default to undefined]
 **brand** | **string** |  | [optional] [default to undefined]
@@ -23,16 +24,16 @@ Name | Type | Description | Notes
 **videos** | [**Array<Video>**](Video.md) | Videos | [optional] [default to undefined]
 **variants** | [**Array<Variant>**](Variant.md) | Variants | [optional] [default to undefined]
 **bundleItems** | [**Array<ProductBundleItemsInner>**](ProductBundleItemsInner.md) | Products in the bundle. | [optional] [default to undefined]
-**retailPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
-**salePrice** | [**SalePrice**](SalePrice.md) |  | [optional] [default to undefined]
+**retailPrice** | [**Price**](Price.md) | The retail price of the product, including tax. Only provided if the product is a bundle. | [optional] [default to undefined]
+**salePrice** | [**SalePrice**](SalePrice.md) | The sale price of the product, including tax. Only provided if the product is a bundle. | [optional] [default to undefined]
 **additionalFiles** | [**Array<ProductAdditionalFilesInner>**](ProductAdditionalFilesInner.md) | Additional files attached to the product. | [optional] [default to undefined]
 **applicationSets** | [**Array<ProductApplicationSetsInner>**](ProductApplicationSetsInner.md) | List of application sets associated with this product | [optional] [default to undefined]
 **reviewScore** | **number** | The average review rating. This field is only present if included in the fields query parameter | [optional] [default to undefined]
 **reviewCount** | **number** | A count of reviews. This field is only present if included in the fields query parameter | [optional] [default to undefined]
-**sku** | **string** |  | [optional] [default to undefined]
+**sku** | **string** | A unique identifier for a specific variant (product + colour + size). | [optional] [default to undefined]
 **sales** | **number** | A count of sales. This field is only present if included in the fields query parameter | [optional] [default to undefined]
-**salesStart** | **string** |  | [optional] [default to undefined]
-**salesEnd** | **string** |  | [optional] [default to undefined]
+**salesStart** | **string** | The start of the window in which sales are counted | [optional] [default to undefined]
+**salesEnd** | **string** | The end of the window in which sales are counted | [optional] [default to undefined]
 **includeInDataFeeds** | **boolean** |  | [optional] [default to undefined]
 **shopifyId** | **number** | For use with the Shopify integration. The Shopify product ID that this product is linked to. | [optional] [default to undefined]
 **warehouseProduct** | [**ProductWarehouseProduct**](ProductWarehouseProduct.md) |  | [optional] [default to undefined]

package/docs/ProductAnalyticsApi.md

@@ -103,8 +103,8 @@ const { status, data } = await apiInstance.exportProductAnalytics(
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Returns the CSV export |  -  |
-|**202** | Export started. When complete, the export will be available for download from a notification within PodOS Dashboard. |  -  |
+|**200** | The dataset is small enough to return immediately. Returns the CSV export directly. |  -  |
+|**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. |  -  |
 |**401** | Not authorised to access this resource. |  -  |
 |**403** | Refuse to authorize. |  -  |
 |**500** | Unknown server error. |  -  |

package/docs/ProductBundleItemsInner.md

@@ -5,9 +5,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | Unique object identifier | [optional] [default to undefined]
-**ref** | **string** | A reference to the resource location | [optional] [default to undefined]
-**title** | **string** |  | [default to undefined]
+**id** | **string** | The unique identifier of the bundle product. | [optional] [default to undefined]
+**ref** | **string** | A URI reference to this bundle product resource. | [optional] [default to undefined]
+**title** | **string** | The display title of the bundle product. | [default to undefined]
 **description** | **string** |  | [default to undefined]
 **slug** | **string** |  | [optional] [readonly] [default to undefined]
 **brand** | **string** |  | [optional] [default to undefined]
@@ -22,16 +22,16 @@ Name | Type | Description | Notes
 **images** | [**Array<Image>**](Image.md) | Images | [optional] [default to undefined]
 **videos** | [**Array<Video>**](Video.md) | Videos | [optional] [default to undefined]
 **variants** | [**Array<Variant>**](Variant.md) | Variants | [optional] [default to undefined]
-**retailPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
-**salePrice** | [**SalePrice**](SalePrice.md) |  | [optional] [default to undefined]
+**retailPrice** | [**Price**](Price.md) | The retail price of the product, including tax. Only provided if the product is a bundle. | [optional] [default to undefined]
+**salePrice** | [**SalePrice**](SalePrice.md) | The sale price of the product, including tax. Only provided if the product is a bundle. | [optional] [default to undefined]
 **additionalFiles** | [**Array<ProductAdditionalFilesInner>**](ProductAdditionalFilesInner.md) | Additional files attached to the product. | [optional] [default to undefined]
 **applicationSets** | [**Array<ProductApplicationSetsInner>**](ProductApplicationSetsInner.md) | List of application sets associated with this product | [optional] [default to undefined]
 **reviewScore** | **number** | The average review rating. This field is only present if included in the fields query parameter | [optional] [default to undefined]
 **reviewCount** | **number** | A count of reviews. This field is only present if included in the fields query parameter | [optional] [default to undefined]
-**sku** | **string** |  | [optional] [default to undefined]
+**sku** | **string** | A unique identifier for a specific variant (product + colour + size). | [optional] [default to undefined]
 **sales** | **number** | A count of sales. This field is only present if included in the fields query parameter | [optional] [default to undefined]
-**salesStart** | **string** |  | [optional] [default to undefined]
-**salesEnd** | **string** |  | [optional] [default to undefined]
+**salesStart** | **string** | The start of the window in which sales are counted | [optional] [default to undefined]
+**salesEnd** | **string** | The end of the window in which sales are counted | [optional] [default to undefined]
 **includeInDataFeeds** | **boolean** |  | [optional] [default to undefined]
 **shopifyId** | **number** | For use with the Shopify integration. The Shopify product ID that this product is linked to. | [optional] [default to undefined]
 **warehouseProduct** | [**ProductWarehouseProduct**](ProductWarehouseProduct.md) |  | [optional] [default to undefined]

package/docs/ProductCreatorsApi.md

@@ -23,9 +23,13 @@ const configuration = new Configuration();
 const apiInstance = new ProductCreatorsApi(configuration);
 
 let project: string; //What project it is (default to undefined)
+let pageToken: number; //Page reference token (optional) (default to 1)
+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)
 
 const { status, data } = await apiInstance.listProductCreators(
-    project
+    project,
+    pageToken,
+    pageSize
 );
 ```
 
@@ -34,6 +38,8 @@ const { status, data } = await apiInstance.listProductCreators(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **project** | [**string**] | What project it is | defaults to undefined|
+| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
+| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
 
 
 ### Return type

package/docs/ProductType.md

@@ -1,11 +1,12 @@
 # ProductType
 
+A type of product available in the catalog (e.g. Printed T-Shirt, Embroidered Hoodie).
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | Unique object identifier | [default to undefined]
+**id** | **string** | The unique identifier of the product type. | [default to undefined]
 **name** | **string** | Name of the product type | [default to undefined]
 
 ## Example

package/docs/ProductsApi.md

@@ -34,7 +34,7 @@ const configuration = new Configuration();
 const apiInstance = new ProductsApi(configuration);
 
 let project: string; //What project it is (default to undefined)
-let createProductRequest: CreateProductRequest; // (optional)
+let createProductRequest: CreateProductRequest; //The product to create, including title, variants, design applications, and pricing. (optional)
 
 const { status, data } = await apiInstance.createProduct(
     project,
@@ -46,7 +46,7 @@ const { status, data } = await apiInstance.createProduct(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **createProductRequest** | **CreateProductRequest**|  | |
+| **createProductRequest** | **CreateProductRequest**| The product to create, including title, variants, design applications, and pricing. | |
 | **project** | [**string**] | What project it is | defaults to undefined|
 
 
@@ -320,8 +320,8 @@ const { status, data } = await apiInstance.exportProducts(
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Returns the CSV export |  -  |
-|**202** | Export started. When complete, the export will be available for download from a notification within PodOS Dashboard. |  -  |
+|**200** | The dataset is small enough to return immediately. Returns the CSV export directly. |  -  |
+|**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. |  -  |
 |**400** | Failed validation. |  -  |
 |**401** | Not authorised to access this resource. |  -  |
 |**403** | Refuse to authorize. |  -  |
@@ -657,7 +657,7 @@ const apiInstance = new ProductsApi(configuration);
 
 let project: string; //What project it is (default to undefined)
 let productId: string; //Product\'s unique identifier (default to undefined)
-let updateProductRequest: UpdateProductRequest; // (optional)
+let updateProductRequest: UpdateProductRequest; //The product fields to update. Only the fields provided will be modified. (optional)
 
 const { status, data } = await apiInstance.updateProduct(
     project,
@@ -670,7 +670,7 @@ const { status, data } = await apiInstance.updateProduct(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **updateProductRequest** | **UpdateProductRequest**|  | |
+| **updateProductRequest** | **UpdateProductRequest**| The product fields to update. Only the fields provided will be modified. | |
 | **project** | [**string**] | What project it is | defaults to undefined|
 | **productId** | [**string**] | Product\'s unique identifier | defaults to undefined|
 

package/docs/Recommendation.md

@@ -1,11 +1,12 @@
 # Recommendation
 
+An AI-generated recommendation for improving product performance.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | Unique object identifier | [default to undefined]
+**id** | **string** | The unique identifier of this recommendation. | [default to undefined]
 **ref** | **string** | A reference to the recommendation resource location | [default to undefined]
 **reason** | **string** | The reason for the recommendation | [default to undefined]
 **recommendation** | **string** | The recommendation for the target | [default to undefined]

package/docs/Stock.md

@@ -1,12 +1,13 @@
 # Stock
 
+Stock availability information including total level and per-location breakdown.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**level** | **number** |  | [optional] [default to undefined]
-**locations** | [**Array<Location>**](Location.md) |  | [optional] [default to undefined]
+**level** | **number** | The current total stock level available for purchase. | [optional] [default to undefined]
+**locations** | [**Array<Location>**](Location.md) | Stock levels broken down by warehouse location. | [optional] [default to undefined]
 
 ## Example
 

package/docs/TargetSearchPhraseData.md

@@ -1,5 +1,6 @@
 # TargetSearchPhraseData
 
+Target search phrase configuration for SEO optimisation of a product.
 
 ## Properties
 

package/docs/TextApplicationProperties.md

@@ -1,5 +1,6 @@
 # TextApplicationProperties
 
+Properties for a text-based application including font, colour, position, and optional personalisation. Null when the application has no configurable properties.
 
 ## Properties
 

package/docs/TextApplicationPropertiesPersonalization.md

@@ -1,5 +1,6 @@
 # TextApplicationPropertiesPersonalization
 
+Personalisation configuration for a text application, allowing end-users to customise the text content.
 
 ## Properties
 

package/docs/UpdateProductRequest.md

@@ -18,8 +18,8 @@ Name | Type | Description | Notes
 **internalTags** | **Array<string>** | Additional product tags used for internal searching and filtering. | [optional] [default to undefined]
 **variants** | [**Array<CreateProductVariant>**](CreateProductVariant.md) | Variants | [optional] [default to undefined]
 **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]
-**retailPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
-**salePrice** | [**SalePrice**](SalePrice.md) |  | [optional] [default to undefined]
+**retailPrice** | [**Price**](Price.md) | The retail price of the product, including tax. Only provided if the product is a bundle. | [optional] [default to undefined]
+**salePrice** | [**SalePrice**](SalePrice.md) | The sale price of the product, including tax. Only provided if the product is a bundle. | [optional] [default to undefined]
 **images** | [**Array<ImageFile>**](ImageFile.md) | Images to attach to the product. For example, photos of models using/wearing the product. | [optional] [default to undefined]
 **videos** | [**Array<VideoFile>**](VideoFile.md) | Videos to attach to the product. | [optional] [default to undefined]
 **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]

package/docs/UpdateProductRequestBundleItemsInner.md

@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**id** | **string** | The product UUID to include in the bundle | [optional] [default to undefined]
 **config** | [**UpdateProductRequestBundleItemsInnerConfig**](UpdateProductRequestBundleItemsInnerConfig.md) |  | [optional] [default to undefined]
 
 ## Example

package/docs/UserList.md

@@ -1,11 +1,12 @@
 # UserList
 
+A list of users who have created products for the project.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**creators** | [**Array<UserListCreatorsInner>**](UserListCreatorsInner.md) |  | [default to undefined]
+**creators** | [**Array<UserListCreatorsInner>**](UserListCreatorsInner.md) | The list of product creators. | [default to undefined]
 
 ## Example
 

package/docs/Variant.md

@@ -1,14 +1,15 @@
 # Variant
 
+A specific colour/size combination of a catalog product with its own SKU, pricing, stock, and design applications.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | Unique object identifier | [optional] [default to undefined]
-**attributes** | [**Array<Attribute>**](Attribute.md) | Attributes associated to a variant such as Colour and Size. An attribute can have thumbnail type of `text`, `color`, or `image`. Attribute tags are intended for grouping and filtering, e.g. by a group of colours. | [default to undefined]
-**sku** | **string** |  | [default to undefined]
-**ref** | **string** | A reference to the variant resource location | [optional] [default to undefined]
+**id** | **string** | The unique identifier of the variant. | [optional] [default to undefined]
+**attributes** | [**Array<Attribute>**](Attribute.md) | The attributes (e.g. Colour, Size) that define this variant. | [default to undefined]
+**sku** | **string** | The stock keeping unit code for this variant. | [default to undefined]
+**ref** | **string** | A URI reference to this variant resource. | [optional] [default to undefined]
 **product** | [**VariantProduct**](VariantProduct.md) |  | [optional] [default to undefined]
 **sortOrder** | **number** |  | [optional] [readonly] [default to undefined]
 **retailPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]

package/docs/VariantWholesaleCost.md

@@ -5,10 +5,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**item** | [**RequiredPrice**](RequiredPrice.md) |  | [default to undefined]
+**item** | [**RequiredPrice**](RequiredPrice.md) | The cost of the variant alone | [default to undefined]
 **applications** | [**Array<NamedPrice>**](NamedPrice.md) | A breakdown of the cost per application | [default to undefined]
 **handling** | [**Array<NamedPrice>**](NamedPrice.md) | a breakdown of the cost per handling fee | [default to undefined]
-**fulfillment** | [**RequiredPrice**](RequiredPrice.md) |  | [default to undefined]
+**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]
 
 ## Example
 

package/docs/Video.md

@@ -1,12 +1,12 @@
 # Video
 
-Video object
+A video associated with a product.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**id** | **string** | The unique identifier of the video. | [optional] [default to undefined]
 **src** | **string** |  | [optional] [default to undefined]
 **alt** | **string** |  | [optional] [default to undefined]
 **sortOrder** | **number** |  | [optional] [default to undefined]

package/docs/VideoFile.md

@@ -1,5 +1,6 @@
 # VideoFile
 
+A video file to attach to a product, specified by a publicly available URL.
 
 ## Properties
 

package/index.ts

@@ -4,7 +4,7 @@
  * Product Catalog
  * 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.
  *
- * The version of the OpenAPI document: 1.92.0
+ * The version of the OpenAPI document: 1.92.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/product-catalog",
-  "version": "1.92.0",
+  "version": "1.92.1",
   "description": "OpenAPI client for @teemill/product-catalog",
   "author": "OpenAPI-Generator Contributors",
   "repository": {
@@ -24,7 +24,7 @@
     "prepare": "npm run build"
   },
   "dependencies": {
-    "axios": "1.13.5"
+    "axios": "1.15.0"
   },
   "devDependencies": {
     "@types/node": "12.11.5 - 12.20.42",