README.md

notehub-py

The OpenAPI definition for the Notehub.io API.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.2.0
• Package version: 6.2.0
• Generator version: 7.5.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://dev.blues.io/support/

Requirements.

Python 3.7+

Installation & Usage

pip install

With pip via PyPy:

python3 -m pip install notehub-py

(you may need to run pip with root permission: sudo python3 -m pip install notehub-py)

or

python3 -m pip3 install notehub-py

Then import the package:

import notehub_py

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import notehub_py

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import notehub_py
from notehub_py.rest import ApiException
from pprint import pprint

configuration = notehub_py.Configuration(
    access_token = "PERSONAL_ACCESS_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	GET /v1/projects/{projectOrProductUID}/alerts
AuthorizationApi	login	POST /auth/login
AuthorizationApi	o_auth2_client_credentials	POST /oauth2/token	Issue an OAuth 2.0 access token (Client Credentials)
BillingAccountApi	get_billing_account	GET /v1/billing-accounts/{billingAccountUID}
BillingAccountApi	get_billing_account_balance_history	GET /v1/billing-accounts/{billingAccountUID}/balance-history
BillingAccountApi	get_billing_accounts	GET /v1/billing-accounts
DeviceApi	add_db_note	POST /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID}
DeviceApi	add_qi_note	POST /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}
DeviceApi	create_notefile	POST /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notefiles/{notefileID}
DeviceApi	delete_device	DELETE /v1/projects/{projectOrProductUID}/devices/{deviceUID}
DeviceApi	delete_device_environment_variable	DELETE /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables/{key}
DeviceApi	delete_note	DELETE /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID}
DeviceApi	delete_notefiles	DELETE /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files
DeviceApi	disable_device	POST /v1/projects/{projectOrProductUID}/devices/{deviceUID}/disable
DeviceApi	enable_device	POST /v1/projects/{projectOrProductUID}/devices/{deviceUID}/enable
DeviceApi	get_db_note	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID}
DeviceApi	get_device	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}
DeviceApi	get_device_environment_hierarchy	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_hierarchy	Get environment variable hierarchy for a device
DeviceApi	get_device_environment_variables	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables
DeviceApi	get_device_environment_variables_by_pin	GET /v1/products/{productUID}/devices/{deviceUID}/environment_variables_with_pin
DeviceApi	get_device_health_log	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/health-log
DeviceApi	get_device_latest_events	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/latest
DeviceApi	get_device_plans	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/plans
DeviceApi	get_device_public_key	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/public-key
DeviceApi	get_device_public_keys	GET /v1/projects/{projectOrProductUID}/devices/public-keys
DeviceApi	get_device_sessions	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/sessions
DeviceApi	get_devices	GET /v1/projects/{projectOrProductUID}/devices
DeviceApi	get_fleet_devices	GET /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/devices
DeviceApi	get_notefile	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}
DeviceApi	list_notefiles	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files
DeviceApi	provision_device	POST /v1/projects/{projectOrProductUID}/devices/{deviceUID}/provision
DeviceApi	set_device_environment_variables	PUT /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables
DeviceApi	set_device_environment_variables_by_pin	PUT /v1/products/{productUID}/devices/{deviceUID}/environment_variables_with_pin
DeviceApi	signal_device	POST /v1/projects/{projectOrProductUID}/devices/{deviceUID}/signal
DeviceApi	update_db_note	PUT /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID}
EventApi	get_events	GET /v1/projects/{projectOrProductUID}/events
EventApi	get_events_by_cursor	GET /v1/projects/{projectOrProductUID}/events-cursor
EventApi	get_fleet_events	GET /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events
EventApi	get_fleet_events_by_cursor	GET /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events-cursor
EventApi	get_route_logs_by_event	GET /v1/projects/{projectOrProductUID}/events/{eventUID}/route-logs
ExternalDevicesApi	create_event_ext_device	POST /v1/products/{productUID}/ext-devices/{deviceUID}/event
ExternalDevicesApi	ext_device_session_close	POST /v1/products/{productUID}/ext-devices/{deviceUID}/session/close
ExternalDevicesApi	ext_device_session_open	POST /v1/products/{productUID}/ext-devices/{deviceUID}/session/open
JobsApi	cancel_job_run	POST /v1/projects/{projectOrProductUID}/jobs/runs/{reportUID}/cancel
JobsApi	create_job	POST /v1/projects/{projectOrProductUID}/jobs
JobsApi	delete_job	DELETE /v1/projects/{projectOrProductUID}/jobs/{jobUID}
JobsApi	get_job	GET /v1/projects/{projectOrProductUID}/jobs/{jobUID}
JobsApi	get_job_run	GET /v1/projects/{projectOrProductUID}/jobs/runs/{reportUID}
JobsApi	get_job_runs	GET /v1/projects/{projectOrProductUID}/jobs/{jobUID}/runs
JobsApi	get_jobs	GET /v1/projects/{projectOrProductUID}/jobs
JobsApi	run_job	POST /v1/projects/{projectOrProductUID}/jobs/{jobUID}/run
MonitorApi	create_monitor	POST /v1/projects/{projectOrProductUID}/monitors
MonitorApi	delete_monitor	DELETE /v1/projects/{projectOrProductUID}/monitors/{monitorUID}
MonitorApi	get_monitor	GET /v1/projects/{projectOrProductUID}/monitors/{monitorUID}
MonitorApi	get_monitors	GET /v1/projects/{projectOrProductUID}/monitors
MonitorApi	update_monitor	PUT /v1/projects/{projectOrProductUID}/monitors/{monitorUID}
ProjectApi	add_device_to_fleets	PUT /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets
ProjectApi	clone_project	POST /v1/projects/{projectOrProductUID}/clone
ProjectApi	create_fleet	POST /v1/projects/{projectOrProductUID}/fleets
ProjectApi	create_product	POST /v1/projects/{projectOrProductUID}/products
ProjectApi	create_project	POST /v1/projects
ProjectApi	delete_device_from_fleets	DELETE /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets
ProjectApi	delete_firmware	DELETE /v1/projects/{projectOrProductUID}/firmware/{firmwareType}/{filename}
ProjectApi	delete_fleet	DELETE /v1/projects/{projectOrProductUID}/fleets/{fleetUID}
ProjectApi	delete_fleet_environment_variable	DELETE /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables/{key}
ProjectApi	delete_product	DELETE /v1/projects/{projectOrProductUID}/products/{productUID}
ProjectApi	delete_project	DELETE /v1/projects/{projectOrProductUID}
ProjectApi	delete_project_environment_variable	DELETE /v1/projects/{projectOrProductUID}/environment_variables/{key}
ProjectApi	disable_global_event_transformation	POST /v1/projects/{projectOrProductUID}/global-transformation/disable
ProjectApi	download_firmware	GET /v1/projects/{projectOrProductUID}/firmware/{firmwareType}/{filename}
ProjectApi	enable_global_event_transformation	POST /v1/projects/{projectOrProductUID}/global-transformation/enable
ProjectApi	get_aws_role_config	GET /v1/projects/{projectOrProductUID}/aws-role-config	Get AWS role configuration for role-based authentication
ProjectApi	get_device_dfu_history	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/dfu/{firmwareType}/history
ProjectApi	get_device_dfu_status	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/dfu/{firmwareType}/status
ProjectApi	get_device_fleets	GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets
ProjectApi	get_devices_dfu_history	GET /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/history
ProjectApi	get_devices_dfu_status	GET /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/status
ProjectApi	get_firmware_info	GET /v1/projects/{projectOrProductUID}/firmware
ProjectApi	get_fleet	GET /v1/projects/{projectOrProductUID}/fleets/{fleetUID}
ProjectApi	get_fleet_environment_hierarchy	GET /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_hierarchy	Get environment variable hierarchy for a device
ProjectApi	get_fleet_environment_variables	GET /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables
ProjectApi	get_fleets	GET /v1/projects/{projectOrProductUID}/fleets
ProjectApi	get_notefile_schemas	GET /v1/projects/{projectOrProductUID}/schemas	Get variable format for a notefile
ProjectApi	get_products	GET /v1/projects/{projectOrProductUID}/products
ProjectApi	get_project	GET /v1/projects/{projectOrProductUID}
ProjectApi	get_project_by_product	GET /v1/products/{productUID}/project
ProjectApi	get_project_environment_hierarchy	GET /v1/projects/{projectOrProductUID}/environment_hierarchy	Get environment variable hierarchy for a device
ProjectApi	get_project_environment_variables	GET /v1/projects/{projectOrProductUID}/environment_variables
ProjectApi	get_project_members	GET /v1/projects/{projectOrProductUID}/members
ProjectApi	get_projects	GET /v1/projects
ProjectApi	perform_dfu_action	POST /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/{action}
ProjectApi	set_fleet_environment_variables	PUT /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables
ProjectApi	set_global_event_transformation	POST /v1/projects/{projectOrProductUID}/global-transformation
ProjectApi	set_project_environment_variables	PUT /v1/projects/{projectOrProductUID}/environment_variables
ProjectApi	update_firmware	POST /v1/projects/{projectOrProductUID}/firmware/{firmwareType}/{filename}
ProjectApi	update_fleet	PUT /v1/projects/{projectOrProductUID}/fleets/{fleetUID}
ProjectApi	upload_firmware	PUT /v1/projects/{projectOrProductUID}/firmware/{firmwareType}/{filename}
RouteApi	create_route	POST /v1/projects/{projectOrProductUID}/routes
RouteApi	delete_route	DELETE /v1/projects/{projectOrProductUID}/routes/{routeUID}
RouteApi	get_route	GET /v1/projects/{projectOrProductUID}/routes/{routeUID}
RouteApi	get_route_logs_by_route	GET /v1/projects/{projectOrProductUID}/routes/{routeUID}/route-logs
RouteApi	get_routes	GET /v1/projects/{projectOrProductUID}/routes
RouteApi	update_route	PUT /v1/projects/{projectOrProductUID}/routes/{routeUID}
UsageApi	get_data_usage	GET /v1/projects/{projectOrProductUID}/usage/data
UsageApi	get_events_usage	GET /v1/projects/{projectOrProductUID}/usage/events
UsageApi	get_route_logs_usage	GET /v1/projects/{projectOrProductUID}/usage/route-logs
UsageApi	get_sessions_usage	GET /v1/projects/{projectOrProductUID}/usage/sessions
WebhookApi	create_webhook	POST /v1/projects/{projectOrProductUID}/webhooks/{webhookUID}
WebhookApi	delete_webhook	DELETE /v1/projects/{projectOrProductUID}/webhooks/{webhookUID}
WebhookApi	get_webhook	GET /v1/projects/{projectOrProductUID}/webhooks/{webhookUID}
WebhookApi	get_webhooks	GET /v1/projects/{projectOrProductUID}/webhooks
WebhookApi	update_webhook	PUT /v1/projects/{projectOrProductUID}/webhooks/{webhookUID}

Documentation For Models

• AWSRoleConfig
• AddDeviceToFleetsRequest
• Alert
• AlertDataInner
• AlertNotificationsInner
• AwsRoute
• AzureRoute
• BillingAccount
• BillingAccountRole
• BlynkRoute
• Body
• CancelJobRun200Response
• CellularPlan
• CloneProjectRequest
• Contact
• CreateFleetRequest
• CreateJob201Response
• CreateMonitor
• CreateProductRequest
• CreateProjectRequest
• CreateUpdateRepository
• CurrentFirmware
• DFUEnv
• DFUState
• DataField
• DataSetField
• DataUsage
• DatacakeRoute
• DeleteDeviceFromFleetsRequest
• DeleteJob200Response
• DeleteNotefilesRequest
• Device
• DeviceDfuHistory
• DeviceDfuHistoryCurrent
• DeviceDfuHistoryPage
• DeviceDfuStateMachine
• DeviceDfuStateMachineNode
• DeviceDfuStatus
• DeviceDfuStatusPage
• DeviceSession
• DeviceTowerInfo
• DeviceUsage
• DfuActionRequest
• EmailNotification
• EnvTreeJsonNode
• EnvVar
• EnvironmentVariables
• Error
• Event
• Filter
• Firmware
• FirmwareInfo
• Fleet
• FleetConnectivityAssurance
• GetAlerts200Response
• GetBillingAccount200Response
• GetBillingAccount200ResponsePlan
• GetBillingAccountBalanceHistory200Response
• GetBillingAccountBalanceHistory200ResponseDataInner
• GetBillingAccounts200Response
• GetDataUsage200Response
• GetDataUsage200ResponseDataInner
• GetDbNote200Response
• GetDeviceEnvironmentVariablesByPin200Response
• GetDeviceFleets200Response
• GetDeviceHealthLog200Response
• GetDeviceHealthLog200ResponseHealthLogInner
• GetDeviceLatestEvents200Response
• GetDevicePlans200Response
• GetDevicePublicKey200Response
• GetDevicePublicKeys200Response
• GetDevicePublicKeys200ResponseDevicePublicKeysInner
• GetDeviceSessions200Response
• GetDevices200Response
• GetEvents200Response
• GetEventsByCursor200Response
• GetJobRuns200Response
• GetJobs200Response
• GetNotefile200Response
• GetProducts200Response
• GetProjectMembers200Response
• GetProjects200Response
• GetRouteLogsUsage200Response
• GetSessionsUsage200Response
• GetWebhooks200Response
• GoogleRoute
• HttpRoute
• Job
• JobRun
• Location
• Login200Response
• LoginRequest
• Monitor
• MonitorAlertRoutesInner
• MqttRoute
• Note
• NoteInput
• Notefile
• NotefileSchema
• NotehubRoute
• NotehubRouteSummary
• OAuth2Error
• OAuth2TokenResponse
• PersonalAccessToken
• PersonalAccessTokenCreatedBy
• PersonalAccessTokenInfo
• PersonalAccessTokenSecret
• Product
• Project
• ProjectMember
• ProvisionDeviceRequest
• ProxyRoute
• QubitroRoute
• RadRoute
• Repository
• Role
• RouteLog
• RouteTransformSettings
• RunJob200Response
• S3ArchiveRoute
• SatelliteDataUsage
• SatellitePlan
• SchemaProperty
• SignalDevice200Response
• SimUsage
• SlackBearerNotification
• SlackRoute
• SlackWebHookNotification
• SnowflakeRoute
• SnowpipeStreamingRoute
• ThingworxRoute
• TowerLocation
• TwilioRoute
• UpdateFleetRequest
• UpdateHostFirmwareRequest
• UploadMetadata
• UsageData
• UsageEventsData
• UsageEventsResponse
• UsageRouteLogsData
• UsageSessionsData
• UserDfuStateMachine
• UserDfuStateMachineStatus
• UserFirmwareInfo
• WebhookSettings

Documentation For Authorization

Authentication schemes defined for the API:

personalAccessToken

• Type: Bearer authentication

Author

engineering@blues.io