com.sparkpost.model.StoredTemplate Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sparkpost-lib Show documentation

The newest version!


package com.sparkpost.model;

import com.google.gson.annotations.SerializedName;
import com.yepher.jsondoc.annotations.Description;

import lombok.Data;
import lombok.EqualsAndHashCode;

/**
 * DTO for storing a stored template.
 */
@Data
@EqualsAndHashCode(callSuper = true)
public class StoredTemplate extends Base {

    /**
     * ID of the stored template to use
     * Specify this field when using a stored template. Maximum length -- 64
     * bytes
     */
    @Description(value = "ID of the stored template to use.  Specify this field when using a stored template. Maximum length -- 64 bytes", sample = {"AbC123"})
    @SerializedName("template_id")
    private String templateId;

    /**
     * Whether or not to use a draft template
     * If this field is set to true and no draft template exists, the
     * transmission will fail.
     */
    @Description(
            value = "Whether or not to use a draft template. If this field is set to true and no draft template exists, the transmission will fail.",
            sample = {"false"})
    @SerializedName("use_draft_template")
    private Boolean useDraftTemplate;
}