dropbox-sign 1.0.0 → 1.1.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 +26 -9
- data/VERSION +1 -0
- data/bin/release +39 -0
- data/bin/ruby +1 -0
- data/docs/BulkSendJobApi.md +5 -3
- data/docs/SignatureRequestApi.md +3 -3
- data/docs/SignatureRequestCreateEmbeddedRequest.md +1 -1
- data/docs/SignatureRequestSendRequest.md +1 -1
- data/docs/SubFormFieldsPerDocumentBase.md +1 -1
- data/docs/TeamResponse.md +1 -0
- data/docs/TemplateCreateEmbeddedDraftRequest.md +1 -1
- data/docs/TemplateResponse.md +2 -2
- data/docs/TemplateResponseDocument.md +3 -3
- data/docs/{TemplateResponseCustomField.md → TemplateResponseDocumentCustomFieldBase.md} +6 -8
- data/docs/TemplateResponseDocumentCustomFieldCheckbox.md +10 -0
- data/docs/TemplateResponseDocumentCustomFieldText.md +14 -0
- data/docs/TemplateResponseDocumentFieldGroup.md +1 -1
- data/docs/TemplateResponseDocumentFieldGroupRule.md +11 -0
- data/docs/{TemplateResponseDocumentFormField.md → TemplateResponseDocumentFormFieldBase.md} +5 -8
- data/docs/TemplateResponseDocumentFormFieldCheckbox.md +10 -0
- data/docs/TemplateResponseDocumentFormFieldDateSigned.md +10 -0
- data/docs/TemplateResponseDocumentFormFieldDropdown.md +10 -0
- data/docs/TemplateResponseDocumentFormFieldHyperlink.md +14 -0
- data/docs/TemplateResponseDocumentFormFieldInitials.md +10 -0
- data/docs/TemplateResponseDocumentFormFieldRadio.md +10 -0
- data/docs/TemplateResponseDocumentFormFieldSignature.md +10 -0
- data/docs/TemplateResponseDocumentFormFieldText.md +15 -0
- data/docs/{TemplateResponseDocumentStaticField.md → TemplateResponseDocumentStaticFieldBase.md} +6 -5
- data/docs/TemplateResponseDocumentStaticFieldCheckbox.md +10 -0
- data/docs/TemplateResponseDocumentStaticFieldDateSigned.md +10 -0
- data/docs/TemplateResponseDocumentStaticFieldDropdown.md +10 -0
- data/docs/TemplateResponseDocumentStaticFieldHyperlink.md +10 -0
- data/docs/TemplateResponseDocumentStaticFieldInitials.md +10 -0
- data/docs/TemplateResponseDocumentStaticFieldRadio.md +10 -0
- data/docs/TemplateResponseDocumentStaticFieldSignature.md +10 -0
- data/docs/TemplateResponseDocumentStaticFieldText.md +10 -0
- data/docs/TemplateResponseFieldAvgTextLength.md +1 -1
- data/docs/UnclaimedDraftApi.md +2 -2
- data/docs/UnclaimedDraftCreateEmbeddedRequest.md +1 -1
- data/docs/UnclaimedDraftCreateRequest.md +1 -1
- data/examples/SignatureRequestCreateEmbedded.rb +1 -1
- data/examples/SignatureRequestSend.rb +2 -2
- data/examples/UnclaimedDraftCreate.rb +2 -2
- data/lib/dropbox-sign/api/bulk_send_job_api.rb +6 -0
- data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_send_request.rb +1 -1
- data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +1 -1
- data/lib/dropbox-sign/models/team_response.rb +17 -4
- data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +1 -1
- data/lib/dropbox-sign/models/template_response.rb +5 -5
- data/lib/dropbox-sign/models/template_response_document.rb +9 -9
- data/lib/dropbox-sign/models/{template_response_document_static_field.rb → template_response_document_custom_field_base.rb} +75 -43
- data/lib/dropbox-sign/models/template_response_document_custom_field_checkbox.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_custom_field_text.rb +306 -0
- data/lib/dropbox-sign/models/template_response_document_field_group.rb +2 -3
- data/lib/dropbox-sign/models/template_response_document_field_group_rule.rb +263 -0
- data/lib/dropbox-sign/models/{template_response_named_form_field.rb → template_response_document_form_field_base.rb} +82 -79
- data/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb +306 -0
- data/lib/dropbox-sign/models/template_response_document_form_field_initials.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_form_field_radio.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_form_field_signature.rb +263 -0
- data/lib/dropbox-sign/models/{template_response_document_form_field.rb → template_response_document_form_field_text.rb} +53 -132
- data/lib/dropbox-sign/models/{template_response_custom_field.rb → template_response_document_static_field_base.rb} +94 -112
- data/lib/dropbox-sign/models/template_response_document_static_field_checkbox.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_static_field_date_signed.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_static_field_dropdown.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_static_field_hyperlink.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_static_field_initials.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_static_field_radio.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_static_field_signature.rb +263 -0
- data/lib/dropbox-sign/models/template_response_document_static_field_text.rb +263 -0
- data/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +1 -1
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +1 -1
- data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +1 -1
- data/lib/dropbox-sign/version.rb +1 -1
- data/lib/dropbox-sign.rb +22 -5
- data/openapi-config.yaml +4 -1
- data/openapi-sdk.yaml +598 -186
- data/templates/VERSION-root.mustache +1 -0
- data/test_fixtures/AccountCreateResponse.json +1 -0
- data/test_fixtures/ApiAppGetResponse.json +1 -0
- data/test_fixtures/ApiAppListResponse.json +1 -0
- data/test_fixtures/BulkSendJobGetResponse.json +8 -3
- data/test_fixtures/SignatureRequestGetResponse.json +65 -65
- data/test_fixtures/SignatureRequestListResponse.json +11 -4
- data/test_fixtures/TemplateGetResponse.json +1064 -41
- data/test_fixtures/TemplateListResponse.json +513 -44
- metadata +58 -64
- data/docs/TemplateResponseDocumentCustomField.md +0 -25
- data/docs/TemplateResponseNamedFormField.md +0 -23
- data/lib/dropbox-sign/models/template_response_document_custom_field.rb +0 -454
- data/vendor/autoload.php +0 -7
- data/vendor/bin/yaml-lint +0 -117
- data/vendor/composer/ClassLoader.php +0 -572
- data/vendor/composer/InstalledVersions.php +0 -350
- data/vendor/composer/LICENSE +0 -21
- data/vendor/composer/autoload_classmap.php +0 -10
- data/vendor/composer/autoload_files.php +0 -11
- data/vendor/composer/autoload_namespaces.php +0 -9
- data/vendor/composer/autoload_psr4.php +0 -11
- data/vendor/composer/autoload_real.php +0 -80
- data/vendor/composer/autoload_static.php +0 -46
- data/vendor/composer/installed.json +0 -239
- data/vendor/composer/installed.php +0 -50
- data/vendor/composer/platform_check.php +0 -26
- data/vendor/symfony/deprecation-contracts/.gitignore +0 -3
- data/vendor/symfony/deprecation-contracts/CHANGELOG.md +0 -5
- data/vendor/symfony/deprecation-contracts/LICENSE +0 -19
- data/vendor/symfony/deprecation-contracts/README.md +0 -26
- data/vendor/symfony/deprecation-contracts/composer.json +0 -35
- data/vendor/symfony/deprecation-contracts/function.php +0 -27
- data/vendor/symfony/polyfill-ctype/Ctype.php +0 -232
- data/vendor/symfony/polyfill-ctype/LICENSE +0 -19
- data/vendor/symfony/polyfill-ctype/README.md +0 -12
- data/vendor/symfony/polyfill-ctype/bootstrap.php +0 -50
- data/vendor/symfony/polyfill-ctype/bootstrap80.php +0 -46
- data/vendor/symfony/polyfill-ctype/composer.json +0 -41
- data/vendor/symfony/yaml/CHANGELOG.md +0 -237
- data/vendor/symfony/yaml/Command/LintCommand.php +0 -289
- data/vendor/symfony/yaml/Dumper.php +0 -140
- data/vendor/symfony/yaml/Escaper.php +0 -95
- data/vendor/symfony/yaml/Exception/DumpException.php +0 -21
- data/vendor/symfony/yaml/Exception/ExceptionInterface.php +0 -21
- data/vendor/symfony/yaml/Exception/ParseException.php +0 -132
- data/vendor/symfony/yaml/Exception/RuntimeException.php +0 -21
- data/vendor/symfony/yaml/Inline.php +0 -812
- data/vendor/symfony/yaml/LICENSE +0 -19
- data/vendor/symfony/yaml/Parser.php +0 -1305
- data/vendor/symfony/yaml/README.md +0 -13
- data/vendor/symfony/yaml/Resources/bin/yaml-lint +0 -45
- data/vendor/symfony/yaml/Tag/TaggedValue.php +0 -38
- data/vendor/symfony/yaml/Unescaper.php +0 -132
- data/vendor/symfony/yaml/Yaml.php +0 -100
- data/vendor/symfony/yaml/composer.json +0 -42
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: '018f6899e96462e2b912468946cc5c6291b3b29dafc4d7a1e6f7ba5c1d700446'
|
4
|
+
data.tar.gz: d2797874c09f30d40bf59b07677a41d650bf203b4ba55a71e5cd49127fa0a210
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: be2cde606853f1216e93ff0d1366705b6a43defd5b13df2ad1c9a37f32dc0ec1dbb894e87e89d1cfe36b22a59871c6a453a637f182cce475042b4a34334d08c9
|
7
|
+
data.tar.gz: c0b1ca167b40d9479044fa615b345057d9b398756e29fc2dad7ae0ae77c44f53bca5ab04b67c06b4e053387c77ac9735ac393a6d5e3ec76e226681ed7e8524e2
|
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.1.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.1.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.1.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.1.0'
|
57
57
|
|
58
58
|
### Install from Git
|
59
59
|
|
@@ -297,14 +297,31 @@ All URIs are relative to *https://api.hellosign.com/v3*
|
|
297
297
|
- [Dropbox::Sign::TemplateResponseAccount](docs/TemplateResponseAccount.md)
|
298
298
|
- [Dropbox::Sign::TemplateResponseAccountQuota](docs/TemplateResponseAccountQuota.md)
|
299
299
|
- [Dropbox::Sign::TemplateResponseCCRole](docs/TemplateResponseCCRole.md)
|
300
|
-
- [Dropbox::Sign::TemplateResponseCustomField](docs/TemplateResponseCustomField.md)
|
301
300
|
- [Dropbox::Sign::TemplateResponseDocument](docs/TemplateResponseDocument.md)
|
302
|
-
- [Dropbox::Sign::
|
301
|
+
- [Dropbox::Sign::TemplateResponseDocumentCustomFieldBase](docs/TemplateResponseDocumentCustomFieldBase.md)
|
302
|
+
- [Dropbox::Sign::TemplateResponseDocumentCustomFieldCheckbox](docs/TemplateResponseDocumentCustomFieldCheckbox.md)
|
303
|
+
- [Dropbox::Sign::TemplateResponseDocumentCustomFieldText](docs/TemplateResponseDocumentCustomFieldText.md)
|
303
304
|
- [Dropbox::Sign::TemplateResponseDocumentFieldGroup](docs/TemplateResponseDocumentFieldGroup.md)
|
304
|
-
- [Dropbox::Sign::
|
305
|
-
- [Dropbox::Sign::
|
305
|
+
- [Dropbox::Sign::TemplateResponseDocumentFieldGroupRule](docs/TemplateResponseDocumentFieldGroupRule.md)
|
306
|
+
- [Dropbox::Sign::TemplateResponseDocumentFormFieldBase](docs/TemplateResponseDocumentFormFieldBase.md)
|
307
|
+
- [Dropbox::Sign::TemplateResponseDocumentFormFieldCheckbox](docs/TemplateResponseDocumentFormFieldCheckbox.md)
|
308
|
+
- [Dropbox::Sign::TemplateResponseDocumentFormFieldDateSigned](docs/TemplateResponseDocumentFormFieldDateSigned.md)
|
309
|
+
- [Dropbox::Sign::TemplateResponseDocumentFormFieldDropdown](docs/TemplateResponseDocumentFormFieldDropdown.md)
|
310
|
+
- [Dropbox::Sign::TemplateResponseDocumentFormFieldHyperlink](docs/TemplateResponseDocumentFormFieldHyperlink.md)
|
311
|
+
- [Dropbox::Sign::TemplateResponseDocumentFormFieldInitials](docs/TemplateResponseDocumentFormFieldInitials.md)
|
312
|
+
- [Dropbox::Sign::TemplateResponseDocumentFormFieldRadio](docs/TemplateResponseDocumentFormFieldRadio.md)
|
313
|
+
- [Dropbox::Sign::TemplateResponseDocumentFormFieldSignature](docs/TemplateResponseDocumentFormFieldSignature.md)
|
314
|
+
- [Dropbox::Sign::TemplateResponseDocumentFormFieldText](docs/TemplateResponseDocumentFormFieldText.md)
|
315
|
+
- [Dropbox::Sign::TemplateResponseDocumentStaticFieldBase](docs/TemplateResponseDocumentStaticFieldBase.md)
|
316
|
+
- [Dropbox::Sign::TemplateResponseDocumentStaticFieldCheckbox](docs/TemplateResponseDocumentStaticFieldCheckbox.md)
|
317
|
+
- [Dropbox::Sign::TemplateResponseDocumentStaticFieldDateSigned](docs/TemplateResponseDocumentStaticFieldDateSigned.md)
|
318
|
+
- [Dropbox::Sign::TemplateResponseDocumentStaticFieldDropdown](docs/TemplateResponseDocumentStaticFieldDropdown.md)
|
319
|
+
- [Dropbox::Sign::TemplateResponseDocumentStaticFieldHyperlink](docs/TemplateResponseDocumentStaticFieldHyperlink.md)
|
320
|
+
- [Dropbox::Sign::TemplateResponseDocumentStaticFieldInitials](docs/TemplateResponseDocumentStaticFieldInitials.md)
|
321
|
+
- [Dropbox::Sign::TemplateResponseDocumentStaticFieldRadio](docs/TemplateResponseDocumentStaticFieldRadio.md)
|
322
|
+
- [Dropbox::Sign::TemplateResponseDocumentStaticFieldSignature](docs/TemplateResponseDocumentStaticFieldSignature.md)
|
323
|
+
- [Dropbox::Sign::TemplateResponseDocumentStaticFieldText](docs/TemplateResponseDocumentStaticFieldText.md)
|
306
324
|
- [Dropbox::Sign::TemplateResponseFieldAvgTextLength](docs/TemplateResponseFieldAvgTextLength.md)
|
307
|
-
- [Dropbox::Sign::TemplateResponseNamedFormField](docs/TemplateResponseNamedFormField.md)
|
308
325
|
- [Dropbox::Sign::TemplateResponseSignerRole](docs/TemplateResponseSignerRole.md)
|
309
326
|
- [Dropbox::Sign::TemplateUpdateFilesRequest](docs/TemplateUpdateFilesRequest.md)
|
310
327
|
- [Dropbox::Sign::TemplateUpdateFilesResponse](docs/TemplateUpdateFilesResponse.md)
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.1.0
|
data/bin/release
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
|
3
|
+
set -e
|
4
|
+
|
5
|
+
DIR=$(cd `dirname $0` && pwd)
|
6
|
+
ROOT_DIR="${DIR}/.."
|
7
|
+
|
8
|
+
PACKAGE_VERSION=$(cat "${ROOT_DIR}/VERSION")
|
9
|
+
|
10
|
+
echo "Building for release ${PACKAGE_VERSION}"
|
11
|
+
echo "---"
|
12
|
+
|
13
|
+
echo "Setting up gem credentials..."
|
14
|
+
set +x
|
15
|
+
mkdir -p ~/.gem
|
16
|
+
|
17
|
+
cat << EOF > ~/.gem/credentials
|
18
|
+
---
|
19
|
+
:rubygems_api_key: ${RUBYGEMS_API_KEY}
|
20
|
+
EOF
|
21
|
+
|
22
|
+
chmod 0600 ~/.gem/credentials
|
23
|
+
set -x
|
24
|
+
|
25
|
+
cd "${ROOT_DIR}"
|
26
|
+
|
27
|
+
echo "Installing dependencies..."
|
28
|
+
gem install bundler > /dev/null
|
29
|
+
bundle install > /dev/null
|
30
|
+
|
31
|
+
echo "Building..."
|
32
|
+
rm -rf pkg
|
33
|
+
rake build
|
34
|
+
|
35
|
+
echo "Pushing release"
|
36
|
+
gem push \
|
37
|
+
--config-file=~/.gem/credentials \
|
38
|
+
--key=rubygems \
|
39
|
+
./pkg/dropbox-sign-${PACKAGE_VERSION}.gem
|
data/bin/ruby
CHANGED
@@ -9,6 +9,7 @@ WORKING_DIR="/app/ruby"
|
|
9
9
|
docker run --rm \
|
10
10
|
-e GEM_HOME="/.gem-cache" \
|
11
11
|
-e BUNDLE_PATH="/.bundle-cache" \
|
12
|
+
-e RUBYGEMS_API_KEY=${RUBYGEMS_API_KEY-:''} \
|
12
13
|
-v "${ROOT_DIR}:${WORKING_DIR}" \
|
13
14
|
-v "dropbox-sign-sdk-gem-cache:/.gem-cache" \
|
14
15
|
-v "dropbox-sign-sdk-bundle-cache:/.bundle-cache" \
|
data/docs/BulkSendJobApi.md
CHANGED
@@ -10,7 +10,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
|
|
10
10
|
|
11
11
|
## `bulk_send_job_get`
|
12
12
|
|
13
|
-
> `<BulkSendJobGetResponse> bulk_send_job_get(bulk_send_job_id)`
|
13
|
+
> `<BulkSendJobGetResponse> bulk_send_job_get(bulk_send_job_id, opts)`
|
14
14
|
|
15
15
|
Get Bulk Send Job
|
16
16
|
|
@@ -46,12 +46,12 @@ end
|
|
46
46
|
|
47
47
|
This returns an Array which contains the response data, status code and headers.
|
48
48
|
|
49
|
-
> `<Array(<BulkSendJobGetResponse>, Integer, Hash)> bulk_send_job_get_with_http_info(bulk_send_job_id)`
|
49
|
+
> `<Array(<BulkSendJobGetResponse>, Integer, Hash)> bulk_send_job_get_with_http_info(bulk_send_job_id, opts)`
|
50
50
|
|
51
51
|
```ruby
|
52
52
|
begin
|
53
53
|
# Get Bulk Send Job
|
54
|
-
data, status_code, headers = api_instance.bulk_send_job_get_with_http_info(bulk_send_job_id)
|
54
|
+
data, status_code, headers = api_instance.bulk_send_job_get_with_http_info(bulk_send_job_id, opts)
|
55
55
|
p status_code # => 2xx
|
56
56
|
p headers # => { ... }
|
57
57
|
p data # => <BulkSendJobGetResponse>
|
@@ -65,6 +65,8 @@ end
|
|
65
65
|
| Name | Type | Description | Notes |
|
66
66
|
| ---- | ---- | ----------- | ----- |
|
67
67
|
| `bulk_send_job_id` | **String** | The id of the BulkSendJob to retrieve. | |
|
68
|
+
| `page` | **Integer** | Which page number of the BulkSendJob list to return. Defaults to `1`. | [optional][default to 1] |
|
69
|
+
| `page_size` | **Integer** | Number of objects to be returned per page. Must be between `1` and `100`. Default is 20. | [optional][default to 20] |
|
68
70
|
|
69
71
|
### Return type
|
70
72
|
|
data/docs/SignatureRequestApi.md
CHANGED
@@ -361,7 +361,7 @@ data.title = "NDA with Acme Co."
|
|
361
361
|
data.subject = "The NDA we talked about"
|
362
362
|
data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions."
|
363
363
|
data.signers = [signer_1, signer_2]
|
364
|
-
data.cc_email_addresses = ["
|
364
|
+
data.cc_email_addresses = ["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"]
|
365
365
|
data.files = [File.new("example_signature_request.pdf", "r")]
|
366
366
|
data.signing_options = signing_options
|
367
367
|
data.test_mode = true
|
@@ -1138,8 +1138,8 @@ data.subject = "The NDA we talked about"
|
|
1138
1138
|
data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions."
|
1139
1139
|
data.signers = [signer_1, signer_2]
|
1140
1140
|
data.cc_email_addresses = [
|
1141
|
-
"
|
1142
|
-
"
|
1141
|
+
"lawyer1@dropboxsign.com",
|
1142
|
+
"lawyer2@dropboxsign.com",
|
1143
1143
|
]
|
1144
1144
|
data.files = [File.new("example_signature_request.pdf", "r")]
|
1145
1145
|
data.metadata = {
|
@@ -19,7 +19,7 @@
|
|
19
19
|
| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | |
|
20
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
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. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here:
|
22
|
+
| `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. 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
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
24
|
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
|
25
25
|
| `metadata` | ```Hash<String, Object>``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.<br><br>Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
|
@@ -19,7 +19,7 @@
|
|
19
19
|
| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | |
|
20
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
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. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here:
|
22
|
+
| `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. 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
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
24
|
| `is_qualified_signature` | ```Boolean``` | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br><br>**Note**: QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
|
25
25
|
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# Dropbox::Sign::SubFormFieldsPerDocumentBase
|
2
2
|
|
3
|
-
The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here:
|
3
|
+
The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
|
4
4
|
|
5
5
|
**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.
|
6
6
|
|
data/docs/TeamResponse.md
CHANGED
@@ -9,4 +9,5 @@ Contains information about your team and its members
|
|
9
9
|
| `name` | ```String``` | The name of your Team | |
|
10
10
|
| `accounts` | [```Array<AccountResponse>```](AccountResponse.md) | | |
|
11
11
|
| `invited_accounts` | [```Array<AccountResponse>```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | |
|
12
|
+
| `invited_emails` | ```Array<String>``` | A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account. | |
|
12
13
|
|
@@ -19,7 +19,7 @@
|
|
19
19
|
| `force_subject_message` | ```Boolean``` | Provide users the ability to review/edit the template subject and message. | [default to false] |
|
20
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
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. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here:
|
22
|
+
| `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. 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
23
|
| `merge_fields` | [```Array<SubMergeField>```](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | |
|
24
24
|
| `message` | ```String``` | The default template email message. | |
|
25
25
|
| `metadata` | ```Hash<String, Object>``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.<br><br>Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
|
data/docs/TemplateResponse.md
CHANGED
@@ -18,7 +18,7 @@ Contains information about the templates you and your team have created.
|
|
18
18
|
| `signer_roles` | [```Array<TemplateResponseSignerRole>```](TemplateResponseSignerRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | |
|
19
19
|
| `cc_roles` | [```Array<TemplateResponseCCRole>```](TemplateResponseCCRole.md) | An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template. | |
|
20
20
|
| `documents` | [```Array<TemplateResponseDocument>```](TemplateResponseDocument.md) | An array describing each document associated with this Template. Includes form field data for each document. | |
|
21
|
-
| `custom_fields` | [```Array<
|
22
|
-
| `named_form_fields` | [```Array<
|
21
|
+
| `custom_fields` | [```Array<TemplateResponseDocumentCustomFieldBase>```](TemplateResponseDocumentCustomFieldBase.md) | Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | |
|
22
|
+
| `named_form_fields` | [```Array<TemplateResponseDocumentFormFieldBase>```](TemplateResponseDocumentFormFieldBase.md) | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | |
|
23
23
|
| `accounts` | [```Array<TemplateResponseAccount>```](TemplateResponseAccount.md) | An array of the Accounts that can use this Template. | |
|
24
24
|
|
@@ -9,7 +9,7 @@
|
|
9
9
|
| `name` | ```String``` | Name of the associated file. | |
|
10
10
|
| `index` | ```Integer``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | |
|
11
11
|
| `field_groups` | [```Array<TemplateResponseDocumentFieldGroup>```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | |
|
12
|
-
| `form_fields` | [```Array<
|
13
|
-
| `custom_fields` | [```Array<
|
14
|
-
| `static_fields` | [```Array<
|
12
|
+
| `form_fields` | [```Array<TemplateResponseDocumentFormFieldBase>```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | |
|
13
|
+
| `custom_fields` | [```Array<TemplateResponseDocumentCustomFieldBase>```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | |
|
14
|
+
| `static_fields` | [```Array<TemplateResponseDocumentStaticFieldBase>```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **Note** only available for certain subscriptions. | |
|
15
15
|
|
@@ -1,22 +1,20 @@
|
|
1
|
-
# Dropbox::Sign::
|
2
|
-
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentCustomFieldBase
|
3
2
|
|
3
|
+
An array of Form Field objects containing the name and type of each named field.
|
4
4
|
|
5
5
|
## Properties
|
6
6
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | | |
|
10
|
+
| `api_id` | ```String``` | The unique ID for this field. | |
|
9
11
|
| `name` | ```String``` | The name of the Custom Field. | |
|
10
|
-
| `
|
12
|
+
| `signer` | ```String``` | The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender). | |
|
11
13
|
| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | |
|
12
14
|
| `y` | ```Integer``` | The vertical offset in pixels for this form field. | |
|
13
15
|
| `width` | ```Integer``` | The width in pixels of this form field. | |
|
14
16
|
| `height` | ```Integer``` | The height in pixels of this form field. | |
|
15
17
|
| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | |
|
16
|
-
| `api_id` | ```String``` | The unique ID for this field. | |
|
17
18
|
| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | |
|
18
|
-
| `
|
19
|
-
| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | |
|
20
|
-
| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | |
|
21
|
-
| `font_family` | ```String``` | Font family used in this form field's text. | |
|
19
|
+
| `font_size` | ```Integer``` | Final font size used by this form field. | |
|
22
20
|
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentCustomFieldCheckbox
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentCustomFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.<br><br>* Text uses `TemplateResponseDocumentCustomFieldText`<br>* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'checkbox'] |
|
10
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentCustomFieldText
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentCustomFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.<br><br>* Text uses `TemplateResponseDocumentCustomFieldText`<br>* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | [default to 'text'] |
|
10
|
+
| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
|
11
|
+
| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | |
|
12
|
+
| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | |
|
13
|
+
| `font_family` | ```String``` | Font family used in this form field's text. | |
|
14
|
+
|
@@ -7,5 +7,5 @@
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
9
|
| `name` | ```String``` | The name of the form field group. | |
|
10
|
-
| `rule` | ```
|
10
|
+
| `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | |
|
11
11
|
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFieldGroupRule
|
2
|
+
|
3
|
+
The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `requirement` | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`<br><br>- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | |
|
10
|
+
| `group_label` | ```String``` | Name of the group | |
|
11
|
+
|
@@ -1,23 +1,20 @@
|
|
1
|
-
# Dropbox::Sign::
|
2
|
-
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFormFieldBase
|
3
2
|
|
3
|
+
An array of Form Field objects containing the name and type of each named field.
|
4
4
|
|
5
5
|
## Properties
|
6
6
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | | |
|
9
10
|
| `api_id` | ```String``` | A unique id for the form field. | |
|
10
11
|
| `name` | ```String``` | The name of the form field. | |
|
11
|
-
| `type` | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types). | |
|
12
12
|
| `signer` | ```String``` | The signer of the Form Field. | |
|
13
13
|
| `x` | ```Integer``` | The horizontal offset in pixels for this form field. | |
|
14
14
|
| `y` | ```Integer``` | The vertical offset in pixels for this form field. | |
|
15
15
|
| `width` | ```Integer``` | The width in pixels of this form field. | |
|
16
16
|
| `height` | ```Integer``` | The height in pixels of this form field. | |
|
17
17
|
| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | |
|
18
|
-
| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null
|
19
|
-
| `
|
20
|
-
| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | |
|
21
|
-
| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | |
|
22
|
-
| `font_family` | ```String``` | Font family used in this form field's text. | |
|
18
|
+
| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields. | |
|
19
|
+
| `font_size` | ```Integer``` | Final font size used by this form field. | |
|
23
20
|
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFormFieldCheckbox
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentFormFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'checkbox'] |
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFormFieldDateSigned
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentFormFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'date_signed'] |
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFormFieldDropdown
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentFormFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'dropdown'] |
|
10
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFormFieldHyperlink
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentFormFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'hyperlink'] |
|
10
|
+
| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
|
11
|
+
| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | |
|
12
|
+
| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | |
|
13
|
+
| `font_family` | ```String``` | Font family used in this form field's text. | |
|
14
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFormFieldInitials
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentFormFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'initials'] |
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFormFieldRadio
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentFormFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'radio'] |
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFormFieldSignature
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentFormFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'signature'] |
|
10
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentFormFieldText
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentFormFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials` | [default to 'text'] |
|
10
|
+
| `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
|
11
|
+
| `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | |
|
12
|
+
| `original_font_size` | ```Integer``` | Original font size used in this form field's text. | |
|
13
|
+
| `font_family` | ```String``` | Font family used in this form field's text. | |
|
14
|
+
| `validation_type` | ```String``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. | |
|
15
|
+
|
data/docs/{TemplateResponseDocumentStaticField.md → TemplateResponseDocumentStaticFieldBase.md}
RENAMED
@@ -1,19 +1,20 @@
|
|
1
|
-
# Dropbox::Sign::
|
2
|
-
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentStaticFieldBase
|
3
2
|
|
3
|
+
An array describing static overlay fields. **Note** only available for certain subscriptions.
|
4
4
|
|
5
5
|
## Properties
|
6
6
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | | |
|
10
|
+
| `api_id` | ```String``` | A unique id for the static field. | |
|
9
11
|
| `name` | ```String``` | The name of the static field. | |
|
10
|
-
| `
|
11
|
-
| `signer` | ```String``` | The signer of the Static Field. | |
|
12
|
+
| `signer` | ```String``` | The signer of the Static Field. | [default to 'me_now'] |
|
12
13
|
| `x` | ```Integer``` | The horizontal offset in pixels for this static field. | |
|
13
14
|
| `y` | ```Integer``` | The vertical offset in pixels for this static field. | |
|
14
15
|
| `width` | ```Integer``` | The width in pixels of this static field. | |
|
15
16
|
| `height` | ```Integer``` | The height in pixels of this static field. | |
|
16
17
|
| `required` | ```Boolean``` | Boolean showing whether or not this field is required. | |
|
17
|
-
| `api_id` | ```String``` | A unique id for the static field. | |
|
18
18
|
| `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | |
|
19
|
+
| `font_size` | ```Integer``` | Final font size used by this form field. | |
|
19
20
|
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentStaticFieldCheckbox
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentStaticFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentStaticFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'checkbox'] |
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentStaticFieldDateSigned
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentStaticFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentStaticFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'date_signed'] |
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentStaticFieldDropdown
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentStaticFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentStaticFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'dropdown'] |
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentStaticFieldHyperlink
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentStaticFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentStaticFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'hyperlink'] |
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Dropbox::Sign::TemplateResponseDocumentStaticFieldInitials
|
2
|
+
|
3
|
+
This class extends `TemplateResponseDocumentStaticFieldBase`
|
4
|
+
|
5
|
+
## Properties
|
6
|
+
|
7
|
+
| Name | Type | Description | Notes |
|
8
|
+
| ---- | ---- | ----------- | ----- |
|
9
|
+
| `type`<sup>*_required_</sup> | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentStaticFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'initials'] |
|
10
|
+
|