MailChimpClient (Data Pipeline JavaDoc)

public interface MailChimpClient

Client for the MailChimp API 3.0 list member endpoints; create one with MailChimpClient.Proxy.get(String).

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static class

MailChimpClient.Proxy

Creates MailChimpClient proxies that authenticate with an API key.
Method Summary

Modifier and Type

Method

Description

String

addListMember(String listId, ListMember listMember)

Adds the member to the list and returns the response as raw JSON.

String

addOrUpdateListMember(String listId, String subscriberHash, ListMember listMember)

Adds or updates the member with the given subscriber hash; returns raw JSON.

String

getListMember(String listId, String subscriberHash)

Returns the member with the given subscriber hash as raw JSON.

ListMember

getListMemberObject(String listId, String subscriberHash)

Returns the same member as getListMember(String, String) mapped to a ListMember.

String

getListMembers(String listId, ListMemberStatus status, long offset, long count)

Returns up to count list members starting at offset as raw JSON; a null status sends no status filter.

ListMembers

getListMembersObject(String listId, ListMemberStatus status, long offset, long count)

Returns the same page as getListMembers(String, ListMemberStatus, long, long) mapped to a ListMembers.

Method Details
- getListMembers
  
  String getListMembers(String listId, ListMemberStatus status, long offset, long count)
  
  Returns up to count list members starting at offset as raw JSON; a null status sends no status filter.
- getListMembersObject
  
  ListMembers getListMembersObject(String listId, ListMemberStatus status, long offset, long count)
  
  Returns the same page as getListMembers(String, ListMemberStatus, long, long) mapped to a ListMembers.
- addListMember
  
  String addListMember(String listId, ListMember listMember)
  
  Adds the member to the list and returns the response as raw JSON.
- addOrUpdateListMember
  
  String addOrUpdateListMember(String listId, String subscriberHash, ListMember listMember)
  
  Adds or updates the member with the given subscriber hash; returns raw JSON.
- getListMember
  
  String getListMember(String listId, String subscriberHash)
  
  Returns the member with the given subscriber hash as raw JSON.
- getListMemberObject
  
  ListMember getListMemberObject(String listId, String subscriberHash)
  
  Returns the same member as getListMember(String, String) mapped to a ListMember.