async-matrix 0.1.2 → 1.0.0

data/data/matrix-spec/api/client-server/definitions/push_condition.yaml

@@ -0,0 +1,53 @@
+# Copyright 2016 OpenMarket Ltd
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+title: PushCondition
+type: object
+properties:
+  kind:
+    type: string
+    description: |-
+      The kind of condition to apply. See [conditions](/client-server-api/#conditions-1) for
+      more information on the allowed kinds and how they work.
+  key:
+    type: string
+    description: |-
+      Required for `event_match`, `event_property_is` and `event_property_contains`
+      conditions. The dot-separated field of the event to match.
+
+      Required for `sender_notification_permission` conditions. The field in
+      the power level event the user needs a minimum power level for. Fields
+      must be specified under the `notifications` property in the power level
+      event's `content`.
+    example: content.body
+  pattern:
+    type: string
+    description: |-
+      Required for `event_match` conditions. The [glob-style pattern](/appendices#glob-style-matching)
+      to match against.
+  is:
+    type: string
+    description: |-
+      Required for `room_member_count` conditions. A decimal integer
+      optionally prefixed by one of, ==, <, >, >= or <=. A prefix of < matches
+      rooms where the member count is strictly less than the given number and
+      so forth. If no prefix is present, this parameter defaults to ==.
+  value:
+    type: ["string", "integer", "boolean", "null"]
+    description: |-
+      Required for `event_property_is` and `event_property_contains` conditions.
+      A non-compound [canonical JSON](/appendices#canonical-json) value to match
+      against.
+required:
+  - kind

data/data/matrix-spec/api/client-server/definitions/push_rule.yaml

@@ -0,0 +1,53 @@
+# Copyright 2016 OpenMarket Ltd
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+title: PushRule
+type: object
+properties:
+  actions:
+    items:
+      type: ["string", "object"]
+    type: array
+    description: |-
+      The actions to perform when this rule is matched.
+  default:
+    type: boolean
+    description: |-
+      Whether this is a default rule, or has been set explicitly.
+  enabled:
+    type: boolean
+    description: |-
+      Whether the push rule is enabled or not.
+  rule_id:
+    type: string
+    description: |-
+      The ID of this rule.
+  conditions:
+    type: array
+    items:
+      $ref: push_condition.yaml
+    description: |-
+      The conditions that must hold true for an event in order for a rule to be
+      applied to an event. A rule with no conditions always matches. Only
+      applicable to `underride` and `override` rules.
+  pattern:
+    type: string
+    description: |-
+      The [glob-style pattern](/appendices#glob-style-matching) to match against.
+      Only applicable to `content` rules.
+required:
+  - actions
+  - default
+  - enabled
+  - rule_id

data/data/matrix-spec/api/client-server/definitions/push_ruleset.yaml

@@ -0,0 +1,206 @@
+# Copyright 2016 OpenMarket Ltd
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+properties:
+  content:
+    items:
+      $ref: push_rule.yaml
+    type: array
+  override:
+    items:
+      $ref: push_rule.yaml
+    type: array
+  room:
+    items:
+      $ref: push_rule.yaml
+    type: array
+  sender:
+    items:
+      $ref: push_rule.yaml
+    type: array
+  underride:
+    items:
+      $ref: push_rule.yaml
+    type: array
+type: object
+example: {
+  "override": [
+    {
+      "actions": [],
+      "conditions": [],
+      "default": true,
+      "enabled": false,
+      "rule_id": ".m.rule.master"
+    },
+    {
+      "actions": [],
+      "conditions": [
+        {
+          "key": "content.msgtype",
+          "kind": "event_match",
+          "pattern": "m.notice"
+        }
+      ],
+      "default": true,
+      "enabled": true,
+      "rule_id": ".m.rule.suppress_notices"
+    }
+  ],
+  "room": [],
+  "sender": [],
+  "underride": [
+    {
+      "actions": [
+        "notify",
+        {
+          "set_tweak": "sound",
+          "value": "ring"
+        },
+        {
+          "set_tweak": "highlight",
+          "value": false
+        }
+      ],
+      "conditions": [
+        {
+          "key": "type",
+          "kind": "event_match",
+          "pattern": "m.call.invite"
+        }
+      ],
+      "default": true,
+      "enabled": true,
+      "rule_id": ".m.rule.call"
+    },
+    {
+      "actions": [
+        "notify",
+        {
+          "set_tweak": "sound",
+          "value": "default"
+        },
+        {
+          "set_tweak": "highlight"
+        }
+      ],
+      "conditions": [
+        {
+            "kind": "event_property_contains",
+            "key": "content.m\\.mentions.user_ids",
+            "value": "@alice:example.com"
+        }
+      ],
+      "default": true,
+      "enabled": true,
+      "rule_id": ".m.rule.is_user_mention"
+    },
+    {
+      "actions": [
+        "notify",
+        {
+          "set_tweak": "sound",
+          "value": "default"
+        },
+        {
+          "set_tweak": "highlight",
+          "value": false
+        }
+      ],
+      "conditions": [
+        {
+          "kind": "room_member_count",
+          "is": "2"
+        },
+        {
+          "kind": "event_match",
+          "key": "type",
+          "pattern": "m.room.message"
+        }
+      ],
+      "default": true,
+      "enabled": true,
+      "rule_id": ".m.rule.room_one_to_one"
+    },
+    {
+      "actions": [
+        "notify",
+        {
+          "set_tweak": "sound",
+          "value": "default"
+        },
+        {
+          "set_tweak": "highlight",
+          "value": false
+        }
+      ],
+      "conditions": [
+        {
+          "key": "type",
+          "kind": "event_match",
+          "pattern": "m.room.member"
+        },
+        {
+          "key": "content.membership",
+          "kind": "event_match",
+          "pattern": "invite"
+        },
+        {
+          "key": "state_key",
+          "kind": "event_match",
+          "pattern": "@alice:example.com"
+        }
+      ],
+      "default": true,
+      "enabled": true,
+      "rule_id": ".m.rule.invite_for_me"
+    },
+    {
+      "actions": [
+        "notify",
+        {
+          "set_tweak": "highlight",
+          "value": false
+        }
+      ],
+      "conditions": [
+        {
+          "key": "type",
+          "kind": "event_match",
+          "pattern": "m.room.member"
+        }
+      ],
+      "default": true,
+      "enabled": true,
+      "rule_id": ".m.rule.member_event"
+    },
+    {
+      "actions": [
+        "notify",
+        {
+          "set_tweak": "highlight",
+          "value": false
+        }
+      ],
+      "conditions": [
+        {
+          "key": "type",
+          "kind": "event_match",
+          "pattern": "m.room.message"
+        }
+      ],
+      "default": true,
+      "enabled": true,
+      "rule_id": ".m.rule.message"
+    }
+  ]
+}

data/data/matrix-spec/api/client-server/definitions/recent_emoji.yaml

@@ -0,0 +1,29 @@
+# Copyright 2026 The Matrix.org Foundation C.I.C.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+title: Recent Emoji
+type: object
+properties:
+  emoji:
+    type: string
+    description: The Unicode emoji as string.
+    example: 🚀
+  total:
+    type: number
+    description: |-
+      The number of times the emoji has been used.
+      MUST be non-negative and smaller than 2^53.
+required:
+  - emoji
+  - total

data/data/matrix-spec/api/client-server/definitions/request_email_validation.yaml

@@ -0,0 +1,36 @@
+# Copyright 2019 The Matrix.org Foundation C.I.C.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+type: object
+allOf:
+- $ref: "../../identity/definitions/request_email_validation.yaml"
+- type: object
+  properties:
+    id_server:
+      type: string
+      description: |-
+        The hostname of the identity server to communicate with. May optionally
+        include a port. This parameter is ignored when the homeserver handles
+        3PID verification.
+
+        This parameter is deprecated with a plan to be removed in a future specification
+        version for `/account/password` and `/register` requests.
+      example: "id.example.com"
+    id_access_token:
+      type: string
+      description: |-
+        An access token previously registered with the identity server. Servers
+        can treat this as optional to distinguish between r0.5-compatible clients
+        and this specification version.
+
+        Required if an `id_server` is supplied.

data/data/matrix-spec/api/client-server/definitions/request_msisdn_validation.yaml

@@ -0,0 +1,36 @@
+# Copyright 2019 The Matrix.org Foundation C.I.C.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+type: object
+allOf:
+- $ref: "../../identity/definitions/request_msisdn_validation.yaml"
+- type: object
+  properties:
+    id_server:
+      type: string
+      description: |-
+        The hostname of the identity server to communicate with. May optionally
+        include a port. This parameter is ignored when the homeserver handles
+        3PID verification.
+
+        This parameter is deprecated with a plan to be removed in a future specification
+        version for `/account/password` and `/register` requests.
+      example: "id.example.com"
+    id_access_token:
+      type: string
+      description: |-
+        An access token previously registered with the identity server. Servers
+        can treat this as optional to distinguish between r0.5-compatible clients
+        and this specification version.
+
+        Required if an `id_server` is supplied.

data/data/matrix-spec/api/client-server/definitions/request_token_response.yaml

@@ -0,0 +1,46 @@
+# Copyright 2019 The Matrix.org Foundation C.I.C.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+type: object
+title: RequestTokenResponse
+properties:
+  sid:
+    type: string
+    description: |-
+      The session ID. Session IDs are opaque strings that must consist entirely
+      of the characters `[0-9a-zA-Z.=_-]`. Their length must not exceed 255
+      characters and they must not be empty.
+    example: "123abc"
+  submit_url:
+    type: string
+    format: uri
+    x-changedInMatrixVersion:
+      "1.18": |-
+        The URL has the same request and response parameters and error codes as
+        the Identity Service API's endpoint.
+    description: |-
+      An optional field containing a URL where the client must submit the
+      validation token, with identical request and response parameters and error
+      codes to the Identity Service API's
+      [`POST /validate/email/submitToken`](/identity-service-api/#post_matrixidentityv2validateemailsubmittoken)
+      and [`POST /validate/msisdn/submitToken`](/identity-service-api/#post_matrixidentityv2validatemsisdnsubmittoken)
+      endpoints (without the requirement for an access token). The homeserver
+      must send this token to the user (if applicable), who should then be
+      prompted to provide it to the client.
+
+      If this field is not present, the client can assume that verification
+      will happen without the client's involvement provided the homeserver
+      advertises a sufficiently recent version in the [`GET /versions`](/client-server-api/#get_matrixclientversions)
+      response (ie: r0.5.0).
+    example: "https://example.org/path/to/submitToken"
+required: ['sid']

data/data/matrix-spec/api/client-server/definitions/room_event_filter.yaml

@@ -0,0 +1,60 @@
+# Copyright 2016 OpenMarket Ltd
+# Copyright 2022 The Matrix.org Foundation C.I.C.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+allOf:
+- $ref: event_filter.yaml
+- type: object
+  title: RoomEventFilter
+  properties:
+    unread_thread_notifications:
+      type: boolean
+      description: |-
+        If `true`, enables per-[thread](/client-server-api/#threading) notification
+        counts. Only applies to the `/sync` endpoint. Defaults to `false`.
+      x-addedInMatrixVersion: "1.4"
+    lazy_load_members:
+      type: boolean
+      description: |-
+        If `true`, enables lazy-loading of membership events. See
+        [Lazy-loading room members](/client-server-api/#lazy-loading-room-members)
+        for more information. Defaults to `false`.
+    include_redundant_members:
+      type: boolean
+      description: |-
+        If `true`, sends all membership events for all events, even if they have already
+        been sent to the client. Does not
+        apply unless `lazy_load_members` is `true`. See
+        [Lazy-loading room members](/client-server-api/#lazy-loading-room-members)
+        for more information. Defaults to `false`.
+    not_rooms:
+      description: A list of room IDs to exclude. If this list is absent then no rooms
+        are excluded. A matching room will be excluded even if it is listed in the `rooms`
+        filter.
+      items:
+        type: string
+        format: mx-room-id
+        pattern: "^!"
+      type: array
+    rooms:
+      description: A list of room IDs to include. If this list is absent then all rooms
+        are included.
+      items:
+        type: string
+        format: mx-room-id
+        pattern: "^!"
+      type: array
+    contains_url:
+      type: boolean
+      description: If `true`, includes only events with a `url` key in their content. If
+        `false`, excludes those events. If omitted, `url` key is not considered for filtering.

data/data/matrix-spec/api/client-server/definitions/room_key_backup.yaml

@@ -0,0 +1,37 @@
+# Copyright 2020 The Matrix.org Foundation C.I.C.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+type: object
+title: RoomKeyBackup
+description: "The backed up keys for a room."
+properties:
+  sessions:
+    type: object
+    description: "A map of session IDs to key data."
+    additionalProperties:
+      $ref: "key_backup_data.yaml"
+    example: {
+      "sessionid1": {
+        "first_message_index": 1,
+        "forwarded_count": 0,
+        "is_verified": true,
+        "session_data": {
+          "ephemeral": "base64+ephemeral+key",
+          "ciphertext": "base64+ciphertext+of+JSON+data",
+          "mac": "base64+mac+of+ciphertext"
+        }
+      }
+    }
+required:
+  - sessions

data/data/matrix-spec/api/client-server/definitions/room_summary.yaml

@@ -0,0 +1,44 @@
+# Copyright 2025 The Matrix.org Foundation C.I.C.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+type: object
+title: RoomSummary
+allOf:
+  - $ref: public_rooms_chunk.yaml
+  - type: object
+    properties:
+      room_type:
+        type: string
+        description: The `type` of room (from
+          [`m.room.create`](/client-server-api/#mroomcreate)),
+          if any.
+      allowed_room_ids:
+        type: array
+        items:
+          type: string
+          format: mx-room-id
+          pattern: "^!"
+        description: |-
+          If the room is a [restricted room](/server-server-api/#restricted-rooms), these are the room IDs which
+          are specified by the join rules. Empty or omitted otherwise.
+      encryption:
+        type: string
+        enum:
+          - "m.megolm.v1.aes-sha2"
+        description: |-
+          The encryption algorithm to be used to encrypt messages sent in the
+          room.
+      room_version:
+        description: The version of the room.
+        type: string

data/data/matrix-spec/api/client-server/definitions/security.yaml

@@ -0,0 +1,47 @@
+# Copyright 2016 OpenMarket Ltd
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+accessTokenQuery:
+  type: apiKey
+  description: |-
+    **Deprecated.** The `access_token` obtained during [account registration](/client-server-api/#account-registration)
+    or [login](/client-server-api/#login), as a query parameter.
+
+    It can also be the `as_token` of an application service.
+  name: access_token
+  in: query
+accessTokenBearer:
+  type: http
+  description: |-
+    The `access_token` obtained during [account registration](/client-server-api/#account-registration)
+    or [login](/client-server-api/#login), using the `Authorization: Bearer` header.
+
+    It can also be the `as_token` of an application service.
+
+    This is the preferred method.
+  scheme: bearer
+appserviceAccessTokenQuery:
+  type: apiKey
+  description: |-
+    **Deprecated.** The `as_token` of an application service, as a query
+    parameter.
+  name: access_token
+  in: query
+appserviceAccessTokenBearer:
+  type: http
+  description: |-
+    The `as_token` of an application service, using the `Authorization: Bearer`
+    header.
+
+    This is the preferred method.
+  scheme: bearer