@teemill/pickfaces 0.25.0 → 0.27.0

package/docs/PickfaceContentsInnerMetadata.md

@@ -0,0 +1,29 @@
+# PickfaceContentsInnerMetadata
+
+Any additional metadata
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | The title of the product | [default to undefined]
+**sku** | **string** | The SKU of the product | [default to undefined]
+**frontImage** | **string** | The image of the front of the product | [optional] [default to undefined]
+**backImage** | **string** | The image of the back of the product | [optional] [default to undefined]
+**attributes** | [**Array<VariantAttribute>**](VariantAttribute.md) | Attributes associated to a variant such as Colour and Size. An attribute can have thumbnail type of `text`, `color`, or `image`. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PickfaceContentsInnerMetadata } from '@teemill/pickfaces';
+
+const instance: PickfaceContentsInnerMetadata = {
+    title,
+    sku,
+    frontImage,
+    backImage,
+    attributes,
+};
+```
+
+[[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/PickfaceContentsInnerQuantity.md

@@ -0,0 +1,24 @@
+# PickfaceContentsInnerQuantity
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **number** | How many are in the box | [optional] [default to undefined]
+**available** | **number** | How many are available to reserve | [optional] [default to undefined]
+**reserved** | **number** | How many are pending some action e.g. to be picked | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PickfaceContentsInnerQuantity } from '@teemill/pickfaces';
+
+const instance: PickfaceContentsInnerQuantity = {
+    total,
+    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/PickfaceIssue.md

@@ -0,0 +1,23 @@
+# PickfaceIssue
+
+The open issue for the pickface
+
+## 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]
+
+## Example
+
+```typescript
+import { PickfaceIssue } from '@teemill/pickfaces';
+
+const instance: PickfaceIssue = {
+    id,
+    ref,
+};
+```
+
+[[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/PickfaceLog.md

@@ -0,0 +1,28 @@
+# PickfaceLog
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**userRef** | **string** | A reference to the resource location | [default to undefined]
+**action** | **string** | The action that was taken | [default to undefined]
+**reason** | **string** | The reason for the action | [default to undefined]
+**createdAt** | **string** | ISO 8601 Created at timestamp | [default to undefined]
+
+## Example
+
+```typescript
+import { PickfaceLog } from '@teemill/pickfaces';
+
+const instance: PickfaceLog = {
+    id,
+    userRef,
+    action,
+    reason,
+    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/PickfaceZone.md

@@ -0,0 +1,24 @@
+# PickfaceZone
+
+
+## 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** | The name of the zone the pickface is in | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PickfaceZone } from '@teemill/pickfaces';
+
+const instance: PickfaceZone = {
+    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)