dropbox-sign 1.0.0.pre.beta2301 → 1.0.1

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

@@ -20,60 +20,79 @@ module Dropbox::Sign
   # An array of signature objects, 1 for each signer.
   class SignatureRequestResponseSignatures
     # Signature identifier.
+    # @return [String]
     attr_accessor :signature_id
 
     # Signer Group GUID
+    # @return [String, nil]
     attr_accessor :signer_group_guid
 
     # The email address of the signer.
+    # @return [String]
     attr_accessor :signer_email_address
 
     # The name of the signer.
+    # @return [String, nil]
     attr_accessor :signer_name
 
     # The role of the signer.
+    # @return [String, nil]
     attr_accessor :signer_role
 
     # If signer order is assigned this is the 0-based index for this signer.
+    # @return [Integer, nil]
     attr_accessor :order
 
     # The current status of the signature. eg: awaiting_signature, signed, declined.
+    # @return [String]
     attr_accessor :status_code
 
     # The reason provided by the signer for declining the request.
+    # @return [String, nil]
     attr_accessor :decline_reason
 
     # Time that the document was signed or null.
+    # @return [Integer, nil]
     attr_accessor :signed_at
 
     # The time that the document was last viewed by this signer or null.
+    # @return [Integer, nil]
     attr_accessor :last_viewed_at
 
     # The time the last reminder email was sent to the signer or null.
+    # @return [Integer, nil]
     attr_accessor :last_reminded_at
 
     # Boolean to indicate whether this signature requires a PIN to access.
+    # @return [Boolean]
     attr_accessor :has_pin
 
     # Boolean to indicate whether this signature has SMS authentication enabled.
+    # @return [Boolean, nil]
     attr_accessor :has_sms_auth
 
     # Boolean to indicate whether this signature has SMS delivery enabled.
+    # @return [Boolean, nil]
     attr_accessor :has_sms_delivery
 
     # The SMS phone number used for authentication or signature request delivery.
+    # @return [String, nil]
     attr_accessor :sms_phone_number
 
     # Email address of original signer who reassigned to this signer.
+    # @return [String, nil]
     attr_accessor :reassigned_by
 
     # Reason provided by original signer who reassigned to this signer.
+    # @return [String, nil]
     attr_accessor :reassignment_reason
 
     # Previous signature identifier.
+    # @return [String, nil]
     attr_accessor :reassigned_from
 
     # Error message pertaining to this signer, or null.
+    # @return [String, nil]
     attr_accessor :error
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,76 +19,101 @@ end
 module Dropbox::Sign
   class SignatureRequestSendRequest
     # 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
 
     # Add Signers to your Signature Request.  This endpoint requires either **signers** or **grouped_signers**, but not both.
+    # @return [Array<SubSignatureRequestSigner>]
     attr_accessor :signers
 
     # Add Grouped Signers to your Signature Request.  This endpoint requires either **signers** or **grouped_signers**, but not both.
+    # @return [Array<SubSignatureRequestGroupedSigners>]
     attr_accessor :grouped_signers
 
     # 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
 
     # The client id of the API App you want to associate with this request. 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`
+    # 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: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)  **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
 
     # Enables automatic Text Tag removal when set to true.  **NOTE**: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.
+    # @return [Boolean]
     attr_accessor :hide_text_tags
 
     # Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **Note**: QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer.
+    # @return [Boolean]
     attr_accessor :is_qualified_signature
 
     # 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
 
+    # @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 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
 
     # Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.
+    # @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.
+    # @return [Integer, nil]
     attr_accessor :expires_at
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,50 +19,66 @@ end
 module Dropbox::Sign
   class SignatureRequestSendWithTemplateRequest
     # Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
+    # @return [Array<String>]
     attr_accessor :template_ids
 
     # Add Signers to your Templated-based Signature Request.
+    # @return [Array<SubSignatureRequestTemplateSigner>]
     attr_accessor :signers
 
     # Allows signers to decline to sign a document if `true`. Defaults to `false`.
+    # @return [Boolean]
     attr_accessor :allow_decline
 
     # Add CC email recipients. Required when a CC role exists for the Template.
+    # @return [Array<SubCC>]
     attr_accessor :ccs
 
     # Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.
+    # @return [String]
     attr_accessor :client_id
 
     # 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
 
     # 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
 
     # Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **Note**: QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer.
+    # @return [Boolean]
     attr_accessor :is_qualified_signature
 
     # 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
 
+    # @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 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
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,15 +19,19 @@ end
 module Dropbox::Sign
   class SignatureRequestUpdateRequest
     # The signature ID for the recipient.
+    # @return [String]
     attr_accessor :signature_id
 
     # The new email address for the recipient.  **NOTE**: Optional if `name` is provided.
+    # @return [String]
     attr_accessor :email_address
 
     # The new name for the recipient.  **NOTE**: Optional if `email_address` is provided.
+    # @return [String]
     attr_accessor :name
 
     # The new time 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.
+    # @return [Integer, nil]
     attr_accessor :expires_at
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,15 +19,19 @@ end
 module Dropbox::Sign
   class SubAttachment
     # The name of attachment.
+    # @return [String]
     attr_accessor :name
 
     # The signer's index in the `signers` parameter (0-based indexing).  **NOTE**: Only one signer can be assigned per attachment.
+    # @return [Integer]
     attr_accessor :signer_index
 
     # The instructions for uploading the attachment.
+    # @return [String]
     attr_accessor :instructions
 
     # Determines if the attachment must be uploaded.
+    # @return [Boolean]
     attr_accessor :required
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,9 +19,11 @@ end
 module Dropbox::Sign
   class SubBulkSignerList
     # An array of custom field values.
+    # @return [Array<SubBulkSignerListCustomField>]
     attr_accessor :custom_fields
 
     # Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.  Currently only templates with a single role are supported. All signers must have the same `role` value.
+    # @return [Array<SubSignatureRequestTemplateSigner>]
     attr_accessor :signers
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,9 +19,11 @@ end
 module Dropbox::Sign
   class SubBulkSignerListCustomField
     # The name of the custom field. Must be the field's `name` or `api_id`.
+    # @return [String]
     attr_accessor :name
 
     # The value of the custom field.
+    # @return [String]
     attr_accessor :value
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,9 +19,11 @@ end
 module Dropbox::Sign
   class SubCC
     # Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role.
+    # @return [String]
     attr_accessor :role
 
     # The email address of the CC recipient.
+    # @return [String]
     attr_accessor :email_address
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,15 +20,19 @@ module Dropbox::Sign
   # 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.
   class SubCustomField
     # The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing.
+    # @return [String]
     attr_accessor :name
 
     # Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.  **Note**: Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable.
+    # @return [String]
     attr_accessor :editor
 
     # Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`.
+    # @return [Boolean]
     attr_accessor :required
 
     # The string that resolves (aka \"pre-fills\") to the merge field on the final document(s) used for signing.
+    # @return [String]
     attr_accessor :value
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,9 +20,11 @@ module Dropbox::Sign
   # This allows the requester to specify editor options when a preparing a document
   class SubEditorOptions
     # Allows requesters to edit the list of signers
+    # @return [Boolean]
     attr_accessor :allow_edit_signers
 
     # Allows requesters to edit documents, including delete and add
+    # @return [Boolean]
     attr_accessor :allow_edit_documents
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,6 +20,7 @@ module Dropbox::Sign
   # This allows the requester to specify field options for a signature request.
   class SubFieldOptions
     # Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))  **Note**: Only available for Premium and higher.
+    # @return [String]
     attr_accessor :date_format
 
     class EnumAttributeValidator

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

@@ -19,12 +19,15 @@ end
 module Dropbox::Sign
   class SubFormFieldGroup
     # ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`.
+    # @return [String]
     attr_accessor :group_id
 
     # Name of the group
+    # @return [String]
     attr_accessor :group_label
 
     # Examples: `require_0-1` `require_1` `require_1-ormore`  - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group.
+    # @return [String]
     attr_accessor :requirement
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,15 +19,19 @@ end
 module Dropbox::Sign
   class SubFormFieldRule
     # Must be unique across all defined rules.
+    # @return [String]
     attr_accessor :id
 
     # Currently only `AND` is supported. Support for `OR` is being worked on.
+    # @return [String]
     attr_accessor :trigger_operator
 
     # An array of trigger definitions, the \"if this\" part of \"**if this**, then that\". Currently only a single trigger per rule is allowed.
+    # @return [Array<SubFormFieldRuleTrigger>]
     attr_accessor :triggers
 
     # An array of action definitions, the \"then that\" part of \"if this, **then that**\". Any number of actions may be attached to a single rule.
+    # @return [Array<SubFormFieldRuleAction>]
     attr_accessor :actions
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,14 +19,18 @@ end
 module Dropbox::Sign
   class SubFormFieldRuleAction
     # `true` to hide the target field when rule is satisfied, otherwise `false`.
+    # @return [Boolean]
     attr_accessor :hidden
 
+    # @return [String]
     attr_accessor :type
 
     # **field_id** or **group_id** is required, but not both.  Must reference the `api_id` of an existing field defined within `form_fields_per_document`.  Cannot use with `group_id`. Trigger and action fields must belong to the same signer.
+    # @return [String]
     attr_accessor :field_id
 
     # **group_id** or **field_id** is required, but not both.  Must reference the ID of an existing group defined within `form_field_groups`.  Cannot use with `field_id`. Trigger and action fields and groups must belong to the same signer.
+    # @return [String]
     attr_accessor :group_id
 
     class EnumAttributeValidator

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

@@ -19,15 +19,19 @@ end
 module Dropbox::Sign
   class SubFormFieldRuleTrigger
     # Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer.
+    # @return [String]
     attr_accessor :id
 
     # Different field types allow different `operator` values: - Field type of **text**:   - **is**: exact match   - **not**: not exact match   - **match**: regular expression, without /. Example:     - OK `[a-zA-Z0-9]`     - Not OK `/[a-zA-Z0-9]/` - Field type of **dropdown**:   - **is**: exact match, single value   - **not**: not exact match, single value   - **any**: exact match, array of values.   - **none**: not exact match, array of values. - Field type of **checkbox**:   - **is**: exact match, single value   - **not**: not exact match, single value - Field type of **radio**:   - **is**: exact match, single value   - **not**: not exact match, single value
+    # @return [String]
     attr_accessor :operator
 
     # **value** or **values** is required, but not both.  The value to match against **operator**.  - When **operator** is one of the following, **value** must be `String`:   - `is`   - `not`   - `match`  Otherwise, - **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1` - **radio**: When **type** of trigger is **radio**, **value** must be `1`
+    # @return [String]
     attr_accessor :value
 
     # **values** or **value** is required, but not both.  The values to match against **operator** when it is one of the following:  - `any` - `none`
+    # @return [Array<String>]
     attr_accessor :values
 
     class EnumAttributeValidator

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

@@ -17,38 +17,49 @@ module Dropbox
 end
 
 module Dropbox::Sign
-  # 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`
+  # 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: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)  **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`
   class SubFormFieldsPerDocumentBase
     # Represents the integer index of the `file` or `file_url` document the field should be attached to.
+    # @return [Integer]
     attr_accessor :document_index
 
     # An identifier for the field that is unique across all documents in the request.
+    # @return [String]
     attr_accessor :api_id
 
     # Size of the field in pixels.
+    # @return [Integer]
     attr_accessor :height
 
     # Whether this field is required.
+    # @return [Boolean]
     attr_accessor :required
 
     # Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.  **NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.
+    # @return [Integer, String]
     attr_accessor :signer
 
+    # @return [String]
     attr_accessor :type
 
     # Size of the field in pixels.
+    # @return [Integer]
     attr_accessor :width
 
     # Location coordinates of the field in pixels.
+    # @return [Integer]
     attr_accessor :x
 
     # Location coordinates of the field in pixels.
+    # @return [Integer]
     attr_accessor :y
 
     # Display name for the field.
+    # @return [String]
     attr_accessor :name
 
     # Page in the document where the field should be placed (requires documents be PDF files).  - When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.
+    # @return [Integer, nil]
     attr_accessor :page
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,12 +20,15 @@ module Dropbox::Sign
   # This class extends `SubFormFieldsPerDocumentBase`.
   class SubFormFieldsPerDocumentCheckbox < SubFormFieldsPerDocumentBase
     # A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class.
+    # @return [String]
     attr_accessor :type
 
     # `true` for checking the checkbox field by default, otherwise `false`.
+    # @return [Boolean]
     attr_accessor :is_checked
 
     # String referencing group defined in `form_field_groups` parameter.
+    # @return [String]
     attr_accessor :group
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,6 +20,7 @@ module Dropbox::Sign
   # This class extends `SubFormFieldsPerDocumentBase`.
   class SubFormFieldsPerDocumentCheckboxMerge < SubFormFieldsPerDocumentBase
     # A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class.
+    # @return [String]
     attr_accessor :type
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,6 +20,7 @@ module Dropbox::Sign
   # This class extends `SubFormFieldsPerDocumentBase`.
   class SubFormFieldsPerDocumentDateSigned < SubFormFieldsPerDocumentBase
     # A date. Use the `SubFormFieldsPerDocumentDateSigned` class.
+    # @return [String]
     attr_accessor :type
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,12 +20,15 @@ module Dropbox::Sign
   # This class extends `SubFormFieldsPerDocumentBase`.
   class SubFormFieldsPerDocumentDropdown < SubFormFieldsPerDocumentBase
     # An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class.
+    # @return [String]
     attr_accessor :type
 
     # Array of string values representing dropdown values.
+    # @return [Array<String>]
     attr_accessor :options
 
     # Selected value in `options` array. Value must exist in array.
+    # @return [String]
     attr_accessor :content
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,12 +20,15 @@ module Dropbox::Sign
   # This class extends `SubFormFieldsPerDocumentBase`.
   class SubFormFieldsPerDocumentHyperlink < SubFormFieldsPerDocumentBase
     # A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class.
+    # @return [String]
     attr_accessor :type
 
     # Link Text.
+    # @return [String]
     attr_accessor :content
 
     # Link URL.
+    # @return [String]
     attr_accessor :content_url
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,6 +20,7 @@ module Dropbox::Sign
   # This class extends `SubFormFieldsPerDocumentBase`.
   class SubFormFieldsPerDocumentInitials < SubFormFieldsPerDocumentBase
     # An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class.
+    # @return [String]
     attr_accessor :type
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,12 +20,15 @@ module Dropbox::Sign
   # This class extends `SubFormFieldsPerDocumentBase`.
   class SubFormFieldsPerDocumentRadio < SubFormFieldsPerDocumentBase
     # An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class.
+    # @return [String]
     attr_accessor :type
 
     # String referencing group defined in `form_field_groups` parameter.
+    # @return [String]
     attr_accessor :group
 
     # `true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`.
+    # @return [Boolean]
     attr_accessor :is_checked
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,6 +20,7 @@ module Dropbox::Sign
   # This class extends `SubFormFieldsPerDocumentBase`.
   class SubFormFieldsPerDocumentSignature < SubFormFieldsPerDocumentBase
     # A signature input field. Use the `SubFormFieldsPerDocumentSignature` class.
+    # @return [String]
     attr_accessor :type
 
     # Attribute mapping from ruby-style variable name to JSON key.