1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
use anyhow::Result;
use crate::Client;
pub struct SuppressionsGlobal {
pub client: Client,
}
impl SuppressionsGlobal {
#[doc(hidden)]
pub fn new(client: Client) -> Self
{
SuppressionsGlobal {
client,
}
}
/**
* Add recipient addresses to the global suppression group.
*
* This function performs a `POST` to the `/asm/suppressions/global` endpoint.
*
* **This endpoint allows you to add one or more email addresses to the global suppressions group.**
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn post_asm_suppressions_global(
&self,
on_behalf_of: &str,
body: &crate::types::SuppressionsRequestBody
) -> Result<crate::types::SuppressionsRequestBody> {
let url =
"/asm/suppressions/global".to_string();
self.client.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body).unwrap()))).await
}
/**
* Retrieve all global suppressions.
*
* This function performs a `GET` to the `/suppression/unsubscribes` endpoint.
*
* **This endpoint allows you to retrieve a list of all email address that are globally suppressed.**
*
* **Parameters:**
*
* * `start_time: i64` -- Refers start of the time range in unix timestamp when an unsubscribe email was created (inclusive).
* * `end_time: i64` -- Refers end of the time range in unix timestamp when an unsubscribe email was created (inclusive).
* * `limit: i64` -- The number of results to display on each page.
* * `offset: i64` -- The point in the list of results to begin displaying global suppressions.
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_suppression_unsubscribes(
&self,
start_time: i64, end_time: i64, limit: i64, offset: i64, on_behalf_of: &str,
) -> Result<Vec<crate::types::GetSuppressionUnsubscribesResponse>> {
let mut query_args: Vec<(String, String)> = Default::default();
if end_time > 0 { query_args.push(("end_time".to_string(), end_time.to_string())); }
if limit > 0 { query_args.push(("limit".to_string(), limit.to_string())); }
if offset > 0 { query_args.push(("offset".to_string(), offset.to_string())); }
if start_time > 0 { query_args.push(("start_time".to_string(), start_time.to_string())); }
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url =
format!("/suppression/unsubscribes?{}",
query_);
self.client.get(&url, None).await
}
/**
* Retrieve all global suppressions.
*
* This function performs a `GET` to the `/suppression/unsubscribes` endpoint.
*
* As opposed to `get_suppression_unsubscribes`, this function returns all the pages of the request at once.
*
* **This endpoint allows you to retrieve a list of all email address that are globally suppressed.**
*/
pub async fn get_all_suppression_unsubscribes(
&self,
start_time: i64, end_time: i64, limit: i64, offset: i64, on_behalf_of: &str,
) -> Result<Vec<crate::types::GetSuppressionUnsubscribesResponse>> {
let mut query_args: Vec<(String, String)> = Default::default();
if end_time > 0 { query_args.push(("end_time".to_string(), end_time.to_string())); }
if limit > 0 { query_args.push(("limit".to_string(), limit.to_string())); }
if offset > 0 { query_args.push(("offset".to_string(), offset.to_string())); }
if start_time > 0 { query_args.push(("start_time".to_string(), start_time.to_string())); }
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url =
format!("/suppression/unsubscribes?{}",
query_);
self.client.get_all_pages(&url, None).await
}
/**
* Retrieve a Global Suppression.
*
* This function performs a `GET` to the `/asm/suppressions/global/{email}` endpoint.
*
* **This endpoint allows you to retrieve a global suppression. You can also use this endpoint to confirm if an email address is already globally suppresed.**
*
* If the email address you include in the URL path parameter `{email}` is already globally suppressed, the response will include that email address. If the address you enter for `{email}` is not globally suppressed, an empty JSON object `{}` will be returned.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_asm_suppressions_global_email(
&self,
email: &str, on_behalf_of: &str,
) -> Result<crate::types::RetrieveAGlobalSuppressionResponse> {
let url =
format!("/asm/suppressions/global/{}",
crate::progenitor_support::encode_path(&email.to_string()),);
self.client.get(&url, None).await
}
/**
* Delete a Global Suppression.
*
* This function performs a `DELETE` to the `/asm/suppressions/global/{email}` endpoint.
*
* **This endpoint allows you to remove an email address from the global suppressions group.**
*
* Deleting a suppression group 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_suppressions_global_email(
&self,
email: &str, on_behalf_of: &str,
) -> Result<crate::types::Help> {
let url =
format!("/asm/suppressions/global/{}",
crate::progenitor_support::encode_path(&email.to_string()),);
self.client.delete(&url, None).await
}
}