recycler_inlane v1.0.0

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 /

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