@alwaysai/device-agent-schemas 1.2.0 → 2.0.0

package/README.md

@@ -1,5 +1,9 @@
 # alwaysAI Device Agent Schemas
 
+## Contents
+* [Documentation](docs/README.md)
+* [Schemas](src/schemas)
+
 The alwaysAI Device Agent Schemas package provides interfaces that represent the messaging interface for communication with the alwaysAI Device Agent, as well as functions for validating JSON data that are being used as device agent messages.
 
 ## Use in Development
@@ -8,23 +12,23 @@ Use the provided interfaces as type guards in your development to ensure that pr
 The provided interfaces are:
 
 - DeviceStats,
-- DeviceStatsMessage,
+- DeviceStatsPayload,
 - AppState,
 - AppStateValue,
 - ServiceStatus,
 - AppDetails,
-- AppStateMessage,
+- AppStatePayload,
 - InstallationStatus,
 - InstallationStatusMessage,
 - AppLogs,
-- AppLogsMessage,
+- AppLogsPayload,
 - AppStateControlValue,
 - AppVersionControlValue,
 - AppStateControl,
 - AppVersionControl,
 - AppActionMessage,
 - AgentActionValue,
-- LiveUpdatesToggle,
+- LiveUpdatesToggles,
 - DeviceAgentMessage,
 - ClientMessage,
 

package/development.md

@@ -1,6 +1,43 @@
 # Overview
 The interfaces and schemas for each sub-packet can be found in `src/schemas`. The schemas are imported into `types.ts` and the overall JSONSchemaType as well as the sub-types are created, as are the validation methods. Validation methods are used to type-guard incoming messages, while the interfaces are used to type-guard at development time. This repository is configured as an `npm` package -- while under local development you can use `npm instal --save` along with the path to this repo to use it with the device agent.
 
+# Naming Conventions
+Below is an outline of the general interface structure.
+
+const message: xxxxMessage = {
+  ....,
+  messageType: [`DeviceAgentMessageTypeValue` or `ClientMessageTypeValue`],
+  payload: xxxxMessagePayload : {
+    [type lowercase]: [type is the mirror of the key (uppercase)]
+  }
+}
+
+
+## Upper Level
+The upper level content has the suffix `Message`. This is in keeping with the convention of having the content delivered on MQTT be the 'message'.
+
+## Message Payload
+Each of the `Message` packets have a 'payload', and these sub-packets are one of the following for `DeviceAgentMessage`:
+  - AppStateControlPayload
+  - AppVersionControlPayload
+  - LiveUpdatesTogglePayload
+  - AppInstallCloudResponsePayload
+  - ModelsInstallCloudResponsePayload
+
+For `ClientMessage`, the 'payload' field must be one of the following:
+  - AppLogsPayload
+  - StatusResponsePayload
+  - AppStatePayload
+  - DeviceStatsPayload
+  - SignedUrlsRequestPayload
+
+For all packets, there is a `messageType` field, whose entry helps identify the contents. This field can be used to distinguish which message has been sent, such as in a conditional block. For `ClientMessage`packets, this field is one of `ClientMessageTypeValue` entries and for `DeviceAgentMessage` packets, it is one of `DeviceAgentMessageTypeValue` entries.
+
+## Message Payload Contents
+Additionally, each 'payload' object contains a key that corresponds to the actual useful contents of the 'payload'. The name of the key indicates what type of contents these are.
+
+For instance, the `AppLogsPayload` type has a `messageType`, which is of type `app_logs`, as well as a key `appLogs`, which is of type `AppLogs`.
+
 # To Create New Schemas and Validation Methods
 To create a new message type, create a new `.ts` file in `src/schemas` and create the sub-schema and a corresponding `interface`. If you are using patterns or enums, you can add these to the `src/constants` file and import them as needed. You can them import the schemas into `types.ts` and modify the main schema's `payload` property's `oneOf` list to include the new type. You can then compile a new validation method against the new schema using your newly defined type. You may need to add the schema to the `ajv` instance, however this shouldn't be necessary if the main schema is referencing the new sub-schema. More notes on the development of this repo can be found here: https://alwaysai.atlassian.net/l/c/RdjVyG1d 
 

package/docs/README.md

@@ -0,0 +1,81 @@
+# README
+
+## Top-level Schemas
+
+*   [agent\_message](./agent-message-schema.md "The messaging payload structure for messages sent from device agent to clients") – `https://alwaysai.co/agent-message-schema.json`
+
+*   [app\_install](./app-install-schema.md) – `https://alwaysai.co/app-install-schema.json`
+
+*   [app\_install\_cloud\_response](./app-install-cloud-response-schema.md) – `https://alwaysai.co/app-install-cloud-response-schema.json`
+
+*   [app\_install\_status](./app-install-status-schema.md) – `https://alwaysai.co/app-install-status-schema.json`
+
+*   [app\_logs](./app-logs-schema.md) – `https://alwaysai.co/app-logs-schema.json`
+
+*   [app\_state](./app-state-schema.md) – `https://alwaysai.co/app-state-schema.json`
+
+*   [app\_state\_control](./app-state-control-schema.md) – `https://alwaysai.co/app-state-control-schema.json`
+
+*   [app\_uninstall](./app-uninstall-schema.md) – `https://alwaysai.co/app-uninstall-schema.json`
+
+*   [app\_version\_control](./app-version-control-schema.md) – `https://alwaysai.co/app-version-control-schema.json`
+
+*   [client\_message](./client-message-schema.md "A schema that describes the message payload structure for messages sent from clients to device agent") – `https://alwaysai.co/client-message-schema.json`
+
+*   [common](./common-schema.md) – `https://alwaysai.co/common-schema.json`
+
+*   [device\_stats](./device-status-schema.md) – `https://alwaysai.co/device-status-schema.json`
+
+*   [live\_state\_updates](./live-updates-toggle-schema.md) – `https://alwaysai.co/live-updates-toggle-schema.json`
+
+*   [models\_install\_cloud\_response](./models-install-cloud-response-schema.md) – `https://alwaysai.co/models-install-cloud-response-schema.json`
+
+*   [models\_install\_payload](./models-install-payload-schema.md) – `https://alwaysai.co/models-install-payload-schema.json`
+
+*   [signed\_urls\_request](./signed-urls-request-schema.md) – `https://alwaysai.co/signed-urls-request-schema.json`
+
+## Other Schemas
+
+### Objects
+
+*   [Untitled object in app\_install\_cloud\_response](./app-install-cloud-response-schema-properties-appinstallcloudresponse.md) – `https://alwaysai.co/app-install-cloud-response-schema.json#/properties/appInstallCloudResponse`
+
+*   [Untitled object in app\_install\_cloud\_response](./app-install-cloud-response-schema-properties-appinstallcloudresponse-properties-appinstallpayload.md) – `https://alwaysai.co/app-install-cloud-response-schema.json#/properties/appInstallCloudResponse/properties/appInstallPayload`
+
+*   [Untitled object in app\_install\_status](./app-install-status-schema-properties-appinstallstatus.md) – `https://alwaysai.co/app-install-status-schema.json#/properties/appInstallStatus`
+
+*   [Untitled object in app\_logs](./app-logs-schema-properties-applogs.md) – `https://alwaysai.co/app-logs-schema.json#/properties/appLogs`
+
+*   [Untitled object in app\_state](./app-state-schema-properties-appstate-items.md) – `https://alwaysai.co/app-state-schema.json#/properties/appState/items`
+
+*   [Untitled object in app\_state](./app-state-schema-properties-appstate-items-properties-appdetails.md) – `https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/appDetails`
+
+*   [Untitled object in app\_state](./app-state-schema-properties-appstate-items-properties-services-items.md) – `https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/services/items`
+
+*   [Untitled object in app\_state\_control](./app-state-control-schema-properties-appstatecontrol.md) – `https://alwaysai.co/app-state-control-schema.json#/properties/appStateControl`
+
+*   [Untitled object in device\_stats](./device-status-schema-properties-devicestats.md) – `https://alwaysai.co/device-status-schema.json#/properties/deviceStats`
+
+*   [Untitled object in live\_state\_updates](./live-updates-toggle-schema-properties-liveupdatestoggles.md) – `https://alwaysai.co/live-updates-toggle-schema.json#/properties/liveUpdatesToggles`
+
+*   [Untitled object in live\_state\_updates](./live-updates-toggle-schema-properties-liveupdatestoggles-properties-applogs.md) – `https://alwaysai.co/live-updates-toggle-schema.json#/properties/liveUpdatesToggles/properties/appLogs`
+
+*   [Untitled object in models\_install\_cloud\_response](./models-install-cloud-response-schema-properties-modelsinstallcloudresponse.md) – `https://alwaysai.co/models-install-cloud-response-schema.json#/properties/modelsInstallCloudResponse`
+
+*   [Untitled object in models\_install\_payload](./models-install-payload-schema-items.md) – `https://alwaysai.co/models-install-payload-schema.json#/items`
+
+*   [Untitled object in signed\_urls\_request](./signed-urls-request-schema-properties-signedurlsrequest.md) – `https://alwaysai.co/signed-urls-request-schema.json#/properties/signedUrlsRequest`
+
+*   [Untitled object in signed\_urls\_request](./signed-urls-request-schema-properties-modelsonlyurlsrequest.md) – `https://alwaysai.co/signed-urls-request-schema.json#/properties/modelsOnlyUrlsRequest`
+
+*   [Untitled object in signed\_urls\_request](./signed-urls-request-schema-properties-modelsonlyurlsrequest-properties-models.md) – `https://alwaysai.co/signed-urls-request-schema.json#/properties/modelsOnlyUrlsRequest/properties/models`
+
+### Arrays
+
+*   [Untitled array in app\_state](./app-state-schema-properties-appstate.md) – `https://alwaysai.co/app-state-schema.json#/properties/appState`
+
+*   [Untitled array in app\_state](./app-state-schema-properties-appstate-items-properties-services.md) – `https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/services`
+
+## Version Note
+
+The schemas linked above follow the JSON Schema Spec version: `https://json-schema.org/draft/2019-09/schema`

package/docs/agent-message-schema-defs-toclient.md

@@ -0,0 +1,25 @@
+# Untitled string in agent\_message Schema
+
+```txt
+https://alwaysai.co/agent-message-schema.json#/$defs/toClient
+```
+
+Messages sent from the agent itself to console client
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                             |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [agent-message-schema.json\*](../out/agent-message-schema.json "open original schema") |
+
+## toClient Type
+
+`string`
+
+## toClient Constraints
+
+**pattern**: the string must match the following regular expression: 
+
+```regexp
+to-client/aai-device/([0-9a-z]+-+)+([0-9a-z])+
+```
+
+[try pattern](https://regexr.com/?expression=to-client%2Faai-device%2F\(%5B0-9a-z%5D%2B-%2B\)%2B\(%5B0-9a-z%5D\)%2B "try regular expression with regexr.com")

package/docs/agent-message-schema-defs-tocloud.md

@@ -0,0 +1,25 @@
+# Untitled string in agent\_message Schema
+
+```txt
+https://alwaysai.co/agent-message-schema.json#/$defs/toCloud
+```
+
+Messages sent from the agent itself to cloud backend
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                             |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [agent-message-schema.json\*](../out/agent-message-schema.json "open original schema") |
+
+## toCloud Type
+
+`string`
+
+## toCloud Constraints
+
+**pattern**: the string must match the following regular expression: 
+
+```regexp
+to-cloud/aai-device/([0-9a-z]+-+)+([0-9a-z])+
+```
+
+[try pattern](https://regexr.com/?expression=to-cloud%2Faai-device%2F\(%5B0-9a-z%5D%2B-%2B\)%2B\(%5B0-9a-z%5D\)%2B "try regular expression with regexr.com")

package/docs/agent-message-schema-defs.md

@@ -0,0 +1,15 @@
+# Untitled undefined type in agent\_message Schema
+
+```txt
+https://alwaysai.co/agent-message-schema.json#/$defs
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                             |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [agent-message-schema.json\*](../out/agent-message-schema.json "open original schema") |
+
+## $defs Type
+
+unknown

package/docs/agent-message-schema-properties-deviceid.md

@@ -0,0 +1,15 @@
+# Untitled string in agent\_message Schema
+
+```txt
+https://alwaysai.co/agent-message-schema.json#/properties/deviceId
+```
+
+Device UUID of device sending the message
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                             |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [agent-message-schema.json\*](../out/agent-message-schema.json "open original schema") |
+
+## deviceId Type
+
+`string`

package/docs/agent-message-schema-properties-payload-oneof-app_install_status.md

@@ -0,0 +1,66 @@
+# app\_install\_status Schema
+
+```txt
+https://alwaysai.co/app-install-status-schema.json#/properties/payload/oneOf/3
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                             |
+| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | No           | Forbidden         | Forbidden             | none                | [agent-message-schema.json\*](../out/agent-message-schema.json "open original schema") |
+
+## 3 Type
+
+`object` ([app\_install\_status](agent-message-schema-properties-payload-oneof-app_install_status.md))
+
+# 3 Properties
+
+| Property                              | Type          | Required | Nullable       | Defined by                                                                                                                                                         |
+| :------------------------------------ | :------------ | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [messageType](#messagetype)           | Not specified | Required | cannot be null | [app\_install\_status](app-install-status-schema-properties-messagetype.md "https://alwaysai.co/app-install-status-schema.json#/properties/messageType")           |
+| [appInstallStatus](#appinstallstatus) | `object`      | Required | cannot be null | [app\_install\_status](app-install-status-schema-properties-appinstallstatus.md "https://alwaysai.co/app-install-status-schema.json#/properties/appInstallStatus") |
+
+## messageType
+
+
+
+`messageType`
+
+*   is required
+
+*   Type: unknown
+
+*   cannot be null
+
+*   defined in: [app\_install\_status](app-install-status-schema-properties-messagetype.md "https://alwaysai.co/app-install-status-schema.json#/properties/messageType")
+
+### messageType Type
+
+unknown
+
+### messageType Constraints
+
+**constant**: the value of this property must be equal to:
+
+```json
+"app_install_status"
+```
+
+## appInstallStatus
+
+
+
+`appInstallStatus`
+
+*   is required
+
+*   Type: `object` ([Details](app-install-status-schema-properties-appinstallstatus.md))
+
+*   cannot be null
+
+*   defined in: [app\_install\_status](app-install-status-schema-properties-appinstallstatus.md "https://alwaysai.co/app-install-status-schema.json#/properties/appInstallStatus")
+
+### appInstallStatus Type
+
+`object` ([Details](app-install-status-schema-properties-appinstallstatus.md))

package/docs/agent-message-schema-properties-payload-oneof-app_logs.md

@@ -0,0 +1,66 @@
+# app\_logs Schema
+
+```txt
+https://alwaysai.co/app-logs-schema.json#/properties/payload/oneOf/2
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                             |
+| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | No           | Forbidden         | Forbidden             | none                | [agent-message-schema.json\*](../out/agent-message-schema.json "open original schema") |
+
+## 2 Type
+
+`object` ([app\_logs](agent-message-schema-properties-payload-oneof-app_logs.md))
+
+# 2 Properties
+
+| Property                    | Type          | Required | Nullable       | Defined by                                                                                                                |
+| :-------------------------- | :------------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------ |
+| [messageType](#messagetype) | Not specified | Required | cannot be null | [app\_logs](app-logs-schema-properties-messagetype.md "https://alwaysai.co/app-logs-schema.json#/properties/messageType") |
+| [appLogs](#applogs)         | `object`      | Required | cannot be null | [app\_logs](app-logs-schema-properties-applogs.md "https://alwaysai.co/app-logs-schema.json#/properties/appLogs")         |
+
+## messageType
+
+
+
+`messageType`
+
+*   is required
+
+*   Type: unknown
+
+*   cannot be null
+
+*   defined in: [app\_logs](app-logs-schema-properties-messagetype.md "https://alwaysai.co/app-logs-schema.json#/properties/messageType")
+
+### messageType Type
+
+unknown
+
+### messageType Constraints
+
+**constant**: the value of this property must be equal to:
+
+```json
+"app_logs"
+```
+
+## appLogs
+
+
+
+`appLogs`
+
+*   is required
+
+*   Type: `object` ([Details](app-logs-schema-properties-applogs.md))
+
+*   cannot be null
+
+*   defined in: [app\_logs](app-logs-schema-properties-applogs.md "https://alwaysai.co/app-logs-schema.json#/properties/appLogs")
+
+### appLogs Type
+
+`object` ([Details](app-logs-schema-properties-applogs.md))

package/docs/agent-message-schema-properties-payload-oneof-app_state.md

@@ -0,0 +1,66 @@
+# app\_state Schema
+
+```txt
+https://alwaysai.co/app-state-schema.json#/properties/payload/oneOf/1
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                             |
+| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | No           | Forbidden         | Forbidden             | none                | [agent-message-schema.json\*](../out/agent-message-schema.json "open original schema") |
+
+## 1 Type
+
+`object` ([app\_state](agent-message-schema-properties-payload-oneof-app_state.md))
+
+# 1 Properties
+
+| Property                    | Type          | Required | Nullable       | Defined by                                                                                                                   |
+| :-------------------------- | :------------ | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------- |
+| [messageType](#messagetype) | Not specified | Required | cannot be null | [app\_state](app-state-schema-properties-messagetype.md "https://alwaysai.co/app-state-schema.json#/properties/messageType") |
+| [appState](#appstate)       | `array`       | Required | cannot be null | [app\_state](app-state-schema-properties-appstate.md "https://alwaysai.co/app-state-schema.json#/properties/appState")       |
+
+## messageType
+
+
+
+`messageType`
+
+*   is required
+
+*   Type: unknown
+
+*   cannot be null
+
+*   defined in: [app\_state](app-state-schema-properties-messagetype.md "https://alwaysai.co/app-state-schema.json#/properties/messageType")
+
+### messageType Type
+
+unknown
+
+### messageType Constraints
+
+**constant**: the value of this property must be equal to:
+
+```json
+"app_state"
+```
+
+## appState
+
+
+
+`appState`
+
+*   is required
+
+*   Type: `object[]` ([Details](app-state-schema-properties-appstate-items.md))
+
+*   cannot be null
+
+*   defined in: [app\_state](app-state-schema-properties-appstate.md "https://alwaysai.co/app-state-schema.json#/properties/appState")
+
+### appState Type
+
+`object[]` ([Details](app-state-schema-properties-appstate-items.md))

package/docs/agent-message-schema-properties-payload-oneof-device_stats.md

@@ -0,0 +1,66 @@
+# device\_stats Schema
+
+```txt
+https://alwaysai.co/device-status-schema.json#/properties/payload/oneOf/0
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                             |
+| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | No           | Forbidden         | Forbidden             | none                | [agent-message-schema.json\*](../out/agent-message-schema.json "open original schema") |
+
+## 0 Type
+
+`object` ([device\_stats](agent-message-schema-properties-payload-oneof-device_stats.md))
+
+# 0 Properties
+
+| Property                    | Type          | Required | Nullable       | Defined by                                                                                                                              |
+| :-------------------------- | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------- |
+| [messageType](#messagetype) | Not specified | Required | cannot be null | [device\_stats](device-status-schema-properties-messagetype.md "https://alwaysai.co/device-status-schema.json#/properties/messageType") |
+| [deviceStats](#devicestats) | `object`      | Required | cannot be null | [device\_stats](device-status-schema-properties-devicestats.md "https://alwaysai.co/device-status-schema.json#/properties/deviceStats") |
+
+## messageType
+
+
+
+`messageType`
+
+*   is required
+
+*   Type: unknown
+
+*   cannot be null
+
+*   defined in: [device\_stats](device-status-schema-properties-messagetype.md "https://alwaysai.co/device-status-schema.json#/properties/messageType")
+
+### messageType Type
+
+unknown
+
+### messageType Constraints
+
+**constant**: the value of this property must be equal to:
+
+```json
+"device_stats"
+```
+
+## deviceStats
+
+
+
+`deviceStats`
+
+*   is required
+
+*   Type: `object` ([Details](device-status-schema-properties-devicestats.md))
+
+*   cannot be null
+
+*   defined in: [device\_stats](device-status-schema-properties-devicestats.md "https://alwaysai.co/device-status-schema.json#/properties/deviceStats")
+
+### deviceStats Type
+
+`object` ([Details](device-status-schema-properties-devicestats.md))

package/docs/agent-message-schema-properties-payload-oneof-signed_urls_request.md

@@ -0,0 +1,85 @@
+# signed\_urls\_request Schema
+
+```txt
+https://alwaysai.co/signed-urls-request-schema.json#/properties/payload/oneOf/4
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                             |
+| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | No           | Forbidden         | Forbidden             | none                | [agent-message-schema.json\*](../out/agent-message-schema.json "open original schema") |
+
+## 4 Type
+
+`object` ([signed\_urls\_request](agent-message-schema-properties-payload-oneof-signed_urls_request.md))
+
+# 4 Properties
+
+| Property                                        | Type          | Required | Nullable       | Defined by                                                                                                                                                                      |
+| :---------------------------------------------- | :------------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [messageType](#messagetype)                     | Not specified | Required | cannot be null | [signed\_urls\_request](signed-urls-request-schema-properties-messagetype.md "https://alwaysai.co/signed-urls-request-schema.json#/properties/messageType")                     |
+| [signedUrlsRequest](#signedurlsrequest)         | `object`      | Optional | cannot be null | [signed\_urls\_request](signed-urls-request-schema-properties-signedurlsrequest.md "https://alwaysai.co/signed-urls-request-schema.json#/properties/signedUrlsRequest")         |
+| [modelsOnlyUrlsRequest](#modelsonlyurlsrequest) | `object`      | Optional | cannot be null | [signed\_urls\_request](signed-urls-request-schema-properties-modelsonlyurlsrequest.md "https://alwaysai.co/signed-urls-request-schema.json#/properties/modelsOnlyUrlsRequest") |
+
+## messageType
+
+
+
+`messageType`
+
+*   is required
+
+*   Type: unknown
+
+*   cannot be null
+
+*   defined in: [signed\_urls\_request](signed-urls-request-schema-properties-messagetype.md "https://alwaysai.co/signed-urls-request-schema.json#/properties/messageType")
+
+### messageType Type
+
+unknown
+
+### messageType Constraints
+
+**constant**: the value of this property must be equal to:
+
+```json
+"signed_urls_request"
+```
+
+## signedUrlsRequest
+
+
+
+`signedUrlsRequest`
+
+*   is optional
+
+*   Type: `object` ([Details](signed-urls-request-schema-properties-signedurlsrequest.md))
+
+*   cannot be null
+
+*   defined in: [signed\_urls\_request](signed-urls-request-schema-properties-signedurlsrequest.md "https://alwaysai.co/signed-urls-request-schema.json#/properties/signedUrlsRequest")
+
+### signedUrlsRequest Type
+
+`object` ([Details](signed-urls-request-schema-properties-signedurlsrequest.md))
+
+## modelsOnlyUrlsRequest
+
+
+
+`modelsOnlyUrlsRequest`
+
+*   is optional
+
+*   Type: `object` ([Details](signed-urls-request-schema-properties-modelsonlyurlsrequest.md))
+
+*   cannot be null
+
+*   defined in: [signed\_urls\_request](signed-urls-request-schema-properties-modelsonlyurlsrequest.md "https://alwaysai.co/signed-urls-request-schema.json#/properties/modelsOnlyUrlsRequest")
+
+### modelsOnlyUrlsRequest Type
+
+`object` ([Details](signed-urls-request-schema-properties-modelsonlyurlsrequest.md))

package/docs/agent-message-schema-properties-payload.md

@@ -0,0 +1,27 @@
+# Untitled undefined type in agent\_message Schema
+
+```txt
+https://alwaysai.co/agent-message-schema.json#/properties/payload
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                             |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [agent-message-schema.json\*](../out/agent-message-schema.json "open original schema") |
+
+## payload Type
+
+merged type ([Details](agent-message-schema-properties-payload.md))
+
+one (and only one) of
+
+*   [device_stats](agent-message-schema-properties-payload-oneof-device_stats.md "check type definition")
+
+*   [app_state](agent-message-schema-properties-payload-oneof-app_state.md "check type definition")
+
+*   [app_logs](agent-message-schema-properties-payload-oneof-app_logs.md "check type definition")
+
+*   [app_install_status](agent-message-schema-properties-payload-oneof-app_install_status.md "check type definition")
+
+*   [signed_urls_request](agent-message-schema-properties-payload-oneof-signed_urls_request.md "check type definition")

package/docs/agent-message-schema-properties-timestamp.md

@@ -0,0 +1,15 @@
+# Untitled string in agent\_message Schema
+
+```txt
+https://alwaysai.co/agent-message-schema.json#/properties/timestamp
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                             |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [agent-message-schema.json\*](../out/agent-message-schema.json "open original schema") |
+
+## timestamp Type
+
+`string`