Struct mailchimp::types::ListMembersFilter

pub struct ListMembersFilter {
    pub fields: Option<String>,
    pub exclude_fields: Option<String>,
    pub count: Option<u64>,
    pub offset: Option<u64>,
    pub email_type: Option<String>,
    pub status: Option<String>,
    pub since_timestamp_opt: Option<String>,
    pub before_timestamp_opt: Option<String>,
    pub since_last_changed: Option<String>,
    pub before_last_changed: Option<String>,
    pub unique_email_id: Option<String>,
    pub vip_only: Option<String>,
    pub interest_category_id: Option<String>,
    pub interest_ids: Option<String>,
    pub interest_match: Option<String>,
    pub sort_field: Option<String>,
    pub sort_dir: Option<String>,
    pub since_last_campaign: Option<bool>,
    pub unsubscribed_since: Option<String>,
}

================================= ITER =====================

Fields

fields: Option<String>

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fields: Option<String>

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

count: Option<u64>

The number of records to return. Default value is 10.

offset: Option<u64>

The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. Default value is 0..

email_type: Option<String>

The email type.

status: Option<String>

The subscriber’s status.

since_timestamp_opt: Option<String>

Restrict results to subscribers who opted-in after the set timeframe. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.

before_timestamp_opt: Option<String>

Restrict results to subscribers who opted-in before the set timeframe. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.

since_last_changed: Option<String>

Restrict results to subscribers whose information changed after the set timeframe. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.

before_last_changed: Option<String>

Restrict results to subscribers whose information changed before the set timeframe. We recommend ISO 8601 time format: 2015-10-21T15:41:36+00:00.

unique_email_id: Option<String>

A unique identifier for the email address across all Mailchimp lists. This parameter can be found in any links with Ecommerce Tracking enabled.

vip_only: Option<String>

A filter to return only the list’s VIP members. Passing true will restrict results to VIP list members, passing false will return all list members.

interest_category_id: Option<String>

The unique id for the interest category.

interest_ids: Option<String>

Used to filter list members by interests. Must be accompanied by interest_category_id and interest_match. The value must be a comma separated list of interest ids present for any supplied interest categories.

interest_match: Option<String>

Used to filter list members by interests. Must be accompanied by interest_category_id and interest_ids. “any” will match a member with any of the interest supplied, “all” will only match members with every interest supplied, and “none” will match members without any of the interest supplied.

sort_field: Option<String>

Returns files sorted by the specified field. [timestamp_opt, timestamp_signup]

sort_dir: Option<String>

Determines the order direction for sorted results.

since_last_campaign: Option<bool>

Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter.

unsubscribed_since: Option<String>

Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error.

Trait Implementations

impl ResourceFilter for ListMembersFilter

fn build_payload(&self) -> HashMap<String, String>

impl Default for ListMembersFilter

fn default() -> Self

Returns the "default value" for a type.

impl Clone for ListMembersFilter

fn clone(&self) -> ListMembersFilter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListMembersFilter

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.