@alwaysai/device-agent-schemas 1.2.0 → 2.0.0

package/docs/app_install_schema.md

@@ -0,0 +1,105 @@
+# Untitled object in undefined 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") |
+
+## Untitled object in undefined Type
+
+`object` ([Details](app_install_schema.md))
+
+# Untitled object in undefined Properties
+
+| Property                          | Type     | Required | Nullable       | Defined by                                                                                                                                  |
+| :-------------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------ |
+| [baseCommand](#basecommand)       | `string` | Required | cannot be null | [Untitled schema](app_install_schema-properties-basecommand.md "https://alwaysai.co/app_install_schema.json#/properties/baseCommand")       |
+| [projectId](#projectid)           | `string` | Required | cannot be null | [Untitled schema](app_install_schema-properties-projectid.md "https://alwaysai.co/app_install_schema.json#/properties/projectId")           |
+| [appReleaseHash](#appreleasehash) | `string` | Required | cannot be null | [Untitled schema](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: [Untitled schema](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: [Untitled schema](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: [Untitled schema](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_state_control_schema-properties-appstatecontrol-properties-basecommand.md

@@ -0,0 +1,25 @@
+# Untitled string in undefined 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 undefined 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")

package/docs/app_state_control_schema-properties-appstatecontrol.md

@@ -0,0 +1,78 @@
+# Untitled object in undefined Schema
+
+```txt
+https://alwaysai.co/app_state_control_schema.json#/properties/appStateControl
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                                        |
+| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------------ |
+| Can be instantiated | No         | Unknown status | No           | Forbidden         | Forbidden             | none                | [app\_state\_control\_schema.json\*](../out/app_state_control_schema.json "open original schema") |
+
+## appStateControl Type
+
+`object` ([Details](app_state_control_schema-properties-appstatecontrol.md))
+
+# appStateControl Properties
+
+| Property                    | Type     | Required | Nullable       | Defined by                                                                                                                                                                                              |
+| :-------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [baseCommand](#basecommand) | `string` | Required | cannot be null | [Untitled schema](app_state_control_schema-properties-appstatecontrol-properties-basecommand.md "https://alwaysai.co/app_state_control_schema.json#/properties/appStateControl/properties/baseCommand") |
+| [projectId](#projectid)     | `string` | Required | cannot be null | [Untitled schema](app_state_control_schema-properties-appstatecontrol-properties-projectid.md "https://alwaysai.co/app_state_control_schema.json#/properties/appStateControl/properties/projectId")     |
+
+## baseCommand
+
+
+
+`baseCommand`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [Untitled schema](app_state_control_schema-properties-appstatecontrol-properties-basecommand.md "https://alwaysai.co/app_state_control_schema.json#/properties/appStateControl/properties/baseCommand")
+
+### 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"` |             |
+
+## projectId
+
+The specific project associated with the message payload.
+
+`projectId`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [Untitled schema](app_state_control_schema-properties-appstatecontrol-properties-projectid.md "https://alwaysai.co/app_state_control_schema.json#/properties/appStateControl/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")

package/docs/app_state_control_schema-properties-messagetype.md

@@ -0,0 +1,23 @@
+# Untitled schema Schema
+
+```txt
+https://alwaysai.co/app_state_control_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\_state\_control\_schema.json\*](../out/app_state_control_schema.json "open original schema") |
+
+## messageType Type
+
+unknown
+
+## messageType Constraints
+
+**constant**: the value of this property must be equal to:
+
+```json
+"app_state_control"
+```

package/docs/app_state_control_schema.md

@@ -0,0 +1,66 @@
+# Untitled object in undefined Schema
+
+```txt
+https://alwaysai.co/app_state_control_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\_state\_control\_schema.json](../out/app_state_control_schema.json "open original schema") |
+
+## Untitled object in undefined Type
+
+`object` ([Details](app_state_control_schema.md))
+
+# Untitled object in undefined Properties
+
+| Property                            | Type          | Required | Nullable       | Defined by                                                                                                                                                |
+| :---------------------------------- | :------------ | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [messageType](#messagetype)         | Not specified | Required | cannot be null | [Untitled schema](app_state_control_schema-properties-messagetype.md "https://alwaysai.co/app_state_control_schema.json#/properties/messageType")         |
+| [appStateControl](#appstatecontrol) | `object`      | Required | cannot be null | [Untitled schema](app_state_control_schema-properties-appstatecontrol.md "https://alwaysai.co/app_state_control_schema.json#/properties/appStateControl") |
+
+## messageType
+
+
+
+`messageType`
+
+*   is required
+
+*   Type: unknown
+
+*   cannot be null
+
+*   defined in: [Untitled schema](app_state_control_schema-properties-messagetype.md "https://alwaysai.co/app_state_control_schema.json#/properties/messageType")
+
+### messageType Type
+
+unknown
+
+### messageType Constraints
+
+**constant**: the value of this property must be equal to:
+
+```json
+"app_state_control"
+```
+
+## appStateControl
+
+
+
+`appStateControl`
+
+*   is required
+
+*   Type: `object` ([Details](app_state_control_schema-properties-appstatecontrol.md))
+
+*   cannot be null
+
+*   defined in: [Untitled schema](app_state_control_schema-properties-appstatecontrol.md "https://alwaysai.co/app_state_control_schema.json#/properties/appStateControl")
+
+### appStateControl Type
+
+`object` ([Details](app_state_control_schema-properties-appstatecontrol.md))

package/docs/app_uninstall_schema-properties-basecommand.md

@@ -0,0 +1,23 @@
+# Untitled string in undefined Schema
+
+```txt
+https://alwaysai.co/app_uninstall_schema.json#/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\_uninstall\_schema.json\*](../out/app_uninstall_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 |
+| :------------ | :---------- |
+| `"uninstall"` |             |

package/docs/app_uninstall_schema-properties-projectid.md

@@ -0,0 +1,25 @@
+# Untitled string in undefined Schema
+
+```txt
+https://alwaysai.co/app_uninstall_schema.json#/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\_uninstall\_schema.json\*](../out/app_uninstall_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_uninstall_schema.md

@@ -0,0 +1,76 @@
+# Untitled object in undefined Schema
+
+```txt
+https://alwaysai.co/app_uninstall_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\_uninstall\_schema.json](../out/app_uninstall_schema.json "open original schema") |
+
+## Untitled object in undefined Type
+
+`object` ([Details](app_uninstall_schema.md))
+
+# Untitled object in undefined Properties
+
+| Property                    | Type     | Required | Nullable       | Defined by                                                                                                                                |
+| :-------------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------- |
+| [baseCommand](#basecommand) | `string` | Required | cannot be null | [Untitled schema](app_uninstall_schema-properties-basecommand.md "https://alwaysai.co/app_uninstall_schema.json#/properties/baseCommand") |
+| [projectId](#projectid)     | `string` | Required | cannot be null | [Untitled schema](app_uninstall_schema-properties-projectid.md "https://alwaysai.co/app_uninstall_schema.json#/properties/projectId")     |
+
+## baseCommand
+
+
+
+`baseCommand`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [Untitled schema](app_uninstall_schema-properties-basecommand.md "https://alwaysai.co/app_uninstall_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 |
+| :------------ | :---------- |
+| `"uninstall"` |             |
+
+## projectId
+
+The specific project associated with the message payload.
+
+`projectId`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [Untitled schema](app_uninstall_schema-properties-projectid.md "https://alwaysai.co/app_uninstall_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")

package/docs/app_version_control_schema-properties-appversioncontrol.md

@@ -0,0 +1,21 @@
+# Untitled schema Schema
+
+```txt
+https://alwaysai.co/app_version_control_schema.json#/properties/appVersionControl
+```
+
+
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                                            |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [app\_version\_control\_schema.json\*](../out/app_version_control_schema.json "open original schema") |
+
+## appVersionControl Type
+
+merged type ([Details](app_version_control_schema-properties-appversioncontrol.md))
+
+one (and only one) of
+
+*   [Untitled object in undefined](app_version_control_schema-properties-appversioncontrol-oneof-0.md "check type definition")
+
+*   [Untitled object in undefined](app_version_control_schema-properties-appversioncontrol-oneof-1.md "check type definition")

package/docs/app_version_control_schema-properties-messagetype.md

@@ -0,0 +1,23 @@
+# Untitled string in undefined Schema
+
+```txt
+https://alwaysai.co/app_version_control_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\_version\_control\_schema.json\*](../out/app_version_control_schema.json "open original schema") |
+
+## messageType Type
+
+`string`
+
+## messageType Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value                   | Explanation |
+| :---------------------- | :---------- |
+| `"app_version_control"` |             |

package/docs/app_version_control_schema.md

@@ -0,0 +1,72 @@
+# Untitled object in undefined Schema
+
+```txt
+https://alwaysai.co/app_version_control_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\_version\_control\_schema.json](../out/app_version_control_schema.json "open original schema") |
+
+## Untitled object in undefined Type
+
+`object` ([Details](app_version_control_schema.md))
+
+# Untitled object in undefined Properties
+
+| Property                                | Type     | Required | Nullable       | Defined by                                                                                                                                                        |
+| :-------------------------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [messageType](#messagetype)             | `string` | Required | cannot be null | [Untitled schema](app_version_control_schema-properties-messagetype.md "https://alwaysai.co/app_version_control_schema.json#/properties/messageType")             |
+| [appVersionControl](#appversioncontrol) | Merged   | Required | cannot be null | [Untitled schema](app_version_control_schema-properties-appversioncontrol.md "https://alwaysai.co/app_version_control_schema.json#/properties/appVersionControl") |
+
+## messageType
+
+
+
+`messageType`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [Untitled schema](app_version_control_schema-properties-messagetype.md "https://alwaysai.co/app_version_control_schema.json#/properties/messageType")
+
+### messageType Type
+
+`string`
+
+### messageType Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value                   | Explanation |
+| :---------------------- | :---------- |
+| `"app_version_control"` |             |
+
+## appVersionControl
+
+
+
+`appVersionControl`
+
+*   is required
+
+*   Type: merged type ([Details](app_version_control_schema-properties-appversioncontrol.md))
+
+*   cannot be null
+
+*   defined in: [Untitled schema](app_version_control_schema-properties-appversioncontrol.md "https://alwaysai.co/app_version_control_schema.json#/properties/appVersionControl")
+
+### appVersionControl Type
+
+merged type ([Details](app_version_control_schema-properties-appversioncontrol.md))
+
+one (and only one) of
+
+*   [Untitled object in undefined](app_version_control_schema-properties-appversioncontrol-oneof-0.md "check type definition")
+
+*   [Untitled object in undefined](app_version_control_schema-properties-appversioncontrol-oneof-1.md "check type definition")

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

@@ -0,0 +1,25 @@
+# Untitled string in client\_message Schema
+
+```txt
+https://alwaysai.co/client-message-schema.json#/$defs/message
+```
+
+Topic on which messages are sent to device agent.
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                               |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :--------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [client-message-schema.json\*](../out/client-message-schema.json "open original schema") |
+
+## message Type
+
+`string`
+
+## message Constraints
+
+**pattern**: the string must match the following regular expression: 
+
+```regexp
+^to-device/aai-device/([0-9a-z]+-+)+([0-9a-z])+
+```
+
+[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")

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

@@ -0,0 +1,15 @@
+# Untitled undefined type in client\_message Schema
+
+```txt
+https://alwaysai.co/client-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                | [client-message-schema.json\*](../out/client-message-schema.json "open original schema") |
+
+## $defs Type
+
+unknown