View Source GoogleApi.Drive.V3.Api.Teamdrives (google_api_drive v0.25.0)

API calls for all endpoints tagged Teamdrives.

Link to this section Summary

Link to this section Functions

Link to this function

drive_teamdrives_create(connection, request_id, optional_params \\ [], opts \\ [])

View Source

Specs

drive_teamdrives_create(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.TeamDrive.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deprecated use drives.create instead.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • request_id (type: 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.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :body (type: GoogleApi.Drive.V3.Model.TeamDrive.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.TeamDrive{}} on success
  • {:error, info} on failure
Link to this function

drive_teamdrives_delete(connection, team_drive_id, optional_params \\ [], opts \\ [])

View Source

Specs

drive_teamdrives_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Deprecated use drives.delete instead.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • team_drive_id (type: String.t) - The ID of the Team Drive
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

drive_teamdrives_get(connection, team_drive_id, optional_params \\ [], opts \\ [])

View Source

Specs

drive_teamdrives_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.TeamDrive.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deprecated use drives.get instead.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • team_drive_id (type: String.t) - The ID of the Team Drive
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :useDomainAdminAccess (type: boolean()) - 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 Team Drive belongs.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.TeamDrive{}} on success
  • {:error, info} on failure
Link to this function

drive_teamdrives_list(connection, optional_params \\ [], opts \\ [])

View Source

Specs

drive_teamdrives_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.TeamDriveList.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deprecated use drives.list instead.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :pageSize (type: integer()) - Maximum number of Team Drives to return.
    • :pageToken (type: String.t) - Page token for Team Drives.
    • :q (type: String.t) - Query string for searching Team Drives.
    • :useDomainAdminAccess (type: boolean()) - Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.TeamDriveList{}} on success
  • {:error, info} on failure
Link to this function

drive_teamdrives_update(connection, team_drive_id, optional_params \\ [], opts \\ [])

View Source

Specs

drive_teamdrives_update(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.TeamDrive.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deprecated use drives.update instead

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • team_drive_id (type: String.t) - The ID of the Team Drive
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :useDomainAdminAccess (type: boolean()) - 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 Team Drive belongs.
    • :body (type: GoogleApi.Drive.V3.Model.TeamDrive.t) -
  • opts (type: keyword()) - Call options

Returns

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