com.mailchimp

Interface MailChimpClient

public interface MailChimpClient

Author:

stevensnoeijen, eamoralesl

Method Summary

Modifier and Type	Method and Description
static MailChimpClientBuilder	builder()
Store	create(StoreCreate store) Creates a store.
Cart	create(String storeId, CartCreate cart) Creates a cart.
Customer	create(String storeId, CustomerCreate customer) Creates a customer.
Product	create(String storeId, ProductCreate product) Creates a product.
Batch	createBatch(CreateBatch batch) Create batch.
SubscriberList	createList(SubscriberList subscriberList) Create subscriberList.
Member	createListMember(String listId, Member member) Creates member in list.
ListMergeField	createMergeField(String listId, ListMergeField mergeField) Create merge-field for list.
Segment	createSegment(String listId, SegmentCreate segment) Create segment in list.
Batch	getBatch(String batchId) Get batch.
Batches	getBatches(BatchesQuery query) Get batches by filter.
Cart	getCart(String storeId, String cartId) Retrieves a cart by its id.
Customers	getCustomers(String storeId) List customers for a store.
SubscriberList	getList(String listId) Gets list.
Member	getListMember(String listId, String subscriberHash) Gets member by subscriberHash in list.
Members	getListMembers(String listId, ListMembersQuery query) Gets list members.
ListMergeFields	getListMergeFields(String listId) Get list's member-fields.
SubscriberLists	getLists(ListsQuery query) Gets lists by query.
Root	getRoot() Gets API Root.
Segment	getSegment(String listId, Integer segmentId) Get a segment in the list.
Segments	getSegments(String listId) Get segments in list.
Store	getStore(String storeId) Search stores by id.
Stores	getStores(StoresQuery query) Search stores by query.
SegmentModified	modifySegment(String listId, Integer segmentId, SegmentModify segment) Modify a segment in list.
void	removeBatch(String batchId) Removes batch
void	removeCart(String storeId, String cartId) Removes a cart by its id.
void	removeList(String listId) Removes list.
void	removeListMember(String listId, String subscriberHash) Removes member from list.
void	removeListMergeField(String listId, String mergeId) Removes merge-field from list.
void	removeSegment(String listId, Integer segmentId) Removes segment.
void	removeStore(String storeId) Removes store
SearchMembers	searchMembers(String query) Search members by query.
SearchMembers	searchMembers(String query, String listId) Search members by query and listId.
Cart	updateCart(String storeId, String cartId, CartCreate cart) Updates a specific cart.
Member	updateListMember(String listId, String subscriberHash, Member member) Updates member in a list.

Method Detail

builder

static MailChimpClientBuilder builder()

Returns:

builder to build the client

getRoot

Root getRoot()

Gets API Root.

Returns:

root info about the account

getListMember

Member getListMember(String listId,
                     String subscriberHash)

Gets member by subscriberHash in list.

Parameters:

listId - if of the list

subscriberHash - hash of member's email (see Member.getSubscriberHash(String))

Returns:

member

Throws:

MailChimpErrorException - when listId or subscriberHash was not found

createListMember

Member createListMember(String listId,
                        Member member)

Creates member in list.

Parameters:

listId - id of the list where to create the member in

member - to create

Returns:

created member

Throws:

MailChimpErrorException - when the list-id was not found

updateListMember

Member updateListMember(String listId,
                        String subscriberHash,
                        Member member)

Updates member in a list.

Parameters:

listId - id of the list where to create the member in

subscriberHash - hash of member's email (see Member.getSubscriberHash(String))

member - to update

Returns:

updated user

Throws:

MailChimpErrorException - when the list-id was not found

removeListMember

void removeListMember(String listId,
                      String subscriberHash)

Removes member from list.

Parameters:

listId - id of the list

subscriberHash - hash of member's email (see Member.getSubscriberHash(String))

Throws:

MailChimpErrorException - when listId or subscriberHash was not found

createList

SubscriberList createList(SubscriberList subscriberList)

Create subscriberList.

Parameters:

subscriberList - to create

Returns:

created subscriberList

removeList

void removeList(String listId)

Removes list.

Parameters:

listId - id of the list

Throws:

MailChimpErrorException - when listId was not found

getList

SubscriberList getList(String listId)

Gets list.

Parameters:

listId - id of the list

Returns:

found list

Throws:

MailChimpErrorException - when listId was not found

getLists

SubscriberLists getLists(ListsQuery query)

Gets lists by query.

Parameters:

query - to filter results on

Returns:

filtered list of lists

getListMembers

Members getListMembers(String listId,
                       ListMembersQuery query)

Gets list members.

Parameters:

listId - id of the list

query - to filter results on

Returns:

filtered members

Throws:

MailChimpErrorException - when listId was not found

getListMergeFields

ListMergeFields getListMergeFields(String listId)

Get list's member-fields.

Parameters:

listId - id of the list

Returns:

list's member-fields

Throws:

MailChimpErrorException - when listId was not found

createMergeField

ListMergeField createMergeField(String listId,
                                ListMergeField mergeField)

Create merge-field for list.

Parameters:

listId - id of the list

mergeField - merge-field to create

Returns:

created merge-field for the list

Throws:

MailChimpErrorException - when listId was not found

removeListMergeField

void removeListMergeField(String listId,
                          String mergeId)

Removes merge-field from list.

Parameters:

listId - id of the list

mergeId - id of merge-field

Throws:

MailChimpErrorException - when listId or mergeId was not found

createSegment

Segment createSegment(String listId,
                      SegmentCreate segment)

Create segment in list.

Parameters:

listId - id of the list

segment - segment to create

Returns:

created segment

Throws:

MailChimpErrorException - when listId was not found

modifySegment

SegmentModified modifySegment(String listId,
                              Integer segmentId,
                              SegmentModify segment)

Modify a segment in list.

Parameters:

listId - id of the list

segmentId - id of segment

segment - segment to be modified

Returns:

modified segment

Throws:

MailChimpErrorException - when listId was not found

getSegments

Segments getSegments(String listId)

Get segments in list.

Parameters:

listId - id of the list

Returns:

segments of the list

Throws:

MailChimpErrorException - when listId was not found

getSegment

Segment getSegment(String listId,
                   Integer segmentId)

Get a segment in the list.

Parameters:

listId - id of the list

segmentId - id of the segment

Returns:

segment by id

Throws:

MailChimpErrorException - when listId or segmentId was not found

removeSegment

void removeSegment(String listId,
                   Integer segmentId)

Removes segment.

Parameters:

listId - id of the list

segmentId - id of the segment

Throws:

MailChimpErrorException - when listId or segmentId was not found

createBatch

Batch createBatch(CreateBatch batch)

Create batch.

Parameters:

batch - to create

Returns:

created batch

getBatch

Batch getBatch(String batchId)

Get batch.

Parameters:

batchId - id of batch

Returns:

found batch

Throws:

MailChimpErrorException - when batchId was not found

getBatches

Batches getBatches(BatchesQuery query)

Get batches by filter.

Parameters:

query - to filter

Returns:

filtered batches

removeBatch

void removeBatch(String batchId)

Removes batch

Parameters:

batchId - id of batch

Throws:

MailChimpErrorException - when batchId was not found

searchMembers

SearchMembers searchMembers(String query)

Search members by query.

Parameters:

query - to search by

Returns:

found members by query

searchMembers

SearchMembers searchMembers(String query,
                            String listId)

Search members by query and listId.

Parameters:

query - to search by

listId - id of list

Returns:

found members by query and listId

Throws:

MailChimpErrorException - when batchId was not found

getStores

Stores getStores(StoresQuery query)

Search stores by query.

Parameters:

query - to filter.

Returns:

found stores

Throws:

MailChimpErrorException - when storeId was not found

getStore

Store getStore(String storeId)

Search stores by id.

Parameters:

storeId - id of store

Returns:

found store by the id

Throws:

MailChimpErrorException - when storeId was not found

create

Store create(StoreCreate store)

Creates a store.

Parameters:

store - the store to be created

Returns:

the created store

Throws:

MailChimpErrorException - when storeId was not found

removeStore

void removeStore(String storeId)

Removes store

Parameters:

storeId - id of store

Throws:

MailChimpErrorException - when storeId was not found

create

Customer create(String storeId,
                CustomerCreate customer)

Creates a customer.

Parameters:

customer - the customer to be created

Returns:

the created customer

Throws:

MailChimpErrorException - when storeId was not found

getCustomers

Customers getCustomers(String storeId)

List customers for a store.

Parameters:

storeId - the store id to be created

Returns:

the customers

Throws:

MailChimpErrorException - when storeId was not found

create

Cart create(String storeId,
            CartCreate cart)

Creates a cart.

Parameters:

cart - the cart to be created

Returns:

the created cart

Throws:

MailChimpErrorException - when storeId was not found

getCart

Cart getCart(String storeId,
             String cartId)

Retrieves a cart by its id.

Returns:

the cart if found

Throws:

MailChimpErrorException - when storeId was not found

MailChimpErrorException - when cartId was not found

removeCart

void removeCart(String storeId,
                String cartId)

Removes a cart by its id.

Throws:

MailChimpErrorException - when storeId was not found

MailChimpErrorException - when cartId was not found

updateCart

Cart updateCart(String storeId,
                String cartId,
                CartCreate cart)

Updates a specific cart.

Returns:

the updated cart

Throws:

MailChimpErrorException - when storeId was not found

MailChimpErrorException - when cartId was not found

create

Product create(String storeId,
               ProductCreate product)

Creates a product.

Parameters:

product - the product to be created

Returns:

the created product

Throws:

MailChimpErrorException - when storeId was not found