Struct mailchimp::types::ListInterestCategory

pub struct ListInterestCategory {
    pub list_id: String,
    pub id: String,
    pub title: String,
    pub display_order: u64,
    pub ic_type: String,
    pub _links: Vec<LinkType>,
    // some fields omitted
}

Interest Categories

Manage interest categories for a specific list. Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to ‘group titles’ in the Mailchimp application. Learn more about groups in Mailchimp.

Fields

list_id: String

The unique list id for the category.

id: String

The id for the interest category.

title: String

The text description of this category. This field appears on signup forms and is often phrased as a question.

display_order: u64

The order that the categories are displayed in the list. Lower numbers display first.

ic_type: String

Determines how this category’s interests appear on signup forms. Possible Values: checkboxes dropdown radio hidden

_links: Vec<LinkType>

A list of link types and descriptions for the API schema documents.

Methods

impl ListInterestCategory

pub fn set_api(&mut self, n_api: &MailchimpApi)

Update the api instance

pub fn set_endpoint<'a>(&mut self, n_endpoint: &'a str)

Update the endpoint value

pub fn delete(&self) -> Option<MailchimpErrorType>

Delete a specific note for a specific list member.

pub fn update<'a>(
    &self,
    param: InterestCategoryParam
) -> Result<ListInterestCategory, MailchimpErrorType>

Update a specific note for a specific list member.

Arguments: param: Values tu update

Important traits for MalchimpIter<B>

impl<B> Iterator for MalchimpIter<B> where
    B: BuildIter,
    B::FilterItem: ResourceFilter,
    B::Collection: MailchimpCollection<B::Item> + DeserializeOwned + Default,  type Item = B::Item;

pub fn get_interests(
    &self,
    filters: Option<SimpleFilter>
) -> MalchimpIter<ListInterestBuilder>

Get a list of this category’s interests.

pub fn create_interest<'a>(
    &self,
    param: InterestParam
) -> Result<ListInterest, MailchimpErrorType>

Create a new interest in a specific category

Argument: note: The content of the note. Note length is limited to 1,000 characters.

pub fn get_specific_interest<'a>(
    &self,
    interest_id: &'a str
) -> Result<ListInterestCategory, MailchimpErrorType>

Get interests or ‘group names’ for a specific category.

Argument: interest_id: The specific interest or ‘group name’.

Trait Implementations

impl MailchimpCollection<ListInterestCategory> for CollectionListInterestCategories

fn get_total_items(&self) -> u64

Total Items

fn get_values(&self) -> Vec<ListInterestCategory>

Data

impl Clone for ListInterestCategory

fn clone(&self) -> ListInterestCategory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListInterestCategory

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

Formats the value using the given formatter.

impl Serialize for ListInterestCategory

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for ListInterestCategory

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.