recycler_inlane

in_lane_api

InLaneApi - JavaScript client for in_lane_api InLane communication Web Api This SDK is automatically generated by the Swagger Codegen project:

• API version: v1
• Package version: v1
• Build package: io.swagger.codegen.v3.generators.javascript.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 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:

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

Documentation for Models

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

Documentation for Authorization

Bearer

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