google_api_alert_center v0.11.2

GoogleApi.AlertCenter.V1beta1.Api.V1beta1 (google_api_alert_center v0.11.2) View Source

API calls for all endpoints tagged V1beta1.

Link to this section Summary

Functions

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

Returns customer-level settings.

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

Updates the customer-level settings.

Link to this section Functions

Link to this function

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

View Source

Specs

alertcenter_get_settings(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.AlertCenter.V1beta1.Model.Settings.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Returns customer-level settings.

Parameters

  • connection (type: GoogleApi.AlertCenter.V1beta1.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").
    • :customerId (type: String.t) - Optional. The unique identifier of the Google Workspace organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AlertCenter.V1beta1.Model.Settings{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

alertcenter_update_settings(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.AlertCenter.V1beta1.Model.Settings.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates the customer-level settings.

Parameters

  • connection (type: GoogleApi.AlertCenter.V1beta1.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").
    • :customerId (type: String.t) - Optional. The unique identifier of the Google Workspace organization account of the customer the alert settings are associated with. Inferred from the caller identity if not provided.
    • :body (type: GoogleApi.AlertCenter.V1beta1.Model.Settings.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AlertCenter.V1beta1.Model.Settings{}} on success
  • {:error, info} on failure