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.5.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
DescriptionApi delete_global_description DELETE /v1/description/{descriptionName}
DescriptionApi delete_project_description DELETE /v1/projects/{projectOrProductUID}/description/{descriptionName}
DescriptionApi get_global_description GET /v1/description/{descriptionName}
DescriptionApi get_project_description GET /v1/projects/{projectOrProductUID}/description/{descriptionName}
DescriptionApi list_global_descriptions GET /v1/description
DescriptionApi list_project_descriptions GET /v1/projects/{projectOrProductUID}/description
DescriptionApi set_global_description POST /v1/description/{descriptionName}
DescriptionApi set_project_description POST /v1/projects/{projectOrProductUID}/description/{descriptionName}
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_journey GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/journeys/{journeyID}
DeviceApi get_device_journeys GET /v1/projects/{projectOrProductUID}/devices/{deviceUID}/journeys
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 delete_job_run DELETE /v1/projects/{projectOrProductUID}/jobs/runs/{reportUID}
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}
OrganizationApi get_organization GET /v1/organizations/{organizationUID}
OrganizationApi get_organization_balance_history GET /v1/organizations/{organizationUID}/balance-history
OrganizationApi get_organizations GET /v1/organizations
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 create_project_secret POST /v1/projects/{projectOrProductUID}/secrets
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 delete_project_secret DELETE /v1/projects/{projectOrProductUID}/secrets/{secretName}
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_project_secrets GET /v1/projects/{projectOrProductUID}/secrets
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 update_project_secret PUT /v1/projects/{projectOrProductUID}/secrets/{secretName}
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_legacy_webhook_event POST /v1/products/{productUID}/devices/{deviceUID}/webhook-event
WebhookApi create_webhook POST /v1/projects/{projectOrProductUID}/webhooks/{webhookUID}
WebhookApi create_webhook_device_event_by_product POST /v1/products/{productUID}/webhooks/{webhookUID}/devices/{deviceUID}/event
WebhookApi create_webhook_event_by_product POST /v1/products/{productUID}/webhooks/{webhookUID}/event
WebhookApi delete_webhook DELETE /v1/projects/{projectOrProductUID}/webhooks/{webhookUID}
WebhookApi get_webhook GET /v1/projects/{projectOrProductUID}/webhooks/{webhookUID}
WebhookApi get_webhook_settings_by_product GET /v1/products/{productUID}/webhooks/{webhookUID}/settings
WebhookApi get_webhooks GET /v1/projects/{projectOrProductUID}/webhooks
WebhookApi update_legacy_webhook_session PUT /v1/products/{productUID}/devices/{deviceUID}/webhook-session
WebhookApi update_webhook PUT /v1/projects/{projectOrProductUID}/webhooks/{webhookUID}
WebhookApi update_webhook_settings_by_product PUT /v1/products/{productUID}/webhooks/{webhookUID}/settings

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

personalAccessToken

  • Type: Bearer authentication

Author

engineering@blues.io

Project links

Data verified by PyPI on Jul 30, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for paigen11 from gravatar.com paigen11 Avatar for tjvantoll from gravatar.com tjvantoll

Credits

Author: Blues Engineering

GitHub Statistics

Data verified by PyPI on Jul 30, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

MIT License

Tags

OpenAPI OpenAPI-Generator Notehub API

Classifiers

Report project as malware

Release files for notehub-py 6.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for notehub-py 6.5.0
File Size Uploaded
notehub_py-6.5.0.tar.gz 172.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for notehub-py 6.5.0
File Interpreter ABI Platform
notehub_py-6.5.0-py3-none-any.whl 343.9 kB Python 3 none any Details

Total release size: 516.5 kB

Release files / notehub_py-6.5.0.tar.gz

Download URL notehub_py-6.5.0.tar.gz
Size 172.6 kB
Tags Source
SHA-256 checksum
How to use checksums 		2b4b4b89d9684d50a4147be222f2d81163c8e43180d36d449f8561c0608a9c7d
BLAKE2b-256 checksum
How to use checksums 		112c2d1f8c08442344920cfbd084ba520767c5fa8825061760c13158be577c2b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 30, 2026.

Transparency log
Identity
Publishing platform
GitHub Actions
Publishing repository
github.com/blues/notehub-py
Publishing commit
github.com/blues/notehub-py/tree/4cc555f604bd92914b63ff8c5c2bcae048b2d7e3
Workflow
Publishing configuration
github.com/blues/notehub-py/blob/4cc555f604bd92914b63ff8c5c2bcae048b2d7e3/.github/workflows/publish-pypi.yml
Publishing logs
github.com/blues/notehub-py/actions/runs/30572323505/attempts/1
Artifact
Subject
notehub_py-6.5.0.tar.gz
SHA-256 checksum
2b4b4b89d9684d50a4147be222f2d81163c8e43180d36d449f8561c0608a9c7d Verifying attestations

Release files / notehub_py-6.5.0-py3-none-any.whl

Download URL notehub_py-6.5.0-py3-none-any.whl
Size 343.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums 		fe65f52904889f83fdddba8347e3ca23b8a9733982f96b0abe8859e7e1b20a16
BLAKE2b-256 checksum
How to use checksums 		f4cf1db39be2020602a6888c65c4b7816224e77ffa37e96e8c0b29991408c8d6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 30, 2026.

Transparency log
Identity
Publishing platform
GitHub Actions
Publishing repository
github.com/blues/notehub-py
Publishing commit
github.com/blues/notehub-py/tree/4cc555f604bd92914b63ff8c5c2bcae048b2d7e3
Workflow
Publishing configuration
github.com/blues/notehub-py/blob/4cc555f604bd92914b63ff8c5c2bcae048b2d7e3/.github/workflows/publish-pypi.yml
Publishing logs
github.com/blues/notehub-py/actions/runs/30572323505/attempts/1
Artifact
Subject
notehub_py-6.5.0-py3-none-any.whl
SHA-256 checksum
fe65f52904889f83fdddba8347e3ca23b8a9733982f96b0abe8859e7e1b20a16 Verifying attestations

Release history Release notifications | RSS feed

This release

6.5.0 This release

2 release files

6.4.0

2 release files

6.3.0

2 release files

6.2.0

2 release files

6.1.0

2 release files

6.0.2

2 release files

6.0.1

2 release files

5.0.0

2 release files

4.0.0

2 release files

3.0.0

2 release files

2.3.0

2 release files

2.2.1

2 release files

2.2.0

2 release files

2.1.0

2 release files

2.0.0

2 release files

1.0.17

2 release files

1.0.16

2 release files

1.0.15

2 release files

1.0.14

2 release files

1.0.13

2 release files

1.0.12

2 release files

1.0.11

2 release files

1.0.10

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page