@teemill/pickfaces 0.25.0 → 0.27.0

package/docs/UpdatePickfaceRequest.md

@@ -0,0 +1,35 @@
+# UpdatePickfaceRequest
+
+A list of updates to apply to the pickface.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **boolean** |  | [default to undefined]
+**containerTypeId** | **string** | Unique object identifier | [optional] [default to undefined]
+**zoneId** | **string** | Unique object identifier | [optional] [default to undefined]
+**mixedContents** | **boolean** | Whether the pickface can contain mixed contents. | [optional] [default to undefined]
+**bulk** | **boolean** | Whether the pickface is used for bulk storage | [optional] [default to undefined]
+**name** | **string** | A user defined name for the pickface, if this is not provided the location will be used as the name. | [optional] [default to undefined]
+**contents** | [**Array<UpdatePickfaceRequestContentsInner>**](UpdatePickfaceRequestContentsInner.md) |  | [optional] [default to undefined]
+**purchaseOrderId** | **string** | Unique object identifier | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdatePickfaceRequest } from '@teemill/pickfaces';
+
+const instance: UpdatePickfaceRequest = {
+    enabled,
+    containerTypeId,
+    zoneId,
+    mixedContents,
+    bulk,
+    name,
+    contents,
+    purchaseOrderId,
+};
+```
+
+[[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/UpdatePickfaceRequestContentsInner.md

@@ -0,0 +1,22 @@
+# UpdatePickfaceRequestContentsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**variantRef** | **string** | The variant to add or subtract from the pickface | [default to undefined]
+**quantity** | [**UpdatePickfaceRequestContentsInnerQuantity**](UpdatePickfaceRequestContentsInnerQuantity.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdatePickfaceRequestContentsInner } from '@teemill/pickfaces';
+
+const instance: UpdatePickfaceRequestContentsInner = {
+    variantRef,
+    quantity,
+};
+```
+
+[[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/UpdatePickfaceRequestContentsInnerQuantity.md

@@ -0,0 +1,22 @@
+# UpdatePickfaceRequestContentsInnerQuantity
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**available** | [**UpdatePickfaceRequestContentsInnerQuantityAvailable**](UpdatePickfaceRequestContentsInnerQuantityAvailable.md) |  | [optional] [default to undefined]
+**reserved** | [**UpdatePickfaceRequestContentsInnerQuantityReserved**](UpdatePickfaceRequestContentsInnerQuantityReserved.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdatePickfaceRequestContentsInnerQuantity } from '@teemill/pickfaces';
+
+const instance: UpdatePickfaceRequestContentsInnerQuantity = {
+    available,
+    reserved,
+};
+```
+
+[[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/UpdatePickfaceRequestContentsInnerQuantityAvailable.md

@@ -0,0 +1,23 @@
+# UpdatePickfaceRequestContentsInnerQuantityAvailable
+
+The amount to add or subtract from the available stock on the pickface
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**operation** | **string** |  | [optional] [default to undefined]
+**value** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdatePickfaceRequestContentsInnerQuantityAvailable } from '@teemill/pickfaces';
+
+const instance: UpdatePickfaceRequestContentsInnerQuantityAvailable = {
+    operation,
+    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/UpdatePickfaceRequestContentsInnerQuantityReserved.md

@@ -0,0 +1,23 @@
+# UpdatePickfaceRequestContentsInnerQuantityReserved
+
+The amount to add or subtract from the reserved stock on the pickface. Note that you cannot subtract more than the amount of stock that has been reserved for PodOS orders.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**operation** | **string** |  | [optional] [default to undefined]
+**value** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdatePickfaceRequestContentsInnerQuantityReserved } from '@teemill/pickfaces';
+
+const instance: UpdatePickfaceRequestContentsInnerQuantityReserved = {
+    operation,
+    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/VariantAttribute.md

@@ -0,0 +1,24 @@
+# VariantAttribute
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Attribute name | [default to undefined]
+**value** | **string** | Attribute value | [default to undefined]
+**thumbnail** | [**VariantAttributeThumbnail**](VariantAttributeThumbnail.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { VariantAttribute } from '@teemill/pickfaces';
+
+const instance: VariantAttribute = {
+    name,
+    value,
+    thumbnail,
+};
+```
+
+[[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/VariantAttributeThumbnail.md

@@ -0,0 +1,23 @@
+# VariantAttributeThumbnail
+
+Attribute thumbnail
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [default to undefined]
+**value** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { VariantAttributeThumbnail } from '@teemill/pickfaces';
+
+const instance: VariantAttributeThumbnail = {
+    type,
+    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/index.ts

@@ -4,7 +4,7 @@
  * Pickfaces API
  * Use this API to access your pickfaces. You must have the warehouse module installed to access this API.
  *
- * The version of the OpenAPI document: 0.25.0
+ * The version of the OpenAPI document: 0.27.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/pickfaces",
-  "version": "0.25.0",
+  "version": "0.27.0",
   "description": "OpenAPI client for @teemill/pickfaces",
   "author": "OpenAPI-Generator Contributors",
   "repository": {