dropbox-sign 1.0.0.pre.beta2301 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +7 -9
- data/VERSION +1 -0
- data/bin/check-clean-git-status +15 -0
- data/bin/release +39 -0
- data/bin/ruby +1 -0
- 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/TemplateCreateEmbeddedDraftRequest.md +1 -1
- data/docs/UnclaimedDraftApi.md +2 -2
- data/docs/UnclaimedDraftCreateEmbeddedRequest.md +1 -1
- data/docs/UnclaimedDraftCreateRequest.md +1 -1
- data/examples/EventCallback.rb +1 -4
- data/examples/SignatureRequestCreateEmbedded.rb +1 -1
- data/examples/SignatureRequestSend.rb +2 -2
- data/examples/UnclaimedDraftCreate.rb +2 -2
- data/lib/dropbox-sign/models/account_create_request.rb +4 -0
- data/lib/dropbox-sign/models/account_create_response.rb +3 -0
- data/lib/dropbox-sign/models/account_get_response.rb +2 -0
- data/lib/dropbox-sign/models/account_response.rb +10 -0
- data/lib/dropbox-sign/models/account_response_quotas.rb +5 -0
- data/lib/dropbox-sign/models/account_update_request.rb +3 -0
- data/lib/dropbox-sign/models/account_verify_request.rb +1 -0
- data/lib/dropbox-sign/models/account_verify_response.rb +2 -0
- data/lib/dropbox-sign/models/account_verify_response_account.rb +1 -0
- data/lib/dropbox-sign/models/api_app_create_request.rb +7 -0
- data/lib/dropbox-sign/models/api_app_get_response.rb +2 -0
- data/lib/dropbox-sign/models/api_app_list_response.rb +3 -0
- data/lib/dropbox-sign/models/api_app_response.rb +10 -0
- data/lib/dropbox-sign/models/api_app_response_o_auth.rb +4 -0
- data/lib/dropbox-sign/models/api_app_response_options.rb +1 -0
- data/lib/dropbox-sign/models/api_app_response_owner_account.rb +2 -0
- data/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb +14 -0
- data/lib/dropbox-sign/models/api_app_update_request.rb +7 -0
- data/lib/dropbox-sign/models/bulk_send_job_get_response.rb +4 -0
- data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +24 -0
- data/lib/dropbox-sign/models/bulk_send_job_list_response.rb +3 -0
- data/lib/dropbox-sign/models/bulk_send_job_response.rb +4 -0
- data/lib/dropbox-sign/models/bulk_send_job_send_response.rb +2 -0
- data/lib/dropbox-sign/models/embedded_edit_url_request.rb +10 -0
- data/lib/dropbox-sign/models/embedded_edit_url_response.rb +2 -0
- data/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb +2 -0
- data/lib/dropbox-sign/models/embedded_sign_url_response.rb +2 -0
- data/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb +2 -0
- data/lib/dropbox-sign/models/error_response.rb +1 -0
- data/lib/dropbox-sign/models/error_response_error.rb +3 -0
- data/lib/dropbox-sign/models/event_callback_request.rb +4 -0
- data/lib/dropbox-sign/models/event_callback_request_event.rb +4 -0
- data/lib/dropbox-sign/models/event_callback_request_event_metadata.rb +4 -0
- data/lib/dropbox-sign/models/file_response.rb +2 -0
- data/lib/dropbox-sign/models/file_response_data_uri.rb +1 -0
- data/lib/dropbox-sign/models/list_info_response.rb +4 -0
- data/lib/dropbox-sign/models/o_auth_token_generate_request.rb +5 -0
- data/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +2 -0
- data/lib/dropbox-sign/models/o_auth_token_response.rb +5 -0
- data/lib/dropbox-sign/models/report_create_request.rb +3 -0
- data/lib/dropbox-sign/models/report_create_response.rb +2 -0
- data/lib/dropbox-sign/models/report_response.rb +4 -0
- data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +13 -0
- data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +13 -0
- data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +25 -1
- data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +15 -0
- data/lib/dropbox-sign/models/signature_request_get_response.rb +2 -0
- data/lib/dropbox-sign/models/signature_request_list_response.rb +3 -0
- data/lib/dropbox-sign/models/signature_request_remind_request.rb +2 -0
- data/lib/dropbox-sign/models/signature_request_response.rb +23 -0
- data/lib/dropbox-sign/models/signature_request_response_attachment.rb +6 -0
- data/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb +5 -0
- data/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb +2 -0
- data/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb +2 -0
- data/lib/dropbox-sign/models/signature_request_response_data_base.rb +5 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb +2 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb +2 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb +2 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb +2 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb +2 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb +2 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb +2 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_text.rb +2 -0
- data/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb +2 -0
- data/lib/dropbox-sign/models/signature_request_response_signatures.rb +19 -0
- data/lib/dropbox-sign/models/signature_request_send_request.rb +26 -1
- data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +16 -0
- data/lib/dropbox-sign/models/signature_request_update_request.rb +4 -0
- data/lib/dropbox-sign/models/sub_attachment.rb +4 -0
- data/lib/dropbox-sign/models/sub_bulk_signer_list.rb +2 -0
- data/lib/dropbox-sign/models/sub_bulk_signer_list_custom_field.rb +2 -0
- data/lib/dropbox-sign/models/sub_cc.rb +2 -0
- data/lib/dropbox-sign/models/sub_custom_field.rb +4 -0
- data/lib/dropbox-sign/models/sub_editor_options.rb +2 -0
- data/lib/dropbox-sign/models/sub_field_options.rb +1 -0
- data/lib/dropbox-sign/models/sub_form_field_group.rb +3 -0
- data/lib/dropbox-sign/models/sub_form_field_rule.rb +4 -0
- data/lib/dropbox-sign/models/sub_form_field_rule_action.rb +4 -0
- data/lib/dropbox-sign/models/sub_form_field_rule_trigger.rb +4 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +12 -1
- data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb +3 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox_merge.rb +1 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +1 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +3 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +3 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_initials.rb +1 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_radio.rb +3 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_signature.rb +1 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +8 -0
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +1 -0
- data/lib/dropbox-sign/models/sub_merge_field.rb +2 -0
- data/lib/dropbox-sign/models/sub_o_auth.rb +2 -0
- data/lib/dropbox-sign/models/sub_options.rb +1 -0
- data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +3 -0
- data/lib/dropbox-sign/models/sub_signature_request_signer.rb +6 -0
- data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +6 -0
- data/lib/dropbox-sign/models/sub_signing_options.rb +5 -0
- data/lib/dropbox-sign/models/sub_team_response.rb +2 -0
- data/lib/dropbox-sign/models/sub_template_role.rb +2 -0
- data/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb +3 -0
- data/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb +3 -0
- data/lib/dropbox-sign/models/sub_white_labeling_options.rb +15 -0
- data/lib/dropbox-sign/models/team_add_member_request.rb +3 -0
- data/lib/dropbox-sign/models/team_create_request.rb +1 -0
- data/lib/dropbox-sign/models/team_get_info_response.rb +2 -0
- data/lib/dropbox-sign/models/team_get_response.rb +2 -0
- data/lib/dropbox-sign/models/team_info_response.rb +5 -0
- data/lib/dropbox-sign/models/team_invite_response.rb +6 -0
- data/lib/dropbox-sign/models/team_invites_response.rb +2 -0
- data/lib/dropbox-sign/models/team_member_response.rb +3 -0
- data/lib/dropbox-sign/models/team_members_response.rb +3 -0
- data/lib/dropbox-sign/models/team_parent_response.rb +2 -0
- data/lib/dropbox-sign/models/team_remove_member_request.rb +5 -0
- data/lib/dropbox-sign/models/team_response.rb +3 -0
- data/lib/dropbox-sign/models/team_sub_teams_response.rb +3 -0
- data/lib/dropbox-sign/models/team_update_request.rb +1 -0
- data/lib/dropbox-sign/models/template_add_user_request.rb +3 -0
- data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +26 -1
- data/lib/dropbox-sign/models/template_create_embedded_draft_response.rb +2 -0
- data/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb +4 -0
- data/lib/dropbox-sign/models/template_edit_response.rb +1 -0
- data/lib/dropbox-sign/models/template_get_response.rb +2 -0
- data/lib/dropbox-sign/models/template_list_response.rb +3 -0
- data/lib/dropbox-sign/models/template_remove_user_request.rb +2 -0
- data/lib/dropbox-sign/models/template_response.rb +15 -0
- data/lib/dropbox-sign/models/template_response_account.rb +6 -0
- data/lib/dropbox-sign/models/template_response_account_quota.rb +4 -0
- data/lib/dropbox-sign/models/template_response_cc_role.rb +1 -0
- data/lib/dropbox-sign/models/template_response_custom_field.rb +13 -0
- data/lib/dropbox-sign/models/template_response_document.rb +6 -0
- data/lib/dropbox-sign/models/template_response_document_custom_field.rb +16 -0
- data/lib/dropbox-sign/models/template_response_document_field_group.rb +2 -0
- data/lib/dropbox-sign/models/template_response_document_form_field.rb +14 -0
- data/lib/dropbox-sign/models/template_response_document_static_field.rb +10 -0
- data/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +2 -0
- data/lib/dropbox-sign/models/template_response_named_form_field.rb +14 -0
- data/lib/dropbox-sign/models/template_response_signer_role.rb +2 -0
- data/lib/dropbox-sign/models/template_update_files_request.rb +6 -0
- data/lib/dropbox-sign/models/template_update_files_response.rb +1 -0
- data/lib/dropbox-sign/models/template_update_files_response_template.rb +2 -0
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +37 -1
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +29 -0
- data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +25 -1
- data/lib/dropbox-sign/models/unclaimed_draft_create_response.rb +2 -0
- data/lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb +8 -0
- data/lib/dropbox-sign/models/unclaimed_draft_response.rb +6 -0
- data/lib/dropbox-sign/models/warning_response.rb +2 -0
- data/lib/dropbox-sign/version.rb +1 -1
- data/openapi-config.yaml +6 -1
- data/openapi-sdk.yaml +7 -10
- data/spec/models/sub_form_fields_per_document_base_spec.rb +24 -0
- data/templates/README.mustache +3 -5
- data/templates/VERSION-root.mustache +1 -0
- data/templates/partial_model_generic.mustache +1 -0
- metadata +17 -56
- 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: 5cd9c2abe6acfbf4366ab760fe1eb3dfc94f79c75fce22c6d83e0112ef56431a
|
4
|
+
data.tar.gz: 3bc5f3fb30ccf70c05ba6836dc91bfa6aaa77e9e7867138c5d77bbf3868820c4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 20cec127dfa5530e7e52048d540729675586ef0c7d4698bc57353b62dee0a8eda3a8a6b95207d05dcd145b43dd2583749d93e6b78729a3b49a7070b0e271f10e
|
7
|
+
data.tar.gz: fdb5a6cd0d8b0bd8b40542548e6e38484fdad170ddebe24493f330174f9faea0c84df482b5b71dc36706df1b7fc1544c487b63ccd38e4588067d96bd03dedb47
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -6,7 +6,7 @@ Dropbox Sign v3 API
|
|
6
6
|
|
7
7
|
## Migrating from legacy SDK
|
8
8
|
|
9
|
-
This SDK is generated from our officially maintained [OpenAPI spec](https://github.com/hellosign/hellosign-openapi/blob/
|
9
|
+
This SDK is generated from our officially maintained [OpenAPI spec](https://github.com/hellosign/hellosign-openapi/blob/main/openapi.yaml).
|
10
10
|
We've made important updates that introduce new functionality and create feature parity between the Dropbox Sign API and the SDK.
|
11
11
|
However, some of these changes are considered "breaking" in the sense that they'll require you to update your existing code in order to continue using the SDK.
|
12
12
|
Please refer to this [migration guide](https://developers.hellosign.com/docs/sdks/ruby/migration-guide/) for more information.
|
@@ -25,14 +25,14 @@ 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.0.
|
28
|
+
- Package version: 1.0.1
|
29
29
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
30
30
|
|
31
31
|
## Installation
|
32
32
|
|
33
33
|
### Install gem
|
34
34
|
```shell
|
35
|
-
gem install dropbox-sign
|
35
|
+
gem install dropbox-sign
|
36
36
|
```
|
37
37
|
|
38
38
|
### Build a gem
|
@@ -43,19 +43,17 @@ To build the Ruby code into a gem:
|
|
43
43
|
gem build dropbox-sign.gemspec
|
44
44
|
```
|
45
45
|
|
46
|
-
Then
|
46
|
+
Then install the gem locally:
|
47
47
|
|
48
48
|
```shell
|
49
|
-
gem install ./dropbox-sign-1.0.
|
49
|
+
gem install ./dropbox-sign-1.0.1.gem
|
50
50
|
```
|
51
51
|
|
52
|
-
(for development, run `gem install --dev ./dropbox-sign-1.0.
|
53
|
-
|
54
|
-
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
52
|
+
(for development, run `gem install --dev ./dropbox-sign-1.0.1.gem` to install the development dependencies)
|
55
53
|
|
56
54
|
Finally add this to the Gemfile:
|
57
55
|
|
58
|
-
gem 'dropbox-sign', '~> 1.0.
|
56
|
+
gem 'dropbox-sign', '~> 1.0.1'
|
59
57
|
|
60
58
|
### Install from Git
|
61
59
|
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.0.1
|
@@ -0,0 +1,15 @@
|
|
1
|
+
#!/usr/bin/env bash
|
2
|
+
|
3
|
+
if [[ $(git status --porcelain) != '' ]]; then
|
4
|
+
printf "Working directory is dirty.\n";
|
5
|
+
printf "Please check that you committed any changes after running.\n"
|
6
|
+
printf "You may need to rebuild the SDK by running:\n";
|
7
|
+
printf "\t./run-build\n"
|
8
|
+
|
9
|
+
git status
|
10
|
+
|
11
|
+
exit 1
|
12
|
+
else
|
13
|
+
echo "Working directory is clean!"
|
14
|
+
exit 0
|
15
|
+
fi
|
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/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
|
|
@@ -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/UnclaimedDraftApi.md
CHANGED
@@ -59,8 +59,8 @@ data.type = "request_signature"
|
|
59
59
|
data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions."
|
60
60
|
data.signers = [signer_1, signer_2]
|
61
61
|
data.cc_email_addresses = [
|
62
|
-
"
|
63
|
-
"
|
62
|
+
"lawyer1@dropboxsign.com",
|
63
|
+
"lawyer2@dropboxsign.com",
|
64
64
|
]
|
65
65
|
data.files = [File.new("example_signature_request.pdf", "r")]
|
66
66
|
data.metadata = {
|
@@ -22,7 +22,7 @@
|
|
22
22
|
| `force_subject_message` | ```Boolean``` | Provide users the ability to review/edit the subject and message. | [default to false] |
|
23
23
|
| `form_field_groups` | [```Array<SubFormFieldGroup>```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | |
|
24
24
|
| `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
|
25
|
-
| `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here:
|
25
|
+
| `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` | |
|
26
26
|
| `hide_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [default to false] |
|
27
27
|
| `hold_request` | ```Boolean``` | The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`. | [default to false] |
|
28
28
|
| `is_for_embedded_signing` | ```Boolean``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [default to false] |
|
@@ -17,7 +17,7 @@
|
|
17
17
|
| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | |
|
18
18
|
| `form_field_groups` | [```Array<SubFormFieldGroup>```](SubFormFieldGroup.md) | Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`. | |
|
19
19
|
| `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
|
20
|
-
| `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here:
|
20
|
+
| `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` | |
|
21
21
|
| `hide_text_tags` | ```Boolean``` | Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details. | [default to false] |
|
22
22
|
| `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
|
23
23
|
| `metadata` | ```Hash<String, Object>``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.<br><br>Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | |
|
data/examples/EventCallback.rb
CHANGED
@@ -18,10 +18,7 @@ callback_data = {
|
|
18
18
|
},
|
19
19
|
}
|
20
20
|
|
21
|
-
callback_event = Dropbox::Sign::
|
22
|
-
callback_data,
|
23
|
-
"Dropbox::Sign::EventCallbackRequest"
|
24
|
-
) || Dropbox::Sign::EventCallbackRequest.new
|
21
|
+
callback_event = Dropbox::Sign::EventCallbackRequest.init(callback_data)
|
25
22
|
|
26
23
|
# verify that a callback came from HelloSign.com
|
27
24
|
if Dropbox::Sign::EventCallbackHelper.is_valid(api_key, callback_event)
|
@@ -33,7 +33,7 @@ data.title = "NDA with Acme Co."
|
|
33
33
|
data.subject = "The NDA we talked about"
|
34
34
|
data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions."
|
35
35
|
data.signers = [signer_1, signer_2]
|
36
|
-
data.cc_email_addresses = ["
|
36
|
+
data.cc_email_addresses = ["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"]
|
37
37
|
data.files = [File.new("example_signature_request.pdf", "r")]
|
38
38
|
data.signing_options = signing_options
|
39
39
|
data.test_mode = true
|
@@ -36,8 +36,8 @@ data.subject = "The NDA we talked about"
|
|
36
36
|
data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions."
|
37
37
|
data.signers = [signer_1, signer_2]
|
38
38
|
data.cc_email_addresses = [
|
39
|
-
"
|
40
|
-
"
|
39
|
+
"lawyer1@dropboxsign.com",
|
40
|
+
"lawyer2@dropboxsign.com",
|
41
41
|
]
|
42
42
|
data.files = [File.new("example_signature_request.pdf", "r")]
|
43
43
|
data.metadata = {
|
@@ -36,8 +36,8 @@ data.type = "request_signature"
|
|
36
36
|
data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions."
|
37
37
|
data.signers = [signer_1, signer_2]
|
38
38
|
data.cc_email_addresses = [
|
39
|
-
"
|
40
|
-
"
|
39
|
+
"lawyer1@dropboxsign.com",
|
40
|
+
"lawyer2@dropboxsign.com",
|
41
41
|
]
|
42
42
|
data.files = [File.new("example_signature_request.pdf", "r")]
|
43
43
|
data.metadata = {
|
@@ -19,15 +19,19 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class AccountCreateRequest
|
21
21
|
# The email address which will be associated with the new Account.
|
22
|
+
# @return [String]
|
22
23
|
attr_accessor :email_address
|
23
24
|
|
24
25
|
# Used when creating a new account with OAuth authorization. See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)
|
26
|
+
# @return [String]
|
25
27
|
attr_accessor :client_id
|
26
28
|
|
27
29
|
# Used when creating a new account with OAuth authorization. See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)
|
30
|
+
# @return [String]
|
28
31
|
attr_accessor :client_secret
|
29
32
|
|
30
33
|
# The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.
|
34
|
+
# @return [String]
|
31
35
|
attr_accessor :locale
|
32
36
|
|
33
37
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -18,11 +18,14 @@ end
|
|
18
18
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class AccountCreateResponse
|
21
|
+
# @return [AccountResponse]
|
21
22
|
attr_accessor :account
|
22
23
|
|
24
|
+
# @return [OAuthTokenResponse]
|
23
25
|
attr_accessor :oauth_data
|
24
26
|
|
25
27
|
# A list of warnings.
|
28
|
+
# @return [Array<WarningResponse>]
|
26
29
|
attr_accessor :warnings
|
27
30
|
|
28
31
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -18,9 +18,11 @@ end
|
|
18
18
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class AccountGetResponse
|
21
|
+
# @return [AccountResponse]
|
21
22
|
attr_accessor :account
|
22
23
|
|
23
24
|
# A list of warnings.
|
25
|
+
# @return [Array<WarningResponse>]
|
24
26
|
attr_accessor :warnings
|
25
27
|
|
26
28
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,32 +19,42 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class AccountResponse
|
21
21
|
# The ID of the Account
|
22
|
+
# @return [String]
|
22
23
|
attr_accessor :account_id
|
23
24
|
|
24
25
|
# The email address associated with the Account.
|
26
|
+
# @return [String]
|
25
27
|
attr_accessor :email_address
|
26
28
|
|
27
29
|
# Returns `true` if the user has been locked out of their account by a team admin.
|
30
|
+
# @return [Boolean]
|
28
31
|
attr_accessor :is_locked
|
29
32
|
|
30
33
|
# Returns `true` if the user has a paid Dropbox Sign account.
|
34
|
+
# @return [Boolean]
|
31
35
|
attr_accessor :is_paid_hs
|
32
36
|
|
33
37
|
# Returns `true` if the user has a paid HelloFax account.
|
38
|
+
# @return [Boolean]
|
34
39
|
attr_accessor :is_paid_hf
|
35
40
|
|
41
|
+
# @return [AccountResponseQuotas]
|
36
42
|
attr_accessor :quotas
|
37
43
|
|
38
44
|
# The URL that Dropbox Sign events will `POST` to.
|
45
|
+
# @return [String, nil]
|
39
46
|
attr_accessor :callback_url
|
40
47
|
|
41
48
|
# The membership role for the team.
|
49
|
+
# @return [String, nil]
|
42
50
|
attr_accessor :role_code
|
43
51
|
|
44
52
|
# The id of the team account belongs to.
|
53
|
+
# @return [String, nil]
|
45
54
|
attr_accessor :team_id
|
46
55
|
|
47
56
|
# The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.
|
57
|
+
# @return [String, nil]
|
48
58
|
attr_accessor :locale
|
49
59
|
|
50
60
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -20,18 +20,23 @@ module Dropbox::Sign
|
|
20
20
|
# Details concerning remaining monthly quotas.
|
21
21
|
class AccountResponseQuotas
|
22
22
|
# API signature requests remaining.
|
23
|
+
# @return [Integer, nil]
|
23
24
|
attr_accessor :api_signature_requests_left
|
24
25
|
|
25
26
|
# Signature requests remaining.
|
27
|
+
# @return [Integer, nil]
|
26
28
|
attr_accessor :documents_left
|
27
29
|
|
28
30
|
# Total API templates allowed.
|
31
|
+
# @return [Integer, nil]
|
29
32
|
attr_accessor :templates_total
|
30
33
|
|
31
34
|
# API templates remaining.
|
35
|
+
# @return [Integer, nil]
|
32
36
|
attr_accessor :templates_left
|
33
37
|
|
34
38
|
# SMS verifications remaining.
|
39
|
+
# @return [Integer, nil]
|
35
40
|
attr_accessor :sms_verifications_left
|
36
41
|
|
37
42
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,12 +19,15 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class AccountUpdateRequest
|
21
21
|
# The ID of the Account
|
22
|
+
# @return [String, nil]
|
22
23
|
attr_accessor :account_id
|
23
24
|
|
24
25
|
# The URL that Dropbox Sign should POST events to.
|
26
|
+
# @return [String]
|
25
27
|
attr_accessor :callback_url
|
26
28
|
|
27
29
|
# The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.
|
30
|
+
# @return [String]
|
28
31
|
attr_accessor :locale
|
29
32
|
|
30
33
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -18,9 +18,11 @@ end
|
|
18
18
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class AccountVerifyResponse
|
21
|
+
# @return [AccountVerifyResponseAccount]
|
21
22
|
attr_accessor :account
|
22
23
|
|
23
24
|
# A list of warnings.
|
25
|
+
# @return [Array<WarningResponse>]
|
24
26
|
attr_accessor :warnings
|
25
27
|
|
26
28
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,21 +19,28 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class ApiAppCreateRequest
|
21
21
|
# The domain names the ApiApp will be associated with.
|
22
|
+
# @return [Array<String>]
|
22
23
|
attr_accessor :domains
|
23
24
|
|
24
25
|
# The name you want to assign to the ApiApp.
|
26
|
+
# @return [String]
|
25
27
|
attr_accessor :name
|
26
28
|
|
27
29
|
# The URL at which the ApiApp should receive event callbacks.
|
30
|
+
# @return [String]
|
28
31
|
attr_accessor :callback_url
|
29
32
|
|
30
33
|
# An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)
|
34
|
+
# @return [File]
|
31
35
|
attr_accessor :custom_logo_file
|
32
36
|
|
37
|
+
# @return [SubOAuth]
|
33
38
|
attr_accessor :oauth
|
34
39
|
|
40
|
+
# @return [SubOptions]
|
35
41
|
attr_accessor :options
|
36
42
|
|
43
|
+
# @return [SubWhiteLabelingOptions]
|
37
44
|
attr_accessor :white_labeling_options
|
38
45
|
|
39
46
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -18,9 +18,11 @@ end
|
|
18
18
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class ApiAppGetResponse
|
21
|
+
# @return [ApiAppResponse]
|
21
22
|
attr_accessor :api_app
|
22
23
|
|
23
24
|
# A list of warnings.
|
25
|
+
# @return [Array<WarningResponse>]
|
24
26
|
attr_accessor :warnings
|
25
27
|
|
26
28
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,11 +19,14 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class ApiAppListResponse
|
21
21
|
# Contains information about API Apps.
|
22
|
+
# @return [Array<ApiAppResponse>]
|
22
23
|
attr_accessor :api_apps
|
23
24
|
|
25
|
+
# @return [ListInfoResponse]
|
24
26
|
attr_accessor :list_info
|
25
27
|
|
26
28
|
# A list of warnings.
|
29
|
+
# @return [Array<WarningResponse>]
|
27
30
|
attr_accessor :warnings
|
28
31
|
|
29
32
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -20,29 +20,39 @@ module Dropbox::Sign
|
|
20
20
|
# Contains information about an API App.
|
21
21
|
class ApiAppResponse
|
22
22
|
# The app's callback URL (for events)
|
23
|
+
# @return [String, nil]
|
23
24
|
attr_accessor :callback_url
|
24
25
|
|
25
26
|
# The app's client id
|
27
|
+
# @return [String]
|
26
28
|
attr_accessor :client_id
|
27
29
|
|
28
30
|
# The time that the app was created
|
31
|
+
# @return [Integer]
|
29
32
|
attr_accessor :created_at
|
30
33
|
|
31
34
|
# The domain name(s) associated with the app
|
35
|
+
# @return [Array<String>]
|
32
36
|
attr_accessor :domains
|
33
37
|
|
34
38
|
# The name of the app
|
39
|
+
# @return [String]
|
35
40
|
attr_accessor :name
|
36
41
|
|
37
42
|
# Boolean to indicate if the app has been approved
|
43
|
+
# @return [Boolean]
|
38
44
|
attr_accessor :is_approved
|
39
45
|
|
46
|
+
# @return [ApiAppResponseOAuth, nil]
|
40
47
|
attr_accessor :oauth
|
41
48
|
|
49
|
+
# @return [ApiAppResponseOptions, nil]
|
42
50
|
attr_accessor :options
|
43
51
|
|
52
|
+
# @return [ApiAppResponseOwnerAccount]
|
44
53
|
attr_accessor :owner_account
|
45
54
|
|
55
|
+
# @return [ApiAppResponseWhiteLabelingOptions, nil]
|
46
56
|
attr_accessor :white_labeling_options
|
47
57
|
|
48
58
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -20,15 +20,19 @@ module Dropbox::Sign
|
|
20
20
|
# An object describing the app's OAuth properties, or null if OAuth is not configured for the app.
|
21
21
|
class ApiAppResponseOAuth
|
22
22
|
# The app's OAuth callback URL.
|
23
|
+
# @return [String]
|
23
24
|
attr_accessor :callback_url
|
24
25
|
|
25
26
|
# The app's OAuth secret, or null if the app does not belong to user.
|
27
|
+
# @return [String]
|
26
28
|
attr_accessor :secret
|
27
29
|
|
28
30
|
# Array of OAuth scopes used by the app.
|
31
|
+
# @return [Array<String>]
|
29
32
|
attr_accessor :scopes
|
30
33
|
|
31
34
|
# Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests.
|
35
|
+
# @return [Boolean]
|
32
36
|
attr_accessor :charges_users
|
33
37
|
|
34
38
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -20,6 +20,7 @@ module Dropbox::Sign
|
|
20
20
|
# An object with options that override account settings.
|
21
21
|
class ApiAppResponseOptions
|
22
22
|
# Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document
|
23
|
+
# @return [Boolean]
|
23
24
|
attr_accessor :can_insert_everywhere
|
24
25
|
|
25
26
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -20,9 +20,11 @@ module Dropbox::Sign
|
|
20
20
|
# An object describing the app's owner
|
21
21
|
class ApiAppResponseOwnerAccount
|
22
22
|
# The owner account's ID
|
23
|
+
# @return [String]
|
23
24
|
attr_accessor :account_id
|
24
25
|
|
25
26
|
# The owner account's email address
|
27
|
+
# @return [String]
|
26
28
|
attr_accessor :email_address
|
27
29
|
|
28
30
|
# Attribute mapping from ruby-style variable name to JSON key.
|