{"id":38765096,"url":"https://github.com/blues/notehub-go","last_synced_at":"2026-03-14T11:10:44.399Z","repository":{"id":332637918,"uuid":"1117650143","full_name":"blues/notehub-go","owner":"blues","description":"Go-based library for accessing the Blues Notehub API.","archived":false,"fork":false,"pushed_at":"2026-01-14T19:02:44.000Z","size":520,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-14T23:26:03.385Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/blues.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-16T16:03:58.000Z","updated_at":"2026-01-07T10:52:57.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/blues/notehub-go","commit_stats":null,"previous_names":["blues/notehub-go"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/blues/notehub-go","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blues%2Fnotehub-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blues%2Fnotehub-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blues%2Fnotehub-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blues%2Fnotehub-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blues","download_url":"https://codeload.github.com/blues/notehub-go/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blues%2Fnotehub-go/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28508464,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T11:50:55.898Z","status":"ssl_error","status_checked_at":"2026-01-17T11:50:55.569Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-17T12:00:23.995Z","updated_at":"2026-01-17T12:00:46.545Z","avatar_url":"https://github.com/blues.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Go API client for notehub\n\nThe OpenAPI definition for the Notehub.io API.\n\n## Overview\n\nThis 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.\n\n- API version: 1.2.0\n- Package version: 1.0.0\n- Generator version: 7.17.0\n- Build package: org.openapitools.codegen.languages.GoClientCodegen\n  For more information, please visit [https://dev.blues.io/support/](https://dev.blues.io/support/)\n\n## Installation\n\nInstall the following dependencies:\n\n```sh\ngo get github.com/stretchr/testify/assert\ngo get golang.org/x/net/context\n```\n\nPut the package under your project folder and add the following in import:\n\n```go\nimport notehub \"github.com/blues/notehub-go\"\n```\n\nTo use a proxy, set the environment variable `HTTP_PROXY`:\n\n```go\nos.Setenv(\"HTTP_PROXY\", \"http://proxy_name:proxy_port\")\n```\n\n## Updating the Auto-Generated notehub-go Package\n\nWhen 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.\n\nWhen this occurs, it's time to regenerate the notehub-go Go package based on the newly updated openapi.yaml.\n\nTo regenerate the notehub-go package:\n\n1. Git clone the repo from GitHub.\n\n   ```bash\n   git clone git@github.com:blues/notehub-go.git\n   ```\n\n2. Check out the newly created remote branch from GitHub locally. (It will be named something like feat-XYZ.)\n\n3. At the root of the project, run the following script command from your terminal:\n\n   ```bash\n   ./scripts.sh generate_and_format\n   ```\n\nThis command will run the following subcommands:\n\n- **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.\n- **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).\n- **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.\n- **init_go_module** - This initializes the Go module if it doesn't exist.\n- **tidy_go_dependencies** - This tidies up the Go module dependencies.\n\nOnce all of these steps have successfully run, you'll be ready to merge the change to main and publish a new release.\n\n## Configuration of Server URL\n\nDefault configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.\n\n### Select Server Configuration\n\nFor using other server than the one defined on index 0 set context value `notehub.ContextServerIndex` of type `int`.\n\n```go\nctx := context.WithValue(context.Background(), notehub.ContextServerIndex, 1)\n```\n\n### Templated Server URL\n\nTemplated server URL is formatted using default variables from configuration or from context value `notehub.ContextServerVariables` of type `map[string]string`.\n\n```go\nctx := context.WithValue(context.Background(), notehub.ContextServerVariables, map[string]string{\n\t\"basePath\": \"v2\",\n})\n```\n\nNote, enum values are always validated and all unused variables are silently ignored.\n\n### URLs Configuration per Operation\n\nEach operation can use different server URL defined using `OperationServers` map in the `Configuration`.\nAn operation is uniquely identified by `\"{classname}Service.{nickname}\"` string.\nSimilar rules for overriding default operation server index and variables applies by using `notehub.ContextOperationServerIndices` and `notehub.ContextOperationServerVariables` context maps.\n\n```go\nctx := context.WithValue(context.Background(), notehub.ContextOperationServerIndices, map[string]int{\n\t\"{classname}Service.{nickname}\": 2,\n})\nctx = context.WithValue(context.Background(), notehub.ContextOperationServerVariables, map[string]map[string]string{\n\t\"{classname}Service.{nickname}\": {\n\t\t\"port\": \"8443\",\n\t},\n})\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.notefile.net*\n\n| Class                | Method                                                                                         | HTTP request                                                                                   | Description                                          |\n| -------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------- |\n| _AlertAPI_           | [**GetAlerts**](docs/AlertAPI.md#getalerts)                                                    | **Get** /v1/projects/{projectOrProductUID}/alerts                                              |\n| _AuthorizationAPI_   | [**Login**](docs/AuthorizationAPI.md#login)                                                    | **Post** /auth/login                                                                           |\n| _AuthorizationAPI_   | [**OAuth2ClientCredentials**](docs/AuthorizationAPI.md#oauth2clientcredentials)                | **Post** /oauth2/token                                                                         | Issue an OAuth 2.0 access token (Client Credentials) |\n| _BillingAccountAPI_  | [**GetBillingAccounts**](docs/BillingAccountAPI.md#getbillingaccounts)                         | **Get** /v1/billing-accounts                                                                   |\n| _DeviceAPI_          | [**AddDbNote**](docs/DeviceAPI.md#adddbnote)                                                   | **Post** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID}    |\n| _DeviceAPI_          | [**AddQiNote**](docs/DeviceAPI.md#addqinote)                                                   | **Post** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}             |\n| _DeviceAPI_          | [**DeleteDbNote**](docs/DeviceAPI.md#deletedbnote)                                             | **Delete** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID}  |\n| _DeviceAPI_          | [**DeleteDevice**](docs/DeviceAPI.md#deletedevice)                                             | **Delete** /v1/projects/{projectOrProductUID}/devices/{deviceUID}                              |\n| _DeviceAPI_          | [**DeleteDeviceEnvironmentVariable**](docs/DeviceAPI.md#deletedeviceenvironmentvariable)       | **Delete** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables/{key}  |\n| _DeviceAPI_          | [**DeleteNotefiles**](docs/DeviceAPI.md#deletenotefiles)                                       | **Delete** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files                        |\n| _DeviceAPI_          | [**DisableDevice**](docs/DeviceAPI.md#disabledevice)                                           | **Post** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/disable                        |\n| _DeviceAPI_          | [**DisableDeviceConnectivityAssurance**](docs/DeviceAPI.md#disabledeviceconnectivityassurance) | **Post** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/disable-connectivity-assurance |\n| _DeviceAPI_          | [**EnableDevice**](docs/DeviceAPI.md#enabledevice)                                             | **Post** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/enable                         |\n| _DeviceAPI_          | [**EnableDeviceConnectivityAssurance**](docs/DeviceAPI.md#enabledeviceconnectivityassurance)   | **Post** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/enable-connectivity-assurance  |\n| _DeviceAPI_          | [**GetDbNote**](docs/DeviceAPI.md#getdbnote)                                                   | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID}     |\n| _DeviceAPI_          | [**GetDevice**](docs/DeviceAPI.md#getdevice)                                                   | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}                                 |\n| _DeviceAPI_          | [**GetDeviceEnvironmentHierarchy**](docs/DeviceAPI.md#getdeviceenvironmenthierarchy)           | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_hierarchy           | Get environment variable hierarchy for a device      |\n| _DeviceAPI_          | [**GetDeviceEnvironmentVariables**](docs/DeviceAPI.md#getdeviceenvironmentvariables)           | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables           |\n| _DeviceAPI_          | [**GetDeviceEnvironmentVariablesByPin**](docs/DeviceAPI.md#getdeviceenvironmentvariablesbypin) | **Get** /v1/products/{productUID}/devices/{deviceUID}/environment_variables_with_pin           |\n| _DeviceAPI_          | [**GetDeviceHealthLog**](docs/DeviceAPI.md#getdevicehealthlog)                                 | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/health-log                      |\n| _DeviceAPI_          | [**GetDeviceLatestEvents**](docs/DeviceAPI.md#getdevicelatestevents)                           | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/latest                          |\n| _DeviceAPI_          | [**GetDevicePlans**](docs/DeviceAPI.md#getdeviceplans)                                         | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/plans                           |\n| _DeviceAPI_          | [**GetDevicePublicKey**](docs/DeviceAPI.md#getdevicepublickey)                                 | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/public-key                      |\n| _DeviceAPI_          | [**GetDevicePublicKeys**](docs/DeviceAPI.md#getdevicepublickeys)                               | **Get** /v1/projects/{projectOrProductUID}/devices/public-keys                                 |\n| _DeviceAPI_          | [**GetDeviceSessions**](docs/DeviceAPI.md#getdevicesessions)                                   | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/sessions                        |\n| _DeviceAPI_          | [**GetDevices**](docs/DeviceAPI.md#getdevices)                                                 | **Get** /v1/projects/{projectOrProductUID}/devices                                             |\n| _DeviceAPI_          | [**GetFleetDevices**](docs/DeviceAPI.md#getfleetdevices)                                       | **Get** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/devices                           |\n| _DeviceAPI_          | [**GetNotefile**](docs/DeviceAPI.md#getnotefile)                                               | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/changes      |\n| _DeviceAPI_          | [**ListNotefiles**](docs/DeviceAPI.md#listnotefiles)                                           | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files/changes                   |\n| _DeviceAPI_          | [**ListPendingNotefiles**](docs/DeviceAPI.md#listpendingnotefiles)                             | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files/changes/pending           |\n| _DeviceAPI_          | [**ProvisionDevice**](docs/DeviceAPI.md#provisiondevice)                                       | **Post** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/provision                      |\n| _DeviceAPI_          | [**SetDeviceEnvironmentVariables**](docs/DeviceAPI.md#setdeviceenvironmentvariables)           | **Put** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables           |\n| _DeviceAPI_          | [**SetDeviceEnvironmentVariablesByPin**](docs/DeviceAPI.md#setdeviceenvironmentvariablesbypin) | **Put** /v1/products/{productUID}/devices/{deviceUID}/environment_variables_with_pin           |\n| _DeviceAPI_          | [**SignalDevice**](docs/DeviceAPI.md#signaldevice)                                             | **Post** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/signal                         |\n| _DeviceAPI_          | [**UpdateDbNote**](docs/DeviceAPI.md#updatedbnote)                                             | **Put** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID}     |\n| _EventAPI_           | [**GetEvents**](docs/EventAPI.md#getevents)                                                    | **Get** /v1/projects/{projectOrProductUID}/events                                              |\n| _EventAPI_           | [**GetEventsByCursor**](docs/EventAPI.md#geteventsbycursor)                                    | **Get** /v1/projects/{projectOrProductUID}/events-cursor                                       |\n| _EventAPI_           | [**GetFleetEvents**](docs/EventAPI.md#getfleetevents)                                          | **Get** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events                            |\n| _EventAPI_           | [**GetFleetEventsByCursor**](docs/EventAPI.md#getfleeteventsbycursor)                          | **Get** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events-cursor                     |\n| _EventAPI_           | [**GetRouteLogsByEvent**](docs/EventAPI.md#getroutelogsbyevent)                                | **Get** /v1/projects/{projectOrProductUID}/events/{eventUID}/route-logs                        |\n| _ExternalDevicesAPI_ | [**CreateEventExtDevice**](docs/ExternalDevicesAPI.md#createeventextdevice)                    | **Post** /v1/products/{productUID}/ext-devices/{deviceUID}/event                               |\n| _ExternalDevicesAPI_ | [**ExtDeviceSessionClose**](docs/ExternalDevicesAPI.md#extdevicesessionclose)                  | **Post** /v1/products/{productUID}/ext-devices/{deviceUID}/session/close                       |\n| _ExternalDevicesAPI_ | [**ExtDeviceSessionOpen**](docs/ExternalDevicesAPI.md#extdevicesessionopen)                    | **Post** /v1/products/{productUID}/ext-devices/{deviceUID}/session/open                        |\n| _MonitorAPI_         | [**CreateMonitor**](docs/MonitorAPI.md#createmonitor)                                          | **Post** /v1/projects/{projectOrProductUID}/monitors                                           |\n| _MonitorAPI_         | [**DeleteMonitor**](docs/MonitorAPI.md#deletemonitor)                                          | **Delete** /v1/projects/{projectOrProductUID}/monitors/{monitorUID}                            |\n| _MonitorAPI_         | [**GetMonitor**](docs/MonitorAPI.md#getmonitor)                                                | **Get** /v1/projects/{projectOrProductUID}/monitors/{monitorUID}                               |\n| _MonitorAPI_         | [**GetMonitors**](docs/MonitorAPI.md#getmonitors)                                              | **Get** /v1/projects/{projectOrProductUID}/monitors                                            |\n| _MonitorAPI_         | [**UpdateMonitor**](docs/MonitorAPI.md#updatemonitor)                                          | **Put** /v1/projects/{projectOrProductUID}/monitors/{monitorUID}                               |\n| _ProjectAPI_         | [**AddDeviceToFleets**](docs/ProjectAPI.md#adddevicetofleets)                                  | **Put** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets                          |\n| _ProjectAPI_         | [**CloneProject**](docs/ProjectAPI.md#cloneproject)                                            | **Post** /v1/projects/{projectOrProductUID}/clone                                              |\n| _ProjectAPI_         | [**CreateFleet**](docs/ProjectAPI.md#createfleet)                                              | **Post** /v1/projects/{projectOrProductUID}/fleets                                             |\n| _ProjectAPI_         | [**CreateProduct**](docs/ProjectAPI.md#createproduct)                                          | **Post** /v1/projects/{projectOrProductUID}/products                                           |\n| _ProjectAPI_         | [**CreateProject**](docs/ProjectAPI.md#createproject)                                          | **Post** /v1/projects                                                                          |\n| _ProjectAPI_         | [**DeleteDeviceFromFleets**](docs/ProjectAPI.md#deletedevicefromfleets)                        | **Delete** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets                       |\n| _ProjectAPI_         | [**DeleteFleet**](docs/ProjectAPI.md#deletefleet)                                              | **Delete** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}                                |\n| _ProjectAPI_         | [**DeleteFleetEnvironmentVariable**](docs/ProjectAPI.md#deletefleetenvironmentvariable)        | **Delete** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables/{key}    |\n| _ProjectAPI_         | [**DeleteProduct**](docs/ProjectAPI.md#deleteproduct)                                          | **Delete** /v1/projects/{projectOrProductUID}/products/{productUID}                            |\n| _ProjectAPI_         | [**DeleteProject**](docs/ProjectAPI.md#deleteproject)                                          | **Delete** /v1/projects/{projectOrProductUID}                                                  |\n| _ProjectAPI_         | [**DeleteProjectEnvironmentVariable**](docs/ProjectAPI.md#deleteprojectenvironmentvariable)    | **Delete** /v1/projects/{projectOrProductUID}/environment_variables/{key}                      |\n| _ProjectAPI_         | [**DisableGlobalEventTransformation**](docs/ProjectAPI.md#disableglobaleventtransformation)    | **Post** /v1/projects/{projectOrProductUID}/global-transformation/disable                      |\n| _ProjectAPI_         | [**EnableGlobalEventTransformation**](docs/ProjectAPI.md#enableglobaleventtransformation)      | **Post** /v1/projects/{projectOrProductUID}/global-transformation/enable                       |\n| _ProjectAPI_         | [**GetDeviceDfuHistory**](docs/ProjectAPI.md#getdevicedfuhistory)                              | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/dfu/{firmwareType}/history      |\n| _ProjectAPI_         | [**GetDeviceDfuStatus**](docs/ProjectAPI.md#getdevicedfustatus)                                | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/dfu/{firmwareType}/status       |\n| _ProjectAPI_         | [**GetDeviceFleets**](docs/ProjectAPI.md#getdevicefleets)                                      | **Get** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets                          |\n| _ProjectAPI_         | [**GetDevicesDfuHistory**](docs/ProjectAPI.md#getdevicesdfuhistory)                            | **Get** /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/history                          |\n| _ProjectAPI_         | [**GetDevicesDfuStatus**](docs/ProjectAPI.md#getdevicesdfustatus)                              | **Get** /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/status                           |\n| _ProjectAPI_         | [**GetFirmwareInfo**](docs/ProjectAPI.md#getfirmwareinfo)                                      | **Get** /v1/projects/{projectOrProductUID}/firmware                                            |\n| _ProjectAPI_         | [**GetFleet**](docs/ProjectAPI.md#getfleet)                                                    | **Get** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}                                   |\n| _ProjectAPI_         | [**GetFleetEnvironmentHierarchy**](docs/ProjectAPI.md#getfleetenvironmenthierarchy)            | **Get** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_hierarchy             | Get environment variable hierarchy for a device      |\n| _ProjectAPI_         | [**GetFleetEnvironmentVariables**](docs/ProjectAPI.md#getfleetenvironmentvariables)            | **Get** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables             |\n| _ProjectAPI_         | [**GetFleets**](docs/ProjectAPI.md#getfleets)                                                  | **Get** /v1/projects/{projectOrProductUID}/fleets                                              |\n| _ProjectAPI_         | [**GetNotefileSchemas**](docs/ProjectAPI.md#getnotefileschemas)                                | **Get** /v1/projects/{projectOrProductUID}/schemas                                             | Get variable format for a notefile                   |\n| _ProjectAPI_         | [**GetProducts**](docs/ProjectAPI.md#getproducts)                                              | **Get** /v1/projects/{projectOrProductUID}/products                                            |\n| _ProjectAPI_         | [**GetProject**](docs/ProjectAPI.md#getproject)                                                | **Get** /v1/projects/{projectOrProductUID}                                                     |\n| _ProjectAPI_         | [**GetProjectByProduct**](docs/ProjectAPI.md#getprojectbyproduct)                              | **Get** /v1/products/{productUID}/project                                                      |\n| _ProjectAPI_         | [**GetProjectEnvironmentHierarchy**](docs/ProjectAPI.md#getprojectenvironmenthierarchy)        | **Get** /v1/projects/{projectOrProductUID}/environment_hierarchy                               | Get environment variable hierarchy for a device      |\n| _ProjectAPI_         | [**GetProjectEnvironmentVariables**](docs/ProjectAPI.md#getprojectenvironmentvariables)        | **Get** /v1/projects/{projectOrProductUID}/environment_variables                               |\n| _ProjectAPI_         | [**GetProjectMembers**](docs/ProjectAPI.md#getprojectmembers)                                  | **Get** /v1/projects/{projectOrProductUID}/members                                             |\n| _ProjectAPI_         | [**GetProjects**](docs/ProjectAPI.md#getprojects)                                              | **Get** /v1/projects                                                                           |\n| _ProjectAPI_         | [**PerformDfuAction**](docs/ProjectAPI.md#performdfuaction)                                    | **Post** /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/{action}                        |\n| _ProjectAPI_         | [**SetFleetEnvironmentVariables**](docs/ProjectAPI.md#setfleetenvironmentvariables)            | **Put** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables             |\n| _ProjectAPI_         | [**SetGlobalEventTransformation**](docs/ProjectAPI.md#setglobaleventtransformation)            | **Post** /v1/projects/{projectOrProductUID}/global-transformation                              |\n| _ProjectAPI_         | [**SetProjectEnvironmentVariables**](docs/ProjectAPI.md#setprojectenvironmentvariables)        | **Put** /v1/projects/{projectOrProductUID}/environment_variables                               |\n| _ProjectAPI_         | [**UpdateFleet**](docs/ProjectAPI.md#updatefleet)                                              | **Put** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}                                   |\n| _ProjectAPI_         | [**UploadFirmware**](docs/ProjectAPI.md#uploadfirmware)                                        | **Put** /v1/projects/{projectOrProductUID}/firmware/{firmwareType}/{filename}                  |\n| _RouteAPI_           | [**CreateRoute**](docs/RouteAPI.md#createroute)                                                | **Post** /v1/projects/{projectOrProductUID}/routes                                             |\n| _RouteAPI_           | [**DeleteRoute**](docs/RouteAPI.md#deleteroute)                                                | **Delete** /v1/projects/{projectOrProductUID}/routes/{routeUID}                                |\n| _RouteAPI_           | [**GetRoute**](docs/RouteAPI.md#getroute)                                                      | **Get** /v1/projects/{projectOrProductUID}/routes/{routeUID}                                   |\n| _RouteAPI_           | [**GetRouteLogsByRoute**](docs/RouteAPI.md#getroutelogsbyroute)                                | **Get** /v1/projects/{projectOrProductUID}/routes/{routeUID}/route-logs                        |\n| _RouteAPI_           | [**GetRoutes**](docs/RouteAPI.md#getroutes)                                                    | **Get** /v1/projects/{projectOrProductUID}/routes                                              |\n| _RouteAPI_           | [**UpdateRoute**](docs/RouteAPI.md#updateroute)                                                | **Put** /v1/projects/{projectOrProductUID}/routes/{routeUID}                                   |\n| _UsageAPI_           | [**GetDataUsage**](docs/UsageAPI.md#getdatausage)                                              | **Get** /v1/projects/{projectOrProductUID}/usage/data                                          |\n| _UsageAPI_           | [**GetEventsUsage**](docs/UsageAPI.md#geteventsusage)                                          | **Get** /v1/projects/{projectOrProductUID}/usage/events                                        |\n| _UsageAPI_           | [**GetSessionsUsage**](docs/UsageAPI.md#getsessionsusage)                                      | **Get** /v1/projects/{projectOrProductUID}/usage/sessions                                      |\n| _WebhookAPI_         | [**CreateWebhook**](docs/WebhookAPI.md#createwebhook)                                          | **Post** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID}                              |\n| _WebhookAPI_         | [**DeleteWebhook**](docs/WebhookAPI.md#deletewebhook)                                          | **Delete** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID}                            |\n| _WebhookAPI_         | [**GetWebhook**](docs/WebhookAPI.md#getwebhook)                                                | **Get** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID}                               |\n| _WebhookAPI_         | [**GetWebhooks**](docs/WebhookAPI.md#getwebhooks)                                              | **Get** /v1/projects/{projectOrProductUID}/webhooks                                            |\n| _WebhookAPI_         | [**UpdateWebhook**](docs/WebhookAPI.md#updatewebhook)                                          | **Put** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID}                               |\n\n## Documentation For Models\n\n- [AddDeviceToFleetsRequest](docs/AddDeviceToFleetsRequest.md)\n- [Alert](docs/Alert.md)\n- [AlertDataInner](docs/AlertDataInner.md)\n- [AlertNotificationsInner](docs/AlertNotificationsInner.md)\n- [AwsRoute](docs/AwsRoute.md)\n- [AzureRoute](docs/AzureRoute.md)\n- [BillingAccount](docs/BillingAccount.md)\n- [BillingAccountRole](docs/BillingAccountRole.md)\n- [BlynkRoute](docs/BlynkRoute.md)\n- [Body](docs/Body.md)\n- [CellularPlan](docs/CellularPlan.md)\n- [CloneProjectRequest](docs/CloneProjectRequest.md)\n- [Contact](docs/Contact.md)\n- [CreateFleetRequest](docs/CreateFleetRequest.md)\n- [CreateMonitor](docs/CreateMonitor.md)\n- [CreateProductRequest](docs/CreateProductRequest.md)\n- [CreateProjectRequest](docs/CreateProjectRequest.md)\n- [CreateUpdateRepository](docs/CreateUpdateRepository.md)\n- [CurrentFirmware](docs/CurrentFirmware.md)\n- [DFUEnv](docs/DFUEnv.md)\n- [DFUState](docs/DFUState.md)\n- [DataField](docs/DataField.md)\n- [DataSetField](docs/DataSetField.md)\n- [DataUsage](docs/DataUsage.md)\n- [DatacakeRoute](docs/DatacakeRoute.md)\n- [DeleteDeviceFromFleetsRequest](docs/DeleteDeviceFromFleetsRequest.md)\n- [DeleteNotefilesRequest](docs/DeleteNotefilesRequest.md)\n- [Device](docs/Device.md)\n- [DeviceDfuHistory](docs/DeviceDfuHistory.md)\n- [DeviceDfuHistoryCurrent](docs/DeviceDfuHistoryCurrent.md)\n- [DeviceDfuHistoryPage](docs/DeviceDfuHistoryPage.md)\n- [DeviceDfuStateMachine](docs/DeviceDfuStateMachine.md)\n- [DeviceDfuStateMachineNode](docs/DeviceDfuStateMachineNode.md)\n- [DeviceDfuStatus](docs/DeviceDfuStatus.md)\n- [DeviceDfuStatusPage](docs/DeviceDfuStatusPage.md)\n- [DeviceSession](docs/DeviceSession.md)\n- [DeviceTowerInfo](docs/DeviceTowerInfo.md)\n- [DeviceUsage](docs/DeviceUsage.md)\n- [DfuActionRequest](docs/DfuActionRequest.md)\n- [EmailNotification](docs/EmailNotification.md)\n- [EnvTreeJsonNode](docs/EnvTreeJsonNode.md)\n- [EnvVar](docs/EnvVar.md)\n- [EnvironmentVariables](docs/EnvironmentVariables.md)\n- [Error](docs/Error.md)\n- [Event](docs/Event.md)\n- [Filter](docs/Filter.md)\n- [Firmware](docs/Firmware.md)\n- [FirmwareInfo](docs/FirmwareInfo.md)\n- [Fleet](docs/Fleet.md)\n- [FleetConnectivityAssurance](docs/FleetConnectivityAssurance.md)\n- [GetAlerts200Response](docs/GetAlerts200Response.md)\n- [GetBillingAccounts200Response](docs/GetBillingAccounts200Response.md)\n- [GetDataUsage200Response](docs/GetDataUsage200Response.md)\n- [GetDataUsage200ResponseDataInner](docs/GetDataUsage200ResponseDataInner.md)\n- [GetDbNote200Response](docs/GetDbNote200Response.md)\n- [GetDeviceEnvironmentVariablesByPin200Response](docs/GetDeviceEnvironmentVariablesByPin200Response.md)\n- [GetDeviceFleets200Response](docs/GetDeviceFleets200Response.md)\n- [GetDeviceHealthLog200Response](docs/GetDeviceHealthLog200Response.md)\n- [GetDeviceHealthLog200ResponseHealthLogInner](docs/GetDeviceHealthLog200ResponseHealthLogInner.md)\n- [GetDeviceLatestEvents200Response](docs/GetDeviceLatestEvents200Response.md)\n- [GetDevicePlans200Response](docs/GetDevicePlans200Response.md)\n- [GetDevicePublicKey200Response](docs/GetDevicePublicKey200Response.md)\n- [GetDevicePublicKeys200Response](docs/GetDevicePublicKeys200Response.md)\n- [GetDevicePublicKeys200ResponseDevicePublicKeysInner](docs/GetDevicePublicKeys200ResponseDevicePublicKeysInner.md)\n- [GetDeviceSessions200Response](docs/GetDeviceSessions200Response.md)\n- [GetDevices200Response](docs/GetDevices200Response.md)\n- [GetEvents200Response](docs/GetEvents200Response.md)\n- [GetEventsByCursor200Response](docs/GetEventsByCursor200Response.md)\n- [GetNotefile200Response](docs/GetNotefile200Response.md)\n- [GetProducts200Response](docs/GetProducts200Response.md)\n- [GetProjectMembers200Response](docs/GetProjectMembers200Response.md)\n- [GetProjects200Response](docs/GetProjects200Response.md)\n- [GetSessionsUsage200Response](docs/GetSessionsUsage200Response.md)\n- [GetWebhooks200Response](docs/GetWebhooks200Response.md)\n- [GoogleRoute](docs/GoogleRoute.md)\n- [HttpRoute](docs/HttpRoute.md)\n- [InlineObject](docs/InlineObject.md)\n- [InlineObject1](docs/InlineObject1.md)\n- [ListNotefiles200Response](docs/ListNotefiles200Response.md)\n- [ListPendingNotefiles200Response](docs/ListPendingNotefiles200Response.md)\n- [Location](docs/Location.md)\n- [Login200Response](docs/Login200Response.md)\n- [LoginRequest](docs/LoginRequest.md)\n- [Monitor](docs/Monitor.md)\n- [MonitorAlertRoutesInner](docs/MonitorAlertRoutesInner.md)\n- [MqttRoute](docs/MqttRoute.md)\n- [Note](docs/Note.md)\n- [NotefileSchema](docs/NotefileSchema.md)\n- [NotehubRoute](docs/NotehubRoute.md)\n- [NotehubRouteSummary](docs/NotehubRouteSummary.md)\n- [OAuth2Error](docs/OAuth2Error.md)\n- [OAuth2TokenResponse](docs/OAuth2TokenResponse.md)\n- [PersonalAccessToken](docs/PersonalAccessToken.md)\n- [PersonalAccessTokenCreatedBy](docs/PersonalAccessTokenCreatedBy.md)\n- [PersonalAccessTokenInfo](docs/PersonalAccessTokenInfo.md)\n- [PersonalAccessTokenSecret](docs/PersonalAccessTokenSecret.md)\n- [Product](docs/Product.md)\n- [Project](docs/Project.md)\n- [ProjectMember](docs/ProjectMember.md)\n- [ProvisionDeviceRequest](docs/ProvisionDeviceRequest.md)\n- [ProxyRoute](docs/ProxyRoute.md)\n- [QubitroRoute](docs/QubitroRoute.md)\n- [RadRoute](docs/RadRoute.md)\n- [Repository](docs/Repository.md)\n- [Role](docs/Role.md)\n- [RouteLog](docs/RouteLog.md)\n- [RouteTransformSettings](docs/RouteTransformSettings.md)\n- [S3ArchiveRoute](docs/S3ArchiveRoute.md)\n- [SatellitePlan](docs/SatellitePlan.md)\n- [SchemaProperty](docs/SchemaProperty.md)\n- [SignalDevice200Response](docs/SignalDevice200Response.md)\n- [SimUsage](docs/SimUsage.md)\n- [SlackBearerNotification](docs/SlackBearerNotification.md)\n- [SlackRoute](docs/SlackRoute.md)\n- [SlackWebHookNotification](docs/SlackWebHookNotification.md)\n- [SnowflakeRoute](docs/SnowflakeRoute.md)\n- [SnowpipeStreamingRoute](docs/SnowpipeStreamingRoute.md)\n- [ThingworxRoute](docs/ThingworxRoute.md)\n- [TowerLocation](docs/TowerLocation.md)\n- [TwilioRoute](docs/TwilioRoute.md)\n- [UpdateFleetRequest](docs/UpdateFleetRequest.md)\n- [UploadMetadata](docs/UploadMetadata.md)\n- [UsageData](docs/UsageData.md)\n- [UsageEventsData](docs/UsageEventsData.md)\n- [UsageEventsResponse](docs/UsageEventsResponse.md)\n- [UsageRouteLogsData](docs/UsageRouteLogsData.md)\n- [UsageSessionsData](docs/UsageSessionsData.md)\n- [UserDfuStateMachine](docs/UserDfuStateMachine.md)\n- [UserDfuStateMachineStatus](docs/UserDfuStateMachineStatus.md)\n- [UserFirmwareInfo](docs/UserFirmwareInfo.md)\n- [WebhookSettings](docs/WebhookSettings.md)\n\n## Documentation For Authorization\n\nAuthentication schemes defined for the API:\n\n### personalAccessToken\n\n- **Type**: HTTP Bearer token authentication\n\nExample\n\n```go\nauth := context.WithValue(context.Background(), notehub.ContextAccessToken, \"BEARER_TOKEN_STRING\")\nr, err := client.Service.Operation(auth, args)\n```\n\n### pin\n\n- **Type**: API key\n- **API key parameter name**: X-Auth-Token\n- **Location**: HTTP header\n\nNote, 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.\n\nExample\n\n```go\nauth := context.WithValue(\n\t\tcontext.Background(),\n\t\tnotehub.ContextAPIKeys,\n\t\tmap[string]notehub.APIKey{\n\t\t\t\"pin\": {Key: \"API_KEY_STRING\"},\n\t\t},\n\t)\nr, err := client.Service.Operation(auth, args)\n```\n\n## Documentation for Utility Methods\n\nDue to the fact that model structure members are all pointers, this package contains\na number of utility functions to easily obtain pointers to values of basic types.\nEach of these functions takes a value of the given basic type and returns a pointer to it:\n\n- `PtrBool`\n- `PtrInt`\n- `PtrInt32`\n- `PtrInt64`\n- `PtrFloat`\n- `PtrFloat32`\n- `PtrFloat64`\n- `PtrString`\n- `PtrTime`\n\n## Author\n\nengineering@blues.io\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblues%2Fnotehub-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblues%2Fnotehub-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblues%2Fnotehub-go/lists"}