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
@@ -19,42 +19,55 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class SignatureRequestBulkSendWithTemplateRequest
|
21
21
|
# Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
|
22
|
+
# @return [Array<String>]
|
22
23
|
attr_accessor :template_ids
|
23
24
|
|
24
25
|
# `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns: - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) **Note**: Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ```
|
26
|
+
# @return [File]
|
25
27
|
attr_accessor :signer_file
|
26
28
|
|
27
29
|
# `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.
|
30
|
+
# @return [Array<SubBulkSignerList>]
|
28
31
|
attr_accessor :signer_list
|
29
32
|
|
30
33
|
# Allows signers to decline to sign a document if `true`. Defaults to `false`.
|
34
|
+
# @return [Boolean]
|
31
35
|
attr_accessor :allow_decline
|
32
36
|
|
33
37
|
# Add CC email recipients. Required when a CC role exists for the Template.
|
38
|
+
# @return [Array<SubCC>]
|
34
39
|
attr_accessor :ccs
|
35
40
|
|
36
41
|
# The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.
|
42
|
+
# @return [String]
|
37
43
|
attr_accessor :client_id
|
38
44
|
|
39
45
|
# When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
|
46
|
+
# @return [Array<SubCustomField>]
|
40
47
|
attr_accessor :custom_fields
|
41
48
|
|
42
49
|
# The custom message in the email that will be sent to the signers.
|
50
|
+
# @return [String]
|
43
51
|
attr_accessor :message
|
44
52
|
|
45
53
|
# 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. 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.
|
54
|
+
# @return [Hash<String, Object>]
|
46
55
|
attr_accessor :metadata
|
47
56
|
|
48
57
|
# The URL you want signers redirected to after they successfully sign.
|
58
|
+
# @return [String]
|
49
59
|
attr_accessor :signing_redirect_url
|
50
60
|
|
51
61
|
# The subject in the email that will be sent to the signers.
|
62
|
+
# @return [String]
|
52
63
|
attr_accessor :subject
|
53
64
|
|
54
65
|
# Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
|
66
|
+
# @return [Boolean]
|
55
67
|
attr_accessor :test_mode
|
56
68
|
|
57
69
|
# The title you want to assign to the SignatureRequest.
|
70
|
+
# @return [String]
|
58
71
|
attr_accessor :title
|
59
72
|
|
60
73
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,73 +19,97 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class SignatureRequestCreateEmbeddedRequest
|
21
21
|
# Client id of the app you're using to create this embedded signature request. Used for security purposes.
|
22
|
+
# @return [String]
|
22
23
|
attr_accessor :client_id
|
23
24
|
|
24
25
|
# Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.
|
26
|
+
# @return [Array<File>]
|
25
27
|
attr_accessor :files
|
26
28
|
|
27
29
|
# Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.
|
30
|
+
# @return [Array<String>]
|
28
31
|
attr_accessor :file_urls
|
29
32
|
|
30
33
|
# Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.
|
34
|
+
# @return [Array<SubSignatureRequestSigner>]
|
31
35
|
attr_accessor :signers
|
32
36
|
|
33
37
|
# Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both.
|
38
|
+
# @return [Array<SubSignatureRequestGroupedSigners>]
|
34
39
|
attr_accessor :grouped_signers
|
35
40
|
|
36
41
|
# Allows signers to decline to sign a document if `true`. Defaults to `false`.
|
42
|
+
# @return [Boolean]
|
37
43
|
attr_accessor :allow_decline
|
38
44
|
|
39
45
|
# Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **Note**: Only available for Premium plan.
|
46
|
+
# @return [Boolean]
|
40
47
|
attr_accessor :allow_reassign
|
41
48
|
|
42
49
|
# A list describing the attachments
|
50
|
+
# @return [Array<SubAttachment>]
|
43
51
|
attr_accessor :attachments
|
44
52
|
|
45
53
|
# The email addresses that should be CCed.
|
54
|
+
# @return [Array<String>]
|
46
55
|
attr_accessor :cc_email_addresses
|
47
56
|
|
48
57
|
# When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
|
58
|
+
# @return [Array<SubCustomField>]
|
49
59
|
attr_accessor :custom_fields
|
50
60
|
|
61
|
+
# @return [SubFieldOptions]
|
51
62
|
attr_accessor :field_options
|
52
63
|
|
53
64
|
# 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`.
|
65
|
+
# @return [Array<SubFormFieldGroup>]
|
54
66
|
attr_accessor :form_field_groups
|
55
67
|
|
56
68
|
# Conditional Logic rules for fields defined in `form_fields_per_document`.
|
69
|
+
# @return [Array<SubFormFieldRule>]
|
57
70
|
attr_accessor :form_field_rules
|
58
71
|
|
59
|
-
# 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:
|
72
|
+
# 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).) **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. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
|
73
|
+
# @return [Array<SubFormFieldsPerDocumentBase>]
|
60
74
|
attr_accessor :form_fields_per_document
|
61
75
|
|
62
76
|
# Enables automatic Text Tag removal when set to true. **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.
|
77
|
+
# @return [Boolean]
|
63
78
|
attr_accessor :hide_text_tags
|
64
79
|
|
65
80
|
# The custom message in the email that will be sent to the signers.
|
81
|
+
# @return [String]
|
66
82
|
attr_accessor :message
|
67
83
|
|
68
84
|
# 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. 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.
|
85
|
+
# @return [Hash<String, Object>]
|
69
86
|
attr_accessor :metadata
|
70
87
|
|
88
|
+
# @return [SubSigningOptions]
|
71
89
|
attr_accessor :signing_options
|
72
90
|
|
73
91
|
# The subject in the email that will be sent to the signers.
|
92
|
+
# @return [String]
|
74
93
|
attr_accessor :subject
|
75
94
|
|
76
95
|
# Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
|
96
|
+
# @return [Boolean]
|
77
97
|
attr_accessor :test_mode
|
78
98
|
|
79
99
|
# The title you want to assign to the SignatureRequest.
|
100
|
+
# @return [String]
|
80
101
|
attr_accessor :title
|
81
102
|
|
82
103
|
# Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.
|
104
|
+
# @return [Boolean]
|
83
105
|
attr_accessor :use_text_tags
|
84
106
|
|
85
107
|
# Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
|
108
|
+
# @return [Boolean]
|
86
109
|
attr_accessor :populate_auto_fill_fields
|
87
110
|
|
88
111
|
# When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. **Note**: This does not correspond to the **expires_at** returned in the response.
|
112
|
+
# @return [Integer, nil]
|
89
113
|
attr_accessor :expires_at
|
90
114
|
|
91
115
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,47 +19,62 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class SignatureRequestCreateEmbeddedWithTemplateRequest
|
21
21
|
# Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
|
22
|
+
# @return [Array<String>]
|
22
23
|
attr_accessor :template_ids
|
23
24
|
|
24
25
|
# Client id of the app you're using to create this embedded signature request. Used for security purposes.
|
26
|
+
# @return [String]
|
25
27
|
attr_accessor :client_id
|
26
28
|
|
27
29
|
# Add Signers to your Templated-based Signature Request.
|
30
|
+
# @return [Array<SubSignatureRequestTemplateSigner>]
|
28
31
|
attr_accessor :signers
|
29
32
|
|
30
33
|
# Allows signers to decline to sign a document if `true`. Defaults to `false`.
|
34
|
+
# @return [Boolean]
|
31
35
|
attr_accessor :allow_decline
|
32
36
|
|
33
37
|
# Add CC email recipients. Required when a CC role exists for the Template.
|
38
|
+
# @return [Array<SubCC>]
|
34
39
|
attr_accessor :ccs
|
35
40
|
|
36
41
|
# An array defining values and options for custom fields. Required when a custom field exists in the Template.
|
42
|
+
# @return [Array<SubCustomField>]
|
37
43
|
attr_accessor :custom_fields
|
38
44
|
|
39
45
|
# Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.
|
46
|
+
# @return [Array<File>]
|
40
47
|
attr_accessor :files
|
41
48
|
|
42
49
|
# Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.
|
50
|
+
# @return [Array<String>]
|
43
51
|
attr_accessor :file_urls
|
44
52
|
|
45
53
|
# The custom message in the email that will be sent to the signers.
|
54
|
+
# @return [String]
|
46
55
|
attr_accessor :message
|
47
56
|
|
48
57
|
# 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. 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.
|
58
|
+
# @return [Hash<String, Object>]
|
49
59
|
attr_accessor :metadata
|
50
60
|
|
61
|
+
# @return [SubSigningOptions]
|
51
62
|
attr_accessor :signing_options
|
52
63
|
|
53
64
|
# The subject in the email that will be sent to the signers.
|
65
|
+
# @return [String]
|
54
66
|
attr_accessor :subject
|
55
67
|
|
56
68
|
# Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
|
69
|
+
# @return [Boolean]
|
57
70
|
attr_accessor :test_mode
|
58
71
|
|
59
72
|
# The title you want to assign to the SignatureRequest.
|
73
|
+
# @return [String]
|
60
74
|
attr_accessor :title
|
61
75
|
|
62
76
|
# Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
|
77
|
+
# @return [Boolean]
|
63
78
|
attr_accessor :populate_auto_fill_fields
|
64
79
|
|
65
80
|
# 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 SignatureRequestGetResponse
|
21
|
+
# @return [SignatureRequestResponse]
|
21
22
|
attr_accessor :signature_request
|
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 SignatureRequestListResponse
|
21
21
|
# Contains information about signature requests.
|
22
|
+
# @return [Array<SignatureRequestResponse>]
|
22
23
|
attr_accessor :signature_requests
|
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.
|
@@ -19,9 +19,11 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class SignatureRequestRemindRequest
|
21
21
|
# The email address of the signer to send a reminder to.
|
22
|
+
# @return [String]
|
22
23
|
attr_accessor :email_address
|
23
24
|
|
24
25
|
# The name of the signer to send a reminder to. Include if two or more signers share an email address.
|
26
|
+
# @return [String]
|
25
27
|
attr_accessor :name
|
26
28
|
|
27
29
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -20,72 +20,95 @@ module Dropbox::Sign
|
|
20
20
|
# Contains information about a signature request.
|
21
21
|
class SignatureRequestResponse
|
22
22
|
# Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.
|
23
|
+
# @return [Boolean, nil]
|
23
24
|
attr_accessor :test_mode
|
24
25
|
|
25
26
|
# The id of the SignatureRequest.
|
27
|
+
# @return [String]
|
26
28
|
attr_accessor :signature_request_id
|
27
29
|
|
28
30
|
# The email address of the initiator of the SignatureRequest.
|
31
|
+
# @return [String]
|
29
32
|
attr_accessor :requester_email_address
|
30
33
|
|
31
34
|
# The title the specified Account uses for the SignatureRequest.
|
35
|
+
# @return [String]
|
32
36
|
attr_accessor :title
|
33
37
|
|
34
38
|
# Default Label for account.
|
39
|
+
# @return [String]
|
35
40
|
attr_accessor :original_title
|
36
41
|
|
37
42
|
# The subject in the email that was initially sent to the signers.
|
43
|
+
# @return [String, nil]
|
38
44
|
attr_accessor :subject
|
39
45
|
|
40
46
|
# The custom message in the email that was initially sent to the signers.
|
47
|
+
# @return [String, nil]
|
41
48
|
attr_accessor :message
|
42
49
|
|
43
50
|
# The metadata attached to the signature request.
|
51
|
+
# @return [Object]
|
44
52
|
attr_accessor :metadata
|
45
53
|
|
46
54
|
# Time the signature request was created.
|
55
|
+
# @return [Integer]
|
47
56
|
attr_accessor :created_at
|
48
57
|
|
49
58
|
# The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
|
59
|
+
# @return [Integer]
|
50
60
|
attr_accessor :expires_at
|
51
61
|
|
52
62
|
# Whether or not the SignatureRequest has been fully executed by all signers.
|
63
|
+
# @return [Boolean]
|
53
64
|
attr_accessor :is_complete
|
54
65
|
|
55
66
|
# Whether or not the SignatureRequest has been declined by a signer.
|
67
|
+
# @return [Boolean]
|
56
68
|
attr_accessor :is_declined
|
57
69
|
|
58
70
|
# Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).
|
71
|
+
# @return [Boolean]
|
59
72
|
attr_accessor :has_error
|
60
73
|
|
61
74
|
# The URL where a copy of the request's documents can be downloaded.
|
75
|
+
# @return [String]
|
62
76
|
attr_accessor :files_url
|
63
77
|
|
64
78
|
# The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing.
|
79
|
+
# @return [String, nil]
|
65
80
|
attr_accessor :signing_url
|
66
81
|
|
67
82
|
# The URL where the requester and the signers can view the current status of the SignatureRequest.
|
83
|
+
# @return [String]
|
68
84
|
attr_accessor :details_url
|
69
85
|
|
70
86
|
# A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.
|
87
|
+
# @return [Array<String>]
|
71
88
|
attr_accessor :cc_email_addresses
|
72
89
|
|
73
90
|
# The URL you want the signer redirected to after they successfully sign.
|
91
|
+
# @return [String, nil]
|
74
92
|
attr_accessor :signing_redirect_url
|
75
93
|
|
76
94
|
# Templates IDs used in this SignatureRequest (if any).
|
95
|
+
# @return [Array<String>, nil]
|
77
96
|
attr_accessor :template_ids
|
78
97
|
|
79
98
|
# An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`
|
99
|
+
# @return [Array<SignatureRequestResponseCustomFieldBase>, nil]
|
80
100
|
attr_accessor :custom_fields
|
81
101
|
|
82
102
|
# Signer attachments.
|
103
|
+
# @return [Array<SignatureRequestResponseAttachment>, nil]
|
83
104
|
attr_accessor :attachments
|
84
105
|
|
85
106
|
# An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.
|
107
|
+
# @return [Array<SignatureRequestResponseDataBase>, nil]
|
86
108
|
attr_accessor :response_data
|
87
109
|
|
88
110
|
# An array of signature objects, 1 for each signer.
|
111
|
+
# @return [Array<SignatureRequestResponseSignatures>]
|
89
112
|
attr_accessor :signatures
|
90
113
|
|
91
114
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -20,21 +20,27 @@ module Dropbox::Sign
|
|
20
20
|
# Signer attachments.
|
21
21
|
class SignatureRequestResponseAttachment
|
22
22
|
# The unique ID for this attachment.
|
23
|
+
# @return [String]
|
23
24
|
attr_accessor :id
|
24
25
|
|
25
26
|
# The Signer this attachment is assigned to.
|
27
|
+
# @return [String]
|
26
28
|
attr_accessor :signer
|
27
29
|
|
28
30
|
# The name of this attachment.
|
31
|
+
# @return [String]
|
29
32
|
attr_accessor :name
|
30
33
|
|
31
34
|
# A boolean value denoting if this attachment is required.
|
35
|
+
# @return [Boolean]
|
32
36
|
attr_accessor :required
|
33
37
|
|
34
38
|
# Instructions for Signer.
|
39
|
+
# @return [String, nil]
|
35
40
|
attr_accessor :instructions
|
36
41
|
|
37
42
|
# Timestamp when attachment was uploaded by Signer.
|
43
|
+
# @return [Integer, nil]
|
38
44
|
attr_accessor :uploaded_at
|
39
45
|
|
40
46
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -20,18 +20,23 @@ module Dropbox::Sign
|
|
20
20
|
# An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`
|
21
21
|
class SignatureRequestResponseCustomFieldBase
|
22
22
|
# The type of this Custom Field. Only 'text' and 'checkbox' are currently supported.
|
23
|
+
# @return [String]
|
23
24
|
attr_accessor :type
|
24
25
|
|
25
26
|
# The name of the Custom Field.
|
27
|
+
# @return [String]
|
26
28
|
attr_accessor :name
|
27
29
|
|
28
30
|
# A boolean value denoting if this field is required.
|
31
|
+
# @return [Boolean]
|
29
32
|
attr_accessor :required
|
30
33
|
|
31
34
|
# The unique ID for this field.
|
35
|
+
# @return [String]
|
32
36
|
attr_accessor :api_id
|
33
37
|
|
34
38
|
# The name of the Role that is able to edit this field.
|
39
|
+
# @return [String]
|
35
40
|
attr_accessor :editor
|
36
41
|
|
37
42
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -20,9 +20,11 @@ module Dropbox::Sign
|
|
20
20
|
# This class extends `SignatureRequestResponseCustomFieldBase`.
|
21
21
|
class SignatureRequestResponseCustomFieldCheckbox < SignatureRequestResponseCustomFieldBase
|
22
22
|
# The type of this Custom Field. Only 'text' and 'checkbox' are currently supported.
|
23
|
+
# @return [String]
|
23
24
|
attr_accessor :type
|
24
25
|
|
25
26
|
# A true/false for checkbox fields
|
27
|
+
# @return [Boolean]
|
26
28
|
attr_accessor :value
|
27
29
|
|
28
30
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -20,9 +20,11 @@ module Dropbox::Sign
|
|
20
20
|
# This class extends `SignatureRequestResponseCustomFieldBase`.
|
21
21
|
class SignatureRequestResponseCustomFieldText < SignatureRequestResponseCustomFieldBase
|
22
22
|
# The type of this Custom Field. Only 'text' and 'checkbox' are currently supported.
|
23
|
+
# @return [String]
|
23
24
|
attr_accessor :type
|
24
25
|
|
25
26
|
# A text string for text fields
|
27
|
+
# @return [String]
|
26
28
|
attr_accessor :value
|
27
29
|
|
28
30
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -20,17 +20,22 @@ module Dropbox::Sign
|
|
20
20
|
# An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.
|
21
21
|
class SignatureRequestResponseDataBase
|
22
22
|
# The unique ID for this field.
|
23
|
+
# @return [String]
|
23
24
|
attr_accessor :api_id
|
24
25
|
|
25
26
|
# The ID of the signature to which this response is linked.
|
27
|
+
# @return [String]
|
26
28
|
attr_accessor :signature_id
|
27
29
|
|
28
30
|
# The name of the form field.
|
31
|
+
# @return [String]
|
29
32
|
attr_accessor :name
|
30
33
|
|
31
34
|
# A boolean value denoting if this field is required.
|
35
|
+
# @return [Boolean]
|
32
36
|
attr_accessor :required
|
33
37
|
|
38
|
+
# @return [String]
|
34
39
|
attr_accessor :type
|
35
40
|
|
36
41
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,9 +19,11 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class SignatureRequestResponseDataValueCheckbox < SignatureRequestResponseDataBase
|
21
21
|
# A yes/no checkbox
|
22
|
+
# @return [String]
|
22
23
|
attr_accessor :type
|
23
24
|
|
24
25
|
# The value of the form field.
|
26
|
+
# @return [Boolean]
|
25
27
|
attr_accessor :value
|
26
28
|
|
27
29
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,9 +19,11 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class SignatureRequestResponseDataValueCheckboxMerge < SignatureRequestResponseDataBase
|
21
21
|
# A checkbox field that has default value set by the api
|
22
|
+
# @return [String]
|
22
23
|
attr_accessor :type
|
23
24
|
|
24
25
|
# The value of the form field.
|
26
|
+
# @return [String]
|
25
27
|
attr_accessor :value
|
26
28
|
|
27
29
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,9 +19,11 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class SignatureRequestResponseDataValueDateSigned < SignatureRequestResponseDataBase
|
21
21
|
# A date
|
22
|
+
# @return [String]
|
22
23
|
attr_accessor :type
|
23
24
|
|
24
25
|
# The value of the form field.
|
26
|
+
# @return [String]
|
25
27
|
attr_accessor :value
|
26
28
|
|
27
29
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,9 +19,11 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class SignatureRequestResponseDataValueDropdown < SignatureRequestResponseDataBase
|
21
21
|
# An input field for dropdowns
|
22
|
+
# @return [String]
|
22
23
|
attr_accessor :type
|
23
24
|
|
24
25
|
# The value of the form field.
|
26
|
+
# @return [String]
|
25
27
|
attr_accessor :value
|
26
28
|
|
27
29
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,9 +19,11 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class SignatureRequestResponseDataValueInitials < SignatureRequestResponseDataBase
|
21
21
|
# An input field for initials
|
22
|
+
# @return [String]
|
22
23
|
attr_accessor :type
|
23
24
|
|
24
25
|
# The value of the form field.
|
26
|
+
# @return [String]
|
25
27
|
attr_accessor :value
|
26
28
|
|
27
29
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,9 +19,11 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class SignatureRequestResponseDataValueRadio < SignatureRequestResponseDataBase
|
21
21
|
# An input field for radios
|
22
|
+
# @return [String]
|
22
23
|
attr_accessor :type
|
23
24
|
|
24
25
|
# The value of the form field.
|
26
|
+
# @return [Boolean]
|
25
27
|
attr_accessor :value
|
26
28
|
|
27
29
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,9 +19,11 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class SignatureRequestResponseDataValueSignature < SignatureRequestResponseDataBase
|
21
21
|
# A signature input field
|
22
|
+
# @return [String]
|
22
23
|
attr_accessor :type
|
23
24
|
|
24
25
|
# The value of the form field.
|
26
|
+
# @return [String]
|
25
27
|
attr_accessor :value
|
26
28
|
|
27
29
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,9 +19,11 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class SignatureRequestResponseDataValueText < SignatureRequestResponseDataBase
|
21
21
|
# A text input field
|
22
|
+
# @return [String]
|
22
23
|
attr_accessor :type
|
23
24
|
|
24
25
|
# The value of the form field.
|
26
|
+
# @return [String]
|
25
27
|
attr_accessor :value
|
26
28
|
|
27
29
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,9 +19,11 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class SignatureRequestResponseDataValueTextMerge < SignatureRequestResponseDataBase
|
21
21
|
# A text field that has default text set by the api
|
22
|
+
# @return [String]
|
22
23
|
attr_accessor :type
|
23
24
|
|
24
25
|
# The value of the form field.
|
26
|
+
# @return [String]
|
25
27
|
attr_accessor :value
|
26
28
|
|
27
29
|
# Attribute mapping from ruby-style variable name to JSON key.
|