@openvtc/trust-tasks 0.28.10 → 0.28.12

package/dist/vtn/broadcasts/send/0.1/payload.d.ts

@@ -0,0 +1,728 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtn/broadcasts/send/0.1/payload.schema.json
+ */
+import type { BroadcastRecord, Credential, DeliveryStatus, Did_VtnV0_1 as Did, Ext, Receipt, RoleName_VtnV0_1 as RoleName } from "../../../../_shared/components.js";
+/**
+ * An administrator's message for every group registered for a role. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTNBroadcastsSendPayload {
+    /**
+     * The role to address: delivered to every current member's group registered for it.
+     */
+    role: RoleName;
+    /**
+     * What kind of message it is, for the receiving group to sort on: `notice` (the default), `request-for-action`, `room-invite`, or another the network's framework names.
+     */
+    class?: string;
+    /**
+     * A one-line subject.
+     */
+    subject: string;
+    /**
+     * The message text.
+     */
+    body: string;
+    /**
+     * Where replies go, such as a URL or DID for a network data room, so that a broadcast never becomes reply-all.
+     */
+    replyTo?: string;
+    ext?: Ext;
+}
+/**
+ * The broadcast as recorded, with each group's receipt as it stands when the network answers. Queued deliveries are retried from the outbox and update the record later.
+ */
+export interface VTNBroadcastsSendResponsePayload {
+    broadcast: BroadcastRecord;
+    ext?: Ext;
+}
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { BroadcastRecord, Credential, DeliveryStatus, Did, Ext, Receipt, RoleName };
+/** Trust Task type URI. */
+export declare const TYPE_URI: "https://trusttasks.org/spec/vtn/broadcasts/send/0.1";
+/**
+ * The earlier version of this specification that this one declares it
+ * extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
+ * `null`. Only the direct declaration — follow the chain with
+ * `extendsChain` / `readForSpec`.
+ */
+export declare const EXTENDS: string | null;
+/**
+ * Why this version is deprecated, or `null` while it is current. A
+ * superseded or retired version is still supported, and is withdrawn from
+ * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
+ * Versions").
+ */
+export declare const DEPRECATION: string | null;
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTNBroadcastsSendPayload;
+/** Trust Task response type URI (request type URI + "#response"). */
+export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vtn/broadcasts/send/0.1#response";
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTNBroadcastsSendResponsePayload;
+/**
+ * This specification's payload schema, as a value.
+ *
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
+ * rather than only as a `.json` file because TypeScript types are erased
+ * at runtime: without a schema a consumer has nothing to validate, and
+ * every REQUIRED payload member is optional in practice. Cross-file
+ * `$ref`s are already inlined, so it needs no resolver.
+ */
+export declare const PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "https://trusttasks.org/spec/vtn/broadcasts/send/0.1";
+    readonly title: "VTN Broadcasts — Send — payload";
+    readonly description: "An administrator's message for every group registered for a role. The outer document members are owned by the framework — SPEC §6.3.";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["role", "subject", "body"];
+    readonly properties: {
+        readonly role: {
+            readonly $ref: "#/$defs/RoleName";
+            readonly description: "The role to address: delivered to every current member's group registered for it.";
+        };
+        readonly class: {
+            readonly type: "string";
+            readonly pattern: "^[a-z][a-z0-9-]{0,62}$";
+            readonly description: "What kind of message it is, for the receiving group to sort on: `notice` (the default), `request-for-action`, `room-invite`, or another the network's framework names.";
+        };
+        readonly subject: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 200;
+            readonly description: "A one-line subject.";
+        };
+        readonly body: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 20000;
+            readonly description: "The message text.";
+        };
+        readonly replyTo: {
+            readonly type: "string";
+            readonly minLength: 1;
+            readonly maxLength: 2048;
+            readonly description: "Where replies go, such as a URL or DID for a network data room, so that a broadcast never becomes reply-all.";
+        };
+        readonly ext: {
+            readonly $ref: "#/$defs/Ext";
+        };
+    };
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTN Broadcasts — Send — response payload";
+            readonly description: "The broadcast as recorded, with each group's receipt as it stands when the network answers. Queued deliveries are retried from the outbox and update the record later.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["broadcast"];
+            readonly properties: {
+                readonly broadcast: {
+                    readonly $ref: "#/$defs/BroadcastRecord";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly description: "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly BroadcastRecord: {
+            readonly description: "A broadcast as this network sent or relayed it.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["id", "direction", "role", "message", "recordedAt", "receipts", "reached"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                    readonly maxLength: 2048;
+                    readonly description: "The message id.";
+                };
+                readonly direction: {
+                    readonly type: "string";
+                    readonly enum: readonly ["sent", "received"];
+                    readonly description: "Whether this network sent it or received it to relay.";
+                };
+                readonly role: {
+                    readonly $ref: "#/$defs/RoleName";
+                    readonly description: "The role it was addressed to.";
+                };
+                readonly message: {
+                    readonly $ref: "#/$defs/Credential";
+                    readonly description: "The signed message.";
+                };
+                readonly from: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "For a received message, the network that delivered it.";
+                };
+                readonly actor: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "For a sent message, the administrator that sent it.";
+                };
+                readonly recordedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When.";
+                };
+                readonly receipts: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/Receipt";
+                    };
+                    readonly description: "Per group.";
+                };
+                readonly reached: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Groups delivered to, counting relays.";
+                };
+            };
+        };
+        readonly Receipt: {
+            readonly description: "The outcome of one delivery.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["group", "member", "status"];
+            readonly properties: {
+                readonly group: {
+                    readonly type: "string";
+                    readonly maxLength: 2048;
+                    readonly description: "The group delivered to.";
+                };
+                readonly member: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The member that owns it.";
+                };
+                readonly status: {
+                    readonly $ref: "#/$defs/DeliveryStatus";
+                };
+                readonly detail: {
+                    readonly type: "string";
+                    readonly maxLength: 1000;
+                    readonly description: "Why, for anything but `delivered`.";
+                };
+                readonly network: {
+                    readonly type: "boolean";
+                    readonly description: "Whether the group is a network group, which relays further.";
+                };
+                readonly relayed: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/Receipt";
+                    };
+                    readonly description: "The receipts the network group's own relay returned.";
+                };
+            };
+        };
+        readonly DeliveryStatus: {
+            readonly type: "string";
+            readonly enum: readonly ["delivered", "duplicate", "refused", "queued", "failed"];
+            readonly description: "What happened to one delivery. `queued` will be retried.";
+        };
+        readonly Did: {
+            readonly type: "string";
+            readonly pattern: "^did:[a-z0-9]+:.+$";
+            readonly maxLength: 2048;
+            readonly description: "A DID.";
+        };
+        readonly Credential: {
+            readonly type: "object";
+            readonly description: "A DTG credential (W3C VC 2.0, JSON) exactly as signed. Verified by the party relying on it, never by its shape here: it is an open object so a binding cannot narrow away a member the proof covers.";
+        };
+        readonly RoleName: {
+            readonly type: "string";
+            readonly pattern: "^[a-z0-9_-]{1,64}$";
+            readonly description: "A role's name: 1–64 lowercase letters, digits, `-` or `_`.";
+        };
+    };
+};
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export declare const RESPONSE_PAYLOAD_SCHEMA: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $ref: "#/$defs/Response";
+    readonly $defs: {
+        readonly Response: {
+            readonly $anchor: "response";
+            readonly title: "VTN Broadcasts — Send — response payload";
+            readonly description: "The broadcast as recorded, with each group's receipt as it stands when the network answers. Queued deliveries are retried from the outbox and update the record later.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["broadcast"];
+            readonly properties: {
+                readonly broadcast: {
+                    readonly $ref: "#/$defs/BroadcastRecord";
+                };
+                readonly ext: {
+                    readonly $ref: "#/$defs/Ext";
+                };
+            };
+        };
+        readonly Ext: {
+            readonly title: "Ext";
+            readonly description: "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.";
+            readonly type: "object";
+            readonly minProperties: 1;
+            readonly additionalProperties: true;
+            readonly propertyNames: {
+                readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+            };
+        };
+        readonly BroadcastRecord: {
+            readonly description: "A broadcast as this network sent or relayed it.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["id", "direction", "role", "message", "recordedAt", "receipts", "reached"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                    readonly maxLength: 2048;
+                    readonly description: "The message id.";
+                };
+                readonly direction: {
+                    readonly type: "string";
+                    readonly enum: readonly ["sent", "received"];
+                    readonly description: "Whether this network sent it or received it to relay.";
+                };
+                readonly role: {
+                    readonly $ref: "#/$defs/RoleName";
+                    readonly description: "The role it was addressed to.";
+                };
+                readonly message: {
+                    readonly $ref: "#/$defs/Credential";
+                    readonly description: "The signed message.";
+                };
+                readonly from: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "For a received message, the network that delivered it.";
+                };
+                readonly actor: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "For a sent message, the administrator that sent it.";
+                };
+                readonly recordedAt: {
+                    readonly type: "string";
+                    readonly format: "date-time";
+                    readonly description: "When.";
+                };
+                readonly receipts: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/Receipt";
+                    };
+                    readonly description: "Per group.";
+                };
+                readonly reached: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                    readonly description: "Groups delivered to, counting relays.";
+                };
+            };
+        };
+        readonly Receipt: {
+            readonly description: "The outcome of one delivery.";
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["group", "member", "status"];
+            readonly properties: {
+                readonly group: {
+                    readonly type: "string";
+                    readonly maxLength: 2048;
+                    readonly description: "The group delivered to.";
+                };
+                readonly member: {
+                    readonly $ref: "#/$defs/Did";
+                    readonly description: "The member that owns it.";
+                };
+                readonly status: {
+                    readonly $ref: "#/$defs/DeliveryStatus";
+                };
+                readonly detail: {
+                    readonly type: "string";
+                    readonly maxLength: 1000;
+                    readonly description: "Why, for anything but `delivered`.";
+                };
+                readonly network: {
+                    readonly type: "boolean";
+                    readonly description: "Whether the group is a network group, which relays further.";
+                };
+                readonly relayed: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/Receipt";
+                    };
+                    readonly description: "The receipts the network group's own relay returned.";
+                };
+            };
+        };
+        readonly DeliveryStatus: {
+            readonly type: "string";
+            readonly enum: readonly ["delivered", "duplicate", "refused", "queued", "failed"];
+            readonly description: "What happened to one delivery. `queued` will be retried.";
+        };
+        readonly Did: {
+            readonly type: "string";
+            readonly pattern: "^did:[a-z0-9]+:.+$";
+            readonly maxLength: 2048;
+            readonly description: "A DID.";
+        };
+        readonly Credential: {
+            readonly type: "object";
+            readonly description: "A DTG credential (W3C VC 2.0, JSON) exactly as signed. Verified by the party relying on it, never by its shape here: it is an open object so a binding cannot narrow away a member the proof covers.";
+        };
+        readonly RoleName: {
+            readonly type: "string";
+            readonly pattern: "^[a-z0-9_-]{1,64}$";
+            readonly description: "A role's name: 1–64 lowercase letters, digits, `-` or `_`.";
+        };
+    };
+};
+/**
+ * SPEC.md §7.2 policy for the request variant, from this specification's
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
+ */
+export declare const SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/vtn/broadcasts/send/0.1";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $id: "https://trusttasks.org/spec/vtn/broadcasts/send/0.1";
+        readonly title: "VTN Broadcasts — Send — payload";
+        readonly description: "An administrator's message for every group registered for a role. The outer document members are owned by the framework — SPEC §6.3.";
+        readonly type: "object";
+        readonly additionalProperties: false;
+        readonly required: readonly ["role", "subject", "body"];
+        readonly properties: {
+            readonly role: {
+                readonly $ref: "#/$defs/RoleName";
+                readonly description: "The role to address: delivered to every current member's group registered for it.";
+            };
+            readonly class: {
+                readonly type: "string";
+                readonly pattern: "^[a-z][a-z0-9-]{0,62}$";
+                readonly description: "What kind of message it is, for the receiving group to sort on: `notice` (the default), `request-for-action`, `room-invite`, or another the network's framework names.";
+            };
+            readonly subject: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 200;
+                readonly description: "A one-line subject.";
+            };
+            readonly body: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 20000;
+                readonly description: "The message text.";
+            };
+            readonly replyTo: {
+                readonly type: "string";
+                readonly minLength: 1;
+                readonly maxLength: 2048;
+                readonly description: "Where replies go, such as a URL or DID for a network data room, so that a broadcast never becomes reply-all.";
+            };
+            readonly ext: {
+                readonly $ref: "#/$defs/Ext";
+            };
+        };
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTN Broadcasts — Send — response payload";
+                readonly description: "The broadcast as recorded, with each group's receipt as it stands when the network answers. Queued deliveries are retried from the outbox and update the record later.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["broadcast"];
+                readonly properties: {
+                    readonly broadcast: {
+                        readonly $ref: "#/$defs/BroadcastRecord";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly description: "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly BroadcastRecord: {
+                readonly description: "A broadcast as this network sent or relayed it.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["id", "direction", "role", "message", "recordedAt", "receipts", "reached"];
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                        readonly maxLength: 2048;
+                        readonly description: "The message id.";
+                    };
+                    readonly direction: {
+                        readonly type: "string";
+                        readonly enum: readonly ["sent", "received"];
+                        readonly description: "Whether this network sent it or received it to relay.";
+                    };
+                    readonly role: {
+                        readonly $ref: "#/$defs/RoleName";
+                        readonly description: "The role it was addressed to.";
+                    };
+                    readonly message: {
+                        readonly $ref: "#/$defs/Credential";
+                        readonly description: "The signed message.";
+                    };
+                    readonly from: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "For a received message, the network that delivered it.";
+                    };
+                    readonly actor: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "For a sent message, the administrator that sent it.";
+                    };
+                    readonly recordedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When.";
+                    };
+                    readonly receipts: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/Receipt";
+                        };
+                        readonly description: "Per group.";
+                    };
+                    readonly reached: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Groups delivered to, counting relays.";
+                    };
+                };
+            };
+            readonly Receipt: {
+                readonly description: "The outcome of one delivery.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["group", "member", "status"];
+                readonly properties: {
+                    readonly group: {
+                        readonly type: "string";
+                        readonly maxLength: 2048;
+                        readonly description: "The group delivered to.";
+                    };
+                    readonly member: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The member that owns it.";
+                    };
+                    readonly status: {
+                        readonly $ref: "#/$defs/DeliveryStatus";
+                    };
+                    readonly detail: {
+                        readonly type: "string";
+                        readonly maxLength: 1000;
+                        readonly description: "Why, for anything but `delivered`.";
+                    };
+                    readonly network: {
+                        readonly type: "boolean";
+                        readonly description: "Whether the group is a network group, which relays further.";
+                    };
+                    readonly relayed: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/Receipt";
+                        };
+                        readonly description: "The receipts the network group's own relay returned.";
+                    };
+                };
+            };
+            readonly DeliveryStatus: {
+                readonly type: "string";
+                readonly enum: readonly ["delivered", "duplicate", "refused", "queued", "failed"];
+                readonly description: "What happened to one delivery. `queued` will be retried.";
+            };
+            readonly Did: {
+                readonly type: "string";
+                readonly pattern: "^did:[a-z0-9]+:.+$";
+                readonly maxLength: 2048;
+                readonly description: "A DID.";
+            };
+            readonly Credential: {
+                readonly type: "object";
+                readonly description: "A DTG credential (W3C VC 2.0, JSON) exactly as signed. Verified by the party relying on it, never by its shape here: it is an open object so a binding cannot narrow away a member the proof covers.";
+            };
+            readonly RoleName: {
+                readonly type: "string";
+                readonly pattern: "^[a-z0-9_-]{1,64}$";
+                readonly description: "A role's name: 1–64 lowercase letters, digits, `-` or `_`.";
+            };
+        };
+    };
+};
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export declare const RESPONSE_SPEC: {
+    readonly typeUri: "https://trusttasks.org/spec/vtn/broadcasts/send/0.1#response";
+    readonly isBearer: false;
+    readonly isProofRequired: true;
+    readonly isRecipientRequired: true;
+    readonly isIssuedAtRequired: true;
+    readonly payloadSchema: {
+        readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+        readonly $ref: "#/$defs/Response";
+        readonly $defs: {
+            readonly Response: {
+                readonly $anchor: "response";
+                readonly title: "VTN Broadcasts — Send — response payload";
+                readonly description: "The broadcast as recorded, with each group's receipt as it stands when the network answers. Queued deliveries are retried from the outbox and update the record later.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["broadcast"];
+                readonly properties: {
+                    readonly broadcast: {
+                        readonly $ref: "#/$defs/BroadcastRecord";
+                    };
+                    readonly ext: {
+                        readonly $ref: "#/$defs/Ext";
+                    };
+                };
+            };
+            readonly Ext: {
+                readonly title: "Ext";
+                readonly description: "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.";
+                readonly type: "object";
+                readonly minProperties: 1;
+                readonly additionalProperties: true;
+                readonly propertyNames: {
+                    readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
+                };
+            };
+            readonly BroadcastRecord: {
+                readonly description: "A broadcast as this network sent or relayed it.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["id", "direction", "role", "message", "recordedAt", "receipts", "reached"];
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                        readonly maxLength: 2048;
+                        readonly description: "The message id.";
+                    };
+                    readonly direction: {
+                        readonly type: "string";
+                        readonly enum: readonly ["sent", "received"];
+                        readonly description: "Whether this network sent it or received it to relay.";
+                    };
+                    readonly role: {
+                        readonly $ref: "#/$defs/RoleName";
+                        readonly description: "The role it was addressed to.";
+                    };
+                    readonly message: {
+                        readonly $ref: "#/$defs/Credential";
+                        readonly description: "The signed message.";
+                    };
+                    readonly from: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "For a received message, the network that delivered it.";
+                    };
+                    readonly actor: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "For a sent message, the administrator that sent it.";
+                    };
+                    readonly recordedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When.";
+                    };
+                    readonly receipts: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/Receipt";
+                        };
+                        readonly description: "Per group.";
+                    };
+                    readonly reached: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "Groups delivered to, counting relays.";
+                    };
+                };
+            };
+            readonly Receipt: {
+                readonly description: "The outcome of one delivery.";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly required: readonly ["group", "member", "status"];
+                readonly properties: {
+                    readonly group: {
+                        readonly type: "string";
+                        readonly maxLength: 2048;
+                        readonly description: "The group delivered to.";
+                    };
+                    readonly member: {
+                        readonly $ref: "#/$defs/Did";
+                        readonly description: "The member that owns it.";
+                    };
+                    readonly status: {
+                        readonly $ref: "#/$defs/DeliveryStatus";
+                    };
+                    readonly detail: {
+                        readonly type: "string";
+                        readonly maxLength: 1000;
+                        readonly description: "Why, for anything but `delivered`.";
+                    };
+                    readonly network: {
+                        readonly type: "boolean";
+                        readonly description: "Whether the group is a network group, which relays further.";
+                    };
+                    readonly relayed: {
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/$defs/Receipt";
+                        };
+                        readonly description: "The receipts the network group's own relay returned.";
+                    };
+                };
+            };
+            readonly DeliveryStatus: {
+                readonly type: "string";
+                readonly enum: readonly ["delivered", "duplicate", "refused", "queued", "failed"];
+                readonly description: "What happened to one delivery. `queued` will be retried.";
+            };
+            readonly Did: {
+                readonly type: "string";
+                readonly pattern: "^did:[a-z0-9]+:.+$";
+                readonly maxLength: 2048;
+                readonly description: "A DID.";
+            };
+            readonly Credential: {
+                readonly type: "object";
+                readonly description: "A DTG credential (W3C VC 2.0, JSON) exactly as signed. Verified by the party relying on it, never by its shape here: it is an open object so a binding cannot narrow away a member the proof covers.";
+            };
+            readonly RoleName: {
+                readonly type: "string";
+                readonly pattern: "^[a-z0-9_-]{1,64}$";
+                readonly description: "A role's name: 1–64 lowercase letters, digits, `-` or `_`.";
+            };
+        };
+    };
+};
+//# sourceMappingURL=payload.d.ts.map