dropbox-sign 1.3.0 → 1.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +12 -4
- data/VERSION +1 -1
- data/docs/BulkSendJobGetResponseSignatureRequests.md +1 -0
- data/docs/EventCallbackRequestEvent.md +1 -1
- data/docs/SignatureRequestApi.md +415 -0
- data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestBulkSendWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestEditEmbeddedRequest.md +33 -0
- data/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md +24 -0
- data/docs/SignatureRequestEditRequest.md +35 -0
- data/docs/SignatureRequestEditWithTemplateRequest.md +26 -0
- data/docs/SignatureRequestResponse.md +2 -0
- data/docs/SubFormFieldsPerDocumentDateSigned.md +1 -1
- data/docs/SubFormFieldsPerDocumentDropdown.md +1 -1
- data/docs/SubFormFieldsPerDocumentHyperlink.md +1 -1
- data/docs/SubFormFieldsPerDocumentText.md +1 -1
- data/docs/SubFormFieldsPerDocumentTextMerge.md +1 -1
- data/docs/SubSignatureRequestSigner.md +1 -1
- data/docs/SubSignatureRequestTemplateSigner.md +1 -1
- 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 +460 -0
- data/lib/dropbox-sign/api/team_api.rb +1 -1
- 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/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_edit_embedded_request.rb +593 -0
- data/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb +490 -0
- data/lib/dropbox-sign/models/signature_request_edit_request.rb +612 -0
- data/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb +509 -0
- data/lib/dropbox-sign/models/signature_request_response.rb +28 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +2 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +2 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +2 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +2 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +2 -0
- 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/version.rb +1 -1
- data/lib/dropbox-sign.rb +4 -0
- data/openapi-config.yaml +1 -1
- data/openapi-sdk.yaml +2321 -1264
- 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 +23 -10
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 19e7be09ec4ca8eed92a4bfc2c49920e50ff01a1ea696e4bbdf8c1c9ac1918ea
|
4
|
+
data.tar.gz: 72c5f408ae6dda210cb045ba722f2f2b1e7f14d1abeb0fa2d4ba3894c69a1583
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: df70fd2fd900ef438d5da6bf972037cc1fce126a24664b86836375ad44462f65f6e48d2cb0f32bb5fd047241e7bdf9abc6d4a293c2a24796fb097a5406158b33
|
7
|
+
data.tar.gz: 1b6fac487796259adc81a0e9f83ee946a7973cab84d7297a4f4f0a0c8e743aaa65c9ea5a852f1620590dcca182538ca71a13c4dbc74c62975940099df4def133
|
data/Gemfile.lock
CHANGED
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.
|
28
|
+
- Package version: 1.4.0
|
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.
|
49
|
+
gem install ./dropbox-sign-1.4.0.gem
|
50
50
|
```
|
51
51
|
|
52
|
-
(for development, run `gem install --dev ./dropbox-sign-1.
|
52
|
+
(for development, run `gem install --dev ./dropbox-sign-1.4.0.gem` to install the development dependencies)
|
53
53
|
|
54
54
|
Finally add this to the Gemfile:
|
55
55
|
|
56
|
-
gem 'dropbox-sign', '~> 1.
|
56
|
+
gem 'dropbox-sign', '~> 1.4.0'
|
57
57
|
|
58
58
|
### Install from Git
|
59
59
|
|
@@ -127,6 +127,10 @@ 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 |
|
130
134
|
|*Dropbox::Sign::SignatureRequestApi* | [**signature_request_files**](docs/SignatureRequestApi.md#signature_request_files) | **GET** /signature_request/files/{signature_request_id} | Download Files |
|
131
135
|
|*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 |
|
132
136
|
|*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 |
|
@@ -213,6 +217,10 @@ All URIs are relative to *https://api.hellosign.com/v3*
|
|
213
217
|
- [Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest](docs/SignatureRequestBulkSendWithTemplateRequest.md)
|
214
218
|
- [Dropbox::Sign::SignatureRequestCreateEmbeddedRequest](docs/SignatureRequestCreateEmbeddedRequest.md)
|
215
219
|
- [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)
|
216
224
|
- [Dropbox::Sign::SignatureRequestGetResponse](docs/SignatureRequestGetResponse.md)
|
217
225
|
- [Dropbox::Sign::SignatureRequestListResponse](docs/SignatureRequestListResponse.md)
|
218
226
|
- [Dropbox::Sign::SignatureRequestRemindRequest](docs/SignatureRequestRemindRequest.md)
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.4.0
|
@@ -24,6 +24,7 @@
|
|
24
24
|
| `details_url` | ```String``` | The URL where the requester and the signers can view the current status of the SignatureRequest. | |
|
25
25
|
| `cc_email_addresses` | ```Array<String>``` | A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed. | |
|
26
26
|
| `signing_redirect_url` | ```String``` | The URL you want the signer redirected to after they successfully sign. | |
|
27
|
+
| `final_copy_uri` | ```String``` | The path where the completed document can be downloaded | |
|
27
28
|
| `template_ids` | ```Array<String>``` | Templates IDs used in this SignatureRequest (if any). | |
|
28
29
|
| `custom_fields` | [```Array<SignatureRequestResponseCustomFieldBase>```](SignatureRequestResponseCustomFieldBase.md) | An array of Custom Field objects containing the name and type of each custom field.<br><br>* Text Field uses `SignatureRequestResponseCustomFieldText`<br>* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` | |
|
29
30
|
| `attachments` | [```Array<SignatureRequestResponseAttachment>```](SignatureRequestResponseAttachment.md) | Signer attachments. | |
|
@@ -9,5 +9,5 @@ Basic information about the event that occurred.
|
|
9
9
|
| `event_time`<sup>*_required_</sup> | ```String``` | Time the event was created (using Unix time). | |
|
10
10
|
| `event_type`<sup>*_required_</sup> | ```String``` | Type of callback event that was triggered. | |
|
11
11
|
| `event_hash`<sup>*_required_</sup> | ```String``` | Generated hash used to verify source of event data. | |
|
12
|
-
| `event_metadata
|
12
|
+
| `event_metadata` | [```EventCallbackRequestEventMetadata```](EventCallbackRequestEventMetadata.md) | | |
|
13
13
|
|
data/docs/SignatureRequestApi.md
CHANGED
@@ -9,6 +9,10 @@ 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 |
|
12
16
|
| [`signature_request_files`](SignatureRequestApi.md#signature_request_files) | **GET** `/signature_request/files/{signature_request_id}` | Download Files |
|
13
17
|
| [`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 |
|
14
18
|
| [`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 |
|
@@ -504,6 +508,417 @@ end
|
|
504
508
|
- **Accept**: application/json
|
505
509
|
|
506
510
|
|
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
|
+
|
507
922
|
## `signature_request_files`
|
508
923
|
|
509
924
|
> `File signature_request_files(signature_request_id, opts)`
|
@@ -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> **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
|
+
| `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> **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 ``` | |
|
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. | |
|
@@ -0,0 +1,33 @@
|
|
1
|
+
# Dropbox::Sign::SignatureRequestEditEmbeddedRequest
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `client_id`<sup>*_required_</sup> | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | |
|
10
|
+
| `files` | ```Array<File>``` | Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
|
11
|
+
| `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. | |
|
12
|
+
| `signers` | [```Array<SubSignatureRequestSigner>```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.<br><br>This endpoint requires either **signers** or **grouped_signers**, but not both. | |
|
13
|
+
| `grouped_signers` | [```Array<SubSignatureRequestGroupedSigners>```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.<br><br>This endpoint requires either **signers** or **grouped_signers**, but not both. | |
|
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>**Note**: Only available for Premium plan. | [default to false] |
|
16
|
+
| `attachments` | [```Array<SubAttachment>```](SubAttachment.md) | A list describing the attachments | |
|
17
|
+
| `cc_email_addresses` | ```Array<String>``` | The email addresses that should be CCed. | |
|
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. | |
|
19
|
+
| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | |
|
20
|
+
| `form_field_groups` | [```Array<SubFormFieldGroup>```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | |
|
21
|
+
| `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
|
22
|
+
| `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
|
23
|
+
| `hide_text_tags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.<br><br>**NOTE**: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [default to false] |
|
24
|
+
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
|
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
|
+
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
|
27
|
+
| `subject` | ```String``` | The subject in the email that will be sent to the signers. | |
|
28
|
+
| `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
|
29
|
+
| `title` | ```String``` | The title you want to assign to the SignatureRequest. | |
|
30
|
+
| `use_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | [default to false] |
|
31
|
+
| `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] |
|
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. | |
|
33
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `template_ids`<sup>*_required_</sup> | ```Array<String>``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | |
|
10
|
+
| `client_id`<sup>*_required_</sup> | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | |
|
11
|
+
| `signers`<sup>*_required_</sup> | [```Array<SubSignatureRequestTemplateSigner>```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | |
|
12
|
+
| `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
|
13
|
+
| `ccs` | [```Array<SubCC>```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | |
|
14
|
+
| `custom_fields` | [```Array<SubCustomField>```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | |
|
15
|
+
| `files` | ```Array<File>``` | Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
|
16
|
+
| `file_urls` | ```Array<String>``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
|
17
|
+
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
|
18
|
+
| `metadata` | ```Hash<String, Object>``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.<br><br>Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
|
19
|
+
| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
|
20
|
+
| `subject` | ```String``` | The subject in the email that will be sent to the signers. | |
|
21
|
+
| `test_mode` | ```Boolean``` | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [default to false] |
|
22
|
+
| `title` | ```String``` | The title you want to assign to the SignatureRequest. | |
|
23
|
+
| `populate_auto_fill_fields` | ```Boolean``` | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer'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] |
|
24
|
+
|