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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
use anyhow::Result;
use crate::Client;
pub struct DomainAuthentication {
pub client: Client,
}
impl DomainAuthentication {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
DomainAuthentication { client }
}
/**
* List all authenticated domains.
*
* This function performs a `GET` to the `/whitelabel/domains` endpoint.
*
* **This endpoint allows you to retrieve a list of all domains you have authenticated.**
*
* **Parameters:**
*
* * `limit: i64` -- Number of domains to return.
* * `offset: i64` -- Paging offset.
* * `exclude_subusers: bool` -- Indicates if your subuser statistics will be sent to your New Relic Dashboard.
* * `username: &str` -- The license key provided with your New Relic account.
* * `domain: &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_whitelabel_domains(
&self,
limit: i64,
offset: i64,
exclude_subusers: bool,
username: &str,
domain: &str,
) -> Result<Vec<crate::types::DomainAuthentication200ResponseAllOf>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !domain.is_empty() {
query_args.push(("domain".to_string(), domain.to_string()));
}
if exclude_subusers {
query_args.push(("exclude_subusers".to_string(), exclude_subusers.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 !username.is_empty() {
query_args.push(("username".to_string(), username.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/whitelabel/domains?{}", query_);
self.client.get(&url, None).await
}
/**
* List all authenticated domains.
*
* This function performs a `GET` to the `/whitelabel/domains` endpoint.
*
* As opposed to `get_whitelabel_domains`, this function returns all the pages of the request at once.
*
* **This endpoint allows you to retrieve a list of all domains you have authenticated.**
*/
pub async fn get_all_whitelabel_domains(
&self,
offset: i64,
exclude_subusers: bool,
username: &str,
domain: &str,
) -> Result<Vec<crate::types::DomainAuthentication200ResponseAllOf>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !domain.is_empty() {
query_args.push(("domain".to_string(), domain.to_string()));
}
if exclude_subusers {
query_args.push(("exclude_subusers".to_string(), exclude_subusers.to_string()));
}
if offset > 0 {
query_args.push(("offset".to_string(), offset.to_string()));
}
if !username.is_empty() {
query_args.push(("username".to_string(), username.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/whitelabel/domains?{}", query_);
self.client.get_all_pages(&url, None).await
}
/**
* Authenticate a domain.
*
* This function performs a `POST` to the `/whitelabel/domains` endpoint.
*
* **This endpoint allows you to authenticate a domain.**
*
* If you are authenticating a domain for a subuser, you have two options:
* 1. Use the "username" parameter. This allows you to authenticate a domain on behalf of your subuser. This means the subuser is able to see and modify the authenticated domain.
* 2. Use the Association workflow (see Associate Domain section). This allows you to authenticate a domain created by the parent to a subuser. This means the subuser will default to the assigned domain, but will not be able to see or modify that authenticated domain. However, if the subuser authenticates their own domain it will overwrite the assigned domain.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn post_whitelabel_domain(
&self,
body: &crate::types::PostWhitelabelDomainsRequest,
) -> Result<crate::types::AuthenticationDomain> {
let url = "/whitelabel/domains".to_string();
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Retrieve an authenticated domain.
*
* This function performs a `GET` to the `/whitelabel/domains/{domain_id}` endpoint.
*
* **This endpoint allows you to retrieve a specific authenticated domain.**
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_whitelabel_domains_domain(
&self,
domain_id: &str,
) -> Result<crate::types::AuthenticationDomain> {
let url = format!(
"/whitelabel/domains/{}",
crate::progenitor_support::encode_path(domain_id),
);
self.client.get(&url, None).await
}
/**
* Delete an authenticated domain.
*
* This function performs a `DELETE` to the `/whitelabel/domains/{domain_id}` endpoint.
*
* **This endpoint allows you to delete an authenticated domain.**
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn delete_whitelabel_domains_domain(
&self,
domain_id: &str,
) -> Result<crate::types::Help> {
let url = format!(
"/whitelabel/domains/{}",
crate::progenitor_support::encode_path(domain_id),
);
self.client.delete(&url, None).await
}
/**
* Update an authenticated domain.
*
* This function performs a `PATCH` to the `/whitelabel/domains/{domain_id}` endpoint.
*
* **This endpoint allows you to update the settings for an authenticated domain.**
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn patch_whitelabel_domains_domain(
&self,
domain_id: &str,
body: &crate::types::PatchWhitelabelDomainsDomainRequest,
) -> Result<Vec<crate::types::DomainAuthentication200ResponseAllOf>> {
let url = format!(
"/whitelabel/domains/{}",
crate::progenitor_support::encode_path(domain_id),
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Get the default authentication.
*
* This function performs a `GET` to the `/whitelabel/domains/default` endpoint.
*
* **This endpoint allows you to retrieve the default authentication for a domain.**
*
* When creating or updating a domain authentication, you can set the domain as a default. The default domain will be used to send all mail. If you have multiple authenticated domains, the authenticated domain matching the domain of the From address will be used, and the default will be overridden.
*
* This endpoint will return a default domain and its details only if a default is set. You are not required to set a default. If you do not set a default domain, this endpoint will return general information about your domain authentication status.
*
* **Parameters:**
*
* * `domain: &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_whitelabel_domains_default(
&self,
domain: &str,
) -> Result<Vec<crate::types::DomainAuthentication200ResponseAllOf>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !domain.is_empty() {
query_args.push(("domain".to_string(), domain.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/whitelabel/domains/default?{}", query_);
self.client.get(&url, None).await
}
/**
* Get the default authentication.
*
* This function performs a `GET` to the `/whitelabel/domains/default` endpoint.
*
* As opposed to `get_whitelabel_domains_default`, this function returns all the pages of the request at once.
*
* **This endpoint allows you to retrieve the default authentication for a domain.**
*
* When creating or updating a domain authentication, you can set the domain as a default. The default domain will be used to send all mail. If you have multiple authenticated domains, the authenticated domain matching the domain of the From address will be used, and the default will be overridden.
*
* This endpoint will return a default domain and its details only if a default is set. You are not required to set a default. If you do not set a default domain, this endpoint will return general information about your domain authentication status.
*/
pub async fn get_all_whitelabel_domains_default(
&self,
domain: &str,
) -> Result<Vec<crate::types::DomainAuthentication200ResponseAllOf>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !domain.is_empty() {
query_args.push(("domain".to_string(), domain.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/whitelabel/domains/default?{}", query_);
self.client.get_all_pages(&url, None).await
}
/**
* Add an IP to an authenticated domain.
*
* This function performs a `POST` to the `/whitelabel/domains/{id}/ips` endpoint.
*
* **This endpoint allows you to add an IP address to an authenticated domain.**
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn post_whitelabel_domains_ip(
&self,
id: i64,
body: &crate::types::Ips,
) -> Result<crate::types::DomainAuthentication> {
let url = format!(
"/whitelabel/domains/{}/ips",
crate::progenitor_support::encode_path(&id.to_string()),
);
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Remove an IP from an authenticated domain.
*
* This function performs a `DELETE` to the `/whitelabel/domains/{id}/ips/{ip}` endpoint.
*
* **This endpoint allows you to remove an IP address from that domain's authentication.**
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn delete_whitelabel_domains_ips_ip(
&self,
id: i64,
ip: &str,
) -> Result<crate::types::DomainAuthentication> {
let url = format!(
"/whitelabel/domains/{}/ips/{}",
crate::progenitor_support::encode_path(&id.to_string()),
crate::progenitor_support::encode_path(ip),
);
self.client.delete(&url, None).await
}
/**
* Validate a domain authentication.
*
* This function performs a `POST` to the `/whitelabel/domains/{id}/validate` endpoint.
*
* **This endpoint allows you to validate an authenticated domain. If it fails, it will return an error message describing why the domain could not be validated.**
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn post_whitelabel_domains_validate(
&self,
id: i64,
) -> Result<crate::types::PostWhitelabelDomainsValidateResponse> {
let url = format!(
"/whitelabel/domains/{}/validate",
crate::progenitor_support::encode_path(&id.to_string()),
);
self.client.post(&url, None).await
}
/**
* List the authenticated domain associated with the given user.
*
* This function performs a `GET` to the `/whitelabel/domains/subuser` endpoint.
*
* **This endpoint allows you to retrieve all of the authenticated domains that have been assigned to a specific subuser.**
*
* Authenticated domains can be associated with (i.e. assigned to) subusers from a parent account. This functionality allows subusers to send mail using their parent's domain authentication. To associate a authenticated domain with a subuser, the parent account must first authenticate and validate the domain. The the parent may then associate the authenticated domain via the subuser management tools.
*
* **Parameters:**
*
* * `username: &str` -- Username for the subuser to find associated authenticated domain.
*/
pub async fn get_whitelabel_domains_subuser(
&self,
username: &str,
) -> Result<crate::types::DomainAuthentication> {
let mut query_args: Vec<(String, String)> = Default::default();
if !username.is_empty() {
query_args.push(("username".to_string(), username.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/whitelabel/domains/subuser?{}", query_);
self.client.get(&url, None).await
}
/**
* Disassociate an authenticated domain from a given user.
*
* This function performs a `DELETE` to the `/whitelabel/domains/subuser` endpoint.
*
* **This endpoint allows you to disassociate a specific authenticated domain from a subuser.**
*
* Authenticated domains can be associated with (i.e. assigned to) subusers from a parent account. This functionality allows subusers to send mail using their parent's domain authentication. To associate a authenticated domain with a subuser, the parent account must first authenticate and validate the domain. The the parent may then associate the authenticated domain via the subuser management tools.
*
* **Parameters:**
*
* * `username: &str` -- Username for the subuser to find associated authenticated domain.
*/
pub async fn delete_whitelabel_domains_subuser(
&self,
username: &str,
) -> Result<crate::types::Help> {
let mut query_args: Vec<(String, String)> = Default::default();
if !username.is_empty() {
query_args.push(("username".to_string(), username.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/whitelabel/domains/subuser?{}", query_);
self.client.delete(&url, None).await
}
/**
* Associate a authenticated domain with a given user.
*
* This function performs a `POST` to the `/whitelabel/domains/{domain_id}/subuser` endpoint.
*
* **This endpoint allows you to associate a specific authenticated domain with a subuser.**
*
* Authenticated domains can be associated with (i.e. assigned to) subusers from a parent account. This functionality allows subusers to send mail using their parent's domain authentication. To associate a authenticated domain with a subuser, the parent account must first authenticate and validate the domain. The the parent may then associate the authenticated domain via the subuser management tools.
*/
pub async fn post_whitelabel_domains_domain_subuser(
&self,
domain_id: i64,
body: &crate::types::PutUserUsernameResponse,
) -> Result<crate::types::DomainAuthentication> {
let url = format!(
"/whitelabel/domains/{}/subuser",
crate::progenitor_support::encode_path(&domain_id.to_string()),
);
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
}