@teemill/product-catalog 1.58.1 → 1.61.0

package/docs/ApplicationPropertiesPersonalization.md

@@ -0,0 +1,22 @@
+# ApplicationPropertiesPersonalization
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **string** | The label to be displayed on the personalization field. | [optional] [default to undefined]
+**rules** | [**ApplicationPropertiesPersonalizationRules**](ApplicationPropertiesPersonalizationRules.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ApplicationPropertiesPersonalization } from '@teemill/product-catalog';
+
+const instance: ApplicationPropertiesPersonalization = {
+    label,
+    rules,
+};
+```
+
+[[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/ApplicationPropertiesPersonalizationRules.md

@@ -0,0 +1,20 @@
+# ApplicationPropertiesPersonalizationRules
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fit** | **string** | The fit of the image. This determines how an uploaded image will be resized to fit the application. | [optional] [default to FitEnum_Contain]
+
+## Example
+
+```typescript
+import { ApplicationPropertiesPersonalizationRules } from '@teemill/product-catalog';
+
+const instance: ApplicationPropertiesPersonalizationRules = {
+    fit,
+};
+```
+
+[[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/ApplicationPropertiesPosition.md

@@ -1,13 +1,14 @@
 # ApplicationPropertiesPosition
 
-Position of the application
+Position of the application relative to the bounding box of the product
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**x** | **number** | X coordinate of the application in pixels relative to the bounding box of the product | [default to undefined]
-**y** | **number** | Y coordinate of the application in pixels relative to the bounding box of the product | [default to undefined]
+**x** | **number** | X coordinate of the application in pixels | [default to undefined]
+**y** | **number** | Y coordinate of the application in pixels | [default to undefined]
+**z** | **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. | [optional] [default to 0]
 
 ## Example
 
@@ -17,6 +18,7 @@ import { ApplicationPropertiesPosition } from '@teemill/product-catalog';
 const instance: ApplicationPropertiesPosition = {
     x,
     y,
+    z,
 };
 ```
 

package/docs/ApplicationPropertiesPositionInference.md

@@ -0,0 +1,23 @@
+# ApplicationPropertiesPositionInference
+
+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.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mockup** | **string** | Old mockup with applications. This is used to infer the position of the application. | [default to undefined]
+**baseFlat** | **string** | Base flat image. This is used to infer the position of the application. | [default to undefined]
+
+## Example
+
+```typescript
+import { ApplicationPropertiesPositionInference } from '@teemill/product-catalog';
+
+const instance: ApplicationPropertiesPositionInference = {
+    mockup,
+    baseFlat,
+};
+```
+
+[[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/ApplicationPropertiesProperties.md

@@ -0,0 +1,40 @@
+# ApplicationPropertiesProperties
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**position** | [**ApplicationPropertiesPosition**](ApplicationPropertiesPosition.md) |  | [optional] [default to undefined]
+**positionInference** | [**ApplicationPropertiesPositionInference**](ApplicationPropertiesPositionInference.md) |  | [optional] [default to undefined]
+**lines** | **Array<string>** | An array of text lines. | [optional] [default to undefined]
+**font** | **string** | The font to be used for the text. This font must be available in the PodOS font library. | [optional] [default to undefined]
+**fontSize** | **number** | The size of the text in pixels. | [optional] [default to undefined]
+**fontWeight** | **string** | The weight of the text. This must be a valid CSS font-weight value. | [optional] [default to FontWeightEnum_Normal]
+**fontStyle** | **string** | The style of the text. This must be a valid CSS font-style value. | [optional] [default to FontStyleEnum_Normal]
+**color** | **string** | The colour of the text in hex format. | [optional] [default to undefined]
+**width** | **number** | Width of the application in pixels | [optional] [default to undefined]
+**height** | **number** | Height of the application in pixels | [optional] [default to undefined]
+**metadata** | [**ApplicationPropertiesMetadata**](ApplicationPropertiesMetadata.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ApplicationPropertiesProperties } from '@teemill/product-catalog';
+
+const instance: ApplicationPropertiesProperties = {
+    position,
+    positionInference,
+    lines,
+    font,
+    fontSize,
+    fontWeight,
+    fontStyle,
+    color,
+    width,
+    height,
+    metadata,
+};
+```
+
+[[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/CreateApplication.md

@@ -8,9 +8,9 @@ Name | Type | Description | Notes
 **technology** | **string** | Technology to use for the application. | [default to undefined]
 **placement** | **string** | Placement of the application. Available placements depend on the chosen product and technology. | [default to undefined]
 **additionalInstructions** | **string** | Any additional instructions for the application | [optional] [default to undefined]
-**src** | **string** | 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. | [default to undefined]
+**src** | **string** | 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. | [default to undefined]
 **stockedOnly** | **boolean** | If set to true, transfers for this application will not be printed on demand, and will need to be stocked in trays in the factory. Note that this can only be set if the technology is stockable, such as DTF. | [optional] [default to undefined]
-**properties** | [**ApplicationProperties**](ApplicationProperties.md) |  | [optional] [default to undefined]
+**properties** | [**CreateApplicationProperties**](CreateApplicationProperties.md) |  | [optional] [default to undefined]
 
 ## Example
 

package/docs/CreateApplicationProperties.md

@@ -1,14 +1,21 @@
 # CreateApplicationProperties
 
-Optional properties for the application. Leave width, height and position empty and the system will automatically calculate the size for the application.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**position** | [**ApplicationPropertiesPosition**](ApplicationPropertiesPosition.md) |  | [optional] [default to undefined]
+**positionInference** | [**ApplicationPropertiesPositionInference**](ApplicationPropertiesPositionInference.md) |  | [optional] [default to undefined]
+**lines** | **Array<string>** | An array of text lines. | [optional] [default to undefined]
+**font** | **string** | The font to be used for the text. This font must be available in the PodOS font library. | [optional] [default to undefined]
+**fontSize** | **number** | The size of the text in pixels. | [optional] [default to undefined]
+**fontWeight** | **string** | The weight of the text. This must be a valid CSS font-weight value. | [optional] [default to FontWeightEnum_Normal]
+**fontStyle** | **string** | The style of the text. This must be a valid CSS font-style value. | [optional] [default to FontStyleEnum_Normal]
+**color** | **string** | The colour of the text in hex format. | [optional] [default to undefined]
 **width** | **number** | Width of the application in pixels | [optional] [default to undefined]
 **height** | **number** | Height of the application in pixels | [optional] [default to undefined]
-**position** | [**CreateApplicationPropertiesPosition**](CreateApplicationPropertiesPosition.md) |  | [optional] [default to undefined]
+**metadata** | [**ApplicationPropertiesMetadata**](ApplicationPropertiesMetadata.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -16,9 +23,17 @@ Name | Type | Description | Notes
 import { CreateApplicationProperties } from '@teemill/product-catalog';
 
 const instance: CreateApplicationProperties = {
+    position,
+    positionInference,
+    lines,
+    font,
+    fontSize,
+    fontWeight,
+    fontStyle,
+    color,
     width,
     height,
-    position,
+    metadata,
 };
 ```
 

package/docs/TextApplicationProperties.md

@@ -0,0 +1,34 @@
+# TextApplicationProperties
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**position** | [**TextApplicationPropertiesPosition**](TextApplicationPropertiesPosition.md) |  | [optional] [default to undefined]
+**positionInference** | [**ApplicationPropertiesPositionInference**](ApplicationPropertiesPositionInference.md) |  | [optional] [default to undefined]
+**lines** | **Array<string>** | An array of text lines. | [optional] [default to undefined]
+**font** | **string** | The font to be used for the text. This font must be available in the PodOS font library. | [optional] [default to undefined]
+**fontSize** | **number** | The size of the text in pixels. | [optional] [default to undefined]
+**fontWeight** | **string** | The weight of the text. This must be a valid CSS font-weight value. | [optional] [default to FontWeightEnum_Normal]
+**fontStyle** | **string** | The style of the text. This must be a valid CSS font-style value. | [optional] [default to FontStyleEnum_Normal]
+**color** | **string** | The colour of the text in hex format. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TextApplicationProperties } from '@teemill/product-catalog';
+
+const instance: TextApplicationProperties = {
+    position,
+    positionInference,
+    lines,
+    font,
+    fontSize,
+    fontWeight,
+    fontStyle,
+    color,
+};
+```
+
+[[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/TextApplicationPropertiesPersonalization.md

@@ -0,0 +1,24 @@
+# TextApplicationPropertiesPersonalization
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **string** | The label to be displayed on the personalization field. | [optional] [default to undefined]
+**type** | **string** | The type of the personalization field | [optional] [default to undefined]
+**rules** | [**TextApplicationPropertiesPersonalizationRules**](TextApplicationPropertiesPersonalizationRules.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TextApplicationPropertiesPersonalization } from '@teemill/product-catalog';
+
+const instance: TextApplicationPropertiesPersonalization = {
+    label,
+    type,
+    rules,
+};
+```
+
+[[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/TextApplicationPropertiesPersonalizationRules.md

@@ -0,0 +1,30 @@
+# TextApplicationPropertiesPersonalizationRules
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**maxLength** | **number** | The maximum length of the text, in characters. | [optional] [default to 100]
+**profanityFilter** | **boolean** | If true, suspected profanities will be replaced by *. Only valid when metadata.personalization.type is \"text\" | [optional] [default to false]
+**scaleToFit** | **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. | [optional] [default to false]
+**maxValue** | **number** | The maximum value of the number. Only valid when metadata.personalization.type is \"number\" | [optional] [default to 100]
+**minValue** | **number** | The minimum value of the number. Only valid when metadata.personalization.type is \"number\" | [optional] [default to 0]
+**pad** | **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 | [optional] [default to 0]
+
+## Example
+
+```typescript
+import { TextApplicationPropertiesPersonalizationRules } from '@teemill/product-catalog';
+
+const instance: TextApplicationPropertiesPersonalizationRules = {
+    maxLength,
+    profanityFilter,
+    scaleToFit,
+    maxValue,
+    minValue,
+    pad,
+};
+```
+
+[[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/TextApplicationPropertiesPosition.md

@@ -0,0 +1,24 @@
+# TextApplicationPropertiesPosition
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**x** | **number** | The x position of the application in pixels. | [default to 0]
+**y** | **number** | The y position of the application in pixels. | [default to 0]
+**z** | **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. | [optional] [default to 0]
+
+## Example
+
+```typescript
+import { TextApplicationPropertiesPosition } from '@teemill/product-catalog';
+
+const instance: TextApplicationPropertiesPosition = {
+    x,
+    y,
+    z,
+};
+```
+
+[[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/index.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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/product-catalog",
-  "version": "1.58.1",
+  "version": "1.61.0",
   "description": "OpenAPI client for @teemill/product-catalog",
   "author": "OpenAPI-Generator Contributors",
   "repository": {