dropbox-sign 1.2.0 → 1.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (63) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +12 -4
  4. data/VERSION +1 -1
  5. data/docs/BulkSendJobGetResponseSignatureRequests.md +1 -0
  6. data/docs/EventCallbackRequestEvent.md +1 -1
  7. data/docs/SignatureRequestApi.md +419 -3
  8. data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +1 -1
  9. data/docs/SignatureRequestBulkSendWithTemplateRequest.md +1 -1
  10. data/docs/SignatureRequestEditEmbeddedRequest.md +33 -0
  11. data/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md +24 -0
  12. data/docs/SignatureRequestEditRequest.md +35 -0
  13. data/docs/SignatureRequestEditWithTemplateRequest.md +26 -0
  14. data/docs/SignatureRequestResponse.md +2 -0
  15. data/docs/SubFormFieldsPerDocumentDateSigned.md +1 -1
  16. data/docs/SubFormFieldsPerDocumentDropdown.md +1 -1
  17. data/docs/SubFormFieldsPerDocumentHyperlink.md +1 -1
  18. data/docs/SubFormFieldsPerDocumentText.md +1 -1
  19. data/docs/SubFormFieldsPerDocumentTextMerge.md +1 -1
  20. data/docs/SubSignatureRequestSigner.md +1 -1
  21. data/docs/SubSignatureRequestTemplateSigner.md +1 -1
  22. data/docs/TemplateApi.md +4 -3
  23. data/docs/TemplateCreateResponse.md +1 -1
  24. data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +1 -0
  25. data/examples/SignatureRequestEdit.rb +58 -0
  26. data/examples/SignatureRequestEditEmbedded.rb +48 -0
  27. data/examples/SignatureRequestEditEmbeddedWithTemplate.rb +41 -0
  28. data/examples/SignatureRequestEditWithTemplate.rb +52 -0
  29. data/lib/dropbox-sign/api/api_app_api.rb +1 -1
  30. data/lib/dropbox-sign/api/signature_request_api.rb +463 -0
  31. data/lib/dropbox-sign/api/team_api.rb +1 -1
  32. data/lib/dropbox-sign/api/template_api.rb +3 -0
  33. data/lib/dropbox-sign/event_callback_helper.rb +1 -1
  34. data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +13 -1
  35. data/lib/dropbox-sign/models/event_callback_request_event.rb +2 -7
  36. data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +1 -1
  37. data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +1 -1
  38. data/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb +593 -0
  39. data/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb +490 -0
  40. data/lib/dropbox-sign/models/signature_request_edit_request.rb +612 -0
  41. data/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb +509 -0
  42. data/lib/dropbox-sign/models/signature_request_response.rb +28 -4
  43. data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +2 -0
  44. data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +2 -0
  45. data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +2 -0
  46. data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +2 -0
  47. data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +2 -0
  48. data/lib/dropbox-sign/models/sub_signature_request_signer.rb +1 -1
  49. data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +1 -1
  50. data/lib/dropbox-sign/models/template_create_response.rb +2 -2
  51. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +17 -4
  52. data/lib/dropbox-sign/version.rb +1 -1
  53. data/lib/dropbox-sign.rb +4 -0
  54. data/openapi-config.yaml +1 -1
  55. data/openapi-sdk.yaml +2380 -1305
  56. data/spec/event_callback_helper_spec.rb +17 -3
  57. data/templates/event_callback_helper.mustache +1 -1
  58. data/test_fixtures/EventCallbackHelper_AccountCallbacks.json +82 -0
  59. data/test_fixtures/{EventCallbackHelper.json → EventCallbackHelper_AppCallbacks.json} +8 -4
  60. data/test_fixtures/SignatureRequestSendRequest.json +12 -6
  61. data/test_fixtures/SubFormFieldsPerDocument.json +8 -4
  62. data/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +2 -1
  63. metadata +21 -8
@@ -0,0 +1,24 @@
1
+ # Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ | Name | Type | Description | Notes |
8
+ | ---- | ---- | ----------- | ----- |
9
+ | `template_ids`<sup>*_required_</sup> | ```Array<String>``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | |
10
+ | `client_id`<sup>*_required_</sup> | ```String``` | Client id of the app you&#39;re using to create this embedded signature request. Used for security purposes. | |
11
+ | `signers`<sup>*_required_</sup> | [```Array<SubSignatureRequestTemplateSigner>```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | |
12
+ | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
13
+ | `ccs` | [```Array<SubCC>```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | |
14
+ | `custom_fields` | [```Array<SubCustomField>```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | |
15
+ | `files` | ```Array<File>``` | Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
16
+ | `file_urls` | ```Array<String>``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
17
+ | `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
18
+ | `metadata` | ```Hash<String, Object>``` | 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&#39;s order number for look up when receiving events for the signature request.<br><br>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. | |
19
+ | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
20
+ | `subject` | ```String``` | The subject in the email that will be sent to the signers. | |
21
+ | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
22
+ | `title` | ```String``` | The title you want to assign to the SignatureRequest. | |
23
+ | `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer&#39;s information during signing.<br><br>⚠️ **Note** ⚠️: Keep your signer&#39;s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] |
24
+
@@ -0,0 +1,35 @@
1
+ # Dropbox::Sign::SignatureRequestEditRequest
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ | Name | Type | Description | Notes |
8
+ | ---- | ---- | ----------- | ----- |
9
+ | `files` | ```Array<File>``` | Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
10
+ | `file_urls` | ```Array<String>``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
11
+ | `signers` | [```Array<SubSignatureRequestSigner>```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.<br><br>This endpoint requires either **signers** or **grouped_signers**, but not both. | |
12
+ | `grouped_signers` | [```Array<SubSignatureRequestGroupedSigners>```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.<br><br>This endpoint requires either **signers** or **grouped_signers**, but not both. | |
13
+ | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
14
+ | `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.<br><br>**Note**: Only available for Premium plan and higher. | [default to false] |
15
+ | `attachments` | [```Array<SubAttachment>```](SubAttachment.md) | A list describing the attachments | |
16
+ | `cc_email_addresses` | ```Array<String>``` | The email addresses that should be CCed. | |
17
+ | `client_id` | ```String``` | 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. | |
18
+ | `custom_fields` | [```Array<SubCustomField>```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.<br><br>Pre-filled data can be used with &quot;send-once&quot; 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.<br><br>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. | |
19
+ | `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | |
20
+ | `form_field_groups` | [```Array<SubFormFieldGroup>```](SubFormFieldGroup.md) | 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`. | |
21
+ | `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
22
+ | `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**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.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
23
+ | `hide_text_tags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.<br><br>**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. | [default to false] |
24
+ | `is_qualified_signature` | ```Boolean``` | 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&#39;s identity.&lt;br&gt;<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. | [default to false] |
25
+ | `is_eid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
26
+ | `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
27
+ | `metadata` | ```Hash<String, Object>``` | 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&#39;s order number for look up when receiving events for the signature request.<br><br>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. | |
28
+ | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
29
+ | `signing_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully sign. | |
30
+ | `subject` | ```String``` | The subject in the email that will be sent to the signers. | |
31
+ | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
32
+ | `title` | ```String``` | The title you want to assign to the SignatureRequest. | |
33
+ | `use_text_tags` | ```Boolean``` | 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`. | [default to false] |
34
+ | `expires_at` | ```Integer``` | 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. | |
35
+
@@ -0,0 +1,26 @@
1
+ # Dropbox::Sign::SignatureRequestEditWithTemplateRequest
2
+
3
+
4
+
5
+ ## Properties
6
+
7
+ | Name | Type | Description | Notes |
8
+ | ---- | ---- | ----------- | ----- |
9
+ | `template_ids`<sup>*_required_</sup> | ```Array<String>``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | |
10
+ | `signers`<sup>*_required_</sup> | [```Array<SubSignatureRequestTemplateSigner>```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | |
11
+ | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
12
+ | `ccs` | [```Array<SubCC>```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | |
13
+ | `client_id` | ```String``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | |
14
+ | `custom_fields` | [```Array<SubCustomField>```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | |
15
+ | `files` | ```Array<File>``` | Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
16
+ | `file_urls` | ```Array<String>``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
17
+ | `is_qualified_signature` | ```Boolean``` | 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&#39;s identity.&lt;br&gt;<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. | [default to false] |
18
+ | `is_eid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
19
+ | `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
20
+ | `metadata` | ```Hash<String, Object>``` | 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&#39;s order number for look up when receiving events for the signature request.<br><br>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. | |
21
+ | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
22
+ | `signing_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully sign. | |
23
+ | `subject` | ```String``` | The subject in the email that will be sent to the signers. | |
24
+ | `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
25
+ | `title` | ```String``` | The title you want to assign to the SignatureRequest. | |
26
+
@@ -24,9 +24,11 @@ Contains information about a signature request.
24
24
  | `details_url` | ```String``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | |
25
25
  | `cc_email_addresses` | ```Array<String>``` | 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. | |
26
26
  | `signing_redirect_url` | ```String``` | The URL you want the signer redirected to after they successfully sign. | |
27
+ | `final_copy_uri` | ```String``` | The path where the completed document can be downloaded | |
27
28
  | `template_ids` | ```Array<String>``` | Templates IDs used in this SignatureRequest (if any). | |
28
29
  | `custom_fields` | [```Array<SignatureRequestResponseCustomFieldBase>```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.<br><br>* Text Field uses `SignatureRequestResponseCustomFieldText`<br>* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | |
29
30
  | `attachments` | [```Array<SignatureRequestResponseAttachment>```](SignatureRequestResponseAttachment.md) | Signer attachments. | |
30
31
  | `response_data` | [```Array<SignatureRequestResponseDataBase>```](SignatureRequestResponseDataBase.md) | An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers. | |
31
32
  | `signatures` | [```Array<SignatureRequestResponseSignatures>```](SignatureRequestResponseSignatures.md) | An array of signature objects, 1 for each signer. | |
33
+ | `bulk_send_job_id` | ```String``` | The ID of the Bulk Send job which sent the signature request, if applicable. | |
32
34
 
@@ -8,5 +8,5 @@ This class extends `SubFormFieldsPerDocumentBase`.
8
8
  | ---- | ---- | ----------- | ----- |
9
9
  | `type`<sup>*_required_</sup> | ```String``` | A date. Use the `SubFormFieldsPerDocumentDateSigned` class. | [default to 'date_signed'] |
10
10
  | `font_family` | ```String``` | Font family for the field. | |
11
- | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | |
11
+ | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
12
12
 
@@ -10,5 +10,5 @@ This class extends `SubFormFieldsPerDocumentBase`.
10
10
  | `options`<sup>*_required_</sup> | ```Array<String>``` | Array of string values representing dropdown values. | |
11
11
  | `content` | ```String``` | Selected value in `options` array. Value must exist in array. | |
12
12
  | `font_family` | ```String``` | Font family for the field. | |
13
- | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | |
13
+ | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
14
14
 
@@ -10,5 +10,5 @@ This class extends `SubFormFieldsPerDocumentBase`.
10
10
  | `content`<sup>*_required_</sup> | ```String``` | Link Text. | |
11
11
  | `content_url`<sup>*_required_</sup> | ```String``` | Link URL. | |
12
12
  | `font_family` | ```String``` | Font family for the field. | |
13
- | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | |
13
+ | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
14
14
 
@@ -16,5 +16,5 @@ This class extends `SubFormFieldsPerDocumentBase`.
16
16
  | `validation_custom_regex_format_label` | ```String``` | | |
17
17
  | `content` | ```String``` | Content of a `me_now` text field | |
18
18
  | `font_family` | ```String``` | Font family for the field. | |
19
- | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | |
19
+ | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
20
20
 
@@ -8,5 +8,5 @@ This class extends `SubFormFieldsPerDocumentBase`.
8
8
  | ---- | ---- | ----------- | ----- |
9
9
  | `type`<sup>*_required_</sup> | ```String``` | A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. | [default to 'text-merge'] |
10
10
  | `font_family` | ```String``` | Font family for the field. | |
11
- | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | |
11
+ | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
12
12
 
@@ -10,6 +10,6 @@
10
10
  | `email_address`<sup>*_required_</sup> | ```String``` | The email address of the signer. | |
11
11
  | `order` | ```Integer``` | The order the signer is required to sign in. | |
12
12
  | `pin` | ```String``` | The 4- to 12-character access code that will secure this signer&#39;s signature page. | |
13
- | `sms_phone_number` | ```String``` | An E.164 formatted phone number.<br><br>**Note**: Not available in test mode and requires a Standard plan or higher. | |
13
+ | `sms_phone_number` | ```String``` | An E.164 formatted phone number.<br><br>By using the feature, you agree you are responsible for obtaining a signer&#39;s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).<br><br>**Note**: Not available in test mode and requires a Standard plan or higher. | |
14
14
  | `sms_phone_number_type` | ```String``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.<br><br>If `authentication`, signer is sent a verification code via SMS that is required to access the document.<br><br>If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | |
15
15
 
@@ -10,6 +10,6 @@
10
10
  | `name`<sup>*_required_</sup> | ```String``` | The name of the signer. | |
11
11
  | `email_address`<sup>*_required_</sup> | ```String``` | The email address of the signer. | |
12
12
  | `pin` | ```String``` | The 4- to 12-character access code that will secure this signer&#39;s signature page. | |
13
- | `sms_phone_number` | ```String``` | An E.164 formatted phone number.<br><br>**Note**: Not available in test mode and requires a Standard plan or higher. | |
13
+ | `sms_phone_number` | ```String``` | An E.164 formatted phone number.<br><br>By using the feature, you agree you are responsible for obtaining a signer&#39;s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).<br><br>**Note**: Not available in test mode and requires a Standard plan or higher. | |
14
14
  | `sms_phone_number_type` | ```String``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.<br><br>If `authentication`, signer is sent a verification code via SMS that is required to access the document.<br><br>If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | |
15
15
 
data/docs/TemplateApi.md CHANGED
@@ -514,7 +514,7 @@ end
514
514
 
515
515
  ## `template_files_as_file_url`
516
516
 
517
- > `<FileResponse> template_files_as_file_url(template_id)`
517
+ > `<FileResponse> template_files_as_file_url(template_id, opts)`
518
518
 
519
519
  Get Template Files as File Url
520
520
 
@@ -550,12 +550,12 @@ end
550
550
 
551
551
  This returns an Array which contains the response data, status code and headers.
552
552
 
553
- > `<Array(<FileResponse>, Integer, Hash)> template_files_as_file_url_with_http_info(template_id)`
553
+ > `<Array(<FileResponse>, Integer, Hash)> template_files_as_file_url_with_http_info(template_id, opts)`
554
554
 
555
555
  ```ruby
556
556
  begin
557
557
  # Get Template Files as File Url
558
- data, status_code, headers = api_instance.template_files_as_file_url_with_http_info(template_id)
558
+ data, status_code, headers = api_instance.template_files_as_file_url_with_http_info(template_id, opts)
559
559
  p status_code # => 2xx
560
560
  p headers # => { ... }
561
561
  p data # => <FileResponse>
@@ -569,6 +569,7 @@ end
569
569
  | Name | Type | Description | Notes |
570
570
  | ---- | ---- | ----------- | ----- |
571
571
  | `template_id` | **String** | The id of the template files to retrieve. | |
572
+ | `force_download` | **Integer** | By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. | [optional][default to 1] |
572
573
 
573
574
  ### Return type
574
575
 
@@ -6,6 +6,6 @@
6
6
 
7
7
  | Name | Type | Description | Notes |
8
8
  | ---- | ---- | ----------- | ----- |
9
- | `template` | [```TemplateCreateResponse```](TemplateCreateResponse.md) | | |
9
+ | `template` | [```TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) | | |
10
10
  | `warnings` | [```Array<WarningResponse>```](WarningResponse.md) | A list of warnings. | |
11
11
 
@@ -35,4 +35,5 @@
35
35
  | `test_mode` | ```Boolean``` | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
36
36
  | `title` | ```String``` | The title you want to assign to the SignatureRequest. | |
37
37
  | `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer&#39;s information during signing.<br><br>⚠️ **Note** ⚠️: Keep your signer&#39;s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] |
38
+ | `allow_ccs` | ```Boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [default to false] |
38
39
 
@@ -0,0 +1,58 @@
1
+ require "dropbox-sign"
2
+
3
+ Dropbox::Sign.configure do |config|
4
+ # Configure HTTP basic authorization: api_key
5
+ config.username = "YOUR_API_KEY"
6
+
7
+ # or, configure Bearer (JWT) authorization: oauth2
8
+ # config.access_token = "YOUR_ACCESS_TOKEN"
9
+ end
10
+
11
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
12
+
13
+ signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new
14
+ signer_1.email_address = "jack@example.com"
15
+ signer_1.name = "Jack"
16
+ signer_1.order = 0
17
+
18
+ signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new
19
+ signer_2.email_address = "jill@example.com"
20
+ signer_2.name = "Jill"
21
+ signer_2.order = 1
22
+
23
+ signing_options = Dropbox::Sign::SubSigningOptions.new
24
+ signing_options.draw = true
25
+ signing_options.type = true
26
+ signing_options.upload = true
27
+ signing_options.phone = true
28
+ signing_options.default_type = "draw"
29
+
30
+ field_options = Dropbox::Sign::SubFieldOptions.new
31
+ field_options.date_format = "DD - MM - YYYY"
32
+
33
+ data = Dropbox::Sign::SignatureRequestEditRequest.new
34
+ data.title = "NDA with Acme Co."
35
+ data.subject = "The NDA we talked about"
36
+ data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions."
37
+ data.signers = [signer_1, signer_2]
38
+ data.cc_email_addresses = [
39
+ "lawyer1@dropboxsign.com",
40
+ "lawyer2@dropboxsign.com",
41
+ ]
42
+ data.files = [File.new("example_signature_request.pdf", "r")]
43
+ data.metadata = {
44
+ custom_id: 1234,
45
+ custom_text: "NDA #9",
46
+ }
47
+ data.signing_options = signing_options
48
+ data.field_options = field_options
49
+ data.test_mode = true
50
+
51
+ signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
52
+
53
+ begin
54
+ result = signature_request_api.signature_request_edit(signature_request_id, data)
55
+ p result
56
+ rescue Dropbox::Sign::ApiError => e
57
+ puts "Exception when calling Dropbox Sign API: #{e}"
58
+ end
@@ -0,0 +1,48 @@
1
+ require "dropbox-sign"
2
+
3
+ Dropbox::Sign.configure do |config|
4
+ # Configure HTTP basic authorization: api_key
5
+ config.username = "YOUR_API_KEY"
6
+
7
+ # or, configure Bearer (JWT) authorization: oauth2
8
+ # config.access_token = "YOUR_ACCESS_TOKEN"
9
+ end
10
+
11
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
12
+
13
+ signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new
14
+ signer_1.email_address = "jack@example.com"
15
+ signer_1.name = "Jack"
16
+ signer_1.order = 0
17
+
18
+ signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new
19
+ signer_2.email_address = "jill@example.com"
20
+ signer_2.name = "Jill"
21
+ signer_2.order = 1
22
+
23
+ signing_options = Dropbox::Sign::SubSigningOptions.new
24
+ signing_options.draw = true
25
+ signing_options.type = true
26
+ signing_options.upload = true
27
+ signing_options.phone = true
28
+ signing_options.default_type = "draw"
29
+
30
+ data = Dropbox::Sign::SignatureRequestEditEmbeddedRequest.new
31
+ data.client_id = "ec64a202072370a737edf4a0eb7f4437"
32
+ data.title = "NDA with Acme Co."
33
+ data.subject = "The NDA we talked about"
34
+ data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions."
35
+ data.signers = [signer_1, signer_2]
36
+ data.cc_email_addresses = ["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"]
37
+ data.files = [File.new("example_signature_request.pdf", "r")]
38
+ data.signing_options = signing_options
39
+ data.test_mode = true
40
+
41
+ signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
42
+
43
+ begin
44
+ result = signature_request_api.signature_request_edit_embedded(signature_request_id, data)
45
+ p result
46
+ rescue Dropbox::Sign::ApiError => e
47
+ puts "Exception when calling Dropbox Sign API: #{e}"
48
+ end
@@ -0,0 +1,41 @@
1
+ require "dropbox-sign"
2
+
3
+ Dropbox::Sign.configure do |config|
4
+ # Configure HTTP basic authorization: api_key
5
+ config.username = "YOUR_API_KEY"
6
+
7
+ # or, configure Bearer (JWT) authorization: oauth2
8
+ # config.access_token = "YOUR_ACCESS_TOKEN"
9
+ end
10
+
11
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
12
+
13
+ signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
14
+ signer_1.role = "Client"
15
+ signer_1.email_address = "jack@example.com"
16
+ signer_1.name = "Jack"
17
+
18
+ signing_options = Dropbox::Sign::SubSigningOptions.new
19
+ signing_options.draw = true
20
+ signing_options.type = true
21
+ signing_options.upload = true
22
+ signing_options.phone = true
23
+ signing_options.default_type = "draw"
24
+
25
+ data = Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest.new
26
+ data.client_id = "ec64a202072370a737edf4a0eb7f4437"
27
+ data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]
28
+ data.subject = "Purchase Order"
29
+ data.message = "Glad we could come to an agreement."
30
+ data.signers = [signer_1]
31
+ data.signing_options = signing_options
32
+ data.test_mode = true
33
+
34
+ signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
35
+
36
+ begin
37
+ result = signature_request_api.signature_request_edit_embedded_with_template(signature_request_id, data)
38
+ p result
39
+ rescue Dropbox::Sign::ApiError => e
40
+ puts "Exception when calling Dropbox Sign API: #{e}"
41
+ end
@@ -0,0 +1,52 @@
1
+ require "dropbox-sign"
2
+
3
+ Dropbox::Sign.configure do |config|
4
+ # Configure HTTP basic authorization: api_key
5
+ config.username = "YOUR_API_KEY"
6
+
7
+ # or, configure Bearer (JWT) authorization: oauth2
8
+ # config.access_token = "YOUR_ACCESS_TOKEN"
9
+ end
10
+
11
+ signature_request_api = Dropbox::Sign::SignatureRequestApi.new
12
+
13
+ signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
14
+ signer_1.role = "Client"
15
+ signer_1.email_address = "george@example.com"
16
+ signer_1.name = "George"
17
+
18
+ cc_1 = Dropbox::Sign::SubCC.new
19
+ cc_1.role = "Accounting"
20
+ cc_1.email_address = "accounting@example.com"
21
+
22
+ custom_field_1 = Dropbox::Sign::SubCustomField.new
23
+ custom_field_1.name = "Cost"
24
+ custom_field_1.value = "$20,000"
25
+ custom_field_1.editor = "Client"
26
+ custom_field_1.required = true
27
+
28
+ signing_options = Dropbox::Sign::SubSigningOptions.new
29
+ signing_options.draw = true
30
+ signing_options.type = true
31
+ signing_options.upload = true
32
+ signing_options.phone = false
33
+ signing_options.default_type = "draw"
34
+
35
+ data = Dropbox::Sign::SignatureRequestSendWithTemplateRequest.new
36
+ data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]
37
+ data.subject = "Purchase Order"
38
+ data.message = "Glad we could come to an agreement."
39
+ data.signers = [signer_1]
40
+ data.ccs = [cc_1]
41
+ data.custom_fields = [custom_field_1]
42
+ data.signing_options = signing_options
43
+ data.test_mode = true
44
+
45
+ signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
46
+
47
+ begin
48
+ result = signature_request_api.signature_request_edit_with_template(signature_request_id, data)
49
+ p result
50
+ rescue Dropbox::Sign::ApiError => e
51
+ puts "Exception when calling Dropbox Sign API: #{e}"
52
+ end
@@ -96,7 +96,7 @@ module Dropbox::Sign
96
96
  begin
97
97
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
98
98
  rescue Dropbox::Sign::ApiError => e
99
- if e.code === 200
99
+ if e.code === 201
100
100
  body = @api_client.convert_to_type(
101
101
  JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
102
102
  "Dropbox::Sign::ApiAppGetResponse"