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
use anyhow::Result;
use crate::Client;
pub struct Members {
pub client: Client,
}
impl Members {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
Members { client }
}
/**
* This function performs a `GET` to the `/admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}` endpoint.
*
* Checks whether the given user is a member of the group. Membership can be direct or nested.
*
* **Parameters:**
*
* * `group_key: &str` -- Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
* * `member_key: &str` -- Identifies the user member in the API request. The value can be the user's primary email address, alias, or unique ID.
*/
pub async fn has(
&self,
group_key: &str,
member_key: &str,
) -> Result<crate::types::MembersHasMember> {
let url = format!(
"/admin/directory/v1/groups/{}/hasMember/{}",
crate::progenitor_support::encode_path(group_key),
crate::progenitor_support::encode_path(member_key),
);
self.client.get(&url, None).await
}
/**
* This function performs a `GET` to the `/admin/directory/v1/groups/{groupKey}/members` endpoint.
*
* Retrieves a paginated list of all members in a group.
*
* **Parameters:**
*
* * `group_key: &str` -- Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
* * `include_derived_membership: bool` -- A Boolean value to indicate whether payload is wanted. Optional.
* * `max_results: i64` -- Maximum number of results to return. Max allowed value is 200.
* * `page_token: &str` -- Token to specify next page in the list.
* * `roles: &str` -- The `roles` query parameter allows you to retrieve group members by role. Allowed values are `OWNER`, `MANAGER`, and `MEMBER`.
*/
pub async fn list(
&self,
group_key: &str,
include_derived_membership: bool,
max_results: i64,
page_token: &str,
roles: &str,
) -> Result<Vec<crate::types::Member>> {
let mut query_args: Vec<(String, String)> = Default::default();
if include_derived_membership {
query_args.push((
"includeDerivedMembership".to_string(),
include_derived_membership.to_string(),
));
}
if max_results > 0 {
query_args.push(("maxResults".to_string(), max_results.to_string()));
}
if !page_token.is_empty() {
query_args.push(("pageToken".to_string(), page_token.to_string()));
}
if !roles.is_empty() {
query_args.push(("roles".to_string(), roles.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/admin/directory/v1/groups/{}/members?{}",
crate::progenitor_support::encode_path(group_key),
query_
);
let resp: crate::types::Members = self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.members)
}
/**
* This function performs a `GET` to the `/admin/directory/v1/groups/{groupKey}/members` endpoint.
*
* As opposed to `list`, this function returns all the pages of the request at once.
*
* Retrieves a paginated list of all members in a group.
*/
pub async fn list_all(
&self,
group_key: &str,
include_derived_membership: bool,
roles: &str,
) -> Result<Vec<crate::types::Member>> {
let mut query_args: Vec<(String, String)> = Default::default();
if include_derived_membership {
query_args.push((
"includeDerivedMembership".to_string(),
include_derived_membership.to_string(),
));
}
if !roles.is_empty() {
query_args.push(("roles".to_string(), roles.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/admin/directory/v1/groups/{}/members?{}",
crate::progenitor_support::encode_path(group_key),
query_
);
let mut resp: crate::types::Members = self.client.get(&url, None).await?;
let mut members = resp.members;
let mut page = resp.next_page_token;
// Paginate if we should.
while !page.is_empty() {
if !url.contains('?') {
resp = self
.client
.get(&format!("{}?pageToken={}", url, page), None)
.await?;
} else {
resp = self
.client
.get(&format!("{}&pageToken={}", url, page), None)
.await?;
}
members.append(&mut resp.members);
if !resp.next_page_token.is_empty() && resp.next_page_token != page {
page = resp.next_page_token.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(members)
}
/**
* This function performs a `POST` to the `/admin/directory/v1/groups/{groupKey}/members` endpoint.
*
* Adds a user to the specified group.
*
* **Parameters:**
*
* * `group_key: &str` -- Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
*/
pub async fn insert(
&self,
group_key: &str,
body: &crate::types::Member,
) -> Result<crate::types::Member> {
let url = format!(
"/admin/directory/v1/groups/{}/members",
crate::progenitor_support::encode_path(group_key),
);
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* This function performs a `GET` to the `/admin/directory/v1/groups/{groupKey}/members/{memberKey}` endpoint.
*
* Retrieves a group member's properties.
*
* **Parameters:**
*
* * `group_key: &str` -- Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
* * `member_key: &str` -- Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.
*/
pub async fn get(&self, group_key: &str, member_key: &str) -> Result<crate::types::Member> {
let url = format!(
"/admin/directory/v1/groups/{}/members/{}",
crate::progenitor_support::encode_path(group_key),
crate::progenitor_support::encode_path(member_key),
);
self.client.get(&url, None).await
}
/**
* This function performs a `PUT` to the `/admin/directory/v1/groups/{groupKey}/members/{memberKey}` endpoint.
*
* Updates the membership of a user in the specified group.
*
* **Parameters:**
*
* * `group_key: &str` -- Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
* * `member_key: &str` -- Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.
*/
pub async fn update(
&self,
group_key: &str,
member_key: &str,
body: &crate::types::Member,
) -> Result<crate::types::Member> {
let url = format!(
"/admin/directory/v1/groups/{}/members/{}",
crate::progenitor_support::encode_path(group_key),
crate::progenitor_support::encode_path(member_key),
);
self.client
.put(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* This function performs a `DELETE` to the `/admin/directory/v1/groups/{groupKey}/members/{memberKey}` endpoint.
*
* Removes a member from a group.
*
* **Parameters:**
*
* * `group_key: &str` -- Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
* * `member_key: &str` -- Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.
*/
pub async fn delete(&self, group_key: &str, member_key: &str) -> Result<()> {
let url = format!(
"/admin/directory/v1/groups/{}/members/{}",
crate::progenitor_support::encode_path(group_key),
crate::progenitor_support::encode_path(member_key),
);
self.client.delete(&url, None).await
}
/**
* This function performs a `PATCH` to the `/admin/directory/v1/groups/{groupKey}/members/{memberKey}` endpoint.
*
* Updates the membership properties of a user in the specified group. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).
*
* **Parameters:**
*
* * `group_key: &str` -- Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.
* * `member_key: &str` -- Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.
*/
pub async fn patch(
&self,
group_key: &str,
member_key: &str,
body: &crate::types::Member,
) -> Result<crate::types::Member> {
let url = format!(
"/admin/directory/v1/groups/{}/members/{}",
crate::progenitor_support::encode_path(group_key),
crate::progenitor_support::encode_path(member_key),
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
}