Package com.hellosign.openapi.model

Class TemplateResponse

  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class TemplateResponse
extends java.lang.Object
    Contains information about the templates you and your team have created.

    • Field Detail

      • JSON_PROPERTY_TEMPLATE_ID

        public static final java.lang.String JSON_PROPERTY_TEMPLATE_ID
        See Also:
        Constant Field Values

      • JSON_PROPERTY_TITLE

        public static final java.lang.String JSON_PROPERTY_TITLE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_MESSAGE

        public static final java.lang.String JSON_PROPERTY_MESSAGE
        See Also:
        Constant Field Values

      • JSON_PROPERTY_UPDATED_AT

        public static final java.lang.String JSON_PROPERTY_UPDATED_AT
        See Also:
        Constant Field Values

      • JSON_PROPERTY_IS_EMBEDDED

        public static final java.lang.String JSON_PROPERTY_IS_EMBEDDED
        See Also:
        Constant Field Values

      • JSON_PROPERTY_IS_CREATOR

        public static final java.lang.String JSON_PROPERTY_IS_CREATOR
        See Also:
        Constant Field Values

      • JSON_PROPERTY_CAN_EDIT

        public static final java.lang.String JSON_PROPERTY_CAN_EDIT
        See Also:
        Constant Field Values

      • JSON_PROPERTY_IS_LOCKED

        public static final java.lang.String JSON_PROPERTY_IS_LOCKED
        See Also:
        Constant Field Values

      • JSON_PROPERTY_METADATA

        public static final java.lang.String JSON_PROPERTY_METADATA
        See Also:
        Constant Field Values

      • JSON_PROPERTY_SIGNER_ROLES

        public static final java.lang.String JSON_PROPERTY_SIGNER_ROLES
        See Also:
        Constant Field Values

      • JSON_PROPERTY_CC_ROLES

        public static final java.lang.String JSON_PROPERTY_CC_ROLES
        See Also:
        Constant Field Values

      • JSON_PROPERTY_DOCUMENTS

        public static final java.lang.String JSON_PROPERTY_DOCUMENTS
        See Also:
        Constant Field Values

      • JSON_PROPERTY_CUSTOM_FIELDS

        public static final java.lang.String JSON_PROPERTY_CUSTOM_FIELDS
        See Also:
        Constant Field Values

      • JSON_PROPERTY_NAMED_FORM_FIELDS

        public static final java.lang.String JSON_PROPERTY_NAMED_FORM_FIELDS
        See Also:
        Constant Field Values

      • JSON_PROPERTY_ACCOUNTS

        public static final java.lang.String JSON_PROPERTY_ACCOUNTS
        See Also:
        Constant Field Values

    • Constructor Detail

      • TemplateResponse

        public TemplateResponse()

    • Method Detail

      • templateId

        public TemplateResponse templateId​(java.lang.String templateId)

      • getTemplateId

        @Nullable
public java.lang.String getTemplateId()
        The id of the Template.
        Returns:
        templateId

      • setTemplateId

        public void setTemplateId​(java.lang.String templateId)

      • getTitle

        @Nullable
public java.lang.String getTitle()
        The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.
        Returns:
        title

      • setTitle

        public void setTitle​(java.lang.String title)

      • getMessage

        @Nullable
public java.lang.String getMessage()
        The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.
        Returns:
        message

      • setMessage

        public void setMessage​(java.lang.String message)

      • updatedAt

        public TemplateResponse updatedAt​(java.lang.Integer updatedAt)

      • getUpdatedAt

        @Nullable
public java.lang.Integer getUpdatedAt()
        Time the template was last updated.
        Returns:
        updatedAt

      • setUpdatedAt

        public void setUpdatedAt​(java.lang.Integer updatedAt)

      • isEmbedded

        public TemplateResponse isEmbedded​(java.lang.Boolean isEmbedded)

      • getIsEmbedded

        @Nullable
public java.lang.Boolean getIsEmbedded()
        `true` if this template was created using an embedded flow, `false` if it was created on our website.
        Returns:
        isEmbedded

      • setIsEmbedded

        public void setIsEmbedded​(java.lang.Boolean isEmbedded)

      • isCreator

        public TemplateResponse isCreator​(java.lang.Boolean isCreator)

      • getIsCreator

        @Nullable
public java.lang.Boolean getIsCreator()
        `true` if you are the owner of this template, `false` if it's been shared with you by a team member.
        Returns:
        isCreator

      • setIsCreator

        public void setIsCreator​(java.lang.Boolean isCreator)

      • getCanEdit

        @Nullable
public java.lang.Boolean getCanEdit()
        Indicates whether edit rights have been granted to you by the owner (always `true` if that's you).
        Returns:
        canEdit

      • setCanEdit

        public void setCanEdit​(java.lang.Boolean canEdit)

      • getIsLocked

        @Nullable
public java.lang.Boolean getIsLocked()
        Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests.
        Returns:
        isLocked

      • setIsLocked

        public void setIsLocked​(java.lang.Boolean isLocked)

      • getMetadata

        @Nullable
public java.lang.Object getMetadata()
        The metadata attached to the template.
        Returns:
        metadata

      • setMetadata

        public void setMetadata​(java.lang.Object metadata)

      • getSignerRoles

        @Nullable
public java.util.List<TemplateResponseSignerRole> getSignerRoles()
        An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
        Returns:
        signerRoles

      • getCcRoles

        @Nullable
public java.util.List<TemplateResponseCCRole> getCcRoles()
        An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.
        Returns:
        ccRoles

      • getDocuments

        @Nullable
public java.util.List<TemplateResponseDocument> getDocuments()
        An array describing each document associated with this Template. Includes form field data for each document.
        Returns:
        documents

      • getCustomFields

        @Nullable
public java.util.List<TemplateResponseCustomField> getCustomFields()
        An array of Custom Field objects.
        Returns:
        customFields

      • getNamedFormFields

        @Deprecated
@Nullable
public java.util.List<TemplateResponseNamedFormField> getNamedFormFields()
        Deprecated.
        Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.
        Returns:
        namedFormFields

      • getAccounts

        @Nullable
public java.util.List<TemplateResponseAccount> getAccounts()
        An array of the Accounts that can use this Template.
        Returns:
        accounts

      • equals

        public boolean equals​(java.lang.Object o)
        Return true if this TemplateResponse object is equal to o.
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • createFormData

        public java.util.Map<java.lang.String,​java.lang.Object> createFormData()
                                                                      throws ApiException
        Throws:
        ApiException