@teemill/pickfaces 0.24.1 → 0.27.0

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/pickfaces@0.24.1
+## @teemill/pickfaces@0.27.0
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @teemill/pickfaces@0.24.1 --save
+npm install @teemill/pickfaces@0.27.0 --save
 ```
 
 _unPublished (not recommended):_
@@ -44,3 +44,76 @@ _unPublished (not recommended):_
 ```
 npm install PATH_TO_GENERATED_PACKAGE --save
 ```
+
+### Documentation for API Endpoints
+
+All URIs are relative to *https://api.localhost:8080*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*PickfacesApi* | [**createPickface**](docs/PickfacesApi.md#createpickface) | **POST** /v1/pickfaces | Create Pickface
+*PickfacesApi* | [**deletePickface**](docs/PickfacesApi.md#deletepickface) | **DELETE** /v1/pickfaces/{pickfaceId} | Delete Pickface
+*PickfacesApi* | [**exportPickfaces**](docs/PickfacesApi.md#exportpickfaces) | **GET** /v1/pickfaces/export | Export pickfaces
+*PickfacesApi* | [**getPickface**](docs/PickfacesApi.md#getpickface) | **GET** /v1/pickfaces/{pickfaceId} | Get pickface
+*PickfacesApi* | [**issueEmptyPickface**](docs/PickfacesApi.md#issueemptypickface) | **POST** /v1/pickfaces/{pickfaceId}/issue/empty | Issue empty pickface
+*PickfacesApi* | [**issueWrongContentsPickface**](docs/PickfacesApi.md#issuewrongcontentspickface) | **POST** /v1/pickfaces/{pickfaceId}/issue/wrong-contents | Issue wrong contents pickface
+*PickfacesApi* | [**listPickfaceContainerTypes**](docs/PickfacesApi.md#listpickfacecontainertypes) | **GET** /v1/pickfaces/container-types | List pickface container types
+*PickfacesApi* | [**listPickfaceLogs**](docs/PickfacesApi.md#listpickfacelogs) | **GET** /v1/pickfaces/{pickfaceId}/logs | Get pickface logs
+*PickfacesApi* | [**listPickfaces**](docs/PickfacesApi.md#listpickfaces) | **GET** /v1/pickfaces | List pickfaces
+*PickfacesApi* | [**moveStock**](docs/PickfacesApi.md#movestock) | **POST** /v1/pickfaces/{pickfaceId}/stock/move | Move stock
+*PickfacesApi* | [**printPickfaceLabel**](docs/PickfacesApi.md#printpickfacelabel) | **GET** /v1/pickfaces/{pickfaceId}/print | Print pickface label
+*PickfacesApi* | [**printPickfaceLabels**](docs/PickfacesApi.md#printpickfacelabels) | **GET** /v1/pickfaces/print | Print pickface Labels
+*PickfacesApi* | [**resolvePickfaceIssue**](docs/PickfacesApi.md#resolvepickfaceissue) | **POST** /v1/pickfaces/{pickfaceId}/issue/resolve | Resolve pickface issue
+*PickfacesApi* | [**suggestPickfaces**](docs/PickfacesApi.md#suggestpickfaces) | **GET** /v1/pickfaces/suggest | Suggest pickfaces
+*PickfacesApi* | [**updatePickface**](docs/PickfacesApi.md#updatepickface) | **PATCH** /v1/pickfaces/{pickfaceId} | Update Pickface
+
+
+### Documentation For Models
+
+ - [ApiError](docs/ApiError.md)
+ - [ContainerType](docs/ContainerType.md)
+ - [ContainerTypes](docs/ContainerTypes.md)
+ - [CreatePickfaceRequest](docs/CreatePickfaceRequest.md)
+ - [ExportPickfaces202Response](docs/ExportPickfaces202Response.md)
+ - [IssueEmptyPickfaceRequest](docs/IssueEmptyPickfaceRequest.md)
+ - [IssueWrongContentsPickfaceRequest](docs/IssueWrongContentsPickfaceRequest.md)
+ - [ListPickfaceLogs200Response](docs/ListPickfaceLogs200Response.md)
+ - [ListPickfaces200Response](docs/ListPickfaces200Response.md)
+ - [MoveStockRequest](docs/MoveStockRequest.md)
+ - [Pickface](docs/Pickface.md)
+ - [PickfaceContainerType](docs/PickfaceContainerType.md)
+ - [PickfaceContentsInner](docs/PickfaceContentsInner.md)
+ - [PickfaceContentsInnerMetadata](docs/PickfaceContentsInnerMetadata.md)
+ - [PickfaceContentsInnerQuantity](docs/PickfaceContentsInnerQuantity.md)
+ - [PickfaceIssue](docs/PickfaceIssue.md)
+ - [PickfaceLog](docs/PickfaceLog.md)
+ - [PickfaceZone](docs/PickfaceZone.md)
+ - [UpdatePickfaceRequest](docs/UpdatePickfaceRequest.md)
+ - [UpdatePickfaceRequestContentsInner](docs/UpdatePickfaceRequestContentsInner.md)
+ - [UpdatePickfaceRequestContentsInnerQuantity](docs/UpdatePickfaceRequestContentsInnerQuantity.md)
+ - [UpdatePickfaceRequestContentsInnerQuantityAvailable](docs/UpdatePickfaceRequestContentsInnerQuantityAvailable.md)
+ - [UpdatePickfaceRequestContentsInnerQuantityReserved](docs/UpdatePickfaceRequestContentsInnerQuantityReserved.md)
+ - [VariantAttribute](docs/VariantAttribute.md)
+ - [VariantAttributeThumbnail](docs/VariantAttributeThumbnail.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="api-key"></a>
+### api-key
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+
+<a id="session-oauth"></a>
+### session-oauth
+
+- **Type**: OAuth
+- **Flow**: password
+- **Authorization URL**: 
+- **Scopes**: N/A
+

package/api.ts

@@ -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.24.1
+ * The version of the OpenAPI document: 0.27.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -260,79 +260,79 @@ export interface Pickface {
      * @type {string}
      * @memberof Pickface
      */
-    'id'?: string;
+    'id': string;
     /**
      * A reference to the resource location
      * @type {string}
      * @memberof Pickface
      */
-    'ref'?: string;
+    'ref': string;
     /**
      * 
      * @type {PickfaceZone}
      * @memberof Pickface
      */
-    'zone'?: PickfaceZone | null;
+    'zone': PickfaceZone | null;
     /**
      * The human readable location of the pickface, if a name is provided this will be the name.
      * @type {string}
      * @memberof Pickface
      */
-    'code'?: string;
+    'code': string;
     /**
      * 
      * @type {boolean}
      * @memberof Pickface
      */
-    'enabled'?: boolean;
+    'enabled': boolean;
     /**
      * Whether the pickface can contain mixed contents.
      * @type {boolean}
      * @memberof Pickface
      */
-    'mixedContents'?: boolean;
+    'mixedContents': boolean;
     /**
      * Whether the pickface is used for bulk storage and not for picking
      * @type {boolean}
      * @memberof Pickface
      */
-    'bulk'?: boolean;
+    'bulk': boolean;
     /**
      * 
      * @type {PickfaceContainerType}
      * @memberof Pickface
      */
-    'containerType'?: PickfaceContainerType;
+    'containerType': PickfaceContainerType;
     /**
      * The percentage of the pickface that has been taken up by its contents
      * @type {number}
      * @memberof Pickface
      */
-    'fullness'?: number;
+    '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}
      * @memberof Pickface
      */
-    'issue'?: PickfaceIssue | null;
+    'issue': PickfaceIssue | null;
     /**
      * 
      * @type {Array<PickfaceContentsInner>}
      * @memberof Pickface
      */
-    'contents'?: Array<PickfaceContentsInner>;
+    'contents': Array<PickfaceContentsInner>;
 }
 /**
  * 
@@ -364,25 +364,25 @@ export interface PickfaceContentsInner {
      * @type {string}
      * @memberof PickfaceContentsInner
      */
-    'variantRef'?: string;
+    'variantRef': 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.
      * @type {string}
      * @memberof PickfaceContentsInner
      */
-    'ownerProjectId'?: string | null;
+    'ownerProjectId': string | null;
     /**
      * 
      * @type {PickfaceContentsInnerQuantity}
      * @memberof PickfaceContentsInner
      */
-    'quantity'?: PickfaceContentsInnerQuantity;
+    'quantity': PickfaceContentsInnerQuantity;
     /**
      * 
      * @type {PickfaceContentsInnerMetadata}
      * @memberof PickfaceContentsInner
      */
-    'metadata'?: PickfaceContentsInnerMetadata | null;
+    'metadata': PickfaceContentsInnerMetadata | null;
 }
 /**
  * Any additional metadata
@@ -395,13 +395,13 @@ export interface PickfaceContentsInnerMetadata {
      * @type {string}
      * @memberof PickfaceContentsInnerMetadata
      */
-    'title'?: string | null;
+    'title': string | null;
     /**
      * The SKU of the product
      * @type {string}
      * @memberof PickfaceContentsInnerMetadata
      */
-    'sku'?: string | null;
+    'sku': string | null;
     /**
      * The image of the front of the product
      * @type {string}
@@ -465,80 +465,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
@@ -550,31 +476,31 @@ export interface PickfaceLog {
      * @type {string}
      * @memberof PickfaceLog
      */
-    'id'?: string;
+    'id': string;
     /**
      * A reference to the resource location
      * @type {string}
      * @memberof PickfaceLog
      */
-    'userRef'?: string;
+    'userRef': string;
     /**
      * The action that was taken
      * @type {string}
      * @memberof PickfaceLog
      */
-    'action'?: string;
+    'action': string;
     /**
      * The reason for the action
      * @type {string}
      * @memberof PickfaceLog
      */
-    'reason'?: string | null;
+    'reason': string | null;
     /**
      * ISO 8601 Created at timestamp
      * @type {string}
      * @memberof PickfaceLog
      */
-    'createdAt'?: string;
+    'createdAt': string;
 }
 /**
  * 
@@ -612,7 +538,7 @@ export interface UpdatePickfaceRequest {
      * @type {boolean}
      * @memberof UpdatePickfaceRequest
      */
-    'enabled'?: boolean;
+    'enabled': boolean;
     /**
      * Unique object identifier
      * @type {string}
@@ -649,6 +575,12 @@ export interface UpdatePickfaceRequest {
      * @memberof UpdatePickfaceRequest
      */
     'contents'?: Array<UpdatePickfaceRequestContentsInner> | null;
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof UpdatePickfaceRequest
+     */
+    'purchaseOrderId'?: string;
 }
 /**
  * 
@@ -676,25 +608,71 @@ 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 const UpdatePickfaceRequestContentsInnerQuantityAvailableOperationEnum = {
+    Add: 'add',
+    Subtract: 'subtract'
+} as const;
+
+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 const UpdatePickfaceRequestContentsInnerQuantityOperationEnum = {
+export const UpdatePickfaceRequestContentsInnerQuantityReservedOperationEnum = {
     Add: 'add',
     Subtract: 'subtract'
 } as const;
 
-export type UpdatePickfaceRequestContentsInnerQuantityOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityOperationEnum];
+export type UpdatePickfaceRequestContentsInnerQuantityReservedOperationEnum = typeof UpdatePickfaceRequestContentsInnerQuantityReservedOperationEnum[keyof typeof UpdatePickfaceRequestContentsInnerQuantityReservedOperationEnum];
 
 /**
  * 

package/base.ts

@@ -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.24.1
+ * The version of the OpenAPI document: 0.27.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/common.ts

@@ -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.24.1
+ * The version of the OpenAPI document: 0.27.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/configuration.ts

@@ -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.24.1
+ * The version of the OpenAPI document: 0.27.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).