@alwaysai/device-agent-schemas 2.3.2 → 2.3.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +12 -0
- package/README.md +12 -1
- package/lib/index.d.ts +2 -2
- package/lib/index.js +3 -1
- package/lib/schemas/secure-tunnel-schema.json +30 -0
- package/lib/shadow-schema.d.ts +17 -1
- package/lib/shadow-schema.js +9 -1
- package/package.json +16 -6
- package/.eslintignore +0 -4
- package/.eslintrc +0 -14
- package/.node-version +0 -1
- package/bitbucket-pipelines.yml +0 -10
- package/development.md +0 -53
- package/docs/README.md +0 -107
- package/docs/agent-message-schema-defs-toclient.md +0 -25
- package/docs/agent-message-schema-defs-tocloud.md +0 -25
- package/docs/agent-message-schema-defs.md +0 -15
- package/docs/agent-message-schema-properties-deviceid.md +0 -15
- package/docs/agent-message-schema-properties-payload-oneof-app_install_status.md +0 -66
- package/docs/agent-message-schema-properties-payload-oneof-app_logs.md +0 -66
- package/docs/agent-message-schema-properties-payload-oneof-app_state.md +0 -66
- package/docs/agent-message-schema-properties-payload-oneof-device_stats.md +0 -66
- package/docs/agent-message-schema-properties-payload-oneof-signed_urls_request.md +0 -85
- package/docs/agent-message-schema-properties-payload.md +0 -27
- package/docs/agent-message-schema-properties-timestamp.md +0 -15
- package/docs/agent-message-schema-properties-topic-oneof-0.md +0 -25
- package/docs/agent-message-schema-properties-topic-oneof-1.md +0 -25
- package/docs/agent-message-schema-properties-topic.md +0 -21
- package/docs/agent-message-schema.md +0 -138
- package/docs/app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-appinstallpayload-properties-appsignedurl.md +0 -15
- package/docs/app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-appinstallpayload.md +0 -39
- package/docs/app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-appreleasehash.md +0 -25
- package/docs/app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-models_install_payload.md +0 -15
- package/docs/app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-projectid.md +0 -25
- package/docs/app-install-cloud-response-schema-properties-appinstallcloudresponse.md +0 -116
- package/docs/app-install-cloud-response-schema-properties-messagetype.md +0 -23
- package/docs/app-install-cloud-response-schema.md +0 -66
- package/docs/app-install-response-schema-properties-appinstallresponse-properties-appinstallpayload-properties-appsignedurl.md +0 -15
- package/docs/app-install-response-schema-properties-appinstallresponse-properties-appinstallpayload.md +0 -39
- package/docs/app-install-response-schema-properties-appinstallresponse-properties-appreleasehash.md +0 -25
- package/docs/app-install-response-schema-properties-appinstallresponse-properties-models_install_payload.md +0 -15
- package/docs/app-install-response-schema-properties-appinstallresponse-properties-projectid.md +0 -25
- package/docs/app-install-response-schema-properties-appinstallresponse.md +0 -116
- package/docs/app-install-response-schema.md +0 -39
- package/docs/app-install-schema-properties-appreleasehash.md +0 -25
- package/docs/app-install-schema-properties-basecommand.md +0 -23
- package/docs/app-install-schema-properties-projectid.md +0 -25
- package/docs/app-install-schema.md +0 -105
- package/docs/app-install-status-schema-properties-appinstallstatus-properties-appreleasehash.md +0 -25
- package/docs/app-install-status-schema-properties-appinstallstatus-properties-message.md +0 -15
- package/docs/app-install-status-schema-properties-appinstallstatus-properties-status.md +0 -26
- package/docs/app-install-status-schema-properties-appinstallstatus.md +0 -98
- package/docs/app-install-status-schema-properties-messagetype.md +0 -23
- package/docs/app-install-status-schema.md +0 -66
- package/docs/app-logs-schema-properties-applogs-properties-logchunk.md +0 -15
- package/docs/app-logs-schema-properties-applogs-properties-projectid.md +0 -25
- package/docs/app-logs-schema-properties-applogs.md +0 -68
- package/docs/app-logs-schema-properties-logchunk.md +0 -15
- package/docs/app-logs-schema-properties-messagetype.md +0 -23
- package/docs/app-logs-schema-properties-projectid.md +0 -25
- package/docs/app-logs-schema.md +0 -68
- package/docs/app-state-control-schema-properties-appstatecontrol-properties-basecommand.md +0 -25
- package/docs/app-state-control-schema-properties-appstatecontrol-properties-projectid.md +0 -25
- package/docs/app-state-control-schema-properties-appstatecontrol.md +0 -78
- package/docs/app-state-control-schema-properties-basecommand.md +0 -25
- package/docs/app-state-control-schema-properties-messagetype.md +0 -23
- package/docs/app-state-control-schema-properties-projectid.md +0 -25
- package/docs/app-state-control-schema.md +0 -78
- package/docs/app-state-schema-properties-appstate-items-properties-appdetails-properties-projectid.md +0 -25
- package/docs/app-state-schema-properties-appstate-items-properties-appdetails-properties-version.md +0 -25
- package/docs/app-state-schema-properties-appstate-items-properties-appdetails.md +0 -78
- package/docs/app-state-schema-properties-appstate-items-properties-services-items-properties-name.md +0 -15
- package/docs/app-state-schema-properties-appstate-items-properties-services-items-properties-state.md +0 -25
- package/docs/app-state-schema-properties-appstate-items-properties-services-items.md +0 -68
- package/docs/app-state-schema-properties-appstate-items-properties-services.md +0 -15
- package/docs/app-state-schema-properties-appstate-items.md +0 -58
- package/docs/app-state-schema-properties-appstate.md +0 -15
- package/docs/app-state-schema-properties-messagetype.md +0 -23
- package/docs/app-state-schema.md +0 -39
- package/docs/app-uninstall-schema-properties-basecommand.md +0 -23
- package/docs/app-uninstall-schema-properties-projectid.md +0 -25
- package/docs/app-uninstall-schema.md +0 -76
- package/docs/app-version-control-schema-properties-appversioncontrol.md +0 -21
- package/docs/app-version-control-schema-properties-messagetype.md +0 -23
- package/docs/app-version-control-schema.md +0 -21
- package/docs/app_install_cloud_response_schema-properties-appinstallcloudresponse-properties-appinstallpayload-properties-appsignedurl.md +0 -15
- package/docs/app_install_cloud_response_schema-properties-appinstallcloudresponse-properties-appinstallpayload.md +0 -39
- package/docs/app_install_cloud_response_schema-properties-appinstallcloudresponse-properties-appreleasehash.md +0 -25
- package/docs/app_install_cloud_response_schema-properties-appinstallcloudresponse-properties-modelsinstallpayload.md +0 -15
- package/docs/app_install_cloud_response_schema-properties-appinstallcloudresponse-properties-projectid.md +0 -25
- package/docs/app_install_cloud_response_schema-properties-appinstallcloudresponse.md +0 -116
- package/docs/app_install_cloud_response_schema-properties-messagetype.md +0 -23
- package/docs/app_install_cloud_response_schema.md +0 -66
- package/docs/app_install_schema-properties-appreleasehash.md +0 -25
- package/docs/app_install_schema-properties-basecommand.md +0 -23
- package/docs/app_install_schema-properties-projectid.md +0 -25
- package/docs/app_install_schema.md +0 -105
- package/docs/app_state_control_schema-properties-appstatecontrol-properties-basecommand.md +0 -25
- package/docs/app_state_control_schema-properties-appstatecontrol-properties-projectid.md +0 -25
- package/docs/app_state_control_schema-properties-appstatecontrol.md +0 -78
- package/docs/app_state_control_schema-properties-messagetype.md +0 -23
- package/docs/app_state_control_schema.md +0 -66
- package/docs/app_uninstall_schema-properties-basecommand.md +0 -23
- package/docs/app_uninstall_schema-properties-projectid.md +0 -25
- package/docs/app_uninstall_schema.md +0 -76
- package/docs/app_version_control_schema-properties-appversioncontrol.md +0 -21
- package/docs/app_version_control_schema-properties-messagetype.md +0 -23
- package/docs/app_version_control_schema.md +0 -72
- package/docs/client-message-schema-defs-message.md +0 -25
- package/docs/client-message-schema-defs.md +0 -15
- package/docs/client-message-schema-properties-payload-oneof-live_state_updates.md +0 -66
- package/docs/client-message-schema-properties-payload-oneof-models_install_cloud_response.md +0 -66
- package/docs/client-message-schema-properties-payload.md +0 -27
- package/docs/client-message-schema-properties-timestamp.md +0 -15
- package/docs/client-message-schema-properties-topic.md +0 -25
- package/docs/client-message-schema.md +0 -112
- package/docs/client_message_schema-defs-message.md +0 -25
- package/docs/client_message_schema-defs.md +0 -15
- package/docs/client_message_schema-properties-payload-oneof-3.md +0 -66
- package/docs/client_message_schema-properties-payload-oneof-4.md +0 -66
- package/docs/client_message_schema-properties-payload.md +0 -27
- package/docs/client_message_schema-properties-timestamp.md +0 -15
- package/docs/client_message_schema-properties-topic.md +0 -25
- package/docs/client_message_schema.md +0 -112
- package/docs/common-schema-defs-appreleasehash.md +0 -25
- package/docs/common-schema-defs-modelid.md +0 -25
- package/docs/common-schema-defs-projectid.md +0 -25
- package/docs/common-schema-defs-txid.md +0 -29
- package/docs/common-schema-defs.md +0 -15
- package/docs/common-schema.md +0 -61
- package/docs/device-action-schema-properties-action.md +0 -23
- package/docs/device-action-schema.md +0 -47
- package/docs/device-stats-schema-properties-cpudetails-properties-temperature.md +0 -15
- package/docs/device-stats-schema-properties-cpudetails-properties-usedperc.md +0 -15
- package/docs/device-stats-schema-properties-cpudetails.md +0 -58
- package/docs/device-stats-schema-properties-cpuusage.md +0 -15
- package/docs/device-stats-schema-properties-diskdetails-properties-freegb.md +0 -15
- package/docs/device-stats-schema-properties-diskdetails-properties-usedgb.md +0 -15
- package/docs/device-stats-schema-properties-diskdetails.md +0 -58
- package/docs/device-stats-schema-properties-diskutil.md +0 -15
- package/docs/device-stats-schema-properties-memdetails-properties-freemb.md +0 -15
- package/docs/device-stats-schema-properties-memdetails-properties-usedmb.md +0 -15
- package/docs/device-stats-schema-properties-memdetails.md +0 -58
- package/docs/device-stats-schema-properties-usedmemorypercentage.md +0 -15
- package/docs/device-stats-schema.md +0 -134
- package/docs/device-status-schema-properties-devicestats-properties-cpuusage.md +0 -15
- package/docs/device-status-schema-properties-devicestats-properties-diskutil.md +0 -15
- package/docs/device-status-schema-properties-devicestats-properties-usedmemorypercentage.md +0 -15
- package/docs/device-status-schema-properties-devicestats.md +0 -77
- package/docs/device-status-schema-properties-messagetype.md +0 -23
- package/docs/device-status-schema.md +0 -66
- package/docs/live-updates-toggle-schema-properties-applogs-properties-toggle.md +0 -15
- package/docs/live-updates-toggle-schema-properties-applogs.md +0 -68
- package/docs/live-updates-toggle-schema-properties-appstate.md +0 -15
- package/docs/live-updates-toggle-schema-properties-devicestats.md +0 -15
- package/docs/live-updates-toggle-schema-properties-liveupdatestoggles-properties-applogs-properties-projectid.md +0 -25
- package/docs/live-updates-toggle-schema-properties-liveupdatestoggles-properties-applogs-properties-toggle.md +0 -15
- package/docs/live-updates-toggle-schema-properties-liveupdatestoggles-properties-applogs.md +0 -68
- package/docs/live-updates-toggle-schema-properties-liveupdatestoggles-properties-appstate.md +0 -15
- package/docs/live-updates-toggle-schema-properties-liveupdatestoggles-properties-devicestats.md +0 -15
- package/docs/live-updates-toggle-schema-properties-liveupdatestoggles.md +0 -77
- package/docs/live-updates-toggle-schema-properties-messagetype.md +0 -23
- package/docs/live-updates-toggle-schema.md +0 -77
- package/docs/live_updates_toggle_schema-properties-liveupdatestoggles-properties-applogs-properties-projectid.md +0 -25
- package/docs/live_updates_toggle_schema-properties-liveupdatestoggles-properties-applogs-properties-toggle.md +0 -15
- package/docs/live_updates_toggle_schema-properties-liveupdatestoggles-properties-applogs.md +0 -68
- package/docs/live_updates_toggle_schema-properties-liveupdatestoggles-properties-appstate.md +0 -15
- package/docs/live_updates_toggle_schema-properties-liveupdatestoggles-properties-devicestats.md +0 -15
- package/docs/live_updates_toggle_schema-properties-liveupdatestoggles.md +0 -77
- package/docs/live_updates_toggle_schema-properties-messagetype.md +0 -23
- package/docs/live_updates_toggle_schema.md +0 -66
- package/docs/models-install-cloud-response-schema-properties-messagetype.md +0 -23
- package/docs/models-install-cloud-response-schema-properties-modelsinstallcloudresponse-properties-projectid.md +0 -25
- package/docs/models-install-cloud-response-schema-properties-modelsinstallcloudresponse.md +0 -68
- package/docs/models-install-cloud-response-schema.md +0 -66
- package/docs/models-install-payload-schema-items-properties-id.md +0 -25
- package/docs/models-install-payload-schema-items-properties-modelsignedurl.md +0 -15
- package/docs/models-install-payload-schema-items-properties-version.md +0 -15
- package/docs/models-install-payload-schema-items.md +0 -87
- package/docs/models-install-payload-schema.md +0 -15
- package/docs/models-install-response-schema-properties-modelsinstallresponse.md +0 -68
- package/docs/models-install-response-schema.md +0 -39
- package/docs/models_install_cloud_response_schema-properties-messagetype.md +0 -23
- package/docs/models_install_cloud_response_schema-properties-modelsinstallcloudresponse-properties-projectid.md +0 -25
- package/docs/models_install_cloud_response_schema-properties-modelsinstallcloudresponse.md +0 -68
- package/docs/models_install_cloud_response_schema.md +0 -66
- package/docs/models_install_payload_schema-items-properties-id.md +0 -25
- package/docs/models_install_payload_schema-items-properties-modelsignedurl.md +0 -15
- package/docs/models_install_payload_schema-items-properties-version.md +0 -15
- package/docs/models_install_payload_schema-items.md +0 -87
- package/docs/models_install_payload_schema.md +0 -15
- package/docs/shadow-project-update-schema-properties-appconfig.md +0 -15
- package/docs/shadow-project-update-schema-properties-envvars-patternproperties--patternproperties-.md +0 -15
- package/docs/shadow-project-update-schema-properties-envvars-patternproperties--patternproperties.md +0 -15
- package/docs/shadow-project-update-schema-properties-envvars-patternproperties-.md +0 -39
- package/docs/shadow-project-update-schema-properties-envvars-patternproperties.md +0 -15
- package/docs/shadow-project-update-schema-properties-envvars.md +0 -44
- package/docs/shadow-project-update-schema.md +0 -63
- package/docs/shadow-projects-update-all-schema-patternproperties.md +0 -15
- package/docs/shadow-projects-update-all-schema-propertynames.md +0 -25
- package/docs/shadow-projects-update-all-schema.md +0 -44
- package/docs/signed-urls-request-schema-properties-messagetype.md +0 -23
- package/docs/signed-urls-request-schema-properties-modelsonlyurlsrequest-properties-models-patternproperties-a-za-z0-9_.md +0 -15
- package/docs/signed-urls-request-schema-properties-modelsonlyurlsrequest-properties-models-patternproperties.md +0 -15
- package/docs/signed-urls-request-schema-properties-modelsonlyurlsrequest-properties-models.md +0 -39
- package/docs/signed-urls-request-schema-properties-modelsonlyurlsrequest-properties-projectid.md +0 -25
- package/docs/signed-urls-request-schema-properties-modelsonlyurlsrequest.md +0 -68
- package/docs/signed-urls-request-schema-properties-signedurlsrequest-properties-appreleasehash.md +0 -25
- package/docs/signed-urls-request-schema-properties-signedurlsrequest-properties-projectid.md +0 -25
- package/docs/signed-urls-request-schema-properties-signedurlsrequest.md +0 -78
- package/docs/signed-urls-request-schema.md +0 -58
- package/docs/status-response-schema-properties-message.md +0 -15
- package/docs/status-response-schema-properties-status.md +0 -27
- package/docs/status-response-schema.md +0 -70
- package/docs/system-information-schema-properties-cpu-properties-brand.md +0 -15
- package/docs/system-information-schema-properties-cpu-properties-cores.md +0 -15
- package/docs/system-information-schema-properties-cpu-properties-efficiencycores.md +0 -15
- package/docs/system-information-schema-properties-cpu-properties-manufacturer.md +0 -15
- package/docs/system-information-schema-properties-cpu-properties-model.md +0 -15
- package/docs/system-information-schema-properties-cpu-properties-physicalcores.md +0 -15
- package/docs/system-information-schema-properties-cpu-properties-processors.md +0 -15
- package/docs/system-information-schema-properties-cpu-properties-vendor.md +0 -15
- package/docs/system-information-schema-properties-cpu.md +0 -172
- package/docs/system-information-schema-properties-device-properties-manufacturer.md +0 -15
- package/docs/system-information-schema-properties-device-properties-model.md +0 -15
- package/docs/system-information-schema-properties-device-properties-serial.md +0 -15
- package/docs/system-information-schema-properties-device-properties-version.md +0 -15
- package/docs/system-information-schema-properties-device-properties-virtual.md +0 -15
- package/docs/system-information-schema-properties-device.md +0 -115
- package/docs/system-information-schema-properties-disk-properties-drives-items-properties-device.md +0 -15
- package/docs/system-information-schema-properties-disk-properties-drives-items-properties-name.md +0 -15
- package/docs/system-information-schema-properties-disk-properties-drives-items-properties-size.md +0 -15
- package/docs/system-information-schema-properties-disk-properties-drives-items-properties-type.md +0 -15
- package/docs/system-information-schema-properties-disk-properties-drives-items-properties-vendor.md +0 -15
- package/docs/system-information-schema-properties-disk-properties-drives-items.md +0 -115
- package/docs/system-information-schema-properties-disk-properties-drives.md +0 -15
- package/docs/system-information-schema-properties-disk.md +0 -39
- package/docs/system-information-schema-properties-network-properties-ipv4address.md +0 -15
- package/docs/system-information-schema-properties-network-properties-ipv6address.md +0 -15
- package/docs/system-information-schema-properties-network-properties-macaddress.md +0 -15
- package/docs/system-information-schema-properties-network.md +0 -77
- package/docs/system-information-schema-properties-os-properties-architecture.md +0 -15
- package/docs/system-information-schema-properties-os-properties-distro.md +0 -15
- package/docs/system-information-schema-properties-os-properties-hostname.md +0 -15
- package/docs/system-information-schema-properties-os-properties-kernel.md +0 -15
- package/docs/system-information-schema-properties-os-properties-platform.md +0 -15
- package/docs/system-information-schema-properties-os-properties-release.md +0 -15
- package/docs/system-information-schema-properties-os.md +0 -134
- package/docs/system-information-schema-properties-versions-properties-agent.md +0 -15
- package/docs/system-information-schema-properties-versions-properties-deviceagentschemas.md +0 -15
- package/docs/system-information-schema-properties-versions.md +0 -58
- package/docs/system-information-schema.md +0 -134
- package/docs/to-client-message-schema-allof-0-if-properties-messagetype.md +0 -23
- package/docs/to-client-message-schema-allof-0-if-properties.md +0 -15
- package/docs/to-client-message-schema-allof-0-if.md +0 -47
- package/docs/to-client-message-schema-allof-0-then-properties.md +0 -15
- package/docs/to-client-message-schema-allof-0-then.md +0 -39
- package/docs/to-client-message-schema-allof-0.md +0 -15
- package/docs/to-client-message-schema-allof-1-if-properties-messagetype.md +0 -23
- package/docs/to-client-message-schema-allof-1-if-properties.md +0 -15
- package/docs/to-client-message-schema-allof-1-if.md +0 -47
- package/docs/to-client-message-schema-allof-1-then-properties.md +0 -15
- package/docs/to-client-message-schema-allof-1-then.md +0 -39
- package/docs/to-client-message-schema-allof-1.md +0 -15
- package/docs/to-client-message-schema-allof-2-if-properties-messagetype.md +0 -23
- package/docs/to-client-message-schema-allof-2-if-properties.md +0 -15
- package/docs/to-client-message-schema-allof-2-if.md +0 -47
- package/docs/to-client-message-schema-allof-2-then-properties.md +0 -15
- package/docs/to-client-message-schema-allof-2-then.md +0 -39
- package/docs/to-client-message-schema-allof-2.md +0 -15
- package/docs/to-client-message-schema-allof-3-if-properties-messagetype.md +0 -23
- package/docs/to-client-message-schema-allof-3-if-properties.md +0 -15
- package/docs/to-client-message-schema-allof-3-if.md +0 -47
- package/docs/to-client-message-schema-allof-3-then-properties.md +0 -15
- package/docs/to-client-message-schema-allof-3-then.md +0 -39
- package/docs/to-client-message-schema-allof-3.md +0 -15
- package/docs/to-client-message-schema-defs-toclient.md +0 -25
- package/docs/to-client-message-schema-defs.md +0 -15
- package/docs/to-client-message-schema-properties-deviceid.md +0 -15
- package/docs/to-client-message-schema-properties-messagetype.md +0 -26
- package/docs/to-client-message-schema-properties-payload.md +0 -25
- package/docs/to-client-message-schema-properties-timestamp.md +0 -15
- package/docs/to-client-message-schema-properties-topic-oneof-0.md +0 -25
- package/docs/to-client-message-schema-properties-topic.md +0 -19
- package/docs/to-client-message-schema.md +0 -196
- package/docs/to-cloud-message-schema-allof-0-if-properties-messagetype.md +0 -23
- package/docs/to-cloud-message-schema-allof-0-if-properties.md +0 -15
- package/docs/to-cloud-message-schema-allof-0-if.md +0 -47
- package/docs/to-cloud-message-schema-allof-0-then-properties.md +0 -15
- package/docs/to-cloud-message-schema-allof-0-then.md +0 -39
- package/docs/to-cloud-message-schema-allof-0.md +0 -15
- package/docs/to-cloud-message-schema-defs-tocloud.md +0 -25
- package/docs/to-cloud-message-schema-defs.md +0 -15
- package/docs/to-cloud-message-schema-properties-deviceid.md +0 -15
- package/docs/to-cloud-message-schema-properties-messagetype.md +0 -23
- package/docs/to-cloud-message-schema-properties-payload.md +0 -19
- package/docs/to-cloud-message-schema-properties-timestamp.md +0 -15
- package/docs/to-cloud-message-schema-properties-topic-oneof-0.md +0 -25
- package/docs/to-cloud-message-schema-properties-topic.md +0 -19
- package/docs/to-cloud-message-schema.md +0 -181
- package/docs/to-device-agent-message-schema-allof-0-if-properties-messagetype.md +0 -23
- package/docs/to-device-agent-message-schema-allof-0-if-properties.md +0 -15
- package/docs/to-device-agent-message-schema-allof-0-if.md +0 -47
- package/docs/to-device-agent-message-schema-allof-0-then-properties.md +0 -15
- package/docs/to-device-agent-message-schema-allof-0-then.md +0 -39
- package/docs/to-device-agent-message-schema-allof-0.md +0 -15
- package/docs/to-device-agent-message-schema-allof-1-if-properties-messagetype.md +0 -23
- package/docs/to-device-agent-message-schema-allof-1-if-properties.md +0 -15
- package/docs/to-device-agent-message-schema-allof-1-if.md +0 -47
- package/docs/to-device-agent-message-schema-allof-1-then-properties.md +0 -15
- package/docs/to-device-agent-message-schema-allof-1-then.md +0 -45
- package/docs/to-device-agent-message-schema-allof-1.md +0 -15
- package/docs/to-device-agent-message-schema-allof-2-if-properties-messagetype.md +0 -23
- package/docs/to-device-agent-message-schema-allof-2-if-properties.md +0 -15
- package/docs/to-device-agent-message-schema-allof-2-if.md +0 -47
- package/docs/to-device-agent-message-schema-allof-2-then-properties.md +0 -15
- package/docs/to-device-agent-message-schema-allof-2-then.md +0 -39
- package/docs/to-device-agent-message-schema-allof-2.md +0 -15
- package/docs/to-device-agent-message-schema-allof-3-if-properties-messagetype.md +0 -23
- package/docs/to-device-agent-message-schema-allof-3-if-properties.md +0 -15
- package/docs/to-device-agent-message-schema-allof-3-if.md +0 -47
- package/docs/to-device-agent-message-schema-allof-3-then-properties.md +0 -15
- package/docs/to-device-agent-message-schema-allof-3-then.md +0 -39
- package/docs/to-device-agent-message-schema-allof-3.md +0 -15
- package/docs/to-device-agent-message-schema-allof-4-if-properties-messagetype.md +0 -23
- package/docs/to-device-agent-message-schema-allof-4-if-properties.md +0 -15
- package/docs/to-device-agent-message-schema-allof-4-if.md +0 -47
- package/docs/to-device-agent-message-schema-allof-4-then-properties.md +0 -15
- package/docs/to-device-agent-message-schema-allof-4-then.md +0 -39
- package/docs/to-device-agent-message-schema-allof-4.md +0 -15
- package/docs/to-device-agent-message-schema-allof-5-if-properties-messagetype.md +0 -23
- package/docs/to-device-agent-message-schema-allof-5-if-properties.md +0 -15
- package/docs/to-device-agent-message-schema-allof-5-if.md +0 -47
- package/docs/to-device-agent-message-schema-allof-5-then-properties.md +0 -15
- package/docs/to-device-agent-message-schema-allof-5-then.md +0 -39
- package/docs/to-device-agent-message-schema-allof-5.md +0 -15
- package/docs/to-device-agent-message-schema-allof-6-if-properties-messagetype.md +0 -23
- package/docs/to-device-agent-message-schema-allof-6-if-properties.md +0 -15
- package/docs/to-device-agent-message-schema-allof-6-if.md +0 -47
- package/docs/to-device-agent-message-schema-allof-6-then-properties.md +0 -15
- package/docs/to-device-agent-message-schema-allof-6-then.md +0 -39
- package/docs/to-device-agent-message-schema-allof-6.md +0 -15
- package/docs/to-device-agent-message-schema-defs-todevice.md +0 -25
- package/docs/to-device-agent-message-schema-defs.md +0 -15
- package/docs/to-device-agent-message-schema-properties-messagetype.md +0 -29
- package/docs/to-device-agent-message-schema-properties-payload.md +0 -35
- package/docs/to-device-agent-message-schema-properties-timestamp.md +0 -15
- package/docs/to-device-agent-message-schema-properties-topic.md +0 -25
- package/docs/to-device-agent-message-schema.md +0 -202
- package/jest.config.js +0 -3
- package/lib/app-action-schema.d.ts.map +0 -1
- package/lib/app-action-schema.js.map +0 -1
- package/lib/app-logs-schema.d.ts.map +0 -1
- package/lib/app-logs-schema.js.map +0 -1
- package/lib/app-state-schema.d.ts.map +0 -1
- package/lib/app-state-schema.js.map +0 -1
- package/lib/constants.d.ts.map +0 -1
- package/lib/constants.js.map +0 -1
- package/lib/device-action-schema.d.ts.map +0 -1
- package/lib/device-action-schema.js.map +0 -1
- package/lib/device-agent-action-schema.d.ts.map +0 -1
- package/lib/device-agent-action-schema.js.map +0 -1
- package/lib/device-stats-schema.d.ts.map +0 -1
- package/lib/device-stats-schema.js.map +0 -1
- package/lib/index.d.ts.map +0 -1
- package/lib/index.js.map +0 -1
- package/lib/message-builders.d.ts.map +0 -1
- package/lib/message-builders.js.map +0 -1
- package/lib/shadow-schema.d.ts.map +0 -1
- package/lib/shadow-schema.js.map +0 -1
- package/lib/signed-urls-request-schema.d.ts.map +0 -1
- package/lib/signed-urls-request-schema.js.map +0 -1
- package/lib/status-response-schema.d.ts.map +0 -1
- package/lib/status-response-schema.js.map +0 -1
- package/lib/types.d.ts.map +0 -1
- package/lib/types.js.map +0 -1
- package/lib/utils.d.ts.map +0 -1
- package/lib/utils.js.map +0 -1
- package/src/app-action-schema.ts +0 -71
- package/src/app-logs-schema.ts +0 -13
- package/src/app-state-schema.ts +0 -27
- package/src/constants.ts +0 -140
- package/src/device-action-schema.ts +0 -11
- package/src/device-agent-action-schema.ts +0 -17
- package/src/device-stats-schema.ts +0 -33
- package/src/index.ts +0 -182
- package/src/message-builders.ts +0 -263
- package/src/schemas/app-install-response-schema.json +0 -41
- package/src/schemas/app-install-schema.json +0 -20
- package/src/schemas/app-logs-schema.json +0 -16
- package/src/schemas/app-state-control-schema.json +0 -17
- package/src/schemas/app-state-schema.json +0 -49
- package/src/schemas/app-uninstall-schema.json +0 -17
- package/src/schemas/app-version-control-schema.json +0 -14
- package/src/schemas/common-schema.json +0 -27
- package/src/schemas/device-action-schema.json +0 -14
- package/src/schemas/device-stats-schema.json +0 -58
- package/src/schemas/live-updates-toggle-schema.json +0 -29
- package/src/schemas/models-install-payload-schema.json +0 -22
- package/src/schemas/models-install-response-schema.json +0 -23
- package/src/schemas/shadow-project-update-schema.json +0 -30
- package/src/schemas/shadow-projects-update-all-schema.json +0 -17
- package/src/schemas/signed-urls-request-schema.json +0 -42
- package/src/schemas/status-response-schema.json +0 -16
- package/src/schemas/system-information-schema.json +0 -155
- package/src/schemas/to-client-message-schema.json +0 -98
- package/src/schemas/to-cloud-message-schema.json +0 -56
- package/src/schemas/to-device-agent-message-schema.json +0 -135
- package/src/shadow-schema.ts +0 -177
- package/src/signed-urls-request-schema.ts +0 -22
- package/src/status-response-schema.ts +0 -18
- package/src/types.ts +0 -175
- package/src/utils.ts +0 -21
- package/tests/constants.test.ts +0 -41
- package/tests/shadow-schema.test.ts +0 -171
- package/tests/types.test.ts +0 -515
- package/tsconfig.build.json +0 -4
- package/tsconfig.eslint.json +0 -5
- package/tsconfig.json +0 -91
|
@@ -1,112 +0,0 @@
|
|
|
1
|
-
# ClientPayload Schema
|
|
2
|
-
|
|
3
|
-
```txt
|
|
4
|
-
https://alwaysai.co/client_message_schema.json
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
A schema that describes the message payload structure for messages sent from clients to device agent
|
|
8
|
-
|
|
9
|
-
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
-
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------- |
|
|
11
|
-
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [client\_message\_schema.json](../out/client_message_schema.json "open original schema") |
|
|
12
|
-
|
|
13
|
-
## ClientPayload Type
|
|
14
|
-
|
|
15
|
-
`object` ([ClientPayload](client_message_schema.md))
|
|
16
|
-
|
|
17
|
-
# ClientPayload Properties
|
|
18
|
-
|
|
19
|
-
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
-
| :---------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------ |
|
|
21
|
-
| [timestamp](#timestamp) | `string` | Required | cannot be null | [ClientPayload](client_message_schema-properties-timestamp.md "https://alwaysai.co/client_message_schema.json#/properties/timestamp") |
|
|
22
|
-
| [topic](#topic) | `string` | Required | cannot be null | [ClientPayload](client_message_schema-properties-topic.md "https://alwaysai.co/client_message_schema.json#/properties/topic") |
|
|
23
|
-
| [payload](#payload) | Merged | Required | cannot be null | [ClientPayload](client_message_schema-properties-payload.md "https://alwaysai.co/client_message_schema.json#/properties/payload") |
|
|
24
|
-
|
|
25
|
-
## timestamp
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
`timestamp`
|
|
30
|
-
|
|
31
|
-
* is required
|
|
32
|
-
|
|
33
|
-
* Type: `string`
|
|
34
|
-
|
|
35
|
-
* cannot be null
|
|
36
|
-
|
|
37
|
-
* defined in: [ClientPayload](client_message_schema-properties-timestamp.md "https://alwaysai.co/client_message_schema.json#/properties/timestamp")
|
|
38
|
-
|
|
39
|
-
### timestamp Type
|
|
40
|
-
|
|
41
|
-
`string`
|
|
42
|
-
|
|
43
|
-
## topic
|
|
44
|
-
|
|
45
|
-
Topic on which messages are sent to device agent.
|
|
46
|
-
|
|
47
|
-
`topic`
|
|
48
|
-
|
|
49
|
-
* is required
|
|
50
|
-
|
|
51
|
-
* Type: `string`
|
|
52
|
-
|
|
53
|
-
* cannot be null
|
|
54
|
-
|
|
55
|
-
* defined in: [ClientPayload](client_message_schema-properties-topic.md "https://alwaysai.co/client_message_schema.json#/properties/topic")
|
|
56
|
-
|
|
57
|
-
### topic Type
|
|
58
|
-
|
|
59
|
-
`string`
|
|
60
|
-
|
|
61
|
-
### topic Constraints
|
|
62
|
-
|
|
63
|
-
**pattern**: the string must match the following regular expression: 
|
|
64
|
-
|
|
65
|
-
```regexp
|
|
66
|
-
^to-device/aai-device/([0-9a-z]+-+)+([0-9a-z])+
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
[try pattern](https://regexr.com/?expression=%5Eto-device%2Faai-device%2F\(%5B0-9a-z%5D%2B-%2B\)%2B\(%5B0-9a-z%5D\)%2B "try regular expression with regexr.com")
|
|
70
|
-
|
|
71
|
-
## payload
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
`payload`
|
|
76
|
-
|
|
77
|
-
* is required
|
|
78
|
-
|
|
79
|
-
* Type: merged type ([Details](client_message_schema-properties-payload.md))
|
|
80
|
-
|
|
81
|
-
* cannot be null
|
|
82
|
-
|
|
83
|
-
* defined in: [ClientPayload](client_message_schema-properties-payload.md "https://alwaysai.co/client_message_schema.json#/properties/payload")
|
|
84
|
-
|
|
85
|
-
### payload Type
|
|
86
|
-
|
|
87
|
-
merged type ([Details](client_message_schema-properties-payload.md))
|
|
88
|
-
|
|
89
|
-
one (and only one) of
|
|
90
|
-
|
|
91
|
-
* [Untitled object in ClientPayload](client_message_schema-properties-payload-oneof-0.md "check type definition")
|
|
92
|
-
|
|
93
|
-
* [Untitled object in ClientPayload](client_message_schema-properties-payload-oneof-1.md "check type definition")
|
|
94
|
-
|
|
95
|
-
* [app_install_cloud_response](client_message_schema-properties-payload-oneof-app_install_cloud_response.md "check type definition")
|
|
96
|
-
|
|
97
|
-
* [Untitled object in ClientPayload](client_message_schema-properties-payload-oneof-3.md "check type definition")
|
|
98
|
-
|
|
99
|
-
* [Untitled object in ClientPayload](client_message_schema-properties-payload-oneof-4.md "check type definition")
|
|
100
|
-
|
|
101
|
-
# ClientPayload Definitions
|
|
102
|
-
|
|
103
|
-
## Definitions group message
|
|
104
|
-
|
|
105
|
-
Reference this group by using
|
|
106
|
-
|
|
107
|
-
```json
|
|
108
|
-
{"$ref":"https://alwaysai.co/client_message_schema.json#/$defs/message"}
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
| Property | Type | Required | Nullable | Defined by |
|
|
112
|
-
| :------- | :--- | :------- | :------- | :--------- |
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
# Untitled string in signed\_urls\_request Schema
|
|
2
|
-
|
|
3
|
-
```txt
|
|
4
|
-
https://alwaysai.co/signed-urls-request-schema.json#/properties/signedUrlsRequest/properties/appReleaseHash
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
The version of the project associated with the message payload.
|
|
8
|
-
|
|
9
|
-
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
-
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------------- |
|
|
11
|
-
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [signed-urls-request-schema.json\*](../out/signed-urls-request-schema.json "open original schema") |
|
|
12
|
-
|
|
13
|
-
## appReleaseHash Type
|
|
14
|
-
|
|
15
|
-
`string`
|
|
16
|
-
|
|
17
|
-
## appReleaseHash Constraints
|
|
18
|
-
|
|
19
|
-
**pattern**: the string must match the following regular expression: 
|
|
20
|
-
|
|
21
|
-
```regexp
|
|
22
|
-
[0-9a-z]{64}
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
[try pattern](https://regexr.com/?expression=%5B0-9a-z%5D%7B64%7D "try regular expression with regexr.com")
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
# Untitled string in common Schema
|
|
2
|
-
|
|
3
|
-
```txt
|
|
4
|
-
https://alwaysai.co/common-schema.json#/$defs/modelId
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
The id of a model
|
|
8
|
-
|
|
9
|
-
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
-
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------- |
|
|
11
|
-
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [common-schema.json\*](../out/common-schema.json "open original schema") |
|
|
12
|
-
|
|
13
|
-
## modelId Type
|
|
14
|
-
|
|
15
|
-
`string`
|
|
16
|
-
|
|
17
|
-
## modelId Constraints
|
|
18
|
-
|
|
19
|
-
**pattern**: the string must match the following regular expression: 
|
|
20
|
-
|
|
21
|
-
```regexp
|
|
22
|
-
[A-Za-z0-9_]+/[A-Za-z0-9_]*
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
[try pattern](https://regexr.com/?expression=%5BA-Za-z0-9_%5D%2B%2F%5BA-Za-z0-9_%5D* "try regular expression with regexr.com")
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
# Untitled string in signed\_urls\_request Schema
|
|
2
|
-
|
|
3
|
-
```txt
|
|
4
|
-
https://alwaysai.co/signed-urls-request-schema.json#/properties/modelsOnlyUrlsRequest/properties/projectId
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
The specific project associated with the message payload.
|
|
8
|
-
|
|
9
|
-
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
-
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------------- |
|
|
11
|
-
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [signed-urls-request-schema.json\*](../out/signed-urls-request-schema.json "open original schema") |
|
|
12
|
-
|
|
13
|
-
## projectId Type
|
|
14
|
-
|
|
15
|
-
`string`
|
|
16
|
-
|
|
17
|
-
## projectId Constraints
|
|
18
|
-
|
|
19
|
-
**pattern**: the string must match the following regular expression: 
|
|
20
|
-
|
|
21
|
-
```regexp
|
|
22
|
-
[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
[try pattern](https://regexr.com/?expression=%5B0-9a-fA-F%5D%7B8%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B12%7D%24 "try regular expression with regexr.com")
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
# Untitled string in to\_device\_agent\_message Schema
|
|
2
|
-
|
|
3
|
-
```txt
|
|
4
|
-
https://alwaysai.co/to-device-agent-message-schema.json#/properties/txId
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
-
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------------------- |
|
|
11
|
-
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [to-device-agent-message-schema.json\*](../out/to-device-agent-message-schema.json "open original schema") |
|
|
12
|
-
|
|
13
|
-
## txId Type
|
|
14
|
-
|
|
15
|
-
`string`
|
|
16
|
-
|
|
17
|
-
## txId Constraints
|
|
18
|
-
|
|
19
|
-
**maximum length**: the maximum number of characters for this string is: `36`
|
|
20
|
-
|
|
21
|
-
**minimum length**: the minimum number of characters for this string is: `36`
|
|
22
|
-
|
|
23
|
-
**pattern**: the string must match the following regular expression: 
|
|
24
|
-
|
|
25
|
-
```regexp
|
|
26
|
-
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
[try pattern](https://regexr.com/?expression=%5E%5B0-9a-fA-F%5D%7B8%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B4%7D-%5B0-9a-fA-F%5D%7B12%7D%24 "try regular expression with regexr.com")
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# Untitled undefined type in common Schema
|
|
2
|
-
|
|
3
|
-
```txt
|
|
4
|
-
https://alwaysai.co/common-schema.json#/$defs
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
-
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------- |
|
|
11
|
-
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [common-schema.json\*](../out/common-schema.json "open original schema") |
|
|
12
|
-
|
|
13
|
-
## $defs Type
|
|
14
|
-
|
|
15
|
-
unknown
|
package/docs/common-schema.md
DELETED
|
@@ -1,61 +0,0 @@
|
|
|
1
|
-
# common Schema
|
|
2
|
-
|
|
3
|
-
```txt
|
|
4
|
-
https://alwaysai.co/common-schema.json
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
-
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------- |
|
|
11
|
-
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [common-schema.json](../out/common-schema.json "open original schema") |
|
|
12
|
-
|
|
13
|
-
## common Type
|
|
14
|
-
|
|
15
|
-
unknown ([common](common-schema.md))
|
|
16
|
-
|
|
17
|
-
# common Definitions
|
|
18
|
-
|
|
19
|
-
## Definitions group projectId
|
|
20
|
-
|
|
21
|
-
Reference this group by using
|
|
22
|
-
|
|
23
|
-
```json
|
|
24
|
-
{"$ref":"https://alwaysai.co/common-schema.json#/$defs/projectId"}
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
| Property | Type | Required | Nullable | Defined by |
|
|
28
|
-
| :------- | :--- | :------- | :------- | :--------- |
|
|
29
|
-
|
|
30
|
-
## Definitions group appReleaseHash
|
|
31
|
-
|
|
32
|
-
Reference this group by using
|
|
33
|
-
|
|
34
|
-
```json
|
|
35
|
-
{"$ref":"https://alwaysai.co/common-schema.json#/$defs/appReleaseHash"}
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
| Property | Type | Required | Nullable | Defined by |
|
|
39
|
-
| :------- | :--- | :------- | :------- | :--------- |
|
|
40
|
-
|
|
41
|
-
## Definitions group modelId
|
|
42
|
-
|
|
43
|
-
Reference this group by using
|
|
44
|
-
|
|
45
|
-
```json
|
|
46
|
-
{"$ref":"https://alwaysai.co/common-schema.json#/$defs/modelId"}
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
| Property | Type | Required | Nullable | Defined by |
|
|
50
|
-
| :------- | :--- | :------- | :------- | :--------- |
|
|
51
|
-
|
|
52
|
-
## Definitions group txId
|
|
53
|
-
|
|
54
|
-
Reference this group by using
|
|
55
|
-
|
|
56
|
-
```json
|
|
57
|
-
{"$ref":"https://alwaysai.co/common-schema.json#/$defs/txId"}
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
| Property | Type | Required | Nullable | Defined by |
|
|
61
|
-
| :------- | :--- | :------- | :------- | :--------- |
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
# Untitled string in device\_action Schema
|
|
2
|
-
|
|
3
|
-
```txt
|
|
4
|
-
https://alwaysai.co/device-action-schema.json#/properties/action
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
-
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
|
|
11
|
-
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [device-action-schema.json\*](../out/device-action-schema.json "open original schema") |
|
|
12
|
-
|
|
13
|
-
## action Type
|
|
14
|
-
|
|
15
|
-
`string`
|
|
16
|
-
|
|
17
|
-
## action Constraints
|
|
18
|
-
|
|
19
|
-
**enum**: the value of this property must be equal to one of the following values:
|
|
20
|
-
|
|
21
|
-
| Value | Explanation |
|
|
22
|
-
| :----------------- | :---------- |
|
|
23
|
-
| `"system_restart"` | |
|
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
# device\_action Schema
|
|
2
|
-
|
|
3
|
-
```txt
|
|
4
|
-
https://alwaysai.co/device-action-schema.json
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
-
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- |
|
|
11
|
-
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [device-action-schema.json](../out/device-action-schema.json "open original schema") |
|
|
12
|
-
|
|
13
|
-
## device\_action Type
|
|
14
|
-
|
|
15
|
-
`object` ([device\_action](device-action-schema.md))
|
|
16
|
-
|
|
17
|
-
# device\_action Properties
|
|
18
|
-
|
|
19
|
-
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
-
| :---------------- | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
-
| [action](#action) | `string` | Required | cannot be null | [device\_action](device-action-schema-properties-action.md "https://alwaysai.co/device-action-schema.json#/properties/action") |
|
|
22
|
-
|
|
23
|
-
## action
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
`action`
|
|
28
|
-
|
|
29
|
-
* is required
|
|
30
|
-
|
|
31
|
-
* Type: `string`
|
|
32
|
-
|
|
33
|
-
* cannot be null
|
|
34
|
-
|
|
35
|
-
* defined in: [device\_action](device-action-schema-properties-action.md "https://alwaysai.co/device-action-schema.json#/properties/action")
|
|
36
|
-
|
|
37
|
-
### action Type
|
|
38
|
-
|
|
39
|
-
`string`
|
|
40
|
-
|
|
41
|
-
### action Constraints
|
|
42
|
-
|
|
43
|
-
**enum**: the value of this property must be equal to one of the following values:
|
|
44
|
-
|
|
45
|
-
| Value | Explanation |
|
|
46
|
-
| :----------------- | :---------- |
|
|
47
|
-
| `"system_restart"` | |
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# Untitled number in device\_stats Schema
|
|
2
|
-
|
|
3
|
-
```txt
|
|
4
|
-
https://alwaysai.co/device-stats-schema.json#/properties/cpuDetails/properties/temperature
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
-
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- |
|
|
11
|
-
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [device-stats-schema.json\*](../out/device-stats-schema.json "open original schema") |
|
|
12
|
-
|
|
13
|
-
## temperature Type
|
|
14
|
-
|
|
15
|
-
`number`
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# Untitled number in device\_stats Schema
|
|
2
|
-
|
|
3
|
-
```txt
|
|
4
|
-
https://alwaysai.co/device-stats-schema.json#/properties/cpuDetails/properties/usedPerc
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
-
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- |
|
|
11
|
-
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [device-stats-schema.json\*](../out/device-stats-schema.json "open original schema") |
|
|
12
|
-
|
|
13
|
-
## usedPerc Type
|
|
14
|
-
|
|
15
|
-
`number`
|
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
# Untitled object in device\_stats Schema
|
|
2
|
-
|
|
3
|
-
```txt
|
|
4
|
-
https://alwaysai.co/device-stats-schema.json#/properties/cpuDetails
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
CPU utilization information
|
|
8
|
-
|
|
9
|
-
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
-
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- |
|
|
11
|
-
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [device-stats-schema.json\*](../out/device-stats-schema.json "open original schema") |
|
|
12
|
-
|
|
13
|
-
## cpuDetails Type
|
|
14
|
-
|
|
15
|
-
`object` ([Details](device-stats-schema-properties-cpudetails.md))
|
|
16
|
-
|
|
17
|
-
# cpuDetails Properties
|
|
18
|
-
|
|
19
|
-
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
-
| :-------------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
21
|
-
| [usedPerc](#usedperc) | `number` | Optional | cannot be null | [device\_stats](device-stats-schema-properties-cpudetails-properties-usedperc.md "https://alwaysai.co/device-stats-schema.json#/properties/cpuDetails/properties/usedPerc") |
|
|
22
|
-
| [temperature](#temperature) | `number` | Optional | cannot be null | [device\_stats](device-stats-schema-properties-cpudetails-properties-temperature.md "https://alwaysai.co/device-stats-schema.json#/properties/cpuDetails/properties/temperature") |
|
|
23
|
-
|
|
24
|
-
## usedPerc
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
`usedPerc`
|
|
29
|
-
|
|
30
|
-
* is optional
|
|
31
|
-
|
|
32
|
-
* Type: `number`
|
|
33
|
-
|
|
34
|
-
* cannot be null
|
|
35
|
-
|
|
36
|
-
* defined in: [device\_stats](device-stats-schema-properties-cpudetails-properties-usedperc.md "https://alwaysai.co/device-stats-schema.json#/properties/cpuDetails/properties/usedPerc")
|
|
37
|
-
|
|
38
|
-
### usedPerc Type
|
|
39
|
-
|
|
40
|
-
`number`
|
|
41
|
-
|
|
42
|
-
## temperature
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
`temperature`
|
|
47
|
-
|
|
48
|
-
* is optional
|
|
49
|
-
|
|
50
|
-
* Type: `number`
|
|
51
|
-
|
|
52
|
-
* cannot be null
|
|
53
|
-
|
|
54
|
-
* defined in: [device\_stats](device-stats-schema-properties-cpudetails-properties-temperature.md "https://alwaysai.co/device-stats-schema.json#/properties/cpuDetails/properties/temperature")
|
|
55
|
-
|
|
56
|
-
### temperature Type
|
|
57
|
-
|
|
58
|
-
`number`
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# Untitled number in device\_stats Schema
|
|
2
|
-
|
|
3
|
-
```txt
|
|
4
|
-
https://alwaysai.co/device-stats-schema.json#/properties/cpuUsage
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
The percentage of the CPU that is currently being used.
|
|
8
|
-
|
|
9
|
-
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
-
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- |
|
|
11
|
-
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [device-stats-schema.json\*](../out/device-stats-schema.json "open original schema") |
|
|
12
|
-
|
|
13
|
-
## cpuUsage Type
|
|
14
|
-
|
|
15
|
-
`number`
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# Untitled number in device\_stats Schema
|
|
2
|
-
|
|
3
|
-
```txt
|
|
4
|
-
https://alwaysai.co/device-stats-schema.json#/properties/diskDetails/properties/freeGb
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
-
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- |
|
|
11
|
-
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [device-stats-schema.json\*](../out/device-stats-schema.json "open original schema") |
|
|
12
|
-
|
|
13
|
-
## freeGb Type
|
|
14
|
-
|
|
15
|
-
`number`
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# Untitled number in device\_stats Schema
|
|
2
|
-
|
|
3
|
-
```txt
|
|
4
|
-
https://alwaysai.co/device-stats-schema.json#/properties/diskDetails/properties/usedGb
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
-
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- |
|
|
11
|
-
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [device-stats-schema.json\*](../out/device-stats-schema.json "open original schema") |
|
|
12
|
-
|
|
13
|
-
## usedGb Type
|
|
14
|
-
|
|
15
|
-
`number`
|
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
# Untitled object in device\_stats Schema
|
|
2
|
-
|
|
3
|
-
```txt
|
|
4
|
-
https://alwaysai.co/device-stats-schema.json#/properties/diskDetails
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
Disk utilization information
|
|
8
|
-
|
|
9
|
-
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
-
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- |
|
|
11
|
-
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [device-stats-schema.json\*](../out/device-stats-schema.json "open original schema") |
|
|
12
|
-
|
|
13
|
-
## diskDetails Type
|
|
14
|
-
|
|
15
|
-
`object` ([Details](device-stats-schema-properties-diskdetails.md))
|
|
16
|
-
|
|
17
|
-
# diskDetails Properties
|
|
18
|
-
|
|
19
|
-
| Property | Type | Required | Nullable | Defined by |
|
|
20
|
-
| :---------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
21
|
-
| [usedGb](#usedgb) | `number` | Optional | cannot be null | [device\_stats](device-stats-schema-properties-diskdetails-properties-usedgb.md "https://alwaysai.co/device-stats-schema.json#/properties/diskDetails/properties/usedGb") |
|
|
22
|
-
| [freeGb](#freegb) | `number` | Optional | cannot be null | [device\_stats](device-stats-schema-properties-diskdetails-properties-freegb.md "https://alwaysai.co/device-stats-schema.json#/properties/diskDetails/properties/freeGb") |
|
|
23
|
-
|
|
24
|
-
## usedGb
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
`usedGb`
|
|
29
|
-
|
|
30
|
-
* is optional
|
|
31
|
-
|
|
32
|
-
* Type: `number`
|
|
33
|
-
|
|
34
|
-
* cannot be null
|
|
35
|
-
|
|
36
|
-
* defined in: [device\_stats](device-stats-schema-properties-diskdetails-properties-usedgb.md "https://alwaysai.co/device-stats-schema.json#/properties/diskDetails/properties/usedGb")
|
|
37
|
-
|
|
38
|
-
### usedGb Type
|
|
39
|
-
|
|
40
|
-
`number`
|
|
41
|
-
|
|
42
|
-
## freeGb
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
`freeGb`
|
|
47
|
-
|
|
48
|
-
* is optional
|
|
49
|
-
|
|
50
|
-
* Type: `number`
|
|
51
|
-
|
|
52
|
-
* cannot be null
|
|
53
|
-
|
|
54
|
-
* defined in: [device\_stats](device-stats-schema-properties-diskdetails-properties-freegb.md "https://alwaysai.co/device-stats-schema.json#/properties/diskDetails/properties/freeGb")
|
|
55
|
-
|
|
56
|
-
### freeGb Type
|
|
57
|
-
|
|
58
|
-
`number`
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# Untitled number in device\_stats Schema
|
|
2
|
-
|
|
3
|
-
```txt
|
|
4
|
-
https://alwaysai.co/device-stats-schema.json#/properties/diskUtil
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
The percentage of the drive storage that is being used.
|
|
8
|
-
|
|
9
|
-
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
-
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- |
|
|
11
|
-
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [device-stats-schema.json\*](../out/device-stats-schema.json "open original schema") |
|
|
12
|
-
|
|
13
|
-
## diskUtil Type
|
|
14
|
-
|
|
15
|
-
`number`
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# Untitled number in device\_stats Schema
|
|
2
|
-
|
|
3
|
-
```txt
|
|
4
|
-
https://alwaysai.co/device-stats-schema.json#/properties/memDetails/properties/freeMb
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
-
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- |
|
|
11
|
-
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [device-stats-schema.json\*](../out/device-stats-schema.json "open original schema") |
|
|
12
|
-
|
|
13
|
-
## freeMb Type
|
|
14
|
-
|
|
15
|
-
`number`
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# Untitled number in device\_stats Schema
|
|
2
|
-
|
|
3
|
-
```txt
|
|
4
|
-
https://alwaysai.co/device-stats-schema.json#/properties/memDetails/properties/usedMb
|
|
5
|
-
```
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
10
|
-
| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------- |
|
|
11
|
-
| Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [device-stats-schema.json\*](../out/device-stats-schema.json "open original schema") |
|
|
12
|
-
|
|
13
|
-
## usedMb Type
|
|
14
|
-
|
|
15
|
-
`number`
|