From 95192be15eae0f9f73c01594bc6bb656f9f5a76a Mon Sep 17 00:00:00 2001 From: TJ VanToll Date: Wed, 8 Apr 2026 13:34:44 -0400 Subject: [PATCH] feat: better Python example code formatting --- scripts.py | 41 +- src/docs/AddDeviceToFleetsRequest.md | 4 +- src/docs/AlertApi.md | 19 +- src/docs/AlertNotificationsInner.md | 4 +- src/docs/AuthorizationApi.md | 22 +- src/docs/BillingAccountApi.md | 49 +- src/docs/CancelJobRun200Response.md | 4 +- src/docs/CloneProjectRequest.md | 4 +- src/docs/CreateJob201Response.md | 4 +- src/docs/CreateProductRequest.md | 4 +- src/docs/CreateProjectRequest.md | 4 +- src/docs/CreateUpdateRepository.md | 4 +- src/docs/DeleteDeviceFromFleetsRequest.md | 16 +- src/docs/DeleteJob200Response.md | 4 +- src/docs/DeleteNotefilesRequest.md | 4 +- src/docs/DeviceApi.md | 570 +++++++++------- src/docs/DeviceDfuHistoryCurrent.md | 4 +- src/docs/DeviceDfuHistoryPage.md | 4 +- src/docs/DeviceDfuStateMachine.md | 4 +- src/docs/DeviceDfuStateMachineNode.md | 4 +- src/docs/DeviceDfuStatusPage.md | 4 +- src/docs/EnvironmentVariables.md | 4 +- src/docs/EventApi.md | 216 +++--- src/docs/ExternalDevicesApi.md | 45 +- src/docs/FleetConnectivityAssurance.md | 4 +- src/docs/GetAlerts200Response.md | 4 +- src/docs/GetBillingAccount200Response.md | 12 +- src/docs/GetBillingAccount200ResponsePlan.md | 18 +- ...BillingAccountBalanceHistory200Response.md | 18 +- ...countBalanceHistory200ResponseDataInner.md | 18 +- src/docs/GetBillingAccounts200Response.md | 16 +- src/docs/GetDataUsage200Response.md | 4 +- src/docs/GetDataUsage200ResponseDataInner.md | 18 +- src/docs/GetDbNote200Response.md | 4 +- ...iceEnvironmentVariablesByPin200Response.md | 18 +- src/docs/GetDeviceFleets200Response.md | 4 +- src/docs/GetDeviceHealthLog200Response.md | 16 +- ...eviceHealthLog200ResponseHealthLogInner.md | 18 +- src/docs/GetDeviceLatestEvents200Response.md | 18 +- src/docs/GetDevicePlans200Response.md | 4 +- src/docs/GetDevicePublicKey200Response.md | 16 +- src/docs/GetDevicePublicKeys200Response.md | 16 +- ...licKeys200ResponseDevicePublicKeysInner.md | 18 +- src/docs/GetDeviceSessions200Response.md | 12 +- src/docs/GetDevices200Response.md | 4 +- src/docs/GetEvents200Response.md | 4 +- src/docs/GetEventsByCursor200Response.md | 12 +- src/docs/GetJobRuns200Response.md | 4 +- src/docs/GetNotefile200Response.md | 4 +- src/docs/GetProducts200Response.md | 4 +- src/docs/GetProjectMembers200Response.md | 12 +- src/docs/GetProjects200Response.md | 4 +- src/docs/GetRouteLogsUsage200Response.md | 12 +- src/docs/GetSessionsUsage200Response.md | 4 +- src/docs/GetWebhooks200Response.md | 4 +- src/docs/JobsApi.md | 78 +-- src/docs/MonitorAlertRoutesInner.md | 4 +- src/docs/MonitorApi.md | 44 +- src/docs/NotehubRouteSummary.md | 4 +- src/docs/OAuth2TokenResponse.md | 4 +- src/docs/PersonalAccessToken.md | 4 +- src/docs/PersonalAccessTokenCreatedBy.md | 12 +- src/docs/PersonalAccessTokenInfo.md | 4 +- src/docs/PersonalAccessTokenSecret.md | 4 +- src/docs/ProjectApi.md | 639 ++++++++++-------- src/docs/ProvisionDeviceRequest.md | 4 +- src/docs/RouteTransformSettings.md | 4 +- src/docs/SignalDevice200Response.md | 4 +- src/docs/SlackBearerNotification.md | 4 +- src/docs/SlackWebHookNotification.md | 4 +- src/docs/SnowpipeStreamingRoute.md | 4 +- src/docs/UsageApi.md | 150 ++-- src/docs/UsageEventsResponse.md | 4 +- src/docs/UsageRouteLogsData.md | 4 +- src/docs/UserDfuStateMachine.md | 4 +- src/docs/UserDfuStateMachineStatus.md | 4 +- src/docs/WebhookApi.md | 59 +- 77 files changed, 1506 insertions(+), 906 deletions(-) diff --git a/scripts.py b/scripts.py index c2aa6eb..d7d7fbc 100644 --- a/scripts.py +++ b/scripts.py @@ -189,13 +189,46 @@ def run_black_on_python(): except Exception as e: print(f"Exception when running Black on Python files: {e}") +def run_blacken_docs(): + """ + Run blacken-docs on the generated markdown documentation files in the src/docs/ directory. + This normalizes Python code blocks in markdown to use double quotes (Black style). + """ + try: + docs_dir = "src/docs" + + if not os.path.exists(docs_dir): + print(f"Documentation directory {docs_dir} not found. Skipping blacken-docs.") + return + + print(f"Running blacken-docs on markdown documentation in {docs_dir}...") + + subprocess.run([ + "python3", "-m", "pip", "install", "blacken-docs" + ]) + + md_files = [ + os.path.join(docs_dir, f) + for f in os.listdir(docs_dir) + if f.endswith(".md") + ] + + if md_files: + subprocess.run(["python3", "-m", "blacken_docs"] + md_files) + + print("blacken-docs formatting completed successfully.") + except Exception as e: + print(f"Exception when running blacken-docs: {e}") + + def format_code(): """ Format both Python and Markdown files in the repository. """ run_black_on_python() + run_blacken_docs() run_prettier_on_docs() - print("All code formatting completed.") + print("All code formatting completed.") def generate_and_format(): """ @@ -210,10 +243,10 @@ def generate_and_format(): if __name__ == "__main__": if len(sys.argv) != 2: print( - "Usage: python3 scripts.py [download_python_template | " + "Usage: python3 scripts.py [download_python_template | " "generate_package | build_distro_package | " "remove_deprecated_parameters | run_prettier_on_docs | " - "run_black_on_python | format_code | generate_and_format]" + "run_black_on_python | run_blacken_docs | format_code | generate_and_format]" ) sys.exit(1) @@ -230,6 +263,8 @@ def generate_and_format(): run_prettier_on_docs() elif script_to_run == "run_black_on_python": run_black_on_python() + elif script_to_run == "run_blacken_docs": + run_blacken_docs() elif script_to_run == "format_code": format_code() elif script_to_run == "generate_and_format": diff --git a/src/docs/AddDeviceToFleetsRequest.md b/src/docs/AddDeviceToFleetsRequest.md index 5411ab0..b4e4bca 100644 --- a/src/docs/AddDeviceToFleetsRequest.md +++ b/src/docs/AddDeviceToFleetsRequest.md @@ -21,7 +21,9 @@ print(AddDeviceToFleetsRequest.to_json()) # convert the object into a dict add_device_to_fleets_request_dict = add_device_to_fleets_request_instance.to_dict() # create an instance of AddDeviceToFleetsRequest from a dict -add_device_to_fleets_request_from_dict = AddDeviceToFleetsRequest.from_dict(add_device_to_fleets_request_dict) +add_device_to_fleets_request_from_dict = AddDeviceToFleetsRequest.from_dict( + add_device_to_fleets_request_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/AlertApi.md b/src/docs/AlertApi.md index 2ba23d8..3a4cd44 100644 --- a/src/docs/AlertApi.md +++ b/src/docs/AlertApi.md @@ -22,21 +22,24 @@ from notehub_py.models.get_alerts200_response import GetAlerts200Response from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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) + 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) + 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 Exception as e: diff --git a/src/docs/AlertNotificationsInner.md b/src/docs/AlertNotificationsInner.md index 0ab9647..6d61a25 100644 --- a/src/docs/AlertNotificationsInner.md +++ b/src/docs/AlertNotificationsInner.md @@ -23,7 +23,9 @@ print(AlertNotificationsInner.to_json()) # convert the object into a dict alert_notifications_inner_dict = alert_notifications_inner_instance.to_dict() # create an instance of AlertNotificationsInner from a dict -alert_notifications_inner_from_dict = AlertNotificationsInner.from_dict(alert_notifications_inner_dict) +alert_notifications_inner_from_dict = AlertNotificationsInner.from_dict( + alert_notifications_inner_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/AuthorizationApi.md b/src/docs/AuthorizationApi.md index e807295..9f3dacd 100644 --- a/src/docs/AuthorizationApi.md +++ b/src/docs/AuthorizationApi.md @@ -27,7 +27,10 @@ from pprint import pprint with notehub_py.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = notehub_py.AuthorizationApi(api_client) - login_request = {"password":"test-password","username":"name@example.com"} # LoginRequest | + login_request = { + "password": "test-password", + "username": "name@example.com", + } # LoginRequest | try: api_response = api_instance.login(login_request) @@ -77,18 +80,23 @@ from pprint import pprint with notehub_py.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = notehub_py.AuthorizationApi(api_client) - client_id = 'client_id_example' # str | - client_secret = 'client_secret_example' # str | - grant_type = 'grant_type_example' # str | - scope = 'scope_example' # str | Space-delimited scopes. (optional) + client_id = "client_id_example" # str | + client_secret = "client_secret_example" # str | + grant_type = "grant_type_example" # str | + scope = "scope_example" # str | Space-delimited scopes. (optional) try: # Issue an OAuth 2.0 access token (Client Credentials) - api_response = api_instance.o_auth2_client_credentials(client_id, client_secret, grant_type, scope=scope) + api_response = api_instance.o_auth2_client_credentials( + client_id, client_secret, grant_type, scope=scope + ) print("The response of AuthorizationApi->o_auth2_client_credentials:\n") pprint(api_response) except Exception as e: - print("Exception when calling AuthorizationApi->o_auth2_client_credentials: %s\n" % e) + print( + "Exception when calling AuthorizationApi->o_auth2_client_credentials: %s\n" + % e + ) ``` ### Parameters diff --git a/src/docs/BillingAccountApi.md b/src/docs/BillingAccountApi.md index 6ffbcf9..80a9a32 100644 --- a/src/docs/BillingAccountApi.md +++ b/src/docs/BillingAccountApi.md @@ -20,19 +20,19 @@ Get Billing Account Information ```python import notehub_py -from notehub_py.models.get_billing_account200_response import GetBillingAccount200Response +from notehub_py.models.get_billing_account200_response import ( + GetBillingAccount200Response, +) from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.BillingAccountApi(api_client) - billing_account_uid = '00000000-0000-0000-000000000001' # str | + billing_account_uid = "00000000-0000-0000-000000000001" # str | try: api_response = api_instance.get_billing_account(billing_account_uid) @@ -73,28 +73,35 @@ Get Billing Account Balance history, only enterprise supported ```python import notehub_py -from notehub_py.models.get_billing_account_balance_history200_response import GetBillingAccountBalanceHistory200Response +from notehub_py.models.get_billing_account_balance_history200_response import ( + GetBillingAccountBalanceHistory200Response, +) from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.BillingAccountApi(api_client) - billing_account_uid = '00000000-0000-0000-000000000001' # str | - start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) - end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) + billing_account_uid = "00000000-0000-0000-000000000001" # str | + start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) + end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) try: - api_response = api_instance.get_billing_account_balance_history(billing_account_uid, start_date=start_date, end_date=end_date) - print("The response of BillingAccountApi->get_billing_account_balance_history:\n") + api_response = api_instance.get_billing_account_balance_history( + billing_account_uid, start_date=start_date, end_date=end_date + ) + print( + "The response of BillingAccountApi->get_billing_account_balance_history:\n" + ) pprint(api_response) except Exception as e: - print("Exception when calling BillingAccountApi->get_billing_account_balance_history: %s\n" % e) + print( + "Exception when calling BillingAccountApi->get_billing_account_balance_history: %s\n" + % e + ) ``` ### Parameters @@ -130,13 +137,13 @@ Get Billing Accounts accessible by the api_key ```python import notehub_py -from notehub_py.models.get_billing_accounts200_response import GetBillingAccounts200Response +from notehub_py.models.get_billing_accounts200_response import ( + GetBillingAccounts200Response, +) from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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: @@ -148,7 +155,9 @@ with notehub_py.ApiClient(configuration) as api_client: print("The response of BillingAccountApi->get_billing_accounts:\n") pprint(api_response) except Exception as e: - print("Exception when calling BillingAccountApi->get_billing_accounts: %s\n" % e) + print( + "Exception when calling BillingAccountApi->get_billing_accounts: %s\n" % e + ) ``` ### Parameters diff --git a/src/docs/CancelJobRun200Response.md b/src/docs/CancelJobRun200Response.md index 3e2429f..7ecebb9 100644 --- a/src/docs/CancelJobRun200Response.md +++ b/src/docs/CancelJobRun200Response.md @@ -21,7 +21,9 @@ print(CancelJobRun200Response.to_json()) # convert the object into a dict cancel_job_run200_response_dict = cancel_job_run200_response_instance.to_dict() # create an instance of CancelJobRun200Response from a dict -cancel_job_run200_response_from_dict = CancelJobRun200Response.from_dict(cancel_job_run200_response_dict) +cancel_job_run200_response_from_dict = CancelJobRun200Response.from_dict( + cancel_job_run200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/CloneProjectRequest.md b/src/docs/CloneProjectRequest.md index cd00197..75e09c2 100644 --- a/src/docs/CloneProjectRequest.md +++ b/src/docs/CloneProjectRequest.md @@ -24,7 +24,9 @@ print(CloneProjectRequest.to_json()) # convert the object into a dict clone_project_request_dict = clone_project_request_instance.to_dict() # create an instance of CloneProjectRequest from a dict -clone_project_request_from_dict = CloneProjectRequest.from_dict(clone_project_request_dict) +clone_project_request_from_dict = CloneProjectRequest.from_dict( + clone_project_request_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/CreateJob201Response.md b/src/docs/CreateJob201Response.md index d2158ac..a3a71af 100644 --- a/src/docs/CreateJob201Response.md +++ b/src/docs/CreateJob201Response.md @@ -21,7 +21,9 @@ print(CreateJob201Response.to_json()) # convert the object into a dict create_job201_response_dict = create_job201_response_instance.to_dict() # create an instance of CreateJob201Response from a dict -create_job201_response_from_dict = CreateJob201Response.from_dict(create_job201_response_dict) +create_job201_response_from_dict = CreateJob201Response.from_dict( + create_job201_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/CreateProductRequest.md b/src/docs/CreateProductRequest.md index 532807a..78b8398 100644 --- a/src/docs/CreateProductRequest.md +++ b/src/docs/CreateProductRequest.md @@ -24,7 +24,9 @@ print(CreateProductRequest.to_json()) # convert the object into a dict create_product_request_dict = create_product_request_instance.to_dict() # create an instance of CreateProductRequest from a dict -create_product_request_from_dict = CreateProductRequest.from_dict(create_product_request_dict) +create_product_request_from_dict = CreateProductRequest.from_dict( + create_product_request_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/CreateProjectRequest.md b/src/docs/CreateProjectRequest.md index efcb11e..586be5b 100644 --- a/src/docs/CreateProjectRequest.md +++ b/src/docs/CreateProjectRequest.md @@ -22,7 +22,9 @@ print(CreateProjectRequest.to_json()) # convert the object into a dict create_project_request_dict = create_project_request_instance.to_dict() # create an instance of CreateProjectRequest from a dict -create_project_request_from_dict = CreateProjectRequest.from_dict(create_project_request_dict) +create_project_request_from_dict = CreateProjectRequest.from_dict( + create_project_request_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/CreateUpdateRepository.md b/src/docs/CreateUpdateRepository.md index f046105..b8d1e28 100644 --- a/src/docs/CreateUpdateRepository.md +++ b/src/docs/CreateUpdateRepository.md @@ -23,7 +23,9 @@ print(CreateUpdateRepository.to_json()) # convert the object into a dict create_update_repository_dict = create_update_repository_instance.to_dict() # create an instance of CreateUpdateRepository from a dict -create_update_repository_from_dict = CreateUpdateRepository.from_dict(create_update_repository_dict) +create_update_repository_from_dict = CreateUpdateRepository.from_dict( + create_update_repository_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/DeleteDeviceFromFleetsRequest.md b/src/docs/DeleteDeviceFromFleetsRequest.md index 07fc571..62778ea 100644 --- a/src/docs/DeleteDeviceFromFleetsRequest.md +++ b/src/docs/DeleteDeviceFromFleetsRequest.md @@ -9,19 +9,27 @@ ## Example ```python -from notehub_py.models.delete_device_from_fleets_request import DeleteDeviceFromFleetsRequest +from notehub_py.models.delete_device_from_fleets_request import ( + DeleteDeviceFromFleetsRequest, +) # TODO update the JSON string below json = "{}" # create an instance of DeleteDeviceFromFleetsRequest from a JSON string -delete_device_from_fleets_request_instance = DeleteDeviceFromFleetsRequest.from_json(json) +delete_device_from_fleets_request_instance = DeleteDeviceFromFleetsRequest.from_json( + json +) # print the JSON string representation of the object print(DeleteDeviceFromFleetsRequest.to_json()) # convert the object into a dict -delete_device_from_fleets_request_dict = delete_device_from_fleets_request_instance.to_dict() +delete_device_from_fleets_request_dict = ( + delete_device_from_fleets_request_instance.to_dict() +) # create an instance of DeleteDeviceFromFleetsRequest from a dict -delete_device_from_fleets_request_from_dict = DeleteDeviceFromFleetsRequest.from_dict(delete_device_from_fleets_request_dict) +delete_device_from_fleets_request_from_dict = DeleteDeviceFromFleetsRequest.from_dict( + delete_device_from_fleets_request_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/DeleteJob200Response.md b/src/docs/DeleteJob200Response.md index 7ac83f4..cddd1f3 100644 --- a/src/docs/DeleteJob200Response.md +++ b/src/docs/DeleteJob200Response.md @@ -21,7 +21,9 @@ print(DeleteJob200Response.to_json()) # convert the object into a dict delete_job200_response_dict = delete_job200_response_instance.to_dict() # create an instance of DeleteJob200Response from a dict -delete_job200_response_from_dict = DeleteJob200Response.from_dict(delete_job200_response_dict) +delete_job200_response_from_dict = DeleteJob200Response.from_dict( + delete_job200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/DeleteNotefilesRequest.md b/src/docs/DeleteNotefilesRequest.md index 1bd6e91..6dc7361 100644 --- a/src/docs/DeleteNotefilesRequest.md +++ b/src/docs/DeleteNotefilesRequest.md @@ -21,7 +21,9 @@ print(DeleteNotefilesRequest.to_json()) # convert the object into a dict delete_notefiles_request_dict = delete_notefiles_request_instance.to_dict() # create an instance of DeleteNotefilesRequest from a dict -delete_notefiles_request_from_dict = DeleteNotefilesRequest.from_dict(delete_notefiles_request_dict) +delete_notefiles_request_from_dict = DeleteNotefilesRequest.from_dict( + delete_notefiles_request_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/DeviceApi.md b/src/docs/DeviceApi.md index 45227fc..2b9dc24 100644 --- a/src/docs/DeviceApi.md +++ b/src/docs/DeviceApi.md @@ -50,22 +50,24 @@ from notehub_py.models.note_input import NoteInput from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | - notefile_id = 'notefile_id_example' # str | - note_id = 'note_id_example' # str | - note_input = notehub_py.NoteInput() # NoteInput | Body or payload of note to be added to the device + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | + notefile_id = "notefile_id_example" # str | + note_id = "note_id_example" # str | + note_input = ( + notehub_py.NoteInput() + ) # NoteInput | Body or payload of note to be added to the device try: - api_instance.add_db_note(project_or_product_uid, device_uid, notefile_id, note_id, note_input) + api_instance.add_db_note( + project_or_product_uid, device_uid, notefile_id, note_id, note_input + ) except Exception as e: print("Exception when calling DeviceApi->add_db_note: %s\n" % e) ``` @@ -109,21 +111,23 @@ from notehub_py.models.note_input import NoteInput from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | - notefile_id = 'notefile_id_example' # str | - note_input = notehub_py.NoteInput() # NoteInput | Body or payload of note to be added to the device + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | + notefile_id = "notefile_id_example" # str | + note_input = ( + notehub_py.NoteInput() + ) # NoteInput | Body or payload of note to be added to the device try: - api_instance.add_qi_note(project_or_product_uid, device_uid, notefile_id, note_input) + api_instance.add_qi_note( + project_or_product_uid, device_uid, notefile_id, note_input + ) except Exception as e: print("Exception when calling DeviceApi->add_qi_note: %s\n" % e) ``` @@ -165,17 +169,15 @@ import notehub_py from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | - notefile_id = 'notefile_id_example' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | + notefile_id = "notefile_id_example" # str | try: api_instance.create_notefile(project_or_product_uid, device_uid, notefile_id) @@ -219,16 +221,14 @@ import notehub_py from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | try: api_instance.delete_device(project_or_product_uid, device_uid) @@ -272,24 +272,27 @@ from notehub_py.models.environment_variables import EnvironmentVariables from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | - key = 'key_example' # str | The environment variable key to delete. + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | + key = "key_example" # str | The environment variable key to delete. try: - api_response = api_instance.delete_device_environment_variable(project_or_product_uid, device_uid, key) + api_response = api_instance.delete_device_environment_variable( + project_or_product_uid, device_uid, key + ) print("The response of DeviceApi->delete_device_environment_variable:\n") pprint(api_response) except Exception as e: - print("Exception when calling DeviceApi->delete_device_environment_variable: %s\n" % e) + print( + "Exception when calling DeviceApi->delete_device_environment_variable: %s\n" + % e + ) ``` ### Parameters @@ -328,21 +331,21 @@ import notehub_py from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | - notefile_id = 'notefile_id_example' # str | - note_id = 'note_id_example' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | + notefile_id = "notefile_id_example" # str | + note_id = "note_id_example" # str | try: - api_instance.delete_note(project_or_product_uid, device_uid, notefile_id, note_id) + api_instance.delete_note( + project_or_product_uid, device_uid, notefile_id, note_id + ) except Exception as e: print("Exception when calling DeviceApi->delete_note: %s\n" % e) ``` @@ -385,20 +388,22 @@ from notehub_py.models.delete_notefiles_request import DeleteNotefilesRequest from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | - delete_notefiles_request = notehub_py.DeleteNotefilesRequest() # DeleteNotefilesRequest | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | + delete_notefiles_request = ( + notehub_py.DeleteNotefilesRequest() + ) # DeleteNotefilesRequest | try: - api_instance.delete_notefiles(project_or_product_uid, device_uid, delete_notefiles_request) + api_instance.delete_notefiles( + project_or_product_uid, device_uid, delete_notefiles_request + ) except Exception as e: print("Exception when calling DeviceApi->delete_notefiles: %s\n" % e) ``` @@ -439,16 +444,14 @@ import notehub_py from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | try: api_instance.disable_device(project_or_product_uid, device_uid) @@ -491,16 +494,14 @@ import notehub_py from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | try: api_instance.enable_device(project_or_product_uid, device_uid) @@ -544,23 +545,28 @@ from notehub_py.models.get_db_note200_response import GetDbNote200Response from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | - notefile_id = 'notefile_id_example' # str | - note_id = 'note_id_example' # str | - delete = True # bool | Whether to delete the note from the DB notefile (optional) - deleted = True # bool | Whether to return deleted notes (optional) + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | + notefile_id = "notefile_id_example" # str | + note_id = "note_id_example" # str | + delete = True # bool | Whether to delete the note from the DB notefile (optional) + deleted = True # bool | Whether to return deleted notes (optional) try: - api_response = api_instance.get_db_note(project_or_product_uid, device_uid, notefile_id, note_id, delete=delete, deleted=deleted) + api_response = api_instance.get_db_note( + project_or_product_uid, + device_uid, + notefile_id, + note_id, + delete=delete, + deleted=deleted, + ) print("The response of DeviceApi->get_db_note:\n") pprint(api_response) except Exception as e: @@ -607,16 +613,14 @@ from notehub_py.models.device import Device from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | try: api_response = api_instance.get_device(project_or_product_uid, device_uid) @@ -662,24 +666,27 @@ from notehub_py.models.env_tree_json_node import EnvTreeJsonNode from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | try: # Get environment variable hierarchy for a device - api_response = api_instance.get_device_environment_hierarchy(project_or_product_uid, device_uid) + api_response = api_instance.get_device_environment_hierarchy( + project_or_product_uid, device_uid + ) print("The response of DeviceApi->get_device_environment_hierarchy:\n") pprint(api_response) except Exception as e: - print("Exception when calling DeviceApi->get_device_environment_hierarchy: %s\n" % e) + print( + "Exception when calling DeviceApi->get_device_environment_hierarchy: %s\n" + % e + ) ``` ### Parameters @@ -714,27 +721,32 @@ Get environment variables of a device ```python import notehub_py -from notehub_py.models.get_device_environment_variables_by_pin200_response import GetDeviceEnvironmentVariablesByPin200Response +from notehub_py.models.get_device_environment_variables_by_pin200_response import ( + GetDeviceEnvironmentVariablesByPin200Response, +) from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | try: - api_response = api_instance.get_device_environment_variables(project_or_product_uid, device_uid) + api_response = api_instance.get_device_environment_variables( + project_or_product_uid, device_uid + ) print("The response of DeviceApi->get_device_environment_variables:\n") pprint(api_response) except Exception as e: - print("Exception when calling DeviceApi->get_device_environment_variables: %s\n" % e) + print( + "Exception when calling DeviceApi->get_device_environment_variables: %s\n" + % e + ) ``` ### Parameters @@ -767,7 +779,9 @@ Get environment variables of a device with device pin authorization ```python import notehub_py -from notehub_py.models.get_device_environment_variables_by_pin200_response import GetDeviceEnvironmentVariablesByPin200Response +from notehub_py.models.get_device_environment_variables_by_pin200_response import ( + GetDeviceEnvironmentVariablesByPin200Response, +) from notehub_py.rest import ApiException from pprint import pprint @@ -776,16 +790,23 @@ from pprint import pprint with notehub_py.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = notehub_py.DeviceApi(api_client) - product_uid = 'com.blues.bridge:sensors' # str | - device_uid = 'dev:000000000000000' # str | - x_auth_token = 'x_auth_token_example' # str | For accessing endpoints by Device pin. + product_uid = "com.blues.bridge:sensors" # str | + device_uid = "dev:000000000000000" # str | + x_auth_token = ( + "x_auth_token_example" # str | For accessing endpoints by Device pin. + ) try: - api_response = api_instance.get_device_environment_variables_by_pin(product_uid, device_uid, x_auth_token) + api_response = api_instance.get_device_environment_variables_by_pin( + product_uid, device_uid, x_auth_token + ) print("The response of DeviceApi->get_device_environment_variables_by_pin:\n") pprint(api_response) except Exception as e: - print("Exception when calling DeviceApi->get_device_environment_variables_by_pin: %s\n" % e) + print( + "Exception when calling DeviceApi->get_device_environment_variables_by_pin: %s\n" + % e + ) ``` ### Parameters @@ -821,26 +842,34 @@ Get Device Health Log ```python import notehub_py -from notehub_py.models.get_device_health_log200_response import GetDeviceHealthLog200Response +from notehub_py.models.get_device_health_log200_response import ( + GetDeviceHealthLog200Response, +) from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | - start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) - end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) - log_type = ['log_type_example'] # List[str] | Return only specified log types (optional) + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | + start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) + end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) + log_type = [ + "log_type_example" + ] # List[str] | Return only specified log types (optional) try: - api_response = api_instance.get_device_health_log(project_or_product_uid, device_uid, start_date=start_date, end_date=end_date, log_type=log_type) + api_response = api_instance.get_device_health_log( + project_or_product_uid, + device_uid, + start_date=start_date, + end_date=end_date, + log_type=log_type, + ) print("The response of DeviceApi->get_device_health_log:\n") pprint(api_response) except Exception as e: @@ -882,23 +911,25 @@ Get Device Latest Events ```python import notehub_py -from notehub_py.models.get_device_latest_events200_response import GetDeviceLatestEvents200Response +from notehub_py.models.get_device_latest_events200_response import ( + GetDeviceLatestEvents200Response, +) from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | try: - api_response = api_instance.get_device_latest_events(project_or_product_uid, device_uid) + api_response = api_instance.get_device_latest_events( + project_or_product_uid, device_uid + ) print("The response of DeviceApi->get_device_latest_events:\n") pprint(api_response) except Exception as e: @@ -941,16 +972,14 @@ from notehub_py.models.get_device_plans200_response import GetDevicePlans200Resp from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | try: api_response = api_instance.get_device_plans(project_or_product_uid, device_uid) @@ -992,23 +1021,25 @@ Get Device Public Key ```python import notehub_py -from notehub_py.models.get_device_public_key200_response import GetDevicePublicKey200Response +from notehub_py.models.get_device_public_key200_response import ( + GetDevicePublicKey200Response, +) from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | try: - api_response = api_instance.get_device_public_key(project_or_product_uid, device_uid) + api_response = api_instance.get_device_public_key( + project_or_product_uid, device_uid + ) print("The response of DeviceApi->get_device_public_key:\n") pprint(api_response) except Exception as e: @@ -1047,24 +1078,26 @@ Get Device Public Keys of a Project ```python import notehub_py -from notehub_py.models.get_device_public_keys200_response import GetDevicePublicKeys200Response +from notehub_py.models.get_device_public_keys200_response import ( + GetDevicePublicKeys200Response, +) from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(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) + 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) try: - api_response = api_instance.get_device_public_keys(project_or_product_uid, page_size=page_size, page_num=page_num) + api_response = api_instance.get_device_public_keys( + project_or_product_uid, page_size=page_size, page_num=page_num + ) print("The response of DeviceApi->get_device_public_keys:\n") pprint(api_response) except Exception as e: @@ -1104,28 +1137,36 @@ Get Device Sessions ```python import notehub_py -from notehub_py.models.get_device_sessions200_response import GetDeviceSessions200Response +from notehub_py.models.get_device_sessions200_response import ( + GetDeviceSessions200Response, +) from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | - page_size = 50 # int | (optional) (default to 50) - page_num = 1 # int | (optional) (default to 1) - start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) - end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) - first_sync = False # bool | When true, filters results to only show first sync sessions (optional) (default to False) + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | + page_size = 50 # int | (optional) (default to 50) + page_num = 1 # int | (optional) (default to 1) + start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) + end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) + first_sync = False # bool | When true, filters results to only show first sync sessions (optional) (default to False) try: - api_response = api_instance.get_device_sessions(project_or_product_uid, device_uid, page_size=page_size, page_num=page_num, start_date=start_date, end_date=end_date, first_sync=first_sync) + api_response = api_instance.get_device_sessions( + project_or_product_uid, + device_uid, + page_size=page_size, + page_num=page_num, + start_date=start_date, + end_date=end_date, + first_sync=first_sync, + ) print("The response of DeviceApi->get_device_sessions:\n") pprint(api_response) except Exception as e: @@ -1173,29 +1214,46 @@ from notehub_py.models.get_devices200_response import GetDevices200Response from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(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) - device_uid = ['device_uid_example'] # List[str] | A Device UID. (optional) - tag = ['tag_example'] # List[str] | Tag filter (optional) - serial_number = ['serial_number_example'] # List[str] | Serial number filter (optional) - fleet_uid = ['fleet_uid_example'] # List[str] | (optional) - notecard_firmware = ['notecard_firmware_example'] # List[str] | Firmware version filter (optional) - location = ['location_example'] # List[str] | Location filter (optional) - host_firmware = ['host_firmware_example'] # List[str] | Host firmware filter (optional) - product_uid = ['product_uid_example'] # List[str] | (optional) - sku = ['sku_example'] # List[str] | SKU filter (optional) + 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) + device_uid = ["device_uid_example"] # List[str] | A Device UID. (optional) + tag = ["tag_example"] # List[str] | Tag filter (optional) + serial_number = [ + "serial_number_example" + ] # List[str] | Serial number filter (optional) + fleet_uid = ["fleet_uid_example"] # List[str] | (optional) + notecard_firmware = [ + "notecard_firmware_example" + ] # List[str] | Firmware version filter (optional) + location = ["location_example"] # List[str] | Location filter (optional) + host_firmware = [ + "host_firmware_example" + ] # List[str] | Host firmware filter (optional) + product_uid = ["product_uid_example"] # List[str] | (optional) + sku = ["sku_example"] # List[str] | SKU filter (optional) try: - api_response = api_instance.get_devices(project_or_product_uid, page_size=page_size, page_num=page_num, device_uid=device_uid, tag=tag, serial_number=serial_number, fleet_uid=fleet_uid, notecard_firmware=notecard_firmware, location=location, host_firmware=host_firmware, product_uid=product_uid, sku=sku) + api_response = api_instance.get_devices( + project_or_product_uid, + page_size=page_size, + page_num=page_num, + device_uid=device_uid, + tag=tag, + serial_number=serial_number, + fleet_uid=fleet_uid, + notecard_firmware=notecard_firmware, + location=location, + host_firmware=host_firmware, + product_uid=product_uid, + sku=sku, + ) print("The response of DeviceApi->get_devices:\n") pprint(api_response) except Exception as e: @@ -1248,29 +1306,46 @@ from notehub_py.models.get_devices200_response import GetDevices200Response from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - fleet_uid = 'fleet_uid_example' # str | - page_size = 50 # int | (optional) (default to 50) - page_num = 1 # int | (optional) (default to 1) - device_uid = ['device_uid_example'] # List[str] | A Device UID. (optional) - tag = ['tag_example'] # List[str] | Tag filter (optional) - serial_number = ['serial_number_example'] # List[str] | Serial number filter (optional) - notecard_firmware = ['notecard_firmware_example'] # List[str] | Firmware version filter (optional) - location = ['location_example'] # List[str] | Location filter (optional) - host_firmware = ['host_firmware_example'] # List[str] | Host firmware filter (optional) - product_uid = ['product_uid_example'] # List[str] | (optional) - sku = ['sku_example'] # List[str] | SKU filter (optional) + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + fleet_uid = "fleet_uid_example" # str | + page_size = 50 # int | (optional) (default to 50) + page_num = 1 # int | (optional) (default to 1) + device_uid = ["device_uid_example"] # List[str] | A Device UID. (optional) + tag = ["tag_example"] # List[str] | Tag filter (optional) + serial_number = [ + "serial_number_example" + ] # List[str] | Serial number filter (optional) + notecard_firmware = [ + "notecard_firmware_example" + ] # List[str] | Firmware version filter (optional) + location = ["location_example"] # List[str] | Location filter (optional) + host_firmware = [ + "host_firmware_example" + ] # List[str] | Host firmware filter (optional) + product_uid = ["product_uid_example"] # List[str] | (optional) + sku = ["sku_example"] # List[str] | SKU filter (optional) try: - api_response = api_instance.get_fleet_devices(project_or_product_uid, fleet_uid, page_size=page_size, page_num=page_num, device_uid=device_uid, tag=tag, serial_number=serial_number, notecard_firmware=notecard_firmware, location=location, host_firmware=host_firmware, product_uid=product_uid, sku=sku) + api_response = api_instance.get_fleet_devices( + project_or_product_uid, + fleet_uid, + page_size=page_size, + page_num=page_num, + device_uid=device_uid, + tag=tag, + serial_number=serial_number, + notecard_firmware=notecard_firmware, + location=location, + host_firmware=host_firmware, + product_uid=product_uid, + sku=sku, + ) print("The response of DeviceApi->get_fleet_devices:\n") pprint(api_response) except Exception as e: @@ -1323,23 +1398,28 @@ from notehub_py.models.get_notefile200_response import GetNotefile200Response from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | - notefile_id = 'notefile_id_example' # str | - max = 56 # int | The maximum number of Notes to return in the request. (optional) - deleted = True # bool | true to return deleted notes. (optional) - delete = True # bool | true to delete the notes returned by the request. (optional) + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | + notefile_id = "notefile_id_example" # str | + max = 56 # int | The maximum number of Notes to return in the request. (optional) + deleted = True # bool | true to return deleted notes. (optional) + delete = True # bool | true to delete the notes returned by the request. (optional) try: - api_response = api_instance.get_notefile(project_or_product_uid, device_uid, notefile_id, max=max, deleted=deleted, delete=delete) + api_response = api_instance.get_notefile( + project_or_product_uid, + device_uid, + notefile_id, + max=max, + deleted=deleted, + delete=delete, + ) print("The response of DeviceApi->get_notefile:\n") pprint(api_response) except Exception as e: @@ -1386,21 +1466,25 @@ from notehub_py.models.notefile import Notefile from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | - files = ['files_example'] # List[str] | One or more files to obtain change information from. (optional) - pending = True # bool | show only files that are pending sync to the Notecard (optional) + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | + files = [ + "files_example" + ] # List[str] | One or more files to obtain change information from. (optional) + pending = ( + True # bool | show only files that are pending sync to the Notecard (optional) + ) try: - api_response = api_instance.list_notefiles(project_or_product_uid, device_uid, files=files, pending=pending) + api_response = api_instance.list_notefiles( + project_or_product_uid, device_uid, files=files, pending=pending + ) print("The response of DeviceApi->list_notefiles:\n") pprint(api_response) except Exception as e: @@ -1445,20 +1529,22 @@ from notehub_py.models.provision_device_request import ProvisionDeviceRequest from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | - provision_device_request = notehub_py.ProvisionDeviceRequest() # ProvisionDeviceRequest | Provision a device to a specific ProductUID + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | + provision_device_request = ( + notehub_py.ProvisionDeviceRequest() + ) # ProvisionDeviceRequest | Provision a device to a specific ProductUID try: - api_response = api_instance.provision_device(project_or_product_uid, device_uid, provision_device_request) + api_response = api_instance.provision_device( + project_or_product_uid, device_uid, provision_device_request + ) print("The response of DeviceApi->provision_device:\n") pprint(api_response) except Exception as e: @@ -1502,24 +1588,29 @@ from notehub_py.models.environment_variables import EnvironmentVariables from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | - environment_variables = notehub_py.EnvironmentVariables() # EnvironmentVariables | Environment variables to be added to the device + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | + environment_variables = ( + notehub_py.EnvironmentVariables() + ) # EnvironmentVariables | Environment variables to be added to the device try: - api_response = api_instance.set_device_environment_variables(project_or_product_uid, device_uid, environment_variables) + api_response = api_instance.set_device_environment_variables( + project_or_product_uid, device_uid, environment_variables + ) print("The response of DeviceApi->set_device_environment_variables:\n") pprint(api_response) except Exception as e: - print("Exception when calling DeviceApi->set_device_environment_variables: %s\n" % e) + print( + "Exception when calling DeviceApi->set_device_environment_variables: %s\n" + % e + ) ``` ### Parameters @@ -1562,17 +1653,26 @@ from pprint import pprint with notehub_py.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = notehub_py.DeviceApi(api_client) - product_uid = 'com.blues.bridge:sensors' # str | - device_uid = 'dev:000000000000000' # str | - x_auth_token = 'x_auth_token_example' # str | For accessing endpoints by Device pin. - environment_variables = notehub_py.EnvironmentVariables() # EnvironmentVariables | Environment variables to be added to the device + product_uid = "com.blues.bridge:sensors" # str | + device_uid = "dev:000000000000000" # str | + x_auth_token = ( + "x_auth_token_example" # str | For accessing endpoints by Device pin. + ) + environment_variables = ( + notehub_py.EnvironmentVariables() + ) # EnvironmentVariables | Environment variables to be added to the device try: - api_response = api_instance.set_device_environment_variables_by_pin(product_uid, device_uid, x_auth_token, environment_variables) + api_response = api_instance.set_device_environment_variables_by_pin( + product_uid, device_uid, x_auth_token, environment_variables + ) print("The response of DeviceApi->set_device_environment_variables_by_pin:\n") pprint(api_response) except Exception as e: - print("Exception when calling DeviceApi->set_device_environment_variables_by_pin: %s\n" % e) + print( + "Exception when calling DeviceApi->set_device_environment_variables_by_pin: %s\n" + % e + ) ``` ### Parameters @@ -1614,20 +1714,22 @@ from notehub_py.models.signal_device200_response import SignalDevice200Response from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | - body = notehub_py.Body() # Body | Body or payload of signal to be sent to the device + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | + body = ( + notehub_py.Body() + ) # Body | Body or payload of signal to be sent to the device try: - api_response = api_instance.signal_device(project_or_product_uid, device_uid, body) + api_response = api_instance.signal_device( + project_or_product_uid, device_uid, body + ) print("The response of DeviceApi->signal_device:\n") pprint(api_response) except Exception as e: @@ -1671,22 +1773,24 @@ from notehub_py.models.note_input import NoteInput from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.DeviceApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | - notefile_id = 'notefile_id_example' # str | - note_id = 'note_id_example' # str | - note_input = notehub_py.NoteInput() # NoteInput | Body or payload of note to be added to the device + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | + notefile_id = "notefile_id_example" # str | + note_id = "note_id_example" # str | + note_input = ( + notehub_py.NoteInput() + ) # NoteInput | Body or payload of note to be added to the device try: - api_instance.update_db_note(project_or_product_uid, device_uid, notefile_id, note_id, note_input) + api_instance.update_db_note( + project_or_product_uid, device_uid, notefile_id, note_id, note_input + ) except Exception as e: print("Exception when calling DeviceApi->update_db_note: %s\n" % e) ``` diff --git a/src/docs/DeviceDfuHistoryCurrent.md b/src/docs/DeviceDfuHistoryCurrent.md index b3cd6b0..fe911dc 100644 --- a/src/docs/DeviceDfuHistoryCurrent.md +++ b/src/docs/DeviceDfuHistoryCurrent.md @@ -28,7 +28,9 @@ print(DeviceDfuHistoryCurrent.to_json()) # convert the object into a dict device_dfu_history_current_dict = device_dfu_history_current_instance.to_dict() # create an instance of DeviceDfuHistoryCurrent from a dict -device_dfu_history_current_from_dict = DeviceDfuHistoryCurrent.from_dict(device_dfu_history_current_dict) +device_dfu_history_current_from_dict = DeviceDfuHistoryCurrent.from_dict( + device_dfu_history_current_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/DeviceDfuHistoryPage.md b/src/docs/DeviceDfuHistoryPage.md index 1549952..0553094 100644 --- a/src/docs/DeviceDfuHistoryPage.md +++ b/src/docs/DeviceDfuHistoryPage.md @@ -22,7 +22,9 @@ print(DeviceDfuHistoryPage.to_json()) # convert the object into a dict device_dfu_history_page_dict = device_dfu_history_page_instance.to_dict() # create an instance of DeviceDfuHistoryPage from a dict -device_dfu_history_page_from_dict = DeviceDfuHistoryPage.from_dict(device_dfu_history_page_dict) +device_dfu_history_page_from_dict = DeviceDfuHistoryPage.from_dict( + device_dfu_history_page_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/DeviceDfuStateMachine.md b/src/docs/DeviceDfuStateMachine.md index d9944e9..0223891 100644 --- a/src/docs/DeviceDfuStateMachine.md +++ b/src/docs/DeviceDfuStateMachine.md @@ -26,7 +26,9 @@ print(DeviceDfuStateMachine.to_json()) # convert the object into a dict device_dfu_state_machine_dict = device_dfu_state_machine_instance.to_dict() # create an instance of DeviceDfuStateMachine from a dict -device_dfu_state_machine_from_dict = DeviceDfuStateMachine.from_dict(device_dfu_state_machine_dict) +device_dfu_state_machine_from_dict = DeviceDfuStateMachine.from_dict( + device_dfu_state_machine_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/DeviceDfuStateMachineNode.md b/src/docs/DeviceDfuStateMachineNode.md index 87dc174..0371027 100644 --- a/src/docs/DeviceDfuStateMachineNode.md +++ b/src/docs/DeviceDfuStateMachineNode.md @@ -26,7 +26,9 @@ print(DeviceDfuStateMachineNode.to_json()) # convert the object into a dict device_dfu_state_machine_node_dict = device_dfu_state_machine_node_instance.to_dict() # create an instance of DeviceDfuStateMachineNode from a dict -device_dfu_state_machine_node_from_dict = DeviceDfuStateMachineNode.from_dict(device_dfu_state_machine_node_dict) +device_dfu_state_machine_node_from_dict = DeviceDfuStateMachineNode.from_dict( + device_dfu_state_machine_node_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/DeviceDfuStatusPage.md b/src/docs/DeviceDfuStatusPage.md index 2468a2b..c438cd2 100644 --- a/src/docs/DeviceDfuStatusPage.md +++ b/src/docs/DeviceDfuStatusPage.md @@ -22,7 +22,9 @@ print(DeviceDfuStatusPage.to_json()) # convert the object into a dict device_dfu_status_page_dict = device_dfu_status_page_instance.to_dict() # create an instance of DeviceDfuStatusPage from a dict -device_dfu_status_page_from_dict = DeviceDfuStatusPage.from_dict(device_dfu_status_page_dict) +device_dfu_status_page_from_dict = DeviceDfuStatusPage.from_dict( + device_dfu_status_page_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/EnvironmentVariables.md b/src/docs/EnvironmentVariables.md index fddacf2..56f2d71 100644 --- a/src/docs/EnvironmentVariables.md +++ b/src/docs/EnvironmentVariables.md @@ -21,7 +21,9 @@ print(EnvironmentVariables.to_json()) # convert the object into a dict environment_variables_dict = environment_variables_instance.to_dict() # create an instance of EnvironmentVariables from a dict -environment_variables_from_dict = EnvironmentVariables.from_dict(environment_variables_dict) +environment_variables_from_dict = EnvironmentVariables.from_dict( + environment_variables_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/EventApi.md b/src/docs/EventApi.md index 69e5658..7115234 100644 --- a/src/docs/EventApi.md +++ b/src/docs/EventApi.md @@ -26,34 +26,56 @@ from notehub_py.models.get_events200_response import GetEvents200Response from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.EventApi(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) - device_uid = ['device_uid_example'] # List[str] | A Device UID. (optional) - sort_by = 'captured' # str | (optional) (default to 'captured') - sort_order = 'asc' # str | (optional) (default to 'asc') - start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) - end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) - date_type = 'captured' # str | Which date to filter on, either 'captured' or 'uploaded'. This will apply to the startDate and endDate parameters (optional) (default to 'captured') - system_files_only = True # bool | (optional) - files = '_health.qo, data.qo' # str | (optional) - format = 'json' # str | Response format (JSON or CSV) (optional) (default to 'json') - serial_number = ['serial_number_example'] # List[str] | Filter by Serial Number (optional) - fleet_uid = ['fleet_uid_example'] # List[str] | Filter by Fleet UID (optional) - session_uid = ['session_uid_example'] # List[str] | Filter by Session UID (optional) - event_uid = ['event_uid_example'] # List[str] | Filter by Event UID (optional) - select_fields = 'select_fields_example' # str | Comma-separated list of fields to select from JSON payload (e.g., \"field1,field2.subfield,field3\"), this will reflect the columns in the CSV output. (optional) + 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) + device_uid = ["device_uid_example"] # List[str] | A Device UID. (optional) + sort_by = "captured" # str | (optional) (default to 'captured') + sort_order = "asc" # str | (optional) (default to 'asc') + start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) + end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) + date_type = "captured" # str | Which date to filter on, either 'captured' or 'uploaded'. This will apply to the startDate and endDate parameters (optional) (default to 'captured') + system_files_only = True # bool | (optional) + files = "_health.qo, data.qo" # str | (optional) + format = ( + "json" # str | Response format (JSON or CSV) (optional) (default to 'json') + ) + serial_number = [ + "serial_number_example" + ] # List[str] | Filter by Serial Number (optional) + fleet_uid = ["fleet_uid_example"] # List[str] | Filter by Fleet UID (optional) + session_uid = [ + "session_uid_example" + ] # List[str] | Filter by Session UID (optional) + event_uid = ["event_uid_example"] # List[str] | Filter by Event UID (optional) + select_fields = "select_fields_example" # str | Comma-separated list of fields to select from JSON payload (e.g., \"field1,field2.subfield,field3\"), this will reflect the columns in the CSV output. (optional) try: - api_response = api_instance.get_events(project_or_product_uid, page_size=page_size, page_num=page_num, device_uid=device_uid, sort_by=sort_by, sort_order=sort_order, start_date=start_date, end_date=end_date, date_type=date_type, system_files_only=system_files_only, files=files, format=format, serial_number=serial_number, fleet_uid=fleet_uid, session_uid=session_uid, event_uid=event_uid, select_fields=select_fields) + api_response = api_instance.get_events( + project_or_product_uid, + page_size=page_size, + page_num=page_num, + device_uid=device_uid, + sort_by=sort_by, + sort_order=sort_order, + start_date=start_date, + end_date=end_date, + date_type=date_type, + system_files_only=system_files_only, + files=files, + format=format, + serial_number=serial_number, + fleet_uid=fleet_uid, + session_uid=session_uid, + event_uid=event_uid, + select_fields=select_fields, + ) print("The response of EventApi->get_events:\n") pprint(api_response) except Exception as e: @@ -107,29 +129,38 @@ Get Events of a Project by cursor ```python import notehub_py -from notehub_py.models.get_events_by_cursor200_response import GetEventsByCursor200Response +from notehub_py.models.get_events_by_cursor200_response import ( + GetEventsByCursor200Response, +) from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.EventApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - limit = 50 # int | (optional) (default to 50) - cursor = 'cursor_example' # str | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. (optional) - sort_order = 'asc' # str | (optional) (default to 'asc') - system_files_only = True # bool | (optional) - files = '_health.qo, data.qo' # str | (optional) - fleet_uid = 'fleet_uid_example' # str | (optional) - device_uid = ['device_uid_example'] # List[str] | A Device UID. (optional) + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + limit = 50 # int | (optional) (default to 50) + cursor = "cursor_example" # str | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. (optional) + sort_order = "asc" # str | (optional) (default to 'asc') + system_files_only = True # bool | (optional) + files = "_health.qo, data.qo" # str | (optional) + fleet_uid = "fleet_uid_example" # str | (optional) + device_uid = ["device_uid_example"] # List[str] | A Device UID. (optional) try: - api_response = api_instance.get_events_by_cursor(project_or_product_uid, limit=limit, cursor=cursor, sort_order=sort_order, system_files_only=system_files_only, files=files, fleet_uid=fleet_uid, device_uid=device_uid) + api_response = api_instance.get_events_by_cursor( + project_or_product_uid, + limit=limit, + cursor=cursor, + sort_order=sort_order, + system_files_only=system_files_only, + files=files, + fleet_uid=fleet_uid, + device_uid=device_uid, + ) print("The response of EventApi->get_events_by_cursor:\n") pprint(api_response) except Exception as e: @@ -178,34 +209,56 @@ from notehub_py.models.get_events200_response import GetEvents200Response from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.EventApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - fleet_uid = 'fleet_uid_example' # str | - page_size = 50 # int | (optional) (default to 50) - page_num = 1 # int | (optional) (default to 1) - device_uid = ['device_uid_example'] # List[str] | A Device UID. (optional) - sort_by = 'captured' # str | (optional) (default to 'captured') - sort_order = 'asc' # str | (optional) (default to 'asc') - start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) - end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) - date_type = 'captured' # str | Which date to filter on, either 'captured' or 'uploaded'. This will apply to the startDate and endDate parameters (optional) (default to 'captured') - system_files_only = True # bool | (optional) - files = '_health.qo, data.qo' # str | (optional) - format = 'json' # str | Response format (JSON or CSV) (optional) (default to 'json') - serial_number = ['serial_number_example'] # List[str] | Filter by Serial Number (optional) - session_uid = ['session_uid_example'] # List[str] | Filter by Session UID (optional) - event_uid = ['event_uid_example'] # List[str] | Filter by Event UID (optional) - select_fields = 'select_fields_example' # str | Comma-separated list of fields to select from JSON payload (e.g., \"field1,field2.subfield,field3\"), this will reflect the columns in the CSV output. (optional) + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + fleet_uid = "fleet_uid_example" # str | + page_size = 50 # int | (optional) (default to 50) + page_num = 1 # int | (optional) (default to 1) + device_uid = ["device_uid_example"] # List[str] | A Device UID. (optional) + sort_by = "captured" # str | (optional) (default to 'captured') + sort_order = "asc" # str | (optional) (default to 'asc') + start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) + end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) + date_type = "captured" # str | Which date to filter on, either 'captured' or 'uploaded'. This will apply to the startDate and endDate parameters (optional) (default to 'captured') + system_files_only = True # bool | (optional) + files = "_health.qo, data.qo" # str | (optional) + format = ( + "json" # str | Response format (JSON or CSV) (optional) (default to 'json') + ) + serial_number = [ + "serial_number_example" + ] # List[str] | Filter by Serial Number (optional) + session_uid = [ + "session_uid_example" + ] # List[str] | Filter by Session UID (optional) + event_uid = ["event_uid_example"] # List[str] | Filter by Event UID (optional) + select_fields = "select_fields_example" # str | Comma-separated list of fields to select from JSON payload (e.g., \"field1,field2.subfield,field3\"), this will reflect the columns in the CSV output. (optional) try: - api_response = api_instance.get_fleet_events(project_or_product_uid, fleet_uid, page_size=page_size, page_num=page_num, device_uid=device_uid, sort_by=sort_by, sort_order=sort_order, start_date=start_date, end_date=end_date, date_type=date_type, system_files_only=system_files_only, files=files, format=format, serial_number=serial_number, session_uid=session_uid, event_uid=event_uid, select_fields=select_fields) + api_response = api_instance.get_fleet_events( + project_or_product_uid, + fleet_uid, + page_size=page_size, + page_num=page_num, + device_uid=device_uid, + sort_by=sort_by, + sort_order=sort_order, + start_date=start_date, + end_date=end_date, + date_type=date_type, + system_files_only=system_files_only, + files=files, + format=format, + serial_number=serial_number, + session_uid=session_uid, + event_uid=event_uid, + select_fields=select_fields, + ) print("The response of EventApi->get_fleet_events:\n") pprint(api_response) except Exception as e: @@ -259,31 +312,42 @@ Get Events of a Fleet by cursor ```python import notehub_py -from notehub_py.models.get_events_by_cursor200_response import GetEventsByCursor200Response +from notehub_py.models.get_events_by_cursor200_response import ( + GetEventsByCursor200Response, +) from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.EventApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - fleet_uid = 'fleet_uid_example' # str | - limit = 50 # int | (optional) (default to 50) - cursor = 'cursor_example' # str | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. (optional) - sort_order = 'asc' # str | (optional) (default to 'asc') - system_files_only = True # bool | (optional) - files = '_health.qo, data.qo' # str | (optional) - device_uid = ['device_uid_example'] # List[str] | A Device UID. (optional) - start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) - end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + fleet_uid = "fleet_uid_example" # str | + limit = 50 # int | (optional) (default to 50) + cursor = "cursor_example" # str | A cursor, which can be obtained from the `next_cursor` value from a previous call to this endpoint. The results set returned will include this event as its first result if the given identifier is actually the UID of an event. If this event UID is not found, the parameter is ignored and the results set is the same as if the parameter was not included. (optional) + sort_order = "asc" # str | (optional) (default to 'asc') + system_files_only = True # bool | (optional) + files = "_health.qo, data.qo" # str | (optional) + device_uid = ["device_uid_example"] # List[str] | A Device UID. (optional) + start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) + end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) try: - api_response = api_instance.get_fleet_events_by_cursor(project_or_product_uid, fleet_uid, limit=limit, cursor=cursor, sort_order=sort_order, system_files_only=system_files_only, files=files, device_uid=device_uid, start_date=start_date, end_date=end_date) + api_response = api_instance.get_fleet_events_by_cursor( + project_or_product_uid, + fleet_uid, + limit=limit, + cursor=cursor, + sort_order=sort_order, + system_files_only=system_files_only, + files=files, + device_uid=device_uid, + start_date=start_date, + end_date=end_date, + ) print("The response of EventApi->get_fleet_events_by_cursor:\n") pprint(api_response) except Exception as e: @@ -334,19 +398,19 @@ from notehub_py.models.route_log import RouteLog from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.EventApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - event_uid = '4506f411-dea6-44a0-9743-1130f57d7747' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + event_uid = "4506f411-dea6-44a0-9743-1130f57d7747" # str | try: - api_response = api_instance.get_route_logs_by_event(project_or_product_uid, event_uid) + api_response = api_instance.get_route_logs_by_event( + project_or_product_uid, event_uid + ) print("The response of EventApi->get_route_logs_by_event:\n") pprint(api_response) except Exception as e: diff --git a/src/docs/ExternalDevicesApi.md b/src/docs/ExternalDevicesApi.md index 85856aa..ceb68ef 100644 --- a/src/docs/ExternalDevicesApi.md +++ b/src/docs/ExternalDevicesApi.md @@ -24,22 +24,23 @@ from notehub_py.models.event import Event from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ExternalDevicesApi(api_client) - product_uid = 'com.blues.bridge:sensors' # str | - device_uid = 'dev:000000000000000' # str | - event = notehub_py.Event() # Event | Event Object + product_uid = "com.blues.bridge:sensors" # str | + device_uid = "dev:000000000000000" # str | + event = notehub_py.Event() # Event | Event Object try: api_instance.create_event_ext_device(product_uid, device_uid, event) except Exception as e: - print("Exception when calling ExternalDevicesApi->create_event_ext_device: %s\n" % e) + print( + "Exception when calling ExternalDevicesApi->create_event_ext_device: %s\n" + % e + ) ``` ### Parameters @@ -79,22 +80,23 @@ from notehub_py.models.device_session import DeviceSession from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ExternalDevicesApi(api_client) - product_uid = 'com.blues.bridge:sensors' # str | - device_uid = 'dev:000000000000000' # str | - device_session = notehub_py.DeviceSession() # DeviceSession | Session Object + product_uid = "com.blues.bridge:sensors" # str | + device_uid = "dev:000000000000000" # str | + device_session = notehub_py.DeviceSession() # DeviceSession | Session Object try: api_instance.ext_device_session_close(product_uid, device_uid, device_session) except Exception as e: - print("Exception when calling ExternalDevicesApi->ext_device_session_close: %s\n" % e) + print( + "Exception when calling ExternalDevicesApi->ext_device_session_close: %s\n" + % e + ) ``` ### Parameters @@ -134,22 +136,23 @@ from notehub_py.models.device_session import DeviceSession from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ExternalDevicesApi(api_client) - product_uid = 'com.blues.bridge:sensors' # str | - device_uid = 'dev:000000000000000' # str | - device_session = notehub_py.DeviceSession() # DeviceSession | Session Object + product_uid = "com.blues.bridge:sensors" # str | + device_uid = "dev:000000000000000" # str | + device_session = notehub_py.DeviceSession() # DeviceSession | Session Object try: api_instance.ext_device_session_open(product_uid, device_uid, device_session) except Exception as e: - print("Exception when calling ExternalDevicesApi->ext_device_session_open: %s\n" % e) + print( + "Exception when calling ExternalDevicesApi->ext_device_session_open: %s\n" + % e + ) ``` ### Parameters diff --git a/src/docs/FleetConnectivityAssurance.md b/src/docs/FleetConnectivityAssurance.md index 1896a1d..7d1156f 100644 --- a/src/docs/FleetConnectivityAssurance.md +++ b/src/docs/FleetConnectivityAssurance.md @@ -21,7 +21,9 @@ print(FleetConnectivityAssurance.to_json()) # convert the object into a dict fleet_connectivity_assurance_dict = fleet_connectivity_assurance_instance.to_dict() # create an instance of FleetConnectivityAssurance from a dict -fleet_connectivity_assurance_from_dict = FleetConnectivityAssurance.from_dict(fleet_connectivity_assurance_dict) +fleet_connectivity_assurance_from_dict = FleetConnectivityAssurance.from_dict( + fleet_connectivity_assurance_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetAlerts200Response.md b/src/docs/GetAlerts200Response.md index dc57662..ca91a7b 100644 --- a/src/docs/GetAlerts200Response.md +++ b/src/docs/GetAlerts200Response.md @@ -22,7 +22,9 @@ print(GetAlerts200Response.to_json()) # convert the object into a dict get_alerts200_response_dict = get_alerts200_response_instance.to_dict() # create an instance of GetAlerts200Response from a dict -get_alerts200_response_from_dict = GetAlerts200Response.from_dict(get_alerts200_response_dict) +get_alerts200_response_from_dict = GetAlerts200Response.from_dict( + get_alerts200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetBillingAccount200Response.md b/src/docs/GetBillingAccount200Response.md index 883de2c..110d627 100644 --- a/src/docs/GetBillingAccount200Response.md +++ b/src/docs/GetBillingAccount200Response.md @@ -13,7 +13,9 @@ ## Example ```python -from notehub_py.models.get_billing_account200_response import GetBillingAccount200Response +from notehub_py.models.get_billing_account200_response import ( + GetBillingAccount200Response, +) # TODO update the JSON string below json = "{}" @@ -23,9 +25,13 @@ get_billing_account200_response_instance = GetBillingAccount200Response.from_jso print(GetBillingAccount200Response.to_json()) # convert the object into a dict -get_billing_account200_response_dict = get_billing_account200_response_instance.to_dict() +get_billing_account200_response_dict = ( + get_billing_account200_response_instance.to_dict() +) # create an instance of GetBillingAccount200Response from a dict -get_billing_account200_response_from_dict = GetBillingAccount200Response.from_dict(get_billing_account200_response_dict) +get_billing_account200_response_from_dict = GetBillingAccount200Response.from_dict( + get_billing_account200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetBillingAccount200ResponsePlan.md b/src/docs/GetBillingAccount200ResponsePlan.md index 8ff8279..1728769 100644 --- a/src/docs/GetBillingAccount200ResponsePlan.md +++ b/src/docs/GetBillingAccount200ResponsePlan.md @@ -13,19 +13,29 @@ ## Example ```python -from notehub_py.models.get_billing_account200_response_plan import GetBillingAccount200ResponsePlan +from notehub_py.models.get_billing_account200_response_plan import ( + GetBillingAccount200ResponsePlan, +) # TODO update the JSON string below json = "{}" # create an instance of GetBillingAccount200ResponsePlan from a JSON string -get_billing_account200_response_plan_instance = GetBillingAccount200ResponsePlan.from_json(json) +get_billing_account200_response_plan_instance = ( + GetBillingAccount200ResponsePlan.from_json(json) +) # print the JSON string representation of the object print(GetBillingAccount200ResponsePlan.to_json()) # convert the object into a dict -get_billing_account200_response_plan_dict = get_billing_account200_response_plan_instance.to_dict() +get_billing_account200_response_plan_dict = ( + get_billing_account200_response_plan_instance.to_dict() +) # create an instance of GetBillingAccount200ResponsePlan from a dict -get_billing_account200_response_plan_from_dict = GetBillingAccount200ResponsePlan.from_dict(get_billing_account200_response_plan_dict) +get_billing_account200_response_plan_from_dict = ( + GetBillingAccount200ResponsePlan.from_dict( + get_billing_account200_response_plan_dict + ) +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetBillingAccountBalanceHistory200Response.md b/src/docs/GetBillingAccountBalanceHistory200Response.md index 4f1a630..1242ab1 100644 --- a/src/docs/GetBillingAccountBalanceHistory200Response.md +++ b/src/docs/GetBillingAccountBalanceHistory200Response.md @@ -9,19 +9,29 @@ ## Example ```python -from notehub_py.models.get_billing_account_balance_history200_response import GetBillingAccountBalanceHistory200Response +from notehub_py.models.get_billing_account_balance_history200_response import ( + GetBillingAccountBalanceHistory200Response, +) # TODO update the JSON string below json = "{}" # create an instance of GetBillingAccountBalanceHistory200Response from a JSON string -get_billing_account_balance_history200_response_instance = GetBillingAccountBalanceHistory200Response.from_json(json) +get_billing_account_balance_history200_response_instance = ( + GetBillingAccountBalanceHistory200Response.from_json(json) +) # print the JSON string representation of the object print(GetBillingAccountBalanceHistory200Response.to_json()) # convert the object into a dict -get_billing_account_balance_history200_response_dict = get_billing_account_balance_history200_response_instance.to_dict() +get_billing_account_balance_history200_response_dict = ( + get_billing_account_balance_history200_response_instance.to_dict() +) # create an instance of GetBillingAccountBalanceHistory200Response from a dict -get_billing_account_balance_history200_response_from_dict = GetBillingAccountBalanceHistory200Response.from_dict(get_billing_account_balance_history200_response_dict) +get_billing_account_balance_history200_response_from_dict = ( + GetBillingAccountBalanceHistory200Response.from_dict( + get_billing_account_balance_history200_response_dict + ) +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetBillingAccountBalanceHistory200ResponseDataInner.md b/src/docs/GetBillingAccountBalanceHistory200ResponseDataInner.md index eb16cd5..0b9e8e1 100644 --- a/src/docs/GetBillingAccountBalanceHistory200ResponseDataInner.md +++ b/src/docs/GetBillingAccountBalanceHistory200ResponseDataInner.md @@ -11,19 +11,29 @@ ## Example ```python -from notehub_py.models.get_billing_account_balance_history200_response_data_inner import GetBillingAccountBalanceHistory200ResponseDataInner +from notehub_py.models.get_billing_account_balance_history200_response_data_inner import ( + GetBillingAccountBalanceHistory200ResponseDataInner, +) # TODO update the JSON string below json = "{}" # create an instance of GetBillingAccountBalanceHistory200ResponseDataInner from a JSON string -get_billing_account_balance_history200_response_data_inner_instance = GetBillingAccountBalanceHistory200ResponseDataInner.from_json(json) +get_billing_account_balance_history200_response_data_inner_instance = ( + GetBillingAccountBalanceHistory200ResponseDataInner.from_json(json) +) # print the JSON string representation of the object print(GetBillingAccountBalanceHistory200ResponseDataInner.to_json()) # convert the object into a dict -get_billing_account_balance_history200_response_data_inner_dict = get_billing_account_balance_history200_response_data_inner_instance.to_dict() +get_billing_account_balance_history200_response_data_inner_dict = ( + get_billing_account_balance_history200_response_data_inner_instance.to_dict() +) # create an instance of GetBillingAccountBalanceHistory200ResponseDataInner from a dict -get_billing_account_balance_history200_response_data_inner_from_dict = GetBillingAccountBalanceHistory200ResponseDataInner.from_dict(get_billing_account_balance_history200_response_data_inner_dict) +get_billing_account_balance_history200_response_data_inner_from_dict = ( + GetBillingAccountBalanceHistory200ResponseDataInner.from_dict( + get_billing_account_balance_history200_response_data_inner_dict + ) +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetBillingAccounts200Response.md b/src/docs/GetBillingAccounts200Response.md index 6effbc4..ac1c6ee 100644 --- a/src/docs/GetBillingAccounts200Response.md +++ b/src/docs/GetBillingAccounts200Response.md @@ -9,19 +9,27 @@ ## Example ```python -from notehub_py.models.get_billing_accounts200_response import GetBillingAccounts200Response +from notehub_py.models.get_billing_accounts200_response import ( + GetBillingAccounts200Response, +) # TODO update the JSON string below json = "{}" # create an instance of GetBillingAccounts200Response from a JSON string -get_billing_accounts200_response_instance = GetBillingAccounts200Response.from_json(json) +get_billing_accounts200_response_instance = GetBillingAccounts200Response.from_json( + json +) # print the JSON string representation of the object print(GetBillingAccounts200Response.to_json()) # convert the object into a dict -get_billing_accounts200_response_dict = get_billing_accounts200_response_instance.to_dict() +get_billing_accounts200_response_dict = ( + get_billing_accounts200_response_instance.to_dict() +) # create an instance of GetBillingAccounts200Response from a dict -get_billing_accounts200_response_from_dict = GetBillingAccounts200Response.from_dict(get_billing_accounts200_response_dict) +get_billing_accounts200_response_from_dict = GetBillingAccounts200Response.from_dict( + get_billing_accounts200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetDataUsage200Response.md b/src/docs/GetDataUsage200Response.md index 245bf93..5e70c86 100644 --- a/src/docs/GetDataUsage200Response.md +++ b/src/docs/GetDataUsage200Response.md @@ -22,7 +22,9 @@ print(GetDataUsage200Response.to_json()) # convert the object into a dict get_data_usage200_response_dict = get_data_usage200_response_instance.to_dict() # create an instance of GetDataUsage200Response from a dict -get_data_usage200_response_from_dict = GetDataUsage200Response.from_dict(get_data_usage200_response_dict) +get_data_usage200_response_from_dict = GetDataUsage200Response.from_dict( + get_data_usage200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetDataUsage200ResponseDataInner.md b/src/docs/GetDataUsage200ResponseDataInner.md index d9749e2..760e84c 100644 --- a/src/docs/GetDataUsage200ResponseDataInner.md +++ b/src/docs/GetDataUsage200ResponseDataInner.md @@ -15,19 +15,29 @@ ## Example ```python -from notehub_py.models.get_data_usage200_response_data_inner import GetDataUsage200ResponseDataInner +from notehub_py.models.get_data_usage200_response_data_inner import ( + GetDataUsage200ResponseDataInner, +) # TODO update the JSON string below json = "{}" # create an instance of GetDataUsage200ResponseDataInner from a JSON string -get_data_usage200_response_data_inner_instance = GetDataUsage200ResponseDataInner.from_json(json) +get_data_usage200_response_data_inner_instance = ( + GetDataUsage200ResponseDataInner.from_json(json) +) # print the JSON string representation of the object print(GetDataUsage200ResponseDataInner.to_json()) # convert the object into a dict -get_data_usage200_response_data_inner_dict = get_data_usage200_response_data_inner_instance.to_dict() +get_data_usage200_response_data_inner_dict = ( + get_data_usage200_response_data_inner_instance.to_dict() +) # create an instance of GetDataUsage200ResponseDataInner from a dict -get_data_usage200_response_data_inner_from_dict = GetDataUsage200ResponseDataInner.from_dict(get_data_usage200_response_data_inner_dict) +get_data_usage200_response_data_inner_from_dict = ( + GetDataUsage200ResponseDataInner.from_dict( + get_data_usage200_response_data_inner_dict + ) +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetDbNote200Response.md b/src/docs/GetDbNote200Response.md index cd1a424..9b001e5 100644 --- a/src/docs/GetDbNote200Response.md +++ b/src/docs/GetDbNote200Response.md @@ -23,7 +23,9 @@ print(GetDbNote200Response.to_json()) # convert the object into a dict get_db_note200_response_dict = get_db_note200_response_instance.to_dict() # create an instance of GetDbNote200Response from a dict -get_db_note200_response_from_dict = GetDbNote200Response.from_dict(get_db_note200_response_dict) +get_db_note200_response_from_dict = GetDbNote200Response.from_dict( + get_db_note200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetDeviceEnvironmentVariablesByPin200Response.md b/src/docs/GetDeviceEnvironmentVariablesByPin200Response.md index a3ea3f4..41f1a96 100644 --- a/src/docs/GetDeviceEnvironmentVariablesByPin200Response.md +++ b/src/docs/GetDeviceEnvironmentVariablesByPin200Response.md @@ -11,19 +11,29 @@ ## Example ```python -from notehub_py.models.get_device_environment_variables_by_pin200_response import GetDeviceEnvironmentVariablesByPin200Response +from notehub_py.models.get_device_environment_variables_by_pin200_response import ( + GetDeviceEnvironmentVariablesByPin200Response, +) # TODO update the JSON string below json = "{}" # create an instance of GetDeviceEnvironmentVariablesByPin200Response from a JSON string -get_device_environment_variables_by_pin200_response_instance = GetDeviceEnvironmentVariablesByPin200Response.from_json(json) +get_device_environment_variables_by_pin200_response_instance = ( + GetDeviceEnvironmentVariablesByPin200Response.from_json(json) +) # print the JSON string representation of the object print(GetDeviceEnvironmentVariablesByPin200Response.to_json()) # convert the object into a dict -get_device_environment_variables_by_pin200_response_dict = get_device_environment_variables_by_pin200_response_instance.to_dict() +get_device_environment_variables_by_pin200_response_dict = ( + get_device_environment_variables_by_pin200_response_instance.to_dict() +) # create an instance of GetDeviceEnvironmentVariablesByPin200Response from a dict -get_device_environment_variables_by_pin200_response_from_dict = GetDeviceEnvironmentVariablesByPin200Response.from_dict(get_device_environment_variables_by_pin200_response_dict) +get_device_environment_variables_by_pin200_response_from_dict = ( + GetDeviceEnvironmentVariablesByPin200Response.from_dict( + get_device_environment_variables_by_pin200_response_dict + ) +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetDeviceFleets200Response.md b/src/docs/GetDeviceFleets200Response.md index 20fb291..a0ee53d 100644 --- a/src/docs/GetDeviceFleets200Response.md +++ b/src/docs/GetDeviceFleets200Response.md @@ -21,7 +21,9 @@ print(GetDeviceFleets200Response.to_json()) # convert the object into a dict get_device_fleets200_response_dict = get_device_fleets200_response_instance.to_dict() # create an instance of GetDeviceFleets200Response from a dict -get_device_fleets200_response_from_dict = GetDeviceFleets200Response.from_dict(get_device_fleets200_response_dict) +get_device_fleets200_response_from_dict = GetDeviceFleets200Response.from_dict( + get_device_fleets200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetDeviceHealthLog200Response.md b/src/docs/GetDeviceHealthLog200Response.md index 7dc0dbc..7c2ef73 100644 --- a/src/docs/GetDeviceHealthLog200Response.md +++ b/src/docs/GetDeviceHealthLog200Response.md @@ -9,19 +9,27 @@ ## Example ```python -from notehub_py.models.get_device_health_log200_response import GetDeviceHealthLog200Response +from notehub_py.models.get_device_health_log200_response import ( + GetDeviceHealthLog200Response, +) # TODO update the JSON string below json = "{}" # create an instance of GetDeviceHealthLog200Response from a JSON string -get_device_health_log200_response_instance = GetDeviceHealthLog200Response.from_json(json) +get_device_health_log200_response_instance = GetDeviceHealthLog200Response.from_json( + json +) # print the JSON string representation of the object print(GetDeviceHealthLog200Response.to_json()) # convert the object into a dict -get_device_health_log200_response_dict = get_device_health_log200_response_instance.to_dict() +get_device_health_log200_response_dict = ( + get_device_health_log200_response_instance.to_dict() +) # create an instance of GetDeviceHealthLog200Response from a dict -get_device_health_log200_response_from_dict = GetDeviceHealthLog200Response.from_dict(get_device_health_log200_response_dict) +get_device_health_log200_response_from_dict = GetDeviceHealthLog200Response.from_dict( + get_device_health_log200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetDeviceHealthLog200ResponseHealthLogInner.md b/src/docs/GetDeviceHealthLog200ResponseHealthLogInner.md index 22bdc93..2b30071 100644 --- a/src/docs/GetDeviceHealthLog200ResponseHealthLogInner.md +++ b/src/docs/GetDeviceHealthLog200ResponseHealthLogInner.md @@ -11,19 +11,29 @@ ## Example ```python -from notehub_py.models.get_device_health_log200_response_health_log_inner import GetDeviceHealthLog200ResponseHealthLogInner +from notehub_py.models.get_device_health_log200_response_health_log_inner import ( + GetDeviceHealthLog200ResponseHealthLogInner, +) # TODO update the JSON string below json = "{}" # create an instance of GetDeviceHealthLog200ResponseHealthLogInner from a JSON string -get_device_health_log200_response_health_log_inner_instance = GetDeviceHealthLog200ResponseHealthLogInner.from_json(json) +get_device_health_log200_response_health_log_inner_instance = ( + GetDeviceHealthLog200ResponseHealthLogInner.from_json(json) +) # print the JSON string representation of the object print(GetDeviceHealthLog200ResponseHealthLogInner.to_json()) # convert the object into a dict -get_device_health_log200_response_health_log_inner_dict = get_device_health_log200_response_health_log_inner_instance.to_dict() +get_device_health_log200_response_health_log_inner_dict = ( + get_device_health_log200_response_health_log_inner_instance.to_dict() +) # create an instance of GetDeviceHealthLog200ResponseHealthLogInner from a dict -get_device_health_log200_response_health_log_inner_from_dict = GetDeviceHealthLog200ResponseHealthLogInner.from_dict(get_device_health_log200_response_health_log_inner_dict) +get_device_health_log200_response_health_log_inner_from_dict = ( + GetDeviceHealthLog200ResponseHealthLogInner.from_dict( + get_device_health_log200_response_health_log_inner_dict + ) +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetDeviceLatestEvents200Response.md b/src/docs/GetDeviceLatestEvents200Response.md index bbad035..983117b 100644 --- a/src/docs/GetDeviceLatestEvents200Response.md +++ b/src/docs/GetDeviceLatestEvents200Response.md @@ -9,19 +9,29 @@ ## Example ```python -from notehub_py.models.get_device_latest_events200_response import GetDeviceLatestEvents200Response +from notehub_py.models.get_device_latest_events200_response import ( + GetDeviceLatestEvents200Response, +) # TODO update the JSON string below json = "{}" # create an instance of GetDeviceLatestEvents200Response from a JSON string -get_device_latest_events200_response_instance = GetDeviceLatestEvents200Response.from_json(json) +get_device_latest_events200_response_instance = ( + GetDeviceLatestEvents200Response.from_json(json) +) # print the JSON string representation of the object print(GetDeviceLatestEvents200Response.to_json()) # convert the object into a dict -get_device_latest_events200_response_dict = get_device_latest_events200_response_instance.to_dict() +get_device_latest_events200_response_dict = ( + get_device_latest_events200_response_instance.to_dict() +) # create an instance of GetDeviceLatestEvents200Response from a dict -get_device_latest_events200_response_from_dict = GetDeviceLatestEvents200Response.from_dict(get_device_latest_events200_response_dict) +get_device_latest_events200_response_from_dict = ( + GetDeviceLatestEvents200Response.from_dict( + get_device_latest_events200_response_dict + ) +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetDevicePlans200Response.md b/src/docs/GetDevicePlans200Response.md index 0b264e5..554c9e6 100644 --- a/src/docs/GetDevicePlans200Response.md +++ b/src/docs/GetDevicePlans200Response.md @@ -21,7 +21,9 @@ print(GetDevicePlans200Response.to_json()) # convert the object into a dict get_device_plans200_response_dict = get_device_plans200_response_instance.to_dict() # create an instance of GetDevicePlans200Response from a dict -get_device_plans200_response_from_dict = GetDevicePlans200Response.from_dict(get_device_plans200_response_dict) +get_device_plans200_response_from_dict = GetDevicePlans200Response.from_dict( + get_device_plans200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetDevicePublicKey200Response.md b/src/docs/GetDevicePublicKey200Response.md index 16fb9f7..9d1d284 100644 --- a/src/docs/GetDevicePublicKey200Response.md +++ b/src/docs/GetDevicePublicKey200Response.md @@ -10,19 +10,27 @@ ## Example ```python -from notehub_py.models.get_device_public_key200_response import GetDevicePublicKey200Response +from notehub_py.models.get_device_public_key200_response import ( + GetDevicePublicKey200Response, +) # TODO update the JSON string below json = "{}" # create an instance of GetDevicePublicKey200Response from a JSON string -get_device_public_key200_response_instance = GetDevicePublicKey200Response.from_json(json) +get_device_public_key200_response_instance = GetDevicePublicKey200Response.from_json( + json +) # print the JSON string representation of the object print(GetDevicePublicKey200Response.to_json()) # convert the object into a dict -get_device_public_key200_response_dict = get_device_public_key200_response_instance.to_dict() +get_device_public_key200_response_dict = ( + get_device_public_key200_response_instance.to_dict() +) # create an instance of GetDevicePublicKey200Response from a dict -get_device_public_key200_response_from_dict = GetDevicePublicKey200Response.from_dict(get_device_public_key200_response_dict) +get_device_public_key200_response_from_dict = GetDevicePublicKey200Response.from_dict( + get_device_public_key200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetDevicePublicKeys200Response.md b/src/docs/GetDevicePublicKeys200Response.md index 1ceb56b..65fcffc 100644 --- a/src/docs/GetDevicePublicKeys200Response.md +++ b/src/docs/GetDevicePublicKeys200Response.md @@ -10,19 +10,27 @@ ## Example ```python -from notehub_py.models.get_device_public_keys200_response import GetDevicePublicKeys200Response +from notehub_py.models.get_device_public_keys200_response import ( + GetDevicePublicKeys200Response, +) # TODO update the JSON string below json = "{}" # create an instance of GetDevicePublicKeys200Response from a JSON string -get_device_public_keys200_response_instance = GetDevicePublicKeys200Response.from_json(json) +get_device_public_keys200_response_instance = GetDevicePublicKeys200Response.from_json( + json +) # print the JSON string representation of the object print(GetDevicePublicKeys200Response.to_json()) # convert the object into a dict -get_device_public_keys200_response_dict = get_device_public_keys200_response_instance.to_dict() +get_device_public_keys200_response_dict = ( + get_device_public_keys200_response_instance.to_dict() +) # create an instance of GetDevicePublicKeys200Response from a dict -get_device_public_keys200_response_from_dict = GetDevicePublicKeys200Response.from_dict(get_device_public_keys200_response_dict) +get_device_public_keys200_response_from_dict = GetDevicePublicKeys200Response.from_dict( + get_device_public_keys200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetDevicePublicKeys200ResponseDevicePublicKeysInner.md b/src/docs/GetDevicePublicKeys200ResponseDevicePublicKeysInner.md index 00a2ae7..14d78c3 100644 --- a/src/docs/GetDevicePublicKeys200ResponseDevicePublicKeysInner.md +++ b/src/docs/GetDevicePublicKeys200ResponseDevicePublicKeysInner.md @@ -10,19 +10,29 @@ ## Example ```python -from notehub_py.models.get_device_public_keys200_response_device_public_keys_inner import GetDevicePublicKeys200ResponseDevicePublicKeysInner +from notehub_py.models.get_device_public_keys200_response_device_public_keys_inner import ( + GetDevicePublicKeys200ResponseDevicePublicKeysInner, +) # TODO update the JSON string below json = "{}" # create an instance of GetDevicePublicKeys200ResponseDevicePublicKeysInner from a JSON string -get_device_public_keys200_response_device_public_keys_inner_instance = GetDevicePublicKeys200ResponseDevicePublicKeysInner.from_json(json) +get_device_public_keys200_response_device_public_keys_inner_instance = ( + GetDevicePublicKeys200ResponseDevicePublicKeysInner.from_json(json) +) # print the JSON string representation of the object print(GetDevicePublicKeys200ResponseDevicePublicKeysInner.to_json()) # convert the object into a dict -get_device_public_keys200_response_device_public_keys_inner_dict = get_device_public_keys200_response_device_public_keys_inner_instance.to_dict() +get_device_public_keys200_response_device_public_keys_inner_dict = ( + get_device_public_keys200_response_device_public_keys_inner_instance.to_dict() +) # create an instance of GetDevicePublicKeys200ResponseDevicePublicKeysInner from a dict -get_device_public_keys200_response_device_public_keys_inner_from_dict = GetDevicePublicKeys200ResponseDevicePublicKeysInner.from_dict(get_device_public_keys200_response_device_public_keys_inner_dict) +get_device_public_keys200_response_device_public_keys_inner_from_dict = ( + GetDevicePublicKeys200ResponseDevicePublicKeysInner.from_dict( + get_device_public_keys200_response_device_public_keys_inner_dict + ) +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetDeviceSessions200Response.md b/src/docs/GetDeviceSessions200Response.md index 93310d1..f9ba740 100644 --- a/src/docs/GetDeviceSessions200Response.md +++ b/src/docs/GetDeviceSessions200Response.md @@ -10,7 +10,9 @@ ## Example ```python -from notehub_py.models.get_device_sessions200_response import GetDeviceSessions200Response +from notehub_py.models.get_device_sessions200_response import ( + GetDeviceSessions200Response, +) # TODO update the JSON string below json = "{}" @@ -20,9 +22,13 @@ get_device_sessions200_response_instance = GetDeviceSessions200Response.from_jso print(GetDeviceSessions200Response.to_json()) # convert the object into a dict -get_device_sessions200_response_dict = get_device_sessions200_response_instance.to_dict() +get_device_sessions200_response_dict = ( + get_device_sessions200_response_instance.to_dict() +) # create an instance of GetDeviceSessions200Response from a dict -get_device_sessions200_response_from_dict = GetDeviceSessions200Response.from_dict(get_device_sessions200_response_dict) +get_device_sessions200_response_from_dict = GetDeviceSessions200Response.from_dict( + get_device_sessions200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetDevices200Response.md b/src/docs/GetDevices200Response.md index 1e77d4d..534fada 100644 --- a/src/docs/GetDevices200Response.md +++ b/src/docs/GetDevices200Response.md @@ -22,7 +22,9 @@ print(GetDevices200Response.to_json()) # convert the object into a dict get_devices200_response_dict = get_devices200_response_instance.to_dict() # create an instance of GetDevices200Response from a dict -get_devices200_response_from_dict = GetDevices200Response.from_dict(get_devices200_response_dict) +get_devices200_response_from_dict = GetDevices200Response.from_dict( + get_devices200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetEvents200Response.md b/src/docs/GetEvents200Response.md index dbe60aa..b54f0db 100644 --- a/src/docs/GetEvents200Response.md +++ b/src/docs/GetEvents200Response.md @@ -23,7 +23,9 @@ print(GetEvents200Response.to_json()) # convert the object into a dict get_events200_response_dict = get_events200_response_instance.to_dict() # create an instance of GetEvents200Response from a dict -get_events200_response_from_dict = GetEvents200Response.from_dict(get_events200_response_dict) +get_events200_response_from_dict = GetEvents200Response.from_dict( + get_events200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetEventsByCursor200Response.md b/src/docs/GetEventsByCursor200Response.md index c4861c0..1a53045 100644 --- a/src/docs/GetEventsByCursor200Response.md +++ b/src/docs/GetEventsByCursor200Response.md @@ -11,7 +11,9 @@ ## Example ```python -from notehub_py.models.get_events_by_cursor200_response import GetEventsByCursor200Response +from notehub_py.models.get_events_by_cursor200_response import ( + GetEventsByCursor200Response, +) # TODO update the JSON string below json = "{}" @@ -21,9 +23,13 @@ get_events_by_cursor200_response_instance = GetEventsByCursor200Response.from_js print(GetEventsByCursor200Response.to_json()) # convert the object into a dict -get_events_by_cursor200_response_dict = get_events_by_cursor200_response_instance.to_dict() +get_events_by_cursor200_response_dict = ( + get_events_by_cursor200_response_instance.to_dict() +) # create an instance of GetEventsByCursor200Response from a dict -get_events_by_cursor200_response_from_dict = GetEventsByCursor200Response.from_dict(get_events_by_cursor200_response_dict) +get_events_by_cursor200_response_from_dict = GetEventsByCursor200Response.from_dict( + get_events_by_cursor200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetJobRuns200Response.md b/src/docs/GetJobRuns200Response.md index 975305d..6635b85 100644 --- a/src/docs/GetJobRuns200Response.md +++ b/src/docs/GetJobRuns200Response.md @@ -21,7 +21,9 @@ print(GetJobRuns200Response.to_json()) # convert the object into a dict get_job_runs200_response_dict = get_job_runs200_response_instance.to_dict() # create an instance of GetJobRuns200Response from a dict -get_job_runs200_response_from_dict = GetJobRuns200Response.from_dict(get_job_runs200_response_dict) +get_job_runs200_response_from_dict = GetJobRuns200Response.from_dict( + get_job_runs200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetNotefile200Response.md b/src/docs/GetNotefile200Response.md index 1303e8f..39f13fb 100644 --- a/src/docs/GetNotefile200Response.md +++ b/src/docs/GetNotefile200Response.md @@ -23,7 +23,9 @@ print(GetNotefile200Response.to_json()) # convert the object into a dict get_notefile200_response_dict = get_notefile200_response_instance.to_dict() # create an instance of GetNotefile200Response from a dict -get_notefile200_response_from_dict = GetNotefile200Response.from_dict(get_notefile200_response_dict) +get_notefile200_response_from_dict = GetNotefile200Response.from_dict( + get_notefile200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetProducts200Response.md b/src/docs/GetProducts200Response.md index 35f82a8..4d181dc 100644 --- a/src/docs/GetProducts200Response.md +++ b/src/docs/GetProducts200Response.md @@ -21,7 +21,9 @@ print(GetProducts200Response.to_json()) # convert the object into a dict get_products200_response_dict = get_products200_response_instance.to_dict() # create an instance of GetProducts200Response from a dict -get_products200_response_from_dict = GetProducts200Response.from_dict(get_products200_response_dict) +get_products200_response_from_dict = GetProducts200Response.from_dict( + get_products200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetProjectMembers200Response.md b/src/docs/GetProjectMembers200Response.md index 56695ce..843c226 100644 --- a/src/docs/GetProjectMembers200Response.md +++ b/src/docs/GetProjectMembers200Response.md @@ -9,7 +9,9 @@ ## Example ```python -from notehub_py.models.get_project_members200_response import GetProjectMembers200Response +from notehub_py.models.get_project_members200_response import ( + GetProjectMembers200Response, +) # TODO update the JSON string below json = "{}" @@ -19,9 +21,13 @@ get_project_members200_response_instance = GetProjectMembers200Response.from_jso print(GetProjectMembers200Response.to_json()) # convert the object into a dict -get_project_members200_response_dict = get_project_members200_response_instance.to_dict() +get_project_members200_response_dict = ( + get_project_members200_response_instance.to_dict() +) # create an instance of GetProjectMembers200Response from a dict -get_project_members200_response_from_dict = GetProjectMembers200Response.from_dict(get_project_members200_response_dict) +get_project_members200_response_from_dict = GetProjectMembers200Response.from_dict( + get_project_members200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetProjects200Response.md b/src/docs/GetProjects200Response.md index 9aaa785..8154e4e 100644 --- a/src/docs/GetProjects200Response.md +++ b/src/docs/GetProjects200Response.md @@ -21,7 +21,9 @@ print(GetProjects200Response.to_json()) # convert the object into a dict get_projects200_response_dict = get_projects200_response_instance.to_dict() # create an instance of GetProjects200Response from a dict -get_projects200_response_from_dict = GetProjects200Response.from_dict(get_projects200_response_dict) +get_projects200_response_from_dict = GetProjects200Response.from_dict( + get_projects200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetRouteLogsUsage200Response.md b/src/docs/GetRouteLogsUsage200Response.md index 4796572..5f881a8 100644 --- a/src/docs/GetRouteLogsUsage200Response.md +++ b/src/docs/GetRouteLogsUsage200Response.md @@ -10,7 +10,9 @@ ## Example ```python -from notehub_py.models.get_route_logs_usage200_response import GetRouteLogsUsage200Response +from notehub_py.models.get_route_logs_usage200_response import ( + GetRouteLogsUsage200Response, +) # TODO update the JSON string below json = "{}" @@ -20,9 +22,13 @@ get_route_logs_usage200_response_instance = GetRouteLogsUsage200Response.from_js print(GetRouteLogsUsage200Response.to_json()) # convert the object into a dict -get_route_logs_usage200_response_dict = get_route_logs_usage200_response_instance.to_dict() +get_route_logs_usage200_response_dict = ( + get_route_logs_usage200_response_instance.to_dict() +) # create an instance of GetRouteLogsUsage200Response from a dict -get_route_logs_usage200_response_from_dict = GetRouteLogsUsage200Response.from_dict(get_route_logs_usage200_response_dict) +get_route_logs_usage200_response_from_dict = GetRouteLogsUsage200Response.from_dict( + get_route_logs_usage200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetSessionsUsage200Response.md b/src/docs/GetSessionsUsage200Response.md index 8fc4632..6a3f909 100644 --- a/src/docs/GetSessionsUsage200Response.md +++ b/src/docs/GetSessionsUsage200Response.md @@ -22,7 +22,9 @@ print(GetSessionsUsage200Response.to_json()) # convert the object into a dict get_sessions_usage200_response_dict = get_sessions_usage200_response_instance.to_dict() # create an instance of GetSessionsUsage200Response from a dict -get_sessions_usage200_response_from_dict = GetSessionsUsage200Response.from_dict(get_sessions_usage200_response_dict) +get_sessions_usage200_response_from_dict = GetSessionsUsage200Response.from_dict( + get_sessions_usage200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/GetWebhooks200Response.md b/src/docs/GetWebhooks200Response.md index 2fd526e..754b6d3 100644 --- a/src/docs/GetWebhooks200Response.md +++ b/src/docs/GetWebhooks200Response.md @@ -21,7 +21,9 @@ print(GetWebhooks200Response.to_json()) # convert the object into a dict get_webhooks200_response_dict = get_webhooks200_response_instance.to_dict() # create an instance of GetWebhooks200Response from a dict -get_webhooks200_response_from_dict = GetWebhooks200Response.from_dict(get_webhooks200_response_dict) +get_webhooks200_response_from_dict = GetWebhooks200Response.from_dict( + get_webhooks200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/JobsApi.md b/src/docs/JobsApi.md index db7fa45..cd7c995 100644 --- a/src/docs/JobsApi.md +++ b/src/docs/JobsApi.md @@ -29,16 +29,14 @@ from notehub_py.models.cancel_job_run200_response import CancelJobRun200Response from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.JobsApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - report_uid = 'my-reconciliation-job-1707654321000' # str | Unique identifier for a job run report + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + report_uid = "my-reconciliation-job-1707654321000" # str | Unique identifier for a job run report try: api_response = api_instance.cancel_job_run(project_or_product_uid, report_uid) @@ -84,17 +82,15 @@ from notehub_py.models.create_job201_response import CreateJob201Response from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.JobsApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - name = 'name_example' # str | Name for the job - body = None # object | The job definition as raw JSON + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + name = "name_example" # str | Name for the job + body = None # object | The job definition as raw JSON try: api_response = api_instance.create_job(project_or_product_uid, name, body) @@ -141,16 +137,14 @@ from notehub_py.models.delete_job200_response import DeleteJob200Response from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.JobsApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - job_uid = 'my-reconciliation-job' # str | Unique identifier for a batch job + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + job_uid = "my-reconciliation-job" # str | Unique identifier for a batch job try: api_response = api_instance.delete_job(project_or_product_uid, job_uid) @@ -196,16 +190,14 @@ from notehub_py.models.job import Job from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.JobsApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - job_uid = 'my-reconciliation-job' # str | Unique identifier for a batch job + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + job_uid = "my-reconciliation-job" # str | Unique identifier for a batch job try: api_response = api_instance.get_job(project_or_product_uid, job_uid) @@ -251,16 +243,14 @@ from notehub_py.models.job_run import JobRun from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.JobsApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - report_uid = 'my-reconciliation-job-1707654321000' # str | Unique identifier for a job run report + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + report_uid = "my-reconciliation-job-1707654321000" # str | Unique identifier for a job run report try: api_response = api_instance.get_job_run(project_or_product_uid, report_uid) @@ -306,21 +296,21 @@ from notehub_py.models.get_job_runs200_response import GetJobRuns200Response from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.JobsApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - job_uid = 'my-reconciliation-job' # str | Unique identifier for a batch job - status = 'status_example' # str | Filter runs by status (optional) - dry_run = True # bool | Filter runs by dry run flag (optional) + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + job_uid = "my-reconciliation-job" # str | Unique identifier for a batch job + status = "status_example" # str | Filter runs by status (optional) + dry_run = True # bool | Filter runs by dry run flag (optional) try: - api_response = api_instance.get_job_runs(project_or_product_uid, job_uid, status=status, dry_run=dry_run) + api_response = api_instance.get_job_runs( + project_or_product_uid, job_uid, status=status, dry_run=dry_run + ) print("The response of JobsApi->get_job_runs:\n") pprint(api_response) except Exception as e: @@ -365,15 +355,13 @@ from notehub_py.models.get_jobs200_response import GetJobs200Response from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.JobsApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | try: api_response = api_instance.get_jobs(project_or_product_uid) @@ -418,20 +406,20 @@ from notehub_py.models.run_job200_response import RunJob200Response from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.JobsApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - job_uid = 'my-reconciliation-job' # str | Unique identifier for a batch job - dry_run = False # bool | Run job in dry-run mode without making actual changes (optional) (default to False) + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + job_uid = "my-reconciliation-job" # str | Unique identifier for a batch job + dry_run = False # bool | Run job in dry-run mode without making actual changes (optional) (default to False) try: - api_response = api_instance.run_job(project_or_product_uid, job_uid, dry_run=dry_run) + api_response = api_instance.run_job( + project_or_product_uid, job_uid, dry_run=dry_run + ) print("The response of JobsApi->run_job:\n") pprint(api_response) except Exception as e: diff --git a/src/docs/MonitorAlertRoutesInner.md b/src/docs/MonitorAlertRoutesInner.md index 23d43e6..81e81ce 100644 --- a/src/docs/MonitorAlertRoutesInner.md +++ b/src/docs/MonitorAlertRoutesInner.md @@ -26,7 +26,9 @@ print(MonitorAlertRoutesInner.to_json()) # convert the object into a dict monitor_alert_routes_inner_dict = monitor_alert_routes_inner_instance.to_dict() # create an instance of MonitorAlertRoutesInner from a dict -monitor_alert_routes_inner_from_dict = MonitorAlertRoutesInner.from_dict(monitor_alert_routes_inner_dict) +monitor_alert_routes_inner_from_dict = MonitorAlertRoutesInner.from_dict( + monitor_alert_routes_inner_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/MonitorApi.md b/src/docs/MonitorApi.md index f1ab072..cd93e50 100644 --- a/src/docs/MonitorApi.md +++ b/src/docs/MonitorApi.md @@ -27,16 +27,14 @@ from notehub_py.models.monitor import Monitor from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.MonitorApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - body = notehub_py.Monitor() # Monitor | Body or payload of monitor to be created + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + body = notehub_py.Monitor() # Monitor | Body or payload of monitor to be created try: api_response = api_instance.create_monitor(project_or_product_uid, body) @@ -82,16 +80,14 @@ from notehub_py.models.monitor import Monitor from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.MonitorApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - monitor_uid = 'monitor:8bAdf00d-000f-51c-af-01d5eaf00dbad' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + monitor_uid = "monitor:8bAdf00d-000f-51c-af-01d5eaf00dbad" # str | try: api_response = api_instance.delete_monitor(project_or_product_uid, monitor_uid) @@ -137,16 +133,14 @@ from notehub_py.models.monitor import Monitor from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.MonitorApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - monitor_uid = 'monitor:8bAdf00d-000f-51c-af-01d5eaf00dbad' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + monitor_uid = "monitor:8bAdf00d-000f-51c-af-01d5eaf00dbad" # str | try: api_response = api_instance.get_monitor(project_or_product_uid, monitor_uid) @@ -192,15 +186,13 @@ from notehub_py.models.monitor import Monitor from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.MonitorApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | try: api_response = api_instance.get_monitors(project_or_product_uid) @@ -245,20 +237,20 @@ from notehub_py.models.monitor import Monitor from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.MonitorApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - monitor_uid = 'monitor:8bAdf00d-000f-51c-af-01d5eaf00dbad' # str | - monitor = notehub_py.Monitor() # Monitor | Body or payload of monitor to be created + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + monitor_uid = "monitor:8bAdf00d-000f-51c-af-01d5eaf00dbad" # str | + monitor = notehub_py.Monitor() # Monitor | Body or payload of monitor to be created try: - api_response = api_instance.update_monitor(project_or_product_uid, monitor_uid, monitor) + api_response = api_instance.update_monitor( + project_or_product_uid, monitor_uid, monitor + ) print("The response of MonitorApi->update_monitor:\n") pprint(api_response) except Exception as e: diff --git a/src/docs/NotehubRouteSummary.md b/src/docs/NotehubRouteSummary.md index c393884..8ba4336 100644 --- a/src/docs/NotehubRouteSummary.md +++ b/src/docs/NotehubRouteSummary.md @@ -25,7 +25,9 @@ print(NotehubRouteSummary.to_json()) # convert the object into a dict notehub_route_summary_dict = notehub_route_summary_instance.to_dict() # create an instance of NotehubRouteSummary from a dict -notehub_route_summary_from_dict = NotehubRouteSummary.from_dict(notehub_route_summary_dict) +notehub_route_summary_from_dict = NotehubRouteSummary.from_dict( + notehub_route_summary_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/OAuth2TokenResponse.md b/src/docs/OAuth2TokenResponse.md index f29e337..6936a95 100644 --- a/src/docs/OAuth2TokenResponse.md +++ b/src/docs/OAuth2TokenResponse.md @@ -24,7 +24,9 @@ print(OAuth2TokenResponse.to_json()) # convert the object into a dict o_auth2_token_response_dict = o_auth2_token_response_instance.to_dict() # create an instance of OAuth2TokenResponse from a dict -o_auth2_token_response_from_dict = OAuth2TokenResponse.from_dict(o_auth2_token_response_dict) +o_auth2_token_response_from_dict = OAuth2TokenResponse.from_dict( + o_auth2_token_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/PersonalAccessToken.md b/src/docs/PersonalAccessToken.md index 7ac60e7..3c8b70b 100644 --- a/src/docs/PersonalAccessToken.md +++ b/src/docs/PersonalAccessToken.md @@ -28,7 +28,9 @@ print(PersonalAccessToken.to_json()) # convert the object into a dict personal_access_token_dict = personal_access_token_instance.to_dict() # create an instance of PersonalAccessToken from a dict -personal_access_token_from_dict = PersonalAccessToken.from_dict(personal_access_token_dict) +personal_access_token_from_dict = PersonalAccessToken.from_dict( + personal_access_token_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/PersonalAccessTokenCreatedBy.md b/src/docs/PersonalAccessTokenCreatedBy.md index 65104ac..5bbb287 100644 --- a/src/docs/PersonalAccessTokenCreatedBy.md +++ b/src/docs/PersonalAccessTokenCreatedBy.md @@ -13,7 +13,9 @@ The user that created this key ## Example ```python -from notehub_py.models.personal_access_token_created_by import PersonalAccessTokenCreatedBy +from notehub_py.models.personal_access_token_created_by import ( + PersonalAccessTokenCreatedBy, +) # TODO update the JSON string below json = "{}" @@ -23,9 +25,13 @@ personal_access_token_created_by_instance = PersonalAccessTokenCreatedBy.from_js print(PersonalAccessTokenCreatedBy.to_json()) # convert the object into a dict -personal_access_token_created_by_dict = personal_access_token_created_by_instance.to_dict() +personal_access_token_created_by_dict = ( + personal_access_token_created_by_instance.to_dict() +) # create an instance of PersonalAccessTokenCreatedBy from a dict -personal_access_token_created_by_from_dict = PersonalAccessTokenCreatedBy.from_dict(personal_access_token_created_by_dict) +personal_access_token_created_by_from_dict = PersonalAccessTokenCreatedBy.from_dict( + personal_access_token_created_by_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/PersonalAccessTokenInfo.md b/src/docs/PersonalAccessTokenInfo.md index 290743f..6701be2 100644 --- a/src/docs/PersonalAccessTokenInfo.md +++ b/src/docs/PersonalAccessTokenInfo.md @@ -24,7 +24,9 @@ print(PersonalAccessTokenInfo.to_json()) # convert the object into a dict personal_access_token_info_dict = personal_access_token_info_instance.to_dict() # create an instance of PersonalAccessTokenInfo from a dict -personal_access_token_info_from_dict = PersonalAccessTokenInfo.from_dict(personal_access_token_info_dict) +personal_access_token_info_from_dict = PersonalAccessTokenInfo.from_dict( + personal_access_token_info_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/PersonalAccessTokenSecret.md b/src/docs/PersonalAccessTokenSecret.md index ee3fb24..8a4a242 100644 --- a/src/docs/PersonalAccessTokenSecret.md +++ b/src/docs/PersonalAccessTokenSecret.md @@ -22,7 +22,9 @@ print(PersonalAccessTokenSecret.to_json()) # convert the object into a dict personal_access_token_secret_dict = personal_access_token_secret_instance.to_dict() # create an instance of PersonalAccessTokenSecret from a dict -personal_access_token_secret_from_dict = PersonalAccessTokenSecret.from_dict(personal_access_token_secret_dict) +personal_access_token_secret_from_dict = PersonalAccessTokenSecret.from_dict( + personal_access_token_secret_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/ProjectApi.md b/src/docs/ProjectApi.md index 554a2c9..518c283 100644 --- a/src/docs/ProjectApi.md +++ b/src/docs/ProjectApi.md @@ -61,20 +61,22 @@ from notehub_py.models.get_device_fleets200_response import GetDeviceFleets200Re from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | - add_device_to_fleets_request = notehub_py.AddDeviceToFleetsRequest() # AddDeviceToFleetsRequest | The fleets to add to the device. Note that the endpoint takes an array of fleetUIDs, to facilitate multi-fleet devices. Multi-fleet is not yet enabled on all SaaS plans - unless it is supported by the SaaS plan of the project, passing more than a single fleetUID in the array is an error. + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | + add_device_to_fleets_request = ( + notehub_py.AddDeviceToFleetsRequest() + ) # AddDeviceToFleetsRequest | The fleets to add to the device. Note that the endpoint takes an array of fleetUIDs, to facilitate multi-fleet devices. Multi-fleet is not yet enabled on all SaaS plans - unless it is supported by the SaaS plan of the project, passing more than a single fleetUID in the array is an error. try: - api_response = api_instance.add_device_to_fleets(project_or_product_uid, device_uid, add_device_to_fleets_request) + api_response = api_instance.add_device_to_fleets( + project_or_product_uid, device_uid, add_device_to_fleets_request + ) print("The response of ProjectApi->add_device_to_fleets:\n") pprint(api_response) except Exception as e: @@ -119,19 +121,21 @@ from notehub_py.models.project import Project from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - clone_project_request = notehub_py.CloneProjectRequest() # CloneProjectRequest | Project to be cloned + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + clone_project_request = ( + notehub_py.CloneProjectRequest() + ) # CloneProjectRequest | Project to be cloned try: - api_response = api_instance.clone_project(project_or_product_uid, clone_project_request) + api_response = api_instance.clone_project( + project_or_product_uid, clone_project_request + ) print("The response of ProjectApi->clone_project:\n") pprint(api_response) except Exception as e: @@ -175,19 +179,21 @@ from notehub_py.models.fleet import Fleet from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - create_fleet_request = notehub_py.CreateFleetRequest() # CreateFleetRequest | Fleet to be added + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + create_fleet_request = ( + notehub_py.CreateFleetRequest() + ) # CreateFleetRequest | Fleet to be added try: - api_response = api_instance.create_fleet(project_or_product_uid, create_fleet_request) + api_response = api_instance.create_fleet( + project_or_product_uid, create_fleet_request + ) print("The response of ProjectApi->create_fleet:\n") pprint(api_response) except Exception as e: @@ -231,19 +237,21 @@ from notehub_py.models.product import Product from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - create_product_request = notehub_py.CreateProductRequest() # CreateProductRequest | Product to be created + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + create_product_request = ( + notehub_py.CreateProductRequest() + ) # CreateProductRequest | Product to be created try: - api_response = api_instance.create_product(project_or_product_uid, create_product_request) + api_response = api_instance.create_product( + project_or_product_uid, create_product_request + ) print("The response of ProjectApi->create_product:\n") pprint(api_response) except Exception as e: @@ -287,15 +295,15 @@ from notehub_py.models.project import Project from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - create_project_request = notehub_py.CreateProjectRequest() # CreateProjectRequest | Project to be created + create_project_request = ( + notehub_py.CreateProjectRequest() + ) # CreateProjectRequest | Project to be created try: api_response = api_instance.create_project(create_project_request) @@ -336,25 +344,29 @@ Remove Device from Fleets ```python import notehub_py -from notehub_py.models.delete_device_from_fleets_request import DeleteDeviceFromFleetsRequest +from notehub_py.models.delete_device_from_fleets_request import ( + DeleteDeviceFromFleetsRequest, +) from notehub_py.models.get_device_fleets200_response import GetDeviceFleets200Response from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | - delete_device_from_fleets_request = notehub_py.DeleteDeviceFromFleetsRequest() # DeleteDeviceFromFleetsRequest | The fleets to remove from the device. Note that the endpoint takes an array of fleetUIDs, to facilitate multi-fleet devices. Multi-fleet is not yet enabled on all SaaS plans - unless it is supported by the SaaS plan of the project, passing more than a single fleetUID in the array is an error. + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | + delete_device_from_fleets_request = ( + notehub_py.DeleteDeviceFromFleetsRequest() + ) # DeleteDeviceFromFleetsRequest | The fleets to remove from the device. Note that the endpoint takes an array of fleetUIDs, to facilitate multi-fleet devices. Multi-fleet is not yet enabled on all SaaS plans - unless it is supported by the SaaS plan of the project, passing more than a single fleetUID in the array is an error. try: - api_response = api_instance.delete_device_from_fleets(project_or_product_uid, device_uid, delete_device_from_fleets_request) + api_response = api_instance.delete_device_from_fleets( + project_or_product_uid, device_uid, delete_device_from_fleets_request + ) print("The response of ProjectApi->delete_device_from_fleets:\n") pprint(api_response) except Exception as e: @@ -397,16 +409,14 @@ import notehub_py from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - fleet_uid = 'fleet_uid_example' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + fleet_uid = "fleet_uid_example" # str | try: api_instance.delete_fleet(project_or_product_uid, fleet_uid) @@ -450,24 +460,27 @@ from notehub_py.models.environment_variables import EnvironmentVariables from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - fleet_uid = 'fleet_uid_example' # str | - key = 'key_example' # str | The environment variable key to delete. + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + fleet_uid = "fleet_uid_example" # str | + key = "key_example" # str | The environment variable key to delete. try: - api_response = api_instance.delete_fleet_environment_variable(project_or_product_uid, fleet_uid, key) + api_response = api_instance.delete_fleet_environment_variable( + project_or_product_uid, fleet_uid, key + ) print("The response of ProjectApi->delete_fleet_environment_variable:\n") pprint(api_response) except Exception as e: - print("Exception when calling ProjectApi->delete_fleet_environment_variable: %s\n" % e) + print( + "Exception when calling ProjectApi->delete_fleet_environment_variable: %s\n" + % e + ) ``` ### Parameters @@ -506,16 +519,14 @@ import notehub_py from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - product_uid = 'com.blues.bridge:sensors' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + product_uid = "com.blues.bridge:sensors" # str | try: api_instance.delete_product(project_or_product_uid, product_uid) @@ -558,15 +569,13 @@ import notehub_py from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | try: api_instance.delete_project(project_or_product_uid) @@ -609,23 +618,26 @@ from notehub_py.models.environment_variables import EnvironmentVariables from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - key = 'key_example' # str | The environment variable key to delete. + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + key = "key_example" # str | The environment variable key to delete. try: - api_response = api_instance.delete_project_environment_variable(project_or_product_uid, key) + api_response = api_instance.delete_project_environment_variable( + project_or_product_uid, key + ) print("The response of ProjectApi->delete_project_environment_variable:\n") pprint(api_response) except Exception as e: - print("Exception when calling ProjectApi->delete_project_environment_variable: %s\n" % e) + print( + "Exception when calling ProjectApi->delete_project_environment_variable: %s\n" + % e + ) ``` ### Parameters @@ -663,20 +675,21 @@ import notehub_py from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | try: api_instance.disable_global_event_transformation(project_or_product_uid) except Exception as e: - print("Exception when calling ProjectApi->disable_global_event_transformation: %s\n" % e) + print( + "Exception when calling ProjectApi->disable_global_event_transformation: %s\n" + % e + ) ``` ### Parameters @@ -713,20 +726,20 @@ import notehub_py from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - firmware_type = 'firmware_type_example' # str | - filename = 'filename_example' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + firmware_type = "firmware_type_example" # str | + filename = "filename_example" # str | try: - api_response = api_instance.download_firmware(project_or_product_uid, firmware_type, filename) + api_response = api_instance.download_firmware( + project_or_product_uid, firmware_type, filename + ) print("The response of ProjectApi->download_firmware:\n") pprint(api_response) except Exception as e: @@ -769,20 +782,21 @@ import notehub_py from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | try: api_instance.enable_global_event_transformation(project_or_product_uid) except Exception as e: - print("Exception when calling ProjectApi->enable_global_event_transformation: %s\n" % e) + print( + "Exception when calling ProjectApi->enable_global_event_transformation: %s\n" + % e + ) ``` ### Parameters @@ -822,15 +836,13 @@ from notehub_py.models.aws_role_config import AWSRoleConfig from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | try: # Get AWS role configuration for role-based authentication @@ -876,20 +888,20 @@ from notehub_py.models.device_dfu_history import DeviceDfuHistory from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | - firmware_type = 'firmware_type_example' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | + firmware_type = "firmware_type_example" # str | try: - api_response = api_instance.get_device_dfu_history(project_or_product_uid, device_uid, firmware_type) + api_response = api_instance.get_device_dfu_history( + project_or_product_uid, device_uid, firmware_type + ) print("The response of ProjectApi->get_device_dfu_history:\n") pprint(api_response) except Exception as e: @@ -933,20 +945,20 @@ from notehub_py.models.device_dfu_status import DeviceDfuStatus from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | - firmware_type = 'firmware_type_example' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | + firmware_type = "firmware_type_example" # str | try: - api_response = api_instance.get_device_dfu_status(project_or_product_uid, device_uid, firmware_type) + api_response = api_instance.get_device_dfu_status( + project_or_product_uid, device_uid, firmware_type + ) print("The response of ProjectApi->get_device_dfu_status:\n") pprint(api_response) except Exception as e: @@ -990,19 +1002,19 @@ from notehub_py.models.get_device_fleets200_response import GetDeviceFleets200Re from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - device_uid = 'dev:000000000000000' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + device_uid = "dev:000000000000000" # str | try: - api_response = api_instance.get_device_fleets(project_or_product_uid, device_uid) + api_response = api_instance.get_device_fleets( + project_or_product_uid, device_uid + ) print("The response of ProjectApi->get_device_fleets:\n") pprint(api_response) except Exception as e: @@ -1045,32 +1057,52 @@ from notehub_py.models.device_dfu_history_page import DeviceDfuHistoryPage from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - firmware_type = 'firmware_type_example' # str | - page_size = 50 # int | (optional) (default to 50) - page_num = 1 # int | (optional) (default to 1) - sort_by = 'captured' # str | (optional) (default to 'captured') - sort_order = 'asc' # str | (optional) (default to 'asc') - device_uid = ['device_uid_example'] # List[str] | A Device UID. (optional) - tag = ['tag_example'] # List[str] | Tag filter (optional) - serial_number = ['serial_number_example'] # List[str] | Serial number filter (optional) - fleet_uid = 'fleet_uid_example' # str | (optional) - notecard_firmware = ['notecard_firmware_example'] # List[str] | Firmware version filter (optional) - location = ['location_example'] # List[str] | Location filter (optional) - host_firmware = ['host_firmware_example'] # List[str] | Host firmware filter (optional) - product_uid = ['product_uid_example'] # List[str] | (optional) - sku = ['sku_example'] # List[str] | SKU filter (optional) + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + firmware_type = "firmware_type_example" # str | + page_size = 50 # int | (optional) (default to 50) + page_num = 1 # int | (optional) (default to 1) + sort_by = "captured" # str | (optional) (default to 'captured') + sort_order = "asc" # str | (optional) (default to 'asc') + device_uid = ["device_uid_example"] # List[str] | A Device UID. (optional) + tag = ["tag_example"] # List[str] | Tag filter (optional) + serial_number = [ + "serial_number_example" + ] # List[str] | Serial number filter (optional) + fleet_uid = "fleet_uid_example" # str | (optional) + notecard_firmware = [ + "notecard_firmware_example" + ] # List[str] | Firmware version filter (optional) + location = ["location_example"] # List[str] | Location filter (optional) + host_firmware = [ + "host_firmware_example" + ] # List[str] | Host firmware filter (optional) + product_uid = ["product_uid_example"] # List[str] | (optional) + sku = ["sku_example"] # List[str] | SKU filter (optional) try: - api_response = api_instance.get_devices_dfu_history(project_or_product_uid, firmware_type, page_size=page_size, page_num=page_num, sort_by=sort_by, sort_order=sort_order, device_uid=device_uid, tag=tag, serial_number=serial_number, fleet_uid=fleet_uid, notecard_firmware=notecard_firmware, location=location, host_firmware=host_firmware, product_uid=product_uid, sku=sku) + api_response = api_instance.get_devices_dfu_history( + project_or_product_uid, + firmware_type, + page_size=page_size, + page_num=page_num, + sort_by=sort_by, + sort_order=sort_order, + device_uid=device_uid, + tag=tag, + serial_number=serial_number, + fleet_uid=fleet_uid, + notecard_firmware=notecard_firmware, + location=location, + host_firmware=host_firmware, + product_uid=product_uid, + sku=sku, + ) print("The response of ProjectApi->get_devices_dfu_history:\n") pprint(api_response) except Exception as e: @@ -1126,32 +1158,52 @@ from notehub_py.models.device_dfu_status_page import DeviceDfuStatusPage from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - firmware_type = 'firmware_type_example' # str | - page_size = 50 # int | (optional) (default to 50) - page_num = 1 # int | (optional) (default to 1) - sort_by = 'captured' # str | (optional) (default to 'captured') - sort_order = 'asc' # str | (optional) (default to 'asc') - device_uid = ['device_uid_example'] # List[str] | A Device UID. (optional) - tag = ['tag_example'] # List[str] | Tag filter (optional) - serial_number = ['serial_number_example'] # List[str] | Serial number filter (optional) - fleet_uid = 'fleet_uid_example' # str | (optional) - notecard_firmware = ['notecard_firmware_example'] # List[str] | Firmware version filter (optional) - location = ['location_example'] # List[str] | Location filter (optional) - host_firmware = ['host_firmware_example'] # List[str] | Host firmware filter (optional) - product_uid = ['product_uid_example'] # List[str] | (optional) - sku = ['sku_example'] # List[str] | SKU filter (optional) + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + firmware_type = "firmware_type_example" # str | + page_size = 50 # int | (optional) (default to 50) + page_num = 1 # int | (optional) (default to 1) + sort_by = "captured" # str | (optional) (default to 'captured') + sort_order = "asc" # str | (optional) (default to 'asc') + device_uid = ["device_uid_example"] # List[str] | A Device UID. (optional) + tag = ["tag_example"] # List[str] | Tag filter (optional) + serial_number = [ + "serial_number_example" + ] # List[str] | Serial number filter (optional) + fleet_uid = "fleet_uid_example" # str | (optional) + notecard_firmware = [ + "notecard_firmware_example" + ] # List[str] | Firmware version filter (optional) + location = ["location_example"] # List[str] | Location filter (optional) + host_firmware = [ + "host_firmware_example" + ] # List[str] | Host firmware filter (optional) + product_uid = ["product_uid_example"] # List[str] | (optional) + sku = ["sku_example"] # List[str] | SKU filter (optional) try: - api_response = api_instance.get_devices_dfu_status(project_or_product_uid, firmware_type, page_size=page_size, page_num=page_num, sort_by=sort_by, sort_order=sort_order, device_uid=device_uid, tag=tag, serial_number=serial_number, fleet_uid=fleet_uid, notecard_firmware=notecard_firmware, location=location, host_firmware=host_firmware, product_uid=product_uid, sku=sku) + api_response = api_instance.get_devices_dfu_status( + project_or_product_uid, + firmware_type, + page_size=page_size, + page_num=page_num, + sort_by=sort_by, + sort_order=sort_order, + device_uid=device_uid, + tag=tag, + serial_number=serial_number, + fleet_uid=fleet_uid, + notecard_firmware=notecard_firmware, + location=location, + host_firmware=host_firmware, + product_uid=product_uid, + sku=sku, + ) print("The response of ProjectApi->get_devices_dfu_status:\n") pprint(api_response) except Exception as e: @@ -1207,27 +1259,36 @@ from notehub_py.models.firmware_info import FirmwareInfo from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - product = 'product_example' # str | (optional) - firmware_type = 'firmware_type_example' # str | (optional) - version = 'version_example' # str | (optional) - target = 'target_example' # str | (optional) - filename = 'notecard-7.2.2.16518$20240410043100.bin' # str | (optional) - md5 = 'md5_example' # str | (optional) - unpublished = True # bool | (optional) - sort_by = 'created' # str | Field to sort by (optional) (default to 'created') - sort_order = 'desc' # str | Sort order (asc for ascending, desc for descending) (optional) (default to 'desc') + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + product = "product_example" # str | (optional) + firmware_type = "firmware_type_example" # str | (optional) + version = "version_example" # str | (optional) + target = "target_example" # str | (optional) + filename = "notecard-7.2.2.16518$20240410043100.bin" # str | (optional) + md5 = "md5_example" # str | (optional) + unpublished = True # bool | (optional) + sort_by = "created" # str | Field to sort by (optional) (default to 'created') + sort_order = "desc" # str | Sort order (asc for ascending, desc for descending) (optional) (default to 'desc') try: - api_response = api_instance.get_firmware_info(project_or_product_uid, product=product, firmware_type=firmware_type, version=version, target=target, filename=filename, md5=md5, unpublished=unpublished, sort_by=sort_by, sort_order=sort_order) + api_response = api_instance.get_firmware_info( + project_or_product_uid, + product=product, + firmware_type=firmware_type, + version=version, + target=target, + filename=filename, + md5=md5, + unpublished=unpublished, + sort_by=sort_by, + sort_order=sort_order, + ) print("The response of ProjectApi->get_firmware_info:\n") pprint(api_response) except Exception as e: @@ -1278,16 +1339,14 @@ from notehub_py.models.fleet import Fleet from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - fleet_uid = 'fleet_uid_example' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + fleet_uid = "fleet_uid_example" # str | try: api_response = api_instance.get_fleet(project_or_product_uid, fleet_uid) @@ -1333,24 +1392,27 @@ from notehub_py.models.env_tree_json_node import EnvTreeJsonNode from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - fleet_uid = 'fleet_uid_example' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + fleet_uid = "fleet_uid_example" # str | try: # Get environment variable hierarchy for a device - api_response = api_instance.get_fleet_environment_hierarchy(project_or_product_uid, fleet_uid) + api_response = api_instance.get_fleet_environment_hierarchy( + project_or_product_uid, fleet_uid + ) print("The response of ProjectApi->get_fleet_environment_hierarchy:\n") pprint(api_response) except Exception as e: - print("Exception when calling ProjectApi->get_fleet_environment_hierarchy: %s\n" % e) + print( + "Exception when calling ProjectApi->get_fleet_environment_hierarchy: %s\n" + % e + ) ``` ### Parameters @@ -1389,23 +1451,26 @@ from notehub_py.models.environment_variables import EnvironmentVariables from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - fleet_uid = 'fleet_uid_example' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + fleet_uid = "fleet_uid_example" # str | try: - api_response = api_instance.get_fleet_environment_variables(project_or_product_uid, fleet_uid) + api_response = api_instance.get_fleet_environment_variables( + project_or_product_uid, fleet_uid + ) print("The response of ProjectApi->get_fleet_environment_variables:\n") pprint(api_response) except Exception as e: - print("Exception when calling ProjectApi->get_fleet_environment_variables: %s\n" % e) + print( + "Exception when calling ProjectApi->get_fleet_environment_variables: %s\n" + % e + ) ``` ### Parameters @@ -1444,15 +1509,13 @@ from notehub_py.models.get_device_fleets200_response import GetDeviceFleets200Re from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | try: api_response = api_instance.get_fleets(project_or_product_uid) @@ -1500,7 +1563,7 @@ from pprint import pprint with notehub_py.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = notehub_py.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | try: # Get variable format for a notefile @@ -1546,15 +1609,13 @@ from notehub_py.models.get_products200_response import GetProducts200Response from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | try: api_response = api_instance.get_products(project_or_product_uid) @@ -1599,15 +1660,13 @@ from notehub_py.models.project import Project from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | try: api_response = api_instance.get_project(project_or_product_uid) @@ -1652,15 +1711,13 @@ from notehub_py.models.project import Project from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - product_uid = 'com.blues.airnote' # str | + product_uid = "com.blues.airnote" # str | try: api_response = api_instance.get_project_by_product(product_uid) @@ -1705,23 +1762,26 @@ from notehub_py.models.env_tree_json_node import EnvTreeJsonNode from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | try: # Get environment variable hierarchy for a device - api_response = api_instance.get_project_environment_hierarchy(project_or_product_uid) + api_response = api_instance.get_project_environment_hierarchy( + project_or_product_uid + ) print("The response of ProjectApi->get_project_environment_hierarchy:\n") pprint(api_response) except Exception as e: - print("Exception when calling ProjectApi->get_project_environment_hierarchy: %s\n" % e) + print( + "Exception when calling ProjectApi->get_project_environment_hierarchy: %s\n" + % e + ) ``` ### Parameters @@ -1759,22 +1819,25 @@ from notehub_py.models.environment_variables import EnvironmentVariables from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | try: - api_response = api_instance.get_project_environment_variables(project_or_product_uid) + api_response = api_instance.get_project_environment_variables( + project_or_product_uid + ) print("The response of ProjectApi->get_project_environment_variables:\n") pprint(api_response) except Exception as e: - print("Exception when calling ProjectApi->get_project_environment_variables: %s\n" % e) + print( + "Exception when calling ProjectApi->get_project_environment_variables: %s\n" + % e + ) ``` ### Parameters @@ -1808,19 +1871,19 @@ Get Project Members ```python import notehub_py -from notehub_py.models.get_project_members200_response import GetProjectMembers200Response +from notehub_py.models.get_project_members200_response import ( + GetProjectMembers200Response, +) from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | try: api_response = api_instance.get_project_members(project_or_product_uid) @@ -1865,9 +1928,7 @@ from notehub_py.models.get_projects200_response import GetProjects200Response from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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: @@ -1915,30 +1976,50 @@ from notehub_py.models.dfu_action_request import DfuActionRequest from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - firmware_type = 'firmware_type_example' # str | - action = 'action_example' # str | - device_uid = ['device_uid_example'] # List[str] | A Device UID. (optional) - tag = ['tag_example'] # List[str] | Tag filter (optional) - serial_number = ['serial_number_example'] # List[str] | Serial number filter (optional) - fleet_uid = 'fleet_uid_example' # str | (optional) - notecard_firmware = ['notecard_firmware_example'] # List[str] | Firmware version filter (optional) - location = ['location_example'] # List[str] | Location filter (optional) - host_firmware = ['host_firmware_example'] # List[str] | Host firmware filter (optional) - product_uid = ['product_uid_example'] # List[str] | (optional) - sku = ['sku_example'] # List[str] | SKU filter (optional) - dfu_action_request = notehub_py.DfuActionRequest() # DfuActionRequest | Which firmware in the case of an update action (optional) + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + firmware_type = "firmware_type_example" # str | + action = "action_example" # str | + device_uid = ["device_uid_example"] # List[str] | A Device UID. (optional) + tag = ["tag_example"] # List[str] | Tag filter (optional) + serial_number = [ + "serial_number_example" + ] # List[str] | Serial number filter (optional) + fleet_uid = "fleet_uid_example" # str | (optional) + notecard_firmware = [ + "notecard_firmware_example" + ] # List[str] | Firmware version filter (optional) + location = ["location_example"] # List[str] | Location filter (optional) + host_firmware = [ + "host_firmware_example" + ] # List[str] | Host firmware filter (optional) + product_uid = ["product_uid_example"] # List[str] | (optional) + sku = ["sku_example"] # List[str] | SKU filter (optional) + dfu_action_request = ( + notehub_py.DfuActionRequest() + ) # DfuActionRequest | Which firmware in the case of an update action (optional) try: - api_instance.perform_dfu_action(project_or_product_uid, firmware_type, action, device_uid=device_uid, tag=tag, serial_number=serial_number, fleet_uid=fleet_uid, notecard_firmware=notecard_firmware, location=location, host_firmware=host_firmware, product_uid=product_uid, sku=sku, dfu_action_request=dfu_action_request) + api_instance.perform_dfu_action( + project_or_product_uid, + firmware_type, + action, + device_uid=device_uid, + tag=tag, + serial_number=serial_number, + fleet_uid=fleet_uid, + notecard_firmware=notecard_firmware, + location=location, + host_firmware=host_firmware, + product_uid=product_uid, + sku=sku, + dfu_action_request=dfu_action_request, + ) except Exception as e: print("Exception when calling ProjectApi->perform_dfu_action: %s\n" % e) ``` @@ -1990,24 +2071,29 @@ from notehub_py.models.environment_variables import EnvironmentVariables from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - fleet_uid = 'fleet_uid_example' # str | - environment_variables = notehub_py.EnvironmentVariables() # EnvironmentVariables | Environment variables to be added to the fleet + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + fleet_uid = "fleet_uid_example" # str | + environment_variables = ( + notehub_py.EnvironmentVariables() + ) # EnvironmentVariables | Environment variables to be added to the fleet try: - api_response = api_instance.set_fleet_environment_variables(project_or_product_uid, fleet_uid, environment_variables) + api_response = api_instance.set_fleet_environment_variables( + project_or_product_uid, fleet_uid, environment_variables + ) print("The response of ProjectApi->set_fleet_environment_variables:\n") pprint(api_response) except Exception as e: - print("Exception when calling ProjectApi->set_fleet_environment_variables: %s\n" % e) + print( + "Exception when calling ProjectApi->set_fleet_environment_variables: %s\n" + % e + ) ``` ### Parameters @@ -2046,21 +2132,22 @@ import notehub_py from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - body = None # object | JSONata expression which will be applied to each event before it is persisted and routed + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + body = None # object | JSONata expression which will be applied to each event before it is persisted and routed try: api_instance.set_global_event_transformation(project_or_product_uid, body) except Exception as e: - print("Exception when calling ProjectApi->set_global_event_transformation: %s\n" % e) + print( + "Exception when calling ProjectApi->set_global_event_transformation: %s\n" + % e + ) ``` ### Parameters @@ -2099,23 +2186,28 @@ from notehub_py.models.environment_variables import EnvironmentVariables from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - environment_variables = notehub_py.EnvironmentVariables() # EnvironmentVariables | (optional) + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + environment_variables = ( + notehub_py.EnvironmentVariables() + ) # EnvironmentVariables | (optional) try: - api_response = api_instance.set_project_environment_variables(project_or_product_uid, environment_variables=environment_variables) + api_response = api_instance.set_project_environment_variables( + project_or_product_uid, environment_variables=environment_variables + ) print("The response of ProjectApi->set_project_environment_variables:\n") pprint(api_response) except Exception as e: - print("Exception when calling ProjectApi->set_project_environment_variables: %s\n" % e) + print( + "Exception when calling ProjectApi->set_project_environment_variables: %s\n" + % e + ) ``` ### Parameters @@ -2155,20 +2247,22 @@ from notehub_py.models.update_fleet_request import UpdateFleetRequest from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - fleet_uid = 'fleet_uid_example' # str | - update_fleet_request = notehub_py.UpdateFleetRequest() # UpdateFleetRequest | Fleet details to update + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + fleet_uid = "fleet_uid_example" # str | + update_fleet_request = ( + notehub_py.UpdateFleetRequest() + ) # UpdateFleetRequest | Fleet details to update try: - api_response = api_instance.update_fleet(project_or_product_uid, fleet_uid, update_fleet_request) + api_response = api_instance.update_fleet( + project_or_product_uid, fleet_uid, update_fleet_request + ) print("The response of ProjectApi->update_fleet:\n") pprint(api_response) except Exception as e: @@ -2212,23 +2306,28 @@ from notehub_py.models.firmware_info import FirmwareInfo from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.ProjectApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - firmware_type = 'firmware_type_example' # str | - filename = 'filename_example' # str | - body = None # bytearray | contents of the firmware binary - version = 'version_example' # str | Firmware version (optional). If not provided, the version will be extracted from firmware binary if available, otherwise left empty (optional) - notes = 'notes_example' # str | Optional notes describing what's different about this firmware version (optional) + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + firmware_type = "firmware_type_example" # str | + filename = "filename_example" # str | + body = None # bytearray | contents of the firmware binary + version = "version_example" # str | Firmware version (optional). If not provided, the version will be extracted from firmware binary if available, otherwise left empty (optional) + notes = "notes_example" # str | Optional notes describing what's different about this firmware version (optional) try: - api_response = api_instance.upload_firmware(project_or_product_uid, firmware_type, filename, body, version=version, notes=notes) + api_response = api_instance.upload_firmware( + project_or_product_uid, + firmware_type, + filename, + body, + version=version, + notes=notes, + ) print("The response of ProjectApi->upload_firmware:\n") pprint(api_response) except Exception as e: diff --git a/src/docs/ProvisionDeviceRequest.md b/src/docs/ProvisionDeviceRequest.md index d097711..6749002 100644 --- a/src/docs/ProvisionDeviceRequest.md +++ b/src/docs/ProvisionDeviceRequest.md @@ -23,7 +23,9 @@ print(ProvisionDeviceRequest.to_json()) # convert the object into a dict provision_device_request_dict = provision_device_request_instance.to_dict() # create an instance of ProvisionDeviceRequest from a dict -provision_device_request_from_dict = ProvisionDeviceRequest.from_dict(provision_device_request_dict) +provision_device_request_from_dict = ProvisionDeviceRequest.from_dict( + provision_device_request_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/RouteTransformSettings.md b/src/docs/RouteTransformSettings.md index b7bd39b..356a1c0 100644 --- a/src/docs/RouteTransformSettings.md +++ b/src/docs/RouteTransformSettings.md @@ -25,7 +25,9 @@ print(RouteTransformSettings.to_json()) # convert the object into a dict route_transform_settings_dict = route_transform_settings_instance.to_dict() # create an instance of RouteTransformSettings from a dict -route_transform_settings_from_dict = RouteTransformSettings.from_dict(route_transform_settings_dict) +route_transform_settings_from_dict = RouteTransformSettings.from_dict( + route_transform_settings_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/SignalDevice200Response.md b/src/docs/SignalDevice200Response.md index e988935..bdfa14b 100644 --- a/src/docs/SignalDevice200Response.md +++ b/src/docs/SignalDevice200Response.md @@ -21,7 +21,9 @@ print(SignalDevice200Response.to_json()) # convert the object into a dict signal_device200_response_dict = signal_device200_response_instance.to_dict() # create an instance of SignalDevice200Response from a dict -signal_device200_response_from_dict = SignalDevice200Response.from_dict(signal_device200_response_dict) +signal_device200_response_from_dict = SignalDevice200Response.from_dict( + signal_device200_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/SlackBearerNotification.md b/src/docs/SlackBearerNotification.md index 09c9682..3d8a33d 100644 --- a/src/docs/SlackBearerNotification.md +++ b/src/docs/SlackBearerNotification.md @@ -24,7 +24,9 @@ print(SlackBearerNotification.to_json()) # convert the object into a dict slack_bearer_notification_dict = slack_bearer_notification_instance.to_dict() # create an instance of SlackBearerNotification from a dict -slack_bearer_notification_from_dict = SlackBearerNotification.from_dict(slack_bearer_notification_dict) +slack_bearer_notification_from_dict = SlackBearerNotification.from_dict( + slack_bearer_notification_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/SlackWebHookNotification.md b/src/docs/SlackWebHookNotification.md index 6343943..b380f14 100644 --- a/src/docs/SlackWebHookNotification.md +++ b/src/docs/SlackWebHookNotification.md @@ -23,7 +23,9 @@ print(SlackWebHookNotification.to_json()) # convert the object into a dict slack_web_hook_notification_dict = slack_web_hook_notification_instance.to_dict() # create an instance of SlackWebHookNotification from a dict -slack_web_hook_notification_from_dict = SlackWebHookNotification.from_dict(slack_web_hook_notification_dict) +slack_web_hook_notification_from_dict = SlackWebHookNotification.from_dict( + slack_web_hook_notification_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/SnowpipeStreamingRoute.md b/src/docs/SnowpipeStreamingRoute.md index af1568c..79a6920 100644 --- a/src/docs/SnowpipeStreamingRoute.md +++ b/src/docs/SnowpipeStreamingRoute.md @@ -32,7 +32,9 @@ print(SnowpipeStreamingRoute.to_json()) # convert the object into a dict snowpipe_streaming_route_dict = snowpipe_streaming_route_instance.to_dict() # create an instance of SnowpipeStreamingRoute from a dict -snowpipe_streaming_route_from_dict = SnowpipeStreamingRoute.from_dict(snowpipe_streaming_route_dict) +snowpipe_streaming_route_from_dict = SnowpipeStreamingRoute.from_dict( + snowpipe_streaming_route_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/UsageApi.md b/src/docs/UsageApi.md index 44266c1..c7041eb 100644 --- a/src/docs/UsageApi.md +++ b/src/docs/UsageApi.md @@ -25,25 +25,34 @@ from notehub_py.models.get_data_usage200_response import GetDataUsage200Response from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.UsageApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - period = 'period_example' # str | Period type for aggregation - start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) - end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) - device_uid = ['device_uid_example'] # List[str] | A Device UID. (optional) - fleet_uid = ['fleet_uid_example'] # List[str] | Filter by Fleet UID (optional) - limit = 200000 # int | Limit the number of data points returned (optional) (default to 200000) - aggregate = 'device' # str | Aggregation level for results (optional) (default to 'device') + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + period = "period_example" # str | Period type for aggregation + start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) + end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) + device_uid = ["device_uid_example"] # List[str] | A Device UID. (optional) + fleet_uid = ["fleet_uid_example"] # List[str] | Filter by Fleet UID (optional) + limit = 200000 # int | Limit the number of data points returned (optional) (default to 200000) + aggregate = ( + "device" # str | Aggregation level for results (optional) (default to 'device') + ) try: - api_response = api_instance.get_data_usage(project_or_product_uid, period, start_date=start_date, end_date=end_date, device_uid=device_uid, fleet_uid=fleet_uid, limit=limit, aggregate=aggregate) + api_response = api_instance.get_data_usage( + project_or_product_uid, + period, + start_date=start_date, + end_date=end_date, + device_uid=device_uid, + fleet_uid=fleet_uid, + limit=limit, + aggregate=aggregate, + ) print("The response of UsageApi->get_data_usage:\n") pprint(api_response) except Exception as e: @@ -92,28 +101,42 @@ from notehub_py.models.usage_events_response import UsageEventsResponse from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.UsageApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - period = 'period_example' # str | Period type for aggregation - start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) - end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) - device_uid = ['device_uid_example'] # List[str] | A Device UID. (optional) - fleet_uid = ['fleet_uid_example'] # List[str] | Filter by Fleet UID (optional) - limit = 200000 # int | Limit the number of data points returned (optional) (default to 200000) - aggregate = 'device' # str | Aggregation level for results (optional) (default to 'device') - notefile = ['notefile_example'] # List[str] | Filter to specific notefiles (optional) - skip_recent_data = False # bool | When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. (optional) (default to False) - include_notefiles = False # bool | Include per-notefile event counts in the response (optional) (default to False) + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + period = "period_example" # str | Period type for aggregation + start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) + end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) + device_uid = ["device_uid_example"] # List[str] | A Device UID. (optional) + fleet_uid = ["fleet_uid_example"] # List[str] | Filter by Fleet UID (optional) + limit = 200000 # int | Limit the number of data points returned (optional) (default to 200000) + aggregate = ( + "device" # str | Aggregation level for results (optional) (default to 'device') + ) + notefile = [ + "notefile_example" + ] # List[str] | Filter to specific notefiles (optional) + skip_recent_data = False # bool | When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. (optional) (default to False) + include_notefiles = False # bool | Include per-notefile event counts in the response (optional) (default to False) try: - api_response = api_instance.get_events_usage(project_or_product_uid, period, start_date=start_date, end_date=end_date, device_uid=device_uid, fleet_uid=fleet_uid, limit=limit, aggregate=aggregate, notefile=notefile, skip_recent_data=skip_recent_data, include_notefiles=include_notefiles) + api_response = api_instance.get_events_usage( + project_or_product_uid, + period, + start_date=start_date, + end_date=end_date, + device_uid=device_uid, + fleet_uid=fleet_uid, + limit=limit, + aggregate=aggregate, + notefile=notefile, + skip_recent_data=skip_recent_data, + include_notefiles=include_notefiles, + ) print("The response of UsageApi->get_events_usage:\n") pprint(api_response) except Exception as e: @@ -161,29 +184,40 @@ Get route logs usage for a project with time range and period aggregation, when ```python import notehub_py -from notehub_py.models.get_route_logs_usage200_response import GetRouteLogsUsage200Response +from notehub_py.models.get_route_logs_usage200_response import ( + GetRouteLogsUsage200Response, +) from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.UsageApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - period = 'period_example' # str | Period type for aggregation - start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) - end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) - route_uid = ['route_uid_example'] # List[str] | A Route UID. (optional) - limit = 200000 # int | Limit the number of data points returned (optional) (default to 200000) - aggregate = 'route' # str | Aggregation level for results (optional) (default to 'route') - skip_recent_data = False # bool | When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. (optional) (default to False) + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + period = "period_example" # str | Period type for aggregation + start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) + end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) + route_uid = ["route_uid_example"] # List[str] | A Route UID. (optional) + limit = 200000 # int | Limit the number of data points returned (optional) (default to 200000) + aggregate = ( + "route" # str | Aggregation level for results (optional) (default to 'route') + ) + skip_recent_data = False # bool | When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. (optional) (default to False) try: - api_response = api_instance.get_route_logs_usage(project_or_product_uid, period, start_date=start_date, end_date=end_date, route_uid=route_uid, limit=limit, aggregate=aggregate, skip_recent_data=skip_recent_data) + api_response = api_instance.get_route_logs_usage( + project_or_product_uid, + period, + start_date=start_date, + end_date=end_date, + route_uid=route_uid, + limit=limit, + aggregate=aggregate, + skip_recent_data=skip_recent_data, + ) print("The response of UsageApi->get_route_logs_usage:\n") pprint(api_response) except Exception as e: @@ -232,26 +266,36 @@ from notehub_py.models.get_sessions_usage200_response import GetSessionsUsage200 from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.UsageApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - period = 'period_example' # str | Period type for aggregation - start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) - end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) - device_uid = ['device_uid_example'] # List[str] | A Device UID. (optional) - fleet_uid = ['fleet_uid_example'] # List[str] | Filter by Fleet UID (optional) - limit = 200000 # int | Limit the number of data points returned (optional) (default to 200000) - aggregate = 'device' # str | Aggregation level for results (optional) (default to 'device') - skip_recent_data = False # bool | When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. (optional) (default to False) + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + period = "period_example" # str | Period type for aggregation + start_date = 1628631763 # int | Start date for filtering results, specified as a Unix timestamp (optional) + end_date = 1657894210 # int | End date for filtering results, specified as a Unix timestamp (optional) + device_uid = ["device_uid_example"] # List[str] | A Device UID. (optional) + fleet_uid = ["fleet_uid_example"] # List[str] | Filter by Fleet UID (optional) + limit = 200000 # int | Limit the number of data points returned (optional) (default to 200000) + aggregate = ( + "device" # str | Aggregation level for results (optional) (default to 'device') + ) + skip_recent_data = False # bool | When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects. (optional) (default to False) try: - api_response = api_instance.get_sessions_usage(project_or_product_uid, period, start_date=start_date, end_date=end_date, device_uid=device_uid, fleet_uid=fleet_uid, limit=limit, aggregate=aggregate, skip_recent_data=skip_recent_data) + api_response = api_instance.get_sessions_usage( + project_or_product_uid, + period, + start_date=start_date, + end_date=end_date, + device_uid=device_uid, + fleet_uid=fleet_uid, + limit=limit, + aggregate=aggregate, + skip_recent_data=skip_recent_data, + ) print("The response of UsageApi->get_sessions_usage:\n") pprint(api_response) except Exception as e: diff --git a/src/docs/UsageEventsResponse.md b/src/docs/UsageEventsResponse.md index b259666..3bb173a 100644 --- a/src/docs/UsageEventsResponse.md +++ b/src/docs/UsageEventsResponse.md @@ -22,7 +22,9 @@ print(UsageEventsResponse.to_json()) # convert the object into a dict usage_events_response_dict = usage_events_response_instance.to_dict() # create an instance of UsageEventsResponse from a dict -usage_events_response_from_dict = UsageEventsResponse.from_dict(usage_events_response_dict) +usage_events_response_from_dict = UsageEventsResponse.from_dict( + usage_events_response_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/UsageRouteLogsData.md b/src/docs/UsageRouteLogsData.md index 712238a..593a3a0 100644 --- a/src/docs/UsageRouteLogsData.md +++ b/src/docs/UsageRouteLogsData.md @@ -26,7 +26,9 @@ print(UsageRouteLogsData.to_json()) # convert the object into a dict usage_route_logs_data_dict = usage_route_logs_data_instance.to_dict() # create an instance of UsageRouteLogsData from a dict -usage_route_logs_data_from_dict = UsageRouteLogsData.from_dict(usage_route_logs_data_dict) +usage_route_logs_data_from_dict = UsageRouteLogsData.from_dict( + usage_route_logs_data_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/UserDfuStateMachine.md b/src/docs/UserDfuStateMachine.md index 7d1e171..15cd02a 100644 --- a/src/docs/UserDfuStateMachine.md +++ b/src/docs/UserDfuStateMachine.md @@ -24,7 +24,9 @@ print(UserDfuStateMachine.to_json()) # convert the object into a dict user_dfu_state_machine_dict = user_dfu_state_machine_instance.to_dict() # create an instance of UserDfuStateMachine from a dict -user_dfu_state_machine_from_dict = UserDfuStateMachine.from_dict(user_dfu_state_machine_dict) +user_dfu_state_machine_from_dict = UserDfuStateMachine.from_dict( + user_dfu_state_machine_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/UserDfuStateMachineStatus.md b/src/docs/UserDfuStateMachineStatus.md index 28f121a..7fcf692 100644 --- a/src/docs/UserDfuStateMachineStatus.md +++ b/src/docs/UserDfuStateMachineStatus.md @@ -24,7 +24,9 @@ print(UserDfuStateMachineStatus.to_json()) # convert the object into a dict user_dfu_state_machine_status_dict = user_dfu_state_machine_status_instance.to_dict() # create an instance of UserDfuStateMachineStatus from a dict -user_dfu_state_machine_status_from_dict = UserDfuStateMachineStatus.from_dict(user_dfu_state_machine_status_dict) +user_dfu_state_machine_status_from_dict = UserDfuStateMachineStatus.from_dict( + user_dfu_state_machine_status_dict +) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/src/docs/WebhookApi.md b/src/docs/WebhookApi.md index eab91b7..6ff5b68 100644 --- a/src/docs/WebhookApi.md +++ b/src/docs/WebhookApi.md @@ -26,20 +26,26 @@ from notehub_py.models.webhook_settings import WebhookSettings from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.WebhookApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - webhook_uid = 'Abc_123-2646f411-dc56-44a0-9743-4130f47a74h8' # str | Webhook UID - webhook_settings = {"settings":{"disabled":false,"id":"Abc_123-2646f411-dc56-44a0-9743-4130f47a74h8","transform":"{\"device\":body.end_device_ids.dev_eui,\"sn\":body.end_device_ids.device_id,\"body\":body.uplink_message.decoded_payload,\"details\":body}"}} # WebhookSettings | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + webhook_uid = "Abc_123-2646f411-dc56-44a0-9743-4130f47a74h8" # str | Webhook UID + webhook_settings = { + "settings": { + "disabled": false, + "id": "Abc_123-2646f411-dc56-44a0-9743-4130f47a74h8", + "transform": '{"device":body.end_device_ids.dev_eui,"sn":body.end_device_ids.device_id,"body":body.uplink_message.decoded_payload,"details":body}', + } + } # WebhookSettings | try: - api_instance.create_webhook(project_or_product_uid, webhook_uid, webhook_settings) + api_instance.create_webhook( + project_or_product_uid, webhook_uid, webhook_settings + ) except Exception as e: print("Exception when calling WebhookApi->create_webhook: %s\n" % e) ``` @@ -80,16 +86,14 @@ import notehub_py from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.WebhookApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - webhook_uid = 'Abc_123-2646f411-dc56-44a0-9743-4130f47a74h8' # str | Webhook UID + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + webhook_uid = "Abc_123-2646f411-dc56-44a0-9743-4130f47a74h8" # str | Webhook UID try: api_instance.delete_webhook(project_or_product_uid, webhook_uid) @@ -133,16 +137,14 @@ from notehub_py.models.webhook_settings import WebhookSettings from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.WebhookApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - webhook_uid = 'Abc_123-2646f411-dc56-44a0-9743-4130f47a74h8' # str | Webhook UID + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + webhook_uid = "Abc_123-2646f411-dc56-44a0-9743-4130f47a74h8" # str | Webhook UID try: api_response = api_instance.get_webhook(project_or_product_uid, webhook_uid) @@ -188,15 +190,13 @@ from notehub_py.models.get_webhooks200_response import GetWebhooks200Response from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.WebhookApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | try: api_response = api_instance.get_webhooks(project_or_product_uid) @@ -241,20 +241,23 @@ from notehub_py.models.webhook_settings import WebhookSettings from notehub_py.rest import ApiException from pprint import pprint -configuration = notehub_py.Configuration( - access_token = "PERSONAL_ACCESS_TOKEN" -) +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.WebhookApi(api_client) - project_or_product_uid = 'app:2606f411-dea6-44a0-9743-1130f57d77d8' # str | - webhook_uid = 'Abc_123-2646f411-dc56-44a0-9743-4130f47a74h8' # str | Webhook UID - webhook_settings = {"disabled":false,"transform":"{\"device\":body.end_device_ids.dev_eui,\"sn\":body.end_device_ids.device_id,\"body\":body.uplink_message.decoded_payload,\"details\":body}"} # WebhookSettings | + project_or_product_uid = "app:2606f411-dea6-44a0-9743-1130f57d77d8" # str | + webhook_uid = "Abc_123-2646f411-dc56-44a0-9743-4130f47a74h8" # str | Webhook UID + webhook_settings = { + "disabled": false, + "transform": '{"device":body.end_device_ids.dev_eui,"sn":body.end_device_ids.device_id,"body":body.uplink_message.decoded_payload,"details":body}', + } # WebhookSettings | try: - api_instance.update_webhook(project_or_product_uid, webhook_uid, webhook_settings) + api_instance.update_webhook( + project_or_product_uid, webhook_uid, webhook_settings + ) except Exception as e: print("Exception when calling WebhookApi->update_webhook: %s\n" % e) ```