@teemill/pickfaces 0.24.1 → 0.27.0

package/docs/PickfacesApi.md

@@ -0,0 +1,957 @@
+# PickfacesApi
+
+All URIs are relative to *https://api.localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createPickface**](#createpickface) | **POST** /v1/pickfaces | Create Pickface|
+|[**deletePickface**](#deletepickface) | **DELETE** /v1/pickfaces/{pickfaceId} | Delete Pickface|
+|[**exportPickfaces**](#exportpickfaces) | **GET** /v1/pickfaces/export | Export pickfaces|
+|[**getPickface**](#getpickface) | **GET** /v1/pickfaces/{pickfaceId} | Get pickface|
+|[**issueEmptyPickface**](#issueemptypickface) | **POST** /v1/pickfaces/{pickfaceId}/issue/empty | Issue empty pickface|
+|[**issueWrongContentsPickface**](#issuewrongcontentspickface) | **POST** /v1/pickfaces/{pickfaceId}/issue/wrong-contents | Issue wrong contents pickface|
+|[**listPickfaceContainerTypes**](#listpickfacecontainertypes) | **GET** /v1/pickfaces/container-types | List pickface container types|
+|[**listPickfaceLogs**](#listpickfacelogs) | **GET** /v1/pickfaces/{pickfaceId}/logs | Get pickface logs|
+|[**listPickfaces**](#listpickfaces) | **GET** /v1/pickfaces | List pickfaces|
+|[**moveStock**](#movestock) | **POST** /v1/pickfaces/{pickfaceId}/stock/move | Move stock|
+|[**printPickfaceLabel**](#printpickfacelabel) | **GET** /v1/pickfaces/{pickfaceId}/print | Print pickface label|
+|[**printPickfaceLabels**](#printpickfacelabels) | **GET** /v1/pickfaces/print | Print pickface Labels|
+|[**resolvePickfaceIssue**](#resolvepickfaceissue) | **POST** /v1/pickfaces/{pickfaceId}/issue/resolve | Resolve pickface issue|
+|[**suggestPickfaces**](#suggestpickfaces) | **GET** /v1/pickfaces/suggest | Suggest pickfaces|
+|[**updatePickface**](#updatepickface) | **PATCH** /v1/pickfaces/{pickfaceId} | Update Pickface|
+
+# **createPickface**
+> Pickface createPickface(createPickfaceRequest)
+
+Create a Pickface
+
+### Example
+
+```typescript
+import {
+    PickfacesApi,
+    Configuration,
+    CreatePickfaceRequest
+} from '@teemill/pickfaces';
+
+const configuration = new Configuration();
+const apiInstance = new PickfacesApi(configuration);
+
+let project: string; //The project ID (default to undefined)
+let createPickfaceRequest: CreatePickfaceRequest; //Create pickface schema
+
+const { status, data } = await apiInstance.createPickface(
+    project,
+    createPickfaceRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createPickfaceRequest** | **CreatePickfaceRequest**| Create pickface schema | |
+| **project** | [**string**] | The project ID | defaults to undefined|
+
+
+### Return type
+
+**Pickface**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Pickface schema |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deletePickface**
+> deletePickface()
+
+Delete a Pickface
+
+### Example
+
+```typescript
+import {
+    PickfacesApi,
+    Configuration
+} from '@teemill/pickfaces';
+
+const configuration = new Configuration();
+const apiInstance = new PickfacesApi(configuration);
+
+let project: string; //The project ID (default to undefined)
+let pickfaceId: string; //Unique identifier of a pickface (default to undefined)
+
+const { status, data } = await apiInstance.deletePickface(
+    project,
+    pickfaceId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | The project ID | defaults to undefined|
+| **pickfaceId** | [**string**] | Unique identifier of a pickface | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Pickface deleted |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**400** | Failed validation |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **exportPickfaces**
+> File exportPickfaces()
+
+Export pickfaces as a CSV file
+
+### Example
+
+```typescript
+import {
+    PickfacesApi,
+    Configuration
+} from '@teemill/pickfaces';
+
+const configuration = new Configuration();
+const apiInstance = new PickfacesApi(configuration);
+
+let project: string; //The project ID (default to undefined)
+let search: string; //Search term to filter based on pickface code (optional) (default to undefined)
+
+const { status, data } = await apiInstance.exportPickfaces(
+    project,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | The project ID | defaults to undefined|
+| **search** | [**string**] | Search term to filter based on pickface code | (optional) defaults to undefined|
+
+
+### Return type
+
+**File**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/csv, application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Returns the CSV export |  -  |
+|**202** | Export started. When complete, the export will be available for download from a notification within PodOS Dashboard. |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getPickface**
+> Pickface getPickface()
+
+Get a specific pickface. Pickfaces contain useful information such as the items they contain and their level of fullness
+
+### Example
+
+```typescript
+import {
+    PickfacesApi,
+    Configuration
+} from '@teemill/pickfaces';
+
+const configuration = new Configuration();
+const apiInstance = new PickfacesApi(configuration);
+
+let project: string; //The project ID (default to undefined)
+let pickfaceId: string; //Unique identifier of a pickface (default to undefined)
+
+const { status, data } = await apiInstance.getPickface(
+    project,
+    pickfaceId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | The project ID | defaults to undefined|
+| **pickfaceId** | [**string**] | Unique identifier of a pickface | defaults to undefined|
+
+
+### Return type
+
+**Pickface**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Pickface schema |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **issueEmptyPickface**
+> Pickface issueEmptyPickface(issueEmptyPickfaceRequest)
+
+Issue an empty pickface
+
+### Example
+
+```typescript
+import {
+    PickfacesApi,
+    Configuration,
+    IssueEmptyPickfaceRequest
+} from '@teemill/pickfaces';
+
+const configuration = new Configuration();
+const apiInstance = new PickfacesApi(configuration);
+
+let project: string; //The project ID (default to undefined)
+let pickfaceId: string; //Unique identifier of a pickface (default to undefined)
+let issueEmptyPickfaceRequest: IssueEmptyPickfaceRequest; //pickface issue schema
+
+const { status, data } = await apiInstance.issueEmptyPickface(
+    project,
+    pickfaceId,
+    issueEmptyPickfaceRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **issueEmptyPickfaceRequest** | **IssueEmptyPickfaceRequest**| pickface issue schema | |
+| **project** | [**string**] | The project ID | defaults to undefined|
+| **pickfaceId** | [**string**] | Unique identifier of a pickface | defaults to undefined|
+
+
+### Return type
+
+**Pickface**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Pickface schema |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **issueWrongContentsPickface**
+> Pickface issueWrongContentsPickface(issueWrongContentsPickfaceRequest)
+
+Issue a pickface with wrong contents
+
+### Example
+
+```typescript
+import {
+    PickfacesApi,
+    Configuration,
+    IssueWrongContentsPickfaceRequest
+} from '@teemill/pickfaces';
+
+const configuration = new Configuration();
+const apiInstance = new PickfacesApi(configuration);
+
+let project: string; //The project ID (default to undefined)
+let pickfaceId: string; //Unique identifier of a pickface (default to undefined)
+let issueWrongContentsPickfaceRequest: IssueWrongContentsPickfaceRequest; //pickface issue schema
+
+const { status, data } = await apiInstance.issueWrongContentsPickface(
+    project,
+    pickfaceId,
+    issueWrongContentsPickfaceRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **issueWrongContentsPickfaceRequest** | **IssueWrongContentsPickfaceRequest**| pickface issue schema | |
+| **project** | [**string**] | The project ID | defaults to undefined|
+| **pickfaceId** | [**string**] | Unique identifier of a pickface | defaults to undefined|
+
+
+### Return type
+
+**Pickface**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Pickface schema |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listPickfaceContainerTypes**
+> ContainerTypes listPickfaceContainerTypes()
+
+Lists pickface container types
+
+### Example
+
+```typescript
+import {
+    PickfacesApi,
+    Configuration
+} from '@teemill/pickfaces';
+
+const configuration = new Configuration();
+const apiInstance = new PickfacesApi(configuration);
+
+let project: string; //The project ID (default to undefined)
+
+const { status, data } = await apiInstance.listPickfaceContainerTypes(
+    project
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | The project ID | defaults to undefined|
+
+
+### Return type
+
+**ContainerTypes**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | List of pickface container types |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listPickfaceLogs**
+> ListPickfaceLogs200Response listPickfaceLogs()
+
+Get a list of pickface logs
+
+### Example
+
+```typescript
+import {
+    PickfacesApi,
+    Configuration
+} from '@teemill/pickfaces';
+
+const configuration = new Configuration();
+const apiInstance = new PickfacesApi(configuration);
+
+let project: string; //The project ID (default to undefined)
+let pickfaceId: string; //Unique identifier of a pickface (default to undefined)
+let pageToken: number; //Page reference token (optional) (default to 1)
+let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
+
+const { status, data } = await apiInstance.listPickfaceLogs(
+    project,
+    pickfaceId,
+    pageToken,
+    pageSize
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | The project ID | defaults to undefined|
+| **pickfaceId** | [**string**] | Unique identifier of a pickface | defaults to undefined|
+| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
+| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
+
+
+### Return type
+
+**ListPickfaceLogs200Response**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Object containing pickface logs and pagination |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listPickfaces**
+> ListPickfaces200Response listPickfaces()
+
+Lists pickfaces paginated into chunks. Pickfaces contain useful information such as the items they contain and their level of fullness
+
+### Example
+
+```typescript
+import {
+    PickfacesApi,
+    Configuration
+} from '@teemill/pickfaces';
+
+const configuration = new Configuration();
+const apiInstance = new PickfacesApi(configuration);
+
+let project: string; //The project ID (default to undefined)
+let search: string; //Search term to filter based on pickface code (optional) (default to undefined)
+let pageToken: number; //Page reference token (optional) (default to 1)
+let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
+let sortBy: Array<'+available' | '-available' | '+wip' | '-wip' | '+total' | '-total' | '+fullness' | '-fullness' | '+restocked' | '-restocked' | '+picked' | '-picked'>; //An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending. (optional) (default to undefined)
+let updatedStart: string; //Start of date range to filter by when pickfaces were updated in the form of an an ISO 8601 string (optional) (default to undefined)
+let updatedEnd: string; //End of date range to filter by when pickfaces were updated in the form of an an ISO 8601 string (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listPickfaces(
+    project,
+    search,
+    pageToken,
+    pageSize,
+    sortBy,
+    updatedStart,
+    updatedEnd
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | The project ID | defaults to undefined|
+| **search** | [**string**] | Search term to filter based on pickface code | (optional) defaults to undefined|
+| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
+| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
+| **sortBy** | **Array<&#39;+available&#39; &#124; &#39;-available&#39; &#124; &#39;+wip&#39; &#124; &#39;-wip&#39; &#124; &#39;+total&#39; &#124; &#39;-total&#39; &#124; &#39;+fullness&#39; &#124; &#39;-fullness&#39; &#124; &#39;+restocked&#39; &#124; &#39;-restocked&#39; &#124; &#39;+picked&#39; &#124; &#39;-picked&#39;>** | An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending. | (optional) defaults to undefined|
+| **updatedStart** | [**string**] | Start of date range to filter by when pickfaces were updated in the form of an an ISO 8601 string | (optional) defaults to undefined|
+| **updatedEnd** | [**string**] | End of date range to filter by when pickfaces were updated in the form of an an ISO 8601 string | (optional) defaults to undefined|
+
+
+### Return type
+
+**ListPickfaces200Response**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Array of Pickface schemas |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **moveStock**
+> Pickface moveStock(moveStockRequest)
+
+Move stock from one pickface to another in a single transaction
+
+### Example
+
+```typescript
+import {
+    PickfacesApi,
+    Configuration,
+    MoveStockRequest
+} from '@teemill/pickfaces';
+
+const configuration = new Configuration();
+const apiInstance = new PickfacesApi(configuration);
+
+let project: string; //The project ID (default to undefined)
+let pickfaceId: string; //Unique identifier of a pickface (default to undefined)
+let moveStockRequest: MoveStockRequest; //Move stock from one pickface to another
+
+const { status, data } = await apiInstance.moveStock(
+    project,
+    pickfaceId,
+    moveStockRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **moveStockRequest** | **MoveStockRequest**| Move stock from one pickface to another | |
+| **project** | [**string**] | The project ID | defaults to undefined|
+| **pickfaceId** | [**string**] | Unique identifier of a pickface | defaults to undefined|
+
+
+### Return type
+
+**Pickface**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Pickface schema |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**400** | Failed validation |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **printPickfaceLabel**
+> printPickfaceLabel()
+
+Print a pickface label
+
+### Example
+
+```typescript
+import {
+    PickfacesApi,
+    Configuration
+} from '@teemill/pickfaces';
+
+const configuration = new Configuration();
+const apiInstance = new PickfacesApi(configuration);
+
+let project: string; //The project ID (default to undefined)
+let pickfaceId: string; //Unique identifier of a pickface (default to undefined)
+let deviceRef: string; //Unique identifier of a warehouse device (default to undefined)
+
+const { status, data } = await apiInstance.printPickfaceLabel(
+    project,
+    pickfaceId,
+    deviceRef
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | The project ID | defaults to undefined|
+| **pickfaceId** | [**string**] | Unique identifier of a pickface | defaults to undefined|
+| **deviceRef** | [**string**] | Unique identifier of a warehouse device | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Label printed |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **printPickfaceLabels**
+> printPickfaceLabels()
+
+Print pickface labels
+
+### Example
+
+```typescript
+import {
+    PickfacesApi,
+    Configuration
+} from '@teemill/pickfaces';
+
+const configuration = new Configuration();
+const apiInstance = new PickfacesApi(configuration);
+
+let project: string; //The project ID (default to undefined)
+let deviceRef: string; //Unique identifier of a warehouse device (default to undefined)
+let search: string; //Search term to filter based on pickface code (optional) (default to undefined)
+let ids: Array<string>; //List of pickface ids (optional) (default to undefined)
+
+const { status, data } = await apiInstance.printPickfaceLabels(
+    project,
+    deviceRef,
+    search,
+    ids
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | The project ID | defaults to undefined|
+| **deviceRef** | [**string**] | Unique identifier of a warehouse device | defaults to undefined|
+| **search** | [**string**] | Search term to filter based on pickface code | (optional) defaults to undefined|
+| **ids** | **Array&lt;string&gt;** | List of pickface ids | (optional) defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Labels printed |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **resolvePickfaceIssue**
+> Pickface resolvePickfaceIssue()
+
+Resolves an issue on a pickface
+
+### Example
+
+```typescript
+import {
+    PickfacesApi,
+    Configuration
+} from '@teemill/pickfaces';
+
+const configuration = new Configuration();
+const apiInstance = new PickfacesApi(configuration);
+
+let project: string; //The project ID (default to undefined)
+let pickfaceId: string; //Unique identifier of a pickface (default to undefined)
+
+const { status, data } = await apiInstance.resolvePickfaceIssue(
+    project,
+    pickfaceId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | The project ID | defaults to undefined|
+| **pickfaceId** | [**string**] | Unique identifier of a pickface | defaults to undefined|
+
+
+### Return type
+
+**Pickface**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Pickface schema |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **suggestPickfaces**
+> ListPickfaces200Response suggestPickfaces()
+
+Suggest pickfaces for putting away stock
+
+### Example
+
+```typescript
+import {
+    PickfacesApi,
+    Configuration
+} from '@teemill/pickfaces';
+
+const configuration = new Configuration();
+const apiInstance = new PickfacesApi(configuration);
+
+let project: string; //The project ID (default to undefined)
+let variantRef: string; //Unique identifier of a warehouse variant (default to undefined)
+let quantity: number; //Number of variants (default to undefined)
+let sellThroughRate: number; //The sell through rate of the variant to use when suggesting pickfaces (optional) (default to undefined)
+let pageToken: number; //Page reference token (optional) (default to 1)
+let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
+
+const { status, data } = await apiInstance.suggestPickfaces(
+    project,
+    variantRef,
+    quantity,
+    sellThroughRate,
+    pageToken,
+    pageSize
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | The project ID | defaults to undefined|
+| **variantRef** | [**string**] | Unique identifier of a warehouse variant | defaults to undefined|
+| **quantity** | [**number**] | Number of variants | defaults to undefined|
+| **sellThroughRate** | [**number**] | The sell through rate of the variant to use when suggesting pickfaces | (optional) defaults to undefined|
+| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
+| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
+
+
+### Return type
+
+**ListPickfaces200Response**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Array of Pickface schemas |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **updatePickface**
+> Pickface updatePickface(updatePickfaceRequest)
+
+Update a Pickface
+
+### Example
+
+```typescript
+import {
+    PickfacesApi,
+    Configuration,
+    UpdatePickfaceRequest
+} from '@teemill/pickfaces';
+
+const configuration = new Configuration();
+const apiInstance = new PickfacesApi(configuration);
+
+let project: string; //The project ID (default to undefined)
+let pickfaceId: string; //Unique identifier of a pickface (default to undefined)
+let updatePickfaceRequest: UpdatePickfaceRequest; //Update pickface schema
+
+const { status, data } = await apiInstance.updatePickface(
+    project,
+    pickfaceId,
+    updatePickfaceRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updatePickfaceRequest** | **UpdatePickfaceRequest**| Update pickface schema | |
+| **project** | [**string**] | The project ID | defaults to undefined|
+| **pickfaceId** | [**string**] | Unique identifier of a pickface | defaults to undefined|
+
+
+### Return type
+
+**Pickface**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Pickface schema |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+