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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
use crate::Client;
use crate::ClientResult;
pub struct IpAddresses {
pub client: Client,
}
impl IpAddresses {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
IpAddresses { client }
}
/**
* Retrieve all IP addresses.
*
* This function performs a `GET` to the `/ips` endpoint.
*
* **This endpoint allows you to retrieve a list of all assigned and unassigned IPs.**
*
* Response includes warm up status, pools, assigned subusers, and reverse DNS info. The start_date field corresponds to when warmup started for that IP.
*
* A single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it.
*
* **Parameters:**
*
* * `ip: &str` -- The license key provided with your New Relic account.
* * `exclude_whitelabels: bool` -- Indicates if your subuser statistics will be sent to your New Relic Dashboard.
* * `limit: i64` -- The number of IPs you want returned at the same time.
* * `offset: i64` -- The offset for the number of IPs that you are requesting.
* * `subuser: &str` -- The license key provided with your New Relic account.
* * `sort_by_direction: crate::types::SortByDirection` -- The direction to sort the results.
*/
pub async fn get_ips(
&self,
ip: &str,
exclude_whitelabels: bool,
limit: i64,
offset: i64,
subuser: &str,
sort_by_direction: crate::types::SortByDirection,
) -> ClientResult<crate::Response<Vec<crate::types::GetIpsResponse>>> {
let mut query_args: Vec<(String, String)> = Default::default();
if exclude_whitelabels {
query_args.push((
"exclude_whitelabels".to_string(),
exclude_whitelabels.to_string(),
));
}
if !ip.is_empty() {
query_args.push(("ip".to_string(), ip.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 !sort_by_direction.to_string().is_empty() {
query_args.push((
"sort_by_direction".to_string(),
sort_by_direction.to_string(),
));
}
if !subuser.is_empty() {
query_args.push(("subuser".to_string(), subuser.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(&format!("/ips?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Retrieve all IP addresses.
*
* This function performs a `GET` to the `/ips` endpoint.
*
* As opposed to `get_ips`, this function returns all the pages of the request at once.
*
* **This endpoint allows you to retrieve a list of all assigned and unassigned IPs.**
*
* Response includes warm up status, pools, assigned subusers, and reverse DNS info. The start_date field corresponds to when warmup started for that IP.
*
* A single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it.
*/
pub async fn get_all_ips(
&self,
ip: &str,
exclude_whitelabels: bool,
offset: i64,
subuser: &str,
sort_by_direction: crate::types::SortByDirection,
) -> ClientResult<crate::Response<Vec<crate::types::GetIpsResponse>>> {
let mut query_args: Vec<(String, String)> = Default::default();
if exclude_whitelabels {
query_args.push((
"exclude_whitelabels".to_string(),
exclude_whitelabels.to_string(),
));
}
if !ip.is_empty() {
query_args.push(("ip".to_string(), ip.to_string()));
}
if offset > 0 {
query_args.push(("offset".to_string(), offset.to_string()));
}
if !sort_by_direction.to_string().is_empty() {
query_args.push((
"sort_by_direction".to_string(),
sort_by_direction.to_string(),
));
}
if !subuser.is_empty() {
query_args.push(("subuser".to_string(), subuser.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(&format!("/ips?{}", query_), None);
self.client
.get_all_pages(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Add IPs.
*
* This function performs a `POST` to the `/ips` endpoint.
*
* **This endpoint is for adding a(n) IP Address(es) to your account.**
*/
pub async fn post_ip(
&self,
body: &crate::types::PostIpsRequest,
) -> ClientResult<crate::Response<crate::types::PostIpsResponseData>> {
let url = self.client.url("/ips", None);
self.client
.post(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Get remaining IPs count.
*
* This function performs a `GET` to the `/ips/remaining` endpoint.
*
* **This endpoint gets amount of IP Addresses that can still be created during a given period and the price of those IPs.**
*/
pub async fn get_ips_remaining(
&self,
) -> ClientResult<crate::Response<crate::types::GetIpsRemainingResponse>> {
let url = self.client.url("/ips/remaining", None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Retrieve all assigned IPs.
*
* This function performs a `GET` to the `/ips/assigned` endpoint.
*
* **This endpoint allows you to retrieve only assigned IP addresses.**
*
* A single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it.
*/
pub async fn get_ips_assigned(
&self,
) -> ClientResult<crate::Response<Vec<crate::types::GetIpsAssignedResponse>>> {
let url = self.client.url("/ips/assigned", None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Retrieve all assigned IPs.
*
* This function performs a `GET` to the `/ips/assigned` endpoint.
*
* As opposed to `get_ips_assigned`, this function returns all the pages of the request at once.
*
* **This endpoint allows you to retrieve only assigned IP addresses.**
*
* A single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it.
*/
pub async fn get_all_ips_assigned(
&self,
) -> ClientResult<crate::Response<Vec<crate::types::GetIpsAssignedResponse>>> {
let url = self.client.url("/ips/assigned", None);
self.client
.get_all_pages(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Retrieve all IP pools an IP address belongs to.
*
* This function performs a `GET` to the `/ips/{ip_address}` endpoint.
*
* **This endpoint allows you to see which IP pools a particular IP address has been added to.**
*
* The same IP address can be added to multiple IP pools.
*
* A single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it.
*/
pub async fn get_ips_ip_address(
&self,
ip_address: &str,
) -> ClientResult<crate::Response<crate::types::GetIpsIpAddressResponse>> {
let url = self.client.url(
&format!(
"/ips/{}",
crate::progenitor_support::encode_path(ip_address),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
}