com.constantcontact.v2

Interface ContactService

public interface ContactService

Retrofit interface for Contacts and Contact List calls against the Constant Contact API.

See Working With Contacts on the Constant Contact Developer Website

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<Contact>	createContact(Contact contact, OptInSource optInSource) Create an individual Contact
retrofit2.Call<ContactList>	createContactList(ContactList contactList) Create a new ContactList
retrofit2.Call<SignupFormResponse>	createCustomSignupForm(SignupFormRequest signupFormRequest) Create a custom signup form
retrofit2.Call<retrofit2.Response>	deleteContactList(java.lang.String listId) Delete a ContactList
retrofit2.Call<Contact>	getContact(java.lang.String contactId) Get an individual Contact
retrofit2.Call<ContactList>	getContactList(java.lang.String listId) Get a specific ContactList
retrofit2.Call<java.util.List<ContactList>>	getContactLists(java.lang.String date) Get all ContactList in the account
retrofit2.Call<Paged<Contact>>	getContacts(int limit, ContactStatus status) Get a Paged collection of Contact
retrofit2.Call<Paged<Contact>>	getContacts(int limit, java.lang.String date, ContactStatus status) Get a Paged collection of Contact
retrofit2.Call<Paged<Contact>>	getContacts(java.lang.String nextLink) Get a Paged collection of Contact from a previous call's next link.
retrofit2.Call<Paged<Contact>>	getContacts(java.lang.String listId, int limit, java.lang.String date) Get a Paged collection of Contact from a specific ContactList
retrofit2.Call<retrofit2.Response>	unsubscribeContact(java.lang.String contactId) Opt out an individual Contact
retrofit2.Call<Contact>	updateContact(Contact contact, java.lang.String contactId, OptInSource optInSource) Update an individual Contact
retrofit2.Call<ContactList>	updateContactList(ContactList contactList, java.lang.String listId) Update a ContactList

Method Detail

getContacts

@GET(value="v2/contacts")
retrofit2.Call<Paged<Contact>> getContacts(@Query(value="limit")
                                                                     int limit,
                                                                     @Query(value="status")
                                                                     ContactStatus status)

Get a Paged collection of Contact

Parameters:

limit - Size of page to return (1-500)

status - Retrieve contacts with only the chosen ContactStatus

Returns:

an Observable that emits Paged Contacts

getContacts

@GET(value="v2/contacts")
retrofit2.Call<Paged<Contact>> getContacts(@Query(value="limit")
                                                                     int limit,
                                                                     @Query(value="modified_since")
                                                                     java.lang.String date,
                                                                     @Query(value="status")
                                                                     ContactStatus status)

Get a Paged collection of Contact

Parameters:

limit - Size of page to return (1-500)

date - Date to specify retrieval of contacts that have been modified since then, in ISO-8601 format

status - Retrieve contacts with only the chosen ContactStatus

Returns:

an Observable that emits Paged Contacts

getContacts

@GET(value="v2/lists/{listId}/contacts")
retrofit2.Call<Paged<Contact>> getContacts(@Path(value="listId")
                                                                                    java.lang.String listId,
                                                                                    @Query(value="limit")
                                                                                    int limit,
                                                                                    @Query(value="modified_since")
                                                                                    java.lang.String date)

Get a Paged collection of Contact from a specific ContactList

Parameters:

listId - ID of the ContactList to get Contacts from

limit - Size of page to return (1-500)

date - Date to specify retrieval of contacts that have been modified since then, in ISO-8601 format

Returns:

an Observable that emits Paged Contacts

getContacts

@GET(value="v2/contacts?next={next}")
retrofit2.Call<Paged<Contact>> getContacts(@Path(value="next")
                                                                                 java.lang.String nextLink)

Get a Paged collection of Contact from a previous call's next link.

Parameters:

nextLink - Value of the path found in the meta of the original call

Returns:

an Observable that emits Paged Contacts

See Also:

Paged

createContact

@POST(value="v2/contacts")
retrofit2.Call<Contact> createContact(@Body
                                                                 Contact contact,
                                                                 @Query(value="action_by")
                                                                 OptInSource optInSource)

Create an individual Contact

Parameters:

contact - Contact

optInSource - Specify who is creating this contact with OptInSource

Returns:

an Observable that emits a new Contact object, with changes by the server, such as adding an ID

getContact

@GET(value="v2/contacts/{contactId}")
retrofit2.Call<Contact> getContact(@Path(value="contactId")
                                                                         java.lang.String contactId)

Get an individual Contact

Parameters:

contactId - Contact's ID

Returns:

an Observable that emits a Contact

updateContact

@PUT(value="v2/contacts/{contactId")
retrofit2.Call<Contact> updateContact(@Body
                                                                           Contact contact,
                                                                           @Path(value="contactId")
                                                                           java.lang.String contactId,
                                                                           @Query(value="action_by")
                                                                           OptInSource optInSource)

Update an individual Contact

Parameters:

contact - Contact object with updated information

contactId - Contact's ID

optInSource - Specify who is updating this contact with OptInSource

Returns:

an Observable that emits an updated Contact

unsubscribeContact

@DELETE(value="v2/contacts/{contactId}")
retrofit2.Call<retrofit2.Response> unsubscribeContact(@Path(value="contactId")
                                                                                               java.lang.String contactId)

Opt out an individual Contact

Parameters:

contactId - Contact's ID

Returns:

an Observable that emits a Response

getContactLists

@GET(value="v2/lists")
retrofit2.Call<java.util.List<ContactList>> getContactLists(@Query(value="modified_since")
                                                                                   java.lang.String date)

Get all ContactList in the account

Parameters:

date - Date to specify retrieval of contact lists that have been modified since then, in ISO-8601 format

Returns:

an Observable that emits a List of ContactLists

createContactList

@POST(value="v2/lists")
retrofit2.Call<ContactList> createContactList(@Body
                                                                      ContactList contactList)

Create a new ContactList

Parameters:

contactList - ContactList object (requires only name and status to create)

Returns:

an Observable that emits a new ContactList object, with changes by the server, such as adding an ID

getContactList

@GET(value="v2/lists/{listId}")
retrofit2.Call<ContactList> getContactList(@Path(value="listId")
                                                                           java.lang.String listId)

Get a specific ContactList

Parameters:

listId - ID of the list

Returns:

an Observable that emits a ContactList

updateContactList

@PUT(value="v2/lists/{listId}")
retrofit2.Call<ContactList> updateContactList(@Body
                                                                              ContactList contactList,
                                                                              @Path(value="listId")
                                                                              java.lang.String listId)

Update a ContactList

Parameters:

contactList - ContactList

listId - ID of the list

Returns:

an Observable that emits an updated ContactList

deleteContactList

@DELETE(value="v2/lists/{listId}")
retrofit2.Call<retrofit2.Response> deleteContactList(@Path(value="listId")
                                                                                        java.lang.String listId)

Delete a ContactList

Parameters:

listId - ID of the list

Returns:

an Observable that emits a Response

createCustomSignupForm

@POST(value="v2/signupform")
retrofit2.Call<SignupFormResponse> createCustomSignupForm(@Body
                                                                                       SignupFormRequest signupFormRequest)

Create a custom signup form

Parameters:

signupFormRequest - object that contains params for the signup form

Returns:

an Observable that emits a signup form response

See Also:

Signup Form Creation