spiral-sdk 0.1.12

Rust SDK for Spiral resource and table APIs
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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
// Generated by tools/service-contracts/rust.py. Do not edit.
#![doc = "Generated implementation of authenticated SDK resource facades."]
use reqwest_middleware::ClientWithMiddleware;
use spiral_contract::call::CallError;

use crate::api::organization::OrganizationClient;
use crate::api::organization::objects::*;
use crate::auth::TokenSource;
use crate::http::HttpClient;
/// Service operations sharing a connection pool and resolving credentials for every request.
#[derive(Clone, Debug)]
pub struct AuthenticatedClient {
    http: HttpClient,
    client: OrganizationClient,
}
impl AuthenticatedClient {
    /// Connect with bounded requests; configure credentials before authenticated calls.
    pub fn new(base: &str) -> Result<Self, CallError<OrganizationError>> {
        Self::from_http(HttpClient::connect(base).map_err(CallError::transport)?)
    }
    pub(crate) fn from_http(http: HttpClient) -> Result<Self, CallError<OrganizationError>> {
        let client =
            OrganizationClient::from_transport(http.base_url().as_str(), http.middleware_client())?;
        Ok(Self { http, client })
    }
    /// Reuse a connection pool with redirects disabled to protect bearer credentials.
    pub fn with_client(mut self, client: impl Into<ClientWithMiddleware>) -> Self {
        self.http = self.http.with_client(client);
        self.client = self.client.with_transport(self.http.middleware_client());
        self
    }
    /// Resolve the provider's current credential before each request and pagination fetch.
    pub fn with_token_source(mut self, provider: TokenSource) -> Self {
        self.http = self.http.with_token_source(provider);
        self
    }
    /// Create an Organization for the authenticated user. Existing Organization membership prevents
    /// creating another.
    pub async fn create_organization(
        &self,
        request: CreateOrganizationRequest,
    ) -> Result<CreateOrganizationResponse, CallError<OrganizationError>> {
        let auth_header = self
            .http
            .auth_header()
            .await
            .map_err(CallError::transport)?;
        tokio::time::timeout(
            std::time::Duration::from_secs(60),
            self.client.create_organization_http(auth_header, request),
        )
        .await
        .map_err(CallError::transport)?
    }
    /// Open an account administration setting with Organization configure permission.
    pub async fn create_portal_link(
        &self,
        request: PortalLinkRequest,
    ) -> Result<PortalLink, CallError<OrganizationError>> {
        let auth_header = self
            .http
            .auth_header()
            .await
            .map_err(CallError::transport)?;
        tokio::time::timeout(
            std::time::Duration::from_secs(60),
            self.client.create_portal_link_http(auth_header, request),
        )
        .await
        .map_err(CallError::transport)?
    }
    /// Deactivate a membership with manage-users permission. The last owner cannot be deactivated.
    pub async fn deactivate_member(
        &self,
        user_id: String,
    ) -> Result<(), CallError<OrganizationError>> {
        let auth_header = self
            .http
            .auth_header()
            .await
            .map_err(CallError::transport)?;
        tokio::time::timeout(
            std::time::Duration::from_secs(60),
            self.client.deactivate_member_http(auth_header, user_id),
        )
        .await
        .map_err(CallError::transport)?
    }
    /// Deactivate an Organization with platform administer permission.
    pub async fn deactivate_organization(
        &self,
        organization_id: String,
    ) -> Result<(), CallError<OrganizationError>> {
        let auth_header = self
            .http
            .auth_header()
            .await
            .map_err(CallError::transport)?;
        tokio::time::timeout(
            std::time::Duration::from_secs(60),
            self.client
                .deactivate_organization_http(auth_header, organization_id),
        )
        .await
        .map_err(CallError::transport)?
    }
    /// Invite a user to the active Organization with invite permission.
    pub async fn invite_member(
        &self,
        request: InviteMemberRequest,
    ) -> Result<InvitationResponse, CallError<OrganizationError>> {
        let auth_header = self
            .http
            .auth_header()
            .await
            .map_err(CallError::transport)?;
        tokio::time::timeout(
            std::time::Duration::from_secs(60),
            self.client.invite_member_http(auth_header, request),
        )
        .await
        .map_err(CallError::transport)?
    }
    /// List the active Organization invitations with invite permission. Page size defaults to 10
    /// and must be 1..=100.
    pub async fn list_invitations(
        &self,
        request: ListMembersRequest,
    ) -> Result<InvitationPage, CallError<OrganizationError>> {
        let auth_header = self
            .http
            .auth_header()
            .await
            .map_err(CallError::transport)?;
        tokio::time::timeout(
            std::time::Duration::from_secs(60),
            self.client.list_invitations_http(auth_header, request),
        )
        .await
        .map_err(CallError::transport)?
    }
    /// Build a lazy collection, retaining filters and resolving fresh credentials for each page.
    pub fn list_invitations_list(
        &self,
        request: ListMembersRequest,
    ) -> crate::List<'_, Invitation> {
        let options = crate::pagination::PageOptions {
            token: request.page_token.clone(),
            size: request.page_size,
        };
        crate::List::new(move |options| {
            let mut request = request.clone();
            request.page_token = options.token;
            request.page_size = options.size;
            Box::pin(async move {
                let page = self.list_invitations(request).await?;
                Ok(crate::Page {
                    items: page.items,
                    next_page_token: page.next_page_token,
                })
            })
        })
        .with_options(options)
    }
    /// List the active Organization members with list-users permission. Each page reauthorizes the
    /// caller.
    pub async fn list_members(
        &self,
        request: ListMembersRequest,
    ) -> Result<MemberPage, CallError<OrganizationError>> {
        let auth_header = self
            .http
            .auth_header()
            .await
            .map_err(CallError::transport)?;
        tokio::time::timeout(
            std::time::Duration::from_secs(60),
            self.client.list_members_http(auth_header, request),
        )
        .await
        .map_err(CallError::transport)?
    }
    /// Build a lazy collection, retaining filters and resolving fresh credentials for each page.
    pub fn list_members_list(&self, request: ListMembersRequest) -> crate::List<'_, Member> {
        let options = crate::pagination::PageOptions {
            token: request.page_token.clone(),
            size: request.page_size,
        };
        crate::List::new(move |options| {
            let mut request = request.clone();
            request.page_token = options.token;
            request.page_size = options.size;
            Box::pin(async move {
                let page = self.list_members(request).await?;
                Ok(crate::Page {
                    items: page.items,
                    next_page_token: page.next_page_token,
                })
            })
        })
        .with_options(options)
    }
    /// List the authenticated user memberships in ascending Organization ID order. Requires a
    /// first-party user credential.
    pub async fn list_memberships(
        &self,
        request: ListMembershipsRequest,
    ) -> Result<MembershipPage, CallError<OrganizationError>> {
        let auth_header = self
            .http
            .auth_header()
            .await
            .map_err(CallError::transport)?;
        tokio::time::timeout(
            std::time::Duration::from_secs(60),
            self.client.list_memberships_http(auth_header, request),
        )
        .await
        .map_err(CallError::transport)?
    }
    /// Build a lazy collection, retaining filters and resolving fresh credentials for each page.
    pub fn list_memberships_list(
        &self,
        request: ListMembershipsRequest,
    ) -> crate::List<'_, Membership> {
        let options = crate::pagination::PageOptions {
            token: request.page_token.clone(),
            size: request.page_size,
        };
        crate::List::new(move |options| {
            let mut request = request.clone();
            request.page_token = options.token;
            request.page_size = options.size;
            Box::pin(async move {
                let page = self.list_memberships(request).await?;
                Ok(crate::Page {
                    items: page.items,
                    next_page_token: page.next_page_token,
                })
            })
        })
        .with_options(options)
    }
    /// List Organization records in ascending ID order with platform administer permission.
    pub async fn list_organizations(
        &self,
        request: ListOrganizationsRequest,
    ) -> Result<OrganizationPage, CallError<OrganizationError>> {
        let auth_header = self
            .http
            .auth_header()
            .await
            .map_err(CallError::transport)?;
        tokio::time::timeout(
            std::time::Duration::from_secs(60),
            self.client.list_organizations_http(auth_header, request),
        )
        .await
        .map_err(CallError::transport)?
    }
    /// Build a lazy collection, retaining filters and resolving fresh credentials for each page.
    pub fn list_organizations_list(
        &self,
        request: ListOrganizationsRequest,
    ) -> crate::List<'_, OrganizationDetails> {
        let options = crate::pagination::PageOptions {
            token: request.page_token.clone(),
            size: request.page_size,
        };
        crate::List::new(move |options| {
            let mut request = request.clone();
            request.page_token = options.token;
            request.page_size = options.size;
            Box::pin(async move {
                let page = self.list_organizations(request).await?;
                Ok(crate::Page {
                    items: page.items,
                    next_page_token: page.next_page_token,
                })
            })
        })
        .with_options(options)
    }
    /// Reactivate an Organization with platform administer permission.
    pub async fn reactivate_organization(
        &self,
        organization_id: String,
    ) -> Result<(), CallError<OrganizationError>> {
        let auth_header = self
            .http
            .auth_header()
            .await
            .map_err(CallError::transport)?;
        tokio::time::timeout(
            std::time::Duration::from_secs(60),
            self.client
                .reactivate_organization_http(auth_header, organization_id),
        )
        .await
        .map_err(CallError::transport)?
    }
    /// Read the active Organization storage default with Organization configure permission.
    pub async fn read_config(&self) -> Result<OrganizationConfig, CallError<OrganizationError>> {
        let auth_header = self
            .http
            .auth_header()
            .await
            .map_err(CallError::transport)?;
        tokio::time::timeout(
            std::time::Duration::from_secs(60),
            self.client.read_config_http(auth_header),
        )
        .await
        .map_err(CallError::transport)?
    }
    /// Read the authenticated user identity and active Organization. Workload, service and
    /// delegated credentials are refused.
    pub async fn read_identity(&self) -> Result<Identity, CallError<OrganizationError>> {
        let auth_header = self
            .http
            .auth_header()
            .await
            .map_err(CallError::transport)?;
        tokio::time::timeout(
            std::time::Duration::from_secs(60),
            self.client.read_identity_http(auth_header),
        )
        .await
        .map_err(CallError::transport)?
    }
    /// Resend an invitation owned by the active Organization with invite permission.
    pub async fn resend_invitation(
        &self,
        invitation_id: String,
    ) -> Result<InvitationResponse, CallError<OrganizationError>> {
        let auth_header = self
            .http
            .auth_header()
            .await
            .map_err(CallError::transport)?;
        tokio::time::timeout(
            std::time::Duration::from_secs(60),
            self.client
                .resend_invitation_http(auth_header, invitation_id),
        )
        .await
        .map_err(CallError::transport)?
    }
    /// Revoke an invitation owned by the active Organization with invite permission.
    pub async fn revoke_invitation(
        &self,
        invitation_id: String,
    ) -> Result<(), CallError<OrganizationError>> {
        let auth_header = self
            .http
            .auth_header()
            .await
            .map_err(CallError::transport)?;
        tokio::time::timeout(
            std::time::Duration::from_secs(60),
            self.client
                .revoke_invitation_http(auth_header, invitation_id),
        )
        .await
        .map_err(CallError::transport)?
    }
    /// Set a member role with manage-users permission. The last owner cannot be demoted.
    pub async fn set_member_role(
        &self,
        user_id: String,
        request: SetMemberRoleRequest,
    ) -> Result<(), CallError<OrganizationError>> {
        let auth_header = self
            .http
            .auth_header()
            .await
            .map_err(CallError::transport)?;
        tokio::time::timeout(
            std::time::Duration::from_secs(60),
            self.client
                .set_member_role_http(auth_header, user_id, request),
        )
        .await
        .map_err(CallError::transport)?
    }
    /// Synchronize one provider page of memberships for the specified Organization with platform
    /// administer permission. Only active memberships are stored; an empty result can still have a
    /// continuation. Page size defaults to 10 and must be 1..=100.
    pub async fn sync_memberships(
        &self,
        organization_id: String,
        request: ListMembersRequest,
    ) -> Result<MembershipPage, CallError<OrganizationError>> {
        let auth_header = self
            .http
            .auth_header()
            .await
            .map_err(CallError::transport)?;
        tokio::time::timeout(
            std::time::Duration::from_secs(60),
            self.client
                .sync_memberships_http(auth_header, organization_id, request),
        )
        .await
        .map_err(CallError::transport)?
    }
    /// Build a lazy collection, retaining filters and resolving fresh credentials for each page.
    pub fn sync_memberships_list(
        &self,
        organization_id: String,
        request: ListMembersRequest,
    ) -> crate::List<'_, Membership> {
        let options = crate::pagination::PageOptions {
            token: request.page_token.clone(),
            size: request.page_size,
        };
        crate::List::new(move |options| {
            let organization_id = ToOwned::to_owned(&organization_id);
            let mut request = request.clone();
            request.page_token = options.token;
            request.page_size = options.size;
            Box::pin(async move {
                let page = self.sync_memberships(organization_id, request).await?;
                Ok(crate::Page {
                    items: page.items,
                    next_page_token: page.next_page_token,
                })
            })
        })
        .with_options(options)
    }
    /// Synchronize one live provider page with platform administer permission. Page size defaults
    /// to 10 and must be 1..=100. Repeat with the continuation until absent.
    pub async fn sync_organizations(
        &self,
        request: ListMembersRequest,
    ) -> Result<OrganizationIdPage, CallError<OrganizationError>> {
        let auth_header = self
            .http
            .auth_header()
            .await
            .map_err(CallError::transport)?;
        tokio::time::timeout(
            std::time::Duration::from_secs(60),
            self.client.sync_organizations_http(auth_header, request),
        )
        .await
        .map_err(CallError::transport)?
    }
    /// Build a lazy collection, retaining filters and resolving fresh credentials for each page.
    pub fn sync_organizations_list(&self, request: ListMembersRequest) -> crate::List<'_, String> {
        let options = crate::pagination::PageOptions {
            token: request.page_token.clone(),
            size: request.page_size,
        };
        crate::List::new(move |options| {
            let mut request = request.clone();
            request.page_token = options.token;
            request.page_size = options.size;
            Box::pin(async move {
                let page = self.sync_organizations(request).await?;
                Ok(crate::Page {
                    items: page.items,
                    next_page_token: page.next_page_token,
                })
            })
        })
        .with_options(options)
    }
    /// Set the active Organization storage default with Organization configure permission.
    /// Plaintext storage keys are vaulted before persistence.
    pub async fn write_config(
        &self,
        request: OrganizationConfig,
    ) -> Result<OrganizationConfig, CallError<OrganizationError>> {
        let auth_header = self
            .http
            .auth_header()
            .await
            .map_err(CallError::transport)?;
        tokio::time::timeout(
            std::time::Duration::from_secs(60),
            self.client.write_config_http(auth_header, request),
        )
        .await
        .map_err(CallError::transport)?
    }
}