jacquard-api 0.11.0

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

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: place.stream.branding.deleteBlob
//
// 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;
use jacquard_common::types::string::Did;
use jacquard_derive::{IntoStatic, lexicon, open_union};
use serde::{Serialize, Deserialize};

#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic, Default)]
#[serde(rename_all = "camelCase")]
pub struct DeleteBlob<'a> {
    ///DID of the broadcaster. If not provided, uses the server's default broadcaster.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub broadcaster: Option<Did<'a>>,
    ///Branding asset key (mainLogo, favicon, siteTitle, etc.)
    #[serde(borrow)]
    pub key: CowStr<'a>,
}


#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct DeleteBlobOutput<'a> {
    pub success: bool,
}


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

#[serde(tag = "error", content = "message")]
#[serde(bound(deserialize = "'de: 'a"))]
pub enum DeleteBlobError<'a> {
    /// The authenticated DID is not authorized to modify branding
    #[serde(rename = "Unauthorized")]
    Unauthorized(Option<CowStr<'a>>),
    /// The requested branding asset does not exist
    #[serde(rename = "BrandingNotFound")]
    BrandingNotFound(Option<CowStr<'a>>),
}

impl core::fmt::Display for DeleteBlobError<'_> {
    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::BrandingNotFound(msg) => {
                write!(f, "BrandingNotFound")?;
                if let Some(msg) = msg {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
            Self::Unknown(err) => write!(f, "Unknown error: {:?}", err),
        }
    }
}

/// Response type for place.stream.branding.deleteBlob
pub struct DeleteBlobResponse;
impl jacquard_common::xrpc::XrpcResp for DeleteBlobResponse {
    const NSID: &'static str = "place.stream.branding.deleteBlob";
    const ENCODING: &'static str = "application/json";
    type Output<'de> = DeleteBlobOutput<'de>;
    type Err<'de> = DeleteBlobError<'de>;
}

impl<'a> jacquard_common::xrpc::XrpcRequest for DeleteBlob<'a> {
    const NSID: &'static str = "place.stream.branding.deleteBlob";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Response = DeleteBlobResponse;
}

/// Endpoint type for place.stream.branding.deleteBlob
pub struct DeleteBlobRequest;
impl jacquard_common::xrpc::XrpcEndpoint for DeleteBlobRequest {
    const PATH: &'static str = "/xrpc/place.stream.branding.deleteBlob";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Request<'de> = DeleteBlob<'de>;
    type Response = DeleteBlobResponse;
}