View Source GoogleApi.Tasks.V1.Api.Tasklists (google_api_tasks v0.14.1)

API calls for all endpoints tagged Tasklists.

Summary

Functions

Deletes the authenticated user's specified task list.

Returns the authenticated user's specified task list.

Creates a new task list and adds it to the authenticated user's task lists. A user can have up to 2000 lists at a time.

Returns all the authenticated user's task lists. A user can have up to 2000 lists at a time.

Updates the authenticated user's specified task list. This method supports patch semantics.

Updates the authenticated user's specified task list.

Functions

Link to this function

tasks_tasklists_delete(connection, tasklist, optional_params \\ [], opts \\ [])

View Source
@spec tasks_tasklists_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Deletes the authenticated user's specified task list.

Parameters

  • connection (type: GoogleApi.Tasks.V1.Connection.t) - Connection to server
  • tasklist (type: String.t) - Task list identifier.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

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

tasks_tasklists_get(connection, tasklist, optional_params \\ [], opts \\ [])

View Source
@spec tasks_tasklists_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Tasks.V1.Model.TaskList.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the authenticated user's specified task list.

Parameters

  • connection (type: GoogleApi.Tasks.V1.Connection.t) - Connection to server
  • tasklist (type: String.t) - Task list identifier.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Tasks.V1.Model.TaskList{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
@spec tasks_tasklists_insert(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Tasks.V1.Model.TaskList.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new task list and adds it to the authenticated user's task lists. A user can have up to 2000 lists at a time.

Parameters

  • connection (type: GoogleApi.Tasks.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Tasks.V1.Model.TaskList.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Tasks.V1.Model.TaskList{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
@spec tasks_tasklists_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Tasks.V1.Model.TaskLists.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns all the authenticated user's task lists. A user can have up to 2000 lists at a time.

Parameters

  • connection (type: GoogleApi.Tasks.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :maxResults (type: integer()) - Maximum number of task lists returned on one page. Optional. The default is 20 (max allowed: 100).
    • :pageToken (type: String.t) - Token specifying the result page to return. Optional.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Tasks.V1.Model.TaskLists{}} on success
  • {:error, info} on failure
Link to this function

tasks_tasklists_patch(connection, tasklist, optional_params \\ [], opts \\ [])

View Source
@spec tasks_tasklists_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Tasks.V1.Model.TaskList.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the authenticated user's specified task list. This method supports patch semantics.

Parameters

  • connection (type: GoogleApi.Tasks.V1.Connection.t) - Connection to server
  • tasklist (type: String.t) - Task list identifier.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Tasks.V1.Model.TaskList.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Tasks.V1.Model.TaskList{}} on success
  • {:error, info} on failure
Link to this function

tasks_tasklists_update(connection, tasklist, optional_params \\ [], opts \\ [])

View Source
@spec tasks_tasklists_update(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Tasks.V1.Model.TaskList.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the authenticated user's specified task list.

Parameters

  • connection (type: GoogleApi.Tasks.V1.Connection.t) - Connection to server
  • tasklist (type: String.t) - Task list identifier.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Tasks.V1.Model.TaskList.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Tasks.V1.Model.TaskList{}} on success
  • {:error, info} on failure