Struct mailchimp_api::automations::Automations

source ·

pub struct Automations {
    pub client: Client,
}

Fields

client: Client

Implementations

source

impl Automations

source

pub async fn get(
 &self,
 count: i64,
 offset: i64,
 fields: &[String],
 exclude_fields: &[String],
 before_create_time: Option<DateTime<Utc>>,
 since_create_time: Option<DateTime<Utc>>,
 before_start_time: Option<DateTime<Utc>>,
 since_start_time: Option<DateTime<Utc>>,
 status: Status
) -> Result<GetAutomationsResponse>

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, 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.

source

pub async fn post(&self, body: &AutomationWorkflow) -> Result<Automations>

Add automation.

This function performs a POST to the /automations endpoint.

Create a new classic automation in your Mailchimp account.

source

pub async fn get_automations(
 &self,
 fields: &[String],
 exclude_fields: &[String],
 workflow_id: &str
) -> Result<Automations>

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.

source

pub async fn post_actions_pause_all_email(&self, workflow_id: &str) -> Result<()>

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.

source

pub async fn post_actions_start_all_email(&self, workflow_id: &str) -> Result<()>

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.

source

pub async fn archive(&self, workflow_id: &str) -> Result<()>

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.

source

pub async fn get_email(&self, workflow_id: &str) -> Result<AutomationEmails>

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.

source

pub async fn get_email_automations(
 &self,
 workflow_id: &str,
 workflow_email_id: &str
) -> Result<Emails>

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.

source

pub async fn delete_emails(
 &self,
 workflow_id: &str,
 workflow_email_id: &str
) -> Result<()>

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.

source

pub async fn patch_email_workflow(
 &self,
 workflow_id: &str,
 workflow_email_id: &str,
 body: &UpdateInformationAboutASpecificWorkflowEmail
) -> Result<Emails>

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.

source

pub async fn get_emails_queue(
 &self,
 workflow_id: &str,
 workflow_email_id: &str
) -> Result<GetAutomationsEmailsQueueResponse>

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.

source

pub async fn post_emails_queue(
 &self,
 workflow_id: &str,
 workflow_email_id: &str,
 body: &SubscriberInAutomationQueue
) -> Result<SubscriberInAutomationQueueData>

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.

source

pub async fn get_emails_queue_automations(
 &self,
 workflow_id: &str,
 workflow_email_id: &str,
 subscriber_hash: &str
) -> Result<SubscriberInAutomationQueueData>

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.

source

pub async fn post_emails_actions_pause(
 &self,
 workflow_id: &str,
 workflow_email_id: &str
) -> Result<()>

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.

source

pub async fn post_emails_actions_start(
 &self,
 workflow_id: &str,
 workflow_email_id: &str
) -> Result<()>

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.

source

pub async fn get_removed_subscriber(
&self,
workflow_id: &str
) -> Result<RemovedSubscribers>

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.

source

pub async fn post_removed_subscriber(
 &self,
 workflow_id: &str,
 body: &SubscriberInAutomationQueue
) -> Result<Subscribers>

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.

source

pub async fn get_removed_subscriber_automations(
 &self,
 workflow_id: &str,
 subscriber_hash: &str
) -> Result<Subscribers>

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.

Auto Trait Implementations

impl !RefUnwindSafe for Automations

impl Send for Automations

impl Sync for Automations

impl Unpin for Automations

impl !UnwindSafe for Automations

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct mailchimp_api::automations::Automations

Fields

Implementations

impl Automations

pub async fn post(&self, body: &AutomationWorkflow) -> Result<Automations>

pub async fn get_automations( &self, fields: &[String], exclude_fields: &[String], workflow_id: &str) -> Result<Automations>

pub async fn post_actions_pause_all_email(&self, workflow_id: &str) -> Result<()>

pub async fn post_actions_start_all_email(&self, workflow_id: &str) -> Result<()>

pub async fn archive(&self, workflow_id: &str) -> Result<()>

pub async fn get_email(&self, workflow_id: &str) -> Result<AutomationEmails>

pub async fn get_email_automations( &self, workflow_id: &str, workflow_email_id: &str) -> Result<Emails>

pub async fn delete_emails( &self, workflow_id: &str, workflow_email_id: &str) -> Result<()>

pub async fn patch_email_workflow( &self, workflow_id: &str, workflow_email_id: &str, body: &UpdateInformationAboutASpecificWorkflowEmail) -> Result<Emails>

pub async fn get_emails_queue( &self, workflow_id: &str, workflow_email_id: &str) -> Result<GetAutomationsEmailsQueueResponse>

pub async fn post_emails_queue( &self, workflow_id: &str, workflow_email_id: &str, body: &SubscriberInAutomationQueue) -> Result<SubscriberInAutomationQueueData>

pub async fn get_emails_queue_automations( &self, workflow_id: &str, workflow_email_id: &str, subscriber_hash: &str) -> Result<SubscriberInAutomationQueueData>

pub async fn post_emails_actions_pause( &self, workflow_id: &str, workflow_email_id: &str) -> Result<()>

pub async fn post_emails_actions_start( &self, workflow_id: &str, workflow_email_id: &str) -> Result<()>

pub async fn get_removed_subscriber( &self, workflow_id: &str) -> Result<RemovedSubscribers>

pub async fn post_removed_subscriber( &self, workflow_id: &str, body: &SubscriberInAutomationQueue) -> Result<Subscribers>

pub async fn get_removed_subscriber_automations( &self, workflow_id: &str, subscriber_hash: &str) -> Result<Subscribers>

Auto Trait Implementations

impl !RefUnwindSafe for Automations

impl Send for Automations

impl Sync for Automations

impl Unpin for Automations

impl !UnwindSafe for Automations

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

fn with_current_context(self) -> WithContext<Self>

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub async fn get_automations(
&self,
fields: &[String],
exclude_fields: &[String],
workflow_id: &str
) -> Result<Automations>

pub async fn get_email_automations(
&self,
workflow_id: &str,
workflow_email_id: &str
) -> Result<Emails>

pub async fn delete_emails(
&self,
workflow_id: &str,
workflow_email_id: &str
) -> Result<()>

pub async fn patch_email_workflow(
&self,
workflow_id: &str,
workflow_email_id: &str,
body: &UpdateInformationAboutASpecificWorkflowEmail
) -> Result<Emails>

pub async fn get_emails_queue(
&self,
workflow_id: &str,
workflow_email_id: &str
) -> Result<GetAutomationsEmailsQueueResponse>

pub async fn post_emails_queue(
&self,
workflow_id: &str,
workflow_email_id: &str,
body: &SubscriberInAutomationQueue
) -> Result<SubscriberInAutomationQueueData>

pub async fn get_emails_queue_automations(
&self,
workflow_id: &str,
workflow_email_id: &str,
subscriber_hash: &str
) -> Result<SubscriberInAutomationQueueData>

pub async fn post_emails_actions_pause(
&self,
workflow_id: &str,
workflow_email_id: &str
) -> Result<()>

pub async fn post_emails_actions_start(
&self,
workflow_id: &str,
workflow_email_id: &str
) -> Result<()>

pub async fn get_removed_subscriber(
&self,
workflow_id: &str
) -> Result<RemovedSubscribers>

pub async fn post_removed_subscriber(
&self,
workflow_id: &str,
body: &SubscriberInAutomationQueue
) -> Result<Subscribers>

pub async fn get_removed_subscriber_automations(
&self,
workflow_id: &str,
subscriber_hash: &str
) -> Result<Subscribers>

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,