@teemill/product-catalog 1.88.0 → 1.89.0

package/docs/CreateDigitalProductVariantsInnerImagesInner.md

@@ -0,0 +1,20 @@
+# CreateDigitalProductVariantsInnerImagesInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**src** | **string** | Publicly available file URL. | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateDigitalProductVariantsInnerImagesInner } from '@teemill/product-catalog';
+
+const instance: CreateDigitalProductVariantsInnerImagesInner = {
+    src,
+};
+```
+
+[[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/CreateProduct.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **gfnProductRef** | **string** | Reference to the product in the GFN catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API. | [default to undefined]
 **title** | **string** | Product title | [optional] [default to undefined]
 **description** | **string** | Product description | [optional] [default to undefined]
-**enabled** | **boolean** | Whether the product is enabled upon creation. | [optional] [default to undefined]
+**enabled** | **boolean** | Whether the product is enabled upon creation. | [optional] [default to true]
 **slug** | **string** | A custom URL slug for the product. This must be unique for each product on the project. | [optional] [default to undefined]
 **brand** | **string** | The brand of the product. | [optional] [default to undefined]
 **seoMetadata** | [**UpdateProductsRequestProductsInnerSeoMetadata**](UpdateProductsRequestProductsInnerSeoMetadata.md) |  | [optional] [default to undefined]
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 **targetSearchPhraseSynonyms** | **Array<string>** | Synonyms for the target search phrase. **Note:** This field requires the website integration | [optional] [default to undefined]
 **tags** | **Array<string>** | Additional product tags used for searching and filtering. | [optional] [default to undefined]
 **internalTags** | **Array<string>** | Internal tags used for internal searching and filtering. | [optional] [default to undefined]
-**variants** | [**Array<CreateProductVariant>**](CreateProductVariant.md) | Variants | [default to undefined]
+**variants** | [**Array<CreateProductVariant>**](CreateProductVariant.md) | The variants to create for this product. Each variant must specify attributes that match a variant in the GFN Catalog for the product referenced by gfnProductRef. Use the GFN Catalog API to list products and variants (e.g. GET /v1/gfn/catalog/products/{productId} and GET /v1/gfn/catalog/variants) to get the exact attribute names and values — they must match exactly, including casing. | [default to undefined]
 **images** | [**Array<CreateProductImagesInner>**](CreateProductImagesInner.md) | Images to attach to the product. For example, photos of models using/wearing the product. | [optional] [default to undefined]
 **videos** | [**Array<CreateProductVideosInner>**](CreateProductVideosInner.md) | Videos to attach to the product. | [optional] [default to undefined]
 **additionalFiles** | [**Array<CreateProductAdditionalFilesInner>**](CreateProductAdditionalFilesInner.md) | Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc. | [optional] [default to undefined]

package/docs/CreateProductRequest.md

@@ -6,7 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **gfnProductRef** | **string** | Reference to the product in the GFN catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API. | [default to undefined]
-**title** | **string** | Product title | [optional] [default to undefined]
+**title** | **string** | The title of the product | [default to undefined]
 **description** | **string** | Product description | [optional] [default to undefined]
 **enabled** | **boolean** | Whether the product is enabled upon creation. | [optional] [default to undefined]
 **slug** | **string** | A custom URL slug for the product. This must be unique for each product on the project. | [optional] [default to undefined]
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 **targetSearchPhraseSynonyms** | **Array<string>** | Synonyms for the target search phrase. **Note:** This field requires the website integration | [optional] [default to undefined]
 **tags** | **Array<string>** | Additional product tags used for searching and filtering. | [optional] [default to undefined]
 **internalTags** | **Array<string>** | Internal tags used for internal searching and filtering. | [optional] [default to undefined]
-**variants** | [**Array<CreateProductVariant>**](CreateProductVariant.md) | Variants | [default to undefined]
+**variants** | [**Array<CreateDigitalProductVariantsInner>**](CreateDigitalProductVariantsInner.md) | A list of variants to create for the product. | [default to undefined]
 **images** | [**Array<CreateProductImagesInner>**](CreateProductImagesInner.md) | Images to attach to the product. For example, photos of models using/wearing the product. | [optional] [default to undefined]
 **videos** | [**Array<CreateProductVideosInner>**](CreateProductVideosInner.md) | Videos to attach to the product. | [optional] [default to undefined]
 **additionalFiles** | [**Array<CreateProductAdditionalFilesInner>**](CreateProductAdditionalFilesInner.md) | Additional files to attach to the product. For example, original design files e.g. PSD, AI, etc. | [optional] [default to undefined]
@@ -30,6 +30,7 @@ Name | Type | Description | Notes
 **retailPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
 **salePrice** | [**SalePrice**](SalePrice.md) |  | [optional] [default to undefined]
 **price** | [**Price**](Price.md) |  | [optional] [readonly] [default to undefined]
+**isDigital** | **boolean** | An explicit flag to indicate that the product is a digital product. | [default to undefined]
 
 ## Example
 
@@ -62,6 +63,7 @@ const instance: CreateProductRequest = {
     retailPrice,
     salePrice,
     price,
+    isDigital,
 };
 ```
 

package/docs/CreateProductVariant.md

@@ -5,12 +5,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**attributes** | [**Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>**](UpdateProductsRequestProductsInnerVariantsInnerAttributesInner.md) | Attributes associated to a variant such as Colour and Size. | [default to undefined]
+**attributes** | [**Array<CreateProductVariantAttributesInner>**](CreateProductVariantAttributesInner.md) | One entry per attribute (e.g. Size, Colour). The name and value of each attribute must match the GFN Catalog API exactly — use the GFN Catalog API to list the product and its variants to get the exact strings (casing and spelling must match). | [default to undefined]
 **retailPrice** | [**UpdateProductsRequestProductsInnerVariantsInnerRetailPrice**](UpdateProductsRequestProductsInnerVariantsInnerRetailPrice.md) |  | [default to undefined]
 **salePrice** | [**UpdateProductsRequestProductsInnerVariantsInnerSalePrice**](UpdateProductsRequestProductsInnerVariantsInnerSalePrice.md) |  | [optional] [default to undefined]
 **sku** | **string** | A custom stock keeping unit for the variant. | [optional] [default to undefined]
 **applications** | [**Array<Application>**](Application.md) | Design applications. If not provided, the product will be blank. | [optional] [default to undefined]
-**images** | [**Array<CreateProductVariantImagesInner>**](CreateProductVariantImagesInner.md) | Only use if you want to override the main product image. If not provided, mockups will be generated using the design applications and the warehouse product provided. Accepts PNG and JPEG files. | [optional] [default to undefined]
+**images** | [**Array<CreateProductVariantImagesInner>**](CreateProductVariantImagesInner.md) | Only use if you want to override the main product image. If not provided, mockups will be generated using the design applications and the GFN Catalog product. Accepts PNG and JPEG files. | [optional] [default to undefined]
 **barcode** | **string** | The GTIN (Global Trade Item Number) or EAN (European Article Number) of the variant. Please note that a barcode can only be attached after the Barcodes module has been installed. | [optional] [default to undefined]
 **shopifyId** | **number** | 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. | [optional] [default to undefined]
 **integrationConnections** | [**Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner.md) |  | [optional] [default to undefined]

package/docs/CreateProductVariantAttributesInner.md

@@ -0,0 +1,22 @@
+# CreateProductVariantAttributesInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Attribute name as returned by the GFN Catalog API for this product (e.g. \"Size\", \"Colour\"). Must match exactly, including casing. | [default to undefined]
+**value** | **string** | Attribute value as returned by the GFN Catalog API for this product (e.g. \"S\", \"White\"). Must match exactly, including casing. | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateProductVariantAttributesInner } from '@teemill/product-catalog';
+
+const instance: CreateProductVariantAttributesInner = {
+    name,
+    value,
+};
+```
+
+[[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/Product.md

@@ -36,6 +36,7 @@ Name | Type | Description | Notes
 **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]
+**gfnProduct** | [**ProductGfnProduct**](ProductGfnProduct.md) |  | [optional] [default to undefined]
 **metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
 **personalizationTemplate** | **string** | a JSON string representing the personalization template for the product | [optional] [default to undefined]
 **optimisationHistory** | [**Array<OptimisationHistoryItem>**](OptimisationHistoryItem.md) | History of AI optimisations performed on the product | [optional] [default to undefined]
@@ -81,6 +82,7 @@ const instance: Product = {
     includeInDataFeeds,
     shopifyId,
     warehouseProduct,
+    gfnProduct,
     metafields,
     personalizationTemplate,
     optimisationHistory,

package/docs/ProductBundleItemsInner.md

@@ -35,6 +35,7 @@ Name | Type | Description | Notes
 **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]
+**gfnProduct** | [**ProductGfnProduct**](ProductGfnProduct.md) |  | [optional] [default to undefined]
 **metafields** | [**Array<MetaField>**](MetaField.md) | Key/value pairs that can be used to store additional information about the product | [optional] [default to undefined]
 **personalizationTemplate** | **string** | a JSON string representing the personalization template for the product | [optional] [default to undefined]
 **optimisationHistory** | [**Array<OptimisationHistoryItem>**](OptimisationHistoryItem.md) | History of AI optimisations performed on the product | [optional] [default to undefined]
@@ -79,6 +80,7 @@ const instance: ProductBundleItemsInner = {
     includeInDataFeeds,
     shopifyId,
     warehouseProduct,
+    gfnProduct,
     metafields,
     personalizationTemplate,
     optimisationHistory,

package/docs/ProductGfnProduct.md

@@ -0,0 +1,25 @@
+# ProductGfnProduct
+
+The GFN Catalog product this catalog product is based on. Use the GFN Catalog API to list available products.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**gfnProductRef** | **string** | Reference to the product in the Global Fulfillment Network (GFN) catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API. | [optional] [default to undefined]
+**metafields** | [**Array<MetaField>**](MetaField.md) | Meta fields from the GFN Catalog product | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductGfnProduct } from '@teemill/product-catalog';
+
+const instance: ProductGfnProduct = {
+    id,
+    gfnProductRef,
+    metafields,
+};
+```
+
+[[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/ProductWarehouseProduct.md

@@ -1,5 +1,6 @@
 # ProductWarehouseProduct
 
+The GFN Catalog product this catalog product is based on. Use the GFN Catalog API to list available products. (Deprecated Use `gfnProduct` instead)
 
 ## Properties
 
@@ -7,7 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **string** | Unique object identifier | [optional] [default to undefined]
 **gfnProductRef** | **string** | Reference to the product in the Global Fulfillment Network (GFN) catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API. | [optional] [default to undefined]
-**metafields** | [**Array<MetaField>**](MetaField.md) | Meta fields from the warehouse product | [optional] [default to undefined]
+**metafields** | [**Array<MetaField>**](MetaField.md) | Meta fields from the GFN Catalog product | [optional] [default to undefined]
 
 ## Example
 

package/docs/ProductsApi.md

@@ -19,7 +19,7 @@ All URIs are relative to *https://api.podos.io*
 # **createProduct**
 > Product createProduct()
 
-Creates a new catalog product based on a given warehouse product with the variants and design applications provided. To select a warehouse product to base this product on, use the GFN Catalog API to list available options.
+Creates a new catalog product based on a product from the GFN Catalog, with the variants and design applications you provide. Use the [GFN Catalog API](/developer/api/gfn-catalog) to list available products and their variants (including exact attribute names and values) for the project.
 
 ### Example
 

package/docs/Variant.md

@@ -27,6 +27,7 @@ Name | Type | Description | Notes
 **integrationConnections** | [**Array<VariantIntegrationConnectionsInner>**](VariantIntegrationConnectionsInner.md) |  | [optional] [default to undefined]
 **wholesaleCost** | [**VariantWholesaleCost**](VariantWholesaleCost.md) |  | [optional] [default to undefined]
 **warehouseVariant** | [**VariantWarehouseVariant**](VariantWarehouseVariant.md) |  | [optional] [default to undefined]
+**gfnVariant** | [**VariantGfnVariant**](VariantGfnVariant.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -56,6 +57,7 @@ const instance: Variant = {
     integrationConnections,
     wholesaleCost,
     warehouseVariant,
+    gfnVariant,
 };
 ```
 

package/docs/VariantGfnVariant.md

@@ -0,0 +1,25 @@
+# VariantGfnVariant
+
+The GFN Catalog variant this catalog variant corresponds to. Use the GFN Catalog API to list variants and their attributes.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**gfnVariantRef** | **string** | Reference to the variant in the Global Fulfillment Network (GFN) catalog. | [optional] [default to undefined]
+**metafields** | [**Array<MetaField>**](MetaField.md) | Meta fields from the GFN Catalog variant | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { VariantGfnVariant } from '@teemill/product-catalog';
+
+const instance: VariantGfnVariant = {
+    id,
+    gfnVariantRef,
+    metafields,
+};
+```
+
+[[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/VariantWarehouseVariant.md

@@ -1,5 +1,6 @@
 # VariantWarehouseVariant
 
+The GFN Catalog variant this catalog variant corresponds to. Use the GFN Catalog API to list variants and their attributes. (Deprecated Use `gfnVariant` instead)
 
 ## Properties
 
@@ -7,7 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **string** | Unique object identifier | [optional] [default to undefined]
 **gfnVariantRef** | **string** | Reference to the variant in the Global Fulfillment Network (GFN) catalog. | [optional] [default to undefined]
-**metafields** | [**Array<MetaField>**](MetaField.md) | Meta fields from the warehouse variant | [optional] [default to undefined]
+**metafields** | [**Array<MetaField>**](MetaField.md) | Meta fields from the GFN Catalog variant | [optional] [default to undefined]
 
 ## Example
 

package/index.ts

@@ -1,10 +1,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Product Catalog API
- * 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.
+ * 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.88.0
+ * The version of the OpenAPI document: 1.89.0
  * 
  *
  * 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.88.0",
+  "version": "1.89.0",
   "description": "OpenAPI client for @teemill/product-catalog",
   "author": "OpenAPI-Generator Contributors",
   "repository": {