dropbox-sign 1.0.0.pre.beta2301 → 1.0.0

data/lib/dropbox-sign/models/template_response_document_form_field.rb

@@ -19,44 +19,58 @@ end
 module Dropbox::Sign
   class TemplateResponseDocumentFormField
     # A unique id for the form field.
+    # @return [String]
     attr_accessor :api_id
 
     # The name of the form field.
+    # @return [String]
     attr_accessor :name
 
     # The type of this form field. See [field types](/api/reference/constants/#field-types).
+    # @return [String]
     attr_accessor :type
 
     # The signer of the Form Field.
+    # @return [String]
     attr_accessor :signer
 
     # The horizontal offset in pixels for this form field.
+    # @return [Integer]
     attr_accessor :x
 
     # The vertical offset in pixels for this form field.
+    # @return [Integer]
     attr_accessor :y
 
     # The width in pixels of this form field.
+    # @return [Integer]
     attr_accessor :width
 
     # The height in pixels of this form field.
+    # @return [Integer]
     attr_accessor :height
 
     # Boolean showing whether or not this field is required.
+    # @return [Boolean]
     attr_accessor :required
 
     # The name of the group this field is in. If this field is not a group, this defaults to `null`.
+    # @return [String, nil]
     attr_accessor :group
 
+    # @return [TemplateResponseFieldAvgTextLength]
     attr_accessor :avg_text_length
 
     # Whether this form field is multiline text.
+    # @return [Boolean, nil]
     attr_accessor :is_multiline
 
     # Original font size used in this form field's text.
+    # @return [Integer, nil]
     attr_accessor :original_font_size
 
     # Font family used in this form field's text.
+    # @return [String, nil]
     attr_accessor :font_family
 
     class EnumAttributeValidator

data/lib/dropbox-sign/models/template_response_document_static_field.rb

@@ -19,33 +19,43 @@ end
 module Dropbox::Sign
   class TemplateResponseDocumentStaticField
     # The name of the static field.
+    # @return [String]
     attr_accessor :name
 
     # The type of this static field. See [field types](/api/reference/constants/#field-types).
+    # @return [String]
     attr_accessor :type
 
     # The signer of the Static Field.
+    # @return [String]
     attr_accessor :signer
 
     # The horizontal offset in pixels for this static field.
+    # @return [Integer]
     attr_accessor :x
 
     # The vertical offset in pixels for this static field.
+    # @return [Integer]
     attr_accessor :y
 
     # The width in pixels of this static field.
+    # @return [Integer]
     attr_accessor :width
 
     # The height in pixels of this static field.
+    # @return [Integer]
     attr_accessor :height
 
     # Boolean showing whether or not this field is required.
+    # @return [Boolean]
     attr_accessor :required
 
     # A unique id for the static field.
+    # @return [String]
     attr_accessor :api_id
 
     # The name of the group this field is in. If this field is not a group, this defaults to `null`.
+    # @return [String, nil]
     attr_accessor :group
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/template_response_field_avg_text_length.rb

@@ -20,9 +20,11 @@ module Dropbox::Sign
   # Average text length in this field.
   class TemplateResponseFieldAvgTextLength
     # Number of lines.
+    # @return [Integer]
     attr_accessor :num_lines
 
     # Number of character per line.
+    # @return [Integer]
     attr_accessor :num_chars_per_line
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/template_response_named_form_field.rb

@@ -19,44 +19,58 @@ end
 module Dropbox::Sign
   class TemplateResponseNamedFormField
     # The name of the Named Form Field.
+    # @return [String]
     attr_accessor :name
 
     # The type of this Named Form Field. Only `text` and `checkbox` are currently supported.
+    # @return [String]
     attr_accessor :type
 
     # The signer of the Named Form Field.
+    # @return [String]
     attr_accessor :signer
 
     # The horizontal offset in pixels for this form field.
+    # @return [Integer]
     attr_accessor :x
 
     # The vertical offset in pixels for this form field.
+    # @return [Integer]
     attr_accessor :y
 
     # The width in pixels of this form field.
+    # @return [Integer]
     attr_accessor :width
 
     # The height in pixels of this form field.
+    # @return [Integer]
     attr_accessor :height
 
     # Boolean showing whether or not this field is required.
+    # @return [Boolean]
     attr_accessor :required
 
     # The unique ID for this field.
+    # @return [String]
     attr_accessor :api_id
 
     # The name of the group this field is in. If this field is not a group, this defaults to `null`.
+    # @return [String, nil]
     attr_accessor :group
 
+    # @return [TemplateResponseFieldAvgTextLength]
     attr_accessor :avg_text_length
 
     # Whether this form field is multiline text.
+    # @return [Boolean, nil]
     attr_accessor :is_multiline
 
     # Original font size used in this form field's text.
+    # @return [Integer, nil]
     attr_accessor :original_font_size
 
     # Font family used in this form field's text.
+    # @return [String, nil]
     attr_accessor :font_family
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/template_response_signer_role.rb

@@ -19,9 +19,11 @@ end
 module Dropbox::Sign
   class TemplateResponseSignerRole
     # The name of the Role.
+    # @return [String]
     attr_accessor :name
 
     # If signer order is assigned this is the 0-based index for this role.
+    # @return [Integer]
     attr_accessor :order
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/template_update_files_request.rb

@@ -19,21 +19,27 @@ end
 module Dropbox::Sign
   class TemplateUpdateFilesRequest
     # Client id of the app you're using to update this template.
+    # @return [String]
     attr_accessor :client_id
 
     # Use `files[]` to indicate the uploaded file(s) to use for the template.  This endpoint requires either **files** or **file_urls[]**, but not both.
+    # @return [Array<File>]
     attr_accessor :files
 
     # Use `file_urls[]` to have Dropbox Sign download the file(s) to use for the template.  This endpoint requires either **files** or **file_urls[]**, but not both.
+    # @return [Array<String>]
     attr_accessor :file_urls
 
     # The new default template email message.
+    # @return [String]
     attr_accessor :message
 
     # The new default template email subject.
+    # @return [String]
     attr_accessor :subject
 
     # Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
+    # @return [Boolean]
     attr_accessor :test_mode
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/template_update_files_response.rb

@@ -18,6 +18,7 @@ end
 
 module Dropbox::Sign
   class TemplateUpdateFilesResponse
+    # @return [TemplateUpdateFilesResponseTemplate]
     attr_accessor :template
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/template_update_files_response_template.rb

@@ -20,9 +20,11 @@ module Dropbox::Sign
   # Contains template id
   class TemplateUpdateFilesResponseTemplate
     # The id of the Template.
+    # @return [String]
     attr_accessor :template_id
 
     # A list of warnings.
+    # @return [Array<WarningResponse>]
     attr_accessor :warnings
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb

@@ -19,108 +19,144 @@ end
 module Dropbox::Sign
   class UnclaimedDraftCreateEmbeddedRequest
     # Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
+    # @return [String]
     attr_accessor :client_id
 
     # The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`.
+    # @return [String]
     attr_accessor :requester_email_address
 
     # Use `files[]` to indicate the uploaded file(s) to send for signature.  This endpoint requires either **files** or **file_urls[]**, but not both.
+    # @return [Array<File>]
     attr_accessor :files
 
     # Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.  This endpoint requires either **files** or **file_urls[]**, but not both.
+    # @return [Array<String>]
     attr_accessor :file_urls
 
     # This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.
+    # @return [Boolean]
     attr_accessor :allow_ccs
 
     # Allows signers to decline to sign a document if `true`. Defaults to `false`.
+    # @return [Boolean]
     attr_accessor :allow_decline
 
     # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.  **Note**: Only available for Premium plan and higher.
+    # @return [Boolean]
     attr_accessor :allow_reassign
 
     # A list describing the attachments
+    # @return [Array<SubAttachment>]
     attr_accessor :attachments
 
     # The email addresses that should be CCed.
+    # @return [Array<String>]
     attr_accessor :cc_email_addresses
 
     # When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.  Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.  For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
+    # @return [Array<SubCustomField>]
     attr_accessor :custom_fields
 
+    # @return [SubEditorOptions]
     attr_accessor :editor_options
 
+    # @return [SubFieldOptions]
     attr_accessor :field_options
 
     # Provide users the ability to review/edit the signers.
+    # @return [Boolean]
     attr_accessor :force_signer_page
 
     # Provide users the ability to review/edit the subject and message.
+    # @return [Boolean]
     attr_accessor :force_subject_message
 
     # Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.
+    # @return [Array<SubFormFieldGroup>]
     attr_accessor :form_field_groups
 
     # Conditional Logic rules for fields defined in `form_fields_per_document`.
+    # @return [Array<SubFormFieldRule>]
     attr_accessor :form_field_rules
 
     # The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href=\"/docs/openapi/form-fields-per-document\" target=\"_blank\">Using Form Fields per Document</a>.)  **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.  * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
+    # @return [Array<SubFormFieldsPerDocumentBase>]
     attr_accessor :form_fields_per_document
 
     # Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details.
+    # @return [Boolean]
     attr_accessor :hide_text_tags
 
     # The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`.
+    # @return [Boolean]
     attr_accessor :hold_request
 
     # The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`.
+    # @return [Boolean]
     attr_accessor :is_for_embedded_signing
 
     # The custom message in the email that will be sent to the signers.
+    # @return [String]
     attr_accessor :message
 
     # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.  Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
+    # @return [Hash<String, Object>]
     attr_accessor :metadata
 
     # The URL you want signers redirected to after they successfully request a signature.
+    # @return [String]
     attr_accessor :requesting_redirect_url
 
     # This allows the requester to enable the editor/preview experience.  - `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience.
+    # @return [Boolean]
     attr_accessor :show_preview
 
     # When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
+    # @return [Boolean]
     attr_accessor :show_progress_stepper
 
     # Add Signers to your Unclaimed Draft Signature Request.
+    # @return [Array<SubUnclaimedDraftSigner>]
     attr_accessor :signers
 
+    # @return [SubSigningOptions]
     attr_accessor :signing_options
 
     # The URL you want signers redirected to after they successfully sign.
+    # @return [String]
     attr_accessor :signing_redirect_url
 
     # Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.
+    # @return [Boolean]
     attr_accessor :skip_me_now
 
     # The subject in the email that will be sent to the signers.
+    # @return [String]
     attr_accessor :subject
 
     # Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
+    # @return [Boolean]
     attr_accessor :test_mode
 
     # The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it.
+    # @return [String]
     attr_accessor :type
 
     # Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
+    # @return [Boolean]
     attr_accessor :use_preexisting_fields
 
     # Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
+    # @return [Boolean]
     attr_accessor :use_text_tags
 
     # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.  ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
+    # @return [Boolean]
     attr_accessor :populate_auto_fill_fields
 
     # When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.  **Note**: This does not correspond to the **expires_at** returned in the response.
+    # @return [Integer, nil]
     attr_accessor :expires_at
 
     class EnumAttributeValidator

data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb

@@ -19,87 +19,116 @@ end
 module Dropbox::Sign
   class UnclaimedDraftCreateEmbeddedWithTemplateRequest
     # Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
+    # @return [String]
     attr_accessor :client_id
 
     # The email address of the user that should be designated as the requester of this draft.
+    # @return [String]
     attr_accessor :requester_email_address
 
     # Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used.
+    # @return [Array<String>]
     attr_accessor :template_ids
 
     # Allows signers to decline to sign a document if `true`. Defaults to `false`.
+    # @return [Boolean]
     attr_accessor :allow_decline
 
     # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.  **Note**: Only available for Premium plan and higher.
+    # @return [Boolean]
     attr_accessor :allow_reassign
 
     # Add CC email recipients. Required when a CC role exists for the Template.
+    # @return [Array<SubCC>]
     attr_accessor :ccs
 
     # An array defining values and options for custom fields. Required when a custom field exists in the Template.
+    # @return [Array<SubCustomField>]
     attr_accessor :custom_fields
 
+    # @return [SubEditorOptions]
     attr_accessor :editor_options
 
+    # @return [SubFieldOptions]
     attr_accessor :field_options
 
     # Use `files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored.  **files** or **file_urls[]** is required, but not both.
+    # @return [Array<File>]
     attr_accessor :files
 
     # Use file_urls[] to append additional files to the signature request being created from the template. Dropbox Sign will download the file, then parse it for [text tags](https://app.hellosign.com/api/textTagsWalkthrough), and append to the signature request. Text tags for signers not on the template(s) will be ignored.  **files** or **file_urls[]** is required, but not both.
+    # @return [Array<String>]
     attr_accessor :file_urls
 
     # Provide users the ability to review/edit the template signer roles.
+    # @return [Boolean]
     attr_accessor :force_signer_roles
 
     # Provide users the ability to review/edit the template subject and message.
+    # @return [Boolean]
     attr_accessor :force_subject_message
 
     # The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`.
+    # @return [Boolean]
     attr_accessor :hold_request
 
     # The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`.
+    # @return [Boolean]
     attr_accessor :is_for_embedded_signing
 
     # The custom message in the email that will be sent to the signers.
+    # @return [String]
     attr_accessor :message
 
     # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.  Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
+    # @return [Hash<String, Object>]
     attr_accessor :metadata
 
     # 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).  - `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience.  **Note**: This parameter overwrites `show_preview=1` (if set).
+    # @return [Boolean]
     attr_accessor :preview_only
 
     # The URL you want signers redirected to after they successfully request a signature.
+    # @return [String]
     attr_accessor :requesting_redirect_url
 
     # This allows the requester to enable the editor/preview experience.  - `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience.
+    # @return [Boolean]
     attr_accessor :show_preview
 
     # When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
+    # @return [Boolean]
     attr_accessor :show_progress_stepper
 
     # Add Signers to your Templated-based Signature Request.
+    # @return [Array<SubUnclaimedDraftTemplateSigner>]
     attr_accessor :signers
 
+    # @return [SubSigningOptions]
     attr_accessor :signing_options
 
     # The URL you want signers redirected to after they successfully sign.
+    # @return [String]
     attr_accessor :signing_redirect_url
 
     # Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.
+    # @return [Boolean]
     attr_accessor :skip_me_now
 
     # The subject in the email that will be sent to the signers.
+    # @return [String]
     attr_accessor :subject
 
     # Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
+    # @return [Boolean]
     attr_accessor :test_mode
 
     # The title you want to assign to the SignatureRequest.
+    # @return [String]
     attr_accessor :title
 
     # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.  ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
+    # @return [Boolean]
     attr_accessor :populate_auto_fill_fields
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb

@@ -19,73 +19,97 @@ end
 module Dropbox::Sign
   class UnclaimedDraftCreateRequest
     # The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional.
+    # @return [String]
     attr_accessor :type
 
     # Use `files[]` to indicate the uploaded file(s) to send for signature.  This endpoint requires either **files** or **file_urls[]**, but not both.
+    # @return [Array<File>]
     attr_accessor :files
 
     # Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.  This endpoint requires either **files** or **file_urls[]**, but not both.
+    # @return [Array<String>]
     attr_accessor :file_urls
 
     # Allows signers to decline to sign a document if `true`. Defaults to `false`.
+    # @return [Boolean]
     attr_accessor :allow_decline
 
     # A list describing the attachments
+    # @return [Array<SubAttachment>]
     attr_accessor :attachments
 
     # The email addresses that should be CCed.
+    # @return [Array<String>]
     attr_accessor :cc_email_addresses
 
     # Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
+    # @return [String]
     attr_accessor :client_id
 
     # When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.  Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.  For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
+    # @return [Array<SubCustomField>]
     attr_accessor :custom_fields
 
+    # @return [SubFieldOptions]
     attr_accessor :field_options
 
     # Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.
+    # @return [Array<SubFormFieldGroup>]
     attr_accessor :form_field_groups
 
     # Conditional Logic rules for fields defined in `form_fields_per_document`.
+    # @return [Array<SubFormFieldRule>]
     attr_accessor :form_field_rules
 
     # The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href=\"/docs/openapi/form-fields-per-document\" target=\"_blank\">Using Form Fields per Document</a>.)  **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.  * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
+    # @return [Array<SubFormFieldsPerDocumentBase>]
     attr_accessor :form_fields_per_document
 
     # Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details.
+    # @return [Boolean]
     attr_accessor :hide_text_tags
 
     # The custom message in the email that will be sent to the signers.
+    # @return [String]
     attr_accessor :message
 
     # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.  Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
+    # @return [Hash<String, Object>]
     attr_accessor :metadata
 
     # When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
+    # @return [Boolean]
     attr_accessor :show_progress_stepper
 
     # Add Signers to your Unclaimed Draft Signature Request.
+    # @return [Array<SubUnclaimedDraftSigner>]
     attr_accessor :signers
 
+    # @return [SubSigningOptions]
     attr_accessor :signing_options
 
     # The URL you want signers redirected to after they successfully sign.
+    # @return [String]
     attr_accessor :signing_redirect_url
 
     # The subject in the email that will be sent to the signers.
+    # @return [String]
     attr_accessor :subject
 
     # Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
+    # @return [Boolean]
     attr_accessor :test_mode
 
     # Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
+    # @return [Boolean]
     attr_accessor :use_preexisting_fields
 
     # Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
+    # @return [Boolean]
     attr_accessor :use_text_tags
 
     # When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.  **Note**: This does not correspond to the **expires_at** returned in the response.
+    # @return [Integer, nil]
     attr_accessor :expires_at
 
     class EnumAttributeValidator

data/lib/dropbox-sign/models/unclaimed_draft_create_response.rb

@@ -18,9 +18,11 @@ end
 
 module Dropbox::Sign
   class UnclaimedDraftCreateResponse
+    # @return [UnclaimedDraftResponse]
     attr_accessor :unclaimed_draft
 
     # A list of warnings.
+    # @return [Array<WarningResponse>]
     attr_accessor :warnings
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb

@@ -19,26 +19,34 @@ end
 module Dropbox::Sign
   class UnclaimedDraftEditAndResendRequest
     # Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
+    # @return [String]
     attr_accessor :client_id
 
+    # @return [SubEditorOptions]
     attr_accessor :editor_options
 
     # The request created from this draft will also be signable in embedded mode if set to `true`.
+    # @return [Boolean]
     attr_accessor :is_for_embedded_signing
 
     # The email address of the user that should be designated as the requester of this draft. If not set, original requester's email address will be used.
+    # @return [String]
     attr_accessor :requester_email_address
 
     # The URL you want signers redirected to after they successfully request a signature.
+    # @return [String]
     attr_accessor :requesting_redirect_url
 
     # When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
+    # @return [Boolean]
     attr_accessor :show_progress_stepper
 
     # The URL you want signers redirected to after they successfully sign.
+    # @return [String]
     attr_accessor :signing_redirect_url
 
     # Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
+    # @return [Boolean]
     attr_accessor :test_mode
 
     # Attribute mapping from ruby-style variable name to JSON key.