# notehub-py
The OpenAPI definition for the Notehub.io API.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.2.0
- Package version: 2.3.0
- Generator version: 7.5.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://dev.blues.io/support/](https://dev.blues.io/support/)
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
With `pip` via PyPy:
```sh
python3 -m pip install notehub-py
```
(you may need to run `pip` with root permission: `sudo python3 -m pip install notehub-py`)
or
```sh
python3 -m pip3 install notehub-py
```
Then import the package:
```python
import notehub_py
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import notehub_py
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import notehub_py
from notehub_py.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.notefile.net
# See configuration.py for a list of all supported configuration parameters.
configuration = notehub_py.Configuration(
host = "https://api.notefile.net"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization: personalAccessToken
configuration = notehub_py.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with notehub_py.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = notehub_py.AlertApi(api_client)
project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str |
page_size = 50 # int | (optional) (default to 50)
page_num = 1 # int | (optional) (default to 1)
monitor_uid = 'monitor_uid_example' # str | (optional)
try:
api_response = api_instance.get_alerts(project_or_product_uid, page_size=page_size, page_num=page_num, monitor_uid=monitor_uid)
print("The response of AlertApi->get_alerts:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AlertApi->get_alerts: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://api.notefile.net*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AlertApi* | [**get_alerts**](docs/AlertApi.md#get_alerts) | **GET** /v1/projects/{projectOrProductUID}/alerts |
*AuthorizationApi* | [**login**](docs/AuthorizationApi.md#login) | **POST** /auth/login |
*AuthorizationApi* | [**o_auth2_client_credentials**](docs/AuthorizationApi.md#o_auth2_client_credentials) | **POST** /oauth2/token | Issue an OAuth 2.0 access token (Client Credentials)
*BillingAccountApi* | [**get_billing_accounts**](docs/BillingAccountApi.md#get_billing_accounts) | **GET** /v1/billing-accounts |
*DeviceApi* | [**delete_device_environment_variable**](docs/DeviceApi.md#delete_device_environment_variable) | **DELETE** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables/{key} |
*DeviceApi* | [**delete_project_device**](docs/DeviceApi.md#delete_project_device) | **DELETE** /v1/projects/{projectOrProductUID}/devices/{deviceUID} |
*DeviceApi* | [**disable_device**](docs/DeviceApi.md#disable_device) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/disable |
*DeviceApi* | [**disable_device_connectivity_assurance**](docs/DeviceApi.md#disable_device_connectivity_assurance) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/disable-connectivity-assurance |
*DeviceApi* | [**enable_device**](docs/DeviceApi.md#enable_device) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/enable |
*DeviceApi* | [**enable_device_connectivity_assurance**](docs/DeviceApi.md#enable_device_connectivity_assurance) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/enable-connectivity-assurance |
*DeviceApi* | [**get_device**](docs/DeviceApi.md#get_device) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID} |
*DeviceApi* | [**get_device_environment_hierarchy**](docs/DeviceApi.md#get_device_environment_hierarchy) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_hierarchy | Get environment variable hierarchy for a device
*DeviceApi* | [**get_device_environment_variables**](docs/DeviceApi.md#get_device_environment_variables) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables |
*DeviceApi* | [**get_device_environment_variables_by_pin**](docs/DeviceApi.md#get_device_environment_variables_by_pin) | **GET** /v1/products/{productUID}/devices/{deviceUID}/environment_variables_with_pin |
*DeviceApi* | [**get_device_health_log**](docs/DeviceApi.md#get_device_health_log) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/health-log |
*DeviceApi* | [**get_device_latest**](docs/DeviceApi.md#get_device_latest) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/latest |
*DeviceApi* | [**get_device_plans**](docs/DeviceApi.md#get_device_plans) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/plans |
*DeviceApi* | [**get_device_public_key**](docs/DeviceApi.md#get_device_public_key) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/public-key |
*DeviceApi* | [**get_device_sessions**](docs/DeviceApi.md#get_device_sessions) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/sessions |
*DeviceApi* | [**get_project_device_public_keys**](docs/DeviceApi.md#get_project_device_public_keys) | **GET** /v1/projects/{projectOrProductUID}/devices/public-keys |
*DeviceApi* | [**get_project_devices**](docs/DeviceApi.md#get_project_devices) | **GET** /v1/projects/{projectOrProductUID}/devices |
*DeviceApi* | [**get_project_fleet_devices**](docs/DeviceApi.md#get_project_fleet_devices) | **GET** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/devices |
*DeviceApi* | [**handle_note_add**](docs/DeviceApi.md#handle_note_add) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID} |
*DeviceApi* | [**handle_note_changes**](docs/DeviceApi.md#handle_note_changes) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/changes |
*DeviceApi* | [**handle_note_create_add**](docs/DeviceApi.md#handle_note_create_add) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} |
*DeviceApi* | [**handle_note_delete**](docs/DeviceApi.md#handle_note_delete) | **DELETE** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} |
*DeviceApi* | [**handle_note_get**](docs/DeviceApi.md#handle_note_get) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} |
*DeviceApi* | [**handle_note_signal**](docs/DeviceApi.md#handle_note_signal) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/signal |
*DeviceApi* | [**handle_note_update**](docs/DeviceApi.md#handle_note_update) | **PUT** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} |
*DeviceApi* | [**handle_notefile_changes**](docs/DeviceApi.md#handle_notefile_changes) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files/changes |
*DeviceApi* | [**handle_notefile_changes_pending**](docs/DeviceApi.md#handle_notefile_changes_pending) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files/changes/pending |
*DeviceApi* | [**handle_notefile_delete**](docs/DeviceApi.md#handle_notefile_delete) | **DELETE** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files |
*DeviceApi* | [**post_provision_project_device**](docs/DeviceApi.md#post_provision_project_device) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/provision |
*DeviceApi* | [**put_device_environment_variables**](docs/DeviceApi.md#put_device_environment_variables) | **PUT** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables |
*DeviceApi* | [**put_device_environment_variables_by_pin**](docs/DeviceApi.md#put_device_environment_variables_by_pin) | **PUT** /v1/products/{productUID}/devices/{deviceUID}/environment_variables_with_pin |
*EventApi* | [**get_fleet_events**](docs/EventApi.md#get_fleet_events) | **GET** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events |
*EventApi* | [**get_fleet_events_by_cursor**](docs/EventApi.md#get_fleet_events_by_cursor) | **GET** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events-cursor |
*EventApi* | [**get_project_events**](docs/EventApi.md#get_project_events) | **GET** /v1/projects/{projectOrProductUID}/events |
*EventApi* | [**get_project_events_by_cursor**](docs/EventApi.md#get_project_events_by_cursor) | **GET** /v1/projects/{projectOrProductUID}/events-cursor |
*EventApi* | [**get_route_logs_by_event**](docs/EventApi.md#get_route_logs_by_event) | **GET** /v1/projects/{projectOrProductUID}/events/{eventUID}/route-logs |
*ExternalDevicesApi* | [**create_event_ext_device**](docs/ExternalDevicesApi.md#create_event_ext_device) | **POST** /v1/products/{productUID}/ext-devices/{deviceUID}/event |
*ExternalDevicesApi* | [**ext_device_session_close**](docs/ExternalDevicesApi.md#ext_device_session_close) | **POST** /v1/products/{productUID}/ext-devices/{deviceUID}/session/close |
*ExternalDevicesApi* | [**ext_device_session_open**](docs/ExternalDevicesApi.md#ext_device_session_open) | **POST** /v1/products/{productUID}/ext-devices/{deviceUID}/session/open |
*MonitorApi* | [**create_monitor**](docs/MonitorApi.md#create_monitor) | **POST** /v1/projects/{projectOrProductUID}/monitors |
*MonitorApi* | [**delete_monitor**](docs/MonitorApi.md#delete_monitor) | **DELETE** /v1/projects/{projectOrProductUID}/monitors/{monitorUID} |
*MonitorApi* | [**get_monitor**](docs/MonitorApi.md#get_monitor) | **GET** /v1/projects/{projectOrProductUID}/monitors/{monitorUID} |
*MonitorApi* | [**get_monitors**](docs/MonitorApi.md#get_monitors) | **GET** /v1/projects/{projectOrProductUID}/monitors |
*MonitorApi* | [**update_monitor**](docs/MonitorApi.md#update_monitor) | **PUT** /v1/projects/{projectOrProductUID}/monitors/{monitorUID} |
*ProjectApi* | [**clone_project**](docs/ProjectApi.md#clone_project) | **POST** /v1/projects/{projectOrProductUID}/clone |
*ProjectApi* | [**create_fleet**](docs/ProjectApi.md#create_fleet) | **POST** /v1/projects/{projectOrProductUID}/fleets |
*ProjectApi* | [**create_product**](docs/ProjectApi.md#create_product) | **POST** /v1/projects/{projectOrProductUID}/products |
*ProjectApi* | [**create_project**](docs/ProjectApi.md#create_project) | **POST** /v1/projects |
*ProjectApi* | [**delete_device_fleets**](docs/ProjectApi.md#delete_device_fleets) | **DELETE** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets |
*ProjectApi* | [**delete_fleet**](docs/ProjectApi.md#delete_fleet) | **DELETE** /v1/projects/{projectOrProductUID}/fleets/{fleetUID} |
*ProjectApi* | [**delete_fleet_environment_variable**](docs/ProjectApi.md#delete_fleet_environment_variable) | **DELETE** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables/{key} |
*ProjectApi* | [**delete_product**](docs/ProjectApi.md#delete_product) | **DELETE** /v1/projects/{projectOrProductUID}/products/{productUID} |
*ProjectApi* | [**delete_project**](docs/ProjectApi.md#delete_project) | **DELETE** /v1/projects/{projectOrProductUID} |
*ProjectApi* | [**delete_project_environment_variable**](docs/ProjectApi.md#delete_project_environment_variable) | **DELETE** /v1/projects/{projectOrProductUID}/environment_variables/{key} |
*ProjectApi* | [**dfu_action**](docs/ProjectApi.md#dfu_action) | **POST** /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/{action} |
*ProjectApi* | [**disable_global_transformation**](docs/ProjectApi.md#disable_global_transformation) | **POST** /v1/projects/{projectOrProductUID}/global-transformation/disable |
*ProjectApi* | [**enable_global_transformation**](docs/ProjectApi.md#enable_global_transformation) | **POST** /v1/projects/{projectOrProductUID}/global-transformation/enable |
*ProjectApi* | [**get_device_dfu_history**](docs/ProjectApi.md#get_device_dfu_history) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/dfu/{firmwareType}/history |
*ProjectApi* | [**get_device_dfu_status**](docs/ProjectApi.md#get_device_dfu_status) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/dfu/{firmwareType}/status |
*ProjectApi* | [**get_device_fleets**](docs/ProjectApi.md#get_device_fleets) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets |
*ProjectApi* | [**get_devices_dfu_history**](docs/ProjectApi.md#get_devices_dfu_history) | **GET** /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/history |
*ProjectApi* | [**get_devices_dfu_status**](docs/ProjectApi.md#get_devices_dfu_status) | **GET** /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/status |
*ProjectApi* | [**get_firmware_info**](docs/ProjectApi.md#get_firmware_info) | **GET** /v1/projects/{projectOrProductUID}/firmware |
*ProjectApi* | [**get_fleet**](docs/ProjectApi.md#get_fleet) | **GET** /v1/projects/{projectOrProductUID}/fleets/{fleetUID} |
*ProjectApi* | [**get_fleet_environment_hierarchy**](docs/ProjectApi.md#get_fleet_environment_hierarchy) | **GET** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_hierarchy | Get environment variable hierarchy for a device
*ProjectApi* | [**get_fleet_environment_variables**](docs/ProjectApi.md#get_fleet_environment_variables) | **GET** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables |
*ProjectApi* | [**get_notefile_schemas**](docs/ProjectApi.md#get_notefile_schemas) | **GET** /v1/projects/{projectOrProductUID}/schemas | Get variable format for a notefile
*ProjectApi* | [**get_products**](docs/ProjectApi.md#get_products) | **GET** /v1/projects/{projectOrProductUID}/products |
*ProjectApi* | [**get_project**](docs/ProjectApi.md#get_project) | **GET** /v1/projects/{projectOrProductUID} |
*ProjectApi* | [**get_project_by_product**](docs/ProjectApi.md#get_project_by_product) | **GET** /v1/products/{productUID}/project |
*ProjectApi* | [**get_project_environment_hierarchy**](docs/ProjectApi.md#get_project_environment_hierarchy) | **GET** /v1/projects/{projectOrProductUID}/environment_hierarchy | Get environment variable hierarchy for a device
*ProjectApi* | [**get_project_environment_variables**](docs/ProjectApi.md#get_project_environment_variables) | **GET** /v1/projects/{projectOrProductUID}/environment_variables |
*ProjectApi* | [**get_project_fleets**](docs/ProjectApi.md#get_project_fleets) | **GET** /v1/projects/{projectOrProductUID}/fleets |
*ProjectApi* | [**get_project_members**](docs/ProjectApi.md#get_project_members) | **GET** /v1/projects/{projectOrProductUID}/members |
*ProjectApi* | [**get_projects**](docs/ProjectApi.md#get_projects) | **GET** /v1/projects |
*ProjectApi* | [**put_device_fleets**](docs/ProjectApi.md#put_device_fleets) | **PUT** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets |
*ProjectApi* | [**put_fleet_environment_variables**](docs/ProjectApi.md#put_fleet_environment_variables) | **PUT** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables |
*ProjectApi* | [**put_project_environment_variables**](docs/ProjectApi.md#put_project_environment_variables) | **PUT** /v1/projects/{projectOrProductUID}/environment_variables |
*ProjectApi* | [**set_global_transformation**](docs/ProjectApi.md#set_global_transformation) | **POST** /v1/projects/{projectOrProductUID}/global-transformation |
*ProjectApi* | [**update_fleet**](docs/ProjectApi.md#update_fleet) | **PUT** /v1/projects/{projectOrProductUID}/fleets/{fleetUID} |
*ProjectApi* | [**upload_firmware**](docs/ProjectApi.md#upload_firmware) | **PUT** /v1/projects/{projectOrProductUID}/firmware/{firmwareType}/{filename} |
*RouteApi* | [**create_route**](docs/RouteApi.md#create_route) | **POST** /v1/projects/{projectOrProductUID}/routes |
*RouteApi* | [**delete_route**](docs/RouteApi.md#delete_route) | **DELETE** /v1/projects/{projectOrProductUID}/routes/{routeUID} |
*RouteApi* | [**get_route**](docs/RouteApi.md#get_route) | **GET** /v1/projects/{projectOrProductUID}/routes/{routeUID} |
*RouteApi* | [**get_route_logs_by_route**](docs/RouteApi.md#get_route_logs_by_route) | **GET** /v1/projects/{projectOrProductUID}/routes/{routeUID}/route-logs |
*RouteApi* | [**get_routes**](docs/RouteApi.md#get_routes) | **GET** /v1/projects/{projectOrProductUID}/routes |
*RouteApi* | [**update_route**](docs/RouteApi.md#update_route) | **PUT** /v1/projects/{projectOrProductUID}/routes/{routeUID} |
*UsageApi* | [**get_data_usage**](docs/UsageApi.md#get_data_usage) | **GET** /v1/projects/{projectOrProductUID}/usage/data |
*UsageApi* | [**get_events_usage**](docs/UsageApi.md#get_events_usage) | **GET** /v1/projects/{projectOrProductUID}/usage/events |
*UsageApi* | [**get_sessions_usage**](docs/UsageApi.md#get_sessions_usage) | **GET** /v1/projects/{projectOrProductUID}/usage/sessions |
*WebhookApi* | [**create_webhook**](docs/WebhookApi.md#create_webhook) | **POST** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID} |
*WebhookApi* | [**delete_webhook**](docs/WebhookApi.md#delete_webhook) | **DELETE** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID} |
*WebhookApi* | [**get_webhook**](docs/WebhookApi.md#get_webhook) | **GET** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID} |
*WebhookApi* | [**get_webhooks**](docs/WebhookApi.md#get_webhooks) | **GET** /v1/projects/{projectOrProductUID}/webhooks |
*WebhookApi* | [**update_webhook**](docs/WebhookApi.md#update_webhook) | **PUT** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID} |
## Documentation For Models
- [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)
- [DeleteDeviceFleetsRequest](docs/DeleteDeviceFleetsRequest.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)
- [GetDeviceEnvironmentVariablesByPin200Response](docs/GetDeviceEnvironmentVariablesByPin200Response.md)
- [GetDeviceFleets200Response](docs/GetDeviceFleets200Response.md)
- [GetDeviceHealthLog200Response](docs/GetDeviceHealthLog200Response.md)
- [GetDeviceHealthLog200ResponseHealthLogInner](docs/GetDeviceHealthLog200ResponseHealthLogInner.md)
- [GetDeviceLatest200Response](docs/GetDeviceLatest200Response.md)
- [GetDevicePlans200Response](docs/GetDevicePlans200Response.md)
- [GetDevicePublicKey200Response](docs/GetDevicePublicKey200Response.md)
- [GetDeviceSessions200Response](docs/GetDeviceSessions200Response.md)
- [GetProducts200Response](docs/GetProducts200Response.md)
- [GetProjectDevicePublicKeys200Response](docs/GetProjectDevicePublicKeys200Response.md)
- [GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner](docs/GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner.md)
- [GetProjectDevices200Response](docs/GetProjectDevices200Response.md)
- [GetProjectEvents200Response](docs/GetProjectEvents200Response.md)
- [GetProjectEventsByCursor200Response](docs/GetProjectEventsByCursor200Response.md)
- [GetProjectMembers200Response](docs/GetProjectMembers200Response.md)
- [GetProjects200Response](docs/GetProjects200Response.md)
- [GetSessionsUsage200Response](docs/GetSessionsUsage200Response.md)
- [GetWebhooks200Response](docs/GetWebhooks200Response.md)
- [GoogleRoute](docs/GoogleRoute.md)
- [HandleNoteChanges200Response](docs/HandleNoteChanges200Response.md)
- [HandleNoteGet200Response](docs/HandleNoteGet200Response.md)
- [HandleNoteSignal200Response](docs/HandleNoteSignal200Response.md)
- [HandleNotefileChanges200Response](docs/HandleNotefileChanges200Response.md)
- [HandleNotefileChangesPending200Response](docs/HandleNotefileChangesPending200Response.md)
- [HandleNotefileDeleteRequest](docs/HandleNotefileDeleteRequest.md)
- [HttpRoute](docs/HttpRoute.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)
- [PostProvisionProjectDeviceRequest](docs/PostProvisionProjectDeviceRequest.md)
- [Product](docs/Product.md)
- [Project](docs/Project.md)
- [ProjectMember](docs/ProjectMember.md)
- [ProxyRoute](docs/ProxyRoute.md)
- [PutDeviceFleetsRequest](docs/PutDeviceFleetsRequest.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)
- [SimUsage](docs/SimUsage.md)
- [SlackBearerNotification](docs/SlackBearerNotification.md)
- [SlackRoute](docs/SlackRoute.md)
- [SlackWebHookNotification](docs/SlackWebHookNotification.md)
- [SnowflakeRoute](docs/SnowflakeRoute.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)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="personalAccessToken"></a>
### personalAccessToken
- **Type**: Bearer authentication
<a id="pin"></a>
### pin
- **Type**: API key
- **API key parameter name**: X-Auth-Token
- **Location**: HTTP header
## Author
engineering@blues.io
Raw data
{
"_id": null,
"home_page": "https://github.com/blues/notehub-py",
"name": "notehub-py",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Notehub API",
"author": "Blues Engineering",
"author_email": "engineering@blues.io",
"download_url": "https://files.pythonhosted.org/packages/c5/74/6b1747e9e657f0edffdc5c784ffe06e1a4b668e1825ad6168c4bc8c360ca/notehub_py-2.3.0.tar.gz",
"platform": null,
"description": "# notehub-py\nThe OpenAPI definition for the Notehub.io API.\n\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.2.0\n- Package version: 2.3.0\n- Generator version: 7.5.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\nFor more information, please visit [https://dev.blues.io/support/](https://dev.blues.io/support/)\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nWith `pip` via PyPy:\n\n```sh\npython3 -m pip install notehub-py\n```\n(you may need to run `pip` with root permission: `sudo python3 -m pip install notehub-py`)\n\nor\n\n```sh\npython3 -m pip3 install notehub-py\n```\n\nThen import the package:\n\n```python\nimport notehub_py\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport notehub_py\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport notehub_py\nfrom notehub_py.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://api.notefile.net\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = notehub_py.Configuration(\n host = \"https://api.notefile.net\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure Bearer authorization: personalAccessToken\nconfiguration = notehub_py.Configuration(\n access_token = os.environ[\"BEARER_TOKEN\"]\n)\n\n\n# Enter a context with an instance of the API client\nwith notehub_py.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = notehub_py.AlertApi(api_client)\n project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | \n page_size = 50 # int | (optional) (default to 50)\n page_num = 1 # int | (optional) (default to 1)\n monitor_uid = 'monitor_uid_example' # str | (optional)\n\n try:\n api_response = api_instance.get_alerts(project_or_product_uid, page_size=page_size, page_num=page_num, monitor_uid=monitor_uid)\n print(\"The response of AlertApi->get_alerts:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling AlertApi->get_alerts: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.notefile.net*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AlertApi* | [**get_alerts**](docs/AlertApi.md#get_alerts) | **GET** /v1/projects/{projectOrProductUID}/alerts | \n*AuthorizationApi* | [**login**](docs/AuthorizationApi.md#login) | **POST** /auth/login | \n*AuthorizationApi* | [**o_auth2_client_credentials**](docs/AuthorizationApi.md#o_auth2_client_credentials) | **POST** /oauth2/token | Issue an OAuth 2.0 access token (Client Credentials)\n*BillingAccountApi* | [**get_billing_accounts**](docs/BillingAccountApi.md#get_billing_accounts) | **GET** /v1/billing-accounts | \n*DeviceApi* | [**delete_device_environment_variable**](docs/DeviceApi.md#delete_device_environment_variable) | **DELETE** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables/{key} | \n*DeviceApi* | [**delete_project_device**](docs/DeviceApi.md#delete_project_device) | **DELETE** /v1/projects/{projectOrProductUID}/devices/{deviceUID} | \n*DeviceApi* | [**disable_device**](docs/DeviceApi.md#disable_device) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/disable | \n*DeviceApi* | [**disable_device_connectivity_assurance**](docs/DeviceApi.md#disable_device_connectivity_assurance) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/disable-connectivity-assurance | \n*DeviceApi* | [**enable_device**](docs/DeviceApi.md#enable_device) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/enable | \n*DeviceApi* | [**enable_device_connectivity_assurance**](docs/DeviceApi.md#enable_device_connectivity_assurance) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/enable-connectivity-assurance | \n*DeviceApi* | [**get_device**](docs/DeviceApi.md#get_device) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID} | \n*DeviceApi* | [**get_device_environment_hierarchy**](docs/DeviceApi.md#get_device_environment_hierarchy) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_hierarchy | Get environment variable hierarchy for a device\n*DeviceApi* | [**get_device_environment_variables**](docs/DeviceApi.md#get_device_environment_variables) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables | \n*DeviceApi* | [**get_device_environment_variables_by_pin**](docs/DeviceApi.md#get_device_environment_variables_by_pin) | **GET** /v1/products/{productUID}/devices/{deviceUID}/environment_variables_with_pin | \n*DeviceApi* | [**get_device_health_log**](docs/DeviceApi.md#get_device_health_log) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/health-log | \n*DeviceApi* | [**get_device_latest**](docs/DeviceApi.md#get_device_latest) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/latest | \n*DeviceApi* | [**get_device_plans**](docs/DeviceApi.md#get_device_plans) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/plans | \n*DeviceApi* | [**get_device_public_key**](docs/DeviceApi.md#get_device_public_key) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/public-key | \n*DeviceApi* | [**get_device_sessions**](docs/DeviceApi.md#get_device_sessions) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/sessions | \n*DeviceApi* | [**get_project_device_public_keys**](docs/DeviceApi.md#get_project_device_public_keys) | **GET** /v1/projects/{projectOrProductUID}/devices/public-keys | \n*DeviceApi* | [**get_project_devices**](docs/DeviceApi.md#get_project_devices) | **GET** /v1/projects/{projectOrProductUID}/devices | \n*DeviceApi* | [**get_project_fleet_devices**](docs/DeviceApi.md#get_project_fleet_devices) | **GET** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/devices | \n*DeviceApi* | [**handle_note_add**](docs/DeviceApi.md#handle_note_add) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID} | \n*DeviceApi* | [**handle_note_changes**](docs/DeviceApi.md#handle_note_changes) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/changes | \n*DeviceApi* | [**handle_note_create_add**](docs/DeviceApi.md#handle_note_create_add) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} | \n*DeviceApi* | [**handle_note_delete**](docs/DeviceApi.md#handle_note_delete) | **DELETE** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} | \n*DeviceApi* | [**handle_note_get**](docs/DeviceApi.md#handle_note_get) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} | \n*DeviceApi* | [**handle_note_signal**](docs/DeviceApi.md#handle_note_signal) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/signal | \n*DeviceApi* | [**handle_note_update**](docs/DeviceApi.md#handle_note_update) | **PUT** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} | \n*DeviceApi* | [**handle_notefile_changes**](docs/DeviceApi.md#handle_notefile_changes) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files/changes | \n*DeviceApi* | [**handle_notefile_changes_pending**](docs/DeviceApi.md#handle_notefile_changes_pending) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files/changes/pending | \n*DeviceApi* | [**handle_notefile_delete**](docs/DeviceApi.md#handle_notefile_delete) | **DELETE** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files | \n*DeviceApi* | [**post_provision_project_device**](docs/DeviceApi.md#post_provision_project_device) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/provision | \n*DeviceApi* | [**put_device_environment_variables**](docs/DeviceApi.md#put_device_environment_variables) | **PUT** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables | \n*DeviceApi* | [**put_device_environment_variables_by_pin**](docs/DeviceApi.md#put_device_environment_variables_by_pin) | **PUT** /v1/products/{productUID}/devices/{deviceUID}/environment_variables_with_pin | \n*EventApi* | [**get_fleet_events**](docs/EventApi.md#get_fleet_events) | **GET** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events | \n*EventApi* | [**get_fleet_events_by_cursor**](docs/EventApi.md#get_fleet_events_by_cursor) | **GET** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events-cursor | \n*EventApi* | [**get_project_events**](docs/EventApi.md#get_project_events) | **GET** /v1/projects/{projectOrProductUID}/events | \n*EventApi* | [**get_project_events_by_cursor**](docs/EventApi.md#get_project_events_by_cursor) | **GET** /v1/projects/{projectOrProductUID}/events-cursor | \n*EventApi* | [**get_route_logs_by_event**](docs/EventApi.md#get_route_logs_by_event) | **GET** /v1/projects/{projectOrProductUID}/events/{eventUID}/route-logs | \n*ExternalDevicesApi* | [**create_event_ext_device**](docs/ExternalDevicesApi.md#create_event_ext_device) | **POST** /v1/products/{productUID}/ext-devices/{deviceUID}/event | \n*ExternalDevicesApi* | [**ext_device_session_close**](docs/ExternalDevicesApi.md#ext_device_session_close) | **POST** /v1/products/{productUID}/ext-devices/{deviceUID}/session/close | \n*ExternalDevicesApi* | [**ext_device_session_open**](docs/ExternalDevicesApi.md#ext_device_session_open) | **POST** /v1/products/{productUID}/ext-devices/{deviceUID}/session/open | \n*MonitorApi* | [**create_monitor**](docs/MonitorApi.md#create_monitor) | **POST** /v1/projects/{projectOrProductUID}/monitors | \n*MonitorApi* | [**delete_monitor**](docs/MonitorApi.md#delete_monitor) | **DELETE** /v1/projects/{projectOrProductUID}/monitors/{monitorUID} | \n*MonitorApi* | [**get_monitor**](docs/MonitorApi.md#get_monitor) | **GET** /v1/projects/{projectOrProductUID}/monitors/{monitorUID} | \n*MonitorApi* | [**get_monitors**](docs/MonitorApi.md#get_monitors) | **GET** /v1/projects/{projectOrProductUID}/monitors | \n*MonitorApi* | [**update_monitor**](docs/MonitorApi.md#update_monitor) | **PUT** /v1/projects/{projectOrProductUID}/monitors/{monitorUID} | \n*ProjectApi* | [**clone_project**](docs/ProjectApi.md#clone_project) | **POST** /v1/projects/{projectOrProductUID}/clone | \n*ProjectApi* | [**create_fleet**](docs/ProjectApi.md#create_fleet) | **POST** /v1/projects/{projectOrProductUID}/fleets | \n*ProjectApi* | [**create_product**](docs/ProjectApi.md#create_product) | **POST** /v1/projects/{projectOrProductUID}/products | \n*ProjectApi* | [**create_project**](docs/ProjectApi.md#create_project) | **POST** /v1/projects | \n*ProjectApi* | [**delete_device_fleets**](docs/ProjectApi.md#delete_device_fleets) | **DELETE** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets | \n*ProjectApi* | [**delete_fleet**](docs/ProjectApi.md#delete_fleet) | **DELETE** /v1/projects/{projectOrProductUID}/fleets/{fleetUID} | \n*ProjectApi* | [**delete_fleet_environment_variable**](docs/ProjectApi.md#delete_fleet_environment_variable) | **DELETE** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables/{key} | \n*ProjectApi* | [**delete_product**](docs/ProjectApi.md#delete_product) | **DELETE** /v1/projects/{projectOrProductUID}/products/{productUID} | \n*ProjectApi* | [**delete_project**](docs/ProjectApi.md#delete_project) | **DELETE** /v1/projects/{projectOrProductUID} | \n*ProjectApi* | [**delete_project_environment_variable**](docs/ProjectApi.md#delete_project_environment_variable) | **DELETE** /v1/projects/{projectOrProductUID}/environment_variables/{key} | \n*ProjectApi* | [**dfu_action**](docs/ProjectApi.md#dfu_action) | **POST** /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/{action} | \n*ProjectApi* | [**disable_global_transformation**](docs/ProjectApi.md#disable_global_transformation) | **POST** /v1/projects/{projectOrProductUID}/global-transformation/disable | \n*ProjectApi* | [**enable_global_transformation**](docs/ProjectApi.md#enable_global_transformation) | **POST** /v1/projects/{projectOrProductUID}/global-transformation/enable | \n*ProjectApi* | [**get_device_dfu_history**](docs/ProjectApi.md#get_device_dfu_history) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/dfu/{firmwareType}/history | \n*ProjectApi* | [**get_device_dfu_status**](docs/ProjectApi.md#get_device_dfu_status) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/dfu/{firmwareType}/status | \n*ProjectApi* | [**get_device_fleets**](docs/ProjectApi.md#get_device_fleets) | **GET** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets | \n*ProjectApi* | [**get_devices_dfu_history**](docs/ProjectApi.md#get_devices_dfu_history) | **GET** /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/history | \n*ProjectApi* | [**get_devices_dfu_status**](docs/ProjectApi.md#get_devices_dfu_status) | **GET** /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/status | \n*ProjectApi* | [**get_firmware_info**](docs/ProjectApi.md#get_firmware_info) | **GET** /v1/projects/{projectOrProductUID}/firmware | \n*ProjectApi* | [**get_fleet**](docs/ProjectApi.md#get_fleet) | **GET** /v1/projects/{projectOrProductUID}/fleets/{fleetUID} | \n*ProjectApi* | [**get_fleet_environment_hierarchy**](docs/ProjectApi.md#get_fleet_environment_hierarchy) | **GET** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_hierarchy | Get environment variable hierarchy for a device\n*ProjectApi* | [**get_fleet_environment_variables**](docs/ProjectApi.md#get_fleet_environment_variables) | **GET** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables | \n*ProjectApi* | [**get_notefile_schemas**](docs/ProjectApi.md#get_notefile_schemas) | **GET** /v1/projects/{projectOrProductUID}/schemas | Get variable format for a notefile\n*ProjectApi* | [**get_products**](docs/ProjectApi.md#get_products) | **GET** /v1/projects/{projectOrProductUID}/products | \n*ProjectApi* | [**get_project**](docs/ProjectApi.md#get_project) | **GET** /v1/projects/{projectOrProductUID} | \n*ProjectApi* | [**get_project_by_product**](docs/ProjectApi.md#get_project_by_product) | **GET** /v1/products/{productUID}/project | \n*ProjectApi* | [**get_project_environment_hierarchy**](docs/ProjectApi.md#get_project_environment_hierarchy) | **GET** /v1/projects/{projectOrProductUID}/environment_hierarchy | Get environment variable hierarchy for a device\n*ProjectApi* | [**get_project_environment_variables**](docs/ProjectApi.md#get_project_environment_variables) | **GET** /v1/projects/{projectOrProductUID}/environment_variables | \n*ProjectApi* | [**get_project_fleets**](docs/ProjectApi.md#get_project_fleets) | **GET** /v1/projects/{projectOrProductUID}/fleets | \n*ProjectApi* | [**get_project_members**](docs/ProjectApi.md#get_project_members) | **GET** /v1/projects/{projectOrProductUID}/members | \n*ProjectApi* | [**get_projects**](docs/ProjectApi.md#get_projects) | **GET** /v1/projects | \n*ProjectApi* | [**put_device_fleets**](docs/ProjectApi.md#put_device_fleets) | **PUT** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets | \n*ProjectApi* | [**put_fleet_environment_variables**](docs/ProjectApi.md#put_fleet_environment_variables) | **PUT** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables | \n*ProjectApi* | [**put_project_environment_variables**](docs/ProjectApi.md#put_project_environment_variables) | **PUT** /v1/projects/{projectOrProductUID}/environment_variables | \n*ProjectApi* | [**set_global_transformation**](docs/ProjectApi.md#set_global_transformation) | **POST** /v1/projects/{projectOrProductUID}/global-transformation | \n*ProjectApi* | [**update_fleet**](docs/ProjectApi.md#update_fleet) | **PUT** /v1/projects/{projectOrProductUID}/fleets/{fleetUID} | \n*ProjectApi* | [**upload_firmware**](docs/ProjectApi.md#upload_firmware) | **PUT** /v1/projects/{projectOrProductUID}/firmware/{firmwareType}/{filename} | \n*RouteApi* | [**create_route**](docs/RouteApi.md#create_route) | **POST** /v1/projects/{projectOrProductUID}/routes | \n*RouteApi* | [**delete_route**](docs/RouteApi.md#delete_route) | **DELETE** /v1/projects/{projectOrProductUID}/routes/{routeUID} | \n*RouteApi* | [**get_route**](docs/RouteApi.md#get_route) | **GET** /v1/projects/{projectOrProductUID}/routes/{routeUID} | \n*RouteApi* | [**get_route_logs_by_route**](docs/RouteApi.md#get_route_logs_by_route) | **GET** /v1/projects/{projectOrProductUID}/routes/{routeUID}/route-logs | \n*RouteApi* | [**get_routes**](docs/RouteApi.md#get_routes) | **GET** /v1/projects/{projectOrProductUID}/routes | \n*RouteApi* | [**update_route**](docs/RouteApi.md#update_route) | **PUT** /v1/projects/{projectOrProductUID}/routes/{routeUID} | \n*UsageApi* | [**get_data_usage**](docs/UsageApi.md#get_data_usage) | **GET** /v1/projects/{projectOrProductUID}/usage/data | \n*UsageApi* | [**get_events_usage**](docs/UsageApi.md#get_events_usage) | **GET** /v1/projects/{projectOrProductUID}/usage/events | \n*UsageApi* | [**get_sessions_usage**](docs/UsageApi.md#get_sessions_usage) | **GET** /v1/projects/{projectOrProductUID}/usage/sessions | \n*WebhookApi* | [**create_webhook**](docs/WebhookApi.md#create_webhook) | **POST** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID} | \n*WebhookApi* | [**delete_webhook**](docs/WebhookApi.md#delete_webhook) | **DELETE** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID} | \n*WebhookApi* | [**get_webhook**](docs/WebhookApi.md#get_webhook) | **GET** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID} | \n*WebhookApi* | [**get_webhooks**](docs/WebhookApi.md#get_webhooks) | **GET** /v1/projects/{projectOrProductUID}/webhooks | \n*WebhookApi* | [**update_webhook**](docs/WebhookApi.md#update_webhook) | **PUT** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID} | \n\n\n## Documentation For Models\n\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 - [DeleteDeviceFleetsRequest](docs/DeleteDeviceFleetsRequest.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 - [GetDeviceEnvironmentVariablesByPin200Response](docs/GetDeviceEnvironmentVariablesByPin200Response.md)\n - [GetDeviceFleets200Response](docs/GetDeviceFleets200Response.md)\n - [GetDeviceHealthLog200Response](docs/GetDeviceHealthLog200Response.md)\n - [GetDeviceHealthLog200ResponseHealthLogInner](docs/GetDeviceHealthLog200ResponseHealthLogInner.md)\n - [GetDeviceLatest200Response](docs/GetDeviceLatest200Response.md)\n - [GetDevicePlans200Response](docs/GetDevicePlans200Response.md)\n - [GetDevicePublicKey200Response](docs/GetDevicePublicKey200Response.md)\n - [GetDeviceSessions200Response](docs/GetDeviceSessions200Response.md)\n - [GetProducts200Response](docs/GetProducts200Response.md)\n - [GetProjectDevicePublicKeys200Response](docs/GetProjectDevicePublicKeys200Response.md)\n - [GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner](docs/GetProjectDevicePublicKeys200ResponseDevicePublicKeysInner.md)\n - [GetProjectDevices200Response](docs/GetProjectDevices200Response.md)\n - [GetProjectEvents200Response](docs/GetProjectEvents200Response.md)\n - [GetProjectEventsByCursor200Response](docs/GetProjectEventsByCursor200Response.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 - [HandleNoteChanges200Response](docs/HandleNoteChanges200Response.md)\n - [HandleNoteGet200Response](docs/HandleNoteGet200Response.md)\n - [HandleNoteSignal200Response](docs/HandleNoteSignal200Response.md)\n - [HandleNotefileChanges200Response](docs/HandleNotefileChanges200Response.md)\n - [HandleNotefileChangesPending200Response](docs/HandleNotefileChangesPending200Response.md)\n - [HandleNotefileDeleteRequest](docs/HandleNotefileDeleteRequest.md)\n - [HttpRoute](docs/HttpRoute.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 - [PostProvisionProjectDeviceRequest](docs/PostProvisionProjectDeviceRequest.md)\n - [Product](docs/Product.md)\n - [Project](docs/Project.md)\n - [ProjectMember](docs/ProjectMember.md)\n - [ProxyRoute](docs/ProxyRoute.md)\n - [PutDeviceFleetsRequest](docs/PutDeviceFleetsRequest.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 - [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 - [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\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"personalAccessToken\"></a>\n### personalAccessToken\n\n- **Type**: Bearer authentication\n\n<a id=\"pin\"></a>\n### pin\n\n- **Type**: API key\n- **API key parameter name**: X-Auth-Token\n- **Location**: HTTP header\n\n\n## Author\n\nengineering@blues.io\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Python-based library for accessing the Blues Notehub API.",
"version": "2.3.0",
"project_urls": {
"Homepage": "https://github.com/blues/notehub-py"
},
"split_keywords": [
"openapi",
" openapi-generator",
" notehub api"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4d2f5d8812b71a3ecaf463beca7054bf16c304ed123726e2b93d5337c6402730",
"md5": "94ee634e0bc1cdf2d4b691fbc9b54899",
"sha256": "b53bb9097dbcaa9596b12ae2f1d68be377bbc950ee0a7a76832bf9a4ad438cb1"
},
"downloads": -1,
"filename": "notehub_py-2.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "94ee634e0bc1cdf2d4b691fbc9b54899",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 263029,
"upload_time": "2025-10-29T20:27:27",
"upload_time_iso_8601": "2025-10-29T20:27:27.233332Z",
"url": "https://files.pythonhosted.org/packages/4d/2f/5d8812b71a3ecaf463beca7054bf16c304ed123726e2b93d5337c6402730/notehub_py-2.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c5746b1747e9e657f0edffdc5c784ffe06e1a4b668e1825ad6168c4bc8c360ca",
"md5": "8677ee8a18d4ee02a11fd68bd4762891",
"sha256": "f11a695d4b7404904072896290befe9274ecd612f6775986b846df4a06c4dbb0"
},
"downloads": -1,
"filename": "notehub_py-2.3.0.tar.gz",
"has_sig": false,
"md5_digest": "8677ee8a18d4ee02a11fd68bd4762891",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 130254,
"upload_time": "2025-10-29T20:27:28",
"upload_time_iso_8601": "2025-10-29T20:27:28.942472Z",
"url": "https://files.pythonhosted.org/packages/c5/74/6b1747e9e657f0edffdc5c784ffe06e1a4b668e1825ad6168c4bc8c360ca/notehub_py-2.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-29 20:27:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "blues",
"github_project": "notehub-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "notehub-py"
}
JSON
