jacquard-api 0.12.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
131
132

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: place.stream.server.upsertStorage
//
// 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;

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

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic, Default)]
#[serde(
    rename_all = "camelCase",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct UpsertStorage<S: BosStr = DefaultStr> {
    ///Whether backup storage is currently active.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub is_active: Option<bool>,
    ///S3 storage URL in format: s3+https://ACCESS_KEY:SECRET_KEY@endpoint/bucket
    #[serde(skip_serializing_if = "Option::is_none")]
    pub url: Option<S>,
    #[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 UpsertStorageOutput<S: BosStr = DefaultStr> {
    pub storage: Storage<S>,
    #[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 UpsertStorageError {
    /// The provided S3 URL is invalid or malformed.
    #[serde(rename = "InvalidUrl")]
    InvalidUrl(Option<SmolStr>),
    /// Could not connect to the S3 endpoint with the provided credentials.
    #[serde(rename = "ConnectionFailed")]
    ConnectionFailed(Option<SmolStr>),
    /// Cannot modify URL while keeping masked credentials. Provide full credentials or omit URL to keep existing configuration.
    #[serde(rename = "MaskedCredentialsModified")]
    MaskedCredentialsModified(Option<SmolStr>),
    /// Catch-all for unknown error codes.
    #[serde(untagged)]
    Other {
        error: SmolStr,
        message: Option<SmolStr>,
    },
}

impl core::fmt::Display for UpsertStorageError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::InvalidUrl(msg) => {
                write!(f, "InvalidUrl")?;
                if let Some(msg) = msg {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
            Self::ConnectionFailed(msg) => {
                write!(f, "ConnectionFailed")?;
                if let Some(msg) = msg {
                    write!(f, ": {}", msg)?;
                }
                Ok(())
            }
            Self::MaskedCredentialsModified(msg) => {
                write!(f, "MaskedCredentialsModified")?;
                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 marker for the `place.stream.server.upsertStorage` procedure.

Implements `jacquard_common::xrpc::XrpcResp`; successful bodies decode as `Self::Output<S>`, which is `UpsertStorageOutput<S>` for this endpoint.*/
pub struct UpsertStorageResponse;
impl jacquard_common::xrpc::XrpcResp for UpsertStorageResponse {
    const NSID: &'static str = "place.stream.server.upsertStorage";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = UpsertStorageOutput<S>;
    type Err = UpsertStorageError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for UpsertStorage<S> {
    const NSID: &'static str = "place.stream.server.upsertStorage";
    const METHOD: jacquard_common::xrpc::XrpcMethod =
        jacquard_common::xrpc::XrpcMethod::Procedure("application/json");
    type Response = UpsertStorageResponse;
}

/** Endpoint marker for the `place.stream.server.upsertStorage` procedure.

Path: `/xrpc/place.stream.server.upsertStorage`. The request payload type is `UpsertStorage<S>`; send that request with `jacquard::Client` or use this marker through lower-level `XrpcEndpoint` APIs.*/
pub struct UpsertStorageRequest;
impl jacquard_common::xrpc::XrpcEndpoint for UpsertStorageRequest {
    const PATH: &'static str = "/xrpc/place.stream.server.upsertStorage";
    const METHOD: jacquard_common::xrpc::XrpcMethod =
        jacquard_common::xrpc::XrpcMethod::Procedure("application/json");
    type Request<S: BosStr> = UpsertStorage<S>;
    type Response = UpsertStorageResponse;
}