@teemill/pickfaces 0.24.1 → 0.27.0

package/docs/ListPickfaces200Response.md

@@ -0,0 +1,22 @@
+# ListPickfaces200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pickfaces** | [**Array<Pickface>**](Pickface.md) |  | [optional] [default to undefined]
+**nextPageToken** | **number** | The token referencing the next page number | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ListPickfaces200Response } from '@teemill/pickfaces';
+
+const instance: ListPickfaces200Response = {
+    pickfaces,
+    nextPageToken,
+};
+```
+
+[[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/MoveStockRequest.md

@@ -0,0 +1,24 @@
+# MoveStockRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**variantRef** | **string** | The variant to move from the pickface | [default to undefined]
+**quantity** | **number** | The quantity to move from the pickface | [default to undefined]
+**toPickfaceRef** | **string** | The pickface to move the stock to | [default to undefined]
+
+## Example
+
+```typescript
+import { MoveStockRequest } from '@teemill/pickfaces';
+
+const instance: MoveStockRequest = {
+    variantRef,
+    quantity,
+    toPickfaceRef,
+};
+```
+
+[[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/Pickface.md

@@ -0,0 +1,44 @@
+# Pickface
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**ref** | **string** | A reference to the resource location | [default to undefined]
+**zone** | [**PickfaceZone**](PickfaceZone.md) |  | [default to undefined]
+**code** | **string** | The human readable location of the pickface, if a name is provided this will be the name. | [default to undefined]
+**enabled** | **boolean** |  | [default to undefined]
+**mixedContents** | **boolean** | Whether the pickface can contain mixed contents. | [default to undefined]
+**bulk** | **boolean** | Whether the pickface is used for bulk storage and not for picking | [default to undefined]
+**containerType** | [**PickfaceContainerType**](PickfaceContainerType.md) |  | [default to undefined]
+**fullness** | **number** | The percentage of the pickface that has been taken up by its contents | [default to undefined]
+**lastPicked** | [**PickfaceLog**](PickfaceLog.md) |  | [default to undefined]
+**lastRestocked** | [**PickfaceLog**](PickfaceLog.md) |  | [default to undefined]
+**issue** | [**PickfaceIssue**](PickfaceIssue.md) |  | [default to undefined]
+**contents** | [**Array<PickfaceContentsInner>**](PickfaceContentsInner.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Pickface } from '@teemill/pickfaces';
+
+const instance: Pickface = {
+    id,
+    ref,
+    zone,
+    code,
+    enabled,
+    mixedContents,
+    bulk,
+    containerType,
+    fullness,
+    lastPicked,
+    lastRestocked,
+    issue,
+    contents,
+};
+```
+
+[[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/PickfaceContainerType.md

@@ -0,0 +1,22 @@
+# PickfaceContainerType
+
+
+## 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 { PickfaceContainerType } from '@teemill/pickfaces';
+
+const instance: PickfaceContainerType = {
+    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/PickfaceContentsInner.md

@@ -0,0 +1,26 @@
+# PickfaceContentsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**variantRef** | **string** | A reference to the resource location | [default to undefined]
+**ownerProjectId** | **string** | The ID of the project that the contents belongs to. For example, if you had a 3PL item this would be the project that created the product. | [default to undefined]
+**quantity** | [**PickfaceContentsInnerQuantity**](PickfaceContentsInnerQuantity.md) |  | [default to undefined]
+**metadata** | [**PickfaceContentsInnerMetadata**](PickfaceContentsInnerMetadata.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PickfaceContentsInner } from '@teemill/pickfaces';
+
+const instance: PickfaceContentsInner = {
+    variantRef,
+    ownerProjectId,
+    quantity,
+    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/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)