npm - @alwaysai/device-agent-schemas - Versions diffs - 2.3.2 → 2.3.4 - Mend

@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.

Files changed (419) hide show

package/docs/to-client-message-schema.md DELETED Viewed

@@ -1,196 +0,0 @@
-# to\_client\_message Schema
-```txt
-https://alwaysai.co/to-client-message-schema.json
-```
-The messaging payload structure for messages sent from device agent to clients
-| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                                   |
-| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------- |
-| Can be instantiated | No         | Unknown status | No           | Forbidden         | Forbidden             | none                | [to-client-message-schema.json](../out/to-client-message-schema.json "open original schema") |
-## to\_client\_message Type
-`object` ([to\_client\_message](to-client-message-schema.md))
-all of
-*   [Untitled undefined type in to_client_message](to-client-message-schema-allof-0.md "check type definition")
-*   [Untitled undefined type in to_client_message](to-client-message-schema-allof-1.md "check type definition")
-*   [Untitled undefined type in to_client_message](to-client-message-schema-allof-2.md "check type definition")
-*   [Untitled undefined type in to_client_message](to-client-message-schema-allof-3.md "check type definition")
-# to\_client\_message Properties
-| Property                    | Type     | Required | Nullable       | Defined by                                                                                                                                            |
-| :-------------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [timestamp](#timestamp)     | `string` | Required | cannot be null | [to\_client\_message](to-client-message-schema-properties-timestamp.md "https://alwaysai.co/to-client-message-schema.json#/properties/timestamp")     |
-| [deviceId](#deviceid)       | `string` | Required | cannot be null | [to\_client\_message](to-client-message-schema-properties-deviceid.md "https://alwaysai.co/to-client-message-schema.json#/properties/deviceId")       |
-| [topic](#topic)             | Merged   | Optional | cannot be null | [to\_client\_message](to-client-message-schema-properties-topic.md "https://alwaysai.co/to-client-message-schema.json#/properties/topic")             |
-| [messageType](#messagetype) | `string` | Required | cannot be null | [to\_client\_message](to-client-message-schema-properties-messagetype.md "https://alwaysai.co/to-client-message-schema.json#/properties/messageType") |
-| [txId](#txid)               | `string` | Required | cannot be null | [to\_client\_message](common-schema-defs-txid.md "https://alwaysai.co/to-client-message-schema.json#/properties/txId")                                |
-| [payload](#payload)         | Merged   | Required | cannot be null | [to\_client\_message](to-client-message-schema-properties-payload.md "https://alwaysai.co/to-client-message-schema.json#/properties/payload")         |
-## timestamp
-`timestamp`
-*   is required
-*   Type: `string`
-*   cannot be null
-*   defined in: [to\_client\_message](to-client-message-schema-properties-timestamp.md "https://alwaysai.co/to-client-message-schema.json#/properties/timestamp")
-### timestamp Type
-`string`
-## deviceId
-Device UUID of device sending the message
-`deviceId`
-*   is required
-*   Type: `string`
-*   cannot be null
-*   defined in: [to\_client\_message](to-client-message-schema-properties-deviceid.md "https://alwaysai.co/to-client-message-schema.json#/properties/deviceId")
-### deviceId Type
-`string`
-## topic
-`topic`
-*   is optional
-*   Type: merged type ([Details](to-client-message-schema-properties-topic.md))
-*   cannot be null
-*   defined in: [to\_client\_message](to-client-message-schema-properties-topic.md "https://alwaysai.co/to-client-message-schema.json#/properties/topic")
-### topic Type
-merged type ([Details](to-client-message-schema-properties-topic.md))
-one (and only one) of
-*   [Untitled string in to_client_message](to-client-message-schema-properties-topic-oneof-0.md "check type definition")
-## messageType
-`messageType`
-*   is required
-*   Type: `string`
-*   cannot be null
-*   defined in: [to\_client\_message](to-client-message-schema-properties-messagetype.md "https://alwaysai.co/to-client-message-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 |
-| :------------------ | :---------- |
-| `"device_stats"`    |             |
-| `"app_state"`       |             |
-| `"status_response"` |             |
-| `"app_logs"`        |             |
-## txId
-`txId`
-*   is required
-*   Type: `string`
-*   cannot be null
-*   defined in: [to\_client\_message](common-schema-defs-txid.md "https://alwaysai.co/to-client-message-schema.json#/properties/txId")
-### txId Type
-`string`
-### txId Constraints
-**maximum length**: the maximum number of characters for this string is: `36`
-**minimum length**: the minimum number of characters for this string is: `36`
-**pattern**: the string must match the following regular expression:&#x20;
-```regexp
-^[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}$
-```
-[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")
-## payload
-`payload`
-*   is required
-*   Type: merged type ([Details](to-client-message-schema-properties-payload.md))
-*   cannot be null
-*   defined in: [to\_client\_message](to-client-message-schema-properties-payload.md "https://alwaysai.co/to-client-message-schema.json#/properties/payload")
-### payload Type
-merged type ([Details](to-client-message-schema-properties-payload.md))
-one (and only one) of
-*   [device_stats](to-client-message-schema-properties-payload-oneof-device_stats.md "check type definition")
-*   [app_state](to-client-message-schema-properties-payload-oneof-app_state.md "check type definition")
-*   [app_logs](to-client-message-schema-properties-payload-oneof-app_logs.md "check type definition")
-*   [status_response](to-client-message-schema-properties-payload-oneof-status_response.md "check type definition")
-# to\_client\_message Definitions
-## Definitions group toClient
-Reference this group by using
-```json
-{"$ref":"https://alwaysai.co/to-client-message-schema.json#/$defs/toClient"}
-```
-| Property | Type | Required | Nullable | Defined by |
-| :------- | :--- | :------- | :------- | :--------- |

package/docs/to-cloud-message-schema-allof-0-if-properties-messagetype.md DELETED Viewed

@@ -1,23 +0,0 @@
-# Untitled undefined type in cloud\_message Schema
-```txt
-https://alwaysai.co/cloud-message-schema.json#/allOf/0/if/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                | [to-cloud-message-schema.json\*](../out/to-cloud-message-schema.json "open original schema") |
-## messageType Type
-unknown
-## messageType Constraints
-**constant**: the value of this property must be equal to:
-```json
-"signed_urls_request"
-```

package/docs/to-cloud-message-schema-allof-0-if-properties.md DELETED Viewed

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

package/docs/to-cloud-message-schema-allof-0-if.md DELETED Viewed

@@ -1,47 +0,0 @@
-# Untitled undefined type in cloud\_message Schema
-```txt
-https://alwaysai.co/cloud-message-schema.json#/allOf/0/if
-```
-| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                                   |
-| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------- |
-| Can be instantiated | No         | Unknown status | No           | Forbidden         | Allowed               | none                | [to-cloud-message-schema.json\*](../out/to-cloud-message-schema.json "open original schema") |
-## if Type
-unknown
-# if Properties
-| Property                    | Type          | Required | Nullable       | Defined by                                                                                                                                                        |
-| :-------------------------- | :------------ | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [messageType](#messagetype) | Not specified | Optional | cannot be null | [cloud\_message](to-cloud-message-schema-allof-0-if-properties-messagetype.md "https://alwaysai.co/cloud-message-schema.json#/allOf/0/if/properties/messageType") |
-## messageType
-`messageType`
-*   is optional
-*   Type: unknown
-*   cannot be null
-*   defined in: [cloud\_message](to-cloud-message-schema-allof-0-if-properties-messagetype.md "https://alwaysai.co/cloud-message-schema.json#/allOf/0/if/properties/messageType")
-### messageType Type
-unknown
-### messageType Constraints
-**constant**: the value of this property must be equal to:
-```json
-"signed_urls_request"
-```

package/docs/to-cloud-message-schema-allof-0-then-properties.md DELETED Viewed

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

package/docs/to-cloud-message-schema-allof-0-then.md DELETED Viewed

@@ -1,39 +0,0 @@
-# Untitled undefined type in cloud\_message Schema
-```txt
-https://alwaysai.co/cloud-message-schema.json#/allOf/0/then
-```
-| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                                   |
-| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------- |
-| Can be instantiated | No         | Unknown status | No           | Forbidden         | Allowed               | none                | [to-cloud-message-schema.json\*](../out/to-cloud-message-schema.json "open original schema") |
-## then Type
-unknown
-# then Properties
-| Property            | Type     | Required | Nullable       | Defined by                                                                                                                                                                       |
-| :------------------ | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [payload](#payload) | `object` | Optional | cannot be null | [cloud\_message](to-cloud-message-schema-properties-payload-oneof-signed_urls_request.md "https://alwaysai.co/signed-urls-request-schema.json#/allOf/0/then/properties/payload") |
-## payload
-`payload`
-*   is optional
-*   Type: `object` ([signed\_urls\_request](to-cloud-message-schema-properties-payload-oneof-signed_urls_request.md))
-*   cannot be null
-*   defined in: [cloud\_message](to-cloud-message-schema-properties-payload-oneof-signed_urls_request.md "https://alwaysai.co/signed-urls-request-schema.json#/allOf/0/then/properties/payload")
-### payload Type
-`object` ([signed\_urls\_request](to-cloud-message-schema-properties-payload-oneof-signed_urls_request.md))

package/docs/to-cloud-message-schema-allof-0.md DELETED Viewed

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

package/docs/to-cloud-message-schema-defs-tocloud.md DELETED Viewed

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

package/docs/to-cloud-message-schema-defs.md DELETED Viewed

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

package/docs/to-cloud-message-schema-properties-deviceid.md DELETED Viewed

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

package/docs/to-cloud-message-schema-properties-messagetype.md DELETED Viewed

@@ -1,23 +0,0 @@
-# Untitled string in cloud\_message Schema
-```txt
-https://alwaysai.co/cloud-message-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                | [to-cloud-message-schema.json\*](../out/to-cloud-message-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 |
-| :---------------------- | :---------- |
-| `"signed_urls_request"` |             |

package/docs/to-cloud-message-schema-properties-payload.md DELETED Viewed

@@ -1,19 +0,0 @@
-# Untitled undefined type in cloud\_message Schema
-```txt
-https://alwaysai.co/cloud-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                | [to-cloud-message-schema.json\*](../out/to-cloud-message-schema.json "open original schema") |
-## payload Type
-merged type ([Details](to-cloud-message-schema-properties-payload.md))
-one (and only one) of
-*   [signed_urls_request](to-cloud-message-schema-properties-payload-oneof-signed_urls_request.md "check type definition")

package/docs/to-cloud-message-schema-properties-timestamp.md DELETED Viewed

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

package/docs/to-cloud-message-schema-properties-topic-oneof-0.md DELETED Viewed

@@ -1,25 +0,0 @@
-# Untitled string in cloud\_message Schema
-```txt
-https://alwaysai.co/cloud-message-schema.json#/properties/topic/oneOf/0
-```
-Messages sent from the device agent to cloud backend client
-| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                                   |
-| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------------- |
-| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [to-cloud-message-schema.json\*](../out/to-cloud-message-schema.json "open original schema") |
-## 0 Type
-`string`
-## 0 Constraints
-**pattern**: the string must match the following regular expression:&#x20;
-```regexp
-to-cloud/aai-device/[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}$
-```
-[try pattern](https://regexr.com/?expression=to-cloud%2Faai-device%2F%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")

package/docs/to-cloud-message-schema-properties-topic.md DELETED Viewed

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