# @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](https://openapi-generator.tech) project: - API version: 1.2.0 - Package version: 6.4.0 - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit [https://dev.blues.io/support/](https://dev.blues.io/support/) ## 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 @blues-inc/notehub-js --save ``` Finally, you need to build the module: ```shell 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: ```shell npm install ``` Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`: ```shell 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: ```shell npm link /path/to/ ``` Finally, you need to build the module: ```shell 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: ```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 NotehubJs = require("@blues-inc/notehub-js"); var defaultClient = NotehubJs.ApiClient.instance; // Configure Bearer access token for authorization: personalAccessToken var personalAccessToken = defaultClient.authentications["personalAccessToken"]; personalAccessToken.accessToken = "YOUR ACCESS TOKEN"; var api = new NotehubJs.AlertApi(); var projectOrProductUID = "app:2606f411-dea6-44a0-9743-1130f57d77d8"; // {String} var opts = { pageSize: 50, // {Number} pageNum: 1, // {Number} monitorUID: "monitorUID_example", // {String} }; api.getAlerts(projectOrProductUID, opts).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 | Description | | ------------------------------ | ------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- | -------------------------------------------------------- | | _NotehubJs.AlertApi_ | [**getAlerts**](docs/AlertApi.md#getAlerts) | **GET** /v1/projects/{projectOrProductUID}/alerts | | _NotehubJs.AuthorizationApi_ | [**login**](docs/AuthorizationApi.md#login) | **POST** /auth/login | | _NotehubJs.AuthorizationApi_ | [**oAuth2ClientCredentials**](docs/AuthorizationApi.md#oAuth2ClientCredentials) | **POST** /oauth2/token | Issue an OAuth 2.0 access token (Client Credentials) | | _NotehubJs.BillingAccountApi_ | [**getBillingAccount**](docs/BillingAccountApi.md#getBillingAccount) | **GET** /v1/billing-accounts/{billingAccountUID} | | _NotehubJs.BillingAccountApi_ | [**getBillingAccountBalanceHistory**](docs/BillingAccountApi.md#getBillingAccountBalanceHistory) | **GET** /v1/billing-accounts/{billingAccountUID}/balance-history | | _NotehubJs.BillingAccountApi_ | [**getBillingAccounts**](docs/BillingAccountApi.md#getBillingAccounts) | **GET** /v1/billing-accounts | | _NotehubJs.DeviceApi_ | [**addDbNote**](docs/DeviceApi.md#addDbNote) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} | | _NotehubJs.DeviceApi_ | [**addQiNote**](docs/DeviceApi.md#addQiNote) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID} | | _NotehubJs.DeviceApi_ | [**createNotefile**](docs/DeviceApi.md#createNotefile) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notefiles/{notefileID} | | _NotehubJs.DeviceApi_ | [**deleteDevice**](docs/DeviceApi.md#deleteDevice) | **DELETE** /v1/projects/{projectOrProductUID}/devices/{deviceUID} | | _NotehubJs.DeviceApi_ | [**deleteDeviceEnvironmentVariable**](docs/DeviceApi.md#deleteDeviceEnvironmentVariable) | **DELETE** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables/{key} | | _NotehubJs.DeviceApi_ | [**deleteNote**](docs/DeviceApi.md#deleteNote) | **DELETE** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} | | _NotehubJs.DeviceApi_ | [**deleteNotefiles**](docs/DeviceApi.md#deleteNotefiles) | **DELETE** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files | | _NotehubJs.DeviceApi_ | [**disableDevice**](docs/DeviceApi.md#disableDevice) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/disable | | _NotehubJs.DeviceApi_ | [**enableDevice**](docs/DeviceApi.md#enableDevice) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/enable | | _NotehubJs.DeviceApi_ | [**getDbNote**](docs/DeviceApi.md#getDbNote) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} | | _NotehubJs.DeviceApi_ | [**getDevice**](docs/DeviceApi.md#getDevice) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID} | | _NotehubJs.DeviceApi_ | [**getDeviceEnvironmentHierarchy**](docs/DeviceApi.md#getDeviceEnvironmentHierarchy) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_hierarchy | Get environment variable hierarchy for a device | | _NotehubJs.DeviceApi_ | [**getDeviceEnvironmentVariables**](docs/DeviceApi.md#getDeviceEnvironmentVariables) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables | | _NotehubJs.DeviceApi_ | [**getDeviceEnvironmentVariablesByPin**](docs/DeviceApi.md#getDeviceEnvironmentVariablesByPin) | **GET** /v1/products/{productUID}/devices/{deviceUID}/environment_variables_with_pin | | _NotehubJs.DeviceApi_ | [**getDeviceHealthLog**](docs/DeviceApi.md#getDeviceHealthLog) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/health-log | | _NotehubJs.DeviceApi_ | [**getDeviceJourney**](docs/DeviceApi.md#getDeviceJourney) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/journeys/{journeyID} | | _NotehubJs.DeviceApi_ | [**getDeviceJourneys**](docs/DeviceApi.md#getDeviceJourneys) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/journeys | | _NotehubJs.DeviceApi_ | [**getDeviceLatestEvents**](docs/DeviceApi.md#getDeviceLatestEvents) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/latest | | _NotehubJs.DeviceApi_ | [**getDevicePlans**](docs/DeviceApi.md#getDevicePlans) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/plans | | _NotehubJs.DeviceApi_ | [**getDevicePublicKey**](docs/DeviceApi.md#getDevicePublicKey) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/public-key | | _NotehubJs.DeviceApi_ | [**getDevicePublicKeys**](docs/DeviceApi.md#getDevicePublicKeys) | **GET** /v1/projects/{projectOrProductUID}/devices/public-keys | | _NotehubJs.DeviceApi_ | [**getDeviceSessions**](docs/DeviceApi.md#getDeviceSessions) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/sessions | | _NotehubJs.DeviceApi_ | [**getDevices**](docs/DeviceApi.md#getDevices) | **GET** /v1/projects/{projectOrProductUID}/devices | | _NotehubJs.DeviceApi_ | [**getFleetDevices**](docs/DeviceApi.md#getFleetDevices) | **GET** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/devices | | _NotehubJs.DeviceApi_ | [**getNotefile**](docs/DeviceApi.md#getNotefile) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID} | | _NotehubJs.DeviceApi_ | [**listNotefiles**](docs/DeviceApi.md#listNotefiles) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files | | _NotehubJs.DeviceApi_ | [**provisionDevice**](docs/DeviceApi.md#provisionDevice) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/provision | | _NotehubJs.DeviceApi_ | [**setDeviceEnvironmentVariables**](docs/DeviceApi.md#setDeviceEnvironmentVariables) | **PUT** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables | | _NotehubJs.DeviceApi_ | [**setDeviceEnvironmentVariablesByPin**](docs/DeviceApi.md#setDeviceEnvironmentVariablesByPin) | **PUT** /v1/products/{productUID}/devices/{deviceUID}/environment_variables_with_pin | | _NotehubJs.DeviceApi_ | [**signalDevice**](docs/DeviceApi.md#signalDevice) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/signal | | _NotehubJs.DeviceApi_ | [**updateDbNote**](docs/DeviceApi.md#updateDbNote) | **PUT** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} | | _NotehubJs.EventApi_ | [**getEvents**](docs/EventApi.md#getEvents) | **GET** /v1/projects/{projectOrProductUID}/events | | _NotehubJs.EventApi_ | [**getEventsByCursor**](docs/EventApi.md#getEventsByCursor) | **GET** /v1/projects/{projectOrProductUID}/events-cursor | | _NotehubJs.EventApi_ | [**getFleetEvents**](docs/EventApi.md#getFleetEvents) | **GET** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events | | _NotehubJs.EventApi_ | [**getFleetEventsByCursor**](docs/EventApi.md#getFleetEventsByCursor) | **GET** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events-cursor | | _NotehubJs.EventApi_ | [**getRouteLogsByEvent**](docs/EventApi.md#getRouteLogsByEvent) | **GET** /v1/projects/{projectOrProductUID}/events/{eventUID}/route-logs | | _NotehubJs.ExternalDevicesApi_ | [**createEventExtDevice**](docs/ExternalDevicesApi.md#createEventExtDevice) | **POST** /v1/products/{productUID}/ext-devices/{deviceUID}/event | | _NotehubJs.ExternalDevicesApi_ | [**extDeviceSessionClose**](docs/ExternalDevicesApi.md#extDeviceSessionClose) | **POST** /v1/products/{productUID}/ext-devices/{deviceUID}/session/close | | _NotehubJs.ExternalDevicesApi_ | [**extDeviceSessionOpen**](docs/ExternalDevicesApi.md#extDeviceSessionOpen) | **POST** /v1/products/{productUID}/ext-devices/{deviceUID}/session/open | | _NotehubJs.JobsApi_ | [**cancelJobRun**](docs/JobsApi.md#cancelJobRun) | **POST** /v1/projects/{projectOrProductUID}/jobs/runs/{reportUID}/cancel | | _NotehubJs.JobsApi_ | [**createJob**](docs/JobsApi.md#createJob) | **POST** /v1/projects/{projectOrProductUID}/jobs | | _NotehubJs.JobsApi_ | [**deleteJob**](docs/JobsApi.md#deleteJob) | **DELETE** /v1/projects/{projectOrProductUID}/jobs/{jobUID} | | _NotehubJs.JobsApi_ | [**deleteJobRun**](docs/JobsApi.md#deleteJobRun) | **DELETE** /v1/projects/{projectOrProductUID}/jobs/runs/{reportUID} | | _NotehubJs.JobsApi_ | [**getJob**](docs/JobsApi.md#getJob) | **GET** /v1/projects/{projectOrProductUID}/jobs/{jobUID} | | _NotehubJs.JobsApi_ | [**getJobRun**](docs/JobsApi.md#getJobRun) | **GET** /v1/projects/{projectOrProductUID}/jobs/runs/{reportUID} | | _NotehubJs.JobsApi_ | [**getJobRuns**](docs/JobsApi.md#getJobRuns) | **GET** /v1/projects/{projectOrProductUID}/jobs/{jobUID}/runs | | _NotehubJs.JobsApi_ | [**getJobs**](docs/JobsApi.md#getJobs) | **GET** /v1/projects/{projectOrProductUID}/jobs | | _NotehubJs.JobsApi_ | [**runJob**](docs/JobsApi.md#runJob) | **POST** /v1/projects/{projectOrProductUID}/jobs/{jobUID}/run | | _NotehubJs.MonitorApi_ | [**createMonitor**](docs/MonitorApi.md#createMonitor) | **POST** /v1/projects/{projectOrProductUID}/monitors | | _NotehubJs.MonitorApi_ | [**deleteMonitor**](docs/MonitorApi.md#deleteMonitor) | **DELETE** /v1/projects/{projectOrProductUID}/monitors/{monitorUID} | | _NotehubJs.MonitorApi_ | [**getMonitor**](docs/MonitorApi.md#getMonitor) | **GET** /v1/projects/{projectOrProductUID}/monitors/{monitorUID} | | _NotehubJs.MonitorApi_ | [**getMonitors**](docs/MonitorApi.md#getMonitors) | **GET** /v1/projects/{projectOrProductUID}/monitors | | _NotehubJs.MonitorApi_ | [**updateMonitor**](docs/MonitorApi.md#updateMonitor) | **PUT** /v1/projects/{projectOrProductUID}/monitors/{monitorUID} | | _NotehubJs.OrganizationApi_ | [**getOrganization**](docs/OrganizationApi.md#getOrganization) | **GET** /v1/organizations/{organizationUID} | | _NotehubJs.OrganizationApi_ | [**getOrganizationBalanceHistory**](docs/OrganizationApi.md#getOrganizationBalanceHistory) | **GET** /v1/organizations/{organizationUID}/balance-history | | _NotehubJs.OrganizationApi_ | [**getOrganizations**](docs/OrganizationApi.md#getOrganizations) | **GET** /v1/organizations | | _NotehubJs.ProjectApi_ | [**addDeviceToFleets**](docs/ProjectApi.md#addDeviceToFleets) | **PUT** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets | | _NotehubJs.ProjectApi_ | [**cloneProject**](docs/ProjectApi.md#cloneProject) | **POST** /v1/projects/{projectOrProductUID}/clone | | _NotehubJs.ProjectApi_ | [**createFleet**](docs/ProjectApi.md#createFleet) | **POST** /v1/projects/{projectOrProductUID}/fleets | | _NotehubJs.ProjectApi_ | [**createProduct**](docs/ProjectApi.md#createProduct) | **POST** /v1/projects/{projectOrProductUID}/products | | _NotehubJs.ProjectApi_ | [**createProject**](docs/ProjectApi.md#createProject) | **POST** /v1/projects | | _NotehubJs.ProjectApi_ | [**createProjectSecret**](docs/ProjectApi.md#createProjectSecret) | **POST** /v1/projects/{projectOrProductUID}/secrets | | _NotehubJs.ProjectApi_ | [**deleteDeviceFromFleets**](docs/ProjectApi.md#deleteDeviceFromFleets) | **DELETE** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets | | _NotehubJs.ProjectApi_ | [**deleteFirmware**](docs/ProjectApi.md#deleteFirmware) | **DELETE** /v1/projects/{projectOrProductUID}/firmware/{firmwareType}/{filename} | | _NotehubJs.ProjectApi_ | [**deleteFleet**](docs/ProjectApi.md#deleteFleet) | **DELETE** /v1/projects/{projectOrProductUID}/fleets/{fleetUID} | | _NotehubJs.ProjectApi_ | [**deleteFleetEnvironmentVariable**](docs/ProjectApi.md#deleteFleetEnvironmentVariable) | **DELETE** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables/{key} | | _NotehubJs.ProjectApi_ | [**deleteProduct**](docs/ProjectApi.md#deleteProduct) | **DELETE** /v1/projects/{projectOrProductUID}/products/{productUID} | | _NotehubJs.ProjectApi_ | [**deleteProject**](docs/ProjectApi.md#deleteProject) | **DELETE** /v1/projects/{projectOrProductUID} | | _NotehubJs.ProjectApi_ | [**deleteProjectEnvironmentVariable**](docs/ProjectApi.md#deleteProjectEnvironmentVariable) | **DELETE** /v1/projects/{projectOrProductUID}/environment_variables/{key} | | _NotehubJs.ProjectApi_ | [**deleteProjectSecret**](docs/ProjectApi.md#deleteProjectSecret) | **DELETE** /v1/projects/{projectOrProductUID}/secrets/{secretName} | | _NotehubJs.ProjectApi_ | [**disableGlobalEventTransformation**](docs/ProjectApi.md#disableGlobalEventTransformation) | **POST** /v1/projects/{projectOrProductUID}/global-transformation/disable | | _NotehubJs.ProjectApi_ | [**downloadFirmware**](docs/ProjectApi.md#downloadFirmware) | **GET** /v1/projects/{projectOrProductUID}/firmware/{firmwareType}/{filename} | | _NotehubJs.ProjectApi_ | [**enableGlobalEventTransformation**](docs/ProjectApi.md#enableGlobalEventTransformation) | **POST** /v1/projects/{projectOrProductUID}/global-transformation/enable | | _NotehubJs.ProjectApi_ | [**getAWSRoleConfig**](docs/ProjectApi.md#getAWSRoleConfig) | **GET** /v1/projects/{projectOrProductUID}/aws-role-config | Get AWS role configuration for role-based authentication | | _NotehubJs.ProjectApi_ | [**getDeviceDfuHistory**](docs/ProjectApi.md#getDeviceDfuHistory) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/dfu/{firmwareType}/history | | _NotehubJs.ProjectApi_ | [**getDeviceDfuStatus**](docs/ProjectApi.md#getDeviceDfuStatus) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/dfu/{firmwareType}/status | | _NotehubJs.ProjectApi_ | [**getDeviceFleets**](docs/ProjectApi.md#getDeviceFleets) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets | | _NotehubJs.ProjectApi_ | [**getDevicesDfuHistory**](docs/ProjectApi.md#getDevicesDfuHistory) | **GET** /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/history | | _NotehubJs.ProjectApi_ | [**getDevicesDfuStatus**](docs/ProjectApi.md#getDevicesDfuStatus) | **GET** /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/status | | _NotehubJs.ProjectApi_ | [**getFirmwareInfo**](docs/ProjectApi.md#getFirmwareInfo) | **GET** /v1/projects/{projectOrProductUID}/firmware | | _NotehubJs.ProjectApi_ | [**getFleet**](docs/ProjectApi.md#getFleet) | **GET** /v1/projects/{projectOrProductUID}/fleets/{fleetUID} | | _NotehubJs.ProjectApi_ | [**getFleetEnvironmentHierarchy**](docs/ProjectApi.md#getFleetEnvironmentHierarchy) | **GET** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_hierarchy | Get environment variable hierarchy for a device | | _NotehubJs.ProjectApi_ | [**getFleetEnvironmentVariables**](docs/ProjectApi.md#getFleetEnvironmentVariables) | **GET** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables | | _NotehubJs.ProjectApi_ | [**getFleets**](docs/ProjectApi.md#getFleets) | **GET** /v1/projects/{projectOrProductUID}/fleets | | _NotehubJs.ProjectApi_ | [**getNotefileSchemas**](docs/ProjectApi.md#getNotefileSchemas) | **GET** /v1/projects/{projectOrProductUID}/schemas | Get variable format for a notefile | | _NotehubJs.ProjectApi_ | [**getProducts**](docs/ProjectApi.md#getProducts) | **GET** /v1/projects/{projectOrProductUID}/products | | _NotehubJs.ProjectApi_ | [**getProject**](docs/ProjectApi.md#getProject) | **GET** /v1/projects/{projectOrProductUID} | | _NotehubJs.ProjectApi_ | [**getProjectByProduct**](docs/ProjectApi.md#getProjectByProduct) | **GET** /v1/products/{productUID}/project | | _NotehubJs.ProjectApi_ | [**getProjectEnvironmentHierarchy**](docs/ProjectApi.md#getProjectEnvironmentHierarchy) | **GET** /v1/projects/{projectOrProductUID}/environment_hierarchy | Get environment variable hierarchy for a device | | _NotehubJs.ProjectApi_ | [**getProjectEnvironmentVariables**](docs/ProjectApi.md#getProjectEnvironmentVariables) | **GET** /v1/projects/{projectOrProductUID}/environment_variables | | _NotehubJs.ProjectApi_ | [**getProjectMembers**](docs/ProjectApi.md#getProjectMembers) | **GET** /v1/projects/{projectOrProductUID}/members | | _NotehubJs.ProjectApi_ | [**getProjectSecrets**](docs/ProjectApi.md#getProjectSecrets) | **GET** /v1/projects/{projectOrProductUID}/secrets | | _NotehubJs.ProjectApi_ | [**getProjects**](docs/ProjectApi.md#getProjects) | **GET** /v1/projects | | _NotehubJs.ProjectApi_ | [**performDfuAction**](docs/ProjectApi.md#performDfuAction) | **POST** /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/{action} | | _NotehubJs.ProjectApi_ | [**setFleetEnvironmentVariables**](docs/ProjectApi.md#setFleetEnvironmentVariables) | **PUT** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables | | _NotehubJs.ProjectApi_ | [**setGlobalEventTransformation**](docs/ProjectApi.md#setGlobalEventTransformation) | **POST** /v1/projects/{projectOrProductUID}/global-transformation | | _NotehubJs.ProjectApi_ | [**setProjectEnvironmentVariables**](docs/ProjectApi.md#setProjectEnvironmentVariables) | **PUT** /v1/projects/{projectOrProductUID}/environment_variables | | _NotehubJs.ProjectApi_ | [**updateFirmware**](docs/ProjectApi.md#updateFirmware) | **POST** /v1/projects/{projectOrProductUID}/firmware/{firmwareType}/{filename} | | _NotehubJs.ProjectApi_ | [**updateFleet**](docs/ProjectApi.md#updateFleet) | **PUT** /v1/projects/{projectOrProductUID}/fleets/{fleetUID} | | _NotehubJs.ProjectApi_ | [**updateProjectSecret**](docs/ProjectApi.md#updateProjectSecret) | **PUT** /v1/projects/{projectOrProductUID}/secrets/{secretName} | | _NotehubJs.ProjectApi_ | [**uploadFirmware**](docs/ProjectApi.md#uploadFirmware) | **PUT** /v1/projects/{projectOrProductUID}/firmware/{firmwareType}/{filename} | | _NotehubJs.RouteApi_ | [**createRoute**](docs/RouteApi.md#createRoute) | **POST** /v1/projects/{projectOrProductUID}/routes | | _NotehubJs.RouteApi_ | [**deleteRoute**](docs/RouteApi.md#deleteRoute) | **DELETE** /v1/projects/{projectOrProductUID}/routes/{routeUID} | | _NotehubJs.RouteApi_ | [**getRoute**](docs/RouteApi.md#getRoute) | **GET** /v1/projects/{projectOrProductUID}/routes/{routeUID} | | _NotehubJs.RouteApi_ | [**getRouteLogsByRoute**](docs/RouteApi.md#getRouteLogsByRoute) | **GET** /v1/projects/{projectOrProductUID}/routes/{routeUID}/route-logs | | _NotehubJs.RouteApi_ | [**getRoutes**](docs/RouteApi.md#getRoutes) | **GET** /v1/projects/{projectOrProductUID}/routes | | _NotehubJs.RouteApi_ | [**updateRoute**](docs/RouteApi.md#updateRoute) | **PUT** /v1/projects/{projectOrProductUID}/routes/{routeUID} | | _NotehubJs.UsageApi_ | [**getDataUsage**](docs/UsageApi.md#getDataUsage) | **GET** /v1/projects/{projectOrProductUID}/usage/data | | _NotehubJs.UsageApi_ | [**getEventsUsage**](docs/UsageApi.md#getEventsUsage) | **GET** /v1/projects/{projectOrProductUID}/usage/events | | _NotehubJs.UsageApi_ | [**getRouteLogsUsage**](docs/UsageApi.md#getRouteLogsUsage) | **GET** /v1/projects/{projectOrProductUID}/usage/route-logs | | _NotehubJs.UsageApi_ | [**getSessionsUsage**](docs/UsageApi.md#getSessionsUsage) | **GET** /v1/projects/{projectOrProductUID}/usage/sessions | | _NotehubJs.WebhookApi_ | [**createLegacyWebhookEvent**](docs/WebhookApi.md#createLegacyWebhookEvent) | **POST** /v1/products/{productUID}/devices/{deviceUID}/webhook-event | | _NotehubJs.WebhookApi_ | [**createWebhook**](docs/WebhookApi.md#createWebhook) | **POST** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID} | | _NotehubJs.WebhookApi_ | [**createWebhookDeviceEventByProduct**](docs/WebhookApi.md#createWebhookDeviceEventByProduct) | **POST** /v1/products/{productUID}/webhooks/{webhookUID}/devices/{deviceUID}/event | | _NotehubJs.WebhookApi_ | [**createWebhookEventByProduct**](docs/WebhookApi.md#createWebhookEventByProduct) | **POST** /v1/products/{productUID}/webhooks/{webhookUID}/event | | _NotehubJs.WebhookApi_ | [**deleteWebhook**](docs/WebhookApi.md#deleteWebhook) | **DELETE** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID} | | _NotehubJs.WebhookApi_ | [**getWebhook**](docs/WebhookApi.md#getWebhook) | **GET** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID} | | _NotehubJs.WebhookApi_ | [**getWebhookSettingsByProduct**](docs/WebhookApi.md#getWebhookSettingsByProduct) | **GET** /v1/products/{productUID}/webhooks/{webhookUID}/settings | | _NotehubJs.WebhookApi_ | [**getWebhooks**](docs/WebhookApi.md#getWebhooks) | **GET** /v1/projects/{projectOrProductUID}/webhooks | | _NotehubJs.WebhookApi_ | [**updateLegacyWebhookSession**](docs/WebhookApi.md#updateLegacyWebhookSession) | **PUT** /v1/products/{productUID}/devices/{deviceUID}/webhook-session | | _NotehubJs.WebhookApi_ | [**updateWebhook**](docs/WebhookApi.md#updateWebhook) | **PUT** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID} | | _NotehubJs.WebhookApi_ | [**updateWebhookSettingsByProduct**](docs/WebhookApi.md#updateWebhookSettingsByProduct) | **PUT** /v1/products/{productUID}/webhooks/{webhookUID}/settings | ## Documentation for Models - [NotehubJs.AWSRoleConfig](docs/AWSRoleConfig.md) - [NotehubJs.AddDeviceToFleetsRequest](docs/AddDeviceToFleetsRequest.md) - [NotehubJs.Alert](docs/Alert.md) - [NotehubJs.AlertDataInner](docs/AlertDataInner.md) - [NotehubJs.AlertNotificationsInner](docs/AlertNotificationsInner.md) - [NotehubJs.AwsRoute](docs/AwsRoute.md) - [NotehubJs.AzureRoute](docs/AzureRoute.md) - [NotehubJs.BatchJobRequests](docs/BatchJobRequests.md) - [NotehubJs.BillingAccount](docs/BillingAccount.md) - [NotehubJs.BillingAccountRole](docs/BillingAccountRole.md) - [NotehubJs.BlynkRoute](docs/BlynkRoute.md) - [NotehubJs.Body](docs/Body.md) - [NotehubJs.CancelJobRun200Response](docs/CancelJobRun200Response.md) - [NotehubJs.CellularPlan](docs/CellularPlan.md) - [NotehubJs.CloneProjectRequest](docs/CloneProjectRequest.md) - [NotehubJs.Contact](docs/Contact.md) - [NotehubJs.CreateFleetRequest](docs/CreateFleetRequest.md) - [NotehubJs.CreateJob201Response](docs/CreateJob201Response.md) - [NotehubJs.CreateMonitor](docs/CreateMonitor.md) - [NotehubJs.CreateProductRequest](docs/CreateProductRequest.md) - [NotehubJs.CreateProjectRequest](docs/CreateProjectRequest.md) - [NotehubJs.CreateProjectSecretRequest](docs/CreateProjectSecretRequest.md) - [NotehubJs.CreateUpdateRepository](docs/CreateUpdateRepository.md) - [NotehubJs.CreatedRepository](docs/CreatedRepository.md) - [NotehubJs.CurrentFirmware](docs/CurrentFirmware.md) - [NotehubJs.DFUEnv](docs/DFUEnv.md) - [NotehubJs.DFUState](docs/DFUState.md) - [NotehubJs.DataField](docs/DataField.md) - [NotehubJs.DataSetField](docs/DataSetField.md) - [NotehubJs.DataUsage](docs/DataUsage.md) - [NotehubJs.DatacakeRoute](docs/DatacakeRoute.md) - [NotehubJs.DeleteDeviceFromFleetsRequest](docs/DeleteDeviceFromFleetsRequest.md) - [NotehubJs.DeleteJob200Response](docs/DeleteJob200Response.md) - [NotehubJs.DeleteNotefilesRequest](docs/DeleteNotefilesRequest.md) - [NotehubJs.Device](docs/Device.md) - [NotehubJs.DeviceDfuHistory](docs/DeviceDfuHistory.md) - [NotehubJs.DeviceDfuHistoryCurrent](docs/DeviceDfuHistoryCurrent.md) - [NotehubJs.DeviceDfuHistoryPage](docs/DeviceDfuHistoryPage.md) - [NotehubJs.DeviceDfuStateMachine](docs/DeviceDfuStateMachine.md) - [NotehubJs.DeviceDfuStateMachineNode](docs/DeviceDfuStateMachineNode.md) - [NotehubJs.DeviceDfuStatus](docs/DeviceDfuStatus.md) - [NotehubJs.DeviceDfuStatusPage](docs/DeviceDfuStatusPage.md) - [NotehubJs.DeviceSession](docs/DeviceSession.md) - [NotehubJs.DeviceTowerInfo](docs/DeviceTowerInfo.md) - [NotehubJs.DeviceUsage](docs/DeviceUsage.md) - [NotehubJs.DfuActionRequest](docs/DfuActionRequest.md) - [NotehubJs.EmailNotification](docs/EmailNotification.md) - [NotehubJs.EnvTreeJsonNode](docs/EnvTreeJsonNode.md) - [NotehubJs.EnvVar](docs/EnvVar.md) - [NotehubJs.EnvironmentVariables](docs/EnvironmentVariables.md) - [NotehubJs.Error](docs/Error.md) - [NotehubJs.Event](docs/Event.md) - [NotehubJs.Filter](docs/Filter.md) - [NotehubJs.Firmware](docs/Firmware.md) - [NotehubJs.FirmwareInfo](docs/FirmwareInfo.md) - [NotehubJs.Fleet](docs/Fleet.md) - [NotehubJs.FleetConnectivityAssurance](docs/FleetConnectivityAssurance.md) - [NotehubJs.GetAlerts200Response](docs/GetAlerts200Response.md) - [NotehubJs.GetBillingAccount200Response](docs/GetBillingAccount200Response.md) - [NotehubJs.GetBillingAccount200ResponsePlan](docs/GetBillingAccount200ResponsePlan.md) - [NotehubJs.GetBillingAccountBalanceHistory200Response](docs/GetBillingAccountBalanceHistory200Response.md) - [NotehubJs.GetBillingAccountBalanceHistory200ResponseDataInner](docs/GetBillingAccountBalanceHistory200ResponseDataInner.md) - [NotehubJs.GetBillingAccounts200Response](docs/GetBillingAccounts200Response.md) - [NotehubJs.GetDataUsage200Response](docs/GetDataUsage200Response.md) - [NotehubJs.GetDataUsage200ResponseDataInner](docs/GetDataUsage200ResponseDataInner.md) - [NotehubJs.GetDbNote200Response](docs/GetDbNote200Response.md) - [NotehubJs.GetDeviceEnvironmentVariablesByPin200Response](docs/GetDeviceEnvironmentVariablesByPin200Response.md) - [NotehubJs.GetDeviceFleets200Response](docs/GetDeviceFleets200Response.md) - [NotehubJs.GetDeviceHealthLog200Response](docs/GetDeviceHealthLog200Response.md) - [NotehubJs.GetDeviceHealthLog200ResponseHealthLogInner](docs/GetDeviceHealthLog200ResponseHealthLogInner.md) - [NotehubJs.GetDeviceJourney200Response](docs/GetDeviceJourney200Response.md) - [NotehubJs.GetDeviceJourney200ResponseJourney](docs/GetDeviceJourney200ResponseJourney.md) - [NotehubJs.GetDeviceJourneys200Response](docs/GetDeviceJourneys200Response.md) - [NotehubJs.GetDeviceJourneys200ResponseJourneysInner](docs/GetDeviceJourneys200ResponseJourneysInner.md) - [NotehubJs.GetDeviceLatestEvents200Response](docs/GetDeviceLatestEvents200Response.md) - [NotehubJs.GetDevicePlans200Response](docs/GetDevicePlans200Response.md) - [NotehubJs.GetDevicePublicKey200Response](docs/GetDevicePublicKey200Response.md) - [NotehubJs.GetDevicePublicKeys200Response](docs/GetDevicePublicKeys200Response.md) - [NotehubJs.GetDevicePublicKeys200ResponseDevicePublicKeysInner](docs/GetDevicePublicKeys200ResponseDevicePublicKeysInner.md) - [NotehubJs.GetDeviceSessions200Response](docs/GetDeviceSessions200Response.md) - [NotehubJs.GetDevices200Response](docs/GetDevices200Response.md) - [NotehubJs.GetEvents200Response](docs/GetEvents200Response.md) - [NotehubJs.GetEventsByCursor200Response](docs/GetEventsByCursor200Response.md) - [NotehubJs.GetJobRuns200Response](docs/GetJobRuns200Response.md) - [NotehubJs.GetJobs200Response](docs/GetJobs200Response.md) - [NotehubJs.GetNotefile200Response](docs/GetNotefile200Response.md) - [NotehubJs.GetOrganizations200Response](docs/GetOrganizations200Response.md) - [NotehubJs.GetProducts200Response](docs/GetProducts200Response.md) - [NotehubJs.GetProjectMembers200Response](docs/GetProjectMembers200Response.md) - [NotehubJs.GetProjectSecretsResponse](docs/GetProjectSecretsResponse.md) - [NotehubJs.GetProjects200Response](docs/GetProjects200Response.md) - [NotehubJs.GetRouteLogsUsage200Response](docs/GetRouteLogsUsage200Response.md) - [NotehubJs.GetSessionsUsage200Response](docs/GetSessionsUsage200Response.md) - [NotehubJs.GetWebhooks200Response](docs/GetWebhooks200Response.md) - [NotehubJs.GoogleRoute](docs/GoogleRoute.md) - [NotehubJs.HttpRoute](docs/HttpRoute.md) - [NotehubJs.Job](docs/Job.md) - [NotehubJs.JobDefinition](docs/JobDefinition.md) - [NotehubJs.JobDefinitionReportOptions](docs/JobDefinitionReportOptions.md) - [NotehubJs.JobDefinitionSelect](docs/JobDefinitionSelect.md) - [NotehubJs.JobDetail](docs/JobDetail.md) - [NotehubJs.JobDetailAllOf](docs/JobDetailAllOf.md) - [NotehubJs.JobRun](docs/JobRun.md) - [NotehubJs.Location](docs/Location.md) - [NotehubJs.Login200Response](docs/Login200Response.md) - [NotehubJs.LoginRequest](docs/LoginRequest.md) - [NotehubJs.Monitor](docs/Monitor.md) - [NotehubJs.MonitorAlertRoutesInner](docs/MonitorAlertRoutesInner.md) - [NotehubJs.MqttRoute](docs/MqttRoute.md) - [NotehubJs.Note](docs/Note.md) - [NotehubJs.NoteInput](docs/NoteInput.md) - [NotehubJs.Notefile](docs/Notefile.md) - [NotehubJs.NotefileSchema](docs/NotefileSchema.md) - [NotehubJs.NotehubRoute](docs/NotehubRoute.md) - [NotehubJs.NotehubRouteSummary](docs/NotehubRouteSummary.md) - [NotehubJs.OAuth2Error](docs/OAuth2Error.md) - [NotehubJs.OAuth2TokenResponse](docs/OAuth2TokenResponse.md) - [NotehubJs.Organization](docs/Organization.md) - [NotehubJs.OrganizationRole](docs/OrganizationRole.md) - [NotehubJs.PersonalAccessToken](docs/PersonalAccessToken.md) - [NotehubJs.PersonalAccessTokenCreatedBy](docs/PersonalAccessTokenCreatedBy.md) - [NotehubJs.PersonalAccessTokenInfo](docs/PersonalAccessTokenInfo.md) - [NotehubJs.PersonalAccessTokenSecret](docs/PersonalAccessTokenSecret.md) - [NotehubJs.Product](docs/Product.md) - [NotehubJs.Project](docs/Project.md) - [NotehubJs.ProjectMember](docs/ProjectMember.md) - [NotehubJs.ProjectSecret](docs/ProjectSecret.md) - [NotehubJs.ProvisionDeviceRequest](docs/ProvisionDeviceRequest.md) - [NotehubJs.ProxyRoute](docs/ProxyRoute.md) - [NotehubJs.QubitroRoute](docs/QubitroRoute.md) - [NotehubJs.RadRoute](docs/RadRoute.md) - [NotehubJs.Repository](docs/Repository.md) - [NotehubJs.RepositoryListResponse](docs/RepositoryListResponse.md) - [NotehubJs.RepositoryTokenRequest](docs/RepositoryTokenRequest.md) - [NotehubJs.RepositoryTokenResponse](docs/RepositoryTokenResponse.md) - [NotehubJs.Role](docs/Role.md) - [NotehubJs.RouteLog](docs/RouteLog.md) - [NotehubJs.RouteTransformSettings](docs/RouteTransformSettings.md) - [NotehubJs.RunJob200Response](docs/RunJob200Response.md) - [NotehubJs.S3ArchiveRoute](docs/S3ArchiveRoute.md) - [NotehubJs.SatelliteDataUsage](docs/SatelliteDataUsage.md) - [NotehubJs.SatellitePlan](docs/SatellitePlan.md) - [NotehubJs.SchemaProperty](docs/SchemaProperty.md) - [NotehubJs.SignalDevice200Response](docs/SignalDevice200Response.md) - [NotehubJs.SimUsage](docs/SimUsage.md) - [NotehubJs.SlackBearerNotification](docs/SlackBearerNotification.md) - [NotehubJs.SlackRoute](docs/SlackRoute.md) - [NotehubJs.SlackWebHookNotification](docs/SlackWebHookNotification.md) - [NotehubJs.SnowflakeRoute](docs/SnowflakeRoute.md) - [NotehubJs.SnowpipeStreamingRoute](docs/SnowpipeStreamingRoute.md) - [NotehubJs.ThingworxRoute](docs/ThingworxRoute.md) - [NotehubJs.TowerLocation](docs/TowerLocation.md) - [NotehubJs.TwilioRoute](docs/TwilioRoute.md) - [NotehubJs.UpdateFleetRequest](docs/UpdateFleetRequest.md) - [NotehubJs.UpdateHostFirmwareRequest](docs/UpdateHostFirmwareRequest.md) - [NotehubJs.UpdateProjectSecretRequest](docs/UpdateProjectSecretRequest.md) - [NotehubJs.UploadMetadata](docs/UploadMetadata.md) - [NotehubJs.UsageData](docs/UsageData.md) - [NotehubJs.UsageEventsData](docs/UsageEventsData.md) - [NotehubJs.UsageEventsResponse](docs/UsageEventsResponse.md) - [NotehubJs.UsageRouteLogsData](docs/UsageRouteLogsData.md) - [NotehubJs.UsageSessionsData](docs/UsageSessionsData.md) - [NotehubJs.UserDfuStateMachine](docs/UserDfuStateMachine.md) - [NotehubJs.UserDfuStateMachineStatus](docs/UserDfuStateMachineStatus.md) - [NotehubJs.UserFirmwareInfo](docs/UserFirmwareInfo.md) - [NotehubJs.WebhookSettings](docs/WebhookSettings.md) ## Documentation for Authorization ### personalAccessToken - **Type**: Bearer authentication