From 9b015508b61927dd092bce4cb416c9c776a2aac2 Mon Sep 17 00:00:00 2001 From: github-actions Date: Tue, 23 Sep 2025 20:41:06 +0000 Subject: [PATCH 1/4] feat: Update OpenAPI file replicated from Notehub commit 1341f79 --- openapi.yaml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/openapi.yaml b/openapi.yaml index 39e47f0..6751db3 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1531,6 +1531,18 @@ paths: required: true schema: type: string + - name: version + in: query + description: 'Firmware version (optional). If not provided, the version will be extracted from firmware binary if available, otherwise left empty' + required: false + schema: + type: string + - name: notes + in: query + description: Optional notes describing what's different about this firmware version + required: false + schema: + type: string requestBody: description: contents of the firmware binary required: true @@ -4784,6 +4796,9 @@ components: type: string type: type: string + version: + description: User-specified version string provided at time of upload + type: string UsageData: type: object properties: From f5ad1567553fd724dbccccd57f23c0599cb0da9a Mon Sep 17 00:00:00 2001 From: github-actions Date: Wed, 24 Sep 2025 13:48:42 +0000 Subject: [PATCH 2/4] feat: Update OpenAPI file replicated from Notehub commit 2d4771d --- openapi.yaml | 194 +++++++++++++++++++++++++-------------------------- 1 file changed, 96 insertions(+), 98 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 6751db3..47d6344 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -140,7 +140,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - billing_account '/v1/products/{productUID}/devices/{deviceUID}/environment_variables_with_pin': @@ -198,7 +198,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - external devices '/v1/products/{productUID}/ext-devices/{deviceUID}/session/close': @@ -221,7 +221,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - external devices '/v1/products/{productUID}/ext-devices/{deviceUID}/session/open': @@ -244,7 +244,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - external devices '/v1/products/{productUID}/project': @@ -268,7 +268,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects: @@ -290,7 +290,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project post: @@ -324,7 +324,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/alerts': @@ -342,7 +342,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - alert '/v1/projects/{projectOrProductUID}/clone': @@ -384,7 +384,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/devices': @@ -410,7 +410,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/{deviceUID}': @@ -430,7 +430,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device get: @@ -446,7 +446,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device parameters: @@ -470,7 +470,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/dfu/{firmwareType}/status': @@ -491,7 +491,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/disable': @@ -507,7 +507,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/disable-connectivity-assurance': @@ -523,7 +523,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/enable': @@ -539,7 +539,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/enable-connectivity-assurance': @@ -555,7 +555,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_hierarchy': @@ -577,7 +577,7 @@ paths: '500': description: Server error security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables': @@ -590,7 +590,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device parameters: @@ -612,7 +612,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables/{key}': @@ -634,7 +634,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/files': @@ -662,7 +662,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/files/changes': @@ -706,7 +706,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/files/changes/pending': @@ -739,7 +739,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets': @@ -768,7 +768,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project get: @@ -780,7 +780,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project parameters: @@ -811,7 +811,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/health-log': @@ -850,7 +850,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/latest': @@ -866,7 +866,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}': @@ -890,7 +890,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID}': @@ -908,7 +908,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device get: @@ -951,7 +951,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device post: @@ -975,7 +975,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device put: @@ -999,7 +999,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/changes': @@ -1066,7 +1066,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/provision': @@ -1109,7 +1109,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/public-key': @@ -1137,7 +1137,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/sessions': @@ -1157,7 +1157,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/{deviceUID}/signal': @@ -1188,7 +1188,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/devices/public-keys': @@ -1224,7 +1224,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/dfu/{firmwareType}/{action}': @@ -1257,7 +1257,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/dfu/{firmwareType}/history': @@ -1290,7 +1290,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/dfu/{firmwareType}/status': @@ -1323,7 +1323,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/environment_hierarchy': @@ -1344,7 +1344,7 @@ paths: '500': description: Server error security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/environment_variables': @@ -1357,7 +1357,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project parameters: @@ -1376,7 +1376,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/environment_variables/{key}': @@ -1397,7 +1397,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/events': @@ -1444,7 +1444,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - event '/v1/projects/{projectOrProductUID}/events-cursor': @@ -1466,7 +1466,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - event '/v1/projects/{projectOrProductUID}/events/{eventUID}/route-logs': @@ -1488,7 +1488,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - event '/v1/projects/{projectOrProductUID}/firmware': @@ -1516,7 +1516,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/firmware/{firmwareType}/{filename}': @@ -1561,7 +1561,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/fleets': @@ -1574,7 +1574,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project parameters: @@ -1605,7 +1605,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/fleets/{fleetUID}': @@ -1618,7 +1618,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project get: @@ -1632,7 +1632,7 @@ paths: schema: $ref: '#/components/schemas/Fleet' security: - - api_key: [] + - personalAccessToken: [] tags: - project parameters: @@ -1678,7 +1678,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/fleets/{fleetUID}/devices': @@ -1704,7 +1704,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device '/v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_hierarchy': @@ -1726,7 +1726,7 @@ paths: '500': description: Server error security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables': @@ -1739,7 +1739,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project parameters: @@ -1761,7 +1761,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables/{key}': @@ -1783,7 +1783,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events': @@ -1830,7 +1830,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - event '/v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events-cursor': @@ -1854,7 +1854,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - event '/v1/projects/{projectOrProductUID}/global-transformation': @@ -1876,7 +1876,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/global-transformation/disable': @@ -1891,7 +1891,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/global-transformation/enable': @@ -1906,7 +1906,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/members': @@ -1930,7 +1930,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project parameters: @@ -1947,7 +1947,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - monitor post: @@ -1972,7 +1972,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - monitor '/v1/projects/{projectOrProductUID}/monitors/{monitorUID}': @@ -1992,7 +1992,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - monitor get: @@ -2011,7 +2011,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - monitor put: @@ -2037,7 +2037,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - monitor '/v1/projects/{projectOrProductUID}/products': @@ -2059,7 +2059,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project parameters: @@ -2101,7 +2101,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project '/v1/projects/{projectOrProductUID}/routes': @@ -2154,7 +2154,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - route post: @@ -2207,7 +2207,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - route '/v1/projects/{projectOrProductUID}/routes/{routeUID}': @@ -2228,7 +2228,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - route get: @@ -2265,7 +2265,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - route put: @@ -2325,7 +2325,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - route '/v1/projects/{projectOrProductUID}/routes/{routeUID}/route-logs': @@ -2357,7 +2357,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - route '/v1/projects/{projectOrProductUID}/schemas': @@ -2438,7 +2438,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - usage '/v1/projects/{projectOrProductUID}/usage/route-logs': @@ -2470,7 +2470,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - usage '/v1/projects/{projectOrProductUID}/usage/sessions': @@ -2502,7 +2502,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - usage '/v1/projects/{projectOrProductUID}/webhooks': @@ -2526,7 +2526,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - webhook '/v1/projects/{projectOrProductUID}/webhooks/{webhookUID}': @@ -2542,7 +2542,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - webhook get: @@ -2561,7 +2561,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - webhook post: @@ -2587,7 +2587,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - webhook put: @@ -2611,7 +2611,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - webhook '/v1/projects/{projectUID}': @@ -2626,7 +2626,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project get: @@ -2644,7 +2644,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project components: @@ -6016,13 +6016,11 @@ components: when: 1667251044 work: 1667251046 securitySchemes: - api_key: + personalAccessToken: description: | - For accessing most endpoints. - To retrieve the key, see the /auth/login endpoint. - in: header - name: X-Session-Token - type: apiKey + Use a personal access token from notehub.io/api-access + scheme: bearer + type: http pin: description: | For accessing endpoints by Device pin. From 8f4a5d6e2490ab395c18c4b14321b92cef6aedec Mon Sep 17 00:00:00 2001 From: Paige Niedringhaus Date: Wed, 24 Sep 2025 14:53:13 -0400 Subject: [PATCH 3/4] deps: regenerate sdk --- openapi_filtered.yaml | 212 ++++----- src/README.md | 17 +- src/docs/AlertApi.md | 13 +- src/docs/BillingAccountApi.md | 13 +- src/docs/DeviceApi.md | 364 ++++++++-------- src/docs/EventApi.md | 65 ++- src/docs/ExternalDevicesApi.md | 39 +- src/docs/MonitorApi.md | 65 ++- src/docs/ProjectApi.md | 475 ++++++++++----------- src/docs/RouteApi.md | 78 ++-- src/docs/UploadMetadata.md | 31 +- src/docs/UsageApi.md | 53 +-- src/docs/WebhookApi.md | 65 ++- src/notehub_py/api/alert_api.py | 2 +- src/notehub_py/api/billing_account_api.py | 2 +- src/notehub_py/api/device_api.py | 56 +-- src/notehub_py/api/event_api.py | 10 +- src/notehub_py/api/external_devices_api.py | 6 +- src/notehub_py/api/monitor_api.py | 10 +- src/notehub_py/api/project_api.py | 134 ++++-- src/notehub_py/api/route_api.py | 12 +- src/notehub_py/api/usage_api.py | 8 +- src/notehub_py/api/webhook_api.py | 10 +- src/notehub_py/configuration.py | 12 +- src/notehub_py/models/upload_metadata.py | 8 +- src/test/test_upload_metadata.py | 3 +- src/test/test_user_dfu_state_machine.py | 3 +- src/test/test_user_firmware_info.py | 3 +- 28 files changed, 876 insertions(+), 893 deletions(-) diff --git a/openapi_filtered.yaml b/openapi_filtered.yaml index b8b7838..ff10777 100644 --- a/openapi_filtered.yaml +++ b/openapi_filtered.yaml @@ -143,7 +143,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - billing_account /v1/products/{productUID}/devices/{deviceUID}/environment_variables_with_pin: @@ -203,7 +203,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - external devices /v1/products/{productUID}/ext-devices/{deviceUID}/session/close: @@ -227,7 +227,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - external devices /v1/products/{productUID}/ext-devices/{deviceUID}/session/open: @@ -252,7 +252,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - external devices /v1/products/{productUID}/project: @@ -276,7 +276,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects: @@ -298,7 +298,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project post: @@ -335,7 +335,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/alerts: @@ -353,7 +353,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - alert /v1/projects/{projectOrProductUID}/clone: @@ -399,7 +399,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/devices: @@ -425,7 +425,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/{deviceUID}: @@ -445,7 +445,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device get: @@ -461,7 +461,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device parameters: @@ -485,7 +485,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/devices/{deviceUID}/dfu/{firmwareType}/status: @@ -506,7 +506,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/devices/{deviceUID}/disable: @@ -522,7 +522,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/{deviceUID}/disable-connectivity-assurance: @@ -538,7 +538,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/{deviceUID}/enable: @@ -554,7 +554,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/{deviceUID}/enable-connectivity-assurance: @@ -570,7 +570,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_hierarchy: @@ -592,7 +592,7 @@ paths: '500': description: Server error security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables: @@ -605,7 +605,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device parameters: @@ -628,7 +628,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/{deviceUID}/environment_variables/{key}: @@ -650,7 +650,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files: @@ -678,7 +678,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files/changes: @@ -725,7 +725,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/{deviceUID}/files/changes/pending: @@ -761,7 +761,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/{deviceUID}/fleets: @@ -795,7 +795,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project get: @@ -807,7 +807,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project parameters: @@ -842,7 +842,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/devices/{deviceUID}/health-log: @@ -881,7 +881,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/{deviceUID}/latest: @@ -897,7 +897,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}: @@ -923,7 +923,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/{noteID}: @@ -941,7 +941,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device get: @@ -984,7 +984,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device post: @@ -1010,7 +1010,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device put: @@ -1035,7 +1035,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/{deviceUID}/notes/{notefileID}/changes: @@ -1103,7 +1103,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/{deviceUID}/provision: @@ -1146,7 +1146,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/{deviceUID}/public-key: @@ -1174,7 +1174,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/{deviceUID}/sessions: @@ -1194,7 +1194,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/{deviceUID}/signal: @@ -1226,7 +1226,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/devices/public-keys: @@ -1262,7 +1262,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/{action}: @@ -1296,7 +1296,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/history: @@ -1330,7 +1330,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/dfu/{firmwareType}/status: @@ -1364,7 +1364,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/environment_hierarchy: @@ -1385,7 +1385,7 @@ paths: '500': description: Server error security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/environment_variables: @@ -1398,7 +1398,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project parameters: @@ -1418,7 +1418,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/environment_variables/{key}: @@ -1439,7 +1439,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/events: @@ -1470,7 +1470,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - event /v1/projects/{projectOrProductUID}/events-cursor: @@ -1492,7 +1492,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - event /v1/projects/{projectOrProductUID}/events/{eventUID}/route-logs: @@ -1514,7 +1514,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - event /v1/projects/{projectOrProductUID}/firmware: @@ -1542,7 +1542,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/firmware/{firmwareType}/{filename}: @@ -1557,6 +1557,20 @@ paths: required: true schema: type: string + - name: version + in: query + description: Firmware version (optional). If not provided, the version will + be extracted from firmware binary if available, otherwise left empty + required: false + schema: + type: string + - name: notes + in: query + description: Optional notes describing what's different about this firmware + version + required: false + schema: + type: string requestBody: description: contents of the firmware binary required: true @@ -1576,7 +1590,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/fleets: @@ -1589,7 +1603,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project parameters: @@ -1620,7 +1634,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/fleets/{fleetUID}: @@ -1633,7 +1647,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project get: @@ -1647,7 +1661,7 @@ paths: schema: $ref: '#/components/schemas/Fleet' security: - - api_key: [] + - personalAccessToken: [] tags: - project parameters: @@ -1694,7 +1708,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/devices: @@ -1720,7 +1734,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - device /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_hierarchy: @@ -1742,7 +1756,7 @@ paths: '500': description: Server error security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables: @@ -1755,7 +1769,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project parameters: @@ -1778,7 +1792,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/environment_variables/{key}: @@ -1800,7 +1814,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events: @@ -1831,7 +1845,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - event /v1/projects/{projectOrProductUID}/fleets/{fleetUID}/events-cursor: @@ -1855,7 +1869,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - event /v1/projects/{projectOrProductUID}/global-transformation: @@ -1879,7 +1893,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/global-transformation/disable: @@ -1894,7 +1908,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/global-transformation/enable: @@ -1909,7 +1923,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/members: @@ -1933,7 +1947,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project parameters: @@ -1950,7 +1964,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - monitor post: @@ -1976,7 +1990,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - monitor /v1/projects/{projectOrProductUID}/monitors/{monitorUID}: @@ -1996,7 +2010,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - monitor get: @@ -2015,7 +2029,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - monitor put: @@ -2042,7 +2056,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - monitor /v1/projects/{projectOrProductUID}/products: @@ -2064,7 +2078,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project parameters: @@ -2108,7 +2122,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project /v1/projects/{projectOrProductUID}/routes: @@ -2161,7 +2175,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - route post: @@ -2209,7 +2223,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - route /v1/projects/{projectOrProductUID}/routes/{routeUID}: @@ -2230,7 +2244,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - route get: @@ -2267,7 +2281,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - route put: @@ -2307,7 +2321,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - route /v1/projects/{projectOrProductUID}/routes/{routeUID}/route-logs: @@ -2339,7 +2353,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - route /v1/projects/{projectOrProductUID}/schemas: @@ -2421,7 +2435,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - usage /v1/projects/{projectOrProductUID}/usage/route-logs: @@ -2453,7 +2467,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - usage /v1/projects/{projectOrProductUID}/usage/sessions: @@ -2485,7 +2499,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - usage /v1/projects/{projectOrProductUID}/webhooks: @@ -2509,7 +2523,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - webhook /v1/projects/{projectOrProductUID}/webhooks/{webhookUID}: @@ -2525,7 +2539,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - webhook get: @@ -2544,7 +2558,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - webhook post: @@ -2572,7 +2586,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - webhook put: @@ -2599,7 +2613,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - webhook /v1/projects/{projectUID}: @@ -2614,7 +2628,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project get: @@ -2632,7 +2646,7 @@ paths: default: $ref: '#/components/responses/ErrorResponse' security: - - api_key: [] + - personalAccessToken: [] tags: - project components: @@ -4838,6 +4852,9 @@ components: type: string type: type: string + version: + description: User-specified version string provided at time of upload + type: string UsageData: type: object properties: @@ -6132,15 +6149,12 @@ components: when: 1667251044 work: 1667251046 securitySchemes: - api_key: - description: 'For accessing most endpoints. - - To retrieve the key, see the /auth/login endpoint. + personalAccessToken: + description: 'Use a personal access token from notehub.io/api-access ' - in: header - name: X-Session-Token - type: apiKey + scheme: bearer + type: http pin: description: 'For accessing endpoints by Device pin. diff --git a/src/README.md b/src/README.md index cdb7791..84b09e6 100644 --- a/src/README.md +++ b/src/README.md @@ -75,11 +75,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client @@ -335,12 +334,10 @@ Class | Method | HTTP request | Description Authentication schemes defined for the API: - -### api_key + +### personalAccessToken -- **Type**: API key -- **API key parameter name**: X-Session-Token -- **Location**: HTTP header +- **Type**: Bearer authentication ### pin diff --git a/src/docs/AlertApi.md b/src/docs/AlertApi.md index f78168c..36e6d0e 100644 --- a/src/docs/AlertApi.md +++ b/src/docs/AlertApi.md @@ -14,7 +14,7 @@ Get list of defined Alerts ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -33,11 +33,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -71,7 +70,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers diff --git a/src/docs/BillingAccountApi.md b/src/docs/BillingAccountApi.md index c40a0c0..e0c5458 100644 --- a/src/docs/BillingAccountApi.md +++ b/src/docs/BillingAccountApi.md @@ -14,7 +14,7 @@ Get Billing Accounts accessible by the api_key ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -33,11 +33,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -62,7 +61,7 @@ This endpoint does not need any parameter. ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers diff --git a/src/docs/DeviceApi.md b/src/docs/DeviceApi.md index adaec83..9b748bb 100644 --- a/src/docs/DeviceApi.md +++ b/src/docs/DeviceApi.md @@ -43,7 +43,7 @@ Delete environment variable of a device ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -62,11 +62,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -98,7 +97,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -122,7 +121,7 @@ Delete Device ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -140,11 +139,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -174,7 +172,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -198,7 +196,7 @@ Disable Device ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -216,11 +214,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -248,7 +245,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -272,7 +269,7 @@ Disable Connectivity Assurance ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -290,11 +287,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -322,7 +318,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -346,7 +342,7 @@ Enable Device ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -364,11 +360,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -396,7 +391,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -420,7 +415,7 @@ Enable Connectivity Assurance ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -438,11 +433,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -470,7 +464,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -494,7 +488,7 @@ Get Device ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -513,11 +507,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -547,7 +540,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -571,7 +564,7 @@ Get environment variable hierarchy for a device ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -590,11 +583,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -625,7 +617,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -650,7 +642,7 @@ Get environment variables of a device ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -669,11 +661,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -703,7 +694,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -804,7 +795,7 @@ Get Device Health Log ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -823,11 +814,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -857,7 +847,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -881,7 +871,7 @@ Get Device Latest Events ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -900,11 +890,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -934,7 +923,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -958,7 +947,7 @@ Get Device Public Key ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -977,11 +966,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1011,7 +999,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1035,7 +1023,7 @@ Get Device Sessions ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1054,11 +1042,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1096,7 +1083,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1120,7 +1107,7 @@ Get Device Public Keys of a Project ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1139,11 +1126,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1175,7 +1161,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1199,7 +1185,7 @@ Get Devices of a Project ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1218,11 +1204,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1272,7 +1257,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1296,7 +1281,7 @@ Get Devices of a Fleet within a Project ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1315,11 +1300,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1369,7 +1353,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1393,7 +1377,7 @@ Adds a Note to a Notefile, creating the Notefile if it doesn't yet exist. ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1412,11 +1396,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1448,7 +1431,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1472,7 +1455,7 @@ Incrementally retrieve changes within a specific Notefile. ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1491,11 +1474,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1539,7 +1521,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1563,7 +1545,7 @@ Adds a Note to a Notefile, creating the Notefile if it doesn't yet exist. ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1582,11 +1564,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1620,7 +1601,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1644,7 +1625,7 @@ Delete a note from a DB notefile ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1662,11 +1643,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1698,7 +1678,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1722,7 +1702,7 @@ Get a note from a DB notefile ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1741,11 +1721,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1783,7 +1762,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1807,7 +1786,7 @@ Send a signal from Notehub to a Notecard. ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1827,11 +1806,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1863,7 +1841,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1887,7 +1865,7 @@ Update a note in a DB notefile ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1906,11 +1884,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1944,7 +1921,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1968,7 +1945,7 @@ Used to perform queries on a single or multiple files to determine if new Notes ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1987,11 +1964,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -2025,7 +2001,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -2049,7 +2025,7 @@ Returns info about file changes that are pending upload to Notehub or download t ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -2068,11 +2044,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -2102,7 +2077,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -2126,7 +2101,7 @@ Deletes Notefiles and the Notes they contain. ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -2145,11 +2120,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -2179,7 +2153,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -2203,7 +2177,7 @@ Provision Device for a Project ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -2222,11 +2196,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -2258,7 +2231,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -2282,7 +2255,7 @@ Put environment variables of a device ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -2301,11 +2274,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -2337,7 +2309,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers diff --git a/src/docs/EventApi.md b/src/docs/EventApi.md index e627eb6..0135e4c 100644 --- a/src/docs/EventApi.md +++ b/src/docs/EventApi.md @@ -18,7 +18,7 @@ Get Events of a Fleet ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -37,11 +37,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -101,7 +100,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -125,7 +124,7 @@ Get Events of a Fleet by cursor ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -144,11 +143,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -194,7 +192,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -218,7 +216,7 @@ Get Events of a Project ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -237,11 +235,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -301,7 +298,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -325,7 +322,7 @@ Get Events of a Project by cursor ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -344,11 +341,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -390,7 +386,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -414,7 +410,7 @@ Get Route Logs by Event UID ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -433,11 +429,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -467,7 +462,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers diff --git a/src/docs/ExternalDevicesApi.md b/src/docs/ExternalDevicesApi.md index 90fbb31..0ccfb94 100644 --- a/src/docs/ExternalDevicesApi.md +++ b/src/docs/ExternalDevicesApi.md @@ -16,7 +16,7 @@ Creates an event using specified webhook ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -35,11 +35,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -69,7 +68,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -93,7 +92,7 @@ Closes the session for the specified device if open ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -112,11 +111,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -146,7 +144,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -170,7 +168,7 @@ Create a Session for the specified device. | If a session is currently open it w ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -189,11 +187,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -223,7 +220,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers diff --git a/src/docs/MonitorApi.md b/src/docs/MonitorApi.md index 27f9814..db0f1ff 100644 --- a/src/docs/MonitorApi.md +++ b/src/docs/MonitorApi.md @@ -18,7 +18,7 @@ Create a new Monitor ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -38,11 +38,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -72,7 +71,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -96,7 +95,7 @@ Delete Monitor ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -115,11 +114,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -149,7 +147,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -173,7 +171,7 @@ Get Monitor ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -192,11 +190,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -226,7 +223,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -250,7 +247,7 @@ Get list of defined Monitors ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -269,11 +266,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -301,7 +297,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -325,7 +321,7 @@ Update Monitor ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -344,11 +340,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -380,7 +375,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers diff --git a/src/docs/ProjectApi.md b/src/docs/ProjectApi.md index d04e7cf..8bb65d6 100644 --- a/src/docs/ProjectApi.md +++ b/src/docs/ProjectApi.md @@ -49,7 +49,7 @@ Clone a Project ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -69,11 +69,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -103,7 +102,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -127,7 +126,7 @@ Create Fleet ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -147,11 +146,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -181,7 +179,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -205,7 +203,7 @@ Create Product within a Project ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -225,11 +223,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -259,7 +256,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -283,7 +280,7 @@ Create a Project ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -303,11 +300,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -335,7 +331,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -359,7 +355,7 @@ Remove Device from Fleets ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -379,11 +375,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -415,7 +410,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -439,7 +434,7 @@ Delete Fleet ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -457,11 +452,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -489,7 +483,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -513,7 +507,7 @@ Delete environment variables of a fleet ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -532,11 +526,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -568,7 +561,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -592,7 +585,7 @@ Delete a Project by ProjectUID ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -610,11 +603,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -640,7 +632,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -664,7 +656,7 @@ Delete an environment variable of a project by key ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -683,11 +675,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -717,7 +708,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -741,7 +732,7 @@ Update/cancel host or notecard firmware updates ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -760,11 +751,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -814,7 +804,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -838,7 +828,7 @@ Disable the project-level event JSONata transformation ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -856,11 +846,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -886,7 +875,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -910,7 +899,7 @@ Enable the project-level event JSONata transformation ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -928,11 +917,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -958,7 +946,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -982,7 +970,7 @@ Get device DFU history for host or Notecard firmware ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1001,11 +989,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1037,7 +1024,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1061,7 +1048,7 @@ Get device DFU history for host or Notecard firmware ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1080,11 +1067,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1116,7 +1102,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1140,7 +1126,7 @@ Get Device Fleets ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1159,11 +1145,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1193,7 +1178,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1217,7 +1202,7 @@ Get host or Notecard DFU history for all devices that match the filter criteria ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1236,11 +1221,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1296,7 +1280,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1320,7 +1304,7 @@ Get host or Notecard DFU history for all devices that match the filter criteria ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1339,11 +1323,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1399,7 +1382,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1423,7 +1406,7 @@ Get Available Firmware Information ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1442,11 +1425,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1488,7 +1470,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1512,7 +1494,7 @@ Get Fleet ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1531,11 +1513,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1565,7 +1546,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1588,7 +1569,7 @@ Get environment variable hierarchy for a device ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1607,11 +1588,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1642,7 +1622,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1667,7 +1647,7 @@ Get environment variables of a fleet ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1686,11 +1666,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1720,7 +1699,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1807,7 +1786,7 @@ Get a Project by ProjectUID ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1826,11 +1805,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1858,7 +1836,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1882,7 +1860,7 @@ Get a Project by ProductUID ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1901,11 +1879,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -1933,7 +1910,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -1957,7 +1934,7 @@ Get environment variable hierarchy for a device ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -1976,11 +1953,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -2009,7 +1985,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -2034,7 +2010,7 @@ Get environment variables of a project ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -2053,11 +2029,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -2085,7 +2060,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -2109,7 +2084,7 @@ Get Project Fleets ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -2128,11 +2103,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -2160,7 +2134,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -2184,7 +2158,7 @@ Get Project Members ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -2203,11 +2177,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -2235,7 +2208,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -2259,7 +2232,7 @@ Get Products within a Project ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -2278,11 +2251,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -2310,7 +2282,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -2334,7 +2306,7 @@ Get Projects accessible by the api_key ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -2353,11 +2325,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -2382,7 +2353,7 @@ This endpoint does not need any parameter. ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -2406,7 +2377,7 @@ Add Device to Fleets ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -2426,11 +2397,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -2462,7 +2432,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -2486,7 +2456,7 @@ Put environment variables of a fleet ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -2505,11 +2475,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -2541,7 +2510,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -2565,7 +2534,7 @@ Put environment variables of a project ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -2584,11 +2553,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -2618,7 +2586,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -2642,7 +2610,7 @@ Set the project-level event JSONata transformation ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -2660,11 +2628,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -2692,7 +2659,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -2716,7 +2683,7 @@ Update Fleet ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -2736,11 +2703,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -2772,7 +2738,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -2790,13 +2756,13 @@ with notehub_py.ApiClient(configuration) as api_client: # **upload_firmware** -> FirmwareInfo upload_firmware(project_or_product_uid, firmware_type, filename, body) +> FirmwareInfo upload_firmware(project_or_product_uid, firmware_type, filename, body, version=version, notes=notes) Upload firmware binary ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -2815,11 +2781,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -2829,9 +2794,11 @@ with notehub_py.ApiClient(configuration) as api_client: 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) + 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: @@ -2840,12 +2807,14 @@ with notehub_py.ApiClient(configuration) as api_client: ### Parameters -| Name | Type | Description | Notes | -| -------------------------- | ------------- | ------------------------------- | ----- | -| **project_or_product_uid** | **str** | | -| **firmware_type** | **str** | | -| **filename** | **str** | | -| **body** | **bytearray** | contents of the firmware binary | +| Name | Type | Description | Notes | +| -------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **project_or_product_uid** | **str** | | +| **firmware_type** | **str** | | +| **filename** | **str** | | +| **body** | **bytearray** | contents of the firmware binary | +| **version** | **str** | Firmware version (optional). If not provided, the version will be extracted from firmware binary if available, otherwise left empty | [optional] | +| **notes** | **str** | Optional notes describing what's different about this firmware version | [optional] | ### Return type @@ -2853,7 +2822,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers diff --git a/src/docs/RouteApi.md b/src/docs/RouteApi.md index 8e5d80b..d03f457 100644 --- a/src/docs/RouteApi.md +++ b/src/docs/RouteApi.md @@ -19,7 +19,7 @@ Create Route within a Project ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -38,11 +38,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -81,7 +80,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -105,7 +104,7 @@ Delete single route within a project ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -123,11 +122,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -157,7 +155,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -181,7 +179,7 @@ Get single route within a project ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -200,11 +198,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -234,7 +231,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -258,7 +255,7 @@ Get Route Logs by Route UID ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -277,11 +274,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -331,7 +327,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -355,7 +351,7 @@ Get all Routes within a Project ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -374,11 +370,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -406,7 +401,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -430,7 +425,7 @@ Update route by UID ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -449,11 +444,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -496,7 +490,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers diff --git a/src/docs/UploadMetadata.md b/src/docs/UploadMetadata.md index d647fd9..5aa5472 100644 --- a/src/docs/UploadMetadata.md +++ b/src/docs/UploadMetadata.md @@ -2,21 +2,22 @@ ## Properties -| Name | Type | Description | Notes | -| ------------ | --------------------------- | ----------- | ---------- | -| **contains** | **str** | | [optional] | -| **crc32** | **int** | | [optional] | -| **created** | **int** | | [optional] | -| **firmware** | [**Firmware**](Firmware.md) | | [optional] | -| **found** | **str** | | [optional] | -| **length** | **int** | | [optional] | -| **md5** | **str** | | [optional] | -| **modified** | **int** | | [optional] | -| **name** | **str** | | [optional] | -| **notes** | **str** | | [optional] | -| **source** | **str** | | [optional] | -| **tags** | **str** | | [optional] | -| **type** | **str** | | [optional] | +| Name | Type | Description | Notes | +| ------------ | --------------------------- | -------------------------------------------------------- | ---------- | +| **contains** | **str** | | [optional] | +| **crc32** | **int** | | [optional] | +| **created** | **int** | | [optional] | +| **firmware** | [**Firmware**](Firmware.md) | | [optional] | +| **found** | **str** | | [optional] | +| **length** | **int** | | [optional] | +| **md5** | **str** | | [optional] | +| **modified** | **int** | | [optional] | +| **name** | **str** | | [optional] | +| **notes** | **str** | | [optional] | +| **source** | **str** | | [optional] | +| **tags** | **str** | | [optional] | +| **type** | **str** | | [optional] | +| **version** | **str** | User-specified version string provided at time of upload | [optional] | ## Example diff --git a/src/docs/UsageApi.md b/src/docs/UsageApi.md index f04bf0e..6470ecd 100644 --- a/src/docs/UsageApi.md +++ b/src/docs/UsageApi.md @@ -17,8 +17,6 @@ Get data usage in bytes for a project with time range and period aggregation ### Example -- Api Key Authentication (api_key): - ```python import notehub_py from notehub_py.models.object import object @@ -31,16 +29,6 @@ configuration = notehub_py.Configuration( host = "https://api.notefile.net" ) -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -76,7 +64,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +No authorization required ### HTTP request headers @@ -100,7 +88,7 @@ Get events usage for a project with time range and period aggregation ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -119,11 +107,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -159,7 +146,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -183,7 +170,7 @@ Get route logs usage for a project with time range and period aggregation ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -202,11 +189,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -242,7 +228,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -266,7 +252,7 @@ Get sessions usage for a project with time range and period aggregation ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -285,11 +271,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -325,7 +310,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers diff --git a/src/docs/WebhookApi.md b/src/docs/WebhookApi.md index 98d71ea..43dc492 100644 --- a/src/docs/WebhookApi.md +++ b/src/docs/WebhookApi.md @@ -18,7 +18,7 @@ Creates a webhook for the specified product with the given name. The name | must ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -37,11 +37,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -71,7 +70,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -95,7 +94,7 @@ Deletes the specified webhook ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -113,11 +112,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -145,7 +143,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -169,7 +167,7 @@ Retrieves the configuration settings for the specified webhook ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -188,11 +186,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -222,7 +219,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -246,7 +243,7 @@ Retrieves all webhooks for the specified project ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -265,11 +262,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -297,7 +293,7 @@ with notehub_py.ApiClient(configuration) as api_client: ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers @@ -321,7 +317,7 @@ Updates the configuration settings for the specified webhook. | Webhook will be ### Example -- Api Key Authentication (api_key): +- Bearer Authentication (personalAccessToken): ```python import notehub_py @@ -340,11 +336,10 @@ configuration = notehub_py.Configuration( # Examples for each auth method are provided below, use the example that # satisfies your auth use case. -# Configure API key authorization: api_key -configuration.api_key['api_key'] = os.environ["API_KEY"] - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['api_key'] = 'Bearer' +# Configure Bearer authorization: personalAccessToken +configuration = notehub_py.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with notehub_py.ApiClient(configuration) as api_client: @@ -374,7 +369,7 @@ void (empty response body) ### Authorization -[api_key](../README.md#api_key) +[personalAccessToken](../README.md#personalAccessToken) ### HTTP request headers diff --git a/src/notehub_py/api/alert_api.py b/src/notehub_py/api/alert_api.py index e24062e..513761d 100644 --- a/src/notehub_py/api/alert_api.py +++ b/src/notehub_py/api/alert_api.py @@ -312,7 +312,7 @@ def _get_alerts_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", diff --git a/src/notehub_py/api/billing_account_api.py b/src/notehub_py/api/billing_account_api.py index 338132f..7ec2b88 100644 --- a/src/notehub_py/api/billing_account_api.py +++ b/src/notehub_py/api/billing_account_api.py @@ -245,7 +245,7 @@ def _get_billing_accounts_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", diff --git a/src/notehub_py/api/device_api.py b/src/notehub_py/api/device_api.py index 87b9f43..bfda2ca 100644 --- a/src/notehub_py/api/device_api.py +++ b/src/notehub_py/api/device_api.py @@ -335,7 +335,7 @@ def _delete_device_environment_variable_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="DELETE", @@ -606,7 +606,7 @@ def _delete_project_device_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="DELETE", @@ -860,7 +860,7 @@ def _disable_device_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -1114,7 +1114,7 @@ def _disable_device_connectivity_assurance_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -1368,7 +1368,7 @@ def _enable_device_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -1622,7 +1622,7 @@ def _enable_device_connectivity_assurance_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -1876,7 +1876,7 @@ def _get_device_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -2133,7 +2133,7 @@ def _get_device_environment_hierarchy_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -2387,7 +2387,7 @@ def _get_device_environment_variables_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -2895,7 +2895,7 @@ def _get_device_health_log_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -3149,7 +3149,7 @@ def _get_device_latest_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -3403,7 +3403,7 @@ def _get_device_public_key_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -3755,7 +3755,7 @@ def _get_device_sessions_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -4028,7 +4028,7 @@ def _get_project_device_public_keys_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -4506,7 +4506,7 @@ def _get_project_devices_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -4981,7 +4981,7 @@ def _get_project_fleet_devices_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -5281,7 +5281,7 @@ def _handle_note_add_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -5697,7 +5697,7 @@ def _handle_note_changes_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -6012,7 +6012,7 @@ def _handle_note_create_add_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -6296,7 +6296,7 @@ def _handle_note_delete_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="DELETE", @@ -6629,7 +6629,7 @@ def _handle_note_get_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -6917,7 +6917,7 @@ def _handle_note_signal_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -7232,7 +7232,7 @@ def _handle_note_update_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="PUT", @@ -7537,7 +7537,7 @@ def _handle_notefile_changes_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -7791,7 +7791,7 @@ def _handle_notefile_changes_pending_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -8070,7 +8070,7 @@ def _handle_notefile_delete_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="DELETE", @@ -8358,7 +8358,7 @@ def _post_provision_project_device_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -8646,7 +8646,7 @@ def _put_device_environment_variables_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="PUT", diff --git a/src/notehub_py/api/event_api.py b/src/notehub_py/api/event_api.py index 6be8f3a..72728af 100644 --- a/src/notehub_py/api/event_api.py +++ b/src/notehub_py/api/event_api.py @@ -630,7 +630,7 @@ def _get_fleet_events_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -1073,7 +1073,7 @@ def _get_fleet_events_by_cursor_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -1686,7 +1686,7 @@ def _get_project_events_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -2067,7 +2067,7 @@ def _get_project_events_by_cursor_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -2321,7 +2321,7 @@ def _get_route_logs_by_event_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", diff --git a/src/notehub_py/api/external_devices_api.py b/src/notehub_py/api/external_devices_api.py index b506303..5f81309 100644 --- a/src/notehub_py/api/external_devices_api.py +++ b/src/notehub_py/api/external_devices_api.py @@ -301,7 +301,7 @@ def _create_event_ext_device_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -580,7 +580,7 @@ def _ext_device_session_close_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -859,7 +859,7 @@ def _ext_device_session_open_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", diff --git a/src/notehub_py/api/monitor_api.py b/src/notehub_py/api/monitor_api.py index 8fcbf98..d1b46e1 100644 --- a/src/notehub_py/api/monitor_api.py +++ b/src/notehub_py/api/monitor_api.py @@ -293,7 +293,7 @@ def _create_monitor_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -547,7 +547,7 @@ def _delete_monitor_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="DELETE", @@ -801,7 +801,7 @@ def _get_monitor_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -1040,7 +1040,7 @@ def _get_monitors_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -1325,7 +1325,7 @@ def _update_monitor_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="PUT", diff --git a/src/notehub_py/api/project_api.py b/src/notehub_py/api/project_api.py index 9b996a6..e4b3efa 100644 --- a/src/notehub_py/api/project_api.py +++ b/src/notehub_py/api/project_api.py @@ -318,7 +318,7 @@ def _clone_project_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -588,7 +588,7 @@ def _create_fleet_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -858,7 +858,7 @@ def _create_product_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -1113,7 +1113,7 @@ def _create_project_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -1407,7 +1407,7 @@ def _delete_device_fleets_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="DELETE", @@ -1661,7 +1661,7 @@ def _delete_fleet_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="DELETE", @@ -1936,7 +1936,7 @@ def _delete_fleet_environment_variable_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="DELETE", @@ -2175,7 +2175,7 @@ def _delete_project_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="DELETE", @@ -2435,7 +2435,7 @@ def _delete_project_environment_variable_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="DELETE", @@ -2942,7 +2942,7 @@ def _dfu_action_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -3181,7 +3181,7 @@ def _disable_global_transformation_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -3420,7 +3420,7 @@ def _enable_global_transformation_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -3689,7 +3689,7 @@ def _get_device_dfu_history_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -3958,7 +3958,7 @@ def _get_device_dfu_status_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -4212,7 +4212,7 @@ def _get_device_fleets_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -4738,7 +4738,7 @@ def _get_devices_dfu_history_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -5264,7 +5264,7 @@ def _get_devices_dfu_status_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -5622,7 +5622,7 @@ def _get_firmware_info_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -5876,7 +5876,7 @@ def _get_fleet_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -6133,7 +6133,7 @@ def _get_fleet_environment_hierarchy_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -6387,7 +6387,7 @@ def _get_fleet_environment_variables_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -6862,7 +6862,7 @@ def _get_project_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -7101,7 +7101,7 @@ def _get_project_by_product_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -7343,7 +7343,7 @@ def _get_project_environment_hierarchy_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -7582,7 +7582,7 @@ def _get_project_environment_variables_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -7821,7 +7821,7 @@ def _get_project_fleets_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -8060,7 +8060,7 @@ def _get_project_members_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -8299,7 +8299,7 @@ def _get_project_products_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -8523,7 +8523,7 @@ def _get_projects_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -8817,7 +8817,7 @@ def _put_device_fleets_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="PUT", @@ -9105,7 +9105,7 @@ def _put_fleet_environment_variables_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="PUT", @@ -9369,7 +9369,7 @@ def _put_project_environment_variables_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="PUT", @@ -9648,7 +9648,7 @@ def _set_global_transformation_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -9933,7 +9933,7 @@ def _update_fleet_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="PUT", @@ -9960,6 +9960,18 @@ def upload_firmware( Union[StrictBytes, StrictStr], Field(description="contents of the firmware binary"), ], + version: Annotated[ + Optional[StrictStr], + Field( + description="Firmware version (optional). If not provided, the version will be extracted from firmware binary if available, otherwise left empty" + ), + ] = None, + notes: Annotated[ + Optional[StrictStr], + Field( + description="Optional notes describing what's different about this firmware version" + ), + ] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -9984,6 +9996,10 @@ def upload_firmware( :type filename: str :param body: contents of the firmware binary (required) :type body: bytearray + :param version: Firmware version (optional). If not provided, the version will be extracted from firmware binary if available, otherwise left empty + :type version: str + :param notes: Optional notes describing what's different about this firmware version + :type notes: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -10011,6 +10027,8 @@ def upload_firmware( firmware_type=firmware_type, filename=filename, body=body, + version=version, + notes=notes, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -10039,6 +10057,18 @@ def upload_firmware_with_http_info( Union[StrictBytes, StrictStr], Field(description="contents of the firmware binary"), ], + version: Annotated[ + Optional[StrictStr], + Field( + description="Firmware version (optional). If not provided, the version will be extracted from firmware binary if available, otherwise left empty" + ), + ] = None, + notes: Annotated[ + Optional[StrictStr], + Field( + description="Optional notes describing what's different about this firmware version" + ), + ] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -10063,6 +10093,10 @@ def upload_firmware_with_http_info( :type filename: str :param body: contents of the firmware binary (required) :type body: bytearray + :param version: Firmware version (optional). If not provided, the version will be extracted from firmware binary if available, otherwise left empty + :type version: str + :param notes: Optional notes describing what's different about this firmware version + :type notes: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -10090,6 +10124,8 @@ def upload_firmware_with_http_info( firmware_type=firmware_type, filename=filename, body=body, + version=version, + notes=notes, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -10118,6 +10154,18 @@ def upload_firmware_without_preload_content( Union[StrictBytes, StrictStr], Field(description="contents of the firmware binary"), ], + version: Annotated[ + Optional[StrictStr], + Field( + description="Firmware version (optional). If not provided, the version will be extracted from firmware binary if available, otherwise left empty" + ), + ] = None, + notes: Annotated[ + Optional[StrictStr], + Field( + description="Optional notes describing what's different about this firmware version" + ), + ] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -10142,6 +10190,10 @@ def upload_firmware_without_preload_content( :type filename: str :param body: contents of the firmware binary (required) :type body: bytearray + :param version: Firmware version (optional). If not provided, the version will be extracted from firmware binary if available, otherwise left empty + :type version: str + :param notes: Optional notes describing what's different about this firmware version + :type notes: str :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -10169,6 +10221,8 @@ def upload_firmware_without_preload_content( firmware_type=firmware_type, filename=filename, body=body, + version=version, + notes=notes, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -10189,6 +10243,8 @@ def _upload_firmware_serialize( firmware_type, filename, body, + version, + notes, _request_auth, _content_type, _headers, @@ -10214,6 +10270,14 @@ def _upload_firmware_serialize( if filename is not None: _path_params["filename"] = filename # process the query parameters + if version is not None: + + _query_params.append(("version", version)) + + if notes is not None: + + _query_params.append(("notes", notes)) + # process the header parameters # process the form parameters # process the body parameter @@ -10241,7 +10305,7 @@ def _upload_firmware_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="PUT", diff --git a/src/notehub_py/api/route_api.py b/src/notehub_py/api/route_api.py index 6de4b46..df71c61 100644 --- a/src/notehub_py/api/route_api.py +++ b/src/notehub_py/api/route_api.py @@ -294,7 +294,7 @@ def _create_route_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -548,7 +548,7 @@ def _delete_route_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="DELETE", @@ -802,7 +802,7 @@ def _get_route_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -1264,7 +1264,7 @@ def _get_route_logs_by_route_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -1503,7 +1503,7 @@ def _get_routes_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -1788,7 +1788,7 @@ def _update_route_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="PUT", diff --git a/src/notehub_py/api/usage_api.py b/src/notehub_py/api/usage_api.py index e8b5b4d..4c43b86 100644 --- a/src/notehub_py/api/usage_api.py +++ b/src/notehub_py/api/usage_api.py @@ -370,7 +370,7 @@ def _get_project_data_usage_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = [] return self.api_client.param_serialize( method="GET", @@ -715,7 +715,7 @@ def _get_project_events_usage_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -1060,7 +1060,7 @@ def _get_route_logs_usage_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -1405,7 +1405,7 @@ def _get_sessions_usage_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", diff --git a/src/notehub_py/api/webhook_api.py b/src/notehub_py/api/webhook_api.py index d3aa0c2..aa8279b 100644 --- a/src/notehub_py/api/webhook_api.py +++ b/src/notehub_py/api/webhook_api.py @@ -301,7 +301,7 @@ def _create_webhook_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="POST", @@ -555,7 +555,7 @@ def _delete_webhook_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="DELETE", @@ -809,7 +809,7 @@ def _get_webhook_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -1048,7 +1048,7 @@ def _get_webhooks_serialize( ) # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="GET", @@ -1327,7 +1327,7 @@ def _update_webhook_serialize( _header_params["Content-Type"] = _default_content_type # authentication setting - _auth_settings: List[str] = ["api_key"] + _auth_settings: List[str] = ["personalAccessToken"] return self.api_client.param_serialize( method="PUT", diff --git a/src/notehub_py/configuration.py b/src/notehub_py/configuration.py index 8de279e..9d4a3e0 100644 --- a/src/notehub_py/configuration.py +++ b/src/notehub_py/configuration.py @@ -395,14 +395,12 @@ def auth_settings(self): :return: The Auth Settings information dict. """ auth = {} - if "api_key" in self.api_key: - auth["api_key"] = { - "type": "api_key", + if self.access_token is not None: + auth["personalAccessToken"] = { + "type": "bearer", "in": "header", - "key": "X-Session-Token", - "value": self.get_api_key_with_prefix( - "api_key", - ), + "key": "Authorization", + "value": "Bearer " + self.access_token, } if "pin" in self.api_key: auth["pin"] = { diff --git a/src/notehub_py/models/upload_metadata.py b/src/notehub_py/models/upload_metadata.py index 567f207..ab37d2c 100644 --- a/src/notehub_py/models/upload_metadata.py +++ b/src/notehub_py/models/upload_metadata.py @@ -18,7 +18,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from notehub_py.models.firmware import Firmware from typing import Optional, Set @@ -43,6 +43,10 @@ class UploadMetadata(BaseModel): source: Optional[StrictStr] = None tags: Optional[StrictStr] = None type: Optional[StrictStr] = None + version: Optional[StrictStr] = Field( + default=None, + description="User-specified version string provided at time of upload", + ) __properties: ClassVar[List[str]] = [ "contains", "crc32", @@ -57,6 +61,7 @@ class UploadMetadata(BaseModel): "source", "tags", "type", + "version", ] model_config = ConfigDict( @@ -134,6 +139,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "source": obj.get("source"), "tags": obj.get("tags"), "type": obj.get("type"), + "version": obj.get("version"), } ) return _obj diff --git a/src/test/test_upload_metadata.py b/src/test/test_upload_metadata.py index d305f45..6bc39d2 100644 --- a/src/test/test_upload_metadata.py +++ b/src/test/test_upload_metadata.py @@ -60,7 +60,8 @@ def make_instance(self, include_optional) -> UploadMetadata: notes = '', source = '', tags = '', - type = '' + type = '', + version = '' ) else: return UploadMetadata( diff --git a/src/test/test_user_dfu_state_machine.py b/src/test/test_user_dfu_state_machine.py index b51dd65..ea6485a 100644 --- a/src/test/test_user_dfu_state_machine.py +++ b/src/test/test_user_dfu_state_machine.py @@ -62,7 +62,8 @@ def make_instance(self, include_optional) -> UserDfuStateMachine: notes = '', source = '', tags = '', - type = '', ), + type = '', + version = '', ), status = notehub_py.models.user_dfu_state_machine_status.UserDfuStateMachineStatus( date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), phase = '', diff --git a/src/test/test_user_firmware_info.py b/src/test/test_user_firmware_info.py index 27e59f1..b608339 100644 --- a/src/test/test_user_firmware_info.py +++ b/src/test/test_user_firmware_info.py @@ -77,7 +77,8 @@ def make_instance(self, include_optional) -> UserFirmwareInfo: notes = '', source = '', tags = '', - type = '', ), + type = '', + version = '', ), status = notehub_py.models.user_dfu_state_machine_status.UserDfuStateMachineStatus( date = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), phase = '', From b3b58d4f8771a2199f1de9e2f0b55aacd21ae9f3 Mon Sep 17 00:00:00 2001 From: Paige Niedringhaus Date: Wed, 24 Sep 2025 16:15:22 -0400 Subject: [PATCH 4/4] deps: bump major version for PyPI publish --- config.json | 2 +- src/README.md | 2 +- src/notehub_py/__init__.py | 2 +- src/notehub_py/api_client.py | 2 +- src/notehub_py/configuration.py | 4 +--- src/pyproject.toml | 2 +- src/setup.py | 2 +- 7 files changed, 7 insertions(+), 9 deletions(-) diff --git a/config.json b/config.json index bffe3fb..b80ea3f 100644 --- a/config.json +++ b/config.json @@ -2,5 +2,5 @@ "packageName": "notehub_py", "packageUrl": "https://github.com/blues/notehub-py", "projectName": "notehub-py", - "packageVersion": "1.0.17" + "packageVersion": "2.0.0" } \ No newline at end of file diff --git a/src/README.md b/src/README.md index 84b09e6..aa8053a 100644 --- a/src/README.md +++ b/src/README.md @@ -5,7 +5,7 @@ The OpenAPI definition for the Notehub.io API. This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 1.2.0 -- Package version: 1.0.17 +- Package version: 2.0.0 - Generator version: 7.5.0 - Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit [https://dev.blues.io/support/](https://dev.blues.io/support/) diff --git a/src/notehub_py/__init__.py b/src/notehub_py/__init__.py index f2d0646..480d126 100644 --- a/src/notehub_py/__init__.py +++ b/src/notehub_py/__init__.py @@ -15,7 +15,7 @@ """ # noqa: E501 -__version__ = "1.0.17" +__version__ = "2.0.0" # import apis into sdk package from notehub_py.api.alert_api import AlertApi diff --git a/src/notehub_py/api_client.py b/src/notehub_py/api_client.py index e93fec1..a8fa9ae 100644 --- a/src/notehub_py/api_client.py +++ b/src/notehub_py/api_client.py @@ -86,7 +86,7 @@ def __init__( self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = "OpenAPI-Generator/1.0.17/python" + self.user_agent = "OpenAPI-Generator/2.0.0/python" self.client_side_validation = configuration.client_side_validation def __enter__(self): diff --git a/src/notehub_py/configuration.py b/src/notehub_py/configuration.py index 9d4a3e0..a1d3666 100644 --- a/src/notehub_py/configuration.py +++ b/src/notehub_py/configuration.py @@ -423,9 +423,7 @@ def to_debug_report(self): "OS: {env}\n" "Python Version: {pyversion}\n" "Version of the API: 1.2.0\n" - "SDK Package Version: 1.0.17".format( - env=sys.platform, pyversion=sys.version - ) + "SDK Package Version: 2.0.0".format(env=sys.platform, pyversion=sys.version) ) def get_host_settings(self): diff --git a/src/pyproject.toml b/src/pyproject.toml index f03e04f..9c4ea40 100644 --- a/src/pyproject.toml +++ b/src/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "notehub_py" -version = "1.0.17" +version = "2.0.0" description = "Notehub API" authors = ["Blues Engineering "] license = "MIT" diff --git a/src/setup.py b/src/setup.py index d2da33a..184e7ce 100644 --- a/src/setup.py +++ b/src/setup.py @@ -25,7 +25,7 @@ # prerequisite: setuptools # http://pypi.python.org/pypi/setuptools NAME = "notehub-py" -VERSION = "1.0.17" +VERSION = "2.0.0" PYTHON_REQUIRES = ">=3.7" REQUIRES = [ "urllib3 >= 2.5.0",