PHP Class MC4WP_API_v3

Exibir arquivo Open project: dannyvankooten/mailchimp-for-wordpress Class Usage Examples

Protected Properties

Property Type Description
$client MC4WP_API_v3_Client
$connected Are we able to talk to the MailChimp API?

Public Methods

Method Description
__construct ( string $api_key ) Constructor
add_ecommerce_store ( array $args ) : object
add_ecommerce_store_cart ( string $store_id, array $args ) : object
add_ecommerce_store_cart_line ( string $store_id, string $cart_id, array $args ) : object
add_ecommerce_store_customer ( $store_id, array $args ) : object Add OR update a store customer
add_ecommerce_store_order ( string $store_id, array $args ) : object
add_ecommerce_store_order_line ( string $store_id, string $order_id, array $args ) : object
add_ecommerce_store_product ( string $store_id, array $args ) : object Add a product to a store
add_ecommerce_store_product_variant ( string $store_id, string $product_id, array $args ) : object Add OR update a product variant.
add_list_member ( string $list_id, array $args ) : object Add or update (!) a member to a MailChimp list.
add_list_members ( string $list_id, array $args ) : object Batch subscribe / unsubscribe list members.
delete_ecommerce_store ( string $store_id ) : boolean
delete_ecommerce_store_cart ( string $store_id, string $cart_id ) : boolean
delete_ecommerce_store_cart_line ( string $store_id, string $cart_id, string $line_id ) : boolean
delete_ecommerce_store_customer ( string $store_id, string $customer_id ) : boolean
delete_ecommerce_store_order ( string $store_id, string $order_id ) : boolean
delete_ecommerce_store_order_line ( string $store_id, string $order_id, string $line_id ) : boolean
delete_ecommerce_store_product ( string $store_id, string $product_id ) : boolean
delete_ecommerce_store_product_variant ( string $store_id, string $product_id, string $variant_id ) : boolean
delete_list_member ( string $list_id, string $email_address ) : boolean
get_ecommerce_store ( string $store_id, array $args = [] ) : object
get_ecommerce_store_cart ( string $store_id, string $cart_id, array $args = [] ) : object
get_ecommerce_store_cart_line ( string $store_id, string $cart_id, string $line_id, array $args = [] ) : object
get_ecommerce_store_cart_lines ( string $store_id, string $cart_id, array $args = [] ) : object
get_ecommerce_store_carts ( string $store_id, array $args = [] ) : object
get_ecommerce_store_customer ( string $store_id, string $customer_id, array $args = [] ) : object
get_ecommerce_store_customers ( string $store_id, array $args = [] ) : object
get_ecommerce_store_order ( string $store_id, string $order_id, array $args = [] ) : object
get_ecommerce_store_order_line ( string $store_id, string $order_id, string $line_id, array $args = [] ) : object
get_ecommerce_store_order_lines ( string $store_id, string $order_id, array $args = [] ) : object
get_ecommerce_store_orders ( string $store_id, array $args = [] ) : object
get_ecommerce_store_product ( string $store_id, string $product_id, array $args = [] ) : object
get_ecommerce_store_product_variant ( string $store_id, string $product_id, string $variant_id, array $args = [] ) : object
get_ecommerce_store_product_variants ( string $store_id, string $product_id, array $args = [] ) : object
get_ecommerce_store_products ( string $store_id, array $args = [] ) : object
get_last_response_body ( ) : string
get_last_response_headers ( ) : array
get_list ( string $list_id, array $args = [] ) : object
get_list_activity ( string $list_id ) : array Get recent daily, aggregated activity stats for a list.
get_list_interest_categories ( string $list_id, array $args = [] ) : array Gets the interest categories for a given List
get_list_interest_category_interests ( string $list_id, string $interest_category_id, array $args = [] ) : array
get_list_member ( string $list_id, string $email_address, array $args = [] ) : object
get_list_merge_fields ( string $list_id, array $args = [] ) : array Get merge vars for a given list
get_lists ( array $args = [] ) : array
get_subscriber_hash ( $email_address ) : string
is_connected ( ) : boolean Pings the MailChimp API to see if we're connected
update_ecommerce_store ( string $store_id, array $args ) : object
update_ecommerce_store_cart ( string $store_id, string $cart_id, array $args ) : object
update_ecommerce_store_cart_line ( string $store_id, string $cart_id, string $line_id, array $args ) : object
update_ecommerce_store_customer ( string $store_id, string $customer_id, array $args ) : object
update_ecommerce_store_order ( string $store_id, string $order_id, array $args ) : object
update_ecommerce_store_order_line ( string $store_id, string $order_id, string $line_id, array $args ) : object
update_ecommerce_store_product_variant ( string $store_id, string $product_id, string $variant_id, array $args ) : object
update_list_member ( $list_id, $email_address, array $args ) : object

Method Details

__construct() public method

Constructor
public __construct ( string $api_key )
$api_key string

add_ecommerce_store_customer() public method

Add OR update a store customer
See link: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/customers/#edit-put_ecommerce_stores_store_id_customers_customer_id
public add_ecommerce_store_customer ( $store_id, array $args ) : object
$store_id
$args array
return object

add_ecommerce_store_product() public method

Add a product to a store
See link: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/products/#create-post_ecommerce_stores_store_id_products
public add_ecommerce_store_product ( string $store_id, array $args ) : object
$store_id string
$args array
return object

add_ecommerce_store_product_variant() public method

Add OR update a product variant.
See link: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/products/variants/#edit-put_ecommerce_stores_store_id_products_product_id_variants_variant_id
public add_ecommerce_store_product_variant ( string $store_id, string $product_id, array $args ) : object
$store_id string
$product_id string
$args array
return object

add_list_member() public method

Add or update (!) a member to a MailChimp list.
See link: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#create-post_lists_list_id_members
public add_list_member ( string $list_id, array $args ) : object
$list_id string
$args array
return object

add_list_members() public method

Batch subscribe / unsubscribe list members.
See link: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/#create-post_lists_list_id
public add_list_members ( string $list_id, array $args ) : object
$list_id string
$args array
return object

delete_list_member() public method

See link: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/
public delete_list_member ( string $list_id, string $email_address ) : boolean
$list_id string
$email_address string
return boolean

get_ecommerce_store_cart_line() public method

See link: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/carts/lines/#read-get_ecommerce_stores_store_id_carts_cart_id_lines_line_id
public get_ecommerce_store_cart_line ( string $store_id, string $cart_id, string $line_id, array $args = [] ) : object
$store_id string
$cart_id string
$line_id string
$args array
return object

get_ecommerce_store_customer() public method

See link: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/customers/#read-get_ecommerce_stores_store_id_customers_customer_id
public get_ecommerce_store_customer ( string $store_id, string $customer_id, array $args = [] ) : object
$store_id string
$customer_id string
$args array
return object

get_ecommerce_store_order_line() public method

See link: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/orders/lines/#read-get_ecommerce_stores_store_id_orders_order_id_lines_line_id
public get_ecommerce_store_order_line ( string $store_id, string $order_id, string $line_id, array $args = [] ) : object
$store_id string
$order_id string
$line_id string
$args array
return object

get_ecommerce_store_product() public method

See link: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/products/#read-get_ecommerce_stores_store_id_products_product_id
public get_ecommerce_store_product ( string $store_id, string $product_id, array $args = [] ) : object
$store_id string
$product_id string
$args array
return object

get_ecommerce_store_product_variant() public method

See link: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/products/variants/#read-get_ecommerce_stores_store_id_products_product_id_variants_variant_id
public get_ecommerce_store_product_variant ( string $store_id, string $product_id, string $variant_id, array $args = [] ) : object
$store_id string
$product_id string
$variant_id string
$args array
return object

get_last_response_body() public method

public get_last_response_body ( ) : string
return string

get_last_response_headers() public method

public get_last_response_headers ( ) : array
return array

get_list() public method

See link: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/#read-get_lists_list_id
public get_list ( string $list_id, array $args = [] ) : object
$list_id string
$args array
return object

get_list_activity() public method

Get recent daily, aggregated activity stats for a list.
See link: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/activity/#read-get_lists_list_id_activity
public get_list_activity ( string $list_id ) : array
$list_id string
return array

get_list_interest_categories() public method

Gets the interest categories for a given List
See link: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/interest-categories/#read-get_lists_list_id_interest_categories
public get_list_interest_categories ( string $list_id, array $args = [] ) : array
$list_id string
$args array
return array

get_list_interest_category_interests() public method

See link: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/interest-categories/interests/#read-get_lists_list_id_interest_categories_interest_category_id_interests
public get_list_interest_category_interests ( string $list_id, string $interest_category_id, array $args = [] ) : array
$list_id string
$interest_category_id string
$args array
return array

get_list_member() public method

See link: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/
public get_list_member ( string $list_id, string $email_address, array $args = [] ) : object
$list_id string
$email_address string
$args array
return object

get_list_merge_fields() public method

Get merge vars for a given list
See link: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/merge-fields/#read-get_lists_list_id_merge_fields
public get_list_merge_fields ( string $list_id, array $args = [] ) : array
$list_id string
$args array
return array

get_lists() public method

See link: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/#read-get_lists
public get_lists ( array $args = [] ) : array
$args array
return array

get_subscriber_hash() public method

public get_subscriber_hash ( $email_address ) : string
$email_address
return string

is_connected() public method

The result is cached to ensure a maximum of 1 API call per page load
public is_connected ( ) : boolean
return boolean

update_list_member() public method

See link: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#edit-patch_lists_list_id_members_subscriber_hash
public update_list_member ( $list_id, $email_address, array $args ) : object
$list_id
$email_address
$args array
return object

Property Details

$client protected_oe property

protected MC4WP_API_v3_Client $client
return MC4WP_API_v3_Client

$connected protected_oe property

Are we able to talk to the MailChimp API?
protected $connected