com.mailgun.model.mailing.lists.MailingListMemberUpdateRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mailgun-java Show documentation

The Mailgun SDK for Java enables Java developers to work with Mailgun API efficiently.

There is a newer version: 1.1.3

package com.mailgun.model.mailing.lists;

import com.mailgun.enums.YesNo;
import lombok.Builder;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.ToString;

import java.util.Map;

/**
 * 
 * Mailing list member update request.
 * 
 *
 * @see Mailing Lists
 */
@Getter
@ToString
@EqualsAndHashCode
@Builder
public class MailingListMemberUpdateRequest {

    /**
     * 
     * Valid email address specification, e.g. {@code "Alice "} or just {@code "[email protected]" }.
     * 
     */
    String address;

    /**
     * 
     * Recipient name, e.g. Alice.
     * 
     */
    String name;

    /**
     * 
     * A map with arbitrary keys/values that turns into a JSON dictionary, e.g. {@code {"sex":"female","age":27} }.
     * 
     */
    Map vars;

    /**
     * 
     * no to set unsubscribed.
     * 

     * 
     * yes as subscribed.
     * 
     */
    String subscribed;

    public static class MailingListMemberUpdateRequestBuilder {

        /**
         * 
         * false to set unsubscribed.
         * 
         * 
         * true as subscribed.
         * 
         *
         * @param subscribed true to lists subscribed, false for unsubscribed
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        public MailingListMemberUpdateRequest.MailingListMemberUpdateRequestBuilder subscribed(boolean subscribed) {
            this.subscribed = YesNo.getValue(subscribed);
            return this;
        }
    }

}