async-matrix 0.1.2 → 1.0.0

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

@@ -0,0 +1,62 @@
+# 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: Authentication response
+description: |-
+  Used by servers to indicate that additional authentication information is required,
+type: object
+properties:
+  flows:
+    description: A list of the login flows supported by the server for this API.
+    type: array
+    items:
+      type: object
+      title: Flow information
+      properties:
+        stages:
+          description: |-
+            The login type of each of the stages required to complete this
+            authentication flow
+          type: array
+          items:
+            type: string
+            example: "example.type.foo"
+      required:
+        - stages
+  params:
+    type: object
+    description: |-
+      Contains any information that the client will need to know in order to
+      use a given type of authentication. For each login type presented,
+      that type may be present as a key in this dictionary. For example, the
+      public part of an OAuth client ID could be given here.
+    additionalProperties:
+      type: object
+    example:
+      "example.type.baz": { "example_key": "foobar" }
+  session:
+    type: string
+    description: |-
+      This is a session identifier that the client must pass back to the home
+      server, if one is provided, in subsequent attempts to authenticate in the
+      same API call.
+    example: "xxxxxxyz"
+  completed:
+    type: array
+    description: |-
+      A list of the stages the client has completed successfully
+    items:
+      type: string
+      example: "example.type.foo"
+required:
+  - flows

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

@@ -0,0 +1,44 @@
+# 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.
+
+type: object
+description: A client device
+title: Device
+properties:
+  device_id:
+    type: string
+    description: Identifier of this device.
+    example: QBUAZIFURK
+  display_name:
+    type: string
+    description: |-
+      Display name set by the user for this device. Absent if no name has been
+      set.
+    example: android
+  last_seen_ip:
+    type: string
+    description: |-
+      The IP address where this device was last seen. (May be a few minutes out
+      of date, for efficiency reasons).
+    example: 1.2.3.4
+  last_seen_ts:
+    type: integer
+    format: int64
+    description: |-
+      The timestamp (in milliseconds since the unix epoch) when this devices
+      was last seen. (May be a few minutes out of date, for efficiency
+      reasons).
+    example: 1474491775024
+required:
+  - device_id

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

@@ -0,0 +1,49 @@
+# 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.
+
+title: ClientEvent
+description: |-
+  The format used for events when they are returned from a homeserver to a client
+  via the Client-Server API, or sent to an Application Service via the Application Services API.
+type: object
+allOf:
+  - $ref: "client_event_without_room_id.yaml"
+  - type: object
+    properties:
+      room_id:
+        description: The ID of the room associated with this event.
+        type: string
+        format: mx-room-id
+        pattern: "^!"
+        example: '!jEsUZKDJdhlrceRyVU:example.org'
+      unsigned:
+        properties:
+            redacted_because:
+              title: ClientEvent
+              example: {
+                "type": "m.room.redaction",
+                "sender": "@moderator:example.org",
+                "content": {
+                  "reason": "spam"
+                },
+                "redacts": "$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45",
+                "event_id": "$Nhl3rsgHMjk-DjMJANawr9HHAhLg4GcoTYrSiYYGqEE",
+                "origin_server_ts": 1632491098485,
+                "room_id": '!jEsUZKDJdhlrceRyVU:example.org',
+                "unsigned": {
+                  "age": 1257,
+                }
+              }
+    required:
+      - room_id

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

@@ -0,0 +1,147 @@
+# 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.
+
+title: ClientEventWithoutRoomID
+description: |-
+  The format used for events when they are returned from
+  API endpoints such as `/sync`, where the `room_id` is implied elsewhere
+  in the response.
+type: object
+required:
+  - event_id
+  - type
+  - sender
+  - origin_server_ts
+  - content
+properties:
+  event_id:
+    description: The globally unique identifier for this event.
+    type: string
+    format: mx-event-id
+    pattern: "^\\$"
+    example: '$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45'
+  type:
+    description: The type of the event.
+    type: string
+    example: 'm.room.member'
+  state_key:
+    description: |-
+      Present if, and only if, this event is a *state* event. The key making
+      this piece of state unique in the room. Note that it is often an empty
+      string.
+
+      State keys starting with an `@` are reserved for referencing user IDs, such
+      as room members. With the exception of a few events, state events set with a
+      given user's ID as the state key MUST only be set by that user.
+    type: string
+    example: '@user:example.org'
+  sender:
+    description: Contains the fully-qualified ID of the user who sent this event.
+    type: string
+    format: mx-user-id
+    pattern: "^@"
+    example: "@example:example.org"
+  origin_server_ts:
+    description: |-
+      Timestamp (in milliseconds since the unix epoch) on originating homeserver
+      when this event was sent.
+    type: integer
+    format: int64
+    example: 1632489532305
+  content:
+    description: |-
+      The body of this event, as created by the client which sent it.
+    type: object
+    example: {
+      "membership": "join"
+    }
+  unsigned:
+    title: UnsignedData
+    type: object
+    description: Contains optional extra information about the event.
+    properties:
+      age:
+        description: The time in milliseconds that has elapsed since the event was
+          sent. This field is generated by the local homeserver, and may be incorrect
+          if the local time on at least one of the two servers is out of sync, which can
+          cause the age to either be negative or greater than it actually is.
+        type: integer
+        format: int64
+        example: 1567437
+      redacted_because:
+        description: The event that redacted this event, if any.
+        type: object
+        title: ClientEventWithoutRoomID
+        example: {
+          "type": "m.room.redaction",
+          "sender": "@moderator:example.org",
+          "content": {
+            "reason": "spam"
+          },
+          "redacts": "$26RqwJMLw-yds1GAH_QxjHRC1Da9oasK0e5VLnck_45",
+          "event_id": "$Nhl3rsgHMjk-DjMJANawr9HHAhLg4GcoTYrSiYYGqEE",
+          "origin_server_ts": 1632491098485,
+          "unsigned": {
+            "age": 1257,
+            "membership": "leave"
+          }
+        }
+      transaction_id:
+        description: |
+          The client-supplied [transaction ID](/client-server-api/#transaction-identifiers), for example, provided via
+          `PUT /_matrix/client/v3/rooms/{roomId}/send/{eventType}/{txnId}`,
+          if the client being given the event is the same one which sent it.
+        type: string
+      prev_content:
+        description: |
+          The `content` of the previous state event that was replaced by this event.
+          This field is generated by the local homeserver, and is only returned if
+          the event is a state event, and the client has permission to see the
+          previous event.
+        x-changedInMatrixVersion:
+          "1.2": |
+            Previously, this field was specified at the top level of returned
+            events rather than in `unsigned` (with the exception of the [`GET
+            .../notifications`](/client-server-api/#get_matrixclientv3notifications)
+            endpoint), though in practice no known server implementations honoured
+            this.
+        title: EventContent
+        type: object
+      replaces_state:
+        description: |
+          The event ID of the state event replaced by this event. This field is generated
+          by the local homeserver, and is only returned if the event is a state event.
+          Unlike `prev_content`, this field is included regardless of history visibility.
+        type: string
+        x-addedInMatrixVersion: "1.19"
+      membership:
+        description: |
+          The room membership of the user making the request, at the time of the event.
+
+          This property is the value of the `membership` property of the
+          requesting user's [`m.room.member`](/client-server-api#mroommember)
+          state at the point of the event, including any changes caused by the
+          event. If the user had yet to join the room at the time of the event
+          (i.e, they have no `m.room.member` state), this property is set to
+          `leave`.
+
+          Homeservers SHOULD populate this property
+          wherever practical, but they MAY omit it if necessary (for example,
+          if calculating the value is expensive, servers might choose to only
+          implement it in encrypted rooms). The property is *not* normally populated
+          in events pushed to application services via the application service transaction API
+          (where there is no clear definition of "requesting user").
+        type: string
+        example: join
+        x-addedInMatrixVersion: "1.11"

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

@@ -0,0 +1,57 @@
+# 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: CrossSigningKey
+description: Key used for cross signing
+properties:
+  user_id:
+    type: string
+    description: |-
+      The ID of the user the key belongs to.
+    example: "@alice:example.com"
+  usage:
+    type: array
+    description: |-
+      What the key is used for.
+    items:
+      type: string
+      enum: ["master", "self_signing", "user_signing"]
+  keys:
+    type: object
+    additionalProperties:
+      type: string
+    description: |-
+      The public key.  The object must have exactly one property, whose name is
+      in the form `<algorithm>:<unpadded_base64_public_key>`, and whose value
+      is the unpadded base64 public key.
+    minProperties: 1
+    maxProperties: 1
+    example:
+      "ed25519:alice+base64+public+key": "alice+base64+public+key"
+  signatures:
+    type: object
+    title: Signatures
+    description: |-
+      Signatures of the key, calculated using the process described at [Signing JSON](/appendices/#signing-json).
+      Optional for the master signing key. Other keys must be signed by the
+      user\'s master signing key.
+    example: {
+        "@alice:example.com": {
+            "ed25519:alice+base64+master+key": "signature+of+key"
+          }
+      }
+required:
+  - user_id
+  - usage
+  - keys

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

@@ -0,0 +1,70 @@
+# 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.
+type: object
+title: DeviceKeys
+description: Device identity keys
+properties:
+  user_id:
+    type: string
+    description: |-
+      The ID of the user the device belongs to. Must match the user ID used
+      when logging in.
+    example: "@alice:example.com"
+  device_id:
+    type: string
+    description: |-
+      The ID of the device these keys belong to. Must match the device ID used
+      when logging in.
+    example: "JLAFKJWSCS"
+  algorithms:
+    type: array
+    items:
+      type: string
+    description: |-
+      The encryption algorithms supported by this device.
+    example: ["m.olm.v1.curve25519-aes-sha2", "m.megolm.v1.aes-sha2"]
+  keys:
+    type: object
+    description: |-
+       Public identity keys. The names of the properties should be in the
+       format `<algorithm>:<device_id>`. The keys themselves should be
+       encoded as specified by the key algorithm.
+    additionalProperties:
+       type: string
+    example:
+      "curve25519:JLAFKJWSCS": "3C5BFWi2Y8MaVvjM8M22DBmh24PmgR0nPvJOIArzgyI"
+      "ed25519:JLAFKJWSCS": "lEuiRJBit0IG6nUf5pUzWTUEsRVVe/HJkoKuEww9ULI"
+  signatures:
+    type: object
+    title: Signatures
+    description: |-
+       Signatures for the device key object. A map from user ID, to a map from
+       `<algorithm>:<device_id>` to the signature.
+
+       The signature is calculated using the process described at [Signing JSON](/appendices/#signing-json).
+    patternProperties:
+      "^@":
+        x-pattern-format: mx-user-id
+        type: object
+        additionalProperties:
+          type: string
+    example:
+      "@alice:example.com":
+        "ed25519:JLAFKJWSCS": "dSO80A01XiigH3uBiDVx/EjzaoycHcjq9lfQX0uWsqxl2giMIiSPR8a4d291W1ihKJL/a+myXS367WT6NAIcBA"
+required:
+  - user_id
+  - device_id
+  - algorithms
+  - keys
+  - signatures

data/data/matrix-spec/api/client-server/definitions/errors/error.yaml

@@ -0,0 +1,26 @@
+# 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.
+type: object
+title: Error
+description: A Matrix-level Error
+properties:
+  errcode:
+    type: string
+    description: An error code.
+    example: M_UNKNOWN
+  error:
+    type: string
+    description: A human-readable error message.
+    example: An unknown error occurred
+required: ["errcode"]

data/data/matrix-spec/api/client-server/definitions/errors/rate_limited.yaml

@@ -0,0 +1,34 @@
+# Copyright 2018 New Vector 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.
+allOf:
+  - $ref: error.yaml
+  - type: object
+    title: RateLimitError
+    description: The rate limit was reached for this request
+    properties:
+      errcode:
+        type: string
+        description: The M_LIMIT_EXCEEDED error code
+        example: M_LIMIT_EXCEEDED
+      error:
+        type: string
+        description: A human-readable error message.
+        example: Too many requests
+      retry_after_ms:
+        type: integer
+        description: |-
+          The amount of time in milliseconds the client should wait
+          before trying the request again.
+        example: 2000
+    required: ["errcode"]

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

@@ -0,0 +1,22 @@
+# Copyright 2016 OpenMarket Ltd
+# Copyright 2018 New Vector 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:
+  events:
+    description: List of events.
+    items:
+      $ref: ../../../event-schemas/schema/core-event-schema/event.yaml
+    type: array
+type: object
+title: EventBatch

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

@@ -0,0 +1,55 @@
+# 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: EventFilter
+properties:
+  limit:
+    description: |
+      The maximum number of events to return, must be an integer greater than 0.
+
+      Servers should apply a default value, and impose a maximum value to avoid
+      resource exhaustion.
+    type: integer
+  not_senders:
+    description: A list of sender IDs to exclude. If this list is absent then no senders
+      are excluded. A matching sender will be excluded even if it is listed in the
+      `senders` filter.
+    items:
+      type: string
+      format: mx-user-id
+      pattern: "^@"
+    type: array
+  not_types:
+    description: A list of event types to exclude. If this list is absent then no
+      event types are excluded. A matching type will be excluded even if it is listed
+      in the `types` filter. A `*` can be used as a wildcard to match any sequence
+      of characters.
+    items:
+      type: string
+    type: array
+  senders:
+    description: A list of senders IDs to include. If this list is absent then all
+      senders are included.
+    items:
+      type: string
+      format: mx-user-id
+      pattern: "^@"
+    type: array
+  types:
+    description: A list of event types to include. If this list is absent then all
+      event types are included. A `*` can be used as a wildcard to match any sequence
+      of characters.
+    items:
+      type: string
+    type: array
+type: object

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

@@ -0,0 +1,45 @@
+# 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: Invite3pid
+properties:
+  id_server:
+    type: string
+    description: The hostname+port of the identity server which should be used for
+      third-party identifier lookups.
+  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.
+  medium:
+    type: string
+    description: |-
+      The kind of address being passed in the address field, for example `email`
+      (see [the list of recognised values](/appendices/#3pid-types)).
+  address:
+    type: string
+    description: The invitee's third-party identifier.
+required:
+  - id_server
+  - id_access_token
+  - medium
+  - address
+example: {
+  "id_server": "matrix.org",
+  "id_access_token": "abc123_OpaqueString",
+  "medium": "email",
+  "address": "cheeky@monkey.com"
+}

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

@@ -0,0 +1,36 @@
+# 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.
+
+
+type: object
+title: AuthData
+description: |-
+  The format of the `auth_data` when a key backup is created with the
+  `algorithm` set to `m.megolm_backup.v1.curve25519-aes-sha2`.
+properties:
+  public_key:
+    type: string
+    description: |-
+      The curve25519 public key used to encrypt the backups, encoded in unpadded base64.
+    example: "abcdefg"
+  signatures:
+    type: object
+    description: |-
+      Signatures of the `auth_data`, as Signed JSON
+    example: {
+      "something": {
+        "ed25519:something": "hijklmnop"
+      }
+    }
+required: ['public_key']