@blues-inc/notehub-js

NotehubJs - JavaScript client for @blues-inc/notehub-js The OpenAPI definition for the Notehub.io API.

This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version: 1.0.12
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://dev.blues.io/support/

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 @blues-inc/notehub-js --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 @blues-inc/notehub-js 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 NotehubJs = require("@blues-inc/notehub-js");

var api = new NotehubJs.AuthorizationApi();
var loginRequest = { username: "name@example.com", password: "test-password" }; // {LoginRequest}
api.login(loginRequest).then(
  function (data) {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  },
  function (error) {
    console.error(error);
  }
);

Documentation for API Endpoints

All URIs are relative to https://api.notefile.net

Class	Method	HTTP request
NotehubJs.AuthorizationApi	login	POST /auth/login
NotehubJs.BillingAccountApi	getBillingAccounts	GET /v1/billing-accounts
NotehubJs.DeviceApi	deleteDeviceEnvironmentVariable	DELETE /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables/{key}
NotehubJs.DeviceApi	deleteDeviceFleets	DELETE /v1/projects/{projectUID}/devices/{deviceUID}/fleets
NotehubJs.DeviceApi	disableDevice	POST /v1/projects/{projectUID}/devices/{deviceUID}/disable
NotehubJs.DeviceApi	enableDevice	POST /v1/projects/{projectUID}/devices/{deviceUID}/enable
NotehubJs.DeviceApi	getDeviceEnvironmentVariables	GET /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables
NotehubJs.DeviceApi	getDeviceEnvironmentVariablesByPin	GET /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin
NotehubJs.DeviceApi	getDeviceFleets	GET /v1/projects/{projectUID}/devices/{deviceUID}/fleets
NotehubJs.DeviceApi	getDeviceHealthLog	GET /v1/projects/{projectUID}/devices/{deviceUID}/health-log
NotehubJs.DeviceApi	getDeviceLatest	GET /v1/projects/{projectUID}/devices/{deviceUID}/latest
NotehubJs.DeviceApi	getDevicePublicKey	GET /v1/projects/{projectUID}/devices/{deviceUID}/public-key
NotehubJs.DeviceApi	getDeviceSessions	GET /v1/projects/{projectUID}/devices/{deviceUID}/sessions
NotehubJs.DeviceApi	handleNoteSignal	POST /v1/projects/{projectUID}/devices/{deviceUID}/signal
NotehubJs.DeviceApi	putDeviceEnvironmentVariables	PUT /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables
NotehubJs.DeviceApi	putDeviceEnvironmentVariablesByPin	PUT /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin
NotehubJs.DeviceApi	putDeviceFleets	PUT /v1/projects/{projectUID}/devices/{deviceUID}/fleets
NotehubJs.DevicesApi	deleteProjectDevice	DELETE /v1/projects/{projectUID}/devices/{deviceUID}
NotehubJs.DevicesApi	getDevice	GET /v1/projects/{projectUID}/devices/{deviceUID}
NotehubJs.DevicesApi	getProjectDevicePublicKeys	GET /v1/projects/{projectUID}/devices/public-keys
NotehubJs.DevicesApi	getProjectDevices	GET /v1/projects/{projectUID}/devices
NotehubJs.DevicesApi	getProjectFleetDevices	GET /v1/projects/{projectUID}/fleets/{fleetUID}/devices
NotehubJs.EnvironmentVariablesApi	deleteDeviceEnvironmentVariable	DELETE /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables/{key}
NotehubJs.EnvironmentVariablesApi	deleteFleetEnvironmentVariable	DELETE /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables/{key}
NotehubJs.EnvironmentVariablesApi	deleteProjectEnvironmentVariable	DELETE /v1/projects/{projectUID}/environment_variables/{key}
NotehubJs.EnvironmentVariablesApi	getDeviceEnvironmentVariables	GET /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables
NotehubJs.EnvironmentVariablesApi	getDeviceEnvironmentVariablesByPin	GET /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin
NotehubJs.EnvironmentVariablesApi	getFleetEnvironmentVariables	GET /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables
NotehubJs.EnvironmentVariablesApi	getProjectEnvironmentVariables	GET /v1/projects/{projectUID}/environment_variables
NotehubJs.EnvironmentVariablesApi	putDeviceEnvironmentVariables	PUT /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables
NotehubJs.EnvironmentVariablesApi	putDeviceEnvironmentVariablesByPin	PUT /v1/projects/{projectUID}/devices/{deviceUID}/environment_variables_with_pin
NotehubJs.EnvironmentVariablesApi	putFleetEnvironmentVariables	PUT /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables
NotehubJs.EnvironmentVariablesApi	putProjectEnvironmentVariables	PUT /v1/projects/{projectUID}/environment_variables
NotehubJs.EventApi	getFleetEvents	GET /v1/projects/{projectUID}/fleets/{fleetUID}/events
NotehubJs.EventApi	getFleetEventsByCursor	GET /v1/projects/{projectUID}/fleets/{fleetUID}/events-cursor
NotehubJs.EventApi	getProjectEvents	GET /v1/projects/{projectUID}/events
NotehubJs.EventApi	getProjectEventsByCursor	GET /v1/projects/{projectUID}/events-cursor
NotehubJs.FilesApi	handleNotefileChanges	GET /v1/projects/{projectUID}/devices/{deviceUID}/files/changes
NotehubJs.FilesApi	handleNotefileChangesPending	GET /v1/projects/{projectUID}/devices/{deviceUID}/files/changes/pending
NotehubJs.FilesApi	handleNotefileDelete	DELETE /v1/projects/{projectUID}/devices/{deviceUID}/files
NotehubJs.FleetApi	createFleet	POST /v1/projects/{projectUID}/fleets
NotehubJs.FleetApi	deleteDeviceFleets	DELETE /v1/projects/{projectUID}/devices/{deviceUID}/fleets
NotehubJs.FleetApi	deleteFleet	DELETE /v1/projects/{projectUID}/fleets/{fleetUID}
NotehubJs.FleetApi	deleteFleetEnvironmentVariable	DELETE /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables/{key}
NotehubJs.FleetApi	getDeviceFleets	GET /v1/projects/{projectUID}/devices/{deviceUID}/fleets
NotehubJs.FleetApi	getFleetEnvironmentVariables	GET /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables
NotehubJs.FleetApi	getFleetEvents	GET /v1/projects/{projectUID}/fleets/{fleetUID}/events
NotehubJs.FleetApi	getFleetEventsByCursor	GET /v1/projects/{projectUID}/fleets/{fleetUID}/events-cursor
NotehubJs.FleetApi	getProjectFleetDevices	GET /v1/projects/{projectUID}/fleets/{fleetUID}/devices
NotehubJs.FleetApi	getProjectFleets	GET /v1/projects/{projectUID}/fleets
NotehubJs.FleetApi	putDeviceFleets	PUT /v1/projects/{projectUID}/devices/{deviceUID}/fleets
NotehubJs.FleetApi	putFleetEnvironmentVariables	PUT /v1/projects/{projectUID}/fleets/{fleetUID}/environment_variables
NotehubJs.FleetApi	updateFleet	PUT /v1/projects/{projectUID}/fleets/{fleetUID}
NotehubJs.NotesApi	handleNoteAdd	POST /v1/projects/{projectUID}/devices/{deviceUID}/notes/{notefileID}
NotehubJs.NotesApi	handleNoteChanges	GET /v1/projects/{projectUID}/devices/{deviceUID}/notes/{notefileID}/changes
NotehubJs.NotesApi	handleNoteCreateAdd	POST /v1/projects/{projectUID}/devices/{deviceUID}/notes/{notefileID}/{noteID}
NotehubJs.NotesApi	handleNoteDelete	DELETE /v1/projects/{projectUID}/devices/{deviceUID}/notes/{notefileID}/{noteID}
NotehubJs.NotesApi	handleNoteGet	GET /v1/projects/{projectUID}/devices/{deviceUID}/notes/{notefileID}/{noteID}
NotehubJs.NotesApi	handleNoteUpdate	PUT /v1/projects/{projectUID}/devices/{deviceUID}/notes/{notefileID}/{noteID}
NotehubJs.ProductApi	createProduct	POST /v1/projects/{projectUID}/products
NotehubJs.ProductApi	getProjectByProduct	GET /v1/products/{productUID}/project
NotehubJs.ProductApi	getProjectProducts	GET /v1/projects/{projectUID}/products
NotehubJs.ProjectApi	createProduct	POST /v1/projects/{projectUID}/products
NotehubJs.ProjectApi	createProject	POST /v1/projects
NotehubJs.ProjectApi	deleteProjectEnvironmentVariable	DELETE /v1/projects/{projectUID}/environment_variables/{key}
NotehubJs.ProjectApi	getProject	GET /v1/projects/{projectUID}
NotehubJs.ProjectApi	getProjectByProduct	GET /v1/products/{productUID}/project
NotehubJs.ProjectApi	getProjectDevicePublicKeys	GET /v1/projects/{projectUID}/devices/public-keys
NotehubJs.ProjectApi	getProjectDevices	GET /v1/projects/{projectUID}/devices
NotehubJs.ProjectApi	getProjectEnvironmentVariables	GET /v1/projects/{projectUID}/environment_variables
NotehubJs.ProjectApi	getProjectEvents	GET /v1/projects/{projectUID}/events
NotehubJs.ProjectApi	getProjectEventsByCursor	GET /v1/projects/{projectUID}/events-cursor
NotehubJs.ProjectApi	getProjectFleetDevices	GET /v1/projects/{projectUID}/fleets/{fleetUID}/devices
NotehubJs.ProjectApi	getProjectMembers	GET /v1/projects/{projectUID}/members
NotehubJs.ProjectApi	getProjectProducts	GET /v1/projects/{projectUID}/products
NotehubJs.ProjectApi	getProjects	GET /v1/projects
NotehubJs.ProjectApi	putProjectEnvironmentVariables	PUT /v1/projects/{projectUID}/environment_variables
NotehubJs.RouteApi	createRoute	POST /v1/projects/{projectUID}/routes
NotehubJs.RouteApi	deleteRoute	DELETE /v1/projects/{projectUID}/routes/{routeUID}
NotehubJs.RouteApi	getRoute	GET /v1/projects/{projectUID}/routes/{routeUID}
NotehubJs.RouteApi	getRoutes	GET /v1/projects/{projectUID}/routes
NotehubJs.RouteApi	updateRoute	PUT /v1/projects/{projectUID}/routes/{routeUID}

npm