dropbox-sign 1.0.0.pre.beta2301 → 1.0.1

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

@@ -19,32 +19,46 @@ end
 module Dropbox::Sign
   # An object with options to customize the app's signer page
   class ApiAppResponseWhiteLabelingOptions
+    # @return [String]
     attr_accessor :header_background_color
 
+    # @return [String]
     attr_accessor :legal_version
 
+    # @return [String]
     attr_accessor :link_color
 
+    # @return [String]
     attr_accessor :page_background_color
 
+    # @return [String]
     attr_accessor :primary_button_color
 
+    # @return [String]
     attr_accessor :primary_button_color_hover
 
+    # @return [String]
     attr_accessor :primary_button_text_color
 
+    # @return [String]
     attr_accessor :primary_button_text_color_hover
 
+    # @return [String]
     attr_accessor :secondary_button_color
 
+    # @return [String]
     attr_accessor :secondary_button_color_hover
 
+    # @return [String]
     attr_accessor :secondary_button_text_color
 
+    # @return [String]
     attr_accessor :secondary_button_text_color_hover
 
+    # @return [String]
     attr_accessor :text_color1
 
+    # @return [String]
     attr_accessor :text_color2
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,21 +19,28 @@ end
 module Dropbox::Sign
   class ApiAppUpdateRequest
     # The URL at which the API App should receive event callbacks.
+    # @return [String]
     attr_accessor :callback_url
 
     # An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)
+    # @return [File]
     attr_accessor :custom_logo_file
 
     # The domain names the ApiApp will be associated with.
+    # @return [Array<String>]
     attr_accessor :domains
 
     # The name you want to assign to the ApiApp.
+    # @return [String]
     attr_accessor :name
 
+    # @return [SubOAuth]
     attr_accessor :oauth
 
+    # @return [SubOptions]
     attr_accessor :options
 
+    # @return [SubWhiteLabelingOptions]
     attr_accessor :white_labeling_options
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -18,14 +18,18 @@ end
 
 module Dropbox::Sign
   class BulkSendJobGetResponse
+    # @return [BulkSendJobResponse]
     attr_accessor :bulk_send_job
 
+    # @return [ListInfoResponse]
     attr_accessor :list_info
 
     # Contains information about the Signature Requests sent in bulk.
+    # @return [Array<BulkSendJobGetResponseSignatureRequests>]
     attr_accessor :signature_requests
 
     # 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/bulk_send_job_get_response_signature_requests.rb

@@ -19,75 +19,99 @@ end
 module Dropbox::Sign
   class BulkSendJobGetResponseSignatureRequests
     # Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.
+    # @return [Boolean, nil]
     attr_accessor :test_mode
 
     # The id of the SignatureRequest.
+    # @return [String]
     attr_accessor :signature_request_id
 
     # The email address of the initiator of the SignatureRequest.
+    # @return [String]
     attr_accessor :requester_email_address
 
     # The title the specified Account uses for the SignatureRequest.
+    # @return [String]
     attr_accessor :title
 
     # Default Label for account.
+    # @return [String]
     attr_accessor :original_title
 
     # The subject in the email that was initially sent to the signers.
+    # @return [String, nil]
     attr_accessor :subject
 
     # The custom message in the email that was initially sent to the signers.
+    # @return [String, nil]
     attr_accessor :message
 
     # The metadata attached to the signature request.
+    # @return [Object]
     attr_accessor :metadata
 
     # Time the signature request was created.
+    # @return [Integer]
     attr_accessor :created_at
 
     # The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
+    # @return [Integer]
     attr_accessor :expires_at
 
     # Whether or not the SignatureRequest has been fully executed by all signers.
+    # @return [Boolean]
     attr_accessor :is_complete
 
     # Whether or not the SignatureRequest has been declined by a signer.
+    # @return [Boolean]
     attr_accessor :is_declined
 
     # Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).
+    # @return [Boolean]
     attr_accessor :has_error
 
     # The URL where a copy of the request's documents can be downloaded.
+    # @return [String]
     attr_accessor :files_url
 
     # The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing.
+    # @return [String, nil]
     attr_accessor :signing_url
 
     # The URL where the requester and the signers can view the current status of the SignatureRequest.
+    # @return [String]
     attr_accessor :details_url
 
     # A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.
+    # @return [Array<String>]
     attr_accessor :cc_email_addresses
 
     # The URL you want the signer redirected to after they successfully sign.
+    # @return [String, nil]
     attr_accessor :signing_redirect_url
 
     # Templates IDs used in this SignatureRequest (if any).
+    # @return [Array<String>, nil]
     attr_accessor :template_ids
 
     # An array of Custom Field objects containing the name and type of each custom field.  * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`
+    # @return [Array<SignatureRequestResponseCustomFieldBase>, nil]
     attr_accessor :custom_fields
 
     # Signer attachments.
+    # @return [Array<SignatureRequestResponseAttachment>, nil]
     attr_accessor :attachments
 
     # An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.
+    # @return [Array<SignatureRequestResponseDataBase>, nil]
     attr_accessor :response_data
 
     # An array of signature objects, 1 for each signer.
+    # @return [Array<SignatureRequestResponseSignatures>]
     attr_accessor :signatures
 
     # The id of the BulkSendJob.
+    # @return [String]
     attr_accessor :bulk_send_job_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,11 +19,14 @@ end
 module Dropbox::Sign
   class BulkSendJobListResponse
     # Contains a list of BulkSendJobs that the API caller has access to.
+    # @return [Array<BulkSendJobResponse>]
     attr_accessor :bulk_send_jobs
 
+    # @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/bulk_send_job_response.rb

@@ -20,15 +20,19 @@ module Dropbox::Sign
   # Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.
   class BulkSendJobResponse
     # The id of the BulkSendJob.
+    # @return [String, nil]
     attr_accessor :bulk_send_job_id
 
     # The total amount of Signature Requests queued for sending.
+    # @return [Integer]
     attr_accessor :total
 
     # True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member.
+    # @return [Boolean]
     attr_accessor :is_creator
 
     # Time that the BulkSendJob was created.
+    # @return [Integer]
     attr_accessor :created_at
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -18,9 +18,11 @@ end
 
 module Dropbox::Sign
   class BulkSendJobSendResponse
+    # @return [BulkSendJobResponse]
     attr_accessor :bulk_send_job
 
     # 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/embedded_edit_url_request.rb

@@ -19,32 +19,42 @@ end
 module Dropbox::Sign
   class EmbeddedEditUrlRequest
     # This allows the requester to enable/disable to add or change CC roles when editing the template.
+    # @return [Boolean]
     attr_accessor :allow_edit_ccs
 
     # The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.
+    # @return [Array<String>]
     attr_accessor :cc_roles
 
+    # @return [SubEditorOptions]
     attr_accessor :editor_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
 
     # Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template.  Remove all merge fields on the template by passing an empty array `[]`.
+    # @return [Array<SubMergeField>]
     attr_accessor :merge_fields
 
     # This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).  **Note**: This parameter overwrites `show_preview=true` (if set).
+    # @return [Boolean]
     attr_accessor :preview_only
 
     # This allows the requester to enable 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
 
     # Whether this is a test, locked templates will only be available for editing if this is 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/embedded_edit_url_response.rb

@@ -18,9 +18,11 @@ end
 
 module Dropbox::Sign
   class EmbeddedEditUrlResponse
+    # @return [EmbeddedEditUrlResponseEmbedded]
     attr_accessor :embedded
 
     # 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/embedded_edit_url_response_embedded.rb

@@ -20,9 +20,11 @@ module Dropbox::Sign
   # An embedded template object.
   class EmbeddedEditUrlResponseEmbedded
     # A template url that can be opened in an iFrame.
+    # @return [String]
     attr_accessor :edit_url
 
     # The specific time that the the `edit_url` link expires, in epoch.
+    # @return [Integer]
     attr_accessor :expires_at
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -18,9 +18,11 @@ end
 
 module Dropbox::Sign
   class EmbeddedSignUrlResponse
+    # @return [EmbeddedSignUrlResponseEmbedded]
     attr_accessor :embedded
 
     # 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/embedded_sign_url_response_embedded.rb

@@ -20,9 +20,11 @@ module Dropbox::Sign
   # An object that contains necessary information to set up embedded signing.
   class EmbeddedSignUrlResponseEmbedded
     # A signature url that can be opened in an iFrame.
+    # @return [String]
     attr_accessor :sign_url
 
     # The specific time that the the `sign_url` link expires, in epoch.
+    # @return [Integer]
     attr_accessor :expires_at
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

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

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

@@ -20,12 +20,15 @@ module Dropbox::Sign
   # Contains information about an error that occurred.
   class ErrorResponseError
     # Message describing an error.
+    # @return [String]
     attr_accessor :error_msg
 
     # Name of the error.
+    # @return [String]
     attr_accessor :error_name
 
     # Path at which an error occurred.
+    # @return [String]
     attr_accessor :error_path
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -18,12 +18,16 @@ end
 
 module Dropbox::Sign
   class EventCallbackRequest
+    # @return [EventCallbackRequestEvent]
     attr_accessor :event
 
+    # @return [AccountResponse]
     attr_accessor :account
 
+    # @return [SignatureRequestResponse]
     attr_accessor :signature_request
 
+    # @return [TemplateResponse]
     attr_accessor :template
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,14 +20,18 @@ module Dropbox::Sign
   # Basic information about the event that occurred.
   class EventCallbackRequestEvent
     # Time the event was created (using Unix time).
+    # @return [String]
     attr_accessor :event_time
 
     # Type of callback event that was triggered.
+    # @return [String]
     attr_accessor :event_type
 
     # Generated hash used to verify source of event data.
+    # @return [String]
     attr_accessor :event_hash
 
+    # @return [EventCallbackRequestEventMetadata]
     attr_accessor :event_metadata
 
     class EnumAttributeValidator

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

@@ -20,15 +20,19 @@ module Dropbox::Sign
   # Specific metadata about the event.
   class EventCallbackRequestEventMetadata
     # Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events.
+    # @return [String, nil]
     attr_accessor :related_signature_id
 
     # Account ID the event was reported for.
+    # @return [String, nil]
     attr_accessor :reported_for_account_id
 
     # App ID the event was reported for.
+    # @return [String, nil]
     attr_accessor :reported_for_app_id
 
     # Message about a declined or failed (due to error) signature flow.
+    # @return [String, nil]
     attr_accessor :event_message
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,9 +19,11 @@ end
 module Dropbox::Sign
   class FileResponse
     # URL to the file.
+    # @return [String]
     attr_accessor :file_url
 
     # When the link expires.
+    # @return [Integer]
     attr_accessor :expires_at
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,6 +19,7 @@ end
 module Dropbox::Sign
   class FileResponseDataUri
     # File as base64 encoded string.
+    # @return [String]
     attr_accessor :data_uri
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,15 +20,19 @@ module Dropbox::Sign
   # Contains pagination information about the data returned.
   class ListInfoResponse
     # Total number of pages available.
+    # @return [Integer]
     attr_accessor :num_pages
 
     # Total number of objects available.
+    # @return [Integer, nil]
     attr_accessor :num_results
 
     # Number of the page being returned.
+    # @return [Integer]
     attr_accessor :page
 
     # Objects returned per page.
+    # @return [Integer]
     attr_accessor :page_size
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,18 +19,23 @@ end
 module Dropbox::Sign
   class OAuthTokenGenerateRequest
     # The client id of the app requesting authorization.
+    # @return [String]
     attr_accessor :client_id
 
     # The secret token of your app.
+    # @return [String]
     attr_accessor :client_secret
 
     # The code passed to your callback when the user granted access.
+    # @return [String]
     attr_accessor :code
 
     # When generating a new token use `authorization_code`.
+    # @return [String]
     attr_accessor :grant_type
 
     # Same as the state you specified earlier.
+    # @return [String]
     attr_accessor :state
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,9 +19,11 @@ end
 module Dropbox::Sign
   class OAuthTokenRefreshRequest
     # When refreshing an existing token use `refresh_token`.
+    # @return [String]
     attr_accessor :grant_type
 
     # The token provided when you got the expired access token.
+    # @return [String]
     attr_accessor :refresh_token
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -18,15 +18,20 @@ end
 
 module Dropbox::Sign
   class OAuthTokenResponse
+    # @return [String]
     attr_accessor :access_token
 
+    # @return [String]
     attr_accessor :token_type
 
+    # @return [String]
     attr_accessor :refresh_token
 
     # Number of seconds until the `access_token` expires. Uses epoch time.
+    # @return [Integer]
     attr_accessor :expires_in
 
+    # @return [String, nil]
     attr_accessor :state
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,12 +19,15 @@ end
 module Dropbox::Sign
   class ReportCreateRequest
     # The (inclusive) end date for the report data in `MM/DD/YYYY` format.
+    # @return [String]
     attr_accessor :end_date
 
     # The type(s) of the report you are requesting. Allowed values are `user_activity` and `document_status`. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status).
+    # @return [Array<String>]
     attr_accessor :report_type
 
     # The (inclusive) start date for the report data in `MM/DD/YYYY` format.
+    # @return [String]
     attr_accessor :start_date
 
     class EnumAttributeValidator

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

@@ -18,9 +18,11 @@ end
 
 module Dropbox::Sign
   class ReportCreateResponse
+    # @return [ReportResponse]
     attr_accessor :report
 
     # 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/report_response.rb

@@ -20,15 +20,19 @@ module Dropbox::Sign
   # Contains information about the report request.
   class ReportResponse
     # A message indicating the requested operation's success
+    # @return [String]
     attr_accessor :success
 
     # The (inclusive) start date for the report data in MM/DD/YYYY format.
+    # @return [String]
     attr_accessor :start_date
 
     # The (inclusive) end date for the report data in MM/DD/YYYY format.
+    # @return [String]
     attr_accessor :end_date
 
     # The type(s) of the report you are requesting. Allowed values are \"user_activity\" and \"document_status\". User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status).
+    # @return [Array<String>]
     attr_accessor :report_type
 
     class EnumAttributeValidator

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

@@ -19,42 +19,55 @@ end
 module Dropbox::Sign
   class SignatureRequestBulkCreateEmbeddedWithTemplateRequest
     # 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
 
     # Client id of the app you're using to create this embedded signature request. Used for security purposes.
+    # @return [String]
     attr_accessor :client_id
 
     # `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:  - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)      **Note**: Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional)      You may only specify field values here, any other options should be set in the custom_fields request parameter.  Example CSV:  ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ```
+    # @return [File]
     attr_accessor :signer_file
 
     # `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.
+    # @return [Array<SubBulkSignerList>]
     attr_accessor :signer_list
 
     # 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
 
     # 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
 
     # 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 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.