google_api_drive v0.1.0 GoogleApi.Drive.V3.Api.Teamdrives View Source

API calls for all endpoints tagged Teamdrives.

Link to this section Summary

Functions

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

Lists the user's Team Drives

Link to this section Functions

Link to this function drive_teamdrives_create(connection, request_id, opts \\ []) View Source
drive_teamdrives_create(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.TeamDrive.t()} | {:error, Tesla.Env.t()}

Creates a new Team Drive.

Parameters

  • connection (GoogleApi.Drive.V3.Connection): Connection to server
  • request_id (String.t): An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (TeamDrive):

Returns

{:ok, %GoogleApi.Drive.V3.Model.TeamDrive{}} on success {:error, info} on failure

Link to this function drive_teamdrives_delete(connection, team_drive_id, opts \\ []) View Source
drive_teamdrives_delete(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

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

Parameters

  • connection (GoogleApi.Drive.V3.Connection): Connection to server
  • team_drive_id (String.t): The ID of the Team Drive
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function drive_teamdrives_get(connection, team_drive_id, opts \\ []) View Source
drive_teamdrives_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.TeamDrive.t()} | {:error, Tesla.Env.t()}

Gets a Team Drive's metadata by ID.

Parameters

  • connection (GoogleApi.Drive.V3.Connection): Connection to server
  • team_drive_id (String.t): The ID of the Team Drive
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :useDomainAdminAccess (boolean()): Whether the request should be treated as if it was issued by 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 Team Drive belongs.

Returns

{:ok, %GoogleApi.Drive.V3.Model.TeamDrive{}} on success {:error, info} on failure

Link to this function drive_teamdrives_list(connection, opts \\ []) View Source
drive_teamdrives_list(Tesla.Env.client(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.TeamDriveList.t()} | {:error, Tesla.Env.t()}

Lists the user's Team Drives.

Parameters

  • connection (GoogleApi.Drive.V3.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :pageSize (integer()): Maximum number of Team Drives to return.
    • :pageToken (String.t): Page token for Team Drives.
    • :q (String.t): Query string for searching Team Drives.
    • :useDomainAdminAccess (boolean()): Whether the request should be treated as if it was issued by a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.

Returns

{:ok, %GoogleApi.Drive.V3.Model.TeamDriveList{}} on success {:error, info} on failure

Link to this function drive_teamdrives_update(connection, team_drive_id, opts \\ []) View Source
drive_teamdrives_update(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.TeamDrive.t()} | {:error, Tesla.Env.t()}

Updates a Team Drive's metadata

Parameters

  • connection (GoogleApi.Drive.V3.Connection): Connection to server
  • team_drive_id (String.t): The ID of the Team Drive
  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (String.t): 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.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :body (TeamDrive):

Returns

{:ok, %GoogleApi.Drive.V3.Model.TeamDrive{}} on success {:error, info} on failure