Package io.mailtrap.api.contactfields

Class ContactFieldsImpl

java.lang.Object

io.mailtrap.api.apiresource.ApiResource

io.mailtrap.api.apiresource.ApiResourceWithValidation

io.mailtrap.api.contactfields.ContactFieldsImpl

All Implemented Interfaces:

ContactFields

public class ContactFieldsImpl
extends ApiResourceWithValidation
implements ContactFields

Field Summary

Fields inherited from class io.mailtrap.api.apiresource.ApiResourceWithValidation

mailtrapValidator

Fields inherited from class io.mailtrap.api.apiresource.ApiResource

apiHost, httpClient, token

Constructor Summary

Constructors

Constructor	Description
ContactFieldsImpl(MailtrapConfig config, MailtrapValidator mailtrapValidator)

Method Summary

Modifier and Type	Method	Description
ContactFieldResponse	createContactField(long accountId, CreateContactFieldRequest request)	Create new Contact Fields (up to 40)
void	deleteContactField(long accountId, long fieldId)	Delete existing Contact Field.
List<ContactFieldResponse>	getAllContactFields(long accountId)	Get all Contact Fields existing in your account
ContactFieldResponse	getContactField(long accountId, long fieldId)	Get Contact Field by id
ContactFieldResponse	updateContactField(long accountId, long fieldId, UpdateContactFieldRequest request)	Update existing Contact Field

Methods inherited from class io.mailtrap.api.apiresource.ApiResourceWithValidation

validateRequestBodyAndThrowException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ContactFieldsImpl

public ContactFieldsImpl(MailtrapConfig config,
 MailtrapValidator mailtrapValidator)

Method Details

getAllContactFields

public List<ContactFieldResponse> getAllContactFields(long accountId)

Description copied from interface: ContactFields

Get all Contact Fields existing in your account

Specified by:

getAllContactFields in interface ContactFields

Parameters:

accountId - unique account ID

Returns:

existing contact fields

createContactField

public ContactFieldResponse createContactField(long accountId,
 CreateContactFieldRequest request)

Description copied from interface: ContactFields

Create new Contact Fields (up to 40)

Specified by:

createContactField in interface ContactFields

Parameters:

accountId - unique account ID

request - contact field data

Returns:

attributes of the created contact field

getContactField

public ContactFieldResponse getContactField(long accountId,
 long fieldId)

Description copied from interface: ContactFields

Get Contact Field by id

Specified by:

getContactField in interface ContactFields

Parameters:

accountId - unique account ID

fieldId - Unique Contact Field ID

Returns:

attributes of the contact field

updateContactField

public ContactFieldResponse updateContactField(long accountId,
 long fieldId,
 UpdateContactFieldRequest request)

Description copied from interface: ContactFields

Update existing Contact Field

Specified by:

updateContactField in interface ContactFields

Parameters:

accountId - unique account ID

fieldId - Unique Contact Field ID

request - update data. You cannot change data_type of the field

Returns:

attributes of the contact field

deleteContactField

public void deleteContactField(long accountId,
 long fieldId)

Description copied from interface: ContactFields

Delete existing Contact Field. You cannot delete a Contact Field which is used in Automations, Email Campaigns, and in conditions of Contact Segments

Specified by:

deleteContactField in interface ContactFields

Parameters:

accountId - unique account ID

fieldId - Unique Contact Field ID