jacquard-api 0.12.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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: network.slices.slice.createOAuthClient
//
// 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::UriValue;
use jacquard_common::types::value::Data;
use jacquard_derive::IntoStatic;
use serde::{Serialize, Deserialize};
use crate::network_slices::slice::get_o_auth_clients::OauthClientDetails;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase", bound(deserialize = "S: Deserialize<'de> + BosStr"))]
pub struct CreateOAuthClient<S: BosStr = DefaultStr> {
    ///Human-readable name of the OAuth client
    pub client_name: S,
    ///URI of the client application
    #[serde(skip_serializing_if = "Option::is_none")]
    pub client_uri: Option<UriValue<S>>,
    ///OAuth grant types
    #[serde(skip_serializing_if = "Option::is_none")]
    pub grant_types: Option<Vec<S>>,
    ///URI of the client logo
    #[serde(skip_serializing_if = "Option::is_none")]
    pub logo_uri: Option<UriValue<S>>,
    ///URI of the privacy policy
    #[serde(skip_serializing_if = "Option::is_none")]
    pub policy_uri: Option<UriValue<S>>,
    ///Allowed redirect URIs for OAuth flow (must use HTTP or HTTPS)
    pub redirect_uris: Vec<UriValue<S>>,
    ///OAuth response types
    #[serde(skip_serializing_if = "Option::is_none")]
    pub response_types: Option<Vec<S>>,
    ///OAuth scope
    #[serde(skip_serializing_if = "Option::is_none")]
    pub scope: Option<S>,
    ///AT-URI of the slice to register the OAuth client for
    pub slice_uri: S,
    ///URI of the terms of service
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tos_uri: Option<UriValue<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 CreateOAuthClientOutput<S: BosStr = DefaultStr> {
    #[serde(flatten)]
    pub value: OauthClientDetails<S>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/** Response marker for the `network.slices.slice.createOAuthClient` procedure.

Implements `jacquard_common::xrpc::XrpcResp`; successful bodies decode as `Self::Output<S>`, which is `CreateOAuthClientOutput<S>` for this endpoint.*/
pub struct CreateOAuthClientResponse;
impl jacquard_common::xrpc::XrpcResp for CreateOAuthClientResponse {
    const NSID: &'static str = "network.slices.slice.createOAuthClient";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = CreateOAuthClientOutput<S>;
    type Err = jacquard_common::xrpc::GenericError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for CreateOAuthClient<S> {
    const NSID: &'static str = "network.slices.slice.createOAuthClient";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Response = CreateOAuthClientResponse;
}

/** Endpoint marker for the `network.slices.slice.createOAuthClient` procedure.

Path: `/xrpc/network.slices.slice.createOAuthClient`. The request payload type is `CreateOAuthClient<S>`; send that request with `jacquard::Client` or use this marker through lower-level `XrpcEndpoint` APIs.*/
pub struct CreateOAuthClientRequest;
impl jacquard_common::xrpc::XrpcEndpoint for CreateOAuthClientRequest {
    const PATH: &'static str = "/xrpc/network.slices.slice.createOAuthClient";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Request<S: BosStr> = CreateOAuthClient<S>;
    type Response = CreateOAuthClientResponse;
}

pub mod create_o_auth_client_state {

    pub use crate::builder_types::{Set, Unset, IsSet, IsUnset};
    #[allow(unused)]
    use ::core::marker::PhantomData;
    mod sealed {
        pub trait Sealed {}
    }
    /// State trait tracking which required fields have been set
    pub trait State: sealed::Sealed {
        type ClientName;
        type RedirectUris;
        type SliceUri;
    }
    /// Empty state - all required fields are unset
    pub struct Empty(());
    impl sealed::Sealed for Empty {}
    impl State for Empty {
        type ClientName = Unset;
        type RedirectUris = Unset;
        type SliceUri = Unset;
    }
    ///State transition - sets the `client_name` field to Set
    pub struct SetClientName<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetClientName<St> {}
    impl<St: State> State for SetClientName<St> {
        type ClientName = Set<members::client_name>;
        type RedirectUris = St::RedirectUris;
        type SliceUri = St::SliceUri;
    }
    ///State transition - sets the `redirect_uris` field to Set
    pub struct SetRedirectUris<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetRedirectUris<St> {}
    impl<St: State> State for SetRedirectUris<St> {
        type ClientName = St::ClientName;
        type RedirectUris = Set<members::redirect_uris>;
        type SliceUri = St::SliceUri;
    }
    ///State transition - sets the `slice_uri` field to Set
    pub struct SetSliceUri<St: State = Empty>(PhantomData<fn() -> St>);
    impl<St: State> sealed::Sealed for SetSliceUri<St> {}
    impl<St: State> State for SetSliceUri<St> {
        type ClientName = St::ClientName;
        type RedirectUris = St::RedirectUris;
        type SliceUri = Set<members::slice_uri>;
    }
    /// Marker types for field names
    #[allow(non_camel_case_types)]
    pub mod members {
        ///Marker type for the `client_name` field
        pub struct client_name(());
        ///Marker type for the `redirect_uris` field
        pub struct redirect_uris(());
        ///Marker type for the `slice_uri` field
        pub struct slice_uri(());
    }
}

/// Builder for constructing an instance of this type.
pub struct CreateOAuthClientBuilder<
    St: create_o_auth_client_state::State,
    S: BosStr = DefaultStr,
> {
    _state: PhantomData<fn() -> St>,
    _fields: (
        Option<S>,
        Option<UriValue<S>>,
        Option<Vec<S>>,
        Option<UriValue<S>>,
        Option<UriValue<S>>,
        Option<Vec<UriValue<S>>>,
        Option<Vec<S>>,
        Option<S>,
        Option<S>,
        Option<UriValue<S>>,
    ),
    _type: PhantomData<fn() -> S>,
}

impl CreateOAuthClient<DefaultStr> {
    /// Create a new builder for this type, using the default string type (DefaultStr = SmolStr) if needed
    pub fn new() -> CreateOAuthClientBuilder<
        create_o_auth_client_state::Empty,
        DefaultStr,
    > {
        CreateOAuthClientBuilder::new()
    }
}

impl<S: BosStr> CreateOAuthClient<S> {
    /// Create a new builder for this type
    pub fn builder() -> CreateOAuthClientBuilder<create_o_auth_client_state::Empty, S> {
        CreateOAuthClientBuilder::builder()
    }
}

impl CreateOAuthClientBuilder<create_o_auth_client_state::Empty, DefaultStr> {
    /// Create a new builder with all fields unset, using the default string type, if needed
    pub fn new() -> Self {
        CreateOAuthClientBuilder {
            _state: PhantomData,
            _fields: (None, None, None, None, None, None, None, None, None, None),
            _type: PhantomData,
        }
    }
}

impl<S: BosStr> CreateOAuthClientBuilder<create_o_auth_client_state::Empty, S> {
    /// Create a new builder with all fields unset
    pub fn builder() -> Self {
        CreateOAuthClientBuilder {
            _state: PhantomData,
            _fields: (None, None, None, None, None, None, None, None, None, None),
            _type: PhantomData,
        }
    }
}

impl<St, S: BosStr> CreateOAuthClientBuilder<St, S>
where
    St: create_o_auth_client_state::State,
    St::ClientName: create_o_auth_client_state::IsUnset,
{
    /// Set the `clientName` field (required)
    pub fn client_name(
        mut self,
        value: impl Into<S>,
    ) -> CreateOAuthClientBuilder<create_o_auth_client_state::SetClientName<St>, S> {
        self._fields.0 = Option::Some(value.into());
        CreateOAuthClientBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<St: create_o_auth_client_state::State, S: BosStr> CreateOAuthClientBuilder<St, S> {
    /// Set the `clientUri` field (optional)
    pub fn client_uri(mut self, value: impl Into<Option<UriValue<S>>>) -> Self {
        self._fields.1 = value.into();
        self
    }
    /// Set the `clientUri` field to an Option value (optional)
    pub fn maybe_client_uri(mut self, value: Option<UriValue<S>>) -> Self {
        self._fields.1 = value;
        self
    }
}

impl<St: create_o_auth_client_state::State, S: BosStr> CreateOAuthClientBuilder<St, S> {
    /// Set the `grantTypes` field (optional)
    pub fn grant_types(mut self, value: impl Into<Option<Vec<S>>>) -> Self {
        self._fields.2 = value.into();
        self
    }
    /// Set the `grantTypes` field to an Option value (optional)
    pub fn maybe_grant_types(mut self, value: Option<Vec<S>>) -> Self {
        self._fields.2 = value;
        self
    }
}

impl<St: create_o_auth_client_state::State, S: BosStr> CreateOAuthClientBuilder<St, S> {
    /// Set the `logoUri` field (optional)
    pub fn logo_uri(mut self, value: impl Into<Option<UriValue<S>>>) -> Self {
        self._fields.3 = value.into();
        self
    }
    /// Set the `logoUri` field to an Option value (optional)
    pub fn maybe_logo_uri(mut self, value: Option<UriValue<S>>) -> Self {
        self._fields.3 = value;
        self
    }
}

impl<St: create_o_auth_client_state::State, S: BosStr> CreateOAuthClientBuilder<St, S> {
    /// Set the `policyUri` field (optional)
    pub fn policy_uri(mut self, value: impl Into<Option<UriValue<S>>>) -> Self {
        self._fields.4 = value.into();
        self
    }
    /// Set the `policyUri` field to an Option value (optional)
    pub fn maybe_policy_uri(mut self, value: Option<UriValue<S>>) -> Self {
        self._fields.4 = value;
        self
    }
}

impl<St, S: BosStr> CreateOAuthClientBuilder<St, S>
where
    St: create_o_auth_client_state::State,
    St::RedirectUris: create_o_auth_client_state::IsUnset,
{
    /// Set the `redirectUris` field (required)
    pub fn redirect_uris(
        mut self,
        value: impl Into<Vec<UriValue<S>>>,
    ) -> CreateOAuthClientBuilder<create_o_auth_client_state::SetRedirectUris<St>, S> {
        self._fields.5 = Option::Some(value.into());
        CreateOAuthClientBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<St: create_o_auth_client_state::State, S: BosStr> CreateOAuthClientBuilder<St, S> {
    /// Set the `responseTypes` field (optional)
    pub fn response_types(mut self, value: impl Into<Option<Vec<S>>>) -> Self {
        self._fields.6 = value.into();
        self
    }
    /// Set the `responseTypes` field to an Option value (optional)
    pub fn maybe_response_types(mut self, value: Option<Vec<S>>) -> Self {
        self._fields.6 = value;
        self
    }
}

impl<St: create_o_auth_client_state::State, S: BosStr> CreateOAuthClientBuilder<St, S> {
    /// Set the `scope` field (optional)
    pub fn scope(mut self, value: impl Into<Option<S>>) -> Self {
        self._fields.7 = value.into();
        self
    }
    /// Set the `scope` field to an Option value (optional)
    pub fn maybe_scope(mut self, value: Option<S>) -> Self {
        self._fields.7 = value;
        self
    }
}

impl<St, S: BosStr> CreateOAuthClientBuilder<St, S>
where
    St: create_o_auth_client_state::State,
    St::SliceUri: create_o_auth_client_state::IsUnset,
{
    /// Set the `sliceUri` field (required)
    pub fn slice_uri(
        mut self,
        value: impl Into<S>,
    ) -> CreateOAuthClientBuilder<create_o_auth_client_state::SetSliceUri<St>, S> {
        self._fields.8 = Option::Some(value.into());
        CreateOAuthClientBuilder {
            _state: PhantomData,
            _fields: self._fields,
            _type: PhantomData,
        }
    }
}

impl<St: create_o_auth_client_state::State, S: BosStr> CreateOAuthClientBuilder<St, S> {
    /// Set the `tosUri` field (optional)
    pub fn tos_uri(mut self, value: impl Into<Option<UriValue<S>>>) -> Self {
        self._fields.9 = value.into();
        self
    }
    /// Set the `tosUri` field to an Option value (optional)
    pub fn maybe_tos_uri(mut self, value: Option<UriValue<S>>) -> Self {
        self._fields.9 = value;
        self
    }
}

impl<St, S: BosStr> CreateOAuthClientBuilder<St, S>
where
    St: create_o_auth_client_state::State,
    St::ClientName: create_o_auth_client_state::IsSet,
    St::RedirectUris: create_o_auth_client_state::IsSet,
    St::SliceUri: create_o_auth_client_state::IsSet,
{
    /// Build the final struct.
    pub fn build(self) -> CreateOAuthClient<S> {
        CreateOAuthClient {
            client_name: self._fields.0.unwrap(),
            client_uri: self._fields.1,
            grant_types: self._fields.2,
            logo_uri: self._fields.3,
            policy_uri: self._fields.4,
            redirect_uris: self._fields.5.unwrap(),
            response_types: self._fields.6,
            scope: self._fields.7,
            slice_uri: self._fields.8.unwrap(),
            tos_uri: self._fields.9,
            extra_data: Default::default(),
        }
    }
    /// Build the final struct with custom extra_data.
    pub fn build_with_data(
        self,
        extra_data: BTreeMap<SmolStr, Data<S>>,
    ) -> CreateOAuthClient<S> {
        CreateOAuthClient {
            client_name: self._fields.0.unwrap(),
            client_uri: self._fields.1,
            grant_types: self._fields.2,
            logo_uri: self._fields.3,
            policy_uri: self._fields.4,
            redirect_uris: self._fields.5.unwrap(),
            response_types: self._fields.6,
            scope: self._fields.7,
            slice_uri: self._fields.8.unwrap(),
            tos_uri: self._fields.9,
            extra_data: Some(extra_data),
        }
    }
}