package gapi-ocaml

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
val create : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?custom_headers:GapiCore.Header.t list -> requestId:string -> GapiDriveV3Model.Drive.t -> GapiConversation.Session.t -> GapiDriveV3Model.Drive.t * GapiConversation.Session.t

Creates a new shared drive.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter custom_headers

    Optional HTTP custom headers.

  • parameter requestId

    An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.

val delete : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?custom_headers:GapiCore.Header.t list -> driveId:string -> GapiConversation.Session.t -> unit * GapiConversation.Session.t

Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter custom_headers

    Optional HTTP custom headers.

  • parameter driveId

    The ID of the shared drive.

val get : ?base_url:string -> ?etag:string -> ?std_params:GapiService.StandardParameters.t -> ?custom_headers:GapiCore.Header.t list -> ?useDomainAdminAccess:bool -> driveId:string -> GapiConversation.Session.t -> GapiDriveV3Model.Drive.t * GapiConversation.Session.t

Gets a shared drive's metadata 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 custom_headers

    Optional HTTP custom headers.

  • parameter useDomainAdminAccess

    Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.

  • parameter driveId

    The ID of the shared drive.

val hide : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?custom_headers:GapiCore.Header.t list -> driveId:string -> GapiConversation.Session.t -> GapiDriveV3Model.Drive.t * GapiConversation.Session.t

Hides a shared drive from the default view.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter custom_headers

    Optional HTTP custom headers.

  • parameter driveId

    The ID of the shared drive.

val list : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?custom_headers:GapiCore.Header.t list -> ?pageSize:int -> ?useDomainAdminAccess:bool -> ?pageToken:string -> ?q:string -> GapiConversation.Session.t -> GapiDriveV3Model.DriveList.t * GapiConversation.Session.t

Lists the user's shared drives.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter custom_headers

    Optional HTTP custom headers.

  • parameter pageSize

    Maximum number of shared drives to return per page.

  • parameter useDomainAdminAccess

    Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.

  • parameter pageToken

    Page token for shared drives.

  • parameter q

    Query string for searching shared drives.

val unhide : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?custom_headers:GapiCore.Header.t list -> driveId:string -> GapiConversation.Session.t -> GapiDriveV3Model.Drive.t * GapiConversation.Session.t

Restores a shared drive to the default view.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter custom_headers

    Optional HTTP custom headers.

  • parameter driveId

    The ID of the shared drive.

val update : ?base_url:string -> ?std_params:GapiService.StandardParameters.t -> ?custom_headers:GapiCore.Header.t list -> ?useDomainAdminAccess:bool -> driveId:string -> GapiDriveV3Model.Drive.t -> GapiConversation.Session.t -> GapiDriveV3Model.Drive.t * GapiConversation.Session.t

Updates the metadate for a shared drive.

  • parameter base_url

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

  • parameter std_params

    Optional standard parameters.

  • parameter custom_headers

    Optional HTTP custom headers.

  • parameter useDomainAdminAccess

    Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the shared drive belongs.

  • parameter driveId

    The ID of the shared drive.

OCaml

Innovation. Community. Security.