@teemill/product-catalog 1.58.1 → 1.61.0

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/product-catalog@1.58.1
+## @teemill/product-catalog@1.61.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.58.1 --save
+npm install @teemill/product-catalog@1.61.0 --save
 ```
 
 _unPublished (not recommended):_
@@ -79,7 +79,13 @@ Class | Method | HTTP request | Description
  - [Application](docs/Application.md)
  - [ApplicationMockup](docs/ApplicationMockup.md)
  - [ApplicationProperties](docs/ApplicationProperties.md)
+ - [ApplicationPropertiesMetadata](docs/ApplicationPropertiesMetadata.md)
+ - [ApplicationPropertiesMetadataPersonalization](docs/ApplicationPropertiesMetadataPersonalization.md)
+ - [ApplicationPropertiesPersonalization](docs/ApplicationPropertiesPersonalization.md)
+ - [ApplicationPropertiesPersonalizationRules](docs/ApplicationPropertiesPersonalizationRules.md)
  - [ApplicationPropertiesPosition](docs/ApplicationPropertiesPosition.md)
+ - [ApplicationPropertiesPositionInference](docs/ApplicationPropertiesPositionInference.md)
+ - [ApplicationPropertiesProperties](docs/ApplicationPropertiesProperties.md)
  - [ApplicationSet](docs/ApplicationSet.md)
  - [ApplicationSet1](docs/ApplicationSet1.md)
  - [ApplicationSetRecord](docs/ApplicationSetRecord.md)
@@ -91,6 +97,7 @@ Class | Method | HTTP request | Description
  - [AttributeThumbnail](docs/AttributeThumbnail.md)
  - [Attributes1Inner](docs/Attributes1Inner.md)
  - [CreateApplication](docs/CreateApplication.md)
+ - [CreateApplicationProperties](docs/CreateApplicationProperties.md)
  - [CreateApplicationSetRequest](docs/CreateApplicationSetRequest.md)
  - [CreateApplicationSetRequestRecordsInner](docs/CreateApplicationSetRequestRecordsInner.md)
  - [CreateApplicationSetRequestRecordsInnerAttributesInner](docs/CreateApplicationSetRequestRecordsInnerAttributesInner.md)
@@ -124,6 +131,10 @@ Class | Method | HTTP request | Description
  - [SeoOptimiseProductsRequest](docs/SeoOptimiseProductsRequest.md)
  - [Stock](docs/Stock.md)
  - [TargetSearchPhraseData](docs/TargetSearchPhraseData.md)
+ - [TextApplicationProperties](docs/TextApplicationProperties.md)
+ - [TextApplicationPropertiesPersonalization](docs/TextApplicationPropertiesPersonalization.md)
+ - [TextApplicationPropertiesPersonalizationRules](docs/TextApplicationPropertiesPersonalizationRules.md)
+ - [TextApplicationPropertiesPosition](docs/TextApplicationPropertiesPosition.md)
  - [UpdateApplicationSetRequest](docs/UpdateApplicationSetRequest.md)
  - [UpdateApplicationSetRequestRecordsInner](docs/UpdateApplicationSetRequestRecordsInner.md)
  - [UpdateApplicationSetRequestRecordsInnerAttributesInner](docs/UpdateApplicationSetRequestRecordsInnerAttributesInner.md)

package/api.ts

@@ -4,7 +4,7 @@
  * 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.
  *
- * The version of the OpenAPI document: 1.58.1
+ * The version of the OpenAPI document: 1.61.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -86,11 +86,11 @@ 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. Accepts PNG and JPEG files.
+     * 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.
      * @type {string}
      * @memberof Application
      */
-    'src': string;
+    'src'?: string;
     /**
      * 
      * @type {ApplicationMockup}
@@ -105,10 +105,10 @@ export interface Application {
     'stockedOnly'?: boolean;
     /**
      * 
-     * @type {ApplicationProperties}
+     * @type {ApplicationPropertiesProperties}
      * @memberof Application
      */
-    'properties'?: ApplicationProperties | null;
+    'properties'?: ApplicationPropertiesProperties | null;
 }
 
 export const ApplicationTechnologyEnum = {
@@ -154,7 +154,7 @@ export interface ApplicationMockup {
     'preview'?: string;
 }
 /**
- * Optional properties for the application. Leave width, height and position empty and the system will automatically calculate the size for the application.
+ * 
  * @export
  * @interface ApplicationProperties
  */
@@ -177,26 +177,130 @@ export interface ApplicationProperties {
      * @memberof ApplicationProperties
      */
     'position'?: ApplicationPropertiesPosition | null;
+    /**
+     * 
+     * @type {ApplicationPropertiesPositionInference}
+     * @memberof ApplicationProperties
+     */
+    'positionInference'?: ApplicationPropertiesPositionInference | null;
+    /**
+     * 
+     * @type {ApplicationPropertiesMetadata}
+     * @memberof ApplicationProperties
+     */
+    'metadata'?: ApplicationPropertiesMetadata;
+}
+/**
+ * 
+ * @export
+ * @interface ApplicationPropertiesMetadata
+ */
+export interface ApplicationPropertiesMetadata {
+    /**
+     * 
+     * @type {ApplicationPropertiesMetadataPersonalization}
+     * @memberof ApplicationPropertiesMetadata
+     */
+    'personalization'?: ApplicationPropertiesMetadataPersonalization;
+}
+/**
+ * @type ApplicationPropertiesMetadataPersonalization
+ * @export
+ */
+export type ApplicationPropertiesMetadataPersonalization = ApplicationPropertiesPersonalization | TextApplicationPropertiesPersonalization;
+
+/**
+ * 
+ * @export
+ * @interface ApplicationPropertiesPersonalization
+ */
+export interface ApplicationPropertiesPersonalization {
+    /**
+     * The label to be displayed on the personalization field.
+     * @type {string}
+     * @memberof ApplicationPropertiesPersonalization
+     */
+    'label'?: string;
+    /**
+     * 
+     * @type {ApplicationPropertiesPersonalizationRules}
+     * @memberof ApplicationPropertiesPersonalization
+     */
+    'rules'?: ApplicationPropertiesPersonalizationRules;
+}
+/**
+ * 
+ * @export
+ * @interface ApplicationPropertiesPersonalizationRules
+ */
+export interface ApplicationPropertiesPersonalizationRules {
+    /**
+     * The fit of the image. This determines how an uploaded image will be resized to fit the application.
+     * @type {string}
+     * @memberof ApplicationPropertiesPersonalizationRules
+     */
+    'fit'?: ApplicationPropertiesPersonalizationRulesFitEnum;
 }
+
+export const ApplicationPropertiesPersonalizationRulesFitEnum = {
+    Contain: 'contain',
+    Cover: 'cover',
+    Stretch: 'stretch',
+    Crop: 'crop'
+} as const;
+
+export type ApplicationPropertiesPersonalizationRulesFitEnum = typeof ApplicationPropertiesPersonalizationRulesFitEnum[keyof typeof ApplicationPropertiesPersonalizationRulesFitEnum];
+
 /**
- * Position of the application
+ * Position of the application relative to the bounding box of the product
  * @export
  * @interface ApplicationPropertiesPosition
  */
 export interface ApplicationPropertiesPosition {
     /**
-     * X coordinate of the application in pixels relative to the bounding box of the product
+     * X coordinate of the application in pixels
      * @type {number}
      * @memberof ApplicationPropertiesPosition
      */
     'x': number;
     /**
-     * Y coordinate of the application in pixels relative to the bounding box of the product
+     * Y coordinate of the application in pixels
      * @type {number}
      * @memberof ApplicationPropertiesPosition
      */
     'y': number;
+    /**
+     * The z layer of the application. This doesn\'t affect printing, but is used for ordering the applications when displaying them in a mockup.
+     * @type {number}
+     * @memberof 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.
+ * @export
+ * @interface ApplicationPropertiesPositionInference
+ */
+export interface ApplicationPropertiesPositionInference {
+    /**
+     * Old mockup with applications. This is used to infer the position of the application.
+     * @type {string}
+     * @memberof ApplicationPropertiesPositionInference
+     */
+    'mockup': string;
+    /**
+     * Base flat image. This is used to infer the position of the application.
+     * @type {string}
+     * @memberof ApplicationPropertiesPositionInference
+     */
+    'baseFlat': string;
+}
+/**
+ * @type ApplicationPropertiesProperties
+ * @export
+ */
+export type ApplicationPropertiesProperties = ApplicationProperties | TextApplicationProperties;
+
 /**
  * 
  * @export
@@ -499,7 +603,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. Accepts PNG and JPEG files.
+     * 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.
      * @type {string}
      * @memberof CreateApplication
      */
@@ -512,10 +616,10 @@ export interface CreateApplication {
     'stockedOnly'?: boolean;
     /**
      * 
-     * @type {ApplicationProperties}
+     * @type {CreateApplicationProperties}
      * @memberof CreateApplication
      */
-    'properties'?: ApplicationProperties | null;
+    'properties'?: CreateApplicationProperties | null;
 }
 
 export const CreateApplicationTechnologyEnum = {
@@ -541,6 +645,12 @@ export const CreateApplicationPlacementEnum = {
 
 export type CreateApplicationPlacementEnum = typeof CreateApplicationPlacementEnum[keyof typeof CreateApplicationPlacementEnum];
 
+/**
+ * @type CreateApplicationProperties
+ * @export
+ */
+export type CreateApplicationProperties = ApplicationProperties | TextApplicationProperties;
+
 /**
  * 
  * @export
@@ -705,7 +815,7 @@ export interface CreateBundleProduct {
      * @type {number}
      * @memberof CreateBundleProduct
      */
-    'shopifyId'?: number;
+    'shopifyId'?: number | null;
     /**
      * Key/value pairs that can be used to store additional information about the product
      * @type {Array<MetaField>}
@@ -844,7 +954,7 @@ export interface CreateProduct {
      * @type {number}
      * @memberof CreateProduct
      */
-    'shopifyId'?: number;
+    'shopifyId'?: number | null;
     /**
      * Key/value pairs that can be used to store additional information about the product
      * @type {Array<MetaField>}
@@ -949,7 +1059,7 @@ export interface CreateProductVariant {
      * @type {number}
      * @memberof CreateProductVariant
      */
-    'shopifyId'?: number;
+    'shopifyId'?: number | null;
     /**
      * 
      * @type {Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>}
@@ -1619,6 +1729,179 @@ export interface TargetSearchPhraseData {
      */
     'targetSearchPhraseSynonyms'?: Array<string>;
 }
+/**
+ * 
+ * @export
+ * @interface TextApplicationProperties
+ */
+export interface TextApplicationProperties {
+    /**
+     * 
+     * @type {TextApplicationPropertiesPosition}
+     * @memberof TextApplicationProperties
+     */
+    'position'?: TextApplicationPropertiesPosition;
+    /**
+     * 
+     * @type {ApplicationPropertiesPositionInference}
+     * @memberof TextApplicationProperties
+     */
+    'positionInference'?: ApplicationPropertiesPositionInference | null;
+    /**
+     * An array of text lines.
+     * @type {Array<string>}
+     * @memberof TextApplicationProperties
+     */
+    'lines'?: Array<string>;
+    /**
+     * The font to be used for the text. This font must be available in the PodOS font library.
+     * @type {string}
+     * @memberof TextApplicationProperties
+     */
+    'font'?: string;
+    /**
+     * The size of the text in pixels.
+     * @type {number}
+     * @memberof TextApplicationProperties
+     */
+    'fontSize'?: number;
+    /**
+     * The weight of the text. This must be a valid CSS font-weight value.
+     * @type {string}
+     * @memberof TextApplicationProperties
+     */
+    'fontWeight'?: TextApplicationPropertiesFontWeightEnum;
+    /**
+     * The style of the text. This must be a valid CSS font-style value.
+     * @type {string}
+     * @memberof TextApplicationProperties
+     */
+    'fontStyle'?: TextApplicationPropertiesFontStyleEnum;
+    /**
+     * The colour of the text in hex format.
+     * @type {string}
+     * @memberof TextApplicationProperties
+     */
+    'color'?: string;
+}
+
+export const TextApplicationPropertiesFontWeightEnum = {
+    Lighter: 'lighter',
+    Normal: 'normal',
+    Bold: 'bold',
+    Bolder: 'bolder'
+} as const;
+
+export type TextApplicationPropertiesFontWeightEnum = typeof TextApplicationPropertiesFontWeightEnum[keyof typeof TextApplicationPropertiesFontWeightEnum];
+export const TextApplicationPropertiesFontStyleEnum = {
+    Normal: 'normal',
+    Italic: 'italic',
+    Oblique: 'oblique'
+} as const;
+
+export type TextApplicationPropertiesFontStyleEnum = typeof TextApplicationPropertiesFontStyleEnum[keyof typeof TextApplicationPropertiesFontStyleEnum];
+
+/**
+ * 
+ * @export
+ * @interface TextApplicationPropertiesPersonalization
+ */
+export interface TextApplicationPropertiesPersonalization {
+    /**
+     * The label to be displayed on the personalization field.
+     * @type {string}
+     * @memberof TextApplicationPropertiesPersonalization
+     */
+    'label'?: string;
+    /**
+     * The type of the personalization field
+     * @type {string}
+     * @memberof TextApplicationPropertiesPersonalization
+     */
+    'type'?: TextApplicationPropertiesPersonalizationTypeEnum | null;
+    /**
+     * 
+     * @type {TextApplicationPropertiesPersonalizationRules}
+     * @memberof TextApplicationPropertiesPersonalization
+     */
+    'rules'?: TextApplicationPropertiesPersonalizationRules;
+}
+
+export const TextApplicationPropertiesPersonalizationTypeEnum = {
+    Text: 'text',
+    Number: 'number'
+} as const;
+
+export type TextApplicationPropertiesPersonalizationTypeEnum = typeof TextApplicationPropertiesPersonalizationTypeEnum[keyof typeof TextApplicationPropertiesPersonalizationTypeEnum];
+
+/**
+ * 
+ * @export
+ * @interface TextApplicationPropertiesPersonalizationRules
+ */
+export interface TextApplicationPropertiesPersonalizationRules {
+    /**
+     * The maximum length of the text, in characters.
+     * @type {number}
+     * @memberof TextApplicationPropertiesPersonalizationRules
+     */
+    'maxLength'?: number;
+    /**
+     * If true, suspected profanities will be replaced by *. Only valid when metadata.personalization.type is \"text\"
+     * @type {boolean}
+     * @memberof TextApplicationPropertiesPersonalizationRules
+     */
+    'profanityFilter'?: boolean;
+    /**
+     * If true, and the inputted text is longer than the original text, the font size will be reduced to keep the text within the application\'s original bounds.
+     * @type {boolean}
+     * @memberof TextApplicationPropertiesPersonalizationRules
+     */
+    'scaleToFit'?: boolean;
+    /**
+     * The maximum value of the number. Only valid when metadata.personalization.type is \"number\"
+     * @type {number}
+     * @memberof TextApplicationPropertiesPersonalizationRules
+     */
+    'maxValue'?: number;
+    /**
+     * The minimum value of the number. Only valid when metadata.personalization.type is \"number\"
+     * @type {number}
+     * @memberof TextApplicationPropertiesPersonalizationRules
+     */
+    'minValue'?: number;
+    /**
+     * If the entered number is below the specified digits it will be padded with 0s. E.g. 7 will become 007 when pad is 3. Only valid when metadata.personalization.type is number
+     * @type {number}
+     * @memberof TextApplicationPropertiesPersonalizationRules
+     */
+    'pad'?: number;
+}
+/**
+ * 
+ * @export
+ * @interface TextApplicationPropertiesPosition
+ */
+export interface TextApplicationPropertiesPosition {
+    /**
+     * The x position of the application in pixels.
+     * @type {number}
+     * @memberof TextApplicationPropertiesPosition
+     */
+    'x': number;
+    /**
+     * The y position of the application in pixels.
+     * @type {number}
+     * @memberof TextApplicationPropertiesPosition
+     */
+    'y': number;
+    /**
+     * The z layer of the application. This doesn\'t affect printing, but is used for ordering the applications when displaying them in a mockup.
+     * @type {number}
+     * @memberof TextApplicationPropertiesPosition
+     */
+    'z'?: number;
+}
 /**
  * 
  * @export
@@ -1825,7 +2108,7 @@ export interface UpdateProductRequest {
      * @type {number}
      * @memberof UpdateProductRequest
      */
-    'shopifyId'?: number;
+    'shopifyId'?: number | null;
     /**
      * Key/value pairs that can be used to store additional information about the product
      * @type {Array<MetaField>}
@@ -1948,7 +2231,7 @@ export interface UpdateProductsRequestProductsInner {
      * @type {number}
      * @memberof UpdateProductsRequestProductsInner
      */
-    'shopifyId'?: number;
+    'shopifyId'?: number | null;
     /**
      * 
      * @type {Array<UpdateProductsRequestProductsInnerIntegrationConnectionsInner>}
@@ -2029,7 +2312,7 @@ export interface UpdateProductsRequestProductsInnerVariantsInner {
      * @type {number}
      * @memberof UpdateProductsRequestProductsInnerVariantsInner
      */
-    'shopifyId'?: number;
+    'shopifyId'?: number | null;
     /**
      * 
      * @type {Array<UpdateProductsRequestProductsInnerVariantsInnerIntegrationConnectionsInner>}

package/base.ts

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

package/common.ts

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

package/configuration.ts

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