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
use anyhow::Result;
use crate::Client;
pub struct Permissions {
pub client: Client,
}
impl Permissions {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
Permissions { client }
}
/**
* This function performs a `GET` to the `/files/{fileId}/permissions` endpoint.
*
* Lists a file's or shared drive's permissions.
*
* **Parameters:**
*
* * `file_id: &str` -- A link to this theme's background image.
* * `include_permissions_for_view: &str` -- Specifies which additional view's permissions to include in the response. Only 'published' is supported.
* * `page_size: i64` -- The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned.
* * `page_token: &str` -- The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
* * `supports_all_drives: bool` -- Whether the requesting application supports both My Drives and shared drives.
* * `supports_team_drives: bool` -- Whether the user has installed the requesting app.
* * `use_domain_admin_access: bool` -- Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
*/
pub async fn list(
&self,
file_id: &str,
include_permissions_for_view: &str,
page_size: i64,
page_token: &str,
supports_all_drives: bool,
supports_team_drives: bool,
use_domain_admin_access: bool,
) -> Result<Vec<crate::types::Permission>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !include_permissions_for_view.is_empty() {
query_args.push((
"includePermissionsForView".to_string(),
include_permissions_for_view.to_string(),
));
}
if page_size > 0 {
query_args.push(("pageSize".to_string(), page_size.to_string()));
}
if !page_token.is_empty() {
query_args.push(("pageToken".to_string(), page_token.to_string()));
}
if supports_all_drives {
query_args.push((
"supportsAllDrives".to_string(),
supports_all_drives.to_string(),
));
}
if supports_team_drives {
query_args.push((
"supportsTeamDrives".to_string(),
supports_team_drives.to_string(),
));
}
if use_domain_admin_access {
query_args.push((
"useDomainAdminAccess".to_string(),
use_domain_admin_access.to_string(),
));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/files/{}/permissions?{}",
crate::progenitor_support::encode_path(file_id),
query_
);
let resp: crate::types::PermissionList = self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.permissions.to_vec())
}
/**
* This function performs a `GET` to the `/files/{fileId}/permissions` endpoint.
*
* As opposed to `list`, this function returns all the pages of the request at once.
*
* Lists a file's or shared drive's permissions.
*/
pub async fn list_all(
&self,
file_id: &str,
include_permissions_for_view: &str,
supports_all_drives: bool,
supports_team_drives: bool,
use_domain_admin_access: bool,
) -> Result<Vec<crate::types::Permission>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !include_permissions_for_view.is_empty() {
query_args.push((
"includePermissionsForView".to_string(),
include_permissions_for_view.to_string(),
));
}
if supports_all_drives {
query_args.push((
"supportsAllDrives".to_string(),
supports_all_drives.to_string(),
));
}
if supports_team_drives {
query_args.push((
"supportsTeamDrives".to_string(),
supports_team_drives.to_string(),
));
}
if use_domain_admin_access {
query_args.push((
"useDomainAdminAccess".to_string(),
use_domain_admin_access.to_string(),
));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/files/{}/permissions?{}",
crate::progenitor_support::encode_path(file_id),
query_
);
let mut resp: crate::types::PermissionList = self.client.get(&url, None).await?;
let mut permissions = resp.permissions;
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?;
}
permissions.append(&mut resp.permissions);
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(permissions)
}
/**
* This function performs a `POST` to the `/files/{fileId}/permissions` endpoint.
*
* Creates a permission for a file or shared drive.
*
* **Parameters:**
*
* * `file_id: &str` -- A link to this theme's background image.
* * `email_message: &str` -- A plain text custom message to include in the notification email.
* * `enforce_single_parent: bool` -- Whether the user has installed the requesting app.
* * `move_to_new_owners_root: bool` -- This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, parents are not changed.
* * `send_notification_email: bool` -- Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.
* * `supports_all_drives: bool` -- Whether the requesting application supports both My Drives and shared drives.
* * `supports_team_drives: bool` -- Whether the user has installed the requesting app.
* * `transfer_ownership: bool` -- Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. File owners can only transfer ownership of files existing on My Drive. Files existing in a shared drive are owned by the organization that owns that shared drive. Ownership transfers are not supported for files and folders in shared drives. Organizers of a shared drive can move items from that shared drive into their My Drive which transfers the ownership to them.
* * `use_domain_admin_access: bool` -- Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
*/
pub async fn create(
&self,
file_id: &str,
email_message: &str,
move_to_new_owners_root: bool,
send_notification_email: bool,
supports_all_drives: bool,
supports_team_drives: bool,
transfer_ownership: bool,
use_domain_admin_access: bool,
body: &crate::types::Permission,
) -> Result<crate::types::Permission> {
let mut query_args: Vec<(String, String)> = Default::default();
if !email_message.is_empty() {
query_args.push(("emailMessage".to_string(), email_message.to_string()));
}
if move_to_new_owners_root {
query_args.push((
"moveToNewOwnersRoot".to_string(),
move_to_new_owners_root.to_string(),
));
}
query_args.push((
"sendNotificationEmail".to_string(),
send_notification_email.to_string(),
));
if supports_all_drives {
query_args.push((
"supportsAllDrives".to_string(),
supports_all_drives.to_string(),
));
}
if supports_team_drives {
query_args.push((
"supportsTeamDrives".to_string(),
supports_team_drives.to_string(),
));
}
if transfer_ownership {
query_args.push((
"transferOwnership".to_string(),
transfer_ownership.to_string(),
));
}
if use_domain_admin_access {
query_args.push((
"useDomainAdminAccess".to_string(),
use_domain_admin_access.to_string(),
));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/files/{}/permissions?{}",
crate::progenitor_support::encode_path(file_id),
query_
);
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* This function performs a `GET` to the `/files/{fileId}/permissions/{permissionId}` endpoint.
*
* Gets a permission by ID.
*
* **Parameters:**
*
* * `file_id: &str` -- A link to this theme's background image.
* * `permission_id: &str` -- A link to this theme's background image.
* * `supports_all_drives: bool` -- Whether the requesting application supports both My Drives and shared drives.
* * `supports_team_drives: bool` -- Whether the user has installed the requesting app.
* * `use_domain_admin_access: bool` -- Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
*/
pub async fn get(
&self,
file_id: &str,
permission_id: &str,
supports_all_drives: bool,
supports_team_drives: bool,
use_domain_admin_access: bool,
) -> Result<crate::types::Permission> {
let mut query_args: Vec<(String, String)> = Default::default();
if supports_all_drives {
query_args.push((
"supportsAllDrives".to_string(),
supports_all_drives.to_string(),
));
}
if supports_team_drives {
query_args.push((
"supportsTeamDrives".to_string(),
supports_team_drives.to_string(),
));
}
if use_domain_admin_access {
query_args.push((
"useDomainAdminAccess".to_string(),
use_domain_admin_access.to_string(),
));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/files/{}/permissions/{}?{}",
crate::progenitor_support::encode_path(file_id),
crate::progenitor_support::encode_path(permission_id),
query_
);
self.client.get(&url, None).await
}
/**
* This function performs a `DELETE` to the `/files/{fileId}/permissions/{permissionId}` endpoint.
*
* Deletes a permission.
*
* **Parameters:**
*
* * `file_id: &str` -- A link to this theme's background image.
* * `permission_id: &str` -- A link to this theme's background image.
* * `supports_all_drives: bool` -- Whether the requesting application supports both My Drives and shared drives.
* * `supports_team_drives: bool` -- Whether the user has installed the requesting app.
* * `use_domain_admin_access: bool` -- Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
*/
pub async fn delete(
&self,
file_id: &str,
permission_id: &str,
supports_all_drives: bool,
supports_team_drives: bool,
use_domain_admin_access: bool,
) -> Result<()> {
let mut query_args: Vec<(String, String)> = Default::default();
if supports_all_drives {
query_args.push((
"supportsAllDrives".to_string(),
supports_all_drives.to_string(),
));
}
if supports_team_drives {
query_args.push((
"supportsTeamDrives".to_string(),
supports_team_drives.to_string(),
));
}
if use_domain_admin_access {
query_args.push((
"useDomainAdminAccess".to_string(),
use_domain_admin_access.to_string(),
));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/files/{}/permissions/{}?{}",
crate::progenitor_support::encode_path(file_id),
crate::progenitor_support::encode_path(permission_id),
query_
);
self.client.delete(&url, None).await
}
/**
* This function performs a `PATCH` to the `/files/{fileId}/permissions/{permissionId}` endpoint.
*
* Updates a permission with patch semantics.
*
* **Parameters:**
*
* * `file_id: &str` -- A link to this theme's background image.
* * `permission_id: &str` -- A link to this theme's background image.
* * `remove_expiration: bool` -- Whether the user has installed the requesting app.
* * `supports_all_drives: bool` -- Whether the requesting application supports both My Drives and shared drives.
* * `supports_team_drives: bool` -- Whether the user has installed the requesting app.
* * `transfer_ownership: bool` -- Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect. File owners can only transfer ownership of files existing on My Drive. Files existing in a shared drive are owned by the organization that owns that shared drive. Ownership transfers are not supported for files and folders in shared drives. Organizers of a shared drive can move items from that shared drive into their My Drive which transfers the ownership to them.
* * `use_domain_admin_access: bool` -- Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
*/
pub async fn update(
&self,
file_id: &str,
permission_id: &str,
remove_expiration: bool,
supports_all_drives: bool,
supports_team_drives: bool,
transfer_ownership: bool,
use_domain_admin_access: bool,
body: &crate::types::Permission,
) -> Result<crate::types::Permission> {
let mut query_args: Vec<(String, String)> = Default::default();
if remove_expiration {
query_args.push((
"removeExpiration".to_string(),
remove_expiration.to_string(),
));
}
if supports_all_drives {
query_args.push((
"supportsAllDrives".to_string(),
supports_all_drives.to_string(),
));
}
if supports_team_drives {
query_args.push((
"supportsTeamDrives".to_string(),
supports_team_drives.to_string(),
));
}
if transfer_ownership {
query_args.push((
"transferOwnership".to_string(),
transfer_ownership.to_string(),
));
}
if use_domain_admin_access {
query_args.push((
"useDomainAdminAccess".to_string(),
use_domain_admin_access.to_string(),
));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/files/{}/permissions/{}?{}",
crate::progenitor_support::encode_path(file_id),
crate::progenitor_support::encode_path(permission_id),
query_
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
}