@teemill/pickfaces 0.25.0 → 0.28.0

package/dist/esm/api.d.ts

@@ -2,7 +2,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.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -257,6 +257,12 @@ export interface Pickface {
      * @memberof Pickface
      */
     'ref': string;
+    /**
+     * The barcode of the pickface
+     * @type {string}
+     * @memberof Pickface
+     */
+    'barcode': string;
     /**
      *
      * @type {PickfaceZone}
@@ -301,16 +307,16 @@ export interface Pickface {
     'fullness': number;
     /**
      *
-     * @type {PickfaceLastPicked}
+     * @type {PickfaceLog}
      * @memberof Pickface
      */
-    'lastPicked': PickfaceLastPicked;
+    'lastPicked': PickfaceLog | null;
     /**
      *
-     * @type {PickfaceLastRestocked}
+     * @type {PickfaceLog}
      * @memberof Pickface
      */
-    'lastRestocked': PickfaceLastRestocked;
+    'lastRestocked': PickfaceLog | null;
     /**
      *
      * @type {PickfaceIssue}
@@ -455,80 +461,6 @@ export interface PickfaceIssue {
      */
     'ref'?: string;
 }
-/**
- *
- * @export
- * @interface PickfaceLastPicked
- */
-export interface PickfaceLastPicked {
-    /**
-     * Unique object identifier
-     * @type {string}
-     * @memberof PickfaceLastPicked
-     */
-    'id': string;
-    /**
-     * A reference to the resource location
-     * @type {string}
-     * @memberof PickfaceLastPicked
-     */
-    'userRef': string;
-    /**
-     * The action that was taken
-     * @type {string}
-     * @memberof PickfaceLastPicked
-     */
-    'action': string;
-    /**
-     * The reason for the action
-     * @type {string}
-     * @memberof PickfaceLastPicked
-     */
-    'reason': string | null;
-    /**
-     * ISO 8601 Created at timestamp
-     * @type {string}
-     * @memberof PickfaceLastPicked
-     */
-    'createdAt': string;
-}
-/**
- *
- * @export
- * @interface PickfaceLastRestocked
- */
-export interface PickfaceLastRestocked {
-    /**
-     * Unique object identifier
-     * @type {string}
-     * @memberof PickfaceLastRestocked
-     */
-    'id': string;
-    /**
-     * A reference to the resource location
-     * @type {string}
-     * @memberof PickfaceLastRestocked
-     */
-    'userRef': string;
-    /**
-     * The action that was taken
-     * @type {string}
-     * @memberof PickfaceLastRestocked
-     */
-    'action': string;
-    /**
-     * The reason for the action
-     * @type {string}
-     * @memberof PickfaceLastRestocked
-     */
-    'reason': string | null;
-    /**
-     * ISO 8601 Created at timestamp
-     * @type {string}
-     * @memberof PickfaceLastRestocked
-     */
-    'createdAt': string;
-}
 /**
  *
  * @export
@@ -672,23 +604,66 @@ export interface UpdatePickfaceRequestContentsInner {
  */
 export interface UpdatePickfaceRequestContentsInnerQuantity {
     /**
-     * The operation to perform on the pickface
-     * @type {string}
+     *
+     * @type {UpdatePickfaceRequestContentsInnerQuantityAvailable}
      * @memberof UpdatePickfaceRequestContentsInnerQuantity
      */
-    'operation': UpdatePickfaceRequestContentsInnerQuantityOperationEnum;
+    'available'?: UpdatePickfaceRequestContentsInnerQuantityAvailable | null;
     /**
-     * The value to use with the operation
-     * @type {number}
+     *
+     * @type {UpdatePickfaceRequestContentsInnerQuantityReserved}
      * @memberof UpdatePickfaceRequestContentsInnerQuantity
      */
+    'reserved'?: UpdatePickfaceRequestContentsInnerQuantityReserved | null;
+}
+/**
+ * The amount to add or subtract from the available stock on the pickface
+ * @export
+ * @interface UpdatePickfaceRequestContentsInnerQuantityAvailable
+ */
+export interface UpdatePickfaceRequestContentsInnerQuantityAvailable {
+    /**
+     *
+     * @type {string}
+     * @memberof UpdatePickfaceRequestContentsInnerQuantityAvailable
+     */
+    'operation'?: UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof UpdatePickfaceRequestContentsInnerQuantityAvailable
+     */
+    'value': number;
+}
+export declare const UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum: {
+    readonly Add: "add";
+    readonly Subtract: "subtract";
+};
+export type UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum];
+/**
+ * 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.
+ * @export
+ * @interface UpdatePickfaceRequestContentsInnerQuantityReserved
+ */
+export interface UpdatePickfaceRequestContentsInnerQuantityReserved {
+    /**
+     *
+     * @type {string}
+     * @memberof UpdatePickfaceRequestContentsInnerQuantityReserved
+     */
+    'operation'?: UpdatePickfaceRequestContentsInnerQuantityReservedOperationEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof UpdatePickfaceRequestContentsInnerQuantityReserved
+     */
     'value': number;
 }
-export declare const UpdatePickfaceRequestContentsInnerQuantityOperationEnum: {
+export declare const UpdatePickfaceRequestContentsInnerQuantityReservedOperationEnum: {
     readonly Add: "add";
     readonly Subtract: "subtract";
 };
-export type UpdatePickfaceRequestContentsInnerQuantityOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityOperationEnum];
+export type UpdatePickfaceRequestContentsInnerQuantityReservedOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityReservedOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityReservedOperationEnum];
 /**
  *
  * @export

package/dist/esm/api.js

@@ -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.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -26,7 +26,11 @@ import globalAxios from 'axios';
 import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
 // @ts-ignore
 import { BASE_PATH, BaseAPI, operationServerMap } from './base';
-export const UpdatePickfaceRequestContentsInnerQuantityOperationEnum = {
+export const UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum = {
+    Add: 'add',
+    Subtract: 'subtract'
+};
+export const UpdatePickfaceRequestContentsInnerQuantityReservedOperationEnum = {
     Add: 'add',
     Subtract: 'subtract'
 };

package/dist/esm/base.d.ts

@@ -2,7 +2,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.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/base.js

@@ -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.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.d.ts

@@ -2,7 +2,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.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.js

@@ -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.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.d.ts

@@ -2,7 +2,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.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.js

@@ -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.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.d.ts

@@ -2,7 +2,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.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.js

@@ -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.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.d.ts

@@ -2,7 +2,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.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.js

@@ -5,7 +5,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.28.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/ApiError.md

@@ -0,0 +1,22 @@
+# ApiError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ApiError } from '@teemill/pickfaces';
+
+const instance: ApiError = {
+    code,
+    message,
+};
+```
+
+[[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/ContainerType.md

@@ -0,0 +1,31 @@
+# ContainerType
+
+The factory container the pickface is within
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**ref** | **string** | A reference to the resource location | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**width** | **number** | The width of the container in millimetres | [optional] [default to undefined]
+**depth** | **number** | The depth of the container in millimetres | [optional] [default to undefined]
+**height** | **number** | The height of the container in millimetres | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ContainerType } from '@teemill/pickfaces';
+
+const instance: ContainerType = {
+    id,
+    ref,
+    name,
+    width,
+    depth,
+    height,
+};
+```
+
+[[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/ContainerTypes.md

@@ -0,0 +1,20 @@
+# ContainerTypes
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**containerTypes** | [**Array<ContainerType>**](ContainerType.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ContainerTypes } from '@teemill/pickfaces';
+
+const instance: ContainerTypes = {
+    containerTypes,
+};
+```
+
+[[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/CreatePickfaceRequest.md

@@ -0,0 +1,30 @@
+# CreatePickfaceRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**location** | **string** | A human readable location for the pickface i.e. \"1 Wf 49\" | [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]
+**containerTypeId** | **string** | Use \'Pickfaces API\' > \'List pickface container types\' to get a list of available options. | [default to undefined]
+**bulk** | **boolean** | Whether the pickface is used for bulk storage | [optional] [default to false]
+**mixedContents** | **boolean** | Whether the pickface can contain mixed contents. | [optional] [default to false]
+**zoneId** | **string** | Typically this field is left empty. Use \'Zones API\' > \'List warehouse zones\' to get a list of available options. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreatePickfaceRequest } from '@teemill/pickfaces';
+
+const instance: CreatePickfaceRequest = {
+    location,
+    name,
+    containerTypeId,
+    bulk,
+    mixedContents,
+    zoneId,
+};
+```
+
+[[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/ExportPickfaces202Response.md

@@ -0,0 +1,20 @@
+# ExportPickfaces202Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message describing the export status | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ExportPickfaces202Response } from '@teemill/pickfaces';
+
+const instance: ExportPickfaces202Response = {
+    message,
+};
+```
+
+[[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/IssueEmptyPickfaceRequest.md

@@ -0,0 +1,20 @@
+# IssueEmptyPickfaceRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**issueRef** | **string** | A reference to the resource location | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { IssueEmptyPickfaceRequest } from '@teemill/pickfaces';
+
+const instance: IssueEmptyPickfaceRequest = {
+    issueRef,
+};
+```
+
+[[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/IssueWrongContentsPickfaceRequest.md

@@ -0,0 +1,22 @@
+# IssueWrongContentsPickfaceRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**issueRef** | **string** | A reference to the resource location | [optional] [default to undefined]
+**variantRef** | **string** | A reference to the resource location | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { IssueWrongContentsPickfaceRequest } from '@teemill/pickfaces';
+
+const instance: IssueWrongContentsPickfaceRequest = {
+    issueRef,
+    variantRef,
+};
+```
+
+[[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/ListPickfaceLogs200Response.md

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