InterestCategory

Extends \MailChimp\Core\Model

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.

package	Default

Methods

__construct

__construct(array $data = NULL)

inherited

Arguments

$data

array

all

all() : \MailChimp\Response\InterestCategoryListResponse

Get information about a list’s interest categories.

Response

\MailChimp\Response\InterestCategoryListResponse

api

api()

inherited

clear

clear()

inherited

config

config()

inherited

create

create() : \MailChimp\Models\Lists\InterestCategory

Create a new interest category.

Response

\MailChimp\Models\Lists\InterestCategory

delete

delete() : mixed

Delete a specific interest category.

Response

mixed

edit

edit() : \MailChimp\Models\Lists\InterestCategory

Update a specific interest category.

Response

\MailChimp\Models\Lists\InterestCategory

getAction

getAction( $name)

inherited

Arguments

$name

Returns an ActionField object specified by `$action` and `$name`

getActionField(string $action, string $name) : \MailChimp\Core\ActionField

inherited

Arguments

$action

string

Action Name

$name

string

Field Name

Response

\MailChimp\Core\ActionField

Returns an array of action fields for an action

getActionFields(string $action) : array<mixed,\MailChimp\Core\ActionField>

inherited

Arguments

$action

string

Response

array<mixed,\MailChimp\Core\ActionField>

Returns Field Information

getField(string $name) : \MailChimp\Core\Field

inherited

Arguments

$name

string

Response

\MailChimp\Core\Field

Gets all allowed fields of a Data

getFields() : array

inherited

Response

array

Return API Path

getPath(\MailChimp\Core\string $child = NULL, array $params = NULL) : string

inherited

Arguments

$child

\MailChimp\Core\string

$params

array

Response

string

Return true if field exists or false otherwise

hasField(string $name) : boolean

inherited

Arguments

$name

string

Field name

Response

boolean

initialize

initialize()

inherited

jsonSerialize

jsonSerialize()

inherited

merge

merge( $data)

inherited

Arguments

$data

own

own( $class,  $args)

inherited

Arguments

$class

$args

parseActionPath

parseActionPath( &$params)

inherited

Arguments

$params

read

read() : \MailChimp\Models\Lists\InterestCategory

Get information about a specific interest category.

Response

\MailChimp\Models\Lists\InterestCategory

reference

reference( &$field,  $name)

inherited

Arguments

$field

$name

setApi

setApi(\MailChimp\Interfaces\MailChimpInterface &$api)

inherited

Arguments

$api

\MailChimp\Interfaces\MailChimpInterface

setConfig

setConfig(\MailChimp\Interfaces\ConfigInterface &$config)

inherited

Arguments

$config

\MailChimp\Interfaces\ConfigInterface

Properties

API Endpoint

path : string

inherited

var

Type(s)

string

Path Parameters

params : array

inherited

var

Type(s)

array

Action Fields Configurations

action : array

inherited

var

Type(s)

array

Info for all action fields

_action : array

inherited

var

Type(s)

array

Data holder for predefined fields

data : object

inherited

var

Type(s)

object

Info for unreferenced action fields

_fields : array

inherited

var

Type(s)

array

API Query builder

builder : \MailChimp\Core\Builder

inherited

var

Type(s)

\MailChimp\Core\Builder

Fields for the model

fields : array

inherited

var

Type(s)

array

Reference map for fields

_reference : array

inherited

var

Type(s)

array

_api

_api :

inherited

Type(s)

_config

_config :

inherited

Type(s)

id

id : string

The id for the interest category.

Type(s)

string

list_id

list_id : string

The unique list id for the category.

Type(s)

string

title

title : string

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

Type(s)

string

display_order

display_order : integer

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

Type(s)

integer

type

type : string

Determines how this category’s interests appear on signup forms.

Possible Values:

checkboxes
dropdown
radio
hidden

Type(s)

string

_links

_links : array<mixed,\MailChimp\Data\Link>

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

Type(s)

array<mixed,\MailChimp\Data\Link>