dropbox-sign 1.3.0 → 1.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +5 -2
- data/README.md +4 -4
- data/VERSION +1 -1
- data/docs/BulkSendJobGetResponseSignatureRequests.md +1 -0
- data/docs/EmbeddedEditUrlRequest.md +1 -1
- data/docs/EventCallbackRequestEvent.md +1 -1
- data/docs/SignatureRequestApi.md +7 -7
- data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestBulkSendWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestCreateEmbeddedRequest.md +4 -4
- data/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestResponse.md +2 -0
- data/docs/SignatureRequestSendRequest.md +5 -5
- data/docs/SignatureRequestSendWithTemplateRequest.md +2 -2
- data/docs/SignatureRequestUpdateRequest.md +2 -2
- data/docs/SubAttachment.md +1 -1
- data/docs/SubCustomField.md +1 -1
- data/docs/SubFieldOptions.md +1 -1
- data/docs/SubFormFieldsPerDocumentBase.md +2 -2
- data/docs/SubFormFieldsPerDocumentDateSigned.md +1 -1
- data/docs/SubFormFieldsPerDocumentDropdown.md +1 -1
- data/docs/SubFormFieldsPerDocumentHyperlink.md +1 -1
- data/docs/SubFormFieldsPerDocumentText.md +2 -2
- data/docs/SubFormFieldsPerDocumentTextMerge.md +1 -1
- data/docs/SubSignatureRequestGroupedSigners.md +1 -1
- data/docs/SubSignatureRequestSigner.md +1 -1
- data/docs/SubSignatureRequestTemplateSigner.md +1 -1
- data/docs/SubSigningOptions.md +1 -1
- data/docs/TeamAddMemberRequest.md +1 -1
- data/docs/TeamRemoveMemberRequest.md +2 -2
- data/docs/TemplateAddUserRequest.md +2 -2
- data/docs/TemplateCreateEmbeddedDraftRequest.md +2 -2
- data/docs/TemplateCreateRequest.md +2 -2
- data/docs/TemplateResponseDocument.md +1 -1
- data/docs/TemplateResponseDocumentStaticFieldBase.md +1 -1
- data/docs/UnclaimedDraftApi.md +3 -3
- data/docs/UnclaimedDraftCreateEmbeddedRequest.md +4 -4
- data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +3 -3
- data/docs/UnclaimedDraftCreateRequest.md +2 -2
- data/examples/SignatureRequestEdit.rb +58 -0
- data/examples/SignatureRequestEditEmbedded.rb +48 -0
- data/examples/SignatureRequestEditEmbeddedWithTemplate.rb +41 -0
- data/examples/SignatureRequestEditWithTemplate.rb +52 -0
- data/lib/dropbox-sign/api/api_app_api.rb +1 -1
- data/lib/dropbox-sign/api/signature_request_api.rb +14 -14
- data/lib/dropbox-sign/api/team_api.rb +1 -1
- data/lib/dropbox-sign/api/unclaimed_draft_api.rb +6 -6
- data/lib/dropbox-sign/event_callback_helper.rb +1 -1
- data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +13 -1
- data/lib/dropbox-sign/models/embedded_edit_url_request.rb +1 -1
- data/lib/dropbox-sign/models/event_callback_request_event.rb +2 -7
- data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +4 -4
- data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_response.rb +28 -4
- data/lib/dropbox-sign/models/signature_request_send_request.rb +5 -5
- data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +2 -2
- data/lib/dropbox-sign/models/signature_request_update_request.rb +2 -2
- data/lib/dropbox-sign/models/sub_attachment.rb +1 -1
- data/lib/dropbox-sign/models/sub_custom_field.rb +1 -1
- data/lib/dropbox-sign/models/sub_field_options.rb +1 -1
- data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +2 -2
- data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +3 -1
- data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +3 -1
- data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +3 -1
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +4 -2
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +3 -1
- data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +1 -1
- data/lib/dropbox-sign/models/sub_signature_request_signer.rb +1 -1
- data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +1 -1
- data/lib/dropbox-sign/models/sub_signing_options.rb +1 -1
- data/lib/dropbox-sign/models/team_add_member_request.rb +1 -1
- data/lib/dropbox-sign/models/team_remove_member_request.rb +2 -2
- data/lib/dropbox-sign/models/template_add_user_request.rb +2 -2
- data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +2 -2
- data/lib/dropbox-sign/models/template_create_request.rb +2 -2
- data/lib/dropbox-sign/models/template_response_document.rb +1 -1
- data/lib/dropbox-sign/models/template_response_document_static_field_base.rb +1 -1
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +4 -4
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +3 -3
- data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +2 -2
- data/lib/dropbox-sign/version.rb +1 -1
- data/openapi-config.yaml +1 -1
- data/openapi-sdk.yaml +154 -121
- data/spec/event_callback_helper_spec.rb +17 -3
- data/templates/event_callback_helper.mustache +1 -1
- data/test_fixtures/EventCallbackHelper_AccountCallbacks.json +82 -0
- data/test_fixtures/{EventCallbackHelper.json → EventCallbackHelper_AppCallbacks.json} +8 -4
- data/test_fixtures/SignatureRequestSendRequest.json +12 -6
- data/test_fixtures/SubFormFieldsPerDocument.json +8 -4
- metadata +14 -9
data/docs/UnclaimedDraftApi.md
CHANGED
@@ -124,7 +124,7 @@ end
|
|
124
124
|
|
125
125
|
Create Embedded Unclaimed Draft
|
126
126
|
|
127
|
-
Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE
|
127
|
+
Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
|
128
128
|
|
129
129
|
### Examples
|
130
130
|
|
@@ -200,7 +200,7 @@ end
|
|
200
200
|
|
201
201
|
Create Embedded Unclaimed Draft with Template
|
202
202
|
|
203
|
-
Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE
|
203
|
+
Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
|
204
204
|
|
205
205
|
### Examples
|
206
206
|
|
@@ -287,7 +287,7 @@ end
|
|
287
287
|
|
288
288
|
Edit and Resend Unclaimed Draft
|
289
289
|
|
290
|
-
Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE
|
290
|
+
Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
|
291
291
|
|
292
292
|
### Examples
|
293
293
|
|
@@ -12,7 +12,7 @@
|
|
12
12
|
| `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. | |
|
13
13
|
| `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 true] |
|
14
14
|
| `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
|
15
|
-
| `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.<br><br>**
|
15
|
+
| `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] |
|
16
16
|
| `attachments` | [```Array<SubAttachment>```](SubAttachment.md) | A list describing the attachments | |
|
17
17
|
| `cc_email_addresses` | ```Array<String>``` | The email addresses that should be CCed. | |
|
18
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 "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.<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. | |
|
@@ -22,7 +22,7 @@
|
|
22
22
|
| `force_subject_message` | ```Boolean``` | Provide users the ability to review/edit the subject and message. | [default to false] |
|
23
23
|
| `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`. | |
|
24
24
|
| `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
|
25
|
-
| `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
|
25
|
+
| `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` | |
|
26
26
|
| `hide_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [default to false] |
|
27
27
|
| `hold_request` | ```Boolean``` | The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [default to false] |
|
28
28
|
| `is_for_embedded_signing` | ```Boolean``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [default to false] |
|
@@ -40,6 +40,6 @@
|
|
40
40
|
| `type` | ```String``` | The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. | [default to 'request_signature'] |
|
41
41
|
| `use_preexisting_fields` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] |
|
42
42
|
| `use_text_tags` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] |
|
43
|
-
| `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's information during signing.<br><br
|
44
|
-
| `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.<br><br>**
|
43
|
+
| `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's information during signing.<br><br>**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] |
|
44
|
+
| `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.<br><br>**NOTE:** This does not correspond to the **expires_at** returned in the response. | |
|
45
45
|
|
@@ -10,7 +10,7 @@
|
|
10
10
|
| `requester_email_address`<sup>*_required_</sup> | ```String``` | The email address of the user that should be designated as the requester of this draft. | |
|
11
11
|
| `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 templates will be used. | |
|
12
12
|
| `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
|
13
|
-
| `allow_reassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.<br><br>**
|
13
|
+
| `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] |
|
14
14
|
| `ccs` | [```Array<SubCC>```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | |
|
15
15
|
| `custom_fields` | [```Array<SubCustomField>```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | |
|
16
16
|
| `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) | | |
|
@@ -23,7 +23,7 @@
|
|
23
23
|
| `is_for_embedded_signing` | ```Boolean``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [default to false] |
|
24
24
|
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
|
25
25
|
| `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'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. | |
|
26
|
-
| `preview_only` | ```Boolean``` | 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).<br><br>- `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience.<br><br>**
|
26
|
+
| `preview_only` | ```Boolean``` | 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).<br><br>- `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience.<br><br>**NOTE:** This parameter overwrites `show_preview=1` (if set). | [default to false] |
|
27
27
|
| `requesting_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully request a signature. | |
|
28
28
|
| `show_preview` | ```Boolean``` | This allows the requester to enable the editor/preview experience.<br><br>- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [default to false] |
|
29
29
|
| `show_progress_stepper` | ```Boolean``` | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [default to true] |
|
@@ -34,6 +34,6 @@
|
|
34
34
|
| `subject` | ```String``` | The subject in the email that will be sent to the signers. | |
|
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
|
-
| `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's information during signing.<br><br
|
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's information during signing.<br><br>**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [default to false] |
|
38
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] |
|
39
39
|
|
@@ -17,7 +17,7 @@
|
|
17
17
|
| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | |
|
18
18
|
| `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`. | |
|
19
19
|
| `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
|
20
|
-
| `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
|
20
|
+
| `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` | |
|
21
21
|
| `hide_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [default to false] |
|
22
22
|
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
|
23
23
|
| `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'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. | |
|
@@ -29,5 +29,5 @@
|
|
29
29
|
| `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] |
|
30
30
|
| `use_preexisting_fields` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] |
|
31
31
|
| `use_text_tags` | ```Boolean``` | Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both. | [default to false] |
|
32
|
-
| `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.<br><br>**
|
32
|
+
| `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.<br><br>**NOTE:** This does not correspond to the **expires_at** returned in the response. | |
|
33
33
|
|
@@ -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 ===
|
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"
|
@@ -23,7 +23,7 @@ module Dropbox::Sign
|
|
23
23
|
@api_client = api_client
|
24
24
|
end
|
25
25
|
# Embedded Bulk Send with Template
|
26
|
-
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE
|
26
|
+
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher.
|
27
27
|
# @param signature_request_bulk_create_embedded_with_template_request [SignatureRequestBulkCreateEmbeddedWithTemplateRequest]
|
28
28
|
# @param [Hash] opts the optional parameters
|
29
29
|
# @return [BulkSendJobSendResponse]
|
@@ -33,7 +33,7 @@ module Dropbox::Sign
|
|
33
33
|
end
|
34
34
|
|
35
35
|
# Embedded Bulk Send with Template
|
36
|
-
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE
|
36
|
+
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher.
|
37
37
|
# @param signature_request_bulk_create_embedded_with_template_request [SignatureRequestBulkCreateEmbeddedWithTemplateRequest]
|
38
38
|
# @param [Hash] opts the optional parameters
|
39
39
|
# @return [Array<(BulkSendJobSendResponse, Integer, Hash)>] BulkSendJobSendResponse data, response status code and response headers
|
@@ -132,7 +132,7 @@ module Dropbox::Sign
|
|
132
132
|
end
|
133
133
|
|
134
134
|
# Bulk Send with Template
|
135
|
-
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE
|
135
|
+
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher.
|
136
136
|
# @param signature_request_bulk_send_with_template_request [SignatureRequestBulkSendWithTemplateRequest]
|
137
137
|
# @param [Hash] opts the optional parameters
|
138
138
|
# @return [BulkSendJobSendResponse]
|
@@ -142,7 +142,7 @@ module Dropbox::Sign
|
|
142
142
|
end
|
143
143
|
|
144
144
|
# Bulk Send with Template
|
145
|
-
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE
|
145
|
+
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher.
|
146
146
|
# @param signature_request_bulk_send_with_template_request [SignatureRequestBulkSendWithTemplateRequest]
|
147
147
|
# @param [Hash] opts the optional parameters
|
148
148
|
# @return [Array<(BulkSendJobSendResponse, Integer, Hash)>] BulkSendJobSendResponse data, response status code and response headers
|
@@ -241,7 +241,7 @@ module Dropbox::Sign
|
|
241
241
|
end
|
242
242
|
|
243
243
|
# Cancel Incomplete Signature Request
|
244
|
-
# Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE
|
244
|
+
# Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
|
245
245
|
# @param signature_request_id [String] The id of the incomplete SignatureRequest to cancel.
|
246
246
|
# @param [Hash] opts the optional parameters
|
247
247
|
# @return [nil]
|
@@ -251,7 +251,7 @@ module Dropbox::Sign
|
|
251
251
|
end
|
252
252
|
|
253
253
|
# Cancel Incomplete Signature Request
|
254
|
-
# Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE
|
254
|
+
# Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
|
255
255
|
# @param signature_request_id [String] The id of the incomplete SignatureRequest to cancel.
|
256
256
|
# @param [Hash] opts the optional parameters
|
257
257
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -308,7 +308,7 @@ module Dropbox::Sign
|
|
308
308
|
end
|
309
309
|
|
310
310
|
# Create Embedded Signature Request
|
311
|
-
# Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
|
311
|
+
# Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
|
312
312
|
# @param signature_request_create_embedded_request [SignatureRequestCreateEmbeddedRequest]
|
313
313
|
# @param [Hash] opts the optional parameters
|
314
314
|
# @return [SignatureRequestGetResponse]
|
@@ -318,7 +318,7 @@ module Dropbox::Sign
|
|
318
318
|
end
|
319
319
|
|
320
320
|
# Create Embedded Signature Request
|
321
|
-
# Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
|
321
|
+
# Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
|
322
322
|
# @param signature_request_create_embedded_request [SignatureRequestCreateEmbeddedRequest]
|
323
323
|
# @param [Hash] opts the optional parameters
|
324
324
|
# @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
|
@@ -417,7 +417,7 @@ module Dropbox::Sign
|
|
417
417
|
end
|
418
418
|
|
419
419
|
# Create Embedded Signature Request with Template
|
420
|
-
# Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame.
|
420
|
+
# Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
|
421
421
|
# @param signature_request_create_embedded_with_template_request [SignatureRequestCreateEmbeddedWithTemplateRequest]
|
422
422
|
# @param [Hash] opts the optional parameters
|
423
423
|
# @return [SignatureRequestGetResponse]
|
@@ -427,7 +427,7 @@ module Dropbox::Sign
|
|
427
427
|
end
|
428
428
|
|
429
429
|
# Create Embedded Signature Request with Template
|
430
|
-
# Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame.
|
430
|
+
# Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
|
431
431
|
# @param signature_request_create_embedded_with_template_request [SignatureRequestCreateEmbeddedWithTemplateRequest]
|
432
432
|
# @param [Hash] opts the optional parameters
|
433
433
|
# @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
|
@@ -1106,7 +1106,7 @@ module Dropbox::Sign
|
|
1106
1106
|
end
|
1107
1107
|
|
1108
1108
|
# Send Request Reminder
|
1109
|
-
# Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE
|
1109
|
+
# Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests.
|
1110
1110
|
# @param signature_request_id [String] The id of the SignatureRequest to send a reminder for.
|
1111
1111
|
# @param signature_request_remind_request [SignatureRequestRemindRequest]
|
1112
1112
|
# @param [Hash] opts the optional parameters
|
@@ -1117,7 +1117,7 @@ module Dropbox::Sign
|
|
1117
1117
|
end
|
1118
1118
|
|
1119
1119
|
# Send Request Reminder
|
1120
|
-
# Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE
|
1120
|
+
# Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests.
|
1121
1121
|
# @param signature_request_id [String] The id of the SignatureRequest to send a reminder for.
|
1122
1122
|
# @param signature_request_remind_request [SignatureRequestRemindRequest]
|
1123
1123
|
# @param [Hash] opts the optional parameters
|
@@ -1506,7 +1506,7 @@ module Dropbox::Sign
|
|
1506
1506
|
end
|
1507
1507
|
|
1508
1508
|
# Update Signature Request
|
1509
|
-
# Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE
|
1509
|
+
# Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page.
|
1510
1510
|
# @param signature_request_id [String] The id of the SignatureRequest to update.
|
1511
1511
|
# @param signature_request_update_request [SignatureRequestUpdateRequest]
|
1512
1512
|
# @param [Hash] opts the optional parameters
|
@@ -1517,7 +1517,7 @@ module Dropbox::Sign
|
|
1517
1517
|
end
|
1518
1518
|
|
1519
1519
|
# Update Signature Request
|
1520
|
-
# Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE
|
1520
|
+
# Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page.
|
1521
1521
|
# @param signature_request_id [String] The id of the SignatureRequest to update.
|
1522
1522
|
# @param signature_request_update_request [SignatureRequestUpdateRequest]
|
1523
1523
|
# @param [Hash] opts the optional parameters
|
@@ -756,7 +756,7 @@ module Dropbox::Sign
|
|
756
756
|
begin
|
757
757
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
758
758
|
rescue Dropbox::Sign::ApiError => e
|
759
|
-
if e.code ===
|
759
|
+
if e.code === 201
|
760
760
|
body = @api_client.convert_to_type(
|
761
761
|
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
762
762
|
"Dropbox::Sign::TeamGetResponse"
|
@@ -132,7 +132,7 @@ module Dropbox::Sign
|
|
132
132
|
end
|
133
133
|
|
134
134
|
# Create Embedded Unclaimed Draft
|
135
|
-
# Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE
|
135
|
+
# Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
|
136
136
|
# @param unclaimed_draft_create_embedded_request [UnclaimedDraftCreateEmbeddedRequest]
|
137
137
|
# @param [Hash] opts the optional parameters
|
138
138
|
# @return [UnclaimedDraftCreateResponse]
|
@@ -142,7 +142,7 @@ module Dropbox::Sign
|
|
142
142
|
end
|
143
143
|
|
144
144
|
# Create Embedded Unclaimed Draft
|
145
|
-
# Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE
|
145
|
+
# Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
|
146
146
|
# @param unclaimed_draft_create_embedded_request [UnclaimedDraftCreateEmbeddedRequest]
|
147
147
|
# @param [Hash] opts the optional parameters
|
148
148
|
# @return [Array<(UnclaimedDraftCreateResponse, Integer, Hash)>] UnclaimedDraftCreateResponse data, response status code and response headers
|
@@ -241,7 +241,7 @@ module Dropbox::Sign
|
|
241
241
|
end
|
242
242
|
|
243
243
|
# Create Embedded Unclaimed Draft with Template
|
244
|
-
# Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE
|
244
|
+
# Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
|
245
245
|
# @param unclaimed_draft_create_embedded_with_template_request [UnclaimedDraftCreateEmbeddedWithTemplateRequest]
|
246
246
|
# @param [Hash] opts the optional parameters
|
247
247
|
# @return [UnclaimedDraftCreateResponse]
|
@@ -251,7 +251,7 @@ module Dropbox::Sign
|
|
251
251
|
end
|
252
252
|
|
253
253
|
# Create Embedded Unclaimed Draft with Template
|
254
|
-
# Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE
|
254
|
+
# Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
|
255
255
|
# @param unclaimed_draft_create_embedded_with_template_request [UnclaimedDraftCreateEmbeddedWithTemplateRequest]
|
256
256
|
# @param [Hash] opts the optional parameters
|
257
257
|
# @return [Array<(UnclaimedDraftCreateResponse, Integer, Hash)>] UnclaimedDraftCreateResponse data, response status code and response headers
|
@@ -350,7 +350,7 @@ module Dropbox::Sign
|
|
350
350
|
end
|
351
351
|
|
352
352
|
# Edit and Resend Unclaimed Draft
|
353
|
-
# Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE
|
353
|
+
# Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
|
354
354
|
# @param signature_request_id [String] The ID of the signature request to edit and resend.
|
355
355
|
# @param unclaimed_draft_edit_and_resend_request [UnclaimedDraftEditAndResendRequest]
|
356
356
|
# @param [Hash] opts the optional parameters
|
@@ -361,7 +361,7 @@ module Dropbox::Sign
|
|
361
361
|
end
|
362
362
|
|
363
363
|
# Edit and Resend Unclaimed Draft
|
364
|
-
# Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE
|
364
|
+
# Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
|
365
365
|
# @param signature_request_id [String] The ID of the signature request to edit and resend.
|
366
366
|
# @param unclaimed_draft_edit_and_resend_request [UnclaimedDraftEditAndResendRequest]
|
367
367
|
# @param [Hash] opts the optional parameters
|
@@ -44,7 +44,7 @@ module Dropbox::Sign
|
|
44
44
|
def self.get_callback_type(event_callback)
|
45
45
|
metadata = event_callback.event.event_metadata || EventCallbackRequestEventMetadata.new
|
46
46
|
|
47
|
-
if metadata.reported_for_app_id.nil? || metadata.reported_for_app_id.empty?
|
47
|
+
if metadata.nil? || metadata.reported_for_app_id.nil? || metadata.reported_for_app_id.empty?
|
48
48
|
return EVENT_TYPE_ACCOUNT_CALLBACK
|
49
49
|
end
|
50
50
|
|
@@ -90,6 +90,10 @@ module Dropbox::Sign
|
|
90
90
|
# @return [String, nil]
|
91
91
|
attr_accessor :signing_redirect_url
|
92
92
|
|
93
|
+
# The path where the completed document can be downloaded
|
94
|
+
# @return [String, nil]
|
95
|
+
attr_accessor :final_copy_uri
|
96
|
+
|
93
97
|
# Templates IDs used in this SignatureRequest (if any).
|
94
98
|
# @return [Array<String>, nil]
|
95
99
|
attr_accessor :template_ids
|
@@ -135,6 +139,7 @@ module Dropbox::Sign
|
|
135
139
|
:'details_url' => :'details_url',
|
136
140
|
:'cc_email_addresses' => :'cc_email_addresses',
|
137
141
|
:'signing_redirect_url' => :'signing_redirect_url',
|
142
|
+
:'final_copy_uri' => :'final_copy_uri',
|
138
143
|
:'template_ids' => :'template_ids',
|
139
144
|
:'custom_fields' => :'custom_fields',
|
140
145
|
:'attachments' => :'attachments',
|
@@ -175,6 +180,7 @@ module Dropbox::Sign
|
|
175
180
|
:'details_url' => :'String',
|
176
181
|
:'cc_email_addresses' => :'Array<String>',
|
177
182
|
:'signing_redirect_url' => :'String',
|
183
|
+
:'final_copy_uri' => :'String',
|
178
184
|
:'template_ids' => :'Array<String>',
|
179
185
|
:'custom_fields' => :'Array<SignatureRequestResponseCustomFieldBase>',
|
180
186
|
:'attachments' => :'Array<SignatureRequestResponseAttachment>',
|
@@ -197,6 +203,7 @@ module Dropbox::Sign
|
|
197
203
|
:'message',
|
198
204
|
:'signing_url',
|
199
205
|
:'signing_redirect_url',
|
206
|
+
:'final_copy_uri',
|
200
207
|
:'template_ids',
|
201
208
|
:'custom_fields',
|
202
209
|
:'attachments',
|
@@ -310,6 +317,10 @@ module Dropbox::Sign
|
|
310
317
|
self.signing_redirect_url = attributes[:'signing_redirect_url']
|
311
318
|
end
|
312
319
|
|
320
|
+
if attributes.key?(:'final_copy_uri')
|
321
|
+
self.final_copy_uri = attributes[:'final_copy_uri']
|
322
|
+
end
|
323
|
+
|
313
324
|
if attributes.key?(:'template_ids')
|
314
325
|
if (value = attributes[:'template_ids']).is_a?(Array)
|
315
326
|
self.template_ids = value
|
@@ -381,6 +392,7 @@ module Dropbox::Sign
|
|
381
392
|
details_url == o.details_url &&
|
382
393
|
cc_email_addresses == o.cc_email_addresses &&
|
383
394
|
signing_redirect_url == o.signing_redirect_url &&
|
395
|
+
final_copy_uri == o.final_copy_uri &&
|
384
396
|
template_ids == o.template_ids &&
|
385
397
|
custom_fields == o.custom_fields &&
|
386
398
|
attachments == o.attachments &&
|
@@ -398,7 +410,7 @@ module Dropbox::Sign
|
|
398
410
|
# Calculates hash code according to all attributes.
|
399
411
|
# @return [Integer] Hash code
|
400
412
|
def hash
|
401
|
-
[test_mode, signature_request_id, requester_email_address, title, original_title, subject, message, metadata, created_at, expires_at, is_complete, is_declined, has_error, files_url, signing_url, details_url, cc_email_addresses, signing_redirect_url, template_ids, custom_fields, attachments, response_data, signatures, bulk_send_job_id].hash
|
413
|
+
[test_mode, signature_request_id, requester_email_address, title, original_title, subject, message, metadata, created_at, expires_at, is_complete, is_declined, has_error, files_url, signing_url, details_url, cc_email_addresses, signing_redirect_url, final_copy_uri, template_ids, custom_fields, attachments, response_data, signatures, bulk_send_job_id].hash
|
402
414
|
end
|
403
415
|
|
404
416
|
# Builds the object from hash
|