class GoogleDrive::PermissionsApi

Defined in:

google_drive/api/permissions_api.cr

Constant Summary

DRIVE_PERMISSIONS_CREATE_VALID_VALUES_FOR_ALT = String.static_array("json", "media")
DRIVE_PERMISSIONS_DELETE_VALID_VALUES_FOR_ALT = String.static_array("json", "media")
DRIVE_PERMISSIONS_GET_VALID_VALUES_FOR_ALT = String.static_array("json", "media")
DRIVE_PERMISSIONS_LIST_MAX_FOR_PAGE_SIZE = Int32.new("100")
DRIVE_PERMISSIONS_LIST_MIN_FOR_PAGE_SIZE = Int32.new("1")
DRIVE_PERMISSIONS_LIST_VALID_VALUES_FOR_ALT = String.static_array("json", "media")
DRIVE_PERMISSIONS_UPDATE_VALID_VALUES_FOR_ALT = String.static_array("json", "media")

Constructors

Instance Method Summary

Constructor Detail

def self.new(api_client : GoogleDrive::ApiClient = ApiClient.default) #

[View source]

Instance Method Detail

def api_client : ApiClient #

[View source]
def api_client=(api_client : ApiClient) #

[View source]
def build_api_request_for_create(*, file_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, email_message : String | Nil = nil, enforce_single_parent : Bool | Nil = nil, move_to_new_owners_root : Bool | Nil = nil, send_notification_email : Bool | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, transfer_ownership : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil, permission : GoogleDrive::Permission | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_delete(*, file_id : String | Nil = nil, permission_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get(*, file_id : String | Nil = nil, permission_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_list(*, file_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, include_permissions_for_view : String | Nil = nil, page_size : Int32 | Nil = nil, page_token : String | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_update(*, file_id : String | Nil = nil, permission_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, remove_expiration : Bool | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, transfer_ownership : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil, permission : GoogleDrive::Permission | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def client_side_validation?(*args, **options) #

[View source]
def client_side_validation?(*args, **options, &) #

[View source]
def create(*, file_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, email_message : String | Nil = nil, enforce_single_parent : Bool | Nil = nil, move_to_new_owners_root : Bool | Nil = nil, send_notification_email : Bool | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, transfer_ownership : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil, permission : GoogleDrive::Permission | Nil = nil) : GoogleDrive::Permission #

Creates a permission for a file or shared drive. @required @param file_id [String?] The ID of the file or shared drive. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param email_message [String?] A plain text custom message to include in the notification email. @optional @param enforce_single_parent [Bool?] Deprecated. See moveToNewOwnersRoot for details. @optional @param 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. @optional @param 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. @optional @param supports_all_drives [Bool?] Whether the requesting application supports both My Drives and shared drives. @optional @param supports_team_drives [Bool?] Deprecated use supportsAllDrives instead. @optional @param 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. @optional @param 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. @optional @param permission [GoogleDrive::Permission?] @return [GoogleDrive::Permission]


[View source]
def create(*, file_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, email_message : String | Nil = nil, enforce_single_parent : Bool | Nil = nil, move_to_new_owners_root : Bool | Nil = nil, send_notification_email : Bool | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, transfer_ownership : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil, permission : GoogleDrive::Permission | Nil = nil, &block : Crest::Response -> ) : Nil #

Creates a permission for a file or shared drive. @required @param file_id [String?] The ID of the file or shared drive. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param email_message [String?] A plain text custom message to include in the notification email. @optional @param enforce_single_parent [Bool?] Deprecated. See moveToNewOwnersRoot for details. @optional @param 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. @optional @param 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. @optional @param supports_all_drives [Bool?] Whether the requesting application supports both My Drives and shared drives. @optional @param supports_team_drives [Bool?] Deprecated use supportsAllDrives instead. @optional @param 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. @optional @param 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. @optional @param permission [GoogleDrive::Permission?] @return nil


[View source]
def create_with_http_info(*, file_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, email_message : String | Nil = nil, enforce_single_parent : Bool | Nil = nil, move_to_new_owners_root : Bool | Nil = nil, send_notification_email : Bool | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, transfer_ownership : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil, permission : GoogleDrive::Permission | Nil = nil) : Tuple(GoogleDrive::Permission, Int32, Hash(String, Array(String) | String)) #

Creates a permission for a file or shared drive. @required @param file_id [String?] The ID of the file or shared drive. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param email_message [String?] A plain text custom message to include in the notification email. @optional @param enforce_single_parent [Bool?] Deprecated. See moveToNewOwnersRoot for details. @optional @param 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. @optional @param 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. @optional @param supports_all_drives [Bool?] Whether the requesting application supports both My Drives and shared drives. @optional @param supports_team_drives [Bool?] Deprecated use supportsAllDrives instead. @optional @param 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. @optional @param 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. @optional @param permission [GoogleDrive::Permission?] @return [Tuple(GoogleDrive::Permission, Integer, Hash)] GoogleDrive::Permission, response status code and response headers


[View source]
def debugging?(*args, **options) #

[View source]
def debugging?(*args, **options, &) #

[View source]
def delete(*, file_id : String | Nil = nil, permission_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil) : Nil #

Deletes a permission. @required @param file_id [String?] The ID of the file or shared drive. @required @param permission_id [String?] The ID of the permission. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param supports_all_drives [Bool?] Whether the requesting application supports both My Drives and shared drives. @optional @param supports_team_drives [Bool?] Deprecated use supportsAllDrives instead. @optional @param 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. @return [Nil]


[View source]
def delete(*, file_id : String | Nil = nil, permission_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil, &block : Crest::Response -> ) : Nil #

Deletes a permission. @required @param file_id [String?] The ID of the file or shared drive. @required @param permission_id [String?] The ID of the permission. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param supports_all_drives [Bool?] Whether the requesting application supports both My Drives and shared drives. @optional @param supports_team_drives [Bool?] Deprecated use supportsAllDrives instead. @optional @param 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. @return nil


[View source]
def delete_with_http_info(*, file_id : String | Nil = nil, permission_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil) : Tuple(Nil, Int32, Hash(String, Array(String) | String)) #

Deletes a permission. @required @param file_id [String?] The ID of the file or shared drive. @required @param permission_id [String?] The ID of the permission. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param supports_all_drives [Bool?] Whether the requesting application supports both My Drives and shared drives. @optional @param supports_team_drives [Bool?] Deprecated use supportsAllDrives instead. @optional @param 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. @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers


[View source]
def get(*, file_id : String | Nil = nil, permission_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil) : GoogleDrive::Permission #

Gets a permission by ID. @required @param file_id [String?] The ID of the file. @required @param permission_id [String?] The ID of the permission. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param supports_all_drives [Bool?] Whether the requesting application supports both My Drives and shared drives. @optional @param supports_team_drives [Bool?] Deprecated use supportsAllDrives instead. @optional @param 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. @return [GoogleDrive::Permission]


[View source]
def get(*, file_id : String | Nil = nil, permission_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil, &block : Crest::Response -> ) : Nil #

Gets a permission by ID. @required @param file_id [String?] The ID of the file. @required @param permission_id [String?] The ID of the permission. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param supports_all_drives [Bool?] Whether the requesting application supports both My Drives and shared drives. @optional @param supports_team_drives [Bool?] Deprecated use supportsAllDrives instead. @optional @param 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. @return nil


[View source]
def get_with_http_info(*, file_id : String | Nil = nil, permission_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil) : Tuple(GoogleDrive::Permission, Int32, Hash(String, Array(String) | String)) #

Gets a permission by ID. @required @param file_id [String?] The ID of the file. @required @param permission_id [String?] The ID of the permission. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param supports_all_drives [Bool?] Whether the requesting application supports both My Drives and shared drives. @optional @param supports_team_drives [Bool?] Deprecated use supportsAllDrives instead. @optional @param 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. @return [Tuple(GoogleDrive::Permission, Integer, Hash)] GoogleDrive::Permission, response status code and response headers


[View source]
def list(*, file_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, include_permissions_for_view : String | Nil = nil, page_size : Int32 | Nil = nil, page_token : String | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil) : GoogleDrive::PermissionList #

Lists a file's or shared drive's permissions. @required @param file_id [String?] The ID of the file or shared drive. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param include_permissions_for_view [String?] Specifies which additional view's permissions to include in the response. Only 'published' is supported. @optional @param page_size [Int32?] 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. @optional @param page_token [String?] 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. @optional @param supports_all_drives [Bool?] Whether the requesting application supports both My Drives and shared drives. @optional @param supports_team_drives [Bool?] Deprecated use supportsAllDrives instead. @optional @param 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. @return [GoogleDrive::PermissionList]


[View source]
def list(*, file_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, include_permissions_for_view : String | Nil = nil, page_size : Int32 | Nil = nil, page_token : String | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil, &block : Crest::Response -> ) : Nil #

Lists a file's or shared drive's permissions. @required @param file_id [String?] The ID of the file or shared drive. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param include_permissions_for_view [String?] Specifies which additional view's permissions to include in the response. Only 'published' is supported. @optional @param page_size [Int32?] 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. @optional @param page_token [String?] 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. @optional @param supports_all_drives [Bool?] Whether the requesting application supports both My Drives and shared drives. @optional @param supports_team_drives [Bool?] Deprecated use supportsAllDrives instead. @optional @param 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. @return nil


[View source]
def list_with_http_info(*, file_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, include_permissions_for_view : String | Nil = nil, page_size : Int32 | Nil = nil, page_token : String | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil) : Tuple(GoogleDrive::PermissionList, Int32, Hash(String, Array(String) | String)) #

Lists a file's or shared drive's permissions. @required @param file_id [String?] The ID of the file or shared drive. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param include_permissions_for_view [String?] Specifies which additional view's permissions to include in the response. Only 'published' is supported. @optional @param page_size [Int32?] 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. @optional @param page_token [String?] 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. @optional @param supports_all_drives [Bool?] Whether the requesting application supports both My Drives and shared drives. @optional @param supports_team_drives [Bool?] Deprecated use supportsAllDrives instead. @optional @param 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. @return [Tuple(GoogleDrive::PermissionList, Integer, Hash)] GoogleDrive::PermissionList, response status code and response headers


[View source]
def update(*, file_id : String | Nil = nil, permission_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, remove_expiration : Bool | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, transfer_ownership : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil, permission : GoogleDrive::Permission | Nil = nil) : GoogleDrive::Permission #

Updates a permission with patch semantics. @required @param file_id [String?] The ID of the file or shared drive. @required @param permission_id [String?] The ID of the permission. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param remove_expiration [Bool?] Whether to remove the expiration date. @optional @param supports_all_drives [Bool?] Whether the requesting application supports both My Drives and shared drives. @optional @param supports_team_drives [Bool?] Deprecated use supportsAllDrives instead. @optional @param 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. @optional @param 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. @optional @param permission [GoogleDrive::Permission?] @return [GoogleDrive::Permission]


[View source]
def update(*, file_id : String | Nil = nil, permission_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, remove_expiration : Bool | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, transfer_ownership : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil, permission : GoogleDrive::Permission | Nil = nil, &block : Crest::Response -> ) : Nil #

Updates a permission with patch semantics. @required @param file_id [String?] The ID of the file or shared drive. @required @param permission_id [String?] The ID of the permission. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param remove_expiration [Bool?] Whether to remove the expiration date. @optional @param supports_all_drives [Bool?] Whether the requesting application supports both My Drives and shared drives. @optional @param supports_team_drives [Bool?] Deprecated use supportsAllDrives instead. @optional @param 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. @optional @param 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. @optional @param permission [GoogleDrive::Permission?] @return nil


[View source]
def update_with_http_info(*, file_id : String | Nil = nil, permission_id : String | Nil = nil, alt : String | Nil = "json", fields : String | Nil = nil, key : String | Nil = nil, oauth_token : String | Nil = nil, pretty_print : Bool | Nil = nil, quota_user : String | Nil = nil, user_ip : String | Nil = nil, remove_expiration : Bool | Nil = nil, supports_all_drives : Bool | Nil = nil, supports_team_drives : Bool | Nil = nil, transfer_ownership : Bool | Nil = nil, use_domain_admin_access : Bool | Nil = nil, permission : GoogleDrive::Permission | Nil = nil) : Tuple(GoogleDrive::Permission, Int32, Hash(String, Array(String) | String)) #

Updates a permission with patch semantics. @required @param file_id [String?] The ID of the file or shared drive. @required @param permission_id [String?] The ID of the permission. @optional @param alt [String?] Data format for the response. @optional @param fields [String?] Selector specifying which fields to include in a partial response. @optional @param key [String?] API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. @optional @param oauth_token [String?] OAuth 2.0 token for the current user. @optional @param pretty_print [Bool?] Returns response with indentations and line breaks. @optional @param quota_user [String?] An opaque string that represents a user for quota purposes. Must not exceed 40 characters. @optional @param user_ip [String?] Deprecated. Please use quotaUser instead. @optional @param remove_expiration [Bool?] Whether to remove the expiration date. @optional @param supports_all_drives [Bool?] Whether the requesting application supports both My Drives and shared drives. @optional @param supports_team_drives [Bool?] Deprecated use supportsAllDrives instead. @optional @param 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. @optional @param 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. @optional @param permission [GoogleDrive::Permission?] @return [Tuple(GoogleDrive::Permission, Integer, Hash)] GoogleDrive::Permission, response status code and response headers


[View source]