# recycler_inlane

> Inlane web API

Latest version **1.0.0** (published 2021-11-09) · ISC license · 0 weekly downloads

## Install

```sh
npm install recycler_inlane
pnpm add recycler_inlane
yarn add recycler_inlane
bun add recycler_inlane
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-11-09 |
| First published | 2021-11-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 588 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | salman |
| Maintainers | rahul-socius |
| Keywords | inlane |

## Links

- npm: https://www.npmjs.com/package/recycler_inlane
- Repository: https://github.com/odoosocius/inlane
- Homepage: https://github.com/odoosocius/inlane#readme
- Issues: https://github.com/odoosocius/inlane/issues
- npm.io page: https://npm.io/package/recycler_inlane

## Dependencies (2)

- [@babel/cli](https://npm.io/package/@babel/cli.md) ^7.0.0
- [superagent](https://npm.io/package/superagent.md) ^5.3.0

## Recent versions

- 1.0.0 (latest) — 2021-11-09

## README

# in_lane_api

InLaneApi - JavaScript client for in_lane_api
InLane communication Web Api
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: v1
- Package version: v1
- Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install in_lane_api --save
```

#### 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:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
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:

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

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var InLaneApi = require('in_lane_api');
var defaultClient = InLaneApi.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new InLaneApi.AuthApi()
var body = new InLaneApi.LoginRequest(); // {LoginRequest} Object LoginRequest containing appId and username

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.apiV1AuthLoginPost(body, callback);
```

## Documentation for API Endpoints

All URIs are relative to */*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*InLaneApi.AuthApi* | [**apiV1AuthLoginPost**](docs/AuthApi.md#apiV1AuthLoginPost) | **POST** /api/v1/Auth/login | Login a client app to the web api (Allowed requests without authentication token)
*InLaneApi.BagCollectionApi* | [**apiV1OperationBagCollectionStartPost**](docs/BagCollectionApi.md#apiV1OperationBagCollectionStartPost) | **POST** /api/v1/operation/BagCollection/start | Start a new bag collection operation to change the bags inside the safe
*InLaneApi.BagCollectionApi* | [**apiV1OperationBagCollectionStatusGet**](docs/BagCollectionApi.md#apiV1OperationBagCollectionStatusGet) | **GET** /api/v1/operation/BagCollection/status | Retrieve the status of the bag collection operation
*InLaneApi.CassetteCollectionApi* | [**apiV1OperationCassetteCollectionReleaseCassettePost**](docs/CassetteCollectionApi.md#apiV1OperationCassetteCollectionReleaseCassettePost) | **POST** /api/v1/operation/CassetteCollection/releaseCassette | Command to release the hook of the cassette for 30 seconds
*InLaneApi.CassetteCollectionApi* | [**apiV1OperationCassetteCollectionStartPost**](docs/CassetteCollectionApi.md#apiV1OperationCassetteCollectionStartPost) | **POST** /api/v1/operation/CassetteCollection/start | Start a new banknotes cassette collection operation
*InLaneApi.CassetteCollectionApi* | [**apiV1OperationCassetteCollectionStatusGet**](docs/CassetteCollectionApi.md#apiV1OperationCassetteCollectionStatusGet) | **GET** /api/v1/operation/CassetteCollection/status | Retrieve the status of the cassette collection operation
*InLaneApi.ContentApi* | [**apiV1ContentAlertsGet**](docs/ContentApi.md#apiV1ContentAlertsGet) | **GET** /api/v1/Content/alerts | Retrieve denominations that are under or over existing thresholds.
*InLaneApi.ContentApi* | [**apiV1ContentCountingGet**](docs/ContentApi.md#apiV1ContentCountingGet) | **GET** /api/v1/Content/counting | Retrieve all device counting
*InLaneApi.ContentApi* | [**apiV1ContentGet**](docs/ContentApi.md#apiV1ContentGet) | **GET** /api/v1/Content | Retrieve the device content by stock
*InLaneApi.ContentApi* | [**apiV1ContentResetCountingPost**](docs/ContentApi.md#apiV1ContentResetCountingPost) | **POST** /api/v1/Content/resetCounting | Reset the content of a stock
*InLaneApi.DeviceInfoApi* | [**apiV1DeviceInfoConfigurationGet**](docs/DeviceInfoApi.md#apiV1DeviceInfoConfigurationGet) | **GET** /api/v1/DeviceInfo/configuration | Retrieve the stocks configurations
*InLaneApi.DeviceInfoApi* | [**apiV1DeviceInfoCurrencyExchangeRatesGet**](docs/DeviceInfoApi.md#apiV1DeviceInfoCurrencyExchangeRatesGet) | **GET** /api/v1/DeviceInfo/currencyExchangeRates | Retrieve currency exchange rates
*InLaneApi.DeviceInfoApi* | [**apiV1DeviceInfoCurrencyExchangeRatesPost**](docs/DeviceInfoApi.md#apiV1DeviceInfoCurrencyExchangeRatesPost) | **POST** /api/v1/DeviceInfo/currencyExchangeRates | Save new exchange rates on the machine
*InLaneApi.DeviceInfoApi* | [**apiV1DeviceInfoGet**](docs/DeviceInfoApi.md#apiV1DeviceInfoGet) | **GET** /api/v1/DeviceInfo | Retrieve the device information
*InLaneApi.DeviceInfoApi* | [**apiV1DeviceInfoMainCurrencyGet**](docs/DeviceInfoApi.md#apiV1DeviceInfoMainCurrencyGet) | **GET** /api/v1/DeviceInfo/mainCurrency | Retrieve main currency
*InLaneApi.EmptyOutApi* | [**apiV1OperationEmptyOutStartPost**](docs/EmptyOutApi.md#apiV1OperationEmptyOutStartPost) | **POST** /api/v1/operation/EmptyOut/start | Start a new empty out operation to empty some/all stocks
*InLaneApi.EmptyOutApi* | [**apiV1OperationEmptyOutStatusGet**](docs/EmptyOutApi.md#apiV1OperationEmptyOutStatusGet) | **GET** /api/v1/operation/EmptyOut/status | Retrieve the status of the empty out operation
*InLaneApi.ManualRefillApi* | [**apiV1OperationManualRefillNewContentPost**](docs/ManualRefillApi.md#apiV1OperationManualRefillNewContentPost) | **POST** /api/v1/operation/ManualRefill/newContent | Command to send the new content to the machine
*InLaneApi.ManualRefillApi* | [**apiV1OperationManualRefillStartPost**](docs/ManualRefillApi.md#apiV1OperationManualRefillStartPost) | **POST** /api/v1/operation/ManualRefill/start | Start a new manual refill operation to change manually the device content
*InLaneApi.ManualRefillApi* | [**apiV1OperationManualRefillStatusGet**](docs/ManualRefillApi.md#apiV1OperationManualRefillStatusGet) | **GET** /api/v1/operation/ManualRefill/status | Retrieve the status of the manual refill operation
*InLaneApi.PaymentApi* | [**apiV1OperationPaymentEndPost**](docs/PaymentApi.md#apiV1OperationPaymentEndPost) | **POST** /api/v1/operation/Payment/end | Stop the payment operation during the deposit phase
*InLaneApi.PaymentApi* | [**apiV1OperationPaymentStartPost**](docs/PaymentApi.md#apiV1OperationPaymentStartPost) | **POST** /api/v1/operation/Payment/start | Start a new payment operation (from the deposit to the dispensation of the change if necessary)
*InLaneApi.PaymentApi* | [**apiV1OperationPaymentStatusGet**](docs/PaymentApi.md#apiV1OperationPaymentStatusGet) | **GET** /api/v1/operation/Payment/status | Retrieve the status of the payment operation
*InLaneApi.RefillApi* | [**apiV1OperationRefillEndPost**](docs/RefillApi.md#apiV1OperationRefillEndPost) | **POST** /api/v1/operation/Refill/end | Stop the refill operation
*InLaneApi.RefillApi* | [**apiV1OperationRefillStartPost**](docs/RefillApi.md#apiV1OperationRefillStartPost) | **POST** /api/v1/operation/Refill/start | Start a new refill operation
*InLaneApi.RefillApi* | [**apiV1OperationRefillStatusGet**](docs/RefillApi.md#apiV1OperationRefillStatusGet) | **GET** /api/v1/operation/Refill/status | Retrieve the status of the refill operation
*InLaneApi.ResetApi* | [**apiV1OperationResetStartPost**](docs/ResetApi.md#apiV1OperationResetStartPost) | **POST** /api/v1/operation/Reset/start | Start a new device reset operation
*InLaneApi.ResetApi* | [**apiV1OperationResetStatusGet**](docs/ResetApi.md#apiV1OperationResetStatusGet) | **GET** /api/v1/operation/Reset/status | Retrieve the status of the reset operation
*InLaneApi.StatusApi* | [**apiV1StatusGet**](docs/StatusApi.md#apiV1StatusGet) | **GET** /api/v1/Status | Retrieve the device status
*InLaneApi.TransactionsApi* | [**apiV1TransactionsGet**](docs/TransactionsApi.md#apiV1TransactionsGet) | **GET** /api/v1/Transactions | Retrieve the details of a single committed transaction by id or by reference
*InLaneApi.TransferApi* | [**apiV1OperationTransferStartPost**](docs/TransferApi.md#apiV1OperationTransferStartPost) | **POST** /api/v1/operation/Transfer/start | Start a new transfer operation
*InLaneApi.TransferApi* | [**apiV1OperationTransferStatusGet**](docs/TransferApi.md#apiV1OperationTransferStatusGet) | **GET** /api/v1/operation/Transfer/status | Retrieve the status of the transfer operation
*InLaneApi.TransferAllButKitApi* | [**apiV1OperationTransferAllButKitCheckUnderThresholdKitDenominationsGet**](docs/TransferAllButKitApi.md#apiV1OperationTransferAllButKitCheckUnderThresholdKitDenominationsGet) | **GET** /api/v1/operation/TransferAllButKit/checkUnderThresholdKitDenominations | Function to check if there are some denomination under the minimum kit threshold
*InLaneApi.TransferAllButKitApi* | [**apiV1OperationTransferAllButKitConfigurationGet**](docs/TransferAllButKitApi.md#apiV1OperationTransferAllButKitConfigurationGet) | **GET** /api/v1/operation/TransferAllButKit/configuration | Function to read minimum kit configured
*InLaneApi.TransferAllButKitApi* | [**apiV1OperationTransferAllButKitConfigurationPost**](docs/TransferAllButKitApi.md#apiV1OperationTransferAllButKitConfigurationPost) | **POST** /api/v1/operation/TransferAllButKit/configuration | Function to set the Minimum Kit
*InLaneApi.TransferAllButKitApi* | [**apiV1OperationTransferAllButKitStartPost**](docs/TransferAllButKitApi.md#apiV1OperationTransferAllButKitStartPost) | **POST** /api/v1/operation/TransferAllButKit/start | Start a new transfer all but kit operation
*InLaneApi.TransferAllButKitApi* | [**apiV1OperationTransferAllButKitStatusGet**](docs/TransferAllButKitApi.md#apiV1OperationTransferAllButKitStatusGet) | **GET** /api/v1/operation/TransferAllButKit/status | Retrieve the status of the transfer all but kit operation
*InLaneApi.WithdrawalApi* | [**apiV1OperationWithdrawalStartByCurrencyAmountPost**](docs/WithdrawalApi.md#apiV1OperationWithdrawalStartByCurrencyAmountPost) | **POST** /api/v1/operation/Withdrawal/startByCurrencyAmount | Start new withdrawal operation by currency amount
*InLaneApi.WithdrawalApi* | [**apiV1OperationWithdrawalStartByDenominationPost**](docs/WithdrawalApi.md#apiV1OperationWithdrawalStartByDenominationPost) | **POST** /api/v1/operation/Withdrawal/startByDenomination | Start new withdrawal operation by denomination
*InLaneApi.WithdrawalApi* | [**apiV1OperationWithdrawalStatusGet**](docs/WithdrawalApi.md#apiV1OperationWithdrawalStatusGet) | **GET** /api/v1/operation/Withdrawal/status | Retrieve the status of the transfer operation

## Documentation for Models

 - [InLaneApi.ApiVersionInfo](docs/ApiVersionInfo.md)
 - [InLaneApi.BagCollectionOperationStatus](docs/BagCollectionOperationStatus.md)
 - [InLaneApi.BagCollectionStatusEnum](docs/BagCollectionStatusEnum.md)
 - [InLaneApi.BagCollectionTypeEnum](docs/BagCollectionTypeEnum.md)
 - [InLaneApi.BanknoteBagTypeEnum](docs/BanknoteBagTypeEnum.md)
 - [InLaneApi.BanknotesModuleInfo](docs/BanknotesModuleInfo.md)
 - [InLaneApi.CashContent](docs/CashContent.md)
 - [InLaneApi.CashCount](docs/CashCount.md)
 - [InLaneApi.CashDetail](docs/CashDetail.md)
 - [InLaneApi.CashMediaType](docs/CashMediaType.md)
 - [InLaneApi.CassetteCollectionOperationStatus](docs/CassetteCollectionOperationStatus.md)
 - [InLaneApi.CassetteCollectionStatusEnum](docs/CassetteCollectionStatusEnum.md)
 - [InLaneApi.CoinBagTypeEnum](docs/CoinBagTypeEnum.md)
 - [InLaneApi.CoinsModuleInfo](docs/CoinsModuleInfo.md)
 - [InLaneApi.CommandFailedResponse](docs/CommandFailedResponse.md)
 - [InLaneApi.ContentAlert](docs/ContentAlert.md)
 - [InLaneApi.CountingType](docs/CountingType.md)
 - [InLaneApi.CurrencyAmount](docs/CurrencyAmount.md)
 - [InLaneApi.CurrencyString](docs/CurrencyString.md)
 - [InLaneApi.Denomination](docs/Denomination.md)
 - [InLaneApi.DenominationConfig](docs/DenominationConfig.md)
 - [InLaneApi.DepositStatus](docs/DepositStatus.md)
 - [InLaneApi.DeviceContentDetail](docs/DeviceContentDetail.md)
 - [InLaneApi.DeviceContentResponse](docs/DeviceContentResponse.md)
 - [InLaneApi.DeviceCountingDetail](docs/DeviceCountingDetail.md)
 - [InLaneApi.DeviceCountingResponse](docs/DeviceCountingResponse.md)
 - [InLaneApi.DeviceGlobalStatusEnum](docs/DeviceGlobalStatusEnum.md)
 - [InLaneApi.DeviceInfo](docs/DeviceInfo.md)
 - [InLaneApi.DeviceInfoResponse](docs/DeviceInfoResponse.md)
 - [InLaneApi.DeviceStatus](docs/DeviceStatus.md)
 - [InLaneApi.DeviceStatusResponse](docs/DeviceStatusResponse.md)
 - [InLaneApi.DispenseStatus](docs/DispenseStatus.md)
 - [InLaneApi.DoorConfigurationEnum](docs/DoorConfigurationEnum.md)
 - [InLaneApi.DoorStatus](docs/DoorStatus.md)
 - [InLaneApi.DoorTypeEnum](docs/DoorTypeEnum.md)
 - [InLaneApi.EmptyOutOperationStatus](docs/EmptyOutOperationStatus.md)
 - [InLaneApi.ErrorCode](docs/ErrorCode.md)
 - [InLaneApi.ExchangeRate](docs/ExchangeRate.md)
 - [InLaneApi.KitDenomination](docs/KitDenomination.md)
 - [InLaneApi.LoginRequest](docs/LoginRequest.md)
 - [InLaneApi.LoginResponse](docs/LoginResponse.md)
 - [InLaneApi.ManualRefillOperationStatus](docs/ManualRefillOperationStatus.md)
 - [InLaneApi.ManualRefillStatusEnum](docs/ManualRefillStatusEnum.md)
 - [InLaneApi.MinimumKitConfiguration](docs/MinimumKitConfiguration.md)
 - [InLaneApi.ModuleStatus](docs/ModuleStatus.md)
 - [InLaneApi.OperationAvailabilityEnum](docs/OperationAvailabilityEnum.md)
 - [InLaneApi.OperationStatus](docs/OperationStatus.md)
 - [InLaneApi.OperationStatusEnum](docs/OperationStatusEnum.md)
 - [InLaneApi.PaymentOperationStatus](docs/PaymentOperationStatus.md)
 - [InLaneApi.PaymentStatusEnum](docs/PaymentStatusEnum.md)
 - [InLaneApi.ProblemDetails](docs/ProblemDetails.md)
 - [InLaneApi.RefillOperationStatus](docs/RefillOperationStatus.md)
 - [InLaneApi.StartBagCollectionReqData](docs/StartBagCollectionReqData.md)
 - [InLaneApi.StartEmptyOutReqData](docs/StartEmptyOutReqData.md)
 - [InLaneApi.StartOperationResponse](docs/StartOperationResponse.md)
 - [InLaneApi.StartPaymentReqData](docs/StartPaymentReqData.md)
 - [InLaneApi.StartTransferAllButKitClientReqData](docs/StartTransferAllButKitClientReqData.md)
 - [InLaneApi.StartTransferReqData](docs/StartTransferReqData.md)
 - [InLaneApi.StockConfiguration](docs/StockConfiguration.md)
 - [InLaneApi.StockStatus](docs/StockStatus.md)
 - [InLaneApi.StockStatusEnum](docs/StockStatusEnum.md)
 - [InLaneApi.StockTypeEnum](docs/StockTypeEnum.md)
 - [InLaneApi.StockWorkmodeEnum](docs/StockWorkmodeEnum.md)
 - [InLaneApi.StopPaymentReqData](docs/StopPaymentReqData.md)
 - [InLaneApi.TransactionCountings](docs/TransactionCountings.md)
 - [InLaneApi.TransactionResponse](docs/TransactionResponse.md)
 - [InLaneApi.TransactionTotals](docs/TransactionTotals.md)
 - [InLaneApi.TransactionTypeEnum](docs/TransactionTypeEnum.md)
 - [InLaneApi.TransferAllButKitOperationStatus](docs/TransferAllButKitOperationStatus.md)
 - [InLaneApi.TransferOperationStatus](docs/TransferOperationStatus.md)
 - [InLaneApi.TransferSource](docs/TransferSource.md)
 - [InLaneApi.TrayStatusEnum](docs/TrayStatusEnum.md)
 - [InLaneApi.WithdrawalOperationStatus](docs/WithdrawalOperationStatus.md)

## Documentation for Authorization


### Bearer

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header

---
_Source: https://npm.io/package/recycler_inlane · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._