dropbox-sign 1.4.0 → 1.4.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +5 -2
- data/README.md +4 -12
- data/VERSION +1 -1
- data/docs/EmbeddedEditUrlRequest.md +1 -1
- data/docs/SignatureRequestApi.md +7 -422
- 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/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/lib/dropbox-sign/api/signature_request_api.rb +14 -474
- data/lib/dropbox-sign/api/unclaimed_draft_api.rb +6 -6
- data/lib/dropbox-sign/models/embedded_edit_url_request.rb +1 -1
- 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_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 +1 -1
- data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +1 -1
- data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +1 -1
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +2 -2
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +1 -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/lib/dropbox-sign.rb +0 -4
- data/openapi-config.yaml +1 -1
- data/openapi-sdk.yaml +1487 -2511
- metadata +10 -18
- data/docs/SignatureRequestEditEmbeddedRequest.md +0 -33
- data/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md +0 -24
- data/docs/SignatureRequestEditRequest.md +0 -35
- data/docs/SignatureRequestEditWithTemplateRequest.md +0 -26
- data/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb +0 -593
- data/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb +0 -490
- data/lib/dropbox-sign/models/signature_request_edit_request.rb +0 -612
- data/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb +0 -509
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f4fd3f8f12a3fb32891d97e33879626fa74968ef7dc42b6c776719050403d2ab
|
4
|
+
data.tar.gz: 12bca7ef36e1c8b70d3a9a90203e8571fdd6f326feb59b1cb83dde8dac81eca2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0d213ff3b27c639fcd4595c7fa0ff033c40d5b0a63efa0f9e97ea6c4021a8b524e3130da971c0152324877c827e6aeb091797cc49d5a14011d44b5fe13f89ab0
|
7
|
+
data.tar.gz: c2d43976c66b990c24f631d25d24ae8aa5885a2e903701ef06a61de96a35a470b502da8fec8d00a99910b65d1165d4c02d396a49dbfc1205f3a3ee348fa2868d
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
dropbox-sign (1.4.
|
4
|
+
dropbox-sign (1.4.1)
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
6
6
|
|
7
7
|
GEM
|
@@ -13,7 +13,10 @@ GEM
|
|
13
13
|
diff-lcs (1.5.0)
|
14
14
|
ethon (0.16.0)
|
15
15
|
ffi (>= 1.15.0)
|
16
|
-
ffi (1.
|
16
|
+
ffi (1.17.0-aarch64-linux-gnu)
|
17
|
+
ffi (1.17.0-arm64-darwin)
|
18
|
+
ffi (1.17.0-x86_64-darwin)
|
19
|
+
ffi (1.17.0-x86_64-linux-gnu)
|
17
20
|
jaro_winkler (1.5.4)
|
18
21
|
json_spec (1.1.5)
|
19
22
|
multi_json (~> 1.0)
|
data/README.md
CHANGED
@@ -25,7 +25,7 @@ directory that corresponds to the file you want updated.
|
|
25
25
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
26
26
|
|
27
27
|
- API version: 3.0.0
|
28
|
-
- Package version: 1.4.
|
28
|
+
- Package version: 1.4.1
|
29
29
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
30
30
|
|
31
31
|
## Installation
|
@@ -46,14 +46,14 @@ gem build dropbox-sign.gemspec
|
|
46
46
|
Then install the gem locally:
|
47
47
|
|
48
48
|
```shell
|
49
|
-
gem install ./dropbox-sign-1.4.
|
49
|
+
gem install ./dropbox-sign-1.4.1.gem
|
50
50
|
```
|
51
51
|
|
52
|
-
(for development, run `gem install --dev ./dropbox-sign-1.4.
|
52
|
+
(for development, run `gem install --dev ./dropbox-sign-1.4.1.gem` to install the development dependencies)
|
53
53
|
|
54
54
|
Finally add this to the Gemfile:
|
55
55
|
|
56
|
-
gem 'dropbox-sign', '~> 1.4.
|
56
|
+
gem 'dropbox-sign', '~> 1.4.1'
|
57
57
|
|
58
58
|
### Install from Git
|
59
59
|
|
@@ -127,10 +127,6 @@ All URIs are relative to *https://api.hellosign.com/v3*
|
|
127
127
|
|*Dropbox::Sign::SignatureRequestApi* | [**signature_request_cancel**](docs/SignatureRequestApi.md#signature_request_cancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request |
|
128
128
|
|*Dropbox::Sign::SignatureRequestApi* | [**signature_request_create_embedded**](docs/SignatureRequestApi.md#signature_request_create_embedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request |
|
129
129
|
|*Dropbox::Sign::SignatureRequestApi* | [**signature_request_create_embedded_with_template**](docs/SignatureRequestApi.md#signature_request_create_embedded_with_template) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template |
|
130
|
-
|*Dropbox::Sign::SignatureRequestApi* | [**signature_request_edit**](docs/SignatureRequestApi.md#signature_request_edit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request |
|
131
|
-
|*Dropbox::Sign::SignatureRequestApi* | [**signature_request_edit_embedded**](docs/SignatureRequestApi.md#signature_request_edit_embedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request |
|
132
|
-
|*Dropbox::Sign::SignatureRequestApi* | [**signature_request_edit_embedded_with_template**](docs/SignatureRequestApi.md#signature_request_edit_embedded_with_template) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template |
|
133
|
-
|*Dropbox::Sign::SignatureRequestApi* | [**signature_request_edit_with_template**](docs/SignatureRequestApi.md#signature_request_edit_with_template) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template |
|
134
130
|
|*Dropbox::Sign::SignatureRequestApi* | [**signature_request_files**](docs/SignatureRequestApi.md#signature_request_files) | **GET** /signature_request/files/{signature_request_id} | Download Files |
|
135
131
|
|*Dropbox::Sign::SignatureRequestApi* | [**signature_request_files_as_data_uri**](docs/SignatureRequestApi.md#signature_request_files_as_data_uri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri |
|
136
132
|
|*Dropbox::Sign::SignatureRequestApi* | [**signature_request_files_as_file_url**](docs/SignatureRequestApi.md#signature_request_files_as_file_url) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url |
|
@@ -217,10 +213,6 @@ All URIs are relative to *https://api.hellosign.com/v3*
|
|
217
213
|
- [Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest](docs/SignatureRequestBulkSendWithTemplateRequest.md)
|
218
214
|
- [Dropbox::Sign::SignatureRequestCreateEmbeddedRequest](docs/SignatureRequestCreateEmbeddedRequest.md)
|
219
215
|
- [Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest](docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md)
|
220
|
-
- [Dropbox::Sign::SignatureRequestEditEmbeddedRequest](docs/SignatureRequestEditEmbeddedRequest.md)
|
221
|
-
- [Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest](docs/SignatureRequestEditEmbeddedWithTemplateRequest.md)
|
222
|
-
- [Dropbox::Sign::SignatureRequestEditRequest](docs/SignatureRequestEditRequest.md)
|
223
|
-
- [Dropbox::Sign::SignatureRequestEditWithTemplateRequest](docs/SignatureRequestEditWithTemplateRequest.md)
|
224
216
|
- [Dropbox::Sign::SignatureRequestGetResponse](docs/SignatureRequestGetResponse.md)
|
225
217
|
- [Dropbox::Sign::SignatureRequestListResponse](docs/SignatureRequestListResponse.md)
|
226
218
|
- [Dropbox::Sign::SignatureRequestRemindRequest](docs/SignatureRequestRemindRequest.md)
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.4.
|
1
|
+
1.4.1
|
@@ -12,7 +12,7 @@
|
|
12
12
|
| `force_signer_roles` | ```Boolean``` | Provide users the ability to review/edit the template signer roles. | [default to false] |
|
13
13
|
| `force_subject_message` | ```Boolean``` | Provide users the ability to review/edit the template subject and message. | [default to false] |
|
14
14
|
| `merge_fields` | [```Array<SubMergeField>```](SubMergeField.md) | Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template.<br><br>Remove all merge fields on the template by passing an empty array `[]`. | |
|
15
|
-
| `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>**
|
15
|
+
| `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>**NOTE:** This parameter overwrites `show_preview=true` (if set). | [default to false] |
|
16
16
|
| `show_preview` | ```Boolean``` | This allows the requester to enable the editor/preview experience. | [default to false] |
|
17
17
|
| `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] |
|
18
18
|
| `test_mode` | ```Boolean``` | Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. | [default to false] |
|
data/docs/SignatureRequestApi.md
CHANGED
@@ -9,10 +9,6 @@ All URIs are relative to *https://api.hellosign.com/v3*
|
|
9
9
|
| [`signature_request_cancel`](SignatureRequestApi.md#signature_request_cancel) | **POST** `/signature_request/cancel/{signature_request_id}` | Cancel Incomplete Signature Request |
|
10
10
|
| [`signature_request_create_embedded`](SignatureRequestApi.md#signature_request_create_embedded) | **POST** `/signature_request/create_embedded` | Create Embedded Signature Request |
|
11
11
|
| [`signature_request_create_embedded_with_template`](SignatureRequestApi.md#signature_request_create_embedded_with_template) | **POST** `/signature_request/create_embedded_with_template` | Create Embedded Signature Request with Template |
|
12
|
-
| [`signature_request_edit`](SignatureRequestApi.md#signature_request_edit) | **PUT** `/signature_request/edit/{signature_request_id}` | Edit Signature Request |
|
13
|
-
| [`signature_request_edit_embedded`](SignatureRequestApi.md#signature_request_edit_embedded) | **PUT** `/signature_request/edit_embedded/{signature_request_id}` | Edit Embedded Signature Request |
|
14
|
-
| [`signature_request_edit_embedded_with_template`](SignatureRequestApi.md#signature_request_edit_embedded_with_template) | **PUT** `/signature_request/edit_embedded_with_template/{signature_request_id}` | Edit Embedded Signature Request with Template |
|
15
|
-
| [`signature_request_edit_with_template`](SignatureRequestApi.md#signature_request_edit_with_template) | **PUT** `/signature_request/edit_with_template/{signature_request_id}` | Edit Signature Request With Template |
|
16
12
|
| [`signature_request_files`](SignatureRequestApi.md#signature_request_files) | **GET** `/signature_request/files/{signature_request_id}` | Download Files |
|
17
13
|
| [`signature_request_files_as_data_uri`](SignatureRequestApi.md#signature_request_files_as_data_uri) | **GET** `/signature_request/files_as_data_uri/{signature_request_id}` | Download Files as Data Uri |
|
18
14
|
| [`signature_request_files_as_file_url`](SignatureRequestApi.md#signature_request_files_as_file_url) | **GET** `/signature_request/files_as_file_url/{signature_request_id}` | Download Files as File Url |
|
@@ -32,7 +28,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
|
|
32
28
|
|
33
29
|
Embedded Bulk Send with Template
|
34
30
|
|
35
|
-
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
|
31
|
+
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.
|
36
32
|
|
37
33
|
### Examples
|
38
34
|
|
@@ -143,7 +139,7 @@ end
|
|
143
139
|
|
144
140
|
Bulk Send with Template
|
145
141
|
|
146
|
-
Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE
|
142
|
+
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.
|
147
143
|
|
148
144
|
### Examples
|
149
145
|
|
@@ -253,7 +249,7 @@ end
|
|
253
249
|
|
254
250
|
Cancel Incomplete Signature Request
|
255
251
|
|
256
|
-
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
|
252
|
+
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]`.
|
257
253
|
|
258
254
|
### Examples
|
259
255
|
|
@@ -325,7 +321,7 @@ nil (empty response body)
|
|
325
321
|
|
326
322
|
Create Embedded Signature Request
|
327
323
|
|
328
|
-
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.
|
324
|
+
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.
|
329
325
|
|
330
326
|
### Examples
|
331
327
|
|
@@ -423,7 +419,7 @@ end
|
|
423
419
|
|
424
420
|
Create Embedded Signature Request with Template
|
425
421
|
|
426
|
-
Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame.
|
422
|
+
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.
|
427
423
|
|
428
424
|
### Examples
|
429
425
|
|
@@ -508,417 +504,6 @@ end
|
|
508
504
|
- **Accept**: application/json
|
509
505
|
|
510
506
|
|
511
|
-
## `signature_request_edit`
|
512
|
-
|
513
|
-
> `<SignatureRequestGetResponse> signature_request_edit(signature_request_id, signature_request_edit_request)`
|
514
|
-
|
515
|
-
Edit Signature Request
|
516
|
-
|
517
|
-
Edits and sends a SignatureRequest with the submitted documents. 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:** Edit and resend will not deduct your signature request quota.
|
518
|
-
|
519
|
-
### Examples
|
520
|
-
|
521
|
-
```ruby
|
522
|
-
require "dropbox-sign"
|
523
|
-
|
524
|
-
Dropbox::Sign.configure do |config|
|
525
|
-
# Configure HTTP basic authorization: api_key
|
526
|
-
config.username = "YOUR_API_KEY"
|
527
|
-
|
528
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
529
|
-
# config.access_token = "YOUR_ACCESS_TOKEN"
|
530
|
-
end
|
531
|
-
|
532
|
-
signature_request_api = Dropbox::Sign::SignatureRequestApi.new
|
533
|
-
|
534
|
-
signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new
|
535
|
-
signer_1.email_address = "jack@example.com"
|
536
|
-
signer_1.name = "Jack"
|
537
|
-
signer_1.order = 0
|
538
|
-
|
539
|
-
signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new
|
540
|
-
signer_2.email_address = "jill@example.com"
|
541
|
-
signer_2.name = "Jill"
|
542
|
-
signer_2.order = 1
|
543
|
-
|
544
|
-
signing_options = Dropbox::Sign::SubSigningOptions.new
|
545
|
-
signing_options.draw = true
|
546
|
-
signing_options.type = true
|
547
|
-
signing_options.upload = true
|
548
|
-
signing_options.phone = true
|
549
|
-
signing_options.default_type = "draw"
|
550
|
-
|
551
|
-
field_options = Dropbox::Sign::SubFieldOptions.new
|
552
|
-
field_options.date_format = "DD - MM - YYYY"
|
553
|
-
|
554
|
-
data = Dropbox::Sign::SignatureRequestEditRequest.new
|
555
|
-
data.title = "NDA with Acme Co."
|
556
|
-
data.subject = "The NDA we talked about"
|
557
|
-
data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions."
|
558
|
-
data.signers = [signer_1, signer_2]
|
559
|
-
data.cc_email_addresses = [
|
560
|
-
"lawyer1@dropboxsign.com",
|
561
|
-
"lawyer2@dropboxsign.com",
|
562
|
-
]
|
563
|
-
data.files = [File.new("example_signature_request.pdf", "r")]
|
564
|
-
data.metadata = {
|
565
|
-
custom_id: 1234,
|
566
|
-
custom_text: "NDA #9",
|
567
|
-
}
|
568
|
-
data.signing_options = signing_options
|
569
|
-
data.field_options = field_options
|
570
|
-
data.test_mode = true
|
571
|
-
|
572
|
-
signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
|
573
|
-
|
574
|
-
begin
|
575
|
-
result = signature_request_api.signature_request_edit(signature_request_id, data)
|
576
|
-
p result
|
577
|
-
rescue Dropbox::Sign::ApiError => e
|
578
|
-
puts "Exception when calling Dropbox Sign API: #{e}"
|
579
|
-
end
|
580
|
-
|
581
|
-
```
|
582
|
-
|
583
|
-
#### Using the `signature_request_edit_with_http_info` variant
|
584
|
-
|
585
|
-
This returns an Array which contains the response data, status code and headers.
|
586
|
-
|
587
|
-
> `<Array(<SignatureRequestGetResponse>, Integer, Hash)> signature_request_edit_with_http_info(signature_request_id, signature_request_edit_request)`
|
588
|
-
|
589
|
-
```ruby
|
590
|
-
begin
|
591
|
-
# Edit Signature Request
|
592
|
-
data, status_code, headers = api_instance.signature_request_edit_with_http_info(signature_request_id, signature_request_edit_request)
|
593
|
-
p status_code # => 2xx
|
594
|
-
p headers # => { ... }
|
595
|
-
p data # => <SignatureRequestGetResponse>
|
596
|
-
rescue Dropbox::Sign::ApiError => e
|
597
|
-
puts "Error when calling SignatureRequestApi->signature_request_edit_with_http_info: #{e}"
|
598
|
-
end
|
599
|
-
```
|
600
|
-
|
601
|
-
### Parameters
|
602
|
-
|
603
|
-
| Name | Type | Description | Notes |
|
604
|
-
| ---- | ---- | ----------- | ----- |
|
605
|
-
| `signature_request_id` | **String** | The id of the SignatureRequest to edit. | |
|
606
|
-
| `signature_request_edit_request` | [**SignatureRequestEditRequest**](SignatureRequestEditRequest.md) | | |
|
607
|
-
|
608
|
-
### Return type
|
609
|
-
|
610
|
-
[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
|
611
|
-
|
612
|
-
### Authorization
|
613
|
-
|
614
|
-
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
615
|
-
|
616
|
-
### HTTP request headers
|
617
|
-
|
618
|
-
- **Content-Type**: application/json, multipart/form-data
|
619
|
-
- **Accept**: application/json
|
620
|
-
|
621
|
-
|
622
|
-
## `signature_request_edit_embedded`
|
623
|
-
|
624
|
-
> `<SignatureRequestGetResponse> signature_request_edit_embedded(signature_request_id, signature_request_edit_embedded_request)`
|
625
|
-
|
626
|
-
Edit Embedded Signature Request
|
627
|
-
|
628
|
-
Edits a 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. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
|
629
|
-
|
630
|
-
### Examples
|
631
|
-
|
632
|
-
```ruby
|
633
|
-
require "dropbox-sign"
|
634
|
-
|
635
|
-
Dropbox::Sign.configure do |config|
|
636
|
-
# Configure HTTP basic authorization: api_key
|
637
|
-
config.username = "YOUR_API_KEY"
|
638
|
-
|
639
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
640
|
-
# config.access_token = "YOUR_ACCESS_TOKEN"
|
641
|
-
end
|
642
|
-
|
643
|
-
signature_request_api = Dropbox::Sign::SignatureRequestApi.new
|
644
|
-
|
645
|
-
signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new
|
646
|
-
signer_1.email_address = "jack@example.com"
|
647
|
-
signer_1.name = "Jack"
|
648
|
-
signer_1.order = 0
|
649
|
-
|
650
|
-
signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new
|
651
|
-
signer_2.email_address = "jill@example.com"
|
652
|
-
signer_2.name = "Jill"
|
653
|
-
signer_2.order = 1
|
654
|
-
|
655
|
-
signing_options = Dropbox::Sign::SubSigningOptions.new
|
656
|
-
signing_options.draw = true
|
657
|
-
signing_options.type = true
|
658
|
-
signing_options.upload = true
|
659
|
-
signing_options.phone = true
|
660
|
-
signing_options.default_type = "draw"
|
661
|
-
|
662
|
-
data = Dropbox::Sign::SignatureRequestEditEmbeddedRequest.new
|
663
|
-
data.client_id = "ec64a202072370a737edf4a0eb7f4437"
|
664
|
-
data.title = "NDA with Acme Co."
|
665
|
-
data.subject = "The NDA we talked about"
|
666
|
-
data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions."
|
667
|
-
data.signers = [signer_1, signer_2]
|
668
|
-
data.cc_email_addresses = ["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"]
|
669
|
-
data.files = [File.new("example_signature_request.pdf", "r")]
|
670
|
-
data.signing_options = signing_options
|
671
|
-
data.test_mode = true
|
672
|
-
|
673
|
-
signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
|
674
|
-
|
675
|
-
begin
|
676
|
-
result = signature_request_api.signature_request_edit_embedded(signature_request_id, data)
|
677
|
-
p result
|
678
|
-
rescue Dropbox::Sign::ApiError => e
|
679
|
-
puts "Exception when calling Dropbox Sign API: #{e}"
|
680
|
-
end
|
681
|
-
|
682
|
-
```
|
683
|
-
|
684
|
-
#### Using the `signature_request_edit_embedded_with_http_info` variant
|
685
|
-
|
686
|
-
This returns an Array which contains the response data, status code and headers.
|
687
|
-
|
688
|
-
> `<Array(<SignatureRequestGetResponse>, Integer, Hash)> signature_request_edit_embedded_with_http_info(signature_request_id, signature_request_edit_embedded_request)`
|
689
|
-
|
690
|
-
```ruby
|
691
|
-
begin
|
692
|
-
# Edit Embedded Signature Request
|
693
|
-
data, status_code, headers = api_instance.signature_request_edit_embedded_with_http_info(signature_request_id, signature_request_edit_embedded_request)
|
694
|
-
p status_code # => 2xx
|
695
|
-
p headers # => { ... }
|
696
|
-
p data # => <SignatureRequestGetResponse>
|
697
|
-
rescue Dropbox::Sign::ApiError => e
|
698
|
-
puts "Error when calling SignatureRequestApi->signature_request_edit_embedded_with_http_info: #{e}"
|
699
|
-
end
|
700
|
-
```
|
701
|
-
|
702
|
-
### Parameters
|
703
|
-
|
704
|
-
| Name | Type | Description | Notes |
|
705
|
-
| ---- | ---- | ----------- | ----- |
|
706
|
-
| `signature_request_id` | **String** | The id of the SignatureRequest to edit. | |
|
707
|
-
| `signature_request_edit_embedded_request` | [**SignatureRequestEditEmbeddedRequest**](SignatureRequestEditEmbeddedRequest.md) | | |
|
708
|
-
|
709
|
-
### Return type
|
710
|
-
|
711
|
-
[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
|
712
|
-
|
713
|
-
### Authorization
|
714
|
-
|
715
|
-
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
716
|
-
|
717
|
-
### HTTP request headers
|
718
|
-
|
719
|
-
- **Content-Type**: application/json, multipart/form-data
|
720
|
-
- **Accept**: application/json
|
721
|
-
|
722
|
-
|
723
|
-
## `signature_request_edit_embedded_with_template`
|
724
|
-
|
725
|
-
> `<SignatureRequestGetResponse> signature_request_edit_embedded_with_template(signature_request_id, signature_request_edit_embedded_with_template_request)`
|
726
|
-
|
727
|
-
Edit Embedded Signature Request with Template
|
728
|
-
|
729
|
-
Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
|
730
|
-
|
731
|
-
### Examples
|
732
|
-
|
733
|
-
```ruby
|
734
|
-
require "dropbox-sign"
|
735
|
-
|
736
|
-
Dropbox::Sign.configure do |config|
|
737
|
-
# Configure HTTP basic authorization: api_key
|
738
|
-
config.username = "YOUR_API_KEY"
|
739
|
-
|
740
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
741
|
-
# config.access_token = "YOUR_ACCESS_TOKEN"
|
742
|
-
end
|
743
|
-
|
744
|
-
signature_request_api = Dropbox::Sign::SignatureRequestApi.new
|
745
|
-
|
746
|
-
signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
|
747
|
-
signer_1.role = "Client"
|
748
|
-
signer_1.email_address = "jack@example.com"
|
749
|
-
signer_1.name = "Jack"
|
750
|
-
|
751
|
-
signing_options = Dropbox::Sign::SubSigningOptions.new
|
752
|
-
signing_options.draw = true
|
753
|
-
signing_options.type = true
|
754
|
-
signing_options.upload = true
|
755
|
-
signing_options.phone = true
|
756
|
-
signing_options.default_type = "draw"
|
757
|
-
|
758
|
-
data = Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest.new
|
759
|
-
data.client_id = "ec64a202072370a737edf4a0eb7f4437"
|
760
|
-
data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]
|
761
|
-
data.subject = "Purchase Order"
|
762
|
-
data.message = "Glad we could come to an agreement."
|
763
|
-
data.signers = [signer_1]
|
764
|
-
data.signing_options = signing_options
|
765
|
-
data.test_mode = true
|
766
|
-
|
767
|
-
signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
|
768
|
-
|
769
|
-
begin
|
770
|
-
result = signature_request_api.signature_request_edit_embedded_with_template(signature_request_id, data)
|
771
|
-
p result
|
772
|
-
rescue Dropbox::Sign::ApiError => e
|
773
|
-
puts "Exception when calling Dropbox Sign API: #{e}"
|
774
|
-
end
|
775
|
-
|
776
|
-
```
|
777
|
-
|
778
|
-
#### Using the `signature_request_edit_embedded_with_template_with_http_info` variant
|
779
|
-
|
780
|
-
This returns an Array which contains the response data, status code and headers.
|
781
|
-
|
782
|
-
> `<Array(<SignatureRequestGetResponse>, Integer, Hash)> signature_request_edit_embedded_with_template_with_http_info(signature_request_id, signature_request_edit_embedded_with_template_request)`
|
783
|
-
|
784
|
-
```ruby
|
785
|
-
begin
|
786
|
-
# Edit Embedded Signature Request with Template
|
787
|
-
data, status_code, headers = api_instance.signature_request_edit_embedded_with_template_with_http_info(signature_request_id, signature_request_edit_embedded_with_template_request)
|
788
|
-
p status_code # => 2xx
|
789
|
-
p headers # => { ... }
|
790
|
-
p data # => <SignatureRequestGetResponse>
|
791
|
-
rescue Dropbox::Sign::ApiError => e
|
792
|
-
puts "Error when calling SignatureRequestApi->signature_request_edit_embedded_with_template_with_http_info: #{e}"
|
793
|
-
end
|
794
|
-
```
|
795
|
-
|
796
|
-
### Parameters
|
797
|
-
|
798
|
-
| Name | Type | Description | Notes |
|
799
|
-
| ---- | ---- | ----------- | ----- |
|
800
|
-
| `signature_request_id` | **String** | The id of the SignatureRequest to edit. | |
|
801
|
-
| `signature_request_edit_embedded_with_template_request` | [**SignatureRequestEditEmbeddedWithTemplateRequest**](SignatureRequestEditEmbeddedWithTemplateRequest.md) | | |
|
802
|
-
|
803
|
-
### Return type
|
804
|
-
|
805
|
-
[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
|
806
|
-
|
807
|
-
### Authorization
|
808
|
-
|
809
|
-
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
810
|
-
|
811
|
-
### HTTP request headers
|
812
|
-
|
813
|
-
- **Content-Type**: application/json, multipart/form-data
|
814
|
-
- **Accept**: application/json
|
815
|
-
|
816
|
-
|
817
|
-
## `signature_request_edit_with_template`
|
818
|
-
|
819
|
-
> `<SignatureRequestGetResponse> signature_request_edit_with_template(signature_request_id, signature_request_edit_with_template_request)`
|
820
|
-
|
821
|
-
Edit Signature Request With Template
|
822
|
-
|
823
|
-
Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota.
|
824
|
-
|
825
|
-
### Examples
|
826
|
-
|
827
|
-
```ruby
|
828
|
-
require "dropbox-sign"
|
829
|
-
|
830
|
-
Dropbox::Sign.configure do |config|
|
831
|
-
# Configure HTTP basic authorization: api_key
|
832
|
-
config.username = "YOUR_API_KEY"
|
833
|
-
|
834
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
835
|
-
# config.access_token = "YOUR_ACCESS_TOKEN"
|
836
|
-
end
|
837
|
-
|
838
|
-
signature_request_api = Dropbox::Sign::SignatureRequestApi.new
|
839
|
-
|
840
|
-
signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
|
841
|
-
signer_1.role = "Client"
|
842
|
-
signer_1.email_address = "george@example.com"
|
843
|
-
signer_1.name = "George"
|
844
|
-
|
845
|
-
cc_1 = Dropbox::Sign::SubCC.new
|
846
|
-
cc_1.role = "Accounting"
|
847
|
-
cc_1.email_address = "accounting@example.com"
|
848
|
-
|
849
|
-
custom_field_1 = Dropbox::Sign::SubCustomField.new
|
850
|
-
custom_field_1.name = "Cost"
|
851
|
-
custom_field_1.value = "$20,000"
|
852
|
-
custom_field_1.editor = "Client"
|
853
|
-
custom_field_1.required = true
|
854
|
-
|
855
|
-
signing_options = Dropbox::Sign::SubSigningOptions.new
|
856
|
-
signing_options.draw = true
|
857
|
-
signing_options.type = true
|
858
|
-
signing_options.upload = true
|
859
|
-
signing_options.phone = false
|
860
|
-
signing_options.default_type = "draw"
|
861
|
-
|
862
|
-
data = Dropbox::Sign::SignatureRequestSendWithTemplateRequest.new
|
863
|
-
data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]
|
864
|
-
data.subject = "Purchase Order"
|
865
|
-
data.message = "Glad we could come to an agreement."
|
866
|
-
data.signers = [signer_1]
|
867
|
-
data.ccs = [cc_1]
|
868
|
-
data.custom_fields = [custom_field_1]
|
869
|
-
data.signing_options = signing_options
|
870
|
-
data.test_mode = true
|
871
|
-
|
872
|
-
signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
|
873
|
-
|
874
|
-
begin
|
875
|
-
result = signature_request_api.signature_request_edit_with_template(signature_request_id, data)
|
876
|
-
p result
|
877
|
-
rescue Dropbox::Sign::ApiError => e
|
878
|
-
puts "Exception when calling Dropbox Sign API: #{e}"
|
879
|
-
end
|
880
|
-
|
881
|
-
```
|
882
|
-
|
883
|
-
#### Using the `signature_request_edit_with_template_with_http_info` variant
|
884
|
-
|
885
|
-
This returns an Array which contains the response data, status code and headers.
|
886
|
-
|
887
|
-
> `<Array(<SignatureRequestGetResponse>, Integer, Hash)> signature_request_edit_with_template_with_http_info(signature_request_id, signature_request_edit_with_template_request)`
|
888
|
-
|
889
|
-
```ruby
|
890
|
-
begin
|
891
|
-
# Edit Signature Request With Template
|
892
|
-
data, status_code, headers = api_instance.signature_request_edit_with_template_with_http_info(signature_request_id, signature_request_edit_with_template_request)
|
893
|
-
p status_code # => 2xx
|
894
|
-
p headers # => { ... }
|
895
|
-
p data # => <SignatureRequestGetResponse>
|
896
|
-
rescue Dropbox::Sign::ApiError => e
|
897
|
-
puts "Error when calling SignatureRequestApi->signature_request_edit_with_template_with_http_info: #{e}"
|
898
|
-
end
|
899
|
-
```
|
900
|
-
|
901
|
-
### Parameters
|
902
|
-
|
903
|
-
| Name | Type | Description | Notes |
|
904
|
-
| ---- | ---- | ----------- | ----- |
|
905
|
-
| `signature_request_id` | **String** | The id of the SignatureRequest to edit. | |
|
906
|
-
| `signature_request_edit_with_template_request` | [**SignatureRequestEditWithTemplateRequest**](SignatureRequestEditWithTemplateRequest.md) | | |
|
907
|
-
|
908
|
-
### Return type
|
909
|
-
|
910
|
-
[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
|
911
|
-
|
912
|
-
### Authorization
|
913
|
-
|
914
|
-
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
915
|
-
|
916
|
-
### HTTP request headers
|
917
|
-
|
918
|
-
- **Content-Type**: application/json, multipart/form-data
|
919
|
-
- **Accept**: application/json
|
920
|
-
|
921
|
-
|
922
507
|
## `signature_request_files`
|
923
508
|
|
924
509
|
> `File signature_request_files(signature_request_id, opts)`
|
@@ -1363,7 +948,7 @@ end
|
|
1363
948
|
|
1364
949
|
Send Request Reminder
|
1365
950
|
|
1366
|
-
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
|
951
|
+
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.
|
1367
952
|
|
1368
953
|
### Examples
|
1369
954
|
|
@@ -1721,7 +1306,7 @@ end
|
|
1721
1306
|
|
1722
1307
|
Update Signature Request
|
1723
1308
|
|
1724
|
-
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
|
1309
|
+
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.
|
1725
1310
|
|
1726
1311
|
### Examples
|
1727
1312
|
|
@@ -8,7 +8,7 @@
|
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
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
10
|
| `client_id`<sup>*_required_</sup> | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | |
|
11
|
-
| `signer_file` | ```File``` | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:<br><br>- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)<br><br> By using the feature, you agree you are responsible for obtaining a signer'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> **
|
11
|
+
| `signer_file` | ```File``` | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:<br><br>- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)<br><br> By using the feature, you agree you are responsible for obtaining a signer'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. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)<br><br> You may only specify field values here, any other options should be set in the custom_fields request parameter.<br><br>Example CSV:<br><br>``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | |
|
12
12
|
| `signer_list` | [```Array<SubBulkSignerList>```](SubBulkSignerList.md) | `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. | |
|
13
13
|
| `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
|
14
14
|
| `ccs` | [```Array<SubCC>```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | |
|
@@ -7,7 +7,7 @@
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
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
|
-
| `signer_file` | ```File``` | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:<br><br>- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)<br><br> By using the feature, you agree you are responsible for obtaining a signer'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> **
|
10
|
+
| `signer_file` | ```File``` | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:<br><br>- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)<br><br> By using the feature, you agree you are responsible for obtaining a signer'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. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)<br><br> You may only specify field values here, any other options should be set in the custom_fields request parameter.<br><br>Example CSV:<br><br>``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | |
|
11
11
|
| `signer_list` | [```Array<SubBulkSignerList>```](SubBulkSignerList.md) | `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. | |
|
12
12
|
| `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
|
13
13
|
| `ccs` | [```Array<SubCC>```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | |
|