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
use anyhow::Result;
use crate::Client;
pub struct SubusersApi {
pub client: Client,
}
impl SubusersApi {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
SubusersApi { client }
}
/**
* List all Subusers.
*
* This function performs a `GET` to the `/subusers` endpoint.
*
* **This endpoint allows you to retrieve a list of all of your subusers.**
*
* You can choose to retrieve specific subusers as well as limit the results that come back from the API.
*
* **Parameters:**
*
* * `username: &str` -- The license key provided with your New Relic account.
* * `limit: i64` -- The number of results you would like to get in each request.
* * `offset: i64` -- The number of subusers to skip.
*/
pub async fn get_subusers(
&self,
username: &str,
limit: i64,
offset: i64,
) -> Result<Vec<crate::types::Subuser>> {
let mut query_args: Vec<(String, String)> = Default::default();
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!("/subusers?{}", query_);
self.client.get(&url, None).await
}
/**
* List all Subusers.
*
* This function performs a `GET` to the `/subusers` endpoint.
*
* As opposed to `get_subusers`, this function returns all the pages of the request at once.
*
* **This endpoint allows you to retrieve a list of all of your subusers.**
*
* You can choose to retrieve specific subusers as well as limit the results that come back from the API.
*/
pub async fn get_all_subusers(
&self,
username: &str,
offset: i64,
) -> Result<Vec<crate::types::Subuser>> {
let mut query_args: Vec<(String, String)> = Default::default();
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!("/subusers?{}", query_);
self.client.get_all_pages(&url, None).await
}
/**
* Create Subuser.
*
* This function performs a `POST` to the `/subusers` endpoint.
*
* **This endpoint allows you to create a new subuser.**
*/
pub async fn post_subuser(
&self,
body: &crate::types::PostSubusersRequest,
) -> Result<crate::types::SubuserPost> {
let url = "/subusers".to_string();
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Delete a subuser.
*
* This function performs a `DELETE` to the `/subusers/{subuser_name}` endpoint.
*
* **This endpoint allows you to delete a subuser.**
*
* This is a permanent action. Once deleted, a subuser cannot be retrieved.
*/
pub async fn delete_subusers_subuser_name(
&self,
subuser_name: &str,
) -> Result<crate::types::Help> {
let url = format!(
"/subusers/{}",
crate::progenitor_support::encode_path(subuser_name),
);
self.client.delete(&url, None).await
}
/**
* Enable/disable a subuser.
*
* This function performs a `PATCH` to the `/subusers/{subuser_name}` endpoint.
*
* **This endpoint allows you to enable or disable a subuser.**
*/
pub async fn patch_subusers_subuser_name(
&self,
subuser_name: &str,
body: &crate::types::PatchSubusersSubuserNameRequest,
) -> Result<crate::types::Help> {
let url = format!(
"/subusers/{}",
crate::progenitor_support::encode_path(subuser_name),
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Retrieve Subuser Reputations.
*
* This function performs a `GET` to the `/subusers/reputations` endpoint.
*
* **This endpoint allows you to request the reputations for your subusers.**
*
* Subuser sender reputations give a good idea how well a sender is doing with regards to how recipients and recipient servers react to the mail that is being received. When a bounce, spam report, or other negative action happens on a sent email, it will affect your sender rating.
*
* **Parameters:**
*
* * `usernames: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_subusers_reputations(
&self,
usernames: &str,
) -> Result<Vec<crate::types::GetSubusersReputationsResponse>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !usernames.is_empty() {
query_args.push(("usernames".to_string(), usernames.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/subusers/reputations?{}", query_);
self.client.get(&url, None).await
}
/**
* Retrieve Subuser Reputations.
*
* This function performs a `GET` to the `/subusers/reputations` endpoint.
*
* As opposed to `get_subusers_reputations`, this function returns all the pages of the request at once.
*
* **This endpoint allows you to request the reputations for your subusers.**
*
* Subuser sender reputations give a good idea how well a sender is doing with regards to how recipients and recipient servers react to the mail that is being received. When a bounce, spam report, or other negative action happens on a sent email, it will affect your sender rating.
*/
pub async fn get_all_subusers_reputations(
&self,
usernames: &str,
) -> Result<Vec<crate::types::GetSubusersReputationsResponse>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !usernames.is_empty() {
query_args.push(("usernames".to_string(), usernames.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/subusers/reputations?{}", query_);
self.client.get_all_pages(&url, None).await
}
/**
* Update IPs assigned to a subuser.
*
* This function performs a `PUT` to the `/subusers/{subuser_name}/ips` endpoint.
*
* **This endpoint allows you update your subusers' assigned IP.**
*
* Each subuser should be assigned to an IP address from which all of this subuser's mail will be sent. Often, this is the same IP as the parent account, but each subuser can have one or more of their own IP addresses as well.
*
* More information:
*
* * [How to request more IPs](https://sendgrid.com/docs/ui/account-and-settings/dedicated-ip-addresses/)
* * [Setup Reverse DNS](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-reverse-dns/)
*/
pub async fn put_subusers_subuser_name_ips(
&self,
subuser_name: &str,
body: &[std::net::Ipv4Addr],
) -> Result<crate::types::PutSubusersSubuserNameIpsResponse> {
let url = format!(
"/subusers/{}/ips",
crate::progenitor_support::encode_path(subuser_name),
);
self.client
.put(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
}