Package com.hellosign.openapi.model

Class EmbeddedEditUrlRequest

  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class EmbeddedEditUrlRequest
extends java.lang.Object
    EmbeddedEditUrlRequest

    • Field Detail

      • JSON_PROPERTY_ALLOW_EDIT_CCS

        public static final java.lang.String JSON_PROPERTY_ALLOW_EDIT_CCS
        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_EDITOR_OPTIONS

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

      • JSON_PROPERTY_FORCE_SIGNER_ROLES

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

      • JSON_PROPERTY_FORCE_SUBJECT_MESSAGE

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

      • JSON_PROPERTY_MERGE_FIELDS

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

      • JSON_PROPERTY_PREVIEW_ONLY

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

      • JSON_PROPERTY_SHOW_PREVIEW

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

      • JSON_PROPERTY_SHOW_PROGRESS_STEPPER

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

      • JSON_PROPERTY_TEST_MODE

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

    • Constructor Detail

      • EmbeddedEditUrlRequest

        public EmbeddedEditUrlRequest()

    • Method Detail

      • getAllowEditCcs

        @Nullable
public java.lang.Boolean getAllowEditCcs()
        This allows the requester to enable/disable to add or change CC roles when editing the template.
        Returns:
        allowEditCcs

      • setAllowEditCcs

        public void setAllowEditCcs​(java.lang.Boolean allowEditCcs)

      • getCcRoles

        @Nullable
public java.util.List<java.lang.String> getCcRoles()
        The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.
        Returns:
        ccRoles

      • setCcRoles

        public void setCcRoles​(java.util.List<java.lang.String> ccRoles)

      • getEditorOptions

        @Nullable
public SubEditorOptions getEditorOptions()
        Get editorOptions
        Returns:
        editorOptions

      • setEditorOptions

        public void setEditorOptions​(SubEditorOptions editorOptions)

      • getForceSignerRoles

        @Nullable
public java.lang.Boolean getForceSignerRoles()
        Provide users the ability to review/edit the template signer roles.
        Returns:
        forceSignerRoles

      • setForceSignerRoles

        public void setForceSignerRoles​(java.lang.Boolean forceSignerRoles)

      • forceSubjectMessage

        public EmbeddedEditUrlRequest forceSubjectMessage​(java.lang.Boolean forceSubjectMessage)

      • getForceSubjectMessage

        @Nullable
public java.lang.Boolean getForceSubjectMessage()
        Provide users the ability to review/edit the template subject and message.
        Returns:
        forceSubjectMessage

      • setForceSubjectMessage

        public void setForceSubjectMessage​(java.lang.Boolean forceSubjectMessage)

      • getMergeFields

        @Nullable
public java.util.List<SubMergeField> getMergeFields()
        Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template. Remove all merge fields on the template by passing an empty array `[]`.
        Returns:
        mergeFields

      • setMergeFields

        public void setMergeFields​(java.util.List<SubMergeField> mergeFields)

      • getPreviewOnly

        @Nullable
public java.lang.Boolean getPreviewOnly()
        This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor). **Note**: This parameter overwrites `show_preview=true` (if set).
        Returns:
        previewOnly

      • setPreviewOnly

        public void setPreviewOnly​(java.lang.Boolean previewOnly)

      • getShowPreview

        @Nullable
public java.lang.Boolean getShowPreview()
        This allows the requester to enable the editor/preview experience.
        Returns:
        showPreview

      • setShowPreview

        public void setShowPreview​(java.lang.Boolean showPreview)

      • showProgressStepper

        public EmbeddedEditUrlRequest showProgressStepper​(java.lang.Boolean showProgressStepper)

      • getShowProgressStepper

        @Nullable
public java.lang.Boolean getShowProgressStepper()
        When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
        Returns:
        showProgressStepper

      • setShowProgressStepper

        public void setShowProgressStepper​(java.lang.Boolean showProgressStepper)

      • getTestMode

        @Nullable
public java.lang.Boolean getTestMode()
        Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`.
        Returns:
        testMode

      • setTestMode

        public void setTestMode​(java.lang.Boolean testMode)

      • equals

        public boolean equals​(java.lang.Object o)
        Return true if this EmbeddedEditUrlRequest 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