shared/api/endpoints/
circle.rs

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
use crate::{
    api::Method,
    domain::{
        circle::{
            BrowseMembersQuery, BrowseMembersResponse, Circle, CircleBrowseMembersPath,
            CircleBrowsePath, CircleBrowseQuery, CircleBrowseResponse, CircleCreatePath,
            CircleCreateRequest, CircleDeletePath, CircleGetPath, CircleId, CircleRemoveMemberPath,
            CircleSearchPath, CircleSearchQuery, CircleSearchResponse, CircleUpdateRequest,
            JoinCirclePath, LeaveCirclePath, UpdateCirclePath,
        },
        CreateResponse,
    },
    error::EmptyError,
};

use super::ApiEndpoint;

/// Create a Circle.
///
/// # Authorization
/// * TokenUser
/// * One of `Admin`, `AdminAsset`, or `ManageSelfAsset`
pub struct Create;
impl ApiEndpoint for Create {
    type Req = CircleCreateRequest;
    type Res = CreateResponse<CircleId>;
    type Path = CircleCreatePath;
    type Err = EmptyError;
    const METHOD: Method = Method::Post;
}

/// Update the Circle.
///
/// # Authorization
/// * One of `Admin`, `AdminAsset`, or `ManageSelfAsset` for owned Circles
///
pub struct Update;
impl ApiEndpoint for Update {
    type Req = CircleUpdateRequest;
    type Res = ();
    type Path = UpdateCirclePath;
    type Err = EmptyError;
    const METHOD: Method = Method::Patch;
}

/// Browse Circles. Returns the Circles in the response.
///
/// # Authorization
/// * TokenUser of owned Circles
/// * One of `Admin`, `AdminAsset`, or `ManageSelfAsset` for owned Circles
///
pub struct Browse;
impl ApiEndpoint for Browse {
    type Req = CircleBrowseQuery;
    type Res = CircleBrowseResponse;
    type Path = CircleBrowsePath;
    type Err = EmptyError;
    const METHOD: Method = Method::Get;
}

/// Search for Circles.
///
/// # Authorization
/// * None
pub struct Search;
impl ApiEndpoint for Search {
    type Req = CircleSearchQuery;
    type Res = CircleSearchResponse;
    type Path = CircleSearchPath;
    type Err = EmptyError;
    const METHOD: Method = Method::Get;
}

/// Delete a Circle.
///
/// # Authorization
/// * One of `Admin`, `AdminAsset`, or `ManageSelfAsset` for owned Circles
pub struct Delete;
impl ApiEndpoint for Delete {
    type Req = ();
    type Res = ();
    type Path = CircleDeletePath;
    type Err = EmptyError;
    const METHOD: Method = Method::Delete;
}

/// Get a Circle's by ID.
///
/// # Authorization
/// * One of `Admin`, `AdminAsset`,, or `ManageSelfAsset` for owned Circles
///
/// # Errors
/// * [`Unauthorized`](http::StatusCode::UNAUTHORIZED) if authorization is not valid.
/// * [`NotFound`](http::StatusCode::NOT_FOUND) if the circle does not exist
pub struct Get;
impl ApiEndpoint for Get {
    type Req = ();
    type Res = Circle;
    type Path = CircleGetPath;
    type Err = EmptyError;
    const METHOD: Method = Method::Get;
}

/// Join a Circle.
/// # Authorization
/// * TokenUser
/// * One of `Admin`, `AdminAsset`,, or `ManageSelfAsset` for owned Circles
///
/// # Errors
/// * [`Unauthorized`](http::StatusCode::UNAUTHORIZED) if authorization is not valid.
/// * [`NotFound`](http::StatusCode::NOT_FOUND) if the circle does not exist
pub struct JoinCircle;
impl ApiEndpoint for JoinCircle {
    type Req = ();
    type Res = ();
    type Path = JoinCirclePath;
    type Err = EmptyError;
    const METHOD: Method = Method::Post;
}

/// Leave a Circle.
pub struct LeaveCircle;
impl ApiEndpoint for LeaveCircle {
    type Req = ();
    type Res = ();
    type Path = LeaveCirclePath;
    type Err = EmptyError;
    const METHOD: Method = Method::Delete;
}

/// Remove member from a Circle.
pub struct RemoveMember;
impl ApiEndpoint for RemoveMember {
    type Req = ();
    type Res = ();
    type Path = CircleRemoveMemberPath;
    type Err = EmptyError;
    const METHOD: Method = Method::Delete;
}

/// Browse members of a Circle.
pub struct BrowseMembers;
impl ApiEndpoint for BrowseMembers {
    type Req = BrowseMembersQuery;
    type Res = BrowseMembersResponse;
    type Path = CircleBrowseMembersPath;
    type Err = EmptyError;
    const METHOD: Method = Method::Get;
}