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 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
use anyhow::Result;
use crate::Client;
pub struct Automations {
pub client: Client,
}
impl Automations {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
Automations { client }
}
/**
* List automations.
*
* This function performs a `GET` to the `/automations` endpoint.
*
* Get a summary of an account's classic automations.
*
* **Parameters:**
*
* * `count: i64` -- The number of records to return. Default value is 10. Maximum value is 1000.
* * `offset: i64` -- Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.
* * `fields: &[String]` -- A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
* * `exclude_fields: &[String]` -- A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
* * `before_create_time: chrono::DateTime<chrono::Utc>` -- Restrict the response to automations created before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.
* * `since_create_time: chrono::DateTime<chrono::Utc>` -- Restrict the response to automations created after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.
* * `before_start_time: chrono::DateTime<chrono::Utc>` -- Restrict the response to automations started before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.
* * `since_start_time: chrono::DateTime<chrono::Utc>` -- Restrict the response to automations started after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.
* * `status: crate::types::Status` -- Restrict the results to automations with the specified status.
*/
pub async fn get(
&self,
count: i64,
offset: i64,
fields: &[String],
exclude_fields: &[String],
before_create_time: Option<chrono::DateTime<chrono::Utc>>,
since_create_time: Option<chrono::DateTime<chrono::Utc>>,
before_start_time: Option<chrono::DateTime<chrono::Utc>>,
since_start_time: Option<chrono::DateTime<chrono::Utc>>,
status: crate::types::Status,
) -> Result<crate::types::GetAutomationsResponse> {
let mut query_args: Vec<(String, String)> = Default::default();
if let Some(date) = before_create_time {
query_args.push(("before_create_time".to_string(), date.to_rfc3339()));
}
if let Some(date) = before_start_time {
query_args.push(("before_start_time".to_string(), date.to_rfc3339()));
}
if count > 0 {
query_args.push(("count".to_string(), count.to_string()));
}
if !exclude_fields.is_empty() {
query_args.push(("exclude_fields".to_string(), exclude_fields.join(" ")));
}
if !fields.is_empty() {
query_args.push(("fields".to_string(), fields.join(" ")));
}
if offset > 0 {
query_args.push(("offset".to_string(), offset.to_string()));
}
if let Some(date) = since_create_time {
query_args.push(("since_create_time".to_string(), date.to_rfc3339()));
}
if let Some(date) = since_start_time {
query_args.push(("since_start_time".to_string(), date.to_rfc3339()));
}
if !status.to_string().is_empty() {
query_args.push(("status".to_string(), status.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/automations?{}", query_);
self.client.get(&url, None).await
}
/**
* Add automation.
*
* This function performs a `POST` to the `/automations` endpoint.
*
* Create a new classic automation in your Mailchimp account.
*/
pub async fn post(
&self,
body: &crate::types::AutomationWorkflow,
) -> Result<crate::types::Automations> {
let url = "/automations".to_string();
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Get automation info.
*
* This function performs a `GET` to the `/automations/{workflow_id}` endpoint.
*
* Get a summary of an individual classic automation workflow's settings and content. The `trigger_settings` object returns information for the first email in the workflow.
*
* **Parameters:**
*
* * `fields: &[String]` -- A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
* * `exclude_fields: &[String]` -- A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
* * `workflow_id: &str` -- The unique id for the Automation workflow.
*/
pub async fn get_automations(
&self,
fields: &[String],
exclude_fields: &[String],
workflow_id: &str,
) -> Result<crate::types::Automations> {
let mut query_args: Vec<(String, String)> = Default::default();
if !exclude_fields.is_empty() {
query_args.push(("exclude_fields".to_string(), exclude_fields.join(" ")));
}
if !fields.is_empty() {
query_args.push(("fields".to_string(), fields.join(" ")));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/automations/{}?{}",
crate::progenitor_support::encode_path(workflow_id),
query_
);
self.client.get(&url, None).await
}
/**
* Pause automation emails.
*
* This function performs a `POST` to the `/automations/{workflow_id}/actions/pause-all-emails` endpoint.
*
* Pause all emails in a specific classic automation workflow.
*
* **Parameters:**
*
* * `workflow_id: &str` -- The unique id for the Automation workflow.
*/
pub async fn post_actions_pause_all_email(&self, workflow_id: &str) -> Result<()> {
let url = format!(
"/automations/{}/actions/pause-all-emails",
crate::progenitor_support::encode_path(workflow_id),
);
self.client.post(&url, None).await
}
/**
* Start automation emails.
*
* This function performs a `POST` to the `/automations/{workflow_id}/actions/start-all-emails` endpoint.
*
* Start all emails in a classic automation workflow.
*
* **Parameters:**
*
* * `workflow_id: &str` -- The unique id for the Automation workflow.
*/
pub async fn post_actions_start_all_email(&self, workflow_id: &str) -> Result<()> {
let url = format!(
"/automations/{}/actions/start-all-emails",
crate::progenitor_support::encode_path(workflow_id),
);
self.client.post(&url, None).await
}
/**
* Archive automation.
*
* This function performs a `POST` to the `/automations/{workflow_id}/actions/archive` endpoint.
*
* Archiving will permanently end your automation and keep the report data. You’ll be able to replicate your archived automation, but you can’t restart it.
*
* **Parameters:**
*
* * `workflow_id: &str` -- The unique id for the Automation workflow.
*/
pub async fn archive(&self, workflow_id: &str) -> Result<()> {
let url = format!(
"/automations/{}/actions/archive",
crate::progenitor_support::encode_path(workflow_id),
);
self.client.post(&url, None).await
}
/**
* List automated emails.
*
* This function performs a `GET` to the `/automations/{workflow_id}/emails` endpoint.
*
* Get a summary of the emails in a classic automation workflow.
*
* **Parameters:**
*
* * `workflow_id: &str` -- The unique id for the Automation workflow.
*/
pub async fn get_email(&self, workflow_id: &str) -> Result<crate::types::AutomationEmails> {
let url = format!(
"/automations/{}/emails",
crate::progenitor_support::encode_path(workflow_id),
);
self.client.get(&url, None).await
}
/**
* Get workflow email info.
*
* This function performs a `GET` to the `/automations/{workflow_id}/emails/{workflow_email_id}` endpoint.
*
* Get information about an individual classic automation workflow email.
*
* **Parameters:**
*
* * `workflow_id: &str` -- The unique id for the Automation workflow.
* * `workflow_email_id: &str` -- The unique id for the Automation workflow email.
*/
pub async fn get_email_automations(
&self,
workflow_id: &str,
workflow_email_id: &str,
) -> Result<crate::types::Emails> {
let url = format!(
"/automations/{}/emails/{}",
crate::progenitor_support::encode_path(workflow_id),
crate::progenitor_support::encode_path(workflow_email_id),
);
self.client.get(&url, None).await
}
/**
* Delete workflow email.
*
* This function performs a `DELETE` to the `/automations/{workflow_id}/emails/{workflow_email_id}` endpoint.
*
* Removes an individual classic automation workflow email. Emails from certain workflow types, including the Abandoned Cart Email (abandonedCart) and Product Retargeting Email (abandonedBrowse) Workflows, cannot be deleted.
*
* **Parameters:**
*
* * `workflow_id: &str` -- The unique id for the Automation workflow.
* * `workflow_email_id: &str` -- The unique id for the Automation workflow email.
*/
pub async fn delete_emails(&self, workflow_id: &str, workflow_email_id: &str) -> Result<()> {
let url = format!(
"/automations/{}/emails/{}",
crate::progenitor_support::encode_path(workflow_id),
crate::progenitor_support::encode_path(workflow_email_id),
);
self.client.delete(&url, None).await
}
/**
* Update workflow email.
*
* This function performs a `PATCH` to the `/automations/{workflow_id}/emails/{workflow_email_id}` endpoint.
*
* Update settings for a classic automation workflow email
*
* **Parameters:**
*
* * `workflow_id: &str` -- The unique id for the Automation workflow.
* * `workflow_email_id: &str` -- The unique id for the Automation workflow email.
*/
pub async fn patch_email_workflow(
&self,
workflow_id: &str,
workflow_email_id: &str,
body: &crate::types::UpdateInformationAboutASpecificWorkflowEmail,
) -> Result<crate::types::Emails> {
let url = format!(
"/automations/{}/emails/{}",
crate::progenitor_support::encode_path(workflow_id),
crate::progenitor_support::encode_path(workflow_email_id),
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* List automated email subscribers.
*
* This function performs a `GET` to the `/automations/{workflow_id}/emails/{workflow_email_id}/queue` endpoint.
*
* Get information about a classic automation email queue.
*
* **Parameters:**
*
* * `workflow_id: &str` -- The unique id for the Automation workflow.
* * `workflow_email_id: &str` -- The unique id for the Automation workflow email.
*/
pub async fn get_emails_queue(
&self,
workflow_id: &str,
workflow_email_id: &str,
) -> Result<crate::types::GetAutomationsEmailsQueueResponse> {
let url = format!(
"/automations/{}/emails/{}/queue",
crate::progenitor_support::encode_path(workflow_id),
crate::progenitor_support::encode_path(workflow_email_id),
);
self.client.get(&url, None).await
}
/**
* Add subscriber to workflow email.
*
* This function performs a `POST` to the `/automations/{workflow_id}/emails/{workflow_email_id}/queue` endpoint.
*
* Manually add a subscriber to a workflow, bypassing the default trigger settings. You can also use this endpoint to trigger a series of automated emails in an API 3.0 workflow type.
*
* **Parameters:**
*
* * `workflow_id: &str` -- The unique id for the Automation workflow.
* * `workflow_email_id: &str` -- The unique id for the Automation workflow email.
*/
pub async fn post_emails_queue(
&self,
workflow_id: &str,
workflow_email_id: &str,
body: &crate::types::SubscriberInAutomationQueue,
) -> Result<crate::types::SubscriberInAutomationQueueData> {
let url = format!(
"/automations/{}/emails/{}/queue",
crate::progenitor_support::encode_path(workflow_id),
crate::progenitor_support::encode_path(workflow_email_id),
);
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Get automated email subscriber.
*
* This function performs a `GET` to the `/automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}` endpoint.
*
* Get information about a specific subscriber in a classic automation email queue.
*
* **Parameters:**
*
* * `workflow_id: &str` -- The unique id for the Automation workflow.
* * `workflow_email_id: &str` -- The unique id for the Automation workflow email.
* * `subscriber_hash: &str` -- The MD5 hash of the lowercase version of the list member's email address.
*/
pub async fn get_emails_queue_automations(
&self,
workflow_id: &str,
workflow_email_id: &str,
subscriber_hash: &str,
) -> Result<crate::types::SubscriberInAutomationQueueData> {
let url = format!(
"/automations/{}/emails/{}/queue/{}",
crate::progenitor_support::encode_path(workflow_id),
crate::progenitor_support::encode_path(workflow_email_id),
crate::progenitor_support::encode_path(subscriber_hash),
);
self.client.get(&url, None).await
}
/**
* Pause automated email.
*
* This function performs a `POST` to the `/automations/{workflow_id}/emails/{workflow_email_id}/actions/pause` endpoint.
*
* Pause an automated email.
*
* **Parameters:**
*
* * `workflow_id: &str` -- The unique id for the Automation workflow.
* * `workflow_email_id: &str` -- The unique id for the Automation workflow email.
*/
pub async fn post_emails_actions_pause(
&self,
workflow_id: &str,
workflow_email_id: &str,
) -> Result<()> {
let url = format!(
"/automations/{}/emails/{}/actions/pause",
crate::progenitor_support::encode_path(workflow_id),
crate::progenitor_support::encode_path(workflow_email_id),
);
self.client.post(&url, None).await
}
/**
* Start automated email.
*
* This function performs a `POST` to the `/automations/{workflow_id}/emails/{workflow_email_id}/actions/start` endpoint.
*
* Start an automated email.
*
* **Parameters:**
*
* * `workflow_id: &str` -- The unique id for the Automation workflow.
* * `workflow_email_id: &str` -- The unique id for the Automation workflow email.
*/
pub async fn post_emails_actions_start(
&self,
workflow_id: &str,
workflow_email_id: &str,
) -> Result<()> {
let url = format!(
"/automations/{}/emails/{}/actions/start",
crate::progenitor_support::encode_path(workflow_id),
crate::progenitor_support::encode_path(workflow_email_id),
);
self.client.post(&url, None).await
}
/**
* List subscribers removed from workflow.
*
* This function performs a `GET` to the `/automations/{workflow_id}/removed-subscribers` endpoint.
*
* Get information about subscribers who were removed from a classic automation workflow.
*
* **Parameters:**
*
* * `workflow_id: &str` -- The unique id for the Automation workflow.
*/
pub async fn get_removed_subscriber(
&self,
workflow_id: &str,
) -> Result<crate::types::RemovedSubscribers> {
let url = format!(
"/automations/{}/removed-subscribers",
crate::progenitor_support::encode_path(workflow_id),
);
self.client.get(&url, None).await
}
/**
* Remove subscriber from workflow.
*
* This function performs a `POST` to the `/automations/{workflow_id}/removed-subscribers` endpoint.
*
* Remove a subscriber from a specific classic automation workflow. You can remove a subscriber at any point in an automation workflow, regardless of how many emails they've been sent from that workflow. Once they're removed, they can never be added back to the same workflow.
*
* **Parameters:**
*
* * `workflow_id: &str` -- The unique id for the Automation workflow.
*/
pub async fn post_removed_subscriber(
&self,
workflow_id: &str,
body: &crate::types::SubscriberInAutomationQueue,
) -> Result<crate::types::Subscribers> {
let url = format!(
"/automations/{}/removed-subscribers",
crate::progenitor_support::encode_path(workflow_id),
);
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Get subscriber removed from workflow.
*
* This function performs a `GET` to the `/automations/{workflow_id}/removed-subscribers/{subscriber_hash}` endpoint.
*
* Get information about a specific subscriber who was removed from a classic automation workflow.
*
* **Parameters:**
*
* * `workflow_id: &str` -- The unique id for the Automation workflow.
* * `subscriber_hash: &str` -- The MD5 hash of the lowercase version of the list member's email address.
*/
pub async fn get_removed_subscriber_automations(
&self,
workflow_id: &str,
subscriber_hash: &str,
) -> Result<crate::types::Subscribers> {
let url = format!(
"/automations/{}/removed-subscribers/{}",
crate::progenitor_support::encode_path(workflow_id),
crate::progenitor_support::encode_path(subscriber_hash),
);
self.client.get(&url, None).await
}
}