com.mailgun.model.mailing.lists.MailingListMembersRequest 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.

The newest version!

package com.mailgun.model.mailing.lists;

import com.mailgun.enums.YesNo;
import lombok.Builder;
import lombok.Value;
import lombok.extern.jackson.Jacksonized;

/**
 * 
 * Mailing list members request.
 * 
 *
 * @see Mailing Lists
 */
@Value
@Jacksonized
@Builder
public class MailingListMembersRequest {

    /**
     * 
     * Maximum number of records to return (100 by default).
     * 
     */
    Integer limit;

	/**
	 * 
	 * Page name: first, last, next or prev.
	 * 
	 */
	String page;

	/**
	 * 
	 * The email address after or before which the list should be returned
	 * 
	 */
	String address;

    /**
     * 
     * yes to lists subscribed.
     * 
     * 
     * no for unsubscribed.
     * 
     * 
     * List all if not set.
     * 
     */
    String subscribed;

    public static class MailingListMembersRequestBuilder {

        /**
         * 
         * true to lists subscribed.
         * 
         * 
         * false for unsubscribed.
         * 
         *
         * @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 MailingListMembersRequest.MailingListMembersRequestBuilder subscribed(boolean subscribed) {
            this.subscribed = YesNo.getValue(subscribed);
            return this;
        }
    }

}