https://github.com/blues/notehub-go
Go-based library for accessing the Blues Notehub API.
https://github.com/blues/notehub-go
Last synced: 3 months ago
JSON representation
Go-based library for accessing the Blues Notehub API.
- Host: GitHub
- URL: https://github.com/blues/notehub-go
- Owner: blues
- License: mit
- Created: 2025-12-16T16:03:58.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2026-01-14T19:02:44.000Z (5 months ago)
- Last Synced: 2026-01-14T23:26:03.385Z (5 months ago)
- Language: Shell
- Size: 508 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Go API client for notehub
The OpenAPI definition for the Notehub.io API.
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
- API version: 1.2.0
- Package version: 1.0.0
- Generator version: 7.17.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
For more information, please visit [https://dev.blues.io/support/](https://dev.blues.io/support/)
## Installation
Install the following dependencies:
```sh
go get github.com/stretchr/testify/assert
go get golang.org/x/net/context
```
Put the package under your project folder and add the following in import:
```go
import notehub "github.com/blues/notehub-go"
```
To use a proxy, set the environment variable `HTTP_PROXY`:
```go
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
```
## Updating the Auto-Generated notehub-go Package
When the openapi.yaml file is updated in the original Notehub repo which this library supports, the updated file is copied over into a new feature branch in this repo through the magic of GitHub Actions.
When this occurs, it's time to regenerate the notehub-go Go package based on the newly updated openapi.yaml.
To regenerate the notehub-go package:
1. Git clone the repo from GitHub.
```bash
git clone git@github.com:blues/notehub-go.git
```
2. Check out the newly created remote branch from GitHub locally. (It will be named something like feat-XYZ.)
3. At the root of the project, run the following script command from your terminal:
```bash
./scripts.sh generate_and_format
```
This command will run the following subcommands:
- **remove_deprecated_parameters** - This makes a copy of the openapi.yaml file named openapi_filtered.yaml which has removed any query parameters marked as deprecated from the openapi.yaml file. Removing these now deprecated params ensures the generated SDK docs and sample code is clear and up to date, and no longer has potentially confusing artifacts to trip up users.
- **generate_package** - This kicks off the OpenAPI Generator tool to generate a new copy of the library (using the newly updated openapi_filtered.yaml file).
- **format_code** - This runs gofmt and goimports on the Go files, and Prettier on the markdown docs within the docs/ directory to make them look nice.
- **init_go_module** - This initializes the Go module if it doesn't exist.
- **tidy_go_dependencies** - This tidies up the Go module dependencies.
Once all of these steps have successfully run, you'll be ready to merge the change to main and publish a new release.
## Configuration of Server URL
Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.
### Select Server Configuration
For using other server than the one defined on index 0 set context value `notehub.ContextServerIndex` of type `int`.
```go
ctx := context.WithValue(context.Background(), notehub.ContextServerIndex, 1)
```
### Templated Server URL
Templated server URL is formatted using default variables from configuration or from context value `notehub.ContextServerVariables` of type `map[string]string`.
```go
ctx := context.WithValue(context.Background(), notehub.ContextServerVariables, map[string]string{
"basePath": "v2",
})
```
Note, enum values are always validated and all unused variables are silently ignored.
### URLs Configuration per Operation
Each operation can use different server URL defined using `OperationServers` map in the `Configuration`.
An operation is uniquely identified by `"{classname}Service.{nickname}"` string.
Similar rules for overriding default operation server index and variables applies by using `notehub.ContextOperationServerIndices` and `notehub.ContextOperationServerVariables` context maps.
```go
ctx := context.WithValue(context.Background(), notehub.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), notehub.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
```
## Documentation for API Endpoints
All URIs are relative to *https://api.notefile.net*
| Class | Method | HTTP request | Description |
| -------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
| _AlertAPI_ | [**GetAlerts**](docs/AlertAPI.md#getalerts) | **Get** /v1/projects/{projectOrProductUID}/alerts |
| _AuthorizationAPI_ | [**Login**](docs/AuthorizationAPI.md#login) | **Post** /auth/login |
| _AuthorizationAPI_ | [**OAuth2ClientCredentials**](docs/AuthorizationAPI.md#oauth2clientcredentials) | **Post** /oauth2/token | Issue an OAuth 2.0 access token (Client Credentials) |
| _BillingAccountAPI_ | [**GetBillingAccounts**](docs/BillingAccountAPI.md#getbillingaccounts) | **Get** /v1/billing-accounts |
| _DeviceAPI_ | [**AddDbNote**](docs/DeviceAPI.md#adddbnote) | **Post** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} |
| _DeviceAPI_ | [**AddQiNote**](docs/DeviceAPI.md#addqinote) | **Post** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID} |
| _DeviceAPI_ | [**DeleteDbNote**](docs/DeviceAPI.md#deletedbnote) | **Delete** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} |
| _DeviceAPI_ | [**DeleteDevice**](docs/DeviceAPI.md#deletedevice) | **Delete** /v1/projects/{projectOrProductUID}/devices/{deviceUID} |
| _DeviceAPI_ | [**DeleteDeviceEnvironmentVariable**](docs/DeviceAPI.md#deletedeviceenvironmentvariable) | **Delete** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables/{key} |
| _DeviceAPI_ | [**DeleteNotefiles**](docs/DeviceAPI.md#deletenotefiles) | **Delete** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files |
| _DeviceAPI_ | [**DisableDevice**](docs/DeviceAPI.md#disabledevice) | **Post** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/disable |
| _DeviceAPI_ | [**DisableDeviceConnectivityAssurance**](docs/DeviceAPI.md#disabledeviceconnectivityassurance) | **Post** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/disable-connectivity-assurance |
| _DeviceAPI_ | [**EnableDevice**](docs/DeviceAPI.md#enabledevice) | **Post** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/enable |
| _DeviceAPI_ | [**EnableDeviceConnectivityAssurance**](docs/DeviceAPI.md#enabledeviceconnectivityassurance) | **Post** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/enable-connectivity-assurance |
| _DeviceAPI_ | [**GetDbNote**](docs/DeviceAPI.md#getdbnote) | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} |
| _DeviceAPI_ | [**GetDevice**](docs/DeviceAPI.md#getdevice) | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID} |
| _DeviceAPI_ | [**GetDeviceEnvironmentHierarchy**](docs/DeviceAPI.md#getdeviceenvironmenthierarchy) | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_hierarchy | Get environment variable hierarchy for a device |
| _DeviceAPI_ | [**GetDeviceEnvironmentVariables**](docs/DeviceAPI.md#getdeviceenvironmentvariables) | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables |
| _DeviceAPI_ | [**GetDeviceEnvironmentVariablesByPin**](docs/DeviceAPI.md#getdeviceenvironmentvariablesbypin) | **Get** /v1/products/{productUID}/devices/{deviceUID}/environment_variables_with_pin |
| _DeviceAPI_ | [**GetDeviceHealthLog**](docs/DeviceAPI.md#getdevicehealthlog) | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/health-log |
| _DeviceAPI_ | [**GetDeviceLatestEvents**](docs/DeviceAPI.md#getdevicelatestevents) | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/latest |
| _DeviceAPI_ | [**GetDevicePlans**](docs/DeviceAPI.md#getdeviceplans) | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/plans |
| _DeviceAPI_ | [**GetDevicePublicKey**](docs/DeviceAPI.md#getdevicepublickey) | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/public-key |
| _DeviceAPI_ | [**GetDevicePublicKeys**](docs/DeviceAPI.md#getdevicepublickeys) | **Get** /v1/projects/{projectOrProductUID}/devices/public-keys |
| _DeviceAPI_ | [**GetDeviceSessions**](docs/DeviceAPI.md#getdevicesessions) | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/sessions |
| _DeviceAPI_ | [**GetDevices**](docs/DeviceAPI.md#getdevices) | **Get** /v1/projects/{projectOrProductUID}/devices |
| _DeviceAPI_ | [**GetFleetDevices**](docs/DeviceAPI.md#getfleetdevices) | **Get** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/devices |
| _DeviceAPI_ | [**GetNotefile**](docs/DeviceAPI.md#getnotefile) | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/changes |
| _DeviceAPI_ | [**ListNotefiles**](docs/DeviceAPI.md#listnotefiles) | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files/changes |
| _DeviceAPI_ | [**ListPendingNotefiles**](docs/DeviceAPI.md#listpendingnotefiles) | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files/changes/pending |
| _DeviceAPI_ | [**ProvisionDevice**](docs/DeviceAPI.md#provisiondevice) | **Post** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/provision |
| _DeviceAPI_ | [**SetDeviceEnvironmentVariables**](docs/DeviceAPI.md#setdeviceenvironmentvariables) | **Put** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables |
| _DeviceAPI_ | [**SetDeviceEnvironmentVariablesByPin**](docs/DeviceAPI.md#setdeviceenvironmentvariablesbypin) | **Put** /v1/products/{productUID}/devices/{deviceUID}/environment_variables_with_pin |
| _DeviceAPI_ | [**SignalDevice**](docs/DeviceAPI.md#signaldevice) | **Post** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/signal |
| _DeviceAPI_ | [**UpdateDbNote**](docs/DeviceAPI.md#updatedbnote) | **Put** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} |
| _EventAPI_ | [**GetEvents**](docs/EventAPI.md#getevents) | **Get** /v1/projects/{projectOrProductUID}/events |
| _EventAPI_ | [**GetEventsByCursor**](docs/EventAPI.md#geteventsbycursor) | **Get** /v1/projects/{projectOrProductUID}/events-cursor |
| _EventAPI_ | [**GetFleetEvents**](docs/EventAPI.md#getfleetevents) | **Get** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events |
| _EventAPI_ | [**GetFleetEventsByCursor**](docs/EventAPI.md#getfleeteventsbycursor) | **Get** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events-cursor |
| _EventAPI_ | [**GetRouteLogsByEvent**](docs/EventAPI.md#getroutelogsbyevent) | **Get** /v1/projects/{projectOrProductUID}/events/{eventUID}/route-logs |
| _ExternalDevicesAPI_ | [**CreateEventExtDevice**](docs/ExternalDevicesAPI.md#createeventextdevice) | **Post** /v1/products/{productUID}/ext-devices/{deviceUID}/event |
| _ExternalDevicesAPI_ | [**ExtDeviceSessionClose**](docs/ExternalDevicesAPI.md#extdevicesessionclose) | **Post** /v1/products/{productUID}/ext-devices/{deviceUID}/session/close |
| _ExternalDevicesAPI_ | [**ExtDeviceSessionOpen**](docs/ExternalDevicesAPI.md#extdevicesessionopen) | **Post** /v1/products/{productUID}/ext-devices/{deviceUID}/session/open |
| _MonitorAPI_ | [**CreateMonitor**](docs/MonitorAPI.md#createmonitor) | **Post** /v1/projects/{projectOrProductUID}/monitors |
| _MonitorAPI_ | [**DeleteMonitor**](docs/MonitorAPI.md#deletemonitor) | **Delete** /v1/projects/{projectOrProductUID}/monitors/{monitorUID} |
| _MonitorAPI_ | [**GetMonitor**](docs/MonitorAPI.md#getmonitor) | **Get** /v1/projects/{projectOrProductUID}/monitors/{monitorUID} |
| _MonitorAPI_ | [**GetMonitors**](docs/MonitorAPI.md#getmonitors) | **Get** /v1/projects/{projectOrProductUID}/monitors |
| _MonitorAPI_ | [**UpdateMonitor**](docs/MonitorAPI.md#updatemonitor) | **Put** /v1/projects/{projectOrProductUID}/monitors/{monitorUID} |
| _ProjectAPI_ | [**AddDeviceToFleets**](docs/ProjectAPI.md#adddevicetofleets) | **Put** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets |
| _ProjectAPI_ | [**CloneProject**](docs/ProjectAPI.md#cloneproject) | **Post** /v1/projects/{projectOrProductUID}/clone |
| _ProjectAPI_ | [**CreateFleet**](docs/ProjectAPI.md#createfleet) | **Post** /v1/projects/{projectOrProductUID}/fleets |
| _ProjectAPI_ | [**CreateProduct**](docs/ProjectAPI.md#createproduct) | **Post** /v1/projects/{projectOrProductUID}/products |
| _ProjectAPI_ | [**CreateProject**](docs/ProjectAPI.md#createproject) | **Post** /v1/projects |
| _ProjectAPI_ | [**DeleteDeviceFromFleets**](docs/ProjectAPI.md#deletedevicefromfleets) | **Delete** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets |
| _ProjectAPI_ | [**DeleteFleet**](docs/ProjectAPI.md#deletefleet) | **Delete** /v1/projects/{projectOrProductUID}/fleets/{fleetUID} |
| _ProjectAPI_ | [**DeleteFleetEnvironmentVariable**](docs/ProjectAPI.md#deletefleetenvironmentvariable) | **Delete** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables/{key} |
| _ProjectAPI_ | [**DeleteProduct**](docs/ProjectAPI.md#deleteproduct) | **Delete** /v1/projects/{projectOrProductUID}/products/{productUID} |
| _ProjectAPI_ | [**DeleteProject**](docs/ProjectAPI.md#deleteproject) | **Delete** /v1/projects/{projectOrProductUID} |
| _ProjectAPI_ | [**DeleteProjectEnvironmentVariable**](docs/ProjectAPI.md#deleteprojectenvironmentvariable) | **Delete** /v1/projects/{projectOrProductUID}/environment_variables/{key} |
| _ProjectAPI_ | [**DisableGlobalEventTransformation**](docs/ProjectAPI.md#disableglobaleventtransformation) | **Post** /v1/projects/{projectOrProductUID}/global-transformation/disable |
| _ProjectAPI_ | [**EnableGlobalEventTransformation**](docs/ProjectAPI.md#enableglobaleventtransformation) | **Post** /v1/projects/{projectOrProductUID}/global-transformation/enable |
| _ProjectAPI_ | [**GetDeviceDfuHistory**](docs/ProjectAPI.md#getdevicedfuhistory) | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/dfu/{firmwareType}/history |
| _ProjectAPI_ | [**GetDeviceDfuStatus**](docs/ProjectAPI.md#getdevicedfustatus) | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/dfu/{firmwareType}/status |
| _ProjectAPI_ | [**GetDeviceFleets**](docs/ProjectAPI.md#getdevicefleets) | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets |
| _ProjectAPI_ | [**GetDevicesDfuHistory**](docs/ProjectAPI.md#getdevicesdfuhistory) | **Get** /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/history |
| _ProjectAPI_ | [**GetDevicesDfuStatus**](docs/ProjectAPI.md#getdevicesdfustatus) | **Get** /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/status |
| _ProjectAPI_ | [**GetFirmwareInfo**](docs/ProjectAPI.md#getfirmwareinfo) | **Get** /v1/projects/{projectOrProductUID}/firmware |
| _ProjectAPI_ | [**GetFleet**](docs/ProjectAPI.md#getfleet) | **Get** /v1/projects/{projectOrProductUID}/fleets/{fleetUID} |
| _ProjectAPI_ | [**GetFleetEnvironmentHierarchy**](docs/ProjectAPI.md#getfleetenvironmenthierarchy) | **Get** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_hierarchy | Get environment variable hierarchy for a device |
| _ProjectAPI_ | [**GetFleetEnvironmentVariables**](docs/ProjectAPI.md#getfleetenvironmentvariables) | **Get** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables |
| _ProjectAPI_ | [**GetFleets**](docs/ProjectAPI.md#getfleets) | **Get** /v1/projects/{projectOrProductUID}/fleets |
| _ProjectAPI_ | [**GetNotefileSchemas**](docs/ProjectAPI.md#getnotefileschemas) | **Get** /v1/projects/{projectOrProductUID}/schemas | Get variable format for a notefile |
| _ProjectAPI_ | [**GetProducts**](docs/ProjectAPI.md#getproducts) | **Get** /v1/projects/{projectOrProductUID}/products |
| _ProjectAPI_ | [**GetProject**](docs/ProjectAPI.md#getproject) | **Get** /v1/projects/{projectOrProductUID} |
| _ProjectAPI_ | [**GetProjectByProduct**](docs/ProjectAPI.md#getprojectbyproduct) | **Get** /v1/products/{productUID}/project |
| _ProjectAPI_ | [**GetProjectEnvironmentHierarchy**](docs/ProjectAPI.md#getprojectenvironmenthierarchy) | **Get** /v1/projects/{projectOrProductUID}/environment_hierarchy | Get environment variable hierarchy for a device |
| _ProjectAPI_ | [**GetProjectEnvironmentVariables**](docs/ProjectAPI.md#getprojectenvironmentvariables) | **Get** /v1/projects/{projectOrProductUID}/environment_variables |
| _ProjectAPI_ | [**GetProjectMembers**](docs/ProjectAPI.md#getprojectmembers) | **Get** /v1/projects/{projectOrProductUID}/members |
| _ProjectAPI_ | [**GetProjects**](docs/ProjectAPI.md#getprojects) | **Get** /v1/projects |
| _ProjectAPI_ | [**PerformDfuAction**](docs/ProjectAPI.md#performdfuaction) | **Post** /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/{action} |
| _ProjectAPI_ | [**SetFleetEnvironmentVariables**](docs/ProjectAPI.md#setfleetenvironmentvariables) | **Put** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables |
| _ProjectAPI_ | [**SetGlobalEventTransformation**](docs/ProjectAPI.md#setglobaleventtransformation) | **Post** /v1/projects/{projectOrProductUID}/global-transformation |
| _ProjectAPI_ | [**SetProjectEnvironmentVariables**](docs/ProjectAPI.md#setprojectenvironmentvariables) | **Put** /v1/projects/{projectOrProductUID}/environment_variables |
| _ProjectAPI_ | [**UpdateFleet**](docs/ProjectAPI.md#updatefleet) | **Put** /v1/projects/{projectOrProductUID}/fleets/{fleetUID} |
| _ProjectAPI_ | [**UploadFirmware**](docs/ProjectAPI.md#uploadfirmware) | **Put** /v1/projects/{projectOrProductUID}/firmware/{firmwareType}/{filename} |
| _RouteAPI_ | [**CreateRoute**](docs/RouteAPI.md#createroute) | **Post** /v1/projects/{projectOrProductUID}/routes |
| _RouteAPI_ | [**DeleteRoute**](docs/RouteAPI.md#deleteroute) | **Delete** /v1/projects/{projectOrProductUID}/routes/{routeUID} |
| _RouteAPI_ | [**GetRoute**](docs/RouteAPI.md#getroute) | **Get** /v1/projects/{projectOrProductUID}/routes/{routeUID} |
| _RouteAPI_ | [**GetRouteLogsByRoute**](docs/RouteAPI.md#getroutelogsbyroute) | **Get** /v1/projects/{projectOrProductUID}/routes/{routeUID}/route-logs |
| _RouteAPI_ | [**GetRoutes**](docs/RouteAPI.md#getroutes) | **Get** /v1/projects/{projectOrProductUID}/routes |
| _RouteAPI_ | [**UpdateRoute**](docs/RouteAPI.md#updateroute) | **Put** /v1/projects/{projectOrProductUID}/routes/{routeUID} |
| _UsageAPI_ | [**GetDataUsage**](docs/UsageAPI.md#getdatausage) | **Get** /v1/projects/{projectOrProductUID}/usage/data |
| _UsageAPI_ | [**GetEventsUsage**](docs/UsageAPI.md#geteventsusage) | **Get** /v1/projects/{projectOrProductUID}/usage/events |
| _UsageAPI_ | [**GetSessionsUsage**](docs/UsageAPI.md#getsessionsusage) | **Get** /v1/projects/{projectOrProductUID}/usage/sessions |
| _WebhookAPI_ | [**CreateWebhook**](docs/WebhookAPI.md#createwebhook) | **Post** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID} |
| _WebhookAPI_ | [**DeleteWebhook**](docs/WebhookAPI.md#deletewebhook) | **Delete** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID} |
| _WebhookAPI_ | [**GetWebhook**](docs/WebhookAPI.md#getwebhook) | **Get** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID} |
| _WebhookAPI_ | [**GetWebhooks**](docs/WebhookAPI.md#getwebhooks) | **Get** /v1/projects/{projectOrProductUID}/webhooks |
| _WebhookAPI_ | [**UpdateWebhook**](docs/WebhookAPI.md#updatewebhook) | **Put** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID} |
## Documentation For Models
- [AddDeviceToFleetsRequest](docs/AddDeviceToFleetsRequest.md)
- [Alert](docs/Alert.md)
- [AlertDataInner](docs/AlertDataInner.md)
- [AlertNotificationsInner](docs/AlertNotificationsInner.md)
- [AwsRoute](docs/AwsRoute.md)
- [AzureRoute](docs/AzureRoute.md)
- [BillingAccount](docs/BillingAccount.md)
- [BillingAccountRole](docs/BillingAccountRole.md)
- [BlynkRoute](docs/BlynkRoute.md)
- [Body](docs/Body.md)
- [CellularPlan](docs/CellularPlan.md)
- [CloneProjectRequest](docs/CloneProjectRequest.md)
- [Contact](docs/Contact.md)
- [CreateFleetRequest](docs/CreateFleetRequest.md)
- [CreateMonitor](docs/CreateMonitor.md)
- [CreateProductRequest](docs/CreateProductRequest.md)
- [CreateProjectRequest](docs/CreateProjectRequest.md)
- [CreateUpdateRepository](docs/CreateUpdateRepository.md)
- [CurrentFirmware](docs/CurrentFirmware.md)
- [DFUEnv](docs/DFUEnv.md)
- [DFUState](docs/DFUState.md)
- [DataField](docs/DataField.md)
- [DataSetField](docs/DataSetField.md)
- [DataUsage](docs/DataUsage.md)
- [DatacakeRoute](docs/DatacakeRoute.md)
- [DeleteDeviceFromFleetsRequest](docs/DeleteDeviceFromFleetsRequest.md)
- [DeleteNotefilesRequest](docs/DeleteNotefilesRequest.md)
- [Device](docs/Device.md)
- [DeviceDfuHistory](docs/DeviceDfuHistory.md)
- [DeviceDfuHistoryCurrent](docs/DeviceDfuHistoryCurrent.md)
- [DeviceDfuHistoryPage](docs/DeviceDfuHistoryPage.md)
- [DeviceDfuStateMachine](docs/DeviceDfuStateMachine.md)
- [DeviceDfuStateMachineNode](docs/DeviceDfuStateMachineNode.md)
- [DeviceDfuStatus](docs/DeviceDfuStatus.md)
- [DeviceDfuStatusPage](docs/DeviceDfuStatusPage.md)
- [DeviceSession](docs/DeviceSession.md)
- [DeviceTowerInfo](docs/DeviceTowerInfo.md)
- [DeviceUsage](docs/DeviceUsage.md)
- [DfuActionRequest](docs/DfuActionRequest.md)
- [EmailNotification](docs/EmailNotification.md)
- [EnvTreeJsonNode](docs/EnvTreeJsonNode.md)
- [EnvVar](docs/EnvVar.md)
- [EnvironmentVariables](docs/EnvironmentVariables.md)
- [Error](docs/Error.md)
- [Event](docs/Event.md)
- [Filter](docs/Filter.md)
- [Firmware](docs/Firmware.md)
- [FirmwareInfo](docs/FirmwareInfo.md)
- [Fleet](docs/Fleet.md)
- [FleetConnectivityAssurance](docs/FleetConnectivityAssurance.md)
- [GetAlerts200Response](docs/GetAlerts200Response.md)
- [GetBillingAccounts200Response](docs/GetBillingAccounts200Response.md)
- [GetDataUsage200Response](docs/GetDataUsage200Response.md)
- [GetDataUsage200ResponseDataInner](docs/GetDataUsage200ResponseDataInner.md)
- [GetDbNote200Response](docs/GetDbNote200Response.md)
- [GetDeviceEnvironmentVariablesByPin200Response](docs/GetDeviceEnvironmentVariablesByPin200Response.md)
- [GetDeviceFleets200Response](docs/GetDeviceFleets200Response.md)
- [GetDeviceHealthLog200Response](docs/GetDeviceHealthLog200Response.md)
- [GetDeviceHealthLog200ResponseHealthLogInner](docs/GetDeviceHealthLog200ResponseHealthLogInner.md)
- [GetDeviceLatestEvents200Response](docs/GetDeviceLatestEvents200Response.md)
- [GetDevicePlans200Response](docs/GetDevicePlans200Response.md)
- [GetDevicePublicKey200Response](docs/GetDevicePublicKey200Response.md)
- [GetDevicePublicKeys200Response](docs/GetDevicePublicKeys200Response.md)
- [GetDevicePublicKeys200ResponseDevicePublicKeysInner](docs/GetDevicePublicKeys200ResponseDevicePublicKeysInner.md)
- [GetDeviceSessions200Response](docs/GetDeviceSessions200Response.md)
- [GetDevices200Response](docs/GetDevices200Response.md)
- [GetEvents200Response](docs/GetEvents200Response.md)
- [GetEventsByCursor200Response](docs/GetEventsByCursor200Response.md)
- [GetNotefile200Response](docs/GetNotefile200Response.md)
- [GetProducts200Response](docs/GetProducts200Response.md)
- [GetProjectMembers200Response](docs/GetProjectMembers200Response.md)
- [GetProjects200Response](docs/GetProjects200Response.md)
- [GetSessionsUsage200Response](docs/GetSessionsUsage200Response.md)
- [GetWebhooks200Response](docs/GetWebhooks200Response.md)
- [GoogleRoute](docs/GoogleRoute.md)
- [HttpRoute](docs/HttpRoute.md)
- [InlineObject](docs/InlineObject.md)
- [InlineObject1](docs/InlineObject1.md)
- [ListNotefiles200Response](docs/ListNotefiles200Response.md)
- [ListPendingNotefiles200Response](docs/ListPendingNotefiles200Response.md)
- [Location](docs/Location.md)
- [Login200Response](docs/Login200Response.md)
- [LoginRequest](docs/LoginRequest.md)
- [Monitor](docs/Monitor.md)
- [MonitorAlertRoutesInner](docs/MonitorAlertRoutesInner.md)
- [MqttRoute](docs/MqttRoute.md)
- [Note](docs/Note.md)
- [NotefileSchema](docs/NotefileSchema.md)
- [NotehubRoute](docs/NotehubRoute.md)
- [NotehubRouteSummary](docs/NotehubRouteSummary.md)
- [OAuth2Error](docs/OAuth2Error.md)
- [OAuth2TokenResponse](docs/OAuth2TokenResponse.md)
- [PersonalAccessToken](docs/PersonalAccessToken.md)
- [PersonalAccessTokenCreatedBy](docs/PersonalAccessTokenCreatedBy.md)
- [PersonalAccessTokenInfo](docs/PersonalAccessTokenInfo.md)
- [PersonalAccessTokenSecret](docs/PersonalAccessTokenSecret.md)
- [Product](docs/Product.md)
- [Project](docs/Project.md)
- [ProjectMember](docs/ProjectMember.md)
- [ProvisionDeviceRequest](docs/ProvisionDeviceRequest.md)
- [ProxyRoute](docs/ProxyRoute.md)
- [QubitroRoute](docs/QubitroRoute.md)
- [RadRoute](docs/RadRoute.md)
- [Repository](docs/Repository.md)
- [Role](docs/Role.md)
- [RouteLog](docs/RouteLog.md)
- [RouteTransformSettings](docs/RouteTransformSettings.md)
- [S3ArchiveRoute](docs/S3ArchiveRoute.md)
- [SatellitePlan](docs/SatellitePlan.md)
- [SchemaProperty](docs/SchemaProperty.md)
- [SignalDevice200Response](docs/SignalDevice200Response.md)
- [SimUsage](docs/SimUsage.md)
- [SlackBearerNotification](docs/SlackBearerNotification.md)
- [SlackRoute](docs/SlackRoute.md)
- [SlackWebHookNotification](docs/SlackWebHookNotification.md)
- [SnowflakeRoute](docs/SnowflakeRoute.md)
- [SnowpipeStreamingRoute](docs/SnowpipeStreamingRoute.md)
- [ThingworxRoute](docs/ThingworxRoute.md)
- [TowerLocation](docs/TowerLocation.md)
- [TwilioRoute](docs/TwilioRoute.md)
- [UpdateFleetRequest](docs/UpdateFleetRequest.md)
- [UploadMetadata](docs/UploadMetadata.md)
- [UsageData](docs/UsageData.md)
- [UsageEventsData](docs/UsageEventsData.md)
- [UsageEventsResponse](docs/UsageEventsResponse.md)
- [UsageRouteLogsData](docs/UsageRouteLogsData.md)
- [UsageSessionsData](docs/UsageSessionsData.md)
- [UserDfuStateMachine](docs/UserDfuStateMachine.md)
- [UserDfuStateMachineStatus](docs/UserDfuStateMachineStatus.md)
- [UserFirmwareInfo](docs/UserFirmwareInfo.md)
- [WebhookSettings](docs/WebhookSettings.md)
## Documentation For Authorization
Authentication schemes defined for the API:
### personalAccessToken
- **Type**: HTTP Bearer token authentication
Example
```go
auth := context.WithValue(context.Background(), notehub.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)
```
### pin
- **Type**: API key
- **API key parameter name**: X-Auth-Token
- **Location**: HTTP header
Note, each API key must be added to a map of `map[string]APIKey` where the key is: pin and passed in as the auth context for each request.
Example
```go
auth := context.WithValue(
context.Background(),
notehub.ContextAPIKeys,
map[string]notehub.APIKey{
"pin": {Key: "API_KEY_STRING"},
},
)
r, err := client.Service.Operation(auth, args)
```
## Documentation for Utility Methods
Due to the fact that model structure members are all pointers, this package contains
a number of utility functions to easily obtain pointers to values of basic types.
Each of these functions takes a value of the given basic type and returns a pointer to it:
- `PtrBool`
- `PtrInt`
- `PtrInt32`
- `PtrInt64`
- `PtrFloat`
- `PtrFloat32`
- `PtrFloat64`
- `PtrString`
- `PtrTime`
## Author
engineering@blues.io