@alwaysai/device-agent-schemas 1.2.0 → 2.0.0

package/docs/app-install-schema.md

@@ -0,0 +1,105 @@
+# app\_install Schema
+
+```txt
+https://alwaysai.co/app-install-schema.json
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                       |
+| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | No           | Forbidden         | Forbidden             | none                | [app-install-schema.json](../out/app-install-schema.json "open original schema") |
+
+## app\_install Type
+
+`object` ([app\_install](app-install-schema.md))
+
+# app\_install Properties
+
+| Property                          | Type     | Required | Nullable       | Defined by                                                                                                                               |
+| :-------------------------------- | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------- |
+| [baseCommand](#basecommand)       | `string` | Required | cannot be null | [app\_install](app-install-schema-properties-basecommand.md "https://alwaysai.co/app-install-schema.json#/properties/baseCommand")       |
+| [projectId](#projectid)           | `string` | Required | cannot be null | [app\_install](app-install-schema-properties-projectid.md "https://alwaysai.co/app-install-schema.json#/properties/projectId")           |
+| [appReleaseHash](#appreleasehash) | `string` | Required | cannot be null | [app\_install](app-install-schema-properties-appreleasehash.md "https://alwaysai.co/app-install-schema.json#/properties/appReleaseHash") |
+
+## baseCommand
+
+
+
+`baseCommand`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [app\_install](app-install-schema-properties-basecommand.md "https://alwaysai.co/app-install-schema.json#/properties/baseCommand")
+
+### baseCommand Type
+
+`string`
+
+### baseCommand Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value       | Explanation |
+| :---------- | :---------- |
+| `"install"` |             |
+
+## projectId
+
+The specific project associated with the message payload.
+
+`projectId`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [app\_install](app-install-schema-properties-projectid.md "https://alwaysai.co/app-install-schema.json#/properties/projectId")
+
+### projectId Type
+
+`string`
+
+### projectId Constraints
+
+**pattern**: the string must match the following regular expression: 
+
+```regexp
+([0-9a-z]+-+)+([0-9a-z])+
+```
+
+[try pattern](https://regexr.com/?expression=\(%5B0-9a-z%5D%2B-%2B\)%2B\(%5B0-9a-z%5D\)%2B "try regular expression with regexr.com")
+
+## appReleaseHash
+
+The version of the project associated with the message payload.
+
+`appReleaseHash`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [app\_install](app-install-schema-properties-appreleasehash.md "https://alwaysai.co/app-install-schema.json#/properties/appReleaseHash")
+
+### appReleaseHash Type
+
+`string`
+
+### appReleaseHash Constraints
+
+**pattern**: the string must match the following regular expression: 
+
+```regexp
+[0-9a-z]{64}
+```
+
+[try pattern](https://regexr.com/?expression=%5B0-9a-z%5D%7B64%7D "try regular expression with regexr.com")

package/docs/app-install-status-schema-properties-appinstallstatus-properties-appreleasehash.md

@@ -0,0 +1,25 @@
+# Untitled string in app\_install\_status Schema
+
+```txt
+https://alwaysai.co/app-install-status-schema.json#/properties/appInstallStatus/properties/appReleaseHash
+```
+
+The version of the project associated with the message payload.
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                                       |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [app-install-status-schema.json\*](../out/app-install-status-schema.json "open original schema") |
+
+## appReleaseHash Type
+
+`string`
+
+## appReleaseHash Constraints
+
+**pattern**: the string must match the following regular expression: 
+
+```regexp
+[0-9a-z]{64}
+```
+
+[try pattern](https://regexr.com/?expression=%5B0-9a-z%5D%7B64%7D "try regular expression with regexr.com")

package/docs/app-install-status-schema-properties-appinstallstatus-properties-message.md

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

package/docs/app-install-status-schema-properties-appinstallstatus-properties-status.md

@@ -0,0 +1,26 @@
+# Untitled undefined type in app\_install\_status Schema
+
+```txt
+https://alwaysai.co/app-install-status-schema.json#/properties/appInstallStatus/properties/status
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                                       |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [app-install-status-schema.json\*](../out/app-install-status-schema.json "open original schema") |
+
+## status Type
+
+unknown
+
+## status Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value           | Explanation |
+| :-------------- | :---------- |
+| `"requested"`   |             |
+| `"in_progress"` |             |
+| `"failure"`     |             |
+| `"success"`     |             |

package/docs/app-install-status-schema-properties-appinstallstatus.md

@@ -0,0 +1,98 @@
+# Untitled object in app\_install\_status Schema
+
+```txt
+https://alwaysai.co/app-install-status-schema.json#/properties/appInstallStatus
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                                       |
+| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | No           | Forbidden         | Forbidden             | none                | [app-install-status-schema.json\*](../out/app-install-status-schema.json "open original schema") |
+
+## appInstallStatus Type
+
+`object` ([Details](app-install-status-schema-properties-appinstallstatus.md))
+
+# appInstallStatus Properties
+
+| Property                          | Type          | Required | Nullable       | Defined by                                                                                                                                                                                                             |
+| :-------------------------------- | :------------ | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [status](#status)                 | Not specified | Required | cannot be null | [app\_install\_status](app-install-status-schema-properties-appinstallstatus-properties-status.md "https://alwaysai.co/app-install-status-schema.json#/properties/appInstallStatus/properties/status")                 |
+| [message](#message)               | `string`      | Optional | cannot be null | [app\_install\_status](app-install-status-schema-properties-appinstallstatus-properties-message.md "https://alwaysai.co/app-install-status-schema.json#/properties/appInstallStatus/properties/message")               |
+| [appReleaseHash](#appreleasehash) | `string`      | Required | cannot be null | [app\_install\_status](app-install-status-schema-properties-appinstallstatus-properties-appreleasehash.md "https://alwaysai.co/app-install-status-schema.json#/properties/appInstallStatus/properties/appReleaseHash") |
+
+## status
+
+
+
+`status`
+
+*   is required
+
+*   Type: unknown
+
+*   cannot be null
+
+*   defined in: [app\_install\_status](app-install-status-schema-properties-appinstallstatus-properties-status.md "https://alwaysai.co/app-install-status-schema.json#/properties/appInstallStatus/properties/status")
+
+### status Type
+
+unknown
+
+### status Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value           | Explanation |
+| :-------------- | :---------- |
+| `"requested"`   |             |
+| `"in_progress"` |             |
+| `"failure"`     |             |
+| `"success"`     |             |
+
+## message
+
+
+
+`message`
+
+*   is optional
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [app\_install\_status](app-install-status-schema-properties-appinstallstatus-properties-message.md "https://alwaysai.co/app-install-status-schema.json#/properties/appInstallStatus/properties/message")
+
+### message Type
+
+`string`
+
+## appReleaseHash
+
+The version of the project associated with the message payload.
+
+`appReleaseHash`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [app\_install\_status](app-install-status-schema-properties-appinstallstatus-properties-appreleasehash.md "https://alwaysai.co/app-install-status-schema.json#/properties/appInstallStatus/properties/appReleaseHash")
+
+### appReleaseHash Type
+
+`string`
+
+### appReleaseHash Constraints
+
+**pattern**: the string must match the following regular expression: 
+
+```regexp
+[0-9a-z]{64}
+```
+
+[try pattern](https://regexr.com/?expression=%5B0-9a-z%5D%7B64%7D "try regular expression with regexr.com")

package/docs/app-install-status-schema-properties-messagetype.md

@@ -0,0 +1,23 @@
+# Untitled undefined type in app\_install\_status Schema
+
+```txt
+https://alwaysai.co/app-install-status-schema.json#/properties/messageType
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                                       |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :----------------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [app-install-status-schema.json\*](../out/app-install-status-schema.json "open original schema") |
+
+## messageType Type
+
+unknown
+
+## messageType Constraints
+
+**constant**: the value of this property must be equal to:
+
+```json
+"app_install_status"
+```

package/docs/app-install-status-schema.md

@@ -0,0 +1,66 @@
+# app\_install\_status Schema
+
+```txt
+https://alwaysai.co/app-install-status-schema.json
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                                     |
+| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | No           | Forbidden         | Forbidden             | none                | [app-install-status-schema.json](../out/app-install-status-schema.json "open original schema") |
+
+## app\_install\_status Type
+
+`object` ([app\_install\_status](app-install-status-schema.md))
+
+# app\_install\_status 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/app-logs-schema-properties-applogs-properties-logchunk.md

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

package/docs/app-logs-schema-properties-applogs-properties-projectid.md

@@ -0,0 +1,25 @@
+# Untitled string in app\_logs Schema
+
+```txt
+https://alwaysai.co/app-logs-schema.json#/properties/appLogs/properties/projectId
+```
+
+The specific project associated with the message payload.
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                   |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [app-logs-schema.json\*](../out/app-logs-schema.json "open original schema") |
+
+## projectId Type
+
+`string`
+
+## projectId Constraints
+
+**pattern**: the string must match the following regular expression: 
+
+```regexp
+([0-9a-z]+-+)+([0-9a-z])+
+```
+
+[try pattern](https://regexr.com/?expression=\(%5B0-9a-z%5D%2B-%2B\)%2B\(%5B0-9a-z%5D\)%2B "try regular expression with regexr.com")

package/docs/app-logs-schema-properties-applogs.md

@@ -0,0 +1,68 @@
+# Untitled object in app\_logs Schema
+
+```txt
+https://alwaysai.co/app-logs-schema.json#/properties/appLogs
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                   |
+| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | No           | Forbidden         | Forbidden             | none                | [app-logs-schema.json\*](../out/app-logs-schema.json "open original schema") |
+
+## appLogs Type
+
+`object` ([Details](app-logs-schema-properties-applogs.md))
+
+# appLogs Properties
+
+| Property                | Type     | Required | Nullable       | Defined by                                                                                                                                                  |
+| :---------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [projectId](#projectid) | `string` | Required | cannot be null | [app\_logs](app-logs-schema-properties-applogs-properties-projectid.md "https://alwaysai.co/app-logs-schema.json#/properties/appLogs/properties/projectId") |
+| [logChunk](#logchunk)   | `string` | Required | cannot be null | [app\_logs](app-logs-schema-properties-applogs-properties-logchunk.md "https://alwaysai.co/app-logs-schema.json#/properties/appLogs/properties/logChunk")   |
+
+## projectId
+
+The specific project associated with the message payload.
+
+`projectId`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [app\_logs](app-logs-schema-properties-applogs-properties-projectid.md "https://alwaysai.co/app-logs-schema.json#/properties/appLogs/properties/projectId")
+
+### projectId Type
+
+`string`
+
+### projectId Constraints
+
+**pattern**: the string must match the following regular expression: 
+
+```regexp
+([0-9a-z]+-+)+([0-9a-z])+
+```
+
+[try pattern](https://regexr.com/?expression=\(%5B0-9a-z%5D%2B-%2B\)%2B\(%5B0-9a-z%5D\)%2B "try regular expression with regexr.com")
+
+## logChunk
+
+
+
+`logChunk`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [app\_logs](app-logs-schema-properties-applogs-properties-logchunk.md "https://alwaysai.co/app-logs-schema.json#/properties/appLogs/properties/logChunk")
+
+### logChunk Type
+
+`string`

package/docs/app-logs-schema-properties-messagetype.md

@@ -0,0 +1,23 @@
+# Untitled undefined type in app\_logs Schema
+
+```txt
+https://alwaysai.co/app-logs-schema.json#/properties/messageType
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                   |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [app-logs-schema.json\*](../out/app-logs-schema.json "open original schema") |
+
+## messageType Type
+
+unknown
+
+## messageType Constraints
+
+**constant**: the value of this property must be equal to:
+
+```json
+"app_logs"
+```

package/docs/app-logs-schema.md

@@ -0,0 +1,66 @@
+# app\_logs Schema
+
+```txt
+https://alwaysai.co/app-logs-schema.json
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                 |
+| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | No           | Forbidden         | Forbidden             | none                | [app-logs-schema.json](../out/app-logs-schema.json "open original schema") |
+
+## app\_logs Type
+
+`object` ([app\_logs](app-logs-schema.md))
+
+# app\_logs 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/app-state-control-schema-properties-appstatecontrol-properties-basecommand.md

@@ -0,0 +1,25 @@
+# Untitled string in app\_state\_control Schema
+
+```txt
+https://alwaysai.co/app-state-control-schema.json#/properties/appStateControl/properties/baseCommand
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                                     |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [app-state-control-schema.json\*](../out/app-state-control-schema.json "open original schema") |
+
+## baseCommand Type
+
+`string`
+
+## baseCommand Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value       | Explanation |
+| :---------- | :---------- |
+| `"start"`   |             |
+| `"stop"`    |             |
+| `"restart"` |             |

package/docs/app-state-control-schema-properties-appstatecontrol-properties-projectid.md

@@ -0,0 +1,25 @@
+# Untitled string in app\_state\_control Schema
+
+```txt
+https://alwaysai.co/app-state-control-schema.json#/properties/appStateControl/properties/projectId
+```
+
+The specific project associated with the message payload.
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                                     |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [app-state-control-schema.json\*](../out/app-state-control-schema.json "open original schema") |
+
+## projectId Type
+
+`string`
+
+## projectId Constraints
+
+**pattern**: the string must match the following regular expression: 
+
+```regexp
+([0-9a-z]+-+)+([0-9a-z])+
+```
+
+[try pattern](https://regexr.com/?expression=\(%5B0-9a-z%5D%2B-%2B\)%2B\(%5B0-9a-z%5D\)%2B "try regular expression with regexr.com")