use anyhow::Result;
use crate::Client;
pub struct Suppressions {
pub client: Client,
}
impl Suppressions {
#[doc(hidden)]
pub fn new(client: Client) -> Self
{
Suppressions {
client,
}
}
/**
* Retrieve all suppressions for a suppression group.
*
* This function performs a `GET` to the `/asm/groups/{group_id}/suppressions` endpoint.
*
* **This endpoint allows you to retrieve all suppressed email addresses belonging to the given group.**
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_asm_groups_group_suppressions(
&self,
group_id: &str, on_behalf_of: &str,
) -> Result<Vec<String>> {
let url =
format!("/asm/groups/{}/suppressions",
crate::progenitor_support::encode_path(&group_id.to_string()),);
self.client.get(&url, None).await
}
/**
* Retrieve all suppressions for a suppression group.
*
* This function performs a `GET` to the `/asm/groups/{group_id}/suppressions` endpoint.
*
* As opposed to `get_asm_groups_group_suppressions`, this function returns all the pages of the request at once.
*
* **This endpoint allows you to retrieve all suppressed email addresses belonging to the given group.**
*/
pub async fn get_all_asm_groups_group_suppressions(
&self,
group_id: &str, on_behalf_of: &str,
) -> Result<Vec<String>> {
let url =
format!("/asm/groups/{}/suppressions",
crate::progenitor_support::encode_path(&group_id.to_string()),);
self.client.get_all_pages(&url, None).await
}
/**
* Add suppressions to a suppression group.
*
* This function performs a `POST` to the `/asm/groups/{group_id}/suppressions` endpoint.
*
* **This endpoint allows you to add email addresses to an unsubscribe group.**
*
* If you attempt to add suppressions to a group that has been deleted or does not exist, the suppressions will be added to the global suppressions list.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn post_asm_groups_group_suppression(
&self,
group_id: &str, on_behalf_of: &str,
body: &crate::types::SuppressionsRequestBody
) -> Result<crate::types::PostAsmGroupsGroupSuppressionsResponse> {
let url =
format!("/asm/groups/{}/suppressions",
crate::progenitor_support::encode_path(&group_id.to_string()),);
self.client.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body).unwrap()))).await
}
/**
* Search for suppressions within a group.
*
* This function performs a `POST` to the `/asm/groups/{group_id}/suppressions/search` endpoint.
*
* **This endpoint allows you to search a suppression group for multiple suppressions.**
*
* When given a list of email addresses and a group ID, this endpoint will only return the email addresses that have been unsubscribed from the given group.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn post_asm_groups_group_suppressions_search(
&self,
group_id: &str, on_behalf_of: &str,
body: &crate::types::SuppressionsRequestBody
) -> Result<Vec<String>> {
let url =
format!("/asm/groups/{}/suppressions/search",
crate::progenitor_support::encode_path(&group_id.to_string()),);
self.client.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body).unwrap()))).await
}
/**
* Retrieve all suppressions.
*
* This function performs a `GET` to the `/asm/suppressions` endpoint.
*
* **This endpoint allows you to retrieve a list of all suppressions.**
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_asm_suppressions(
&self,
on_behalf_of: &str,
) -> Result<Vec<crate::types::GetAsmSuppressionsResponse>> {
let url =
"/asm/suppressions".to_string();
self.client.get(&url, None).await
}
/**
* Retrieve all suppressions.
*
* This function performs a `GET` to the `/asm/suppressions` endpoint.
*
* As opposed to `get_asm_suppressions`, this function returns all the pages of the request at once.
*
* **This endpoint allows you to retrieve a list of all suppressions.**
*/
pub async fn get_all_asm_suppressions(
&self,
on_behalf_of: &str,
) -> Result<Vec<crate::types::GetAsmSuppressionsResponse>> {
let url =
"/asm/suppressions".to_string();
self.client.get_all_pages(&url, None).await
}
/**
* Retrieve all suppression groups for an email address.
*
* This function performs a `GET` to the `/asm/suppressions/{email}` endpoint.
*
* **This endpoint returns a list of all groups from which the given email address has been unsubscribed.**
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_asm_suppressions_email(
&self,
email: &str, on_behalf_of: &str,
) -> Result<crate::types::GetAsmSuppressionsEmailResponse> {
let url =
format!("/asm/suppressions/{}",
crate::progenitor_support::encode_path(&email.to_string()),);
self.client.get(&url, None).await
}
/**
* Delete a suppression from a suppression group.
*
* This function performs a `DELETE` to the `/asm/groups/{group_id}/suppressions/{email}` endpoint.
*
* **This endpoint allows you to remove a suppressed email address from the given suppression group.**
*
* Removing an address will remove the suppression, meaning email will once again be sent to the previously suppressed addresses. This should be avoided unless a recipient indicates they wish to receive email from you again. You can use our [bypass filters](https://sendgrid.com/docs/ui/sending-email/index-suppressions/#bypass-suppressions) to deliver messages to otherwise suppressed addresses when exceptions are required.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn delete_asm_groups_group_suppressions_email(
&self,
group_id: &str, email: &str, on_behalf_of: &str,
) -> Result<()> {
let url =
format!("/asm/groups/{}/suppressions/{}",
crate::progenitor_support::encode_path(&group_id.to_string()),crate::progenitor_support::encode_path(&email.to_string()),);
self.client.delete(&url, None).await
}
}