npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

kibo-inventory-sdk

v1.0.0

Published

Inventory SDK

Downloads

4

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

mozuintegrationsmozuintegrations

Keywords

Readme

kibo-inventory-sdk

Inventory - JavaScript client for inventory Swagger JSON for inventory apis This SDK is automatically generated by the OpenAPI Generator project:

  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install kibo-inventory-sdk --save

Finally, you need to build the module:

npm run build
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your inventory from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:


var Inventory = require('kibo-sdk-inventory');

var inventoryApiClient = Inventory.ApiClient.instance;


inventoryApiClient.basePath = "[base path]";
inventoryApiClient.defaultHeaders = {
  Authorization: "Bearer [access_token]"
};


let inventoryControllerApi = new Inventory.InventoryControllerApi(inventoryApiClient);
var inventoryRequest = new Inventory.InventoryRequest();

var itemQuantity = new Inventory.ItemQuantity();
var requestLocation = new Inventory.RequestLocation();
requestLocation.locationCode = "[code]";
requestLocation.unit = null;

itemQuantity.upc = "[upc]";
itemQuantity.quantity = 1;

inventoryRequest.items = [itemQuantity];
inventoryRequest.requestLocation = requestLocation;
inventoryRequest.type = "ANY";


var xVolTenant = 1; // {Number} Tenant ID
var xVolSite = 1; // {Number} Site ID


let opts = {
  'xVolSite': xVolSite // Number | Site ID
};
inventoryControllerApi.postQueryInventory(xVolTenant, inventoryRequest, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log("Success on getInventory!!");
    console.log(data);
  }
});

Documentation for API Endpoints

All URIs are relative to https://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- Inventory.AllocationControllerApi | allocateInventory | POST /v5/inventory/allocate/ | Inventory.AllocationControllerApi | deallocateInventory | POST /v5/inventory/deallocate/ | Inventory.AllocationControllerApi | fulfillInventory | POST /v5/inventory/fulfill/ | Inventory.AuditControllerApi | cancelAudit | POST /v1/audit/{audit_id}/cancel/ | Inventory.AuditControllerApi | completeAudit | POST /v1/audit/{audit_id}/complete/ | Inventory.AuditControllerApi | createAudit | POST /v1/audit/ | Inventory.AuditControllerApi | getAuditDetails | GET /v1/audit/{audit_id}/ | Inventory.AuditControllerApi | getOpenAudits | GET /v1/audit/allOpen/{location_code}/ | Inventory.AuditControllerApi | searchAudits | POST /v1/audit/search/ | Inventory.BinControllerApi | createBin | POST /v1/bin/ | Inventory.BinControllerApi | deleteBin | DELETE /v1/bin/{bin_id} | Inventory.BinControllerApi | getBin | GET /v1/bin/{bin_id} | Inventory.BinControllerApi | getBinStatuses | GET /v1/bin/binStatuses/ | Inventory.BinControllerApi | getBinTypes | GET /v1/bin/binTypes/ | Inventory.BinControllerApi | getBins | GET /v1/bin/ | Inventory.BinControllerApi | loadInventory | POST /v1/bin/loadInventory/ | Inventory.BinControllerApi | searchBins | POST /v1/bin/searchInventory/ | Inventory.BinControllerApi | updateBin | POST /v1/bin/{bin_id}/ | Inventory.BinControllerApi | updateBins | POST /v1/bin/updateBins/ | Inventory.ExportInventoryControllerApi | createExportSettings | POST /v1/export/create | Inventory.ExportInventoryControllerApi | createExportSettingsFTP | POST /v1/export/ftp/create | Inventory.ExportInventoryControllerApi | createExportSettingsS3 | POST /v1/export/s3/create | Inventory.ExportInventoryControllerApi | deleteExportSettings | DELETE /v1/export/{exportSettingsName} | Inventory.ExportInventoryControllerApi | deleteExportSettingsFTP | DELETE /v1/export/ftp/{exportSettingsName}/{exportSettingsFTPName} | Inventory.ExportInventoryControllerApi | deleteExportSettingsS3 | DELETE /v1/export/s3/{exportSettingsName}/{exportSettingsS3Name} | Inventory.ExportInventoryControllerApi | getExportSettings | GET /v1/export | Inventory.ExportInventoryControllerApi | runExport | POST /v1/export/ | Inventory.ExportInventoryControllerApi | updateExportSettings | POST /v1/export/update | Inventory.ExportInventoryControllerApi | updateExportSettingsFTP | POST /v1/export/ftp/update | Inventory.ExportInventoryControllerApi | updateExportSettingsS3 | POST /v1/export/s3/update | Inventory.FetchFileConfigControllerApi | getFetchConfig | GET /v1/config/fetchfile/ | Inventory.FetchFileConfigControllerApi | saveFetchConfig | POST /v1/config/fetchfile/ | Inventory.InventoryControllerApi | aggregate | POST /v5/inventory/aggregate/ | Inventory.InventoryControllerApi | getInventory | GET /v5/inventory/ | Inventory.InventoryControllerApi | postQueryInventory | POST /v5/inventory/ | Inventory.JobControllerApi | getJob | GET /v1/queue/{jobID}/ | Inventory.JobControllerApi | getJobs | GET /v1/queue/ | Inventory.ModifyInventoryControllerApi | adjust | POST /v5/inventory/adjust/ | Inventory.ModifyInventoryControllerApi | callDelete | POST /v5/inventory/delete/ | Inventory.ModifyInventoryControllerApi | refresh | POST /v5/inventory/refresh/ | Inventory.ModifyInventoryControllerApi | syncAdjust | POST /v5/inventory/sync-adjust/ | Inventory.ModifyInventoryControllerApi | syncRefresh | POST /v5/inventory/sync-refresh/ | Inventory.OrderItemControllerApi | getOrderItemInformation | POST /v5/inventory/getOrderItemInformation/ | Inventory.OrderItemControllerApi | getOrderItemLog | POST /v5/inventory/getOrderItemLog/ | Inventory.PendingItemsControllerApi | deletePendingItems | DELETE /v1/pendingItem/{pendingItemID} | Inventory.PendingItemsControllerApi | getPendingItems | GET /v1/pendingItem/ | Inventory.ProductMappingControllerApi | createProductMapping | POST /v1/productMapping | Inventory.ProductMappingControllerApi | deleteProductMapping | DELETE /v1/productMapping/{direction} | Inventory.ProductMappingControllerApi | getProductMapping | GET /v1/productMapping | Inventory.WaveControllerApi | closePickWave | POST /v1/wave/{wave_id}/close/ | Inventory.WaveControllerApi | createPickWave | POST /v1/wave/ | Inventory.WaveControllerApi | getOpenPickWaves | GET /v1/wave/open/{location_id}/ | Inventory.WaveControllerApi | getWaveDetails | GET /v1/wave/{wave_id}/ | Inventory.WaveControllerApi | queryWaveSuggestion | POST /v1/wave/suggestion/ |

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.