com.mailgun.model.suppression.unsubscribe.UnsubscribeSingleItemRequest 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.suppression.unsubscribe;

import com.mailgun.util.DateTimeUtil;
import feign.form.FormProperty;
import lombok.Builder;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.ToString;

import java.time.ZonedDateTime;

/**
 * 
 * Unsubscribe single item request.
 * 
 *
 * @see Suppressions/Add a single unsubscribe
 */
@Getter
@ToString
@EqualsAndHashCode
@Builder
public class UnsubscribeSingleItemRequest {

    /**
     * 
     * Valid email address.
     * 
     */
    String address;

    /**
     * 
     * Name of the tag.
     * 
     * 
     * Tag to unsubscribe from, use * to unsubscribe an address from all domain’s correspondence (optional, default: *).
     * 
     */
    String tag;

    /**
     * 
     * Timestamp of an unsubscribe event (optional, default: current time).
     * 
     */
    @FormProperty("created_at")
    String createdAt;

    public static class UnsubscribeSingleItemRequestBuilder {

        /**
         * 
         * Timestamp of an unsubscribe event (optional, default: current time).
         * 
         *
         * @param zonedDateTime {@link ZonedDateTime}
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        public UnsubscribeSingleItemRequest.UnsubscribeSingleItemRequestBuilder createdAt(ZonedDateTime zonedDateTime) {
            this.createdAt = DateTimeUtil.toStringNameTimeZone(zonedDateTime);
            return this;
        }
    }

}