gapi-ocaml 0.4.1 · OCaml Package

gapi-ocaml

val create : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?enforceSingleParent:bool ->
  ?moveToNewOwnersRoot:bool ->
  ?supportsAllDrives:bool ->
  ?supportsTeamDrives:bool ->
  ?transferOwnership:bool ->
  ?useDomainAdminAccess:bool ->
  ?emailMessage:string ->
  ?sendNotificationEmail:bool ->
  fileId:string ->
  GapiDriveV3Model.Permission.t ->
  GapiConversation.Session.t ->
  GapiDriveV3Model.Permission.t * GapiConversation.Session.t

Creates a permission for a file or shared drive.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/drive/v3/").

parameter std_params
Optional standard parameters.

parameter enforceSingleParent
Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. See moveToNewOwnersRoot for details.

parameter moveToNewOwnersRoot
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. When 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, when enforceSingleParent=true, parents are not changed. If set to false, when enforceSingleParent=false, existing parents are not changed; however, the file will be added to the new owner's My Drive root folder, unless it is already in the new owner's My Drive.

parameter supportsAllDrives
Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

parameter supportsTeamDrives
Deprecated use supportsAllDrives instead.

parameter transferOwnership
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.

parameter useDomainAdminAccess
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.

parameter emailMessage
A plain text custom message to include in the notification email.

parameter sendNotificationEmail
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.

parameter fileId
The ID of the file or shared drive.

val delete : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?supportsAllDrives:bool ->
  ?supportsTeamDrives:bool ->
  ?useDomainAdminAccess:bool ->
  fileId:string ->
  permissionId:string ->
  GapiConversation.Session.t ->
  unit * GapiConversation.Session.t

Deletes a permission.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/drive/v3/").

parameter std_params
Optional standard parameters.

parameter supportsAllDrives
Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

parameter supportsTeamDrives
Deprecated use supportsAllDrives instead.

parameter useDomainAdminAccess
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.

parameter fileId
The ID of the file or shared drive.

parameter permissionId
The ID of the permission.

val get : 
  ?base_url:string ->
  ?etag:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?supportsAllDrives:bool ->
  ?supportsTeamDrives:bool ->
  ?useDomainAdminAccess:bool ->
  fileId:string ->
  permissionId:string ->
  GapiConversation.Session.t ->
  GapiDriveV3Model.Permission.t * GapiConversation.Session.t

Gets a permission by ID.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/drive/v3/").

parameter etag
Optional ETag.

parameter std_params
Optional standard parameters.

parameter supportsAllDrives
Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

parameter supportsTeamDrives
Deprecated use supportsAllDrives instead.

parameter useDomainAdminAccess
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.

parameter fileId
The ID of the file.

parameter permissionId
The ID of the permission.

val list : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?supportsAllDrives:bool ->
  ?supportsTeamDrives:bool ->
  ?useDomainAdminAccess:bool ->
  ?pageSize:int ->
  ?pageToken:string ->
  fileId:string ->
  GapiConversation.Session.t ->
  GapiDriveV3Model.PermissionList.t * GapiConversation.Session.t

Lists a file's or shared drive's permissions.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/drive/v3/").

parameter std_params
Optional standard parameters.

parameter supportsAllDrives
Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

parameter supportsTeamDrives
Deprecated use supportsAllDrives instead.

parameter useDomainAdminAccess
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.

parameter pageSize
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.

parameter pageToken
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.

parameter fileId
The ID of the file or shared drive.

val update : 
  ?base_url:string ->
  ?std_params:GapiService.StandardParameters.t ->
  ?removeExpiration:bool ->
  ?supportsAllDrives:bool ->
  ?supportsTeamDrives:bool ->
  ?transferOwnership:bool ->
  ?useDomainAdminAccess:bool ->
  fileId:string ->
  permissionId:string ->
  GapiDriveV3Model.Permission.t ->
  GapiConversation.Session.t ->
  GapiDriveV3Model.Permission.t * GapiConversation.Session.t

Updates a permission with patch semantics.

parameter base_url
Service endpoint base URL (defaults to "https://www.googleapis.com/drive/v3/").

parameter std_params
Optional standard parameters.

parameter removeExpiration
Whether to remove the expiration date.

parameter supportsAllDrives
Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

parameter supportsTeamDrives
Deprecated use supportsAllDrives instead.

parameter transferOwnership
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.

parameter useDomainAdminAccess
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.

parameter fileId
The ID of the file or shared drive.

parameter permissionId
The ID of the permission.

package gapi-ocaml