Struct sendgrid_api::alerts::Alerts

pub struct Alerts {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Alerts

pub async fn get_page( &self ) -> Result<Response<Vec<GetAlertsResponse>>, ClientError>

Retrieve all alerts.

This function performs a GET to the /alerts endpoint.

This endpoint allows you to retrieve all of your alerts.

Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics.

• Usage alerts allow you to set the threshold at which an alert will be sent.
• Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, “daily”, “weekly”, or “monthly”.

For more information about alerts, please see our Alerts documentation.

Parameters:

• authorization: &str – The license key provided with your New Relic account.
• on_behalf_of: &str – The license key provided with your New Relic account.

pub async fn get_all( &self ) -> Result<Response<Vec<GetAlertsResponse>>, ClientError>

Retrieve all alerts.

This function performs a GET to the /alerts endpoint.

As opposed to get, this function returns all the pages of the request at once.

This endpoint allows you to retrieve all of your alerts.

Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics.

• Usage alerts allow you to set the threshold at which an alert will be sent.
• Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, “daily”, “weekly”, or “monthly”.

For more information about alerts, please see our Alerts documentation.

pub async fn post( &self, body: &PostAlertsRequest ) -> Result<Response<PostAlertsResponse>, ClientError>

Create a new Alert.

This function performs a POST to the /alerts endpoint.

This endpoint allows you to create a new alert.

Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics. There are two types of alerts that can be created with this endpoint:

• usage_limit allows you to set the threshold at which an alert will be sent.
• stats_notification allows you to set how frequently you would like to receive email statistics reports. For example, “daily”, “weekly”, or “monthly”.

For more information about alerts, please see our Alerts documentation.

Parameters:

• authorization: &str – The license key provided with your New Relic account.
• on_behalf_of: &str – The license key provided with your New Relic account.

pub async fn get( &self, alert_id: i64 ) -> Result<Response<GetAlertsAlertResponse>, ClientError>

Retrieve a specific alert.

This function performs a GET to the /alerts/{alert_id} endpoint.

This endpoint allows you to retrieve a specific alert.

Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics.

• Usage alerts allow you to set the threshold at which an alert will be sent.
• Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, “daily”, “weekly”, or “monthly”.

For more information about alerts, please see our Alerts documentation.

Parameters:

• authorization: &str – The license key provided with your New Relic account.
• on_behalf_of: &str – The license key provided with your New Relic account.

pub async fn delete(&self, alert_id: i64) -> Result<Response<Help>, ClientError>

Delete an alert.

This function performs a DELETE to the /alerts/{alert_id} endpoint.

This endpoint allows you to delete an alert.

Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics.

• Usage alerts allow you to set the threshold at which an alert will be sent.
• Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, “daily”, “weekly”, or “monthly”.

For more information about alerts, please see our Alerts documentation.

Parameters:

• on_behalf_of: &str – The license key provided with your New Relic account.

pub async fn patch( &self, alert_id: i64, body: &PatchAlertsAlertRequest ) -> Result<Response<GetAlertsAlertResponse>, ClientError>

Update an alert.

This function performs a PATCH to the /alerts/{alert_id} endpoint.

This endpoint allows you to update an alert.

Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics.

• Usage alerts allow you to set the threshold at which an alert will be sent.
• Stats notifications allow you to set how frequently you would like to receive email statistics reports. For example, “daily”, “weekly”, or “monthly”.

For more information about alerts, please see our Alerts documentation.

Parameters:

• on_behalf_of: &str – The license key provided with your New Relic account.