jacquard-api 0.12.0-beta.1

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

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: place.stream.branding.updateBlob
//
// This file was automatically generated from Lexicon schemas.
// Any manual changes will be overwritten on the next regeneration.

#[allow(unused_imports)]
use alloc::collections::BTreeMap;

#[allow(unused_imports)]
use core::marker::PhantomData;
use jacquard_common::{CowStr, BosStr, DefaultStr, FromStaticStr};
use jacquard_common::deps::smol_str::SmolStr;
use jacquard_common::types::string::Did;
use jacquard_common::types::value::Data;
use jacquard_derive::{IntoStatic, open_union};
use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic, Default)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct UpdateBlob<S: BosStr = DefaultStr> {
    ///DID of the broadcaster. If not provided, uses the server's default broadcaster.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub broadcaster: Option<Did<S>>,
    ///Base64-encoded blob data
    pub data: S,
    ///Image height in pixels (optional, for images only)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub height: Option<i64>,
    ///Branding asset key (mainLogo, favicon, siteTitle, etc.)
    pub key: S,
    ///MIME type of the blob (e.g., image/png, text/plain)
    pub mime_type: S,
    ///Image width in pixels (optional, for images only)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub width: Option<i64>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}


#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct UpdateBlobOutput<S: BosStr = DefaultStr> {
    pub success: bool,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}


#[derive(
    Serialize,
    Deserialize,
    Debug,
    Clone,
    PartialEq,
    Eq,
    thiserror::Error,
    miette::Diagnostic
)]

#[serde(tag = "error", content = "message")]
pub enum UpdateBlobError {
    /// The authenticated DID is not authorized to modify branding
    #[serde(rename = "Unauthorized")]
    Unauthorized(Option<SmolStr>),
    /// The blob exceeds the maximum size limit
    #[serde(rename = "BlobTooLarge")]
    BlobTooLarge(Option<SmolStr>),
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other { error: SmolStr, message: Option<SmolStr> },
}

impl core::fmt::Display for UpdateBlobError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::Unauthorized(msg) => {
                write!(f, "Unauthorized")?;
                if let Some(msg) = msg {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
            Self::BlobTooLarge(msg) => {
                write!(f, "BlobTooLarge")?;
                if let Some(msg) = msg {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
            Self::Other { error, message } => {
                write!(f, "{}", error)?;
                if let Some(msg) = message {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
        }
    }
}

/// Response type for place.stream.branding.updateBlob
pub struct UpdateBlobResponse;
impl jacquard_common::xrpc::XrpcResp for UpdateBlobResponse {
    const NSID: &'static str = "place.stream.branding.updateBlob";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = UpdateBlobOutput<S>;
    type Err = UpdateBlobError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for UpdateBlob<S> {
    const NSID: &'static str = "place.stream.branding.updateBlob";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Response = UpdateBlobResponse;
}

/// Endpoint type for place.stream.branding.updateBlob
pub struct UpdateBlobRequest;
impl jacquard_common::xrpc::XrpcEndpoint for UpdateBlobRequest {
    const PATH: &'static str = "/xrpc/place.stream.branding.updateBlob";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Request<S: BosStr> = UpdateBlob<S>;
    type Response = UpdateBlobResponse;
}