dropbox-sign 1.0.0.pre.beta2301 → 1.0.0

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

@@ -19,21 +19,27 @@ end
 module Dropbox::Sign
   class TeamInviteResponse
     # Email address of the user invited to this team.
+    # @return [String]
     attr_accessor :email_address
 
     # Id of the team.
+    # @return [String]
     attr_accessor :team_id
 
     # Role of the user invited to this team.
+    # @return [String]
     attr_accessor :role
 
     # Timestamp when the invitation was sent.
+    # @return [Integer]
     attr_accessor :sent_at
 
     # Timestamp when the invitation was redeemed.
+    # @return [Integer]
     attr_accessor :redeemed_at
 
     # Timestamp when the invitation is expiring.
+    # @return [Integer]
     attr_accessor :expires_at
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,8 +19,10 @@ end
 module Dropbox::Sign
   class TeamInvitesResponse
     # Contains a list of team invites and their roles.
+    # @return [Array<TeamInviteResponse>]
     attr_accessor :team_invites
 
+    # @return [Array<WarningResponse>]
     attr_accessor :warnings
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,12 +19,15 @@ end
 module Dropbox::Sign
   class TeamMemberResponse
     # Account id of the team member.
+    # @return [String]
     attr_accessor :account_id
 
     # Email address of the team member.
+    # @return [String]
     attr_accessor :email_address
 
     # The specific role a member has on the team.
+    # @return [String]
     attr_accessor :role
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,10 +19,13 @@ end
 module Dropbox::Sign
   class TeamMembersResponse
     # Contains a list of team members and their roles for a specific team.
+    # @return [Array<TeamMemberResponse>]
     attr_accessor :team_members
 
+    # @return [ListInfoResponse]
     attr_accessor :list_info
 
+    # @return [Array<WarningResponse>]
     attr_accessor :warnings
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,9 +20,11 @@ module Dropbox::Sign
   # Information about the parent team if a team has one, set to `null` otherwise.
   class TeamParentResponse
     # The id of a team
+    # @return [String]
     attr_accessor :team_id
 
     # The name of a team
+    # @return [String]
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,18 +19,23 @@ end
 module Dropbox::Sign
   class TeamRemoveMemberRequest
     # **account_id** or **email_address** is required. If both are provided, the account id prevails.  Account id to remove from your Team.
+    # @return [String]
     attr_accessor :account_id
 
     # **account_id** or **email_address** is required. If both are provided, the account id prevails.  Email address of the Account to remove from your Team.
+    # @return [String]
     attr_accessor :email_address
 
     # The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account.  **Note**: Only available for Enterprise plans.
+    # @return [String]
     attr_accessor :new_owner_email_address
 
     # Id of the new Team.
+    # @return [String]
     attr_accessor :new_team_id
 
     # A new role member will take in a new Team.  **Note**: This parameter is used only if `new_team_id` is provided.
+    # @return [String]
     attr_accessor :new_role
 
     class EnumAttributeValidator

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

@@ -20,11 +20,14 @@ module Dropbox::Sign
   # Contains information about your team and its members
   class TeamResponse
     # The name of your Team
+    # @return [String]
     attr_accessor :name
 
+    # @return [Array<AccountResponse>]
     attr_accessor :accounts
 
     # A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`.
+    # @return [Array<AccountResponse>]
     attr_accessor :invited_accounts
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,10 +19,13 @@ end
 module Dropbox::Sign
   class TeamSubTeamsResponse
     # Contains a list with sub teams.
+    # @return [Array<SubTeamResponse>]
     attr_accessor :sub_teams
 
+    # @return [ListInfoResponse]
     attr_accessor :list_info
 
+    # @return [Array<WarningResponse>]
     attr_accessor :warnings
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

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

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

@@ -19,12 +19,15 @@ end
 module Dropbox::Sign
   class TemplateAddUserRequest
     # The id of the Account to give access to the Template. <b>Note</b> The account id prevails if email address is also provided.
+    # @return [String]
     attr_accessor :account_id
 
     # The email address of the Account to give access to the Template. <b>Note</b> The account id prevails if it is also provided.
+    # @return [String]
     attr_accessor :email_address
 
     # If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`.
+    # @return [Boolean]
     attr_accessor :skip_notification
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,76 +19,101 @@ end
 module Dropbox::Sign
   class TemplateCreateEmbeddedDraftRequest
     # Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app.
+    # @return [String]
     attr_accessor :client_id
 
     # 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 creating a template.
+    # @return [Boolean]
     attr_accessor :allow_ccs
 
     # 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 CC roles that must be assigned when using the template to send a signature request
+    # @return [Array<String>]
     attr_accessor :cc_roles
 
+    # @return [SubEditorOptions]
     attr_accessor :editor_options
 
+    # @return [SubFieldOptions]
     attr_accessor :field_options
 
     # 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
 
     # 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
 
     # Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document.
+    # @return [Array<SubMergeField>]
     attr_accessor :merge_fields
 
     # The default template email message.
+    # @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 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
 
     # An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
+    # @return [Array<SubTemplateRole>]
     attr_accessor :signer_roles
 
     # 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 template title (alias).
+    # @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
 
     # Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).
+    # @return [Boolean]
     attr_accessor :use_preexisting_fields
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -18,9 +18,11 @@ end
 
 module Dropbox::Sign
   class TemplateCreateEmbeddedDraftResponse
+    # @return [TemplateCreateEmbeddedDraftResponseTemplate]
     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_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.