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
use anyhow::Result;
use crate::Client;
pub struct ContactsApiRecipients {
pub client: Client,
}
impl ContactsApiRecipients {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
ContactsApiRecipients { client }
}
/**
* Retrieve recipients.
*
* This function performs a `GET` to the `/contactdb/recipients` endpoint.
*
* **This endpoint allows you to retrieve all of your Marketing Campaigns recipients.**
*
* Batch deletion of a page makes it possible to receive an empty page of recipients before reaching the end of
* the list of recipients. To avoid this issue; iterate over pages until a 404 is retrieved.
*
* **Parameters:**
*
* * `page: i64` -- Page index of first recipients to return (must be a positive integer).
* * `page_size: i64` -- Number of recipients to return at a time (must be a positive integer between 1 and 1000).
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_contactdb_recipients(
&self,
page: i64,
page_size: i64,
) -> Result<crate::types::ListRecipientsResponse> {
let mut query_args: Vec<(String, String)> = Default::default();
if page > 0 {
query_args.push(("page".to_string(), page.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/contactdb/recipients?{}", query_);
self.client.get(&url, None).await
}
/**
* Add recipients.
*
* This function performs a `POST` to the `/contactdb/recipients` endpoint.
*
* **This endpoint allows you to add a Marketing Campaigns recipient.**
*
* You can add custom field data as a parameter on this endpoint. We have provided an example using some of the default custom fields SendGrid provides.
*
* The rate limit is three requests every 2 seconds. You can upload 1000 contacts per request. So the maximum upload rate is 1500 recipients per second.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn post_contactdb_recipient(
&self,
body: &[crate::types::PostContactdbRecipientsRequest],
) -> Result<crate::types::ContactDbRecipientResponse> {
let url = "/contactdb/recipients".to_string();
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Delete Recipients.
*
* This function performs a `DELETE` to the `/contactdb/recipients` endpoint.
*
* **This endpoint allows you to deletes one or more recipients.**
*
* The body of an API call to this endpoint must include an array of recipient IDs of the recipients you want to delete.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn delete_contactdb_recipients(&self, body: &[String]) -> Result<crate::types::Help> {
let url = "/contactdb/recipients".to_string();
self.client
.delete(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Update Recipient.
*
* This function performs a `PATCH` to the `/contactdb/recipients` endpoint.
*
* **This endpoint allows you to update one or more recipients.**
*
* The body of an API call to this endpoint must include an array of one or more recipient objects.
*
* It is of note that you can add custom field data as parameters on recipient objects. We have provided an example using some of the default custom fields SendGrid provides.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn patch_contactdb_recipients(
&self,
body: &[crate::types::PatchContactdbRecipientsRequest],
) -> Result<crate::types::ContactDbRecipientResponse> {
let url = "/contactdb/recipients".to_string();
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Get Recipient Upload Status.
*
* This function performs a `GET` to the `/contactdb/status` endpoint.
*
* **This endpoint allows you to check the upload status of a Marketing Campaigns recipient.**
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_contactdb_statu(
&self,
) -> Result<crate::types::GetContactdbStatusResponseData> {
let url = "/contactdb/status".to_string();
self.client.get(&url, None).await
}
/**
* Retrieve a single recipient.
*
* This function performs a `GET` to the `/contactdb/recipients/{recipient_id}` endpoint.
*
* **This endpoint allows you to retrieve a single recipient by ID from your contact database.**
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_contactdb_recipients_recipient(
&self,
recipient_id: &str,
) -> Result<crate::types::ContactdbRecipient> {
let url = format!(
"/contactdb/recipients/{}",
crate::progenitor_support::encode_path(&recipient_id.to_string()),
);
self.client.get(&url, None).await
}
/**
* Delete a Recipient.
*
* This function performs a `DELETE` to the `/contactdb/recipients/{recipient_id}` endpoint.
*
* **This endpoint allows you to delete a single recipient with the given ID from your contact database.**
*
* > Use this to permanently delete your recipients from all of your contact lists and all segments if required by applicable law.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn delete_contactdb_recipients_recipient(
&self,
recipient_id: &str,
) -> Result<crate::types::Help> {
let url = format!(
"/contactdb/recipients/{}",
crate::progenitor_support::encode_path(&recipient_id.to_string()),
);
self.client.delete(&url, None).await
}
/**
* Retrieve the lists that a recipient is on.
*
* This function performs a `GET` to the `/contactdb/recipients/{recipient_id}/lists` endpoint.
*
* **This endpoint allows you to retrieve the lists that a given recipient belongs to.**
*
* Each recipient can be on many lists. This endpoint gives you all of the lists that any one recipient has been added to.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_contactdb_recipients_recipient_lists(
&self,
recipient_id: &str,
) -> Result<crate::types::GetContactdbRecipientsRecipientListsResponse> {
let url = format!(
"/contactdb/recipients/{}/lists",
crate::progenitor_support::encode_path(&recipient_id.to_string()),
);
self.client.get(&url, None).await
}
/**
* Retrieve the count of billable recipients.
*
* This function performs a `GET` to the `/contactdb/recipients/billable_count` endpoint.
*
* **This endpoint allows you to retrieve the number of Marketing Campaigns recipients that you will be billed for.**
*
* You are billed for marketing campaigns based on the highest number of recipients you have had in your account at one time. This endpoint will allow you to know the current billable count value.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_contactdb_recipients_billable_count(
&self,
) -> Result<crate::types::ContactdbRecipientCount> {
let url = "/contactdb/recipients/billable_count".to_string();
self.client.get(&url, None).await
}
/**
* Retrieve a Count of Recipients.
*
* This function performs a `GET` to the `/contactdb/recipients/count` endpoint.
*
* **This endpoint allows you to retrieve the total number of Marketing Campaigns recipients.**
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_contactdb_recipients_count(
&self,
) -> Result<crate::types::ContactdbRecipientCount> {
let url = "/contactdb/recipients/count".to_string();
self.client.get(&url, None).await
}
/**
* Search recipients.
*
* This function performs a `GET` to the `/contactdb/recipients/search` endpoint.
*
* **This endpoint allows you to perform a search on all of your Marketing Campaigns recipients.**
*
* field_name:
*
* * is a variable that is substituted for your actual custom field name from your recipient.
* * Text fields must be url-encoded. Date fields are searchable only by unix timestamp (e.g. 2/2/2015 becomes 1422835200)
* * If field_name is a 'reserved' date field, such as created_at or updated_at, the system will internally convert
* your epoch time to a date range encompassing the entire day. For example, an epoch time of 1422835600 converts to
* Mon, 02 Feb 2015 00:06:40 GMT, but internally the system will search from Mon, 02 Feb 2015 00:00:00 GMT through
* Mon, 02 Feb 2015 23:59:59 GMT.
*
* **Parameters:**
*
* * `field_name: &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_contactdb_recipients_search(
&self,
field_name: &str,
) -> Result<crate::types::GetContactdbRecipientsSearchResponse> {
let mut query_args: Vec<(String, String)> = Default::default();
if !field_name.is_empty() {
query_args.push(("{field_name}".to_string(), field_name.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/contactdb/recipients/search?{}", query_);
self.client.get(&url, None).await
}
/**
* Search recipients.
*
* This function performs a `POST` to the `/contactdb/recipients/search` endpoint.
*
* <p>
* Search using segment conditions without actually creating a segment.
* Body contains a JSON object with <code>conditions</code>, a list of conditions as described below, and an optional <code>list_id</code>, which is a valid list ID for a list to limit the search on.
* </p>
*
* <p>
* Valid operators for create and update depend on the type of the field for which you are searching.
* </p>
*
* <ul>
* <li>Dates:
* <ul>
* <li>"eq", "ne", "lt" (before), "gt" (after)
* <ul>
* <li>You may use MM/DD/YYYY for day granularity or an epoch for second granularity.</li>
* </ul>
* </li>
* <li>"empty", "not_empty"</li>
* <li>"is within"
* <ul>
* <li>You may use an <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601 date format</a> or the # of days.</li>
* </ul>
* </li>
* </ul>
* </li>
* <li>Text: "contains", "eq" (is - matches the full field), "ne" (is not - matches any field where the entire field is not the condition value), "empty", "not_empty"</li>
* <li>Numbers: "eq", "lt", "gt", "empty", "not_empty"</li>
* <li>Email Clicks and Opens: "eq" (opened), "ne" (not opened)</li>
* </ul>
*
* <p>
* Field values must all be a string.
* </p>
*
* <p>
* Search conditions using "eq" or "ne" for email clicks and opens should provide a "field" of either <code>clicks.campaign_identifier</code> or <code>opens.campaign_identifier</code>.
* The condition value should be a string containing the id of a completed campaign.
* </p>
*
* <p>
* Search conditions list may contain multiple conditions, joined by an "and" or "or" in the "and_or" field.
* The first condition in the conditions list must have an empty "and_or", and subsequent conditions must all specify an "and_or".
* </p>
*/
pub async fn post_contactdb_recipients_search(
&self,
body: &crate::types::PostContactdbRecipientsSearchRequest,
) -> Result<crate::types::PostContactdbRecipientsSearchResponseData> {
let url = "/contactdb/recipients/search".to_string();
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
}