@teemill/product-catalog 1.48.0 → 1.49.0

package/docs/CreateProductRequest.md

@@ -0,0 +1,64 @@
+# CreateProductRequest
+
+
+## Properties
+
+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]
+**slug** | **string** | A custom URL slug for the product. This must be unique for each product on the project. | [optional] [default to undefined]
+**seoMetadata** | [**UpdateProductsRequestProductsInnerSeoMetadata**](UpdateProductsRequestProductsInnerSeoMetadata.md) |  | [optional] [default to undefined]
+**targetSearchPhrase** | **string** | 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 | [optional] [default to undefined]
+**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]
+**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]
+**applicationSets** | **Array<string>** | List of application set UUIDs to associate with this product | [optional] [default to undefined]
+**includeInDataFeeds** | **boolean** | Whether the product should be included in data feeds that can be provided to Google, Meta etc for advertising. | [optional] [default to true]
+**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]
+**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 object that defines the personalization template for the product. | [optional] [default to undefined]
+**bundleItems** | **Array<string>** | A list of product uuids to include in this bundle | [default to undefined]
+**retailPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+**salePrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+**price** | [**Price**](Price.md) |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateProductRequest } from '@teemill/product-catalog';
+
+const instance: CreateProductRequest = {
+    gfnProductRef,
+    title,
+    description,
+    enabled,
+    slug,
+    seoMetadata,
+    targetSearchPhrase,
+    targetSearchPhraseSynonyms,
+    tags,
+    internalTags,
+    variants,
+    images,
+    videos,
+    additionalFiles,
+    applicationSets,
+    includeInDataFeeds,
+    shopifyId,
+    metafields,
+    personalizationTemplate,
+    bundleItems,
+    retailPrice,
+    salePrice,
+    price,
+};
+```
+
+[[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/CreateProductVariant.md

@@ -0,0 +1,36 @@
+# CreateProductVariant
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attributes** | [**Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>**](UpdateProductsRequestProductsInnerVariantsInnerAttributesInner.md) | Attributes associated to a variant such as Colour and Size. | [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]
+**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]
+
+## Example
+
+```typescript
+import { CreateProductVariant } from '@teemill/product-catalog';
+
+const instance: CreateProductVariant = {
+    attributes,
+    retailPrice,
+    salePrice,
+    sku,
+    applications,
+    images,
+    barcode,
+    shopifyId,
+    integrationConnections,
+};
+```
+
+[[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/CreateProductVariantImagesInner.md

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

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

@@ -0,0 +1,20 @@
+# DuplicateProducts202Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message describing the duplication status | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DuplicateProducts202Response } from '@teemill/product-catalog';
+
+const instance: DuplicateProducts202Response = {
+    message,
+};
+```
+
+[[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/DuplicateProductsRequest.md

@@ -0,0 +1,22 @@
+# DuplicateProductsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ids** | **Array<string>** | A set of product IDs to duplicate. | [default to undefined]
+**projects** | **Array<string>** | A set of project IDs to duplicate the products to. | [default to undefined]
+
+## Example
+
+```typescript
+import { DuplicateProductsRequest } from '@teemill/product-catalog';
+
+const instance: DuplicateProductsRequest = {
+    ids,
+    projects,
+};
+```
+
+[[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/ExportProducts202Response.md

@@ -0,0 +1,20 @@
+# ExportProducts202Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message describing the export status | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ExportProducts202Response } from '@teemill/product-catalog';
+
+const instance: ExportProducts202Response = {
+    message,
+};
+```
+
+[[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/Image.md

@@ -0,0 +1,35 @@
+# Image
+
+Image description
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**src** | **string** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**alt** | **string** |  | [optional] [default to undefined]
+**variantIds** | **Array<string>** | List of variant Ids | [optional] [default to undefined]
+**sortOrder** | **number** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Image } from '@teemill/product-catalog';
+
+const instance: Image = {
+    id,
+    src,
+    type,
+    alt,
+    variantIds,
+    sortOrder,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[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/ImageFile.md

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

@@ -0,0 +1,20 @@
+# ImportProducts200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**importId** | **string** | Id of the product import | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ImportProducts200Response } from '@teemill/product-catalog';
+
+const instance: ImportProducts200Response = {
+    importId,
+};
+```
+
+[[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/Location.md

@@ -0,0 +1,22 @@
+# Location
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**level** | **number** | The total number of units available at the location | [default to undefined]
+**country** | **string** | ISO alpha-2 country code | [default to undefined]
+
+## Example
+
+```typescript
+import { Location } from '@teemill/product-catalog';
+
+const instance: Location = {
+    level,
+    country,
+};
+```
+
+[[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/MetaField.md

@@ -0,0 +1,23 @@
+# MetaField
+
+Key/value pairs that can be used to store additional information on the product
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** | The key of the property | [default to undefined]
+**value** | **string** | The string value of the property | [default to undefined]
+
+## Example
+
+```typescript
+import { MetaField } from '@teemill/product-catalog';
+
+const instance: MetaField = {
+    key,
+    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/OptimisationHistoryItem.md

@@ -0,0 +1,22 @@
+# OptimisationHistoryItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OptimisationHistoryItem } from '@teemill/product-catalog';
+
+const instance: OptimisationHistoryItem = {
+    id,
+    createdAt,
+};
+```
+
+[[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/Price.md

@@ -0,0 +1,23 @@
+# Price
+
+Standard price definition that defines the amount, tax rate and currency.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **number** | Price including tax in the specified currency. | [optional] [default to undefined]
+**currencyCode** | **string** | Currency code for the currency the price is valued in. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Price } from '@teemill/product-catalog';
+
+const instance: Price = {
+    amount,
+    currencyCode,
+};
+```
+
+[[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

@@ -0,0 +1,86 @@
+# Product
+
+
+## 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]
+**description** | **string** |  | [default to undefined]
+**slug** | **string** |  | [optional] [readonly] [default to undefined]
+**enabled** | **boolean** |  | [optional] [default to undefined]
+**seoMetadata** | [**SEOMetadata**](SEOMetadata.md) |  | [optional] [default to undefined]
+**targetSearchPhraseData** | [**TargetSearchPhraseData**](TargetSearchPhraseData.md) |  | [optional] [default to undefined]
+**tags** | **Array<string>** |  | [optional] [default to undefined]
+**internalTags** | **Array<string>** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+**publishedAt** | **string** |  | [optional] [default to undefined]
+**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]
+**bundleItems** | [**Array<Product>**](Product.md) | Products in the bundle. | [optional] [default to undefined]
+**retailPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+**salePrice** | [**Price**](Price.md) |  | [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]
+**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]
+**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]
+**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]
+**integrationConnections** | [**Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>**](UpdateProductsRequestProductsInnerIntegrationConnectionsInner.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Product } from '@teemill/product-catalog';
+
+const instance: Product = {
+    id,
+    ref,
+    title,
+    description,
+    slug,
+    enabled,
+    seoMetadata,
+    targetSearchPhraseData,
+    tags,
+    internalTags,
+    createdAt,
+    updatedAt,
+    publishedAt,
+    images,
+    videos,
+    variants,
+    bundleItems,
+    retailPrice,
+    salePrice,
+    additionalFiles,
+    applicationSets,
+    reviewScore,
+    reviewCount,
+    sku,
+    sales,
+    salesStart,
+    salesEnd,
+    includeInDataFeeds,
+    shopifyId,
+    warehouseProduct,
+    metafields,
+    personalizationTemplate,
+    optimisationHistory,
+    integrationConnections,
+};
+```
+
+[[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/ProductAdditionalFilesInner.md

@@ -0,0 +1,22 @@
+# ProductAdditionalFilesInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**src** | **string** | File URL | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductAdditionalFilesInner } from '@teemill/product-catalog';
+
+const instance: ProductAdditionalFilesInner = {
+    id,
+    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/ProductApplicationSetsInner.md

@@ -0,0 +1,24 @@
+# ProductApplicationSetsInner
+
+
+## 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]
+**name** | **string** | Name of the application set | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductApplicationSetsInner } from '@teemill/product-catalog';
+
+const instance: ProductApplicationSetsInner = {
+    id,
+    ref,
+    name,
+};
+```
+
+[[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

@@ -0,0 +1,22 @@
+# ProductWarehouseProduct
+
+
+## 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]
+
+## Example
+
+```typescript
+import { ProductWarehouseProduct } from '@teemill/product-catalog';
+
+const instance: ProductWarehouseProduct = {
+    id,
+    gfnProductRef,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)