@teemill/pickfaces 0.12.1 → 0.13.0

package/dist/esm/api.d.ts

@@ -0,0 +1,1245 @@
+/**
+ * Pickfaces API
+ * Manage Teemill Pickfaces.  Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change.  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
+ *
+ * The version of the OpenAPI document: 0.13.0
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from './configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import type { RequestArgs } from './base';
+import { BaseAPI } from './base';
+/**
+ *
+ * @export
+ * @interface ApiError
+ */
+export interface ApiError {
+    /**
+     *
+     * @type {string}
+     * @memberof ApiError
+     */
+    'code'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ApiError
+     */
+    'message': string;
+}
+/**
+ *
+ * @export
+ * @interface ContainerModel
+ */
+export interface ContainerModel {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof ContainerModel
+     */
+    'id': string;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof ContainerModel
+     */
+    'ref': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ContainerModel
+     */
+    'name': string;
+    /**
+     * The width of the model in millimetres
+     * @type {number}
+     * @memberof ContainerModel
+     */
+    'width'?: number;
+    /**
+     * The depth of the model in millimetres
+     * @type {number}
+     * @memberof ContainerModel
+     */
+    'depth'?: number;
+    /**
+     * The height of the model in millimetres
+     * @type {number}
+     * @memberof ContainerModel
+     */
+    'height'?: number;
+}
+/**
+ *
+ * @export
+ * @interface ContainerModels
+ */
+export interface ContainerModels {
+    /**
+     *
+     * @type {Array<ContainerModel>}
+     * @memberof ContainerModels
+     */
+    'containerModels'?: Array<ContainerModel>;
+}
+/**
+ *
+ * @export
+ * @interface CreatePickfaceRequest
+ */
+export interface CreatePickfaceRequest {
+    /**
+     * The location of the pickface
+     * @type {string}
+     * @memberof CreatePickfaceRequest
+     */
+    'location'?: string;
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof CreatePickfaceRequest
+     */
+    'containerModelId'?: string;
+}
+/**
+ *
+ * @export
+ * @interface GetPickfaces200Response
+ */
+export interface GetPickfaces200Response {
+    /**
+     *
+     * @type {Array<Pickface>}
+     * @memberof GetPickfaces200Response
+     */
+    'pickfaces'?: Array<Pickface>;
+    /**
+     *
+     * @type {number}
+     * @memberof GetPickfaces200Response
+     */
+    'nextPageToken'?: number;
+}
+/**
+ *
+ * @export
+ * @interface ListPickfaceLogs200Response
+ */
+export interface ListPickfaceLogs200Response {
+    /**
+     *
+     * @type {Array<PickfaceLog>}
+     * @memberof ListPickfaceLogs200Response
+     */
+    'logs'?: Array<PickfaceLog>;
+    /**
+     *
+     * @type {number}
+     * @memberof ListPickfaceLogs200Response
+     */
+    'nextPageToken'?: number;
+}
+/**
+ *
+ * @export
+ * @interface MoveStockRequest
+ */
+export interface MoveStockRequest {
+    /**
+     * The variant to move from the pickface
+     * @type {string}
+     * @memberof MoveStockRequest
+     */
+    'variantRef': string;
+    /**
+     * The quantity to move from the pickface
+     * @type {number}
+     * @memberof MoveStockRequest
+     */
+    'quantity': number;
+    /**
+     * The pickface to move the stock to
+     * @type {string}
+     * @memberof MoveStockRequest
+     */
+    'toPickfaceRef': string;
+}
+/**
+ *
+ * @export
+ * @interface Pickface
+ */
+export interface Pickface {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof Pickface
+     */
+    'id'?: string;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof Pickface
+     */
+    'ref'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Pickface
+     */
+    'code'?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Pickface
+     */
+    'enabled'?: boolean;
+    /**
+     *
+     * @type {PickfaceContainerModel}
+     * @memberof Pickface
+     */
+    'containerModel'?: PickfaceContainerModel;
+    /**
+     * The percentage of the pickface that has been taken up by its contents
+     * @type {number}
+     * @memberof Pickface
+     */
+    'fullness'?: number;
+    /**
+     *
+     * @type {PickfaceLastPicked}
+     * @memberof Pickface
+     */
+    'lastPicked'?: PickfaceLastPicked;
+    /**
+     *
+     * @type {PickfaceLastRestocked}
+     * @memberof Pickface
+     */
+    'lastRestocked'?: PickfaceLastRestocked;
+    /**
+     *
+     * @type {Array<PickfaceContentsInner>}
+     * @memberof Pickface
+     */
+    'contents'?: Array<PickfaceContentsInner>;
+}
+/**
+ *
+ * @export
+ * @interface PickfaceContainerModel
+ */
+export interface PickfaceContainerModel {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof PickfaceContainerModel
+     */
+    'id'?: string;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof PickfaceContainerModel
+     */
+    'ref'?: string;
+}
+/**
+ *
+ * @export
+ * @interface PickfaceContentsInner
+ */
+export interface PickfaceContentsInner {
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof PickfaceContentsInner
+     */
+    'variantRef'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PickfaceContentsInner
+     */
+    'ownerProjectId'?: string | null;
+    /**
+     *
+     * @type {PickfaceContentsInnerQuantity}
+     * @memberof PickfaceContentsInner
+     */
+    'quantity'?: PickfaceContentsInnerQuantity;
+    /**
+     *
+     * @type {Array<PickfaceContentsInnerApplicationsInner>}
+     * @memberof PickfaceContentsInner
+     */
+    'applications'?: Array<PickfaceContentsInnerApplicationsInner>;
+    /**
+     *
+     * @type {PickfaceContentsInnerMetadata}
+     * @memberof PickfaceContentsInner
+     */
+    'metadata'?: PickfaceContentsInnerMetadata | null;
+}
+/**
+ *
+ * @export
+ * @interface PickfaceContentsInnerApplicationsInner
+ */
+export interface PickfaceContentsInnerApplicationsInner {
+    /**
+     *
+     * @type {string}
+     * @memberof PickfaceContentsInnerApplicationsInner
+     */
+    'placement'?: string;
+    /**
+     * A unique identifier for the application
+     * @type {string}
+     * @memberof PickfaceContentsInnerApplicationsInner
+     */
+    'signature'?: string;
+}
+/**
+ * Any additional metadata
+ * @export
+ * @interface PickfaceContentsInnerMetadata
+ */
+export interface PickfaceContentsInnerMetadata {
+    /**
+     * The title of the product
+     * @type {string}
+     * @memberof PickfaceContentsInnerMetadata
+     */
+    'title'?: string | null;
+    /**
+     * The image of the front of the product
+     * @type {string}
+     * @memberof PickfaceContentsInnerMetadata
+     */
+    'frontImage'?: string | null;
+    /**
+     * The image of the back of the product
+     * @type {string}
+     * @memberof PickfaceContentsInnerMetadata
+     */
+    'backImage'?: string | null;
+}
+/**
+ *
+ * @export
+ * @interface PickfaceContentsInnerQuantity
+ */
+export interface PickfaceContentsInnerQuantity {
+    /**
+     * How many are in the box
+     * @type {number}
+     * @memberof PickfaceContentsInnerQuantity
+     */
+    'total'?: number;
+    /**
+     * How many are available to reserve
+     * @type {number}
+     * @memberof PickfaceContentsInnerQuantity
+     */
+    'available'?: number;
+    /**
+     * How many are pending some action e.g. to be picked
+     * @type {number}
+     * @memberof PickfaceContentsInnerQuantity
+     */
+    'reserved'?: number;
+}
+/**
+ *
+ * @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
+ * @interface PickfaceLog
+ */
+export interface PickfaceLog {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof PickfaceLog
+     */
+    'id'?: string;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof PickfaceLog
+     */
+    'userRef'?: string;
+    /**
+     * The action that was taken
+     * @type {string}
+     * @memberof PickfaceLog
+     */
+    'action'?: string;
+    /**
+     * The reason for the action
+     * @type {string}
+     * @memberof PickfaceLog
+     */
+    'reason'?: string | null;
+    /**
+     * ISO 8601 Created at timestamp
+     * @type {string}
+     * @memberof PickfaceLog
+     */
+    'createdAt'?: string;
+}
+/**
+ * A list of updates to apply to the pickface.
+ * @export
+ * @interface UpdatePickfaceRequest
+ */
+export interface UpdatePickfaceRequest {
+    /**
+     *
+     * @type {boolean}
+     * @memberof UpdatePickfaceRequest
+     */
+    'enabled'?: boolean;
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof UpdatePickfaceRequest
+     */
+    'containerModelId'?: string;
+    /**
+     *
+     * @type {Array<UpdatePickfaceRequestContentsInner>}
+     * @memberof UpdatePickfaceRequest
+     */
+    'contents'?: Array<UpdatePickfaceRequestContentsInner> | null;
+}
+/**
+ *
+ * @export
+ * @interface UpdatePickfaceRequestContentsInner
+ */
+export interface UpdatePickfaceRequestContentsInner {
+    /**
+     * The variant to add or subtract from the pickface
+     * @type {string}
+     * @memberof UpdatePickfaceRequestContentsInner
+     */
+    'variantRef': string;
+    /**
+     *
+     * @type {UpdatePickfaceRequestContentsInnerQuantity}
+     * @memberof UpdatePickfaceRequestContentsInner
+     */
+    'quantity': UpdatePickfaceRequestContentsInnerQuantity;
+}
+/**
+ *
+ * @export
+ * @interface UpdatePickfaceRequestContentsInnerQuantity
+ */
+export interface UpdatePickfaceRequestContentsInnerQuantity {
+    /**
+     * The operation to perform on the pickface
+     * @type {string}
+     * @memberof UpdatePickfaceRequestContentsInnerQuantity
+     */
+    'operation': UpdatePickfaceRequestContentsInnerQuantityOperationEnum;
+    /**
+     * The value to use with the operation
+     * @type {number}
+     * @memberof UpdatePickfaceRequestContentsInnerQuantity
+     */
+    'value': number;
+}
+export declare const UpdatePickfaceRequestContentsInnerQuantityOperationEnum: {
+    readonly Add: "add";
+    readonly Subtract: "subtract";
+};
+export type UpdatePickfaceRequestContentsInnerQuantityOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityOperationEnum];
+/**
+ * PickfacesApi - axios parameter creator
+ * @export
+ */
+export declare const PickfacesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create a Pickface
+     * @summary Create Pickface
+     * @param {string} project What project it is
+     * @param {CreatePickfaceRequest} createPickfaceRequest Create pickface schema
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPickface: (project: string, createPickfaceRequest: CreatePickfaceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete a Pickface
+     * @summary Delete Pickface
+     * @param {string} project What project it is
+     * @param {string} pickfaceId Unique identifier of a pickface
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePickface: (project: string, pickfaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Export pickfaces as a CSV file
+     * @summary Export pickfaces
+     * @param {string} project What project it is
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportPickfaces: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a pickface
+     * @summary Get pickface
+     * @param {string} project What project it is
+     * @param {string} pickfaceId Unique identifier of a pickface
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPickface: (project: string, pickfaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Lists pickface container models
+     * @summary Get pickface container models
+     * @param {string} project What project it is
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPickfaceContainerModels: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Lists all pickfaces available paginated into chunks
+     * @summary List pickfaces
+     * @param {string} project What project it is
+     * @param {string} [search] Search term to filter based on pickface code
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {Array<GetPickfacesFiltersEnum>} [filters] Filters to apply to the request
+     * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPickfaces: (project: string, search?: string, pageToken?: number, pageSize?: number, filters?: Array<GetPickfacesFiltersEnum>, sortBy?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a list of pickface logs
+     * @summary Get pickface logs
+     * @param {string} project What project it is
+     * @param {string} pickfaceId Unique identifier of a pickface
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPickfaceLogs: (project: string, pickfaceId: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Move stock from one pickface to another in a single transaction
+     * @summary Move stock
+     * @param {string} project What project it is
+     * @param {string} pickfaceId Unique identifier of a pickface
+     * @param {MoveStockRequest} moveStockRequest Move stock from one pickface to another
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    moveStock: (project: string, pickfaceId: string, moveStockRequest: MoveStockRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Print a pickface label
+     * @summary Print pickface label
+     * @param {string} project What project it is
+     * @param {string} pickfaceId Unique identifier of a pickface
+     * @param {string} deviceRef Unique identifier of a warehouse device
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    printPickfaceLabel: (project: string, pickfaceId: string, deviceRef: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Suggest pickfaces for putting away stock
+     * @summary Suggest pickfaces
+     * @param {string} project What project it is
+     * @param {string} variantRef Unique identifier of a warehouse variant
+     * @param {number} quantity Number of variants
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    suggestPickfaces: (project: string, variantRef: string, quantity: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update a Pickface
+     * @summary Update Pickface
+     * @param {string} project What project it is
+     * @param {string} pickfaceId Unique identifier of a pickface
+     * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePickface: (project: string, pickfaceId: string, updatePickfaceRequest: UpdatePickfaceRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PickfacesApi - functional programming interface
+ * @export
+ */
+export declare const PickfacesApiFp: (configuration?: Configuration) => {
+    /**
+     * Create a Pickface
+     * @summary Create Pickface
+     * @param {string} project What project it is
+     * @param {CreatePickfaceRequest} createPickfaceRequest Create pickface schema
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPickface(project: string, createPickfaceRequest: CreatePickfaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>>;
+    /**
+     * Delete a Pickface
+     * @summary Delete Pickface
+     * @param {string} project What project it is
+     * @param {string} pickfaceId Unique identifier of a pickface
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePickface(project: string, pickfaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Export pickfaces as a CSV file
+     * @summary Export pickfaces
+     * @param {string} project What project it is
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportPickfaces(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    /**
+     * Get a pickface
+     * @summary Get pickface
+     * @param {string} project What project it is
+     * @param {string} pickfaceId Unique identifier of a pickface
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPickface(project: string, pickfaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>>;
+    /**
+     * Lists pickface container models
+     * @summary Get pickface container models
+     * @param {string} project What project it is
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPickfaceContainerModels(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ContainerModels>>;
+    /**
+     * Lists all pickfaces available paginated into chunks
+     * @summary List pickfaces
+     * @param {string} project What project it is
+     * @param {string} [search] Search term to filter based on pickface code
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {Array<GetPickfacesFiltersEnum>} [filters] Filters to apply to the request
+     * @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPickfaces(project: string, search?: string, pageToken?: number, pageSize?: number, filters?: Array<GetPickfacesFiltersEnum>, sortBy?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPickfaces200Response>>;
+    /**
+     * Get a list of pickface logs
+     * @summary Get pickface logs
+     * @param {string} project What project it is
+     * @param {string} pickfaceId Unique identifier of a pickface
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPickfaceLogs(project: string, pickfaceId: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPickfaceLogs200Response>>;
+    /**
+     * Move stock from one pickface to another in a single transaction
+     * @summary Move stock
+     * @param {string} project What project it is
+     * @param {string} pickfaceId Unique identifier of a pickface
+     * @param {MoveStockRequest} moveStockRequest Move stock from one pickface to another
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    moveStock(project: string, pickfaceId: string, moveStockRequest: MoveStockRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>>;
+    /**
+     * Print a pickface label
+     * @summary Print pickface label
+     * @param {string} project What project it is
+     * @param {string} pickfaceId Unique identifier of a pickface
+     * @param {string} deviceRef Unique identifier of a warehouse device
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    printPickfaceLabel(project: string, pickfaceId: string, deviceRef: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Suggest pickfaces for putting away stock
+     * @summary Suggest pickfaces
+     * @param {string} project What project it is
+     * @param {string} variantRef Unique identifier of a warehouse variant
+     * @param {number} quantity Number of variants
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    suggestPickfaces(project: string, variantRef: string, quantity: number, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPickfaces200Response>>;
+    /**
+     * Update a Pickface
+     * @summary Update Pickface
+     * @param {string} project What project it is
+     * @param {string} pickfaceId Unique identifier of a pickface
+     * @param {UpdatePickfaceRequest} updatePickfaceRequest Update pickface schema
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePickface(project: string, pickfaceId: string, updatePickfaceRequest: UpdatePickfaceRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Pickface>>;
+};
+/**
+ * PickfacesApi - factory interface
+ * @export
+ */
+export declare const PickfacesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create a Pickface
+     * @summary Create Pickface
+     * @param {PickfacesApiCreatePickfaceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPickface(requestParameters: PickfacesApiCreatePickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface>;
+    /**
+     * Delete a Pickface
+     * @summary Delete Pickface
+     * @param {PickfacesApiDeletePickfaceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePickface(requestParameters: PickfacesApiDeletePickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Export pickfaces as a CSV file
+     * @summary Export pickfaces
+     * @param {PickfacesApiExportPickfacesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportPickfaces(requestParameters: PickfacesApiExportPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
+    /**
+     * Get a pickface
+     * @summary Get pickface
+     * @param {PickfacesApiGetPickfaceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPickface(requestParameters: PickfacesApiGetPickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface>;
+    /**
+     * Lists pickface container models
+     * @summary Get pickface container models
+     * @param {PickfacesApiGetPickfaceContainerModelsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPickfaceContainerModels(requestParameters: PickfacesApiGetPickfaceContainerModelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ContainerModels>;
+    /**
+     * Lists all pickfaces available paginated into chunks
+     * @summary List pickfaces
+     * @param {PickfacesApiGetPickfacesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPickfaces(requestParameters: PickfacesApiGetPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPickfaces200Response>;
+    /**
+     * Get a list of pickface logs
+     * @summary Get pickface logs
+     * @param {PickfacesApiListPickfaceLogsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPickfaceLogs(requestParameters: PickfacesApiListPickfaceLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListPickfaceLogs200Response>;
+    /**
+     * Move stock from one pickface to another in a single transaction
+     * @summary Move stock
+     * @param {PickfacesApiMoveStockRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    moveStock(requestParameters: PickfacesApiMoveStockRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface>;
+    /**
+     * Print a pickface label
+     * @summary Print pickface label
+     * @param {PickfacesApiPrintPickfaceLabelRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    printPickfaceLabel(requestParameters: PickfacesApiPrintPickfaceLabelRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Suggest pickfaces for putting away stock
+     * @summary Suggest pickfaces
+     * @param {PickfacesApiSuggestPickfacesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    suggestPickfaces(requestParameters: PickfacesApiSuggestPickfacesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPickfaces200Response>;
+    /**
+     * Update a Pickface
+     * @summary Update Pickface
+     * @param {PickfacesApiUpdatePickfaceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePickface(requestParameters: PickfacesApiUpdatePickfaceRequest, options?: RawAxiosRequestConfig): AxiosPromise<Pickface>;
+};
+/**
+ * Request parameters for createPickface operation in PickfacesApi.
+ * @export
+ * @interface PickfacesApiCreatePickfaceRequest
+ */
+export interface PickfacesApiCreatePickfaceRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof PickfacesApiCreatePickface
+     */
+    readonly project: string;
+    /**
+     * Create pickface schema
+     * @type {CreatePickfaceRequest}
+     * @memberof PickfacesApiCreatePickface
+     */
+    readonly createPickfaceRequest: CreatePickfaceRequest;
+}
+/**
+ * Request parameters for deletePickface operation in PickfacesApi.
+ * @export
+ * @interface PickfacesApiDeletePickfaceRequest
+ */
+export interface PickfacesApiDeletePickfaceRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof PickfacesApiDeletePickface
+     */
+    readonly project: string;
+    /**
+     * Unique identifier of a pickface
+     * @type {string}
+     * @memberof PickfacesApiDeletePickface
+     */
+    readonly pickfaceId: string;
+}
+/**
+ * Request parameters for exportPickfaces operation in PickfacesApi.
+ * @export
+ * @interface PickfacesApiExportPickfacesRequest
+ */
+export interface PickfacesApiExportPickfacesRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof PickfacesApiExportPickfaces
+     */
+    readonly project: string;
+}
+/**
+ * Request parameters for getPickface operation in PickfacesApi.
+ * @export
+ * @interface PickfacesApiGetPickfaceRequest
+ */
+export interface PickfacesApiGetPickfaceRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof PickfacesApiGetPickface
+     */
+    readonly project: string;
+    /**
+     * Unique identifier of a pickface
+     * @type {string}
+     * @memberof PickfacesApiGetPickface
+     */
+    readonly pickfaceId: string;
+}
+/**
+ * Request parameters for getPickfaceContainerModels operation in PickfacesApi.
+ * @export
+ * @interface PickfacesApiGetPickfaceContainerModelsRequest
+ */
+export interface PickfacesApiGetPickfaceContainerModelsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof PickfacesApiGetPickfaceContainerModels
+     */
+    readonly project: string;
+}
+/**
+ * Request parameters for getPickfaces operation in PickfacesApi.
+ * @export
+ * @interface PickfacesApiGetPickfacesRequest
+ */
+export interface PickfacesApiGetPickfacesRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof PickfacesApiGetPickfaces
+     */
+    readonly project: string;
+    /**
+     * Search term to filter based on pickface code
+     * @type {string}
+     * @memberof PickfacesApiGetPickfaces
+     */
+    readonly search?: string;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof PickfacesApiGetPickfaces
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof PickfacesApiGetPickfaces
+     */
+    readonly pageSize?: number;
+    /**
+     * Filters to apply to the request
+     * @type {Array<'empty' | 'flagged'>}
+     * @memberof PickfacesApiGetPickfaces
+     */
+    readonly filters?: Array<GetPickfacesFiltersEnum>;
+    /**
+     * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
+     * @type {Array<string>}
+     * @memberof PickfacesApiGetPickfaces
+     */
+    readonly sortBy?: Array<string>;
+}
+/**
+ * Request parameters for listPickfaceLogs operation in PickfacesApi.
+ * @export
+ * @interface PickfacesApiListPickfaceLogsRequest
+ */
+export interface PickfacesApiListPickfaceLogsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof PickfacesApiListPickfaceLogs
+     */
+    readonly project: string;
+    /**
+     * Unique identifier of a pickface
+     * @type {string}
+     * @memberof PickfacesApiListPickfaceLogs
+     */
+    readonly pickfaceId: string;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof PickfacesApiListPickfaceLogs
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof PickfacesApiListPickfaceLogs
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for moveStock operation in PickfacesApi.
+ * @export
+ * @interface PickfacesApiMoveStockRequest
+ */
+export interface PickfacesApiMoveStockRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof PickfacesApiMoveStock
+     */
+    readonly project: string;
+    /**
+     * Unique identifier of a pickface
+     * @type {string}
+     * @memberof PickfacesApiMoveStock
+     */
+    readonly pickfaceId: string;
+    /**
+     * Move stock from one pickface to another
+     * @type {MoveStockRequest}
+     * @memberof PickfacesApiMoveStock
+     */
+    readonly moveStockRequest: MoveStockRequest;
+}
+/**
+ * Request parameters for printPickfaceLabel operation in PickfacesApi.
+ * @export
+ * @interface PickfacesApiPrintPickfaceLabelRequest
+ */
+export interface PickfacesApiPrintPickfaceLabelRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof PickfacesApiPrintPickfaceLabel
+     */
+    readonly project: string;
+    /**
+     * Unique identifier of a pickface
+     * @type {string}
+     * @memberof PickfacesApiPrintPickfaceLabel
+     */
+    readonly pickfaceId: string;
+    /**
+     * Unique identifier of a warehouse device
+     * @type {string}
+     * @memberof PickfacesApiPrintPickfaceLabel
+     */
+    readonly deviceRef: string;
+}
+/**
+ * Request parameters for suggestPickfaces operation in PickfacesApi.
+ * @export
+ * @interface PickfacesApiSuggestPickfacesRequest
+ */
+export interface PickfacesApiSuggestPickfacesRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof PickfacesApiSuggestPickfaces
+     */
+    readonly project: string;
+    /**
+     * Unique identifier of a warehouse variant
+     * @type {string}
+     * @memberof PickfacesApiSuggestPickfaces
+     */
+    readonly variantRef: string;
+    /**
+     * Number of variants
+     * @type {number}
+     * @memberof PickfacesApiSuggestPickfaces
+     */
+    readonly quantity: number;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof PickfacesApiSuggestPickfaces
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof PickfacesApiSuggestPickfaces
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for updatePickface operation in PickfacesApi.
+ * @export
+ * @interface PickfacesApiUpdatePickfaceRequest
+ */
+export interface PickfacesApiUpdatePickfaceRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof PickfacesApiUpdatePickface
+     */
+    readonly project: string;
+    /**
+     * Unique identifier of a pickface
+     * @type {string}
+     * @memberof PickfacesApiUpdatePickface
+     */
+    readonly pickfaceId: string;
+    /**
+     * Update pickface schema
+     * @type {UpdatePickfaceRequest}
+     * @memberof PickfacesApiUpdatePickface
+     */
+    readonly updatePickfaceRequest: UpdatePickfaceRequest;
+}
+/**
+ * PickfacesApi - object-oriented interface
+ * @export
+ * @class PickfacesApi
+ * @extends {BaseAPI}
+ */
+export declare class PickfacesApi extends BaseAPI {
+    /**
+     * Create a Pickface
+     * @summary Create Pickface
+     * @param {PickfacesApiCreatePickfaceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PickfacesApi
+     */
+    createPickface(requestParameters: PickfacesApiCreatePickfaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pickface, any>>;
+    /**
+     * Delete a Pickface
+     * @summary Delete Pickface
+     * @param {PickfacesApiDeletePickfaceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PickfacesApi
+     */
+    deletePickface(requestParameters: PickfacesApiDeletePickfaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Export pickfaces as a CSV file
+     * @summary Export pickfaces
+     * @param {PickfacesApiExportPickfacesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PickfacesApi
+     */
+    exportPickfaces(requestParameters: PickfacesApiExportPickfacesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+    /**
+     * Get a pickface
+     * @summary Get pickface
+     * @param {PickfacesApiGetPickfaceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PickfacesApi
+     */
+    getPickface(requestParameters: PickfacesApiGetPickfaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pickface, any>>;
+    /**
+     * Lists pickface container models
+     * @summary Get pickface container models
+     * @param {PickfacesApiGetPickfaceContainerModelsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PickfacesApi
+     */
+    getPickfaceContainerModels(requestParameters: PickfacesApiGetPickfaceContainerModelsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ContainerModels, any>>;
+    /**
+     * Lists all pickfaces available paginated into chunks
+     * @summary List pickfaces
+     * @param {PickfacesApiGetPickfacesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PickfacesApi
+     */
+    getPickfaces(requestParameters: PickfacesApiGetPickfacesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPickfaces200Response, any>>;
+    /**
+     * Get a list of pickface logs
+     * @summary Get pickface logs
+     * @param {PickfacesApiListPickfaceLogsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PickfacesApi
+     */
+    listPickfaceLogs(requestParameters: PickfacesApiListPickfaceLogsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPickfaceLogs200Response, any>>;
+    /**
+     * Move stock from one pickface to another in a single transaction
+     * @summary Move stock
+     * @param {PickfacesApiMoveStockRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PickfacesApi
+     */
+    moveStock(requestParameters: PickfacesApiMoveStockRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pickface, any>>;
+    /**
+     * Print a pickface label
+     * @summary Print pickface label
+     * @param {PickfacesApiPrintPickfaceLabelRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PickfacesApi
+     */
+    printPickfaceLabel(requestParameters: PickfacesApiPrintPickfaceLabelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Suggest pickfaces for putting away stock
+     * @summary Suggest pickfaces
+     * @param {PickfacesApiSuggestPickfacesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PickfacesApi
+     */
+    suggestPickfaces(requestParameters: PickfacesApiSuggestPickfacesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPickfaces200Response, any>>;
+    /**
+     * Update a Pickface
+     * @summary Update Pickface
+     * @param {PickfacesApiUpdatePickfaceRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PickfacesApi
+     */
+    updatePickface(requestParameters: PickfacesApiUpdatePickfaceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Pickface, any>>;
+}
+/**
+ * @export
+ */
+export declare const GetPickfacesFiltersEnum: {
+    readonly Empty: "empty";
+    readonly Flagged: "flagged";
+};
+export type GetPickfacesFiltersEnum = typeof GetPickfacesFiltersEnum[keyof typeof GetPickfacesFiltersEnum];