@teemill/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @teemill/[email protected] --save

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 | checkedStock | POST /v1/pickfaces/{pickfaceId}/stock/checked | Mark stock as checked PickfacesApi | createPickface | POST /v1/pickfaces | Create Pickface PickfacesApi | deletePickface | DELETE /v1/pickfaces/{pickfaceId} | Delete Pickface PickfacesApi | exportPickfaces | GET /v1/pickfaces/export | Export pickfaces PickfacesApi | getPickface | GET /v1/pickfaces/{pickfaceId} | Get pickface PickfacesApi | issueEmptyPickface | POST /v1/pickfaces/{pickfaceId}/issue/empty | Issue empty pickface PickfacesApi | issueWrongContentsPickface | POST /v1/pickfaces/{pickfaceId}/issue/wrong-contents | Issue wrong contents pickface PickfacesApi | listPickfaceContainerTypes | GET /v1/pickfaces/container-types | List pickface container types PickfacesApi | listPickfaceLogs | GET /v1/pickfaces/{pickfaceId}/logs | Get pickface logs PickfacesApi | listPickfaces | GET /v1/pickfaces | List pickfaces PickfacesApi | moveStock | POST /v1/pickfaces/{pickfaceId}/stock/move | Move stock PickfacesApi | printPickfaceLabel | GET /v1/pickfaces/{pickfaceId}/print | Print pickface label PickfacesApi | printPickfaceLabels | GET /v1/pickfaces/print | Print pickface Labels PickfacesApi | resolvePickfaceIssue | POST /v1/pickfaces/{pickfaceId}/issue/resolve | Resolve pickface issue PickfacesApi | suggestPickfaces | GET /v1/pickfaces/suggest | Suggest pickfaces PickfacesApi | updatePickface | PATCH /v1/pickfaces/{pickfaceId} | Update Pickface PickfacesApi | updatePickfaces | PATCH /v1/pickfaces | Update pickfaces

Documentation For Models

• ApiError
• ContainerType
• ContainerTypes
• CreatePickfaceRequest
• ExportPickfaces202Response
• IssueEmptyPickfaceRequest
• IssueWrongContentsPickfaceRequest
• ListPickfaceLogs200Response
• ListPickfaces200Response
• MoveStockRequest
• Pickface
• PickfaceContainerType
• PickfaceContentsInner
• PickfaceContentsInnerMetadata
• PickfaceContentsInnerQuantity
• PickfaceIssue
• PickfaceLog
• PickfaceZone
• UpdatePickfaceRequest
• UpdatePickfaceRequestContentsInner
• UpdatePickfaceRequestContentsInnerQuantity
• UpdatePickfaceRequestContentsInnerQuantityAvailable
• UpdatePickfaceRequestContentsInnerQuantityZWip
• UpdatePickfacesRequest
• UpdatePickfacesRequestPickfacesInner
• VariantAttribute
• VariantAttributeThumbnail

Documentation For Authorization

Authentication schemes defined for the API:

api-key

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

session-oauth

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A