API Documentation
Back to top  

Location

Extends \MailChimp\Core\Model

Get the locations (countries) that the list’s subscribers have been tagged to based on geocoding their IP address.

package

Default

Methods

__construct

__construct(array $data = NULL)
inherited

Arguments

$data

array

all

all() : \MailChimp\Response\LocationListResponse

Get the locations (countries) that the list’s subscribers have been tagged to based on geocoding their IP address.

Response

\MailChimp\Response\LocationListResponse

api

api()
inherited

clear

clear()
inherited

config

config()
inherited

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

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)

country

country : string

The name of the country.

Type(s)

string

cc

cc : string

The ISO 3166 2 digit country code.

Type(s)

string

percent

percent : integer

The percent of subscribers in the country.

Type(s)

integer

total

total : integer

The total number of subscribers in the country.

Type(s)

integer