@teemill/product-catalog 1.88.0 → 1.89.0

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/product-catalog@1.88.0
+## @teemill/product-catalog@1.89.0
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @teemill/product-catalog@1.88.0 --save
+npm install @teemill/product-catalog@1.89.0 --save
 ```
 
 _unPublished (not recommended):_
@@ -121,11 +121,16 @@ Class | Method | HTTP request | Description
  - [CreateBundleProduct](docs/CreateBundleProduct.md)
  - [CreateBundleProductBundleItemsInner](docs/CreateBundleProductBundleItemsInner.md)
  - [CreateBundleProductSeoMetadata](docs/CreateBundleProductSeoMetadata.md)
+ - [CreateDigitalProduct](docs/CreateDigitalProduct.md)
+ - [CreateDigitalProductVariantsInner](docs/CreateDigitalProductVariantsInner.md)
+ - [CreateDigitalProductVariantsInnerAttributesInner](docs/CreateDigitalProductVariantsInnerAttributesInner.md)
+ - [CreateDigitalProductVariantsInnerImagesInner](docs/CreateDigitalProductVariantsInnerImagesInner.md)
  - [CreateProduct](docs/CreateProduct.md)
  - [CreateProductAdditionalFilesInner](docs/CreateProductAdditionalFilesInner.md)
  - [CreateProductImagesInner](docs/CreateProductImagesInner.md)
  - [CreateProductRequest](docs/CreateProductRequest.md)
  - [CreateProductVariant](docs/CreateProductVariant.md)
+ - [CreateProductVariantAttributesInner](docs/CreateProductVariantAttributesInner.md)
  - [CreateProductVariantImagesInner](docs/CreateProductVariantImagesInner.md)
  - [CreateProductVideosInner](docs/CreateProductVideosInner.md)
  - [DeleteProductsRequest](docs/DeleteProductsRequest.md)
@@ -147,6 +152,7 @@ Class | Method | HTTP request | Description
  - [ProductAnalyticsResponse](docs/ProductAnalyticsResponse.md)
  - [ProductApplicationSetsInner](docs/ProductApplicationSetsInner.md)
  - [ProductBundleItemsInner](docs/ProductBundleItemsInner.md)
+ - [ProductGfnProduct](docs/ProductGfnProduct.md)
  - [ProductType](docs/ProductType.md)
  - [ProductTypeListResponse](docs/ProductTypeListResponse.md)
  - [ProductWarehouseProduct](docs/ProductWarehouseProduct.md)
@@ -187,6 +193,7 @@ Class | Method | HTTP request | Description
  - [UserListCreatorsInner](docs/UserListCreatorsInner.md)
  - [UserListCreatorsInnerAvatar](docs/UserListCreatorsInnerAvatar.md)
  - [Variant](docs/Variant.md)
+ - [VariantGfnVariant](docs/VariantGfnVariant.md)
  - [VariantIntegrationConnectionsInner](docs/VariantIntegrationConnectionsInner.md)
  - [VariantProduct](docs/VariantProduct.md)
  - [VariantWarehouseVariant](docs/VariantWarehouseVariant.md)

package/api.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).
@@ -116,7 +116,7 @@ export interface Application {
      */
     'additionalInstructions'?: string | null;
     /**
-     * Publicly available design file URL. This will fill the design area of the warehouse product. It will be centered horizontally and aligned to the top of the design area.
+     * Publicly available design file URL. This will fill the design area of the GFN Catalog product. It will be centered horizontally and aligned to the top of the design area.
      */
     'src'?: string;
     /**
@@ -250,7 +250,7 @@ export interface ApplicationPropertiesPosition {
     'z'?: number;
 }
 /**
- * Set these properties when you don\'t have position information for the application. We will use the mockup and baseFlat to calculate the position of the application relative to the bounding box of the warehouse product.
+ * Set these properties when you don\'t have position information for the application. We will use the mockup and baseFlat to calculate the position of the application relative to the bounding box of the GFN Catalog product.
  */
 export interface ApplicationPropertiesPositionInference {
     /**
@@ -514,7 +514,11 @@ export interface BundleProduct {
      * For use with the Shopify integration. The Shopify product ID that this product is linked to.
      */
     'shopifyId'?: number | null;
+    /**
+     * @deprecated
+     */
     'warehouseProduct'?: ProductWarehouseProduct;
+    'gfnProduct'?: ProductGfnProduct;
     /**
      * Key/value pairs that can be used to store additional information about the product
      */
@@ -548,7 +552,7 @@ export interface CreateApplication {
      */
     'additionalInstructions'?: string | null;
     /**
-     * Publicly available design file URL. This will fill the design area of the warehouse product. It will be centered horizontally and aligned to the top of the design area.
+     * Publicly available design file URL. This will fill the design area of the GFN Catalog product. It will be centered horizontally and aligned to the top of the design area.
      */
     'src': string;
     /**
@@ -774,6 +778,50 @@ export interface CreateBundleProductSeoMetadata {
      */
     'description'?: string | null;
 }
+/**
+ * A digital product is a product that is not physical, it is a service that is sold.
+ */
+export interface CreateDigitalProduct {
+    /**
+     * The title of the product
+     */
+    'title': string;
+    /**
+     * An explicit flag to indicate that the product is a digital product.
+     */
+    'isDigital': boolean;
+    /**
+     * A list of variants to create for the product.
+     */
+    'variants': Array<CreateDigitalProductVariantsInner>;
+}
+export interface CreateDigitalProductVariantsInner {
+    /**
+     * The attributes of the variant.
+     */
+    'attributes': Array<CreateDigitalProductVariantsInnerAttributesInner>;
+    /**
+     * Images to attach to the product.
+     */
+    'images': Array<CreateDigitalProductVariantsInnerImagesInner>;
+    'retailPrice': Price;
+}
+export interface CreateDigitalProductVariantsInnerAttributesInner {
+    /**
+     * The name of the attribute.
+     */
+    'name': string;
+    /**
+     * The value of the attribute.
+     */
+    'value': string;
+}
+export interface CreateDigitalProductVariantsInnerImagesInner {
+    /**
+     * Publicly available file URL.
+     */
+    'src': string;
+}
 export interface CreateProduct {
     /**
      * 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.
@@ -817,7 +865,7 @@ export interface CreateProduct {
      */
     'internalTags'?: Array<string>;
     /**
-     * Variants
+     * 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.
      */
     'variants': Array<CreateProductVariant>;
     /**
@@ -873,13 +921,13 @@ export interface CreateProductImagesInner {
 /**
  * @type CreateProductRequest
  */
-export type CreateProductRequest = CreateBundleProduct | CreateProduct;
+export type CreateProductRequest = CreateBundleProduct | CreateDigitalProduct | CreateProduct;
 
 export interface CreateProductVariant {
     /**
-     * Attributes associated to a variant such as Colour and Size.
+     * 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).
      */
-    'attributes': Array<UpdateProductsRequestProductsInnerVariantsInnerAttributesInner>;
+    'attributes': Array<CreateProductVariantAttributesInner>;
     'retailPrice': UpdateProductsRequestProductsInnerVariantsInnerRetailPrice;
     'salePrice'?: UpdateProductsRequestProductsInnerVariantsInnerSalePrice | null;
     /**
@@ -891,7 +939,7 @@ export interface CreateProductVariant {
      */
     'applications'?: Array<Application>;
     /**
-     * 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.
+     * 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.
      */
     'images'?: Array<CreateProductVariantImagesInner>;
     /**
@@ -904,6 +952,24 @@ export interface CreateProductVariant {
     'shopifyId'?: number | null;
     'integrationConnections'?: Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>;
 }
+export interface CreateProductVariantAttributesInner {
+    /**
+     * Attribute name as returned by the GFN Catalog API for this product (e.g. \"Size\", \"Colour\"). Must match exactly, including casing.
+     */
+    'name': CreateProductVariantAttributesInnerNameEnum;
+    /**
+     * Attribute value as returned by the GFN Catalog API for this product (e.g. \"S\", \"White\"). Must match exactly, including casing.
+     */
+    'value': string;
+}
+
+export const CreateProductVariantAttributesInnerNameEnum = {
+    Size: 'Size',
+    Colour: 'Colour'
+} as const;
+
+export type CreateProductVariantAttributesInnerNameEnum = typeof CreateProductVariantAttributesInnerNameEnum[keyof typeof CreateProductVariantAttributesInnerNameEnum];
+
 export interface CreateProductVariantImagesInner {
     /**
      * ID of the image if it already exists. A new image will be created if this is not provided.
@@ -1143,7 +1209,11 @@ export interface Product {
      * For use with the Shopify integration. The Shopify product ID that this product is linked to.
      */
     'shopifyId'?: number | null;
+    /**
+     * @deprecated
+     */
     'warehouseProduct'?: ProductWarehouseProduct;
+    'gfnProduct'?: ProductGfnProduct;
     /**
      * Key/value pairs that can be used to store additional information about the product
      */
@@ -1257,7 +1327,11 @@ export interface ProductBundleItemsInner {
      * For use with the Shopify integration. The Shopify product ID that this product is linked to.
      */
     'shopifyId'?: number | null;
+    /**
+     * @deprecated
+     */
     'warehouseProduct'?: ProductWarehouseProduct;
+    'gfnProduct'?: ProductGfnProduct;
     /**
      * Key/value pairs that can be used to store additional information about the product
      */
@@ -1278,6 +1352,23 @@ export interface ProductBundleItemsInner {
     'license'?: License;
     'config'?: UpdateProductRequestBundleItemsInnerConfig;
 }
+/**
+ * The GFN Catalog product this catalog product is based on. Use the GFN Catalog API to list available products.
+ */
+export interface ProductGfnProduct {
+    /**
+     * Unique object identifier
+     */
+    'id'?: 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.
+     */
+    'gfnProductRef'?: string;
+    /**
+     * Meta fields from the GFN Catalog product
+     */
+    'metafields'?: Array<MetaField>;
+}
 export interface ProductType {
     /**
      * Unique object identifier
@@ -1295,6 +1386,9 @@ export interface ProductTypeListResponse {
      */
     'nextPageToken': number | null;
 }
+/**
+ * The GFN Catalog product this catalog product is based on. Use the GFN Catalog API to list available products. (Deprecated Use `gfnProduct` instead)
+ */
 export interface ProductWarehouseProduct {
     /**
      * Unique object identifier
@@ -1305,7 +1399,7 @@ export interface ProductWarehouseProduct {
      */
     'gfnProductRef'?: string;
     /**
-     * Meta fields from the warehouse product
+     * Meta fields from the GFN Catalog product
      */
     'metafields'?: Array<MetaField>;
 }
@@ -1974,7 +2068,28 @@ export interface Variant {
     'metafields'?: Array<MetaField>;
     'integrationConnections'?: Array<VariantIntegrationConnectionsInner>;
     'wholesaleCost'?: VariantWholesaleCost;
+    /**
+     * @deprecated
+     */
     'warehouseVariant'?: VariantWarehouseVariant;
+    'gfnVariant'?: VariantGfnVariant;
+}
+/**
+ * The GFN Catalog variant this catalog variant corresponds to. Use the GFN Catalog API to list variants and their attributes.
+ */
+export interface VariantGfnVariant {
+    /**
+     * Unique object identifier
+     */
+    'id'?: string;
+    /**
+     * Reference to the variant in the Global Fulfillment Network (GFN) catalog.
+     */
+    'gfnVariantRef'?: string;
+    /**
+     * Meta fields from the GFN Catalog variant
+     */
+    'metafields'?: Array<MetaField>;
 }
 export interface VariantIntegrationConnectionsInner {
     'integrationCode': string;
@@ -1993,6 +2108,9 @@ export interface VariantProduct {
      */
     'ref'?: string;
 }
+/**
+ * The GFN Catalog variant this catalog variant corresponds to. Use the GFN Catalog API to list variants and their attributes. (Deprecated Use `gfnVariant` instead)
+ */
 export interface VariantWarehouseVariant {
     /**
      * Unique object identifier
@@ -2003,7 +2121,7 @@ export interface VariantWarehouseVariant {
      */
     'gfnVariantRef'?: string;
     /**
-     * Meta fields from the warehouse variant
+     * Meta fields from the GFN Catalog variant
      */
     'metafields'?: Array<MetaField>;
 }
@@ -4241,7 +4359,7 @@ export class ProductTypesApi extends BaseAPI {
 export const ProductsApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * 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.
          * @summary Create product
          * @param {string} project What project it is
          * @param {CreateProductRequest} [createProductRequest] 
@@ -4864,7 +4982,7 @@ export const ProductsApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = ProductsApiAxiosParamCreator(configuration)
     return {
         /**
-         * 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.
          * @summary Create product
          * @param {string} project What project it is
          * @param {CreateProductRequest} [createProductRequest] 
@@ -5043,7 +5161,7 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
     const localVarFp = ProductsApiFp(configuration)
     return {
         /**
-         * 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.
          * @summary Create product
          * @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -5399,7 +5517,7 @@ export interface ProductsApiUpdateProductsRequest {
  */
 export class ProductsApi extends BaseAPI {
     /**
-     * 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.
      * @summary Create product
      * @param {ProductsApiCreateProductRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/base.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/common.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/configuration.ts

@@ -1,9 +1,9 @@
 /* tslint: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).