dropbox-sign 1.6.1 → 1.8.0

data/docs/TemplateResponse.md

@@ -10,15 +10,16 @@ Contains information about the templates you and your team have created.
 | `title` | ```String``` |  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.  |  |
 | `message` | ```String``` |  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.  |  |
 | `updated_at` | ```Integer``` |  Time the template was last updated.  |  |
-| `is_embedded` | ```Boolean``` |  `true` if this template was created using an embedded flow, `false` if it was created on our website.  |  |
+| `is_embedded` | ```Boolean``` |  `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.  |  |
 | `is_creator` | ```Boolean``` |  `true` if you are the owner of this template, `false` if it's been shared with you by a team member.  |  |
 | `can_edit` | ```Boolean``` |  Indicates whether edit rights have been granted to you by the owner (always `true` if that's you).  |  |
 | `is_locked` | ```Boolean``` |  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.  |  |
-| `metadata` | ```Object``` |  The metadata attached to the template.  |  |
+| `metadata` | ```Hash<String, Object>``` |  The metadata attached to the template.  |  |
 | `signer_roles` | [```Array<TemplateResponseSignerRole>```](TemplateResponseSignerRole.md) |  An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.  |  |
 | `cc_roles` | [```Array<TemplateResponseCCRole>```](TemplateResponseCCRole.md) |  An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.  |  |
 | `documents` | [```Array<TemplateResponseDocument>```](TemplateResponseDocument.md) |  An array describing each document associated with this Template. Includes form field data for each document.  |  |
 | `custom_fields` | [```Array<TemplateResponseDocumentCustomFieldBase>```](TemplateResponseDocumentCustomFieldBase.md) |  Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c&#x3D;200&amp;path&#x3D;template/documents&amp;t&#x3D;response) array instead.  |  |
 | `named_form_fields` | [```Array<TemplateResponseDocumentFormFieldBase>```](TemplateResponseDocumentFormFieldBase.md) |  Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c&#x3D;200&amp;path&#x3D;template/documents&amp;t&#x3D;response) array instead.  |  |
 | `accounts` | [```Array<TemplateResponseAccount>```](TemplateResponseAccount.md) |  An array of the Accounts that can use this Template.  |  |
+| `attachments` | [```Array<SignatureRequestResponseAttachment>```](SignatureRequestResponseAttachment.md) |  Signer attachments.  |  |
 

data/docs/TemplateResponseDocumentFormFieldBase.md

@@ -15,5 +15,4 @@ An array of Form Field objects containing the name and type of each named field.
 | `width` | ```Integer``` |  The width in pixels of this form field.  |  |
 | `height` | ```Integer``` |  The height in pixels of this form field.  |  |
 | `required` | ```Boolean``` |  Boolean showing whether or not this field is required.  |  |
-| `group` | ```String``` |  The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.  |  |
 

data/docs/TemplateResponseDocumentFormFieldCheckbox.md

@@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase`
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | `type`<sup>*_required_</sup> | ```String``` |  The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials`  |  [default to 'checkbox'] |
+| `group` | ```String``` |  The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.  |  |
 

data/docs/TemplateResponseDocumentFormFieldDateSigned.md

@@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase`
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | `type`<sup>*_required_</sup> | ```String``` |  The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials`  |  [default to 'date_signed'] |
+| `group` | ```String``` |  The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.  |  |
 

data/docs/TemplateResponseDocumentFormFieldDropdown.md

@@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase`
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | `type`<sup>*_required_</sup> | ```String``` |  The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials`  |  [default to 'dropdown'] |
+| `group` | ```String``` |  The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.  |  |
 

data/docs/TemplateResponseDocumentFormFieldHyperlink.md

@@ -11,4 +11,5 @@ This class extends `TemplateResponseDocumentFormFieldBase`
 | `is_multiline` | ```Boolean``` |  Whether this form field is multiline text.  |  |
 | `original_font_size` | ```Integer``` |  Original font size used in this form field's text.  |  |
 | `font_family` | ```String``` |  Font family used in this form field's text.  |  |
+| `group` | ```String``` |  The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.  |  |
 

data/docs/TemplateResponseDocumentFormFieldInitials.md

@@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase`
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | `type`<sup>*_required_</sup> | ```String``` |  The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials`  |  [default to 'initials'] |
+| `group` | ```String``` |  The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.  |  |
 

data/docs/TemplateResponseDocumentFormFieldRadio.md

@@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase`
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | `type`<sup>*_required_</sup> | ```String``` |  The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials`  |  [default to 'radio'] |
+| `group`<sup>*_required_</sup> | ```String``` |  The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.  |  |
 

data/docs/TemplateResponseDocumentFormFieldSignature.md

@@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase`
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | `type`<sup>*_required_</sup> | ```String``` |  The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials`  |  [default to 'signature'] |
+| `group` | ```String``` |  The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.  |  |
 

data/docs/TemplateResponseDocumentFormFieldText.md

@@ -12,4 +12,5 @@ This class extends `TemplateResponseDocumentFormFieldBase`
 | `original_font_size` | ```Integer``` |  Original font size used in this form field's text.  |  |
 | `font_family` | ```String``` |  Font family used in this form field's text.  |  |
 | `validation_type` | ```String``` |  Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.  |  |
+| `group` | ```String``` |  The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.  |  |
 

data/examples/FaxDelete.rb

@@ -0,0 +1,14 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+end
+
+fax_api = Dropbox::Sign::FaxApi.new
+
+begin
+  fax_api.fax_delete("fa5c8a0b0f492d768749333ad6fcc214c111e967")
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/FaxFiles.rb

@@ -0,0 +1,17 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+end
+
+fax_api = Dropbox::Sign::FaxApi.new
+
+faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"
+
+begin
+  file_bin = fax_api.fax_files(data)
+  FileUtils.cp(file_bin.path, "path/to/file.pdf")
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/FaxGet.rb

@@ -0,0 +1,17 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+end
+
+fax_api = Dropbox::Sign::FaxApi.new
+
+fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967"
+
+begin
+  result = fax_api.fax_get(fax_id)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/FaxList.rb

@@ -0,0 +1,18 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+end
+
+fax_api = Dropbox::Sign::FaxApi.new
+
+page = 1
+page_size = 2
+
+begin
+  result = fax_api.fax_list({ page: page, page_size: page_size })
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/examples/FaxSend.rb

@@ -0,0 +1,25 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+end
+
+fax_api = Dropbox::Sign::FaxApi.new
+
+data = Dropbox::Sign::FaxSendRequest.new
+data.files = [File.new("example_signature_request.pdf", "r")]
+data.test_mode = true
+data.recipient = "16690000001"
+data.sender = "16690000000"
+data.cover_page_to = "Jill Fax"
+data.cover_page_message = "I'm sending you a fax!"
+data.cover_page_from = "Faxer Faxerson"
+data.title = "This is what the fax is about!"
+
+begin
+  result = fax_api.fax_send(data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end