//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `messaging/account/add`. Version: `0.1`.
#[allow(unused_imports)]
use serde::{Deserialize, Serialize};
/// Error types.
pub mod error {
/// Error from a `TryFrom` or `FromStr` implementation.
pub struct ConversionError(::std::borrow::Cow<'static, str>);
impl ::std::error::Error for ConversionError {}
impl ::std::fmt::Display for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Display::fmt(&self.0, f)
}
}
impl ::std::fmt::Debug for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Debug::fmt(&self.0, f)
}
}
impl From<&'static str> for ConversionError {
fn from(value: &'static str) -> Self {
Self(value.into())
}
}
impl From<String> for ConversionError {
fn from(value: String) -> Self {
Self(value.into())
}
}
}
///The mediator's view of one served account.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Account",
/// "description": "The mediator's view of one served account.",
/// "type": "object",
/// "required": [
/// "accountType",
/// "acl",
/// "did"
/// ],
/// "properties": {
/// "accessListCount": {
/// "description": "Number of entries in the account's access list.",
/// "type": "integer",
/// "minimum": 0.0
/// },
/// "accountType": {
/// "$ref": "#/definitions/AccountType"
/// },
/// "acl": {
/// "$ref": "#/definitions/MediatorAcl"
/// },
/// "did": {
/// "description": "The account's controlling DID.",
/// "$ref": "#/definitions/Vid"
/// },
/// "queueLimits": {
/// "$ref": "#/definitions/QueueLimits"
/// },
/// "receiveQueueBytes": {
/// "description": "Current byte size of queued receive messages.",
/// "type": "integer",
/// "minimum": 0.0
/// },
/// "receiveQueueCount": {
/// "description": "Current count of queued receive messages.",
/// "type": "integer",
/// "minimum": 0.0
/// },
/// "sendQueueBytes": {
/// "description": "Current byte size of queued send messages.",
/// "type": "integer",
/// "minimum": 0.0
/// },
/// "sendQueueCount": {
/// "description": "Current count of queued send messages.",
/// "type": "integer",
/// "minimum": 0.0
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct Account {
///Number of entries in the account's access list.
#[serde(
rename = "accessListCount",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub access_list_count: ::std::option::Option<u64>,
#[serde(rename = "accountType")]
pub account_type: AccountType,
pub acl: MediatorAcl,
///The account's controlling DID.
pub did: Vid,
#[serde(
rename = "queueLimits",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub queue_limits: ::std::option::Option<QueueLimits>,
///Current byte size of queued receive messages.
#[serde(
rename = "receiveQueueBytes",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub receive_queue_bytes: ::std::option::Option<u64>,
///Current count of queued receive messages.
#[serde(
rename = "receiveQueueCount",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub receive_queue_count: ::std::option::Option<u64>,
///Current byte size of queued send messages.
#[serde(
rename = "sendQueueBytes",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub send_queue_bytes: ::std::option::Option<u64>,
///Current count of queued send messages.
#[serde(
rename = "sendQueueCount",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub send_queue_count: ::std::option::Option<u64>,
}
///The account's role at the mediator. `standard` is an ordinary served account; `admin`/`rootAdmin` may administer other accounts; `mediator` is the mediator's own account. Only a rootAdmin may assign or modify the rootAdmin role.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "AccountType",
/// "description": "The account's role at the mediator. `standard` is an ordinary served account; `admin`/`rootAdmin` may administer other accounts; `mediator` is the mediator's own account. Only a rootAdmin may assign or modify the rootAdmin role.",
/// "type": "string",
/// "enum": [
/// "standard",
/// "admin",
/// "rootAdmin",
/// "mediator"
/// ]
///}
/// ```
/// </details>
#[derive(
::serde::Deserialize,
::serde::Serialize,
Clone,
Copy,
Debug,
Eq,
Hash,
Ord,
PartialEq,
PartialOrd,
)]
pub enum AccountType {
#[serde(rename = "standard")]
Standard,
#[serde(rename = "admin")]
Admin,
#[serde(rename = "rootAdmin")]
RootAdmin,
#[serde(rename = "mediator")]
Mediator,
}
impl ::std::fmt::Display for AccountType {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
match *self {
Self::Standard => f.write_str("standard"),
Self::Admin => f.write_str("admin"),
Self::RootAdmin => f.write_str("rootAdmin"),
Self::Mediator => f.write_str("mediator"),
}
}
}
impl ::std::str::FromStr for AccountType {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
match value {
"standard" => Ok(Self::Standard),
"admin" => Ok(Self::Admin),
"rootAdmin" => Ok(Self::RootAdmin),
"mediator" => Ok(Self::Mediator),
_ => Err("invalid value".into()),
}
}
}
impl ::std::convert::TryFrom<&str> for AccountType {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for AccountType {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for AccountType {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
///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.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Ext",
/// "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.",
/// "type": "object",
/// "minProperties": 1,
/// "additionalProperties": true,
/// "propertyNames": {
/// "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
/// }
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(transparent)]
pub struct Ext(pub ::std::collections::HashMap<ExtKey, ::serde_json::Value>);
impl ::std::ops::Deref for Ext {
type Target = ::std::collections::HashMap<ExtKey, ::serde_json::Value>;
fn deref(&self) -> &::std::collections::HashMap<ExtKey, ::serde_json::Value> {
&self.0
}
}
impl ::std::convert::From<Ext> for ::std::collections::HashMap<ExtKey, ::serde_json::Value> {
fn from(value: Ext) -> Self {
value.0
}
}
impl ::std::convert::From<::std::collections::HashMap<ExtKey, ::serde_json::Value>> for Ext {
fn from(value: ::std::collections::HashMap<ExtKey, ::serde_json::Value>) -> Self {
Self(value)
}
}
///`ExtKey`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ExtKey(::std::string::String);
impl ::std::ops::Deref for ExtKey {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ExtKey> for ::std::string::String {
fn from(value: ExtKey) -> Self {
value.0
}
}
impl ::std::str::FromStr for ExtKey {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| {
::regress::Regex::new("^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$").unwrap()
});
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for ExtKey {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for ExtKey {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for ExtKey {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for ExtKey {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
///The mediator's per-account access-control capability set, expressed as named booleans (the transport-agnostic form of the mediator's internal capability flags). On a set request, members omitted are left unchanged; a get/response carries the full realized set.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "MediatorAcl",
/// "description": "The mediator's per-account access-control capability set, expressed as named booleans (the transport-agnostic form of the mediator's internal capability flags). On a set request, members omitted are left unchanged; a get/response carries the full realized set.",
/// "type": "object",
/// "properties": {
/// "accessListMode": {
/// "description": "How the account's access list is interpreted. `explicitAllow` = an allowlist (empty denies everyone); `explicitDeny` = a denylist (empty allows everyone).",
/// "type": "string",
/// "enum": [
/// "explicitAllow",
/// "explicitDeny"
/// ]
/// },
/// "anonReceive": {
/// "description": "Accepts anonymous (no authenticated sender) messages.",
/// "type": "boolean"
/// },
/// "blocked": {
/// "description": "The account is blocked from authenticating and transacting.",
/// "type": "boolean"
/// },
/// "createInvites": {
/// "description": "May create out-of-band invitations.",
/// "type": "boolean"
/// },
/// "didcommEnabled": {
/// "description": "The account accepts DIDComm-protocol delivery. Default true; set false for a TSP-only node.",
/// "type": "boolean"
/// },
/// "local": {
/// "description": "Messages for this account may be stored locally at this mediator for pickup.",
/// "type": "boolean"
/// },
/// "receiveForwarded": {
/// "description": "May be the next hop of a forwarded message.",
/// "type": "boolean"
/// },
/// "receiveMessages": {
/// "description": "May receive direct messages.",
/// "type": "boolean"
/// },
/// "selfManageList": {
/// "description": "May self-manage its own access list.",
/// "type": "boolean"
/// },
/// "selfManageReceiveQueueLimit": {
/// "description": "May self-manage its own receive-queue limit.",
/// "type": "boolean"
/// },
/// "selfManageSendQueueLimit": {
/// "description": "May self-manage its own send-queue limit.",
/// "type": "boolean"
/// },
/// "sendForwarded": {
/// "description": "May send routing/forward (relay) messages.",
/// "type": "boolean"
/// },
/// "sendMessages": {
/// "description": "May send direct messages through the mediator.",
/// "type": "boolean"
/// },
/// "tspEnabled": {
/// "description": "The account accepts TSP-protocol delivery. Default true; set false for a DIDComm-only node.",
/// "type": "boolean"
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct MediatorAcl {
///How the account's access list is interpreted. `explicitAllow` = an allowlist (empty denies everyone); `explicitDeny` = a denylist (empty allows everyone).
#[serde(
rename = "accessListMode",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub access_list_mode: ::std::option::Option<MediatorAclAccessListMode>,
///Accepts anonymous (no authenticated sender) messages.
#[serde(
rename = "anonReceive",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub anon_receive: ::std::option::Option<bool>,
///The account is blocked from authenticating and transacting.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub blocked: ::std::option::Option<bool>,
///May create out-of-band invitations.
#[serde(
rename = "createInvites",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub create_invites: ::std::option::Option<bool>,
///The account accepts DIDComm-protocol delivery. Default true; set false for a TSP-only node.
#[serde(
rename = "didcommEnabled",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub didcomm_enabled: ::std::option::Option<bool>,
///Messages for this account may be stored locally at this mediator for pickup.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub local: ::std::option::Option<bool>,
///May be the next hop of a forwarded message.
#[serde(
rename = "receiveForwarded",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub receive_forwarded: ::std::option::Option<bool>,
///May receive direct messages.
#[serde(
rename = "receiveMessages",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub receive_messages: ::std::option::Option<bool>,
///May self-manage its own access list.
#[serde(
rename = "selfManageList",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub self_manage_list: ::std::option::Option<bool>,
///May self-manage its own receive-queue limit.
#[serde(
rename = "selfManageReceiveQueueLimit",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub self_manage_receive_queue_limit: ::std::option::Option<bool>,
///May self-manage its own send-queue limit.
#[serde(
rename = "selfManageSendQueueLimit",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub self_manage_send_queue_limit: ::std::option::Option<bool>,
///May send routing/forward (relay) messages.
#[serde(
rename = "sendForwarded",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub send_forwarded: ::std::option::Option<bool>,
///May send direct messages through the mediator.
#[serde(
rename = "sendMessages",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub send_messages: ::std::option::Option<bool>,
///The account accepts TSP-protocol delivery. Default true; set false for a DIDComm-only node.
#[serde(
rename = "tspEnabled",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub tsp_enabled: ::std::option::Option<bool>,
}
impl ::std::default::Default for MediatorAcl {
fn default() -> Self {
Self {
access_list_mode: Default::default(),
anon_receive: Default::default(),
blocked: Default::default(),
create_invites: Default::default(),
didcomm_enabled: Default::default(),
local: Default::default(),
receive_forwarded: Default::default(),
receive_messages: Default::default(),
self_manage_list: Default::default(),
self_manage_receive_queue_limit: Default::default(),
self_manage_send_queue_limit: Default::default(),
send_forwarded: Default::default(),
send_messages: Default::default(),
tsp_enabled: Default::default(),
}
}
}
///How the account's access list is interpreted. `explicitAllow` = an allowlist (empty denies everyone); `explicitDeny` = a denylist (empty allows everyone).
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "How the account's access list is interpreted. `explicitAllow` = an allowlist (empty denies everyone); `explicitDeny` = a denylist (empty allows everyone).",
/// "type": "string",
/// "enum": [
/// "explicitAllow",
/// "explicitDeny"
/// ]
///}
/// ```
/// </details>
#[derive(
::serde::Deserialize,
::serde::Serialize,
Clone,
Copy,
Debug,
Eq,
Hash,
Ord,
PartialEq,
PartialOrd,
)]
pub enum MediatorAclAccessListMode {
#[serde(rename = "explicitAllow")]
ExplicitAllow,
#[serde(rename = "explicitDeny")]
ExplicitDeny,
}
impl ::std::fmt::Display for MediatorAclAccessListMode {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
match *self {
Self::ExplicitAllow => f.write_str("explicitAllow"),
Self::ExplicitDeny => f.write_str("explicitDeny"),
}
}
}
impl ::std::str::FromStr for MediatorAclAccessListMode {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
match value {
"explicitAllow" => Ok(Self::ExplicitAllow),
"explicitDeny" => Ok(Self::ExplicitDeny),
_ => Err("invalid value".into()),
}
}
}
impl ::std::convert::TryFrom<&str> for MediatorAclAccessListMode {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for MediatorAclAccessListMode {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for MediatorAclAccessListMode {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
///`Payload`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "$id": "https://trusttasks.org/spec/messaging/account/add/0.1",
/// "title": "Payload",
/// "type": "object",
/// "required": [
/// "did"
/// ],
/// "properties": {
/// "accountType": {
/// "description": "The role to assign the new account. Defaults to `standard`; assigning a non-standard role requires administrative standing (only a rootAdmin may assign rootAdmin).",
/// "default": "standard",
/// "$ref": "#/definitions/AccountType"
/// },
/// "acl": {
/// "description": "Initial access-control capabilities. Members omitted take the mediator's configured defaults.",
/// "$ref": "#/definitions/MediatorAcl"
/// },
/// "did": {
/// "description": "The DID of the account to register.",
/// "$ref": "#/definitions/Vid"
/// },
/// "ext": {
/// "description": "Ecosystem-defined extension members per SPEC.md §4.5.1.",
/// "$ref": "#/definitions/Ext"
/// },
/// "queueLimits": {
/// "description": "Initial queued-message limits. Members omitted take the mediator's configured defaults.",
/// "$ref": "#/definitions/QueueLimits"
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct Payload {
///The role to assign the new account. Defaults to `standard`; assigning a non-standard role requires administrative standing (only a rootAdmin may assign rootAdmin).
#[serde(rename = "accountType", default = "defaults::payload_account_type")]
pub account_type: AccountType,
///Initial access-control capabilities. Members omitted take the mediator's configured defaults.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub acl: ::std::option::Option<MediatorAcl>,
///The DID of the account to register.
pub did: Vid,
///Ecosystem-defined extension members per SPEC.md §4.5.1.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///Initial queued-message limits. Members omitted take the mediator's configured defaults.
#[serde(
rename = "queueLimits",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub queue_limits: ::std::option::Option<QueueLimits>,
}
///Per-account queued-message limits. A value of -1 means unlimited; a member omitted on a change request leaves that limit unchanged.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "QueueLimits",
/// "description": "Per-account queued-message limits. A value of -1 means unlimited; a member omitted on a change request leaves that limit unchanged.",
/// "type": "object",
/// "properties": {
/// "receiveQueueLimit": {
/// "description": "Maximum queued receive messages; -1 = unlimited.",
/// "type": "integer",
/// "minimum": -1.0
/// },
/// "sendQueueLimit": {
/// "description": "Maximum queued send messages; -1 = unlimited.",
/// "type": "integer",
/// "minimum": -1.0
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct QueueLimits {
///Maximum queued receive messages; -1 = unlimited.
#[serde(
rename = "receiveQueueLimit",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub receive_queue_limit: ::std::option::Option<i64>,
///Maximum queued send messages; -1 = unlimited.
#[serde(
rename = "sendQueueLimit",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub send_queue_limit: ::std::option::Option<i64>,
}
impl ::std::default::Default for QueueLimits {
fn default() -> Self {
Self {
receive_queue_limit: Default::default(),
send_queue_limit: Default::default(),
}
}
}
///The success response to a messaging/account/add request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/account/add/0.1#response.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Response",
/// "description": "The success response to a messaging/account/add request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/account/add/0.1#response.",
/// "type": "object",
/// "required": [
/// "account"
/// ],
/// "properties": {
/// "account": {
/// "description": "The full realized mediator view of the newly created account.",
/// "$ref": "#/definitions/Account"
/// },
/// "ext": {
/// "description": "Ecosystem-defined extension members per SPEC.md §4.5.1.",
/// "$ref": "#/definitions/Ext"
/// }
/// },
/// "additionalProperties": false,
/// "$anchor": "response"
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct Response {
///The full realized mediator view of the newly created account.
pub account: Account,
///Ecosystem-defined extension members per SPEC.md §4.5.1.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
}
///A Verifiable Identifier (SPEC §4.8). For a mediator-served account this is the account's controlling DID; carried verbatim and compared by exact string equality.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Vid",
/// "description": "A Verifiable Identifier (SPEC §4.8). For a mediator-served account this is the account's controlling DID; carried verbatim and compared by exact string equality.",
/// "type": "string",
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct Vid(::std::string::String);
impl ::std::ops::Deref for Vid {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<Vid> for ::std::string::String {
fn from(value: Vid) -> Self {
value.0
}
}
impl ::std::str::FromStr for Vid {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for Vid {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for Vid {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for Vid {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for Vid {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
/// Generation of default values for serde.
pub mod defaults {
pub(super) fn payload_account_type() -> super::AccountType {
super::AccountType::Standard
}
}
impl crate::Payload for Payload {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/messaging/account/add/0.1";
const IS_PROOF_REQUIRED: bool = true;
const IS_RECIPIENT_REQUIRED: bool = true;
}
impl crate::Payload for Response {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/messaging/account/add/0.1#response";
const IS_PROOF_REQUIRED: bool = true;
const IS_RECIPIENT_REQUIRED: bool = true;
}
#[cfg(feature = "validate")]
impl crate::validate::ValidatedPayload for Payload {
const SCHEMA_JSON: &'static str = "{\n \"$defs\": {\n \"Account\": {\n \"additionalProperties\": false,\n \"description\": \"The mediator's view of one served account.\",\n \"properties\": {\n \"accessListCount\": {\n \"description\": \"Number of entries in the account's access list.\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"accountType\": {\n \"$ref\": \"#/$defs/AccountType\"\n },\n \"acl\": {\n \"$ref\": \"#/$defs/MediatorAcl\"\n },\n \"did\": {\n \"$ref\": \"#/$defs/Vid\",\n \"description\": \"The account's controlling DID.\"\n },\n \"queueLimits\": {\n \"$ref\": \"#/$defs/QueueLimits\"\n },\n \"receiveQueueBytes\": {\n \"description\": \"Current byte size of queued receive messages.\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"receiveQueueCount\": {\n \"description\": \"Current count of queued receive messages.\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sendQueueBytes\": {\n \"description\": \"Current byte size of queued send messages.\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"sendQueueCount\": {\n \"description\": \"Current count of queued send messages.\",\n \"minimum\": 0,\n \"type\": \"integer\"\n }\n },\n \"required\": [\n \"did\",\n \"accountType\",\n \"acl\"\n ],\n \"title\": \"Account\",\n \"type\": \"object\"\n },\n \"AccountType\": {\n \"description\": \"The account's role at the mediator. `standard` is an ordinary served account; `admin`/`rootAdmin` may administer other accounts; `mediator` is the mediator's own account. Only a rootAdmin may assign or modify the rootAdmin role.\",\n \"enum\": [\n \"standard\",\n \"admin\",\n \"rootAdmin\",\n \"mediator\"\n ],\n \"title\": \"AccountType\",\n \"type\": \"string\"\n },\n \"Ext\": {\n \"additionalProperties\": true,\n \"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.\",\n \"minProperties\": 1,\n \"propertyNames\": {\n \"pattern\": \"^[a-z][a-z0-9-]*(\\\\.[a-z0-9-]+)+$\"\n },\n \"title\": \"Ext\",\n \"type\": \"object\"\n },\n \"MediatorAcl\": {\n \"additionalProperties\": false,\n \"description\": \"The mediator's per-account access-control capability set, expressed as named booleans (the transport-agnostic form of the mediator's internal capability flags). On a set request, members omitted are left unchanged; a get/response carries the full realized set.\",\n \"properties\": {\n \"accessListMode\": {\n \"description\": \"How the account's access list is interpreted. `explicitAllow` = an allowlist (empty denies everyone); `explicitDeny` = a denylist (empty allows everyone).\",\n \"enum\": [\n \"explicitAllow\",\n \"explicitDeny\"\n ],\n \"type\": \"string\"\n },\n \"anonReceive\": {\n \"description\": \"Accepts anonymous (no authenticated sender) messages.\",\n \"type\": \"boolean\"\n },\n \"blocked\": {\n \"description\": \"The account is blocked from authenticating and transacting.\",\n \"type\": \"boolean\"\n },\n \"createInvites\": {\n \"description\": \"May create out-of-band invitations.\",\n \"type\": \"boolean\"\n },\n \"didcommEnabled\": {\n \"description\": \"The account accepts DIDComm-protocol delivery. Default true; set false for a TSP-only node.\",\n \"type\": \"boolean\"\n },\n \"local\": {\n \"description\": \"Messages for this account may be stored locally at this mediator for pickup.\",\n \"type\": \"boolean\"\n },\n \"receiveForwarded\": {\n \"description\": \"May be the next hop of a forwarded message.\",\n \"type\": \"boolean\"\n },\n \"receiveMessages\": {\n \"description\": \"May receive direct messages.\",\n \"type\": \"boolean\"\n },\n \"selfManageList\": {\n \"description\": \"May self-manage its own access list.\",\n \"type\": \"boolean\"\n },\n \"selfManageReceiveQueueLimit\": {\n \"description\": \"May self-manage its own receive-queue limit.\",\n \"type\": \"boolean\"\n },\n \"selfManageSendQueueLimit\": {\n \"description\": \"May self-manage its own send-queue limit.\",\n \"type\": \"boolean\"\n },\n \"sendForwarded\": {\n \"description\": \"May send routing/forward (relay) messages.\",\n \"type\": \"boolean\"\n },\n \"sendMessages\": {\n \"description\": \"May send direct messages through the mediator.\",\n \"type\": \"boolean\"\n },\n \"tspEnabled\": {\n \"description\": \"The account accepts TSP-protocol delivery. Default true; set false for a DIDComm-only node.\",\n \"type\": \"boolean\"\n }\n },\n \"title\": \"MediatorAcl\",\n \"type\": \"object\"\n },\n \"QueueLimits\": {\n \"additionalProperties\": false,\n \"description\": \"Per-account queued-message limits. A value of -1 means unlimited; a member omitted on a change request leaves that limit unchanged.\",\n \"properties\": {\n \"receiveQueueLimit\": {\n \"description\": \"Maximum queued receive messages; -1 = unlimited.\",\n \"minimum\": -1,\n \"type\": \"integer\"\n },\n \"sendQueueLimit\": {\n \"description\": \"Maximum queued send messages; -1 = unlimited.\",\n \"minimum\": -1,\n \"type\": \"integer\"\n }\n },\n \"title\": \"QueueLimits\",\n \"type\": \"object\"\n },\n \"Response\": {\n \"$anchor\": \"response\",\n \"additionalProperties\": false,\n \"description\": \"The success response to a messaging/account/add request. Carried in a Trust Task document whose type is https://trusttasks.org/spec/messaging/account/add/0.1#response.\",\n \"properties\": {\n \"account\": {\n \"$ref\": \"#/$defs/Account\",\n \"description\": \"The full realized mediator view of the newly created account.\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\",\n \"description\": \"Ecosystem-defined extension members per SPEC.md §4.5.1.\"\n }\n },\n \"required\": [\n \"account\"\n ],\n \"title\": \"Messaging Add Account — response payload\",\n \"type\": \"object\"\n },\n \"Vid\": {\n \"description\": \"A Verifiable Identifier (SPEC §4.8). For a mediator-served account this is the account's controlling DID; carried verbatim and compared by exact string equality.\",\n \"minLength\": 1,\n \"title\": \"Vid\",\n \"type\": \"string\"\n }\n },\n \"$id\": \"https://trusttasks.org/spec/messaging/account/add/0.1\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"additionalProperties\": false,\n \"properties\": {\n \"accountType\": {\n \"$ref\": \"#/$defs/AccountType\",\n \"default\": \"standard\",\n \"description\": \"The role to assign the new account. Defaults to `standard`; assigning a non-standard role requires administrative standing (only a rootAdmin may assign rootAdmin).\"\n },\n \"acl\": {\n \"$ref\": \"#/$defs/MediatorAcl\",\n \"description\": \"Initial access-control capabilities. Members omitted take the mediator's configured defaults.\"\n },\n \"did\": {\n \"$ref\": \"#/$defs/Vid\",\n \"description\": \"The DID of the account to register.\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\",\n \"description\": \"Ecosystem-defined extension members per SPEC.md §4.5.1.\"\n },\n \"queueLimits\": {\n \"$ref\": \"#/$defs/QueueLimits\",\n \"description\": \"Initial queued-message limits. Members omitted take the mediator's configured defaults.\"\n }\n },\n \"required\": [\n \"did\"\n ],\n \"title\": \"Messaging Add Account — payload\",\n \"type\": \"object\"\n}\n";
}
#[cfg(test)]
mod conformance {
//! Round-trip tests harvested from the spec's `spec.md`,
//! plus a `rejects_invalid_examples` test for any fixtures
//! in `payload.invalid-examples.json` (validate feature).
#[test]
fn request_example_1() {
const JSON: &str = "{\n \"id\": \"4f3c9e2a-1b81-4d3e-9b51-7a3c89e3d1f2\",\n \"type\": \"https://trusttasks.org/spec/messaging/account/add/0.1\",\n \"issuer\": \"did:web:admin.example\",\n \"recipient\": \"did:web:mediator.example\",\n \"issuedAt\": \"2026-06-22T10:00:00Z\",\n \"payload\": {\n \"did\": \"did:web:alice.example\",\n \"accountType\": \"standard\",\n \"acl\": {\n \"sendMessages\": true,\n \"receiveMessages\": true\n },\n \"queueLimits\": {\n \"sendQueueLimit\": 1000,\n \"receiveQueueLimit\": 1000\n }\n },\n \"proof\": {\n \"type\": \"DataIntegrityProof\",\n \"cryptosuite\": \"eddsa-rdfc-2022\",\n \"verificationMethod\": \"did:web:admin.example#key-1\",\n \"created\": \"2026-06-22T10:00:00Z\",\n \"proofPurpose\": \"assertionMethod\",\n \"proofValue\": \"z3kg...\"\n }\n}\n";
let doc: crate::TrustTask<super::Payload> =
serde_json::from_str(JSON).expect("deserialize request example");
let rendered = serde_json::to_value(&doc).expect("re-serialize");
let expected: serde_json::Value = serde_json::from_str(JSON).expect("re-parse expected");
assert_eq!(rendered, expected, "request example failed round-trip");
}
#[test]
fn response_example_1() {
const JSON: &str = "{\n \"id\": \"5e3c9e2a-1b81-4d3e-9b51-7a3c89e3d1f3\",\n \"type\": \"https://trusttasks.org/spec/messaging/account/add/0.1#response\",\n \"threadId\": \"4f3c9e2a-1b81-4d3e-9b51-7a3c89e3d1f2\",\n \"issuer\": \"did:web:mediator.example\",\n \"recipient\": \"did:web:admin.example\",\n \"issuedAt\": \"2026-06-22T10:00:01Z\",\n \"payload\": {\n \"account\": {\n \"did\": \"did:web:alice.example\",\n \"accountType\": \"standard\",\n \"acl\": {\n \"accessListMode\": \"explicitDeny\",\n \"blocked\": false,\n \"local\": true,\n \"sendMessages\": true,\n \"receiveMessages\": true,\n \"sendForwarded\": false,\n \"receiveForwarded\": true,\n \"createInvites\": false,\n \"anonReceive\": false,\n \"selfManageList\": false,\n \"selfManageSendQueueLimit\": false,\n \"selfManageReceiveQueueLimit\": false,\n \"didcommEnabled\": true,\n \"tspEnabled\": true\n },\n \"queueLimits\": {\n \"sendQueueLimit\": 1000,\n \"receiveQueueLimit\": 1000\n },\n \"sendQueueCount\": 0,\n \"receiveQueueCount\": 0,\n \"accessListCount\": 0\n }\n }\n}\n";
let doc: crate::TrustTask<super::Response> =
serde_json::from_str(JSON).expect("deserialize response example");
let rendered = serde_json::to_value(&doc).expect("re-serialize");
let expected: serde_json::Value = serde_json::from_str(JSON).expect("re-parse expected");
assert_eq!(rendered, expected, "response example failed round-trip");
}
}