squarecloud 0.1.0

Async Rust client for the SquareCloud API
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

use crate::{
    Endpoint,
    http::{ApiClient, errors::ApiError},
    types::WorkspaceInfo,
};

/// A handle to a specific SquareCloud workspace.
///
/// Obtain a `WorkspaceResource` by calling [`ApiClient::workspace`] with the
/// workspace ID, or via
/// [`WorkspaceInfo::into_resource`](crate::types::WorkspaceInfo::into_resource).
///
/// Methods are spread across multiple `impl` blocks in submodules:
///
/// | Source file | Methods |
/// |-------------|---------|
/// | `resource.rs` | info, leave, delete |
/// | `applications.rs` | app membership |
/// | `members.rs` | invite and member management |
pub struct WorkspaceResource {
    /// The workspace's unique identifier.
    pub id: String,
    pub(crate) client: ApiClient,
}

impl WorkspaceResource {
    /// Creates a new `WorkspaceResource` bound to the given client and
    /// workspace ID.
    ///
    /// Prefer [`ApiClient::workspace`] over calling this directly.
    pub fn new(http: ApiClient, id: &str) -> Self {
        Self {
            client: http,
            id: id.to_string(),
        }
    }

    /// Returns metadata about the workspace, including its member list and
    /// application list.
    ///
    /// # Errors
    ///
    /// Returns [`ApiError::Transport`] on network failure or [`ApiError::Api`]
    /// on an API-level error.
    pub async fn info(&self) -> Result<WorkspaceInfo, ApiError> {
        self.client
            .request_endpoint(Endpoint::get_workspace(&self.id))
            .await?
            .into_result_t()
    }

    /// Removes the authenticated account from the workspace.
    ///
    /// Returns `Ok(true)` on success. The owner of a workspace cannot leave
    /// it; use [`delete`](WorkspaceResource::delete) instead.
    ///
    /// # Errors
    ///
    /// Returns [`ApiError::Transport`] on network failure or [`ApiError::Api`]
    /// if the account is the owner or is not a member.
    pub async fn leave(&self) -> Result<bool, ApiError> {
        self.client
            .request_endpoint::<()>(Endpoint::leave_workspace())
            .await?
            .into_bool_result()
    }

    /// Permanently deletes the workspace and all member and application
    /// associations.
    ///
    /// Only the workspace owner can delete the workspace. This action cannot
    /// be undone. Returns `Ok(true)` on success.
    ///
    /// # Errors
    ///
    /// Returns [`ApiError::Transport`] on network failure or [`ApiError::Api`]
    /// if the authenticated account is not the owner.
    pub async fn delete(&self) -> Result<bool, ApiError> {
        self.client
            .request_endpoint::<()>(Endpoint::delete_workspace())
            .await?
            .into_bool_result()
    }
}