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
use anyhow::Result;
use crate::Client;
pub struct Groups {
pub client: Client,
}
impl Groups {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
Groups { client }
}
/**
* This function performs a `GET` to the `/admin/directory/v1/groups` endpoint.
*
* Retrieves all groups of a domain or of a user given a userKey (paginated).
*
* **Parameters:**
*
* * `customer: &str` -- The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, fill this field instead of domain. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users).
* * `domain: &str` -- The domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the `customer` query parameter instead.
* * `max_results: i64` -- Maximum number of results to return. Max allowed value is 200.
* * `order_by: crate::types::DirectoryGroupsListOrderBy` -- Column to use for sorting results.
* * `page_token: &str` -- Token to specify next page in the list.
* * `query: &str` -- Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups.
* * `sort_order: crate::types::SortOrder` -- Whether to return results in ascending or descending order. Must be used with the `orderBy` parameter.
* * `user_key: &str` -- Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object.
*/
pub async fn list(
&self,
customer: &str,
domain: &str,
max_results: i64,
order_by: crate::types::DirectoryGroupsListOrderBy,
page_token: &str,
query: &str,
sort_order: crate::types::SortOrder,
user_key: &str,
) -> Result<Vec<crate::types::Group>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !customer.is_empty() {
query_args.push(("customer".to_string(), customer.to_string()));
}
if !domain.is_empty() {
query_args.push(("domain".to_string(), domain.to_string()));
}
if max_results > 0 {
query_args.push(("maxResults".to_string(), max_results.to_string()));
}
if !order_by.to_string().is_empty() {
query_args.push(("orderBy".to_string(), order_by.to_string()));
}
if !page_token.is_empty() {
query_args.push(("pageToken".to_string(), page_token.to_string()));
}
if !query.is_empty() {
query_args.push(("query".to_string(), query.to_string()));
}
if !sort_order.to_string().is_empty() {
query_args.push(("sortOrder".to_string(), sort_order.to_string()));
}
if !user_key.is_empty() {
query_args.push(("userKey".to_string(), user_key.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/admin/directory/v1/groups?{}", query_);
let resp: crate::types::Groups = self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.groups.to_vec())
}
/**
* This function performs a `GET` to the `/admin/directory/v1/groups` endpoint.
*
* As opposed to `list`, this function returns all the pages of the request at once.
*
* Retrieves all groups of a domain or of a user given a userKey (paginated).
*/
pub async fn list_all(
&self,
customer: &str,
domain: &str,
order_by: crate::types::DirectoryGroupsListOrderBy,
query: &str,
sort_order: crate::types::SortOrder,
user_key: &str,
) -> Result<Vec<crate::types::Group>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !customer.is_empty() {
query_args.push(("customer".to_string(), customer.to_string()));
}
if !domain.is_empty() {
query_args.push(("domain".to_string(), domain.to_string()));
}
if !order_by.to_string().is_empty() {
query_args.push(("orderBy".to_string(), order_by.to_string()));
}
if !query.is_empty() {
query_args.push(("query".to_string(), query.to_string()));
}
if !sort_order.to_string().is_empty() {
query_args.push(("sortOrder".to_string(), sort_order.to_string()));
}
if !user_key.is_empty() {
query_args.push(("userKey".to_string(), user_key.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/admin/directory/v1/groups?{}", query_);
let mut resp: crate::types::Groups = self.client.get(&url, None).await?;
let mut groups = resp.groups;
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?;
}
groups.append(&mut resp.groups);
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(groups)
}
/**
* This function performs a `POST` to the `/admin/directory/v1/groups` endpoint.
*
* Creates a group.
*/
pub async fn insert(&self, body: &crate::types::Group) -> Result<crate::types::Group> {
let url = "/admin/directory/v1/groups".to_string();
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}` endpoint.
*
* Retrieves a group'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.
*/
pub async fn get(&self, group_key: &str) -> Result<crate::types::Group> {
let url = format!(
"/admin/directory/v1/groups/{}",
crate::progenitor_support::encode_path(group_key),
);
self.client.get(&url, None).await
}
/**
* This function performs a `PUT` to the `/admin/directory/v1/groups/{groupKey}` endpoint.
*
* Updates a group'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.
*/
pub async fn update(
&self,
group_key: &str,
body: &crate::types::Group,
) -> Result<crate::types::Group> {
let url = format!(
"/admin/directory/v1/groups/{}",
crate::progenitor_support::encode_path(group_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}` endpoint.
*
* Deletes 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.
*/
pub async fn delete(&self, group_key: &str) -> Result<()> {
let url = format!(
"/admin/directory/v1/groups/{}",
crate::progenitor_support::encode_path(group_key),
);
self.client.delete(&url, None).await
}
/**
* This function performs a `PATCH` to the `/admin/directory/v1/groups/{groupKey}` endpoint.
*
* Updates a group's properties. 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.
*/
pub async fn patch(
&self,
group_key: &str,
body: &crate::types::Group,
) -> Result<crate::types::Group> {
let url = format!(
"/admin/directory/v1/groups/{}",
crate::progenitor_support::encode_path(group_key),
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* This function performs a `GET` to the `/admin/directory/v1/groups/{groupKey}/aliases` endpoint.
*
* Lists all aliases for 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.
*/
pub async fn aliases_list(&self, group_key: &str) -> Result<crate::types::Aliases> {
let url = format!(
"/admin/directory/v1/groups/{}/aliases",
crate::progenitor_support::encode_path(group_key),
);
self.client.get(&url, None).await
}
/**
* This function performs a `POST` to the `/admin/directory/v1/groups/{groupKey}/aliases` endpoint.
*
* Adds an alias for the 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 aliases_insert(
&self,
group_key: &str,
body: &crate::types::Alias,
) -> Result<crate::types::Alias> {
let url = format!(
"/admin/directory/v1/groups/{}/aliases",
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 `DELETE` to the `/admin/directory/v1/groups/{groupKey}/aliases/{alias}` endpoint.
*
* Removes an alias.
*
* **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.
* * `alias: &str` -- The alias to be removed.
*/
pub async fn aliases_delete(&self, group_key: &str, alias: &str) -> Result<()> {
let url = format!(
"/admin/directory/v1/groups/{}/aliases/{}",
crate::progenitor_support::encode_path(group_key),
crate::progenitor_support::encode_path(alias),
);
self.client.delete(&url, None).await
}
}