From 16cb25b22e6a751a602462eadd68dffe469e6535 Mon Sep 17 00:00:00 2001 From: TJ VanToll Date: Wed, 8 Apr 2026 12:27:35 -0400 Subject: [PATCH] feat: more doc consistency changes --- lib_template/api_doc.mustache | 14 +- src/docs/AlertApi.md | 9 +- src/docs/AuthorizationApi.md | 21 +- src/docs/BillingAccountApi.md | 27 +-- src/docs/DeviceApi.md | 262 +++--------------------- src/docs/EventApi.md | 45 +---- src/docs/ExternalDevicesApi.md | 27 +-- src/docs/JobsApi.md | 79 +------- src/docs/MonitorApi.md | 45 +---- src/docs/ProjectApi.md | 351 ++++----------------------------- src/docs/RouteApi.md | 54 +---- src/docs/UsageApi.md | 36 +--- src/docs/WebhookApi.md | 45 +---- 13 files changed, 113 insertions(+), 902 deletions(-) diff --git a/lib_template/api_doc.mustache b/lib_template/api_doc.mustache index d3e270e..162edc9 100644 --- a/lib_template/api_doc.mustache +++ b/lib_template/api_doc.mustache @@ -10,7 +10,9 @@ Method | HTTP request | Description {{#operations}} {{#operation}} -## **{{{operationId}}}** + +## {{{operationId}}} + > {{#returnType}}{{{.}}} {{/returnType}}{{{operationId}}}({{#allParams}}{{#required}}{{{paramName}}}{{/required}}{{^required}}{{{paramName}}}={{{paramName}}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}}) {{{summary}}}{{#notes}} @@ -60,15 +62,5 @@ Name | Type | Description | Notes - **Content-Type**: {{#consumes}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/consumes}}{{^consumes}}Not defined{{/consumes}} - **Accept**: {{#produces}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/produces}}{{^produces}}Not defined{{/produces}} -{{#responses.0}} -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -{{#responses}} -**{{code}}** | {{message}} | {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}} | -{{/responses}} -{{/responses.0}} - {{/operation}} {{/operations}} diff --git a/src/docs/AlertApi.md b/src/docs/AlertApi.md index 7f81e3a..7a51a65 100644 --- a/src/docs/AlertApi.md +++ b/src/docs/AlertApi.md @@ -6,7 +6,7 @@ All URIs are relative to *https://api.notefile.net* | ---------------------------------------- | ------------------------------------------------- | ----------- | | [**get_alerts**](AlertApi.md#get_alerts) | **GET** /v1/projects/{projectOrProductUID}/alerts | -## **get_alerts** +## get_alerts > GetAlerts200Response get_alerts(project_or_product_uid, page_size=page_size, page_num=page_num, monitor_uid=monitor_uid) @@ -76,10 +76,3 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | The response body from GET /alerts | - | -| **0** | The response body in case of an API error. | - | diff --git a/src/docs/AuthorizationApi.md b/src/docs/AuthorizationApi.md index 69dac47..6f5c5e7 100644 --- a/src/docs/AuthorizationApi.md +++ b/src/docs/AuthorizationApi.md @@ -7,7 +7,7 @@ All URIs are relative to *https://api.notefile.net* | [**login**](AuthorizationApi.md#login) | **POST** /auth/login | | [**o_auth2_client_credentials**](AuthorizationApi.md#o_auth2_client_credentials) | **POST** /oauth2/token | Issue an OAuth 2.0 access token (Client Credentials) | -## **login** +## login > Login200Response login(login_request) @@ -62,15 +62,7 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | --------------------- | ---------------- | -| **200** | Successful operation | - | -| **400** | Bad Request | - | -| **500** | Internal Server Error | - | - -## **o_auth2_client_credentials** +## o_auth2_client_credentials > OAuth2TokenResponse o_auth2_client_credentials(client_id, client_secret, grant_type, scope=scope) @@ -132,12 +124,3 @@ No authorization required - **Content-Type**: application/x-www-form-urlencoded - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------------- | ---------------- | -| **200** | Successful token response | - | -| **400** | Invalid request (missing or malformed parameters) | - | -| **401** | Invalid client authentication | - | -| **403** | Unauthorized scope | - | diff --git a/src/docs/BillingAccountApi.md b/src/docs/BillingAccountApi.md index 32ed25d..8be1fde 100644 --- a/src/docs/BillingAccountApi.md +++ b/src/docs/BillingAccountApi.md @@ -8,7 +8,7 @@ All URIs are relative to *https://api.notefile.net* | [**get_billing_account_balance_history**](BillingAccountApi.md#get_billing_account_balance_history) | **GET** /v1/billing-accounts/{billingAccountUID}/balance-history | | [**get_billing_accounts**](BillingAccountApi.md#get_billing_accounts) | **GET** /v1/billing-accounts | -## **get_billing_account** +## get_billing_account > GetBillingAccount200Response get_billing_account(billing_account_uid) @@ -73,14 +73,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **get_billing_account_balance_history** +## get_billing_account_balance_history > GetBillingAccountBalanceHistory200Response get_billing_account_balance_history(billing_account_uid, start_date=start_date, end_date=end_date) @@ -149,14 +142,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **get_billing_accounts** +## get_billing_accounts > GetBillingAccounts200Response get_billing_accounts() @@ -217,10 +203,3 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | diff --git a/src/docs/DeviceApi.md b/src/docs/DeviceApi.md index 5f1b7e8..cff5654 100644 --- a/src/docs/DeviceApi.md +++ b/src/docs/DeviceApi.md @@ -34,7 +34,7 @@ All URIs are relative to *https://api.notefile.net* | [**signal_device**](DeviceApi.md#signal_device) | **POST** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/signal | | [**update_db_note**](DeviceApi.md#update_db_note) | **PUT** /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID} | -## **add_db_note** +## add_db_note > add_db_note(project_or_product_uid, device_uid, notefile_id, note_id, note_input) @@ -105,14 +105,7 @@ void (empty response body) - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | An empty object means success | - | -| **0** | The response body in case of an API error. | - | - -## **add_qi_note** +## add_qi_note > add_qi_note(project_or_product_uid, device_uid, notefile_id, note_input) @@ -181,14 +174,7 @@ void (empty response body) - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | An empty object means success | - | -| **0** | The response body in case of an API error. | - | - -## **create_notefile** +## create_notefile > create_notefile(project_or_product_uid, device_uid, notefile_id) @@ -254,14 +240,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | An empty object means success | - | -| **0** | The response body in case of an API error. | - | - -## **delete_device** +## delete_device > delete_device(project_or_product_uid, device_uid) @@ -325,14 +304,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **204** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **delete_device_environment_variable** +## delete_device_environment_variable > EnvironmentVariables delete_device_environment_variable(project_or_product_uid, device_uid, key) @@ -401,14 +373,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | -------------------------------------------------------- | ---------------- | -| **200** | The response body from an environment variables request. | - | -| **0** | The response body in case of an API error. | - | - -## **delete_note** +## delete_note > delete_note(project_or_product_uid, device_uid, notefile_id, note_id) @@ -476,14 +441,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | An empty object means success | - | -| **0** | The response body in case of an API error. | - | - -## **delete_notefiles** +## delete_notefiles > delete_notefiles(project_or_product_uid, device_uid, delete_notefiles_request) @@ -550,14 +508,7 @@ void (empty response body) - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | An empty object means success | - | -| **0** | The response body in case of an API error. | - | - -## **disable_device** +## disable_device > disable_device(project_or_product_uid, device_uid) @@ -621,14 +572,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **enable_device** +## enable_device > enable_device(project_or_product_uid, device_uid) @@ -692,14 +636,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **get_db_note** +## get_db_note > GetDbNote200Response get_db_note(project_or_product_uid, device_uid, notefile_id, note_id, delete=delete, deleted=deleted) @@ -774,14 +711,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | The requested note | - | -| **0** | The response body in case of an API error. | - | - -## **get_device** +## get_device > Device get_device(project_or_product_uid, device_uid) @@ -848,14 +778,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **get_device_environment_hierarchy** +## get_device_environment_hierarchy > EnvTreeJsonNode get_device_environment_hierarchy(project_or_product_uid, device_uid) @@ -923,15 +846,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | --------------------------------------------------- | ---------------- | -| **200** | Successfully retrieved device environment hierarchy | - | -| **404** | Project or device not found | - | -| **500** | Server error | - | - -## **get_device_environment_variables** +## get_device_environment_variables > GetDeviceEnvironmentVariablesByPin200Response get_device_environment_variables(project_or_product_uid, device_uid) @@ -998,14 +913,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------------------------------ | ---------------- | -| **200** | The response body from a get device environment variables request. | - | -| **0** | The response body in case of an API error. | - | - -## **get_device_environment_variables_by_pin** +## get_device_environment_variables_by_pin > GetDeviceEnvironmentVariablesByPin200Response get_device_environment_variables_by_pin(product_uid, device_uid, x_auth_token) @@ -1063,14 +971,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------------------------------ | ---------------- | -| **200** | The response body from a get device environment variables request. | - | -| **0** | The response body in case of an API error. | - | - -## **get_device_health_log** +## get_device_health_log > GetDeviceHealthLog200Response get_device_health_log(project_or_product_uid, device_uid, start_date=start_date, end_date=end_date, log_type=log_type) @@ -1143,14 +1044,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **get_device_latest_events** +## get_device_latest_events > GetDeviceLatestEvents200Response get_device_latest_events(project_or_product_uid, device_uid) @@ -1217,14 +1111,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ---------------------------------------------- | ---------------- | -| **200** | The response body for a Latest Events request. | - | -| **0** | The response body in case of an API error. | - | - -## **get_device_plans** +## get_device_plans > GetDevicePlans200Response get_device_plans(project_or_product_uid, device_uid) @@ -1291,14 +1178,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Response body for /plans | - | -| **0** | The response body in case of an API error. | - | - -## **get_device_public_key** +## get_device_public_key > GetDevicePublicKey200Response get_device_public_key(project_or_product_uid, device_uid) @@ -1365,14 +1245,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **get_device_public_keys** +## get_device_public_keys > GetDevicePublicKeys200Response get_device_public_keys(project_or_product_uid, page_size=page_size, page_num=page_num) @@ -1441,14 +1314,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **get_device_sessions** +## get_device_sessions > GetDeviceSessions200Response 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) @@ -1525,14 +1391,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | The response body for a session request. | - | -| **0** | The response body in case of an API error. | - | - -## **get_devices** +## get_devices > GetDevices200Response 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) @@ -1619,14 +1478,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | List of Devices | - | -| **0** | The response body in case of an API error. | - | - -## **get_fleet_devices** +## get_fleet_devices > GetDevices200Response 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) @@ -1713,14 +1565,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | List of Devices | - | -| **0** | The response body in case of an API error. | - | - -## **get_notefile** +## get_notefile > GetNotefile200Response get_notefile(project_or_product_uid, device_uid, notefile_id, max=max, deleted=deleted, delete=delete) @@ -1795,14 +1640,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | The note changes object | - | -| **0** | The response body in case of an API error. | - | - -## **list_notefiles** +## list_notefiles > List[Notefile] list_notefiles(project_or_product_uid, device_uid, files=files, pending=pending) @@ -1873,14 +1711,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | All notefiles and their notes | - | -| **0** | The response body in case of an API error. | - | - -## **provision_device** +## provision_device > object provision_device(project_or_product_uid, device_uid, provision_device_request) @@ -1949,14 +1780,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **set_device_environment_variables** +## set_device_environment_variables > EnvironmentVariables set_device_environment_variables(project_or_product_uid, device_uid, environment_variables) @@ -2025,14 +1849,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | -------------------------------------------------------- | ---------------- | -| **200** | The response body from an environment variables request. | - | -| **0** | The response body in case of an API error. | - | - -## **set_device_environment_variables_by_pin** +## set_device_environment_variables_by_pin > EnvironmentVariables set_device_environment_variables_by_pin(product_uid, device_uid, x_auth_token, environment_variables) @@ -2092,14 +1909,7 @@ No authorization required - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | -------------------------------------------------------- | ---------------- | -| **200** | The response body from an environment variables request. | - | -| **0** | The response body in case of an API error. | - | - -## **signal_device** +## signal_device > SignalDevice200Response signal_device(project_or_product_uid, device_uid, body) @@ -2169,14 +1979,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | A status response. | - | -| **0** | The response body in case of an API error. | - | - -## **update_db_note** +## update_db_note > update_db_note(project_or_product_uid, device_uid, notefile_id, note_id, note_input) @@ -2246,10 +2049,3 @@ void (empty response body) - **Content-Type**: application/json - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | An empty object means success | - | -| **0** | The response body in case of an API error. | - | diff --git a/src/docs/EventApi.md b/src/docs/EventApi.md index 0270804..015d60f 100644 --- a/src/docs/EventApi.md +++ b/src/docs/EventApi.md @@ -10,7 +10,7 @@ All URIs are relative to *https://api.notefile.net* | [**get_fleet_events_by_cursor**](EventApi.md#get_fleet_events_by_cursor) | **GET** /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events-cursor | | [**get_route_logs_by_event**](EventApi.md#get_route_logs_by_event) | **GET** /v1/projects/{projectOrProductUID}/events/{eventUID}/route-logs | -## **get_events** +## get_events > GetEvents200Response 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) @@ -107,14 +107,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json, text/csv -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | -------------------------------------------- | -------------------------------------------------- | -| **200** | The response body from a GET events request. | \* X-Has-More - True if there are more events
| -| **0** | The response body in case of an API error. | - | - -## **get_events_by_cursor** +## get_events_by_cursor > GetEventsByCursor200Response 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) @@ -193,14 +186,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------------------ | ---------------- | -| **200** | The response body from a GET events by cursor request. | - | -| **0** | The response body in case of an API error. | - | - -## **get_fleet_events** +## get_fleet_events > GetEvents200Response 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) @@ -297,14 +283,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json, text/csv -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | -------------------------------------------- | -------------------------------------------------- | -| **200** | The response body from a GET events request. | \* X-Has-More - True if there are more events
| -| **0** | The response body in case of an API error. | - | - -## **get_fleet_events_by_cursor** +## get_fleet_events_by_cursor > GetEventsByCursor200Response 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) @@ -387,14 +366,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------------------ | ---------------- | -| **200** | The response body from a GET events by cursor request. | - | -| **0** | The response body in case of an API error. | - | - -## **get_route_logs_by_event** +## get_route_logs_by_event > List[RouteLog] get_route_logs_by_event(project_or_product_uid, event_uid) @@ -460,10 +432,3 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | diff --git a/src/docs/ExternalDevicesApi.md b/src/docs/ExternalDevicesApi.md index 4edfbd2..0c7378c 100644 --- a/src/docs/ExternalDevicesApi.md +++ b/src/docs/ExternalDevicesApi.md @@ -8,7 +8,7 @@ All URIs are relative to *https://api.notefile.net* | [**ext_device_session_close**](ExternalDevicesApi.md#ext_device_session_close) | **POST** /v1/products/{productUID}/ext-devices/{deviceUID}/session/close | | [**ext_device_session_open**](ExternalDevicesApi.md#ext_device_session_open) | **POST** /v1/products/{productUID}/ext-devices/{deviceUID}/session/open | -## **create_event_ext_device** +## create_event_ext_device > create_event_ext_device(product_uid, device_uid, event) @@ -75,14 +75,7 @@ void (empty response body) - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Event Created Successfully | - | -| **0** | The response body in case of an API error. | - | - -## **ext_device_session_close** +## ext_device_session_close > ext_device_session_close(product_uid, device_uid, device_session) @@ -149,14 +142,7 @@ void (empty response body) - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Session closed | - | -| **0** | The response body in case of an API error. | - | - -## **ext_device_session_open** +## ext_device_session_open > ext_device_session_open(product_uid, device_uid, device_session) @@ -222,10 +208,3 @@ void (empty response body) - **Content-Type**: application/json - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Session Created Successfully | - | -| **0** | The response body in case of an API error. | - | diff --git a/src/docs/JobsApi.md b/src/docs/JobsApi.md index 1eec2b2..43e9990 100644 --- a/src/docs/JobsApi.md +++ b/src/docs/JobsApi.md @@ -13,7 +13,7 @@ All URIs are relative to *https://api.notefile.net* | [**get_jobs**](JobsApi.md#get_jobs) | **GET** /v1/projects/{projectOrProductUID}/jobs | | [**run_job**](JobsApi.md#run_job) | **POST** /v1/projects/{projectOrProductUID}/jobs/{jobUID}/run | -## **cancel_job_run** +## cancel_job_run > CancelJobRun200Response cancel_job_run(project_or_product_uid, report_uid) @@ -80,15 +80,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Cancel operation completed | - | -| **404** | Run not found | - | -| **0** | The response body in case of an API error. | - | - -## **create_job** +## create_job > CreateJob201Response create_job(project_or_product_uid, name, body) @@ -157,15 +149,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | --------------------------------------------------------- | ---------------- | -| **201** | Job created successfully | - | -| **400** | Missing required name parameter or invalid job definition | - | -| **0** | The response body in case of an API error. | - | - -## **delete_job** +## delete_job > DeleteJob200Response delete_job(project_or_product_uid, job_uid) @@ -232,15 +216,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Job deleted successfully | - | -| **404** | Job not found | - | -| **0** | The response body in case of an API error. | - | - -## **get_job** +## get_job > Job get_job(project_or_product_uid, job_uid) @@ -307,15 +283,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Batch job details | - | -| **404** | Job not found | - | -| **0** | The response body in case of an API error. | - | - -## **get_job_run** +## get_job_run > JobRun get_job_run(project_or_product_uid, report_uid) @@ -382,15 +350,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Job run details | - | -| **404** | Run not found | - | -| **0** | The response body in case of an API error. | - | - -## **get_job_runs** +## get_job_runs > GetJobRuns200Response get_job_runs(project_or_product_uid, job_uid, status=status, dry_run=dry_run) @@ -461,15 +421,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | List of job runs | - | -| **404** | Job not found | - | -| **0** | The response body in case of an API error. | - | - -## **get_jobs** +## get_jobs > GetJobs200Response get_jobs(project_or_product_uid) @@ -534,14 +486,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | List of batch jobs | - | -| **0** | The response body in case of an API error. | - | - -## **run_job** +## run_job > RunJob200Response run_job(project_or_product_uid, job_uid, dry_run=dry_run) @@ -609,11 +554,3 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Job execution started | - | -| **404** | Job not found | - | -| **0** | The response body in case of an API error. | - | diff --git a/src/docs/MonitorApi.md b/src/docs/MonitorApi.md index 54d8fe4..5237137 100644 --- a/src/docs/MonitorApi.md +++ b/src/docs/MonitorApi.md @@ -10,7 +10,7 @@ All URIs are relative to *https://api.notefile.net* | [**get_monitors**](MonitorApi.md#get_monitors) | **GET** /v1/projects/{projectOrProductUID}/monitors | | [**update_monitor**](MonitorApi.md#update_monitor) | **PUT** /v1/projects/{projectOrProductUID}/monitors/{monitorUID} | -## **create_monitor** +## create_monitor > Monitor create_monitor(project_or_product_uid, body) @@ -78,14 +78,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **201** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **delete_monitor** +## delete_monitor > Monitor delete_monitor(project_or_product_uid, monitor_uid) @@ -152,14 +145,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **get_monitor** +## get_monitor > Monitor get_monitor(project_or_product_uid, monitor_uid) @@ -226,14 +212,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **get_monitors** +## get_monitors > List[Monitor] get_monitors(project_or_product_uid) @@ -298,14 +277,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | The response body from GET /monitors | - | -| **0** | The response body in case of an API error. | - | - -## **update_monitor** +## update_monitor > Monitor update_monitor(project_or_product_uid, monitor_uid, monitor) @@ -373,10 +345,3 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: application/json - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | diff --git a/src/docs/ProjectApi.md b/src/docs/ProjectApi.md index 82ecbee..4cb25a0 100644 --- a/src/docs/ProjectApi.md +++ b/src/docs/ProjectApi.md @@ -44,7 +44,7 @@ All URIs are relative to *https://api.notefile.net* | [**update_fleet**](ProjectApi.md#update_fleet) | **PUT** /v1/projects/{projectOrProductUID}/fleets/{fleetUID} | | [**upload_firmware**](ProjectApi.md#upload_firmware) | **PUT** /v1/projects/{projectOrProductUID}/firmware/{firmwareType}/{filename} | -## **add_device_to_fleets** +## add_device_to_fleets > GetDeviceFleets200Response add_device_to_fleets(project_or_product_uid, device_uid, add_device_to_fleets_request) @@ -114,14 +114,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | The response body from a fleets endpoint. | - | -| **0** | The response body in case of an API error. | - | - -## **clone_project** +## clone_project > Project clone_project(project_or_product_uid, clone_project_request) @@ -189,14 +182,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **201** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **create_fleet** +## create_fleet > Fleet create_fleet(project_or_product_uid, create_fleet_request) @@ -264,14 +250,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **201** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **create_product** +## create_product > Product create_product(project_or_product_uid, create_product_request) @@ -339,14 +318,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **201** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **create_project** +## create_project > Project create_project(create_project_request) @@ -412,14 +384,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **201** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **delete_device_from_fleets** +## delete_device_from_fleets > GetDeviceFleets200Response delete_device_from_fleets(project_or_product_uid, device_uid, delete_device_from_fleets_request) @@ -489,14 +454,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | The response body from a fleets endpoint. | - | -| **0** | The response body in case of an API error. | - | - -## **delete_fleet** +## delete_fleet > delete_fleet(project_or_product_uid, fleet_uid) @@ -560,14 +518,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **204** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **delete_fleet_environment_variable** +## delete_fleet_environment_variable > EnvironmentVariables delete_fleet_environment_variable(project_or_product_uid, fleet_uid, key) @@ -636,14 +587,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | -------------------------------------------------------- | ---------------- | -| **200** | The response body from an environment variables request. | - | -| **0** | The response body in case of an API error. | - | - -## **delete_product** +## delete_product > delete_product(project_or_product_uid, product_uid) @@ -707,14 +651,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **204** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **delete_project** +## delete_project > delete_project(project_or_product_uid) @@ -776,14 +713,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **delete_project_environment_variable** +## delete_project_environment_variable > EnvironmentVariables delete_project_environment_variable(project_or_product_uid, key) @@ -850,14 +780,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | -------------------------------------------------------- | ---------------- | -| **200** | The response body from an environment variables request. | - | -| **0** | The response body in case of an API error. | - | - -## **disable_global_event_transformation** +## disable_global_event_transformation > disable_global_event_transformation(project_or_product_uid) @@ -919,14 +842,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **download_firmware** +## download_firmware > bytearray download_firmware(project_or_product_uid, firmware_type, filename) @@ -994,14 +910,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/octet-stream, application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Firmware binary | - | -| **0** | The response body in case of an API error. | - | - -## **enable_global_event_transformation** +## enable_global_event_transformation > enable_global_event_transformation(project_or_product_uid) @@ -1063,14 +972,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **get_aws_role_config** +## get_aws_role_config > AWSRoleConfig get_aws_role_config(project_or_product_uid) @@ -1138,14 +1040,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | AWS role configuration | - | -| **0** | The response body in case of an API error. | - | - -## **get_device_dfu_history** +## get_device_dfu_history > DeviceDfuHistory get_device_dfu_history(project_or_product_uid, device_uid, firmware_type) @@ -1214,14 +1109,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Success | - | -| **0** | The response body in case of an API error. | - | - -## **get_device_dfu_status** +## get_device_dfu_status > DeviceDfuStatus get_device_dfu_status(project_or_product_uid, device_uid, firmware_type) @@ -1290,14 +1178,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Success | - | -| **0** | The response body in case of an API error. | - | - -## **get_device_fleets** +## get_device_fleets > GetDeviceFleets200Response get_device_fleets(project_or_product_uid, device_uid) @@ -1364,14 +1245,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | The response body from a fleets endpoint. | - | -| **0** | The response body in case of an API error. | - | - -## **get_devices_dfu_history** +## get_devices_dfu_history > DeviceDfuHistoryPage 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) @@ -1464,14 +1338,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Success | - | -| **0** | The response body in case of an API error. | - | - -## **get_devices_dfu_status** +## get_devices_dfu_status > DeviceDfuStatusPage 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) @@ -1564,14 +1431,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Success | - | -| **0** | The response body in case of an API error. | - | - -## **get_firmware_info** +## get_firmware_info > List[FirmwareInfo] 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) @@ -1654,14 +1514,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Success | - | -| **0** | The response body in case of an API error. | - | - -## **get_fleet** +## get_fleet > Fleet get_fleet(project_or_product_uid, fleet_uid) @@ -1728,13 +1581,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | -------------------- | ---------------- | -| **200** | Successful operation | - | - -## **get_fleet_environment_hierarchy** +## get_fleet_environment_hierarchy > EnvTreeJsonNode get_fleet_environment_hierarchy(project_or_product_uid, fleet_uid) @@ -1802,15 +1649,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | -------------------------------------------------- | ---------------- | -| **200** | Successfully retrieved fleet environment hierarchy | - | -| **404** | Project or device not found | - | -| **500** | Server error | - | - -## **get_fleet_environment_variables** +## get_fleet_environment_variables > EnvironmentVariables get_fleet_environment_variables(project_or_product_uid, fleet_uid) @@ -1877,14 +1716,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | -------------------------------------------------------- | ---------------- | -| **200** | The response body from an environment variables request. | - | -| **0** | The response body in case of an API error. | - | - -## **get_fleets** +## get_fleets > GetDeviceFleets200Response get_fleets(project_or_product_uid) @@ -1949,14 +1781,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | The response body from a fleets endpoint. | - | -| **0** | The response body in case of an API error. | - | - -## **get_notefile_schemas** +## get_notefile_schemas > List[NotefileSchema] get_notefile_schemas(project_or_product_uid) @@ -2011,13 +1836,7 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ----------------------------------- | ---------------- | -| **200** | List of notefile schema definitions | - | - -## **get_products** +## get_products > GetProducts200Response get_products(project_or_product_uid) @@ -2082,14 +1901,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **get_project** +## get_project > Project get_project(project_or_product_uid) @@ -2154,14 +1966,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **get_project_by_product** +## get_project_by_product > Project get_project_by_product(product_uid) @@ -2226,14 +2031,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **get_project_environment_hierarchy** +## get_project_environment_hierarchy > EnvTreeJsonNode get_project_environment_hierarchy(project_or_product_uid) @@ -2299,15 +2097,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ---------------------------------------------------- | ---------------- | -| **200** | Successfully retrieved project environment hierarchy | - | -| **404** | Project or device not found | - | -| **500** | Server error | - | - -## **get_project_environment_variables** +## get_project_environment_variables > EnvironmentVariables get_project_environment_variables(project_or_product_uid) @@ -2372,14 +2162,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | -------------------------------------------------------- | ---------------- | -| **200** | The response body from an environment variables request. | - | -| **0** | The response body in case of an API error. | - | - -## **get_project_members** +## get_project_members > GetProjectMembers200Response get_project_members(project_or_product_uid) @@ -2444,14 +2227,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **get_projects** +## get_projects > GetProjects200Response get_projects() @@ -2513,14 +2289,7 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **perform_dfu_action** +## perform_dfu_action > 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) @@ -2607,14 +2376,7 @@ void (empty response body) - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Success | - | -| **0** | The response body in case of an API error. | - | - -## **set_fleet_environment_variables** +## set_fleet_environment_variables > EnvironmentVariables set_fleet_environment_variables(project_or_product_uid, fleet_uid, environment_variables) @@ -2683,14 +2445,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | -------------------------------------------------------- | ---------------- | -| **200** | The response body from an environment variables request. | - | -| **0** | The response body in case of an API error. | - | - -## **set_global_event_transformation** +## set_global_event_transformation > set_global_event_transformation(project_or_product_uid, body) @@ -2754,14 +2509,7 @@ void (empty response body) - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **set_project_environment_variables** +## set_project_environment_variables > EnvironmentVariables set_project_environment_variables(project_or_product_uid, environment_variables=environment_variables) @@ -2828,14 +2576,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | -------------------------------------------------------- | ---------------- | -| **200** | The response body from an environment variables request. | - | -| **0** | The response body in case of an API error. | - | - -## **update_fleet** +## update_fleet > Fleet update_fleet(project_or_product_uid, fleet_uid, update_fleet_request) @@ -2905,14 +2646,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **upload_firmware** +## upload_firmware > FirmwareInfo upload_firmware(project_or_product_uid, firmware_type, filename, body, version=version, notes=notes) @@ -2986,10 +2720,3 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: application/octet-stream - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Upload successful | - | -| **0** | The response body in case of an API error. | - | diff --git a/src/docs/RouteApi.md b/src/docs/RouteApi.md index 8ab1502..f9c6a6a 100644 --- a/src/docs/RouteApi.md +++ b/src/docs/RouteApi.md @@ -11,7 +11,7 @@ All URIs are relative to *https://api.notefile.net* | [**get_routes**](RouteApi.md#get_routes) | **GET** /v1/projects/{projectOrProductUID}/routes | | [**update_route**](RouteApi.md#update_route) | **PUT** /v1/projects/{projectOrProductUID}/routes/{routeUID} | -## **create_route** +## create_route > NotehubRoute create_route(project_or_product_uid, notehub_route) @@ -78,14 +78,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **201** | Created | - | -| **0** | The response body in case of an API error. | - | - -## **delete_route** +## delete_route > delete_route(project_or_product_uid, route_uid) @@ -149,14 +142,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **204** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **get_route** +## get_route > NotehubRoute get_route(project_or_product_uid, route_uid) @@ -223,14 +209,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **get_route_logs_by_route** +## get_route_logs_by_route > List[RouteLog] get_route_logs_by_route(project_or_product_uid, route_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, system_files_only=system_files_only, most_recent_only=most_recent_only, files=files, routing_status=routing_status, response_status=response_status) @@ -321,14 +300,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **get_routes** +## get_routes > List[NotehubRouteSummary] get_routes(project_or_product_uid) @@ -393,14 +365,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **update_route** +## update_route > NotehubRoute update_route(project_or_product_uid, route_uid, notehub_route) @@ -479,10 +444,3 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: application/json - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | diff --git a/src/docs/UsageApi.md b/src/docs/UsageApi.md index b4de860..752d7d3 100644 --- a/src/docs/UsageApi.md +++ b/src/docs/UsageApi.md @@ -9,7 +9,7 @@ All URIs are relative to *https://api.notefile.net* | [**get_route_logs_usage**](UsageApi.md#get_route_logs_usage) | **GET** /v1/projects/{projectOrProductUID}/usage/route-logs | | [**get_sessions_usage**](UsageApi.md#get_sessions_usage) | **GET** /v1/projects/{projectOrProductUID}/usage/sessions | -## **get_data_usage** +## get_data_usage > GetDataUsage200Response 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) @@ -88,14 +88,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Response body for Data Usage | - | -| **0** | The response body in case of an API error. | - | - -## **get_events_usage** +## get_events_usage > UsageEventsResponse 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) @@ -180,14 +173,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Successful operation | - | -| **0** | The response body in case of an API error. | - | - -## **get_route_logs_usage** +## get_route_logs_usage > GetRouteLogsUsage200Response 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) @@ -266,14 +252,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Response body for Route Log Usage | - | -| **0** | The response body in case of an API error. | - | - -## **get_sessions_usage** +## get_sessions_usage > GetSessionsUsage200Response 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) @@ -353,10 +332,3 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Response body for Session Usage | - | -| **0** | The response body in case of an API error. | - | diff --git a/src/docs/WebhookApi.md b/src/docs/WebhookApi.md index 9ebcd2a..72c9b27 100644 --- a/src/docs/WebhookApi.md +++ b/src/docs/WebhookApi.md @@ -10,7 +10,7 @@ All URIs are relative to *https://api.notefile.net* | [**get_webhooks**](WebhookApi.md#get_webhooks) | **GET** /v1/projects/{projectOrProductUID}/webhooks | | [**update_webhook**](WebhookApi.md#update_webhook) | **PUT** /v1/projects/{projectOrProductUID}/webhooks/{webhookUID} | -## **create_webhook** +## create_webhook > create_webhook(project_or_product_uid, webhook_uid, webhook_settings) @@ -77,14 +77,7 @@ void (empty response body) - **Content-Type**: application/json - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Webhook created successfully | - | -| **0** | The response body in case of an API error. | - | - -## **delete_webhook** +## delete_webhook > delete_webhook(project_or_product_uid, webhook_uid) @@ -148,14 +141,7 @@ void (empty response body) - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Webhook deleted successfully | - | -| **0** | The response body in case of an API error. | - | - -## **get_webhook** +## get_webhook > WebhookSettings get_webhook(project_or_product_uid, webhook_uid) @@ -222,14 +208,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Webhook settings retrieved successfully | - | -| **0** | The response body in case of an API error. | - | - -## **get_webhooks** +## get_webhooks > GetWebhooks200Response get_webhooks(project_or_product_uid) @@ -294,14 +273,7 @@ with notehub_py.ApiClient(configuration) as api_client: - **Content-Type**: Not defined - **Accept**: application/json -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Webhooks retrieved successfully | - | -| **0** | The response body in case of an API error. | - | - -## **update_webhook** +## update_webhook > update_webhook(project_or_product_uid, webhook_uid, webhook_settings) @@ -367,10 +339,3 @@ void (empty response body) - **Content-Type**: application/json - **Accept**: application/json - -### HTTP response details - -| Status code | Description | Response headers | -| ----------- | ------------------------------------------ | ---------------- | -| **200** | Webhook updated successfully | - | -| **0** | The response body in case of an API error. | - |