mhome-core-api 1.10.0

Shared wire types and service contracts for the mHome core
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "urn:mhome:core-api:messaging:normalized-inbound:v4",
  "title": "mHome normalized messaging inbound v4",
  "type": "object",
  "additionalProperties": false,
  "required": ["schemaVersion", "eventId", "address", "actor", "content"],
  "properties": {
    "schemaVersion": { "const": 4 },
    "eventId": { "$ref": "#/$defs/id" },
    "address": { "$ref": "#/$defs/address" },
    "actor": { "$ref": "#/$defs/actor" },
    "content": { "$ref": "#/$defs/content" },
    "conversationDisplayName": { "$ref": "#/$defs/id" },
    "occurredAtMs": { "type": "integer", "minimum": 0 }
  },
  "$defs": {
    "id": { "type": "string", "minLength": 1, "pattern": "^\\S(?:.*\\S)?$" },
    "text": { "type": "string", "minLength": 1 },
    "providerId": { "type": "string", "pattern": "^[a-z][a-z0-9_]*$" },
    "address": {
      "type": "object",
      "additionalProperties": false,
      "required": ["provider", "accountId", "conversationId", "audience"],
      "properties": {
        "provider": { "$ref": "#/$defs/providerId" },
        "accountId": { "$ref": "#/$defs/id" },
        "conversationId": { "$ref": "#/$defs/id" },
        "laneId": { "$ref": "#/$defs/id" },
        "audience": { "enum": ["personal", "shared"] }
      }
    },
    "actor": {
      "type": "object",
      "additionalProperties": false,
      "required": ["provider", "accountId", "externalUserId"],
      "properties": {
        "provider": { "$ref": "#/$defs/providerId" },
        "accountId": { "$ref": "#/$defs/id" },
        "externalUserId": { "$ref": "#/$defs/id" },
        "displayName": { "$ref": "#/$defs/id" }
      }
    },
    "media": {
      "type": "object",
      "additionalProperties": false,
      "required": ["handle", "kind"],
      "properties": {
        "handle": { "$ref": "#/$defs/id" },
        "kind": { "enum": ["image", "audio", "video", "file"] },
        "mimeType": { "$ref": "#/$defs/id" },
        "sizeBytes": { "type": "integer", "minimum": 1 },
        "fileName": { "$ref": "#/$defs/id" },
        "durationMs": { "type": "integer", "minimum": 1 },
        "widthPx": { "type": "integer", "minimum": 1 },
        "heightPx": { "type": "integer", "minimum": 1 },
        "caption": { "$ref": "#/$defs/id" },
        "transcript": { "$ref": "#/$defs/id" }
      },
      "dependentRequired": {
        "widthPx": ["heightPx"],
        "heightPx": ["widthPx"]
      }
    },
    "part": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": false,
          "required": ["type", "text"],
          "properties": {
            "type": { "const": "text" },
            "text": { "$ref": "#/$defs/text" }
          }
        },
        {
          "type": "object",
          "additionalProperties": false,
          "required": ["type", "reference"],
          "properties": {
            "type": { "const": "media" },
            "reference": { "$ref": "#/$defs/media" }
          }
        }
      ]
    },
    "content": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": false,
          "required": ["type", "attention", "parts"],
          "properties": {
            "type": { "const": "message" },
            "providerMessageId": { "$ref": "#/$defs/id" },
            "attention": { "enum": ["addressed", "unaddressed", "unknown"] },
            "parts": {
              "type": "array",
              "minItems": 1,
              "maxItems": 16,
              "items": { "$ref": "#/$defs/part" }
            }
          }
        },
        {
          "type": "object",
          "additionalProperties": false,
          "required": ["type", "token"],
          "properties": {
            "type": { "const": "action_selected" },
            "token": { "$ref": "#/$defs/id" }
          }
        }
      ]
    }
  }
}