dropbox-sign 1.0.0.pre.beta2301 → 1.0.1

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

@@ -20,15 +20,19 @@ module Dropbox::Sign
   # Template object with parameters: `template_id`, `edit_url`, `expires_at`.
   class TemplateCreateEmbeddedDraftResponseTemplate
     # The id of the Template.
+    # @return [String]
     attr_accessor :template_id
 
     # Link to edit the template.
+    # @return [String]
     attr_accessor :edit_url
 
     # When the link expires.
+    # @return [Integer]
     attr_accessor :expires_at
 
     # 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/template_edit_response.rb

@@ -19,6 +19,7 @@ end
 module Dropbox::Sign
   class TemplateEditResponse
     # The id of the Template.
+    # @return [String]
     attr_accessor :template_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -18,9 +18,11 @@ end
 
 module Dropbox::Sign
   class TemplateGetResponse
+    # @return [TemplateResponse]
     attr_accessor :template
 
     # 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/template_list_response.rb

@@ -19,11 +19,14 @@ end
 module Dropbox::Sign
   class TemplateListResponse
     # List of templates that the API caller has access to.
+    # @return [Array<TemplateResponse>]
     attr_accessor :templates
 
+    # @return [ListInfoResponse]
     attr_accessor :list_info
 
     # 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/template_remove_user_request.rb

@@ -19,9 +19,11 @@ end
 module Dropbox::Sign
   class TemplateRemoveUserRequest
     # The id or email address of the Account to remove access to the Template. The account id prevails if both are provided.
+    # @return [String]
     attr_accessor :account_id
 
     # The id or email address of the Account to remove access to the Template. The account id prevails if both are provided.
+    # @return [String]
     attr_accessor :email_address
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,48 +20,63 @@ module Dropbox::Sign
   # Contains information about the templates you and your team have created.
   class TemplateResponse
     # The id of the Template.
+    # @return [String]
     attr_accessor :template_id
 
     # 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.
+    # @return [String]
     attr_accessor :title
 
     # 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.
+    # @return [String]
     attr_accessor :message
 
     # Time the template was last updated.
+    # @return [Integer]
     attr_accessor :updated_at
 
     # `true` if this template was created using an embedded flow, `false` if it was created on our website.
+    # @return [Boolean, nil]
     attr_accessor :is_embedded
 
     # `true` if you are the owner of this template, `false` if it's been shared with you by a team member.
+    # @return [Boolean, nil]
     attr_accessor :is_creator
 
     # Indicates whether edit rights have been granted to you by the owner (always `true` if that's you).
+    # @return [Boolean, nil]
     attr_accessor :can_edit
 
     # 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.
+    # @return [Boolean, nil]
     attr_accessor :is_locked
 
     # The metadata attached to the template.
+    # @return [Object]
     attr_accessor :metadata
 
     # An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
+    # @return [Array<TemplateResponseSignerRole>]
     attr_accessor :signer_roles
 
     # An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.
+    # @return [Array<TemplateResponseCCRole>]
     attr_accessor :cc_roles
 
     # An array describing each document associated with this Template. Includes form field data for each document.
+    # @return [Array<TemplateResponseDocument>]
     attr_accessor :documents
 
     # An array of Custom Field objects.
+    # @return [Array<TemplateResponseCustomField>, nil]
     attr_accessor :custom_fields
 
     # Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.
+    # @return [Array<TemplateResponseNamedFormField>, nil]
     attr_accessor :named_form_fields
 
     # An array of the Accounts that can use this Template.
+    # @return [Array<TemplateResponseAccount>, nil]
     attr_accessor :accounts
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,20 +19,26 @@ end
 module Dropbox::Sign
   class TemplateResponseAccount
     # The id of the Account.
+    # @return [String]
     attr_accessor :account_id
 
     # The email address associated with the Account.
+    # @return [String]
     attr_accessor :email_address
 
     # Returns `true` if the user has been locked out of their account by a team admin.
+    # @return [Boolean]
     attr_accessor :is_locked
 
     # Returns `true` if the user has a paid Dropbox Sign account.
+    # @return [Boolean]
     attr_accessor :is_paid_hs
 
     # Returns `true` if the user has a paid HelloFax account.
+    # @return [Boolean]
     attr_accessor :is_paid_hf
 
+    # @return [TemplateResponseAccountQuota]
     attr_accessor :quotas
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,15 +20,19 @@ module Dropbox::Sign
   # An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.
   class TemplateResponseAccountQuota
     # API templates remaining.
+    # @return [Integer]
     attr_accessor :templates_left
 
     # API signature requests remaining.
+    # @return [Integer]
     attr_accessor :api_signature_requests_left
 
     # Signature requests remaining.
+    # @return [Integer]
     attr_accessor :documents_left
 
     # SMS verifications remaining.
+    # @return [Integer]
     attr_accessor :sms_verifications_left
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,6 +19,7 @@ end
 module Dropbox::Sign
   class TemplateResponseCCRole
     # The name of the Role.
+    # @return [String]
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,41 +19,54 @@ end
 module Dropbox::Sign
   class TemplateResponseCustomField
     # The name of the Custom Field.
+    # @return [String]
     attr_accessor :name
 
     # The type of this Custom Field. Only `text` and `checkbox` are currently supported.
+    # @return [String]
     attr_accessor :type
 
     # 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
 
     class EnumAttributeValidator

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

@@ -19,21 +19,27 @@ end
 module Dropbox::Sign
   class TemplateResponseDocument
     # Name of the associated file.
+    # @return [String]
     attr_accessor :name
 
     # Document ordering, the lowest index is displayed first and the highest last (0-based indexing).
+    # @return [Integer]
     attr_accessor :index
 
     # An array of Form Field Group objects.
+    # @return [Array<TemplateResponseDocumentFieldGroup>]
     attr_accessor :field_groups
 
     # An array of Form Field objects containing the name and type of each named textbox and checkmark field.
+    # @return [Array<TemplateResponseDocumentFormField>]
     attr_accessor :form_fields
 
     # An array of Document Custom Field objects.
+    # @return [Array<TemplateResponseDocumentCustomField>]
     attr_accessor :custom_fields
 
     # An array describing static overlay fields. <b>Note</b> only available for certain subscriptions.
+    # @return [Array<TemplateResponseDocumentStaticField>, nil]
     attr_accessor :static_fields
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,49 +19,65 @@ end
 module Dropbox::Sign
   class TemplateResponseDocumentCustomField
     # The name of the Custom Field.
+    # @return [String]
     attr_accessor :name
 
     # The type of this Custom Field. Only `text` and `checkbox` are currently supported.
+    # @return [String]
     attr_accessor :type
 
     # The signer of the Custom 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
 
     # Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.
+    # @return [Object, nil]
     attr_accessor :named_form_fields
 
+    # @return [String, nil]
     attr_accessor :reusable_form_id
 
     class EnumAttributeValidator

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

@@ -19,9 +19,11 @@ end
 module Dropbox::Sign
   class TemplateResponseDocumentFieldGroup
     # The name of the form field group.
+    # @return [String]
     attr_accessor :name
 
     # The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).
+    # @return [String]
     attr_accessor :rule
 
     # Attribute mapping from ruby-style variable name to JSON key.

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.