google_api_home_graph v0.6.0 GoogleApi.HomeGraph.V1.Api.AgentUsers View Source

API calls for all endpoints tagged AgentUsers.

Link to this section Summary

Functions

Unlinks the given third-party user from your smart home Action. All data related to this user will be deleted.

Link to this section Functions

Link to this function

homegraph_agent_users_delete(connection, agent_users_id, optional_params \\ [], opts \\ [])

View Source

Specs

homegraph_agent_users_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.HomeGraph.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Unlinks the given third-party user from your smart home Action. All data related to this user will be deleted.

For more details on how users link their accounts, see fulfillment and authentication.

The third-party user's identity is passed in via the agent_user_id (see DeleteAgentUserRequest). This request must be authorized using service account credentials from your Actions console project.

Parameters

  • connection (type: GoogleApi.HomeGraph.V1.Connection.t) - Connection to server
  • agent_users_id (type: String.t) - Part of agentUserId. Required. Third-party user ID.
  • 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").
    • :requestId (type: String.t) - Request ID used for debugging.
  • opts (type: keyword()) - Call options

Returns

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