google_api_admin

v0.18.0

google_api_admin v0.18.0 GoogleApi.Admin.Directory_v1.Api.Notifications View Source

API calls for all endpoints tagged Notifications.

Link to this section Summary

Functions

directory_notifications_delete(connection, customer, notification_id, optional_params \\ [], opts \\ [])

Deletes a notification

directory_notifications_get(connection, customer, notification_id, optional_params \\ [], opts \\ [])

Retrieves a notification.

directory_notifications_list(connection, customer, optional_params \\ [], opts \\ [])

Retrieves a list of notifications.

directory_notifications_patch(connection, customer, notification_id, optional_params \\ [], opts \\ [])

Updates a notification. This method supports patch semantics.

directory_notifications_update(connection, customer, notification_id, optional_params \\ [], opts \\ [])

Updates a notification.

Link to this section Functions

Link to this function

directory_notifications_delete(connection, customer, notification_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Deletes a notification

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer (type: String.t) - The unique ID for the customer's G Suite account. The customerId is also returned as part of the Users resource.
  • notification_id (type: String.t) - The unique ID of the notification.
  • 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

directory_notifications_get(connection, customer, notification_id, optional_params \\ [], opts \\ [])

View Source

Specs

directory_notifications_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.Notification.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Retrieves a notification.

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer (type: String.t) - The unique ID for the customer's G Suite account. The customerId is also returned as part of the Users resource.
  • notification_id (type: String.t) - The unique ID of the notification.
  • 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, %GoogleApi.Admin.Directory_v1.Model.Notification{}} on success
  • {:error, info} on failure
Link to this function

directory_notifications_list(connection, customer, optional_params \\ [], opts \\ [])

View Source

Specs

directory_notifications_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.Notifications.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Retrieves a list of notifications.

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer (type: String.t) - The unique ID for the customer's G Suite account.
  • 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.
    • :language (type: String.t) - The ISO 639-1 code of the language notifications are returned in. The default is English (en).
    • :maxResults (type: integer()) - Maximum number of notifications to return per page. The default is 100.
    • :pageToken (type: String.t) - The token to specify the page of results to retrieve.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Directory_v1.Model.Notifications{}} on success
  • {:error, info} on failure
Link to this function

directory_notifications_patch(connection, customer, notification_id, optional_params \\ [], opts \\ [])

View Source

Specs

directory_notifications_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.Notification.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates a notification. This method supports patch semantics.

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer (type: String.t) - The unique ID for the customer's G Suite account.
  • notification_id (type: String.t) - The unique ID of the notification.
  • 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.Admin.Directory_v1.Model.Notification.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Directory_v1.Model.Notification{}} on success
  • {:error, info} on failure
Link to this function

directory_notifications_update(connection, customer, notification_id, optional_params \\ [], opts \\ [])

View Source

Specs

directory_notifications_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.Notification.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates a notification.

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • customer (type: String.t) - The unique ID for the customer's G Suite account.
  • notification_id (type: String.t) - The unique ID of the notification.
  • 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.Admin.Directory_v1.Model.Notification.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Directory_v1.Model.Notification{}} on success
  • {:error, info} on failure