net.optionfactory.whatsapp.dto.messages.Contact Maven / Gradle / Ivy

Go to download
package net.optionfactory.whatsapp.dto.messages;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;

import java.util.ArrayList;
import java.util.List;

/**
 * Full contact information.
 *
 * @see Api reference
 */
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Contact {
    /**
     * Optional.
     * 
     * YYYY-MM-DD formatted string.
     */
    @JsonProperty("birthday")
    private String birthday;

    @JsonProperty("emails")
    private List emails;
    /**
     * Optional.
     * 

     * Full contact address(es) formatted as an addresses object.
     */
    @JsonProperty("addresses")
    private List addresses;

    @JsonProperty("urls")
    private List urls;

    @JsonProperty("org")
    private Org org;

    @JsonProperty("name")
    private Name name;

    @JsonProperty("phones")
    private List phones;

    /**
     * Gets birthday.
     *
     * @return the birthday
     */
    public String getBirthday() {
        return birthday;
    }

    /**
     * Sets birthday.
     *
     * @param birthday the birthday.  Optional.
     *                 YYYY-MM-DD formatted string.
     * @return Contact
     */
    public Contact setBirthday(String birthday) {
        this.birthday = birthday;
        return this;
    }

    /**
     * Gets emails.
     *
     * @return the emails
     */
    public List getEmails() {
        return emails;
    }

    /**
     * Sets emails.
     *
     * @param emails Optional. Contact email address(es) formatted as an emails object.
     * @return the emails
     */
    public Contact setEmails(List emails) {
        this.emails = emails;
        return this;
    }

    /**
     * Add emails contact.
     *
     * @param email Optional. Contact email address(es) formatted as an emails object.
     * @return the contact
     * @deprecated use {@link #addEmail(Email)} instead
     */
    @Deprecated(forRemoval = true)
    public Contact addEmails(Email email) {
        if (this.emails == null) this.emails = new ArrayList<>();

        this.emails.add(email);
        return this;
    }

    /**
     * Add emails contact.
     *
     * @param email Optional. Contact email address(es) formatted as an emails object.
     * @return the contact
     */
    public Contact addEmail(Email email) {
        if (this.emails == null) this.emails = new ArrayList<>();

        this.emails.add(email);
        return this;
    }

    /**
     * Gets addresses.
     *
     * @return the addresses
     */
    public List getAddresses() {
        return addresses;
    }

    /**
     * Sets addresses.
     *
     * @param addresses Optional. Full contact address(es) formatted as an addresses object
     * @return the addresses
     */
    public Contact setAddresses(List addresses) {
        this.addresses = addresses;
        return this;
    }

    /**
     * Add addresses contact.
     *
     * @param address Optional. Full contact address(es) formatted as an addresses object
     * @return the contact
     * @deprecated use {@link #addAddress(Address)}
     */
    @Deprecated(forRemoval = true)
    public Contact addAddresses(Address address) {
        if (this.addresses == null) this.addresses = new ArrayList<>();
        this.addresses.add(address);
        return this;
    }

    /**
     * Add addresses contact.
     *
     * @param address Optional. Full contact address(es) formatted as an addresses object
     * @return the contact
     */
    public Contact addAddress(Address address) {
        if (this.addresses == null) this.addresses = new ArrayList<>();
        this.addresses.add(address);
        return this;
    }

    /**
     * Gets urls.
     *
     * @return the urls
     */
    public List getUrls() {
        return urls;
    }

    /**
     * Sets urls.
     *
     * @param urls Optional. Contact URL(s) formatted as a urls object.
     * @return the urls
     */
    public Contact setUrls(List urls) {
        this.urls = urls;
        return this;
    }

    /**
     * Add urls contact.
     *
     * @param url Optional.Contact URL(s) formatted as a urls object.
     * @return the contact
     * @deprecated use {@link #addUrl(Url)}
     */
    @Deprecated(forRemoval = true)
    public Contact addUrls(Url url) {
        if (this.urls == null) this.urls = new ArrayList<>();

        this.urls.add(url);
        return this;
    }

    /**
     * Add url contact.
     *
     * @param url Optional.Contact URL(s) formatted as a urls object.
     * @return the contact
     */
    public Contact addUrl(Url url) {
        if (this.urls == null) this.urls = new ArrayList<>();

        this.urls.add(url);
        return this;
    }

    /**
     * Gets org.
     *
     * @return the org
     */
    public Org getOrg() {
        return org;
    }

    /**
     * Sets org.
     *
     * @param org Optional. Contact organization information formatted as an org object
     * @return the org
     */
    public Contact setOrg(Org org) {
        this.org = org;
        return this;
    }

    /**
     * Gets name.
     *
     * @return the name
     */
    public Name getName() {
        return name;
    }

    /**
     * Sets name.
     *
     * @param name {@link Name}. Required.
     *             Full contact name formatted as a name object.
     * @return the name
     */
    public Contact setName(Name name) {
        this.name = name;
        return this;
    }


    /**
     * Gets phones.
     *
     * @return the phones
     */
    public List getPhones() {
        return phones;
    }

    /**
     * Sets phones.
     *
     * @param phones {@link Phone} Optional. Contact phone number(s) formatted as a phone object.
     * @return the phones
     */
    public Contact setPhones(List phones) {
        this.phones = phones;
        return this;
    }

    /**
     * Add phones contact.
     *
     * @param phone Optional. Contact phone number(s) formatted as a phone object.
     * @return the contact
     * @deprecated use {@link Contact#addPhone(Phone)} instead
     */
    @Deprecated(forRemoval = true)
    public Contact addPhones(Phone phone) {
        if (this.phones == null) this.phones = new ArrayList<>();
        this.phones.add(phone);
        return this;
    }

    /**
     * Add phones contact.
     *
     * @param phone Optional. Contact phone number(s) formatted as a phone object.
     * @return the contact
     */
    public Contact addPhone(Phone phone) {
        if (this.phones == null) this.phones = new ArrayList<>();
        this.phones.add(phone);
        return this;
    }
}