dropbox-sign 1.0.0.pre.beta2301 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +7 -9
- data/bin/check-clean-git-status +15 -0
- data/examples/EventCallback.rb +1 -4
- 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 +24 -0
- 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 +25 -0
- 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 +11 -0
- 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 +25 -0
- 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 +36 -0
- 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 +24 -0
- 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 +3 -1
- data/openapi-sdk.yaml +1 -0
- data/spec/models/sub_form_fields_per_document_base_spec.rb +24 -0
- data/templates/README.mustache +3 -5
- data/templates/partial_model_generic.mustache +1 -0
- metadata +5 -4
@@ -19,32 +19,42 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class EmbeddedEditUrlRequest
|
21
21
|
# This allows the requester to enable/disable to add or change CC roles when editing the template.
|
22
|
+
# @return [Boolean]
|
22
23
|
attr_accessor :allow_edit_ccs
|
23
24
|
|
24
25
|
# The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.
|
26
|
+
# @return [Array<String>]
|
25
27
|
attr_accessor :cc_roles
|
26
28
|
|
29
|
+
# @return [SubEditorOptions]
|
27
30
|
attr_accessor :editor_options
|
28
31
|
|
29
32
|
# Provide users the ability to review/edit the template signer roles.
|
33
|
+
# @return [Boolean]
|
30
34
|
attr_accessor :force_signer_roles
|
31
35
|
|
32
36
|
# Provide users the ability to review/edit the template subject and message.
|
37
|
+
# @return [Boolean]
|
33
38
|
attr_accessor :force_subject_message
|
34
39
|
|
35
40
|
# Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template. Remove all merge fields on the template by passing an empty array `[]`.
|
41
|
+
# @return [Array<SubMergeField>]
|
36
42
|
attr_accessor :merge_fields
|
37
43
|
|
38
44
|
# This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor). **Note**: This parameter overwrites `show_preview=true` (if set).
|
45
|
+
# @return [Boolean]
|
39
46
|
attr_accessor :preview_only
|
40
47
|
|
41
48
|
# This allows the requester to enable the editor/preview experience.
|
49
|
+
# @return [Boolean]
|
42
50
|
attr_accessor :show_preview
|
43
51
|
|
44
52
|
# When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
|
53
|
+
# @return [Boolean]
|
45
54
|
attr_accessor :show_progress_stepper
|
46
55
|
|
47
56
|
# Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`.
|
57
|
+
# @return [Boolean]
|
48
58
|
attr_accessor :test_mode
|
49
59
|
|
50
60
|
# 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 EmbeddedEditUrlResponse
|
21
|
+
# @return [EmbeddedEditUrlResponseEmbedded]
|
21
22
|
attr_accessor :embedded
|
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.
|
@@ -20,9 +20,11 @@ module Dropbox::Sign
|
|
20
20
|
# An embedded template object.
|
21
21
|
class EmbeddedEditUrlResponseEmbedded
|
22
22
|
# A template url that can be opened in an iFrame.
|
23
|
+
# @return [String]
|
23
24
|
attr_accessor :edit_url
|
24
25
|
|
25
26
|
# The specific time that the the `edit_url` link expires, in epoch.
|
27
|
+
# @return [Integer]
|
26
28
|
attr_accessor :expires_at
|
27
29
|
|
28
30
|
# 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 EmbeddedSignUrlResponse
|
21
|
+
# @return [EmbeddedSignUrlResponseEmbedded]
|
21
22
|
attr_accessor :embedded
|
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.
|
@@ -20,9 +20,11 @@ module Dropbox::Sign
|
|
20
20
|
# An object that contains necessary information to set up embedded signing.
|
21
21
|
class EmbeddedSignUrlResponseEmbedded
|
22
22
|
# A signature url that can be opened in an iFrame.
|
23
|
+
# @return [String]
|
23
24
|
attr_accessor :sign_url
|
24
25
|
|
25
26
|
# The specific time that the the `sign_url` link expires, in epoch.
|
27
|
+
# @return [Integer]
|
26
28
|
attr_accessor :expires_at
|
27
29
|
|
28
30
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -20,12 +20,15 @@ module Dropbox::Sign
|
|
20
20
|
# Contains information about an error that occurred.
|
21
21
|
class ErrorResponseError
|
22
22
|
# Message describing an error.
|
23
|
+
# @return [String]
|
23
24
|
attr_accessor :error_msg
|
24
25
|
|
25
26
|
# Name of the error.
|
27
|
+
# @return [String]
|
26
28
|
attr_accessor :error_name
|
27
29
|
|
28
30
|
# Path at which an error occurred.
|
31
|
+
# @return [String]
|
29
32
|
attr_accessor :error_path
|
30
33
|
|
31
34
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -18,12 +18,16 @@ end
|
|
18
18
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class EventCallbackRequest
|
21
|
+
# @return [EventCallbackRequestEvent]
|
21
22
|
attr_accessor :event
|
22
23
|
|
24
|
+
# @return [AccountResponse]
|
23
25
|
attr_accessor :account
|
24
26
|
|
27
|
+
# @return [SignatureRequestResponse]
|
25
28
|
attr_accessor :signature_request
|
26
29
|
|
30
|
+
# @return [TemplateResponse]
|
27
31
|
attr_accessor :template
|
28
32
|
|
29
33
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -20,14 +20,18 @@ module Dropbox::Sign
|
|
20
20
|
# Basic information about the event that occurred.
|
21
21
|
class EventCallbackRequestEvent
|
22
22
|
# Time the event was created (using Unix time).
|
23
|
+
# @return [String]
|
23
24
|
attr_accessor :event_time
|
24
25
|
|
25
26
|
# Type of callback event that was triggered.
|
27
|
+
# @return [String]
|
26
28
|
attr_accessor :event_type
|
27
29
|
|
28
30
|
# Generated hash used to verify source of event data.
|
31
|
+
# @return [String]
|
29
32
|
attr_accessor :event_hash
|
30
33
|
|
34
|
+
# @return [EventCallbackRequestEventMetadata]
|
31
35
|
attr_accessor :event_metadata
|
32
36
|
|
33
37
|
class EnumAttributeValidator
|
@@ -20,15 +20,19 @@ module Dropbox::Sign
|
|
20
20
|
# Specific metadata about the event.
|
21
21
|
class EventCallbackRequestEventMetadata
|
22
22
|
# Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events.
|
23
|
+
# @return [String, nil]
|
23
24
|
attr_accessor :related_signature_id
|
24
25
|
|
25
26
|
# Account ID the event was reported for.
|
27
|
+
# @return [String, nil]
|
26
28
|
attr_accessor :reported_for_account_id
|
27
29
|
|
28
30
|
# App ID the event was reported for.
|
31
|
+
# @return [String, nil]
|
29
32
|
attr_accessor :reported_for_app_id
|
30
33
|
|
31
34
|
# Message about a declined or failed (due to error) signature flow.
|
35
|
+
# @return [String, nil]
|
32
36
|
attr_accessor :event_message
|
33
37
|
|
34
38
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,9 +19,11 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class FileResponse
|
21
21
|
# URL to the file.
|
22
|
+
# @return [String]
|
22
23
|
attr_accessor :file_url
|
23
24
|
|
24
25
|
# When the link expires.
|
26
|
+
# @return [Integer]
|
25
27
|
attr_accessor :expires_at
|
26
28
|
|
27
29
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -20,15 +20,19 @@ module Dropbox::Sign
|
|
20
20
|
# Contains pagination information about the data returned.
|
21
21
|
class ListInfoResponse
|
22
22
|
# Total number of pages available.
|
23
|
+
# @return [Integer]
|
23
24
|
attr_accessor :num_pages
|
24
25
|
|
25
26
|
# Total number of objects available.
|
27
|
+
# @return [Integer, nil]
|
26
28
|
attr_accessor :num_results
|
27
29
|
|
28
30
|
# Number of the page being returned.
|
31
|
+
# @return [Integer]
|
29
32
|
attr_accessor :page
|
30
33
|
|
31
34
|
# Objects returned per page.
|
35
|
+
# @return [Integer]
|
32
36
|
attr_accessor :page_size
|
33
37
|
|
34
38
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,18 +19,23 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class OAuthTokenGenerateRequest
|
21
21
|
# The client id of the app requesting authorization.
|
22
|
+
# @return [String]
|
22
23
|
attr_accessor :client_id
|
23
24
|
|
24
25
|
# The secret token of your app.
|
26
|
+
# @return [String]
|
25
27
|
attr_accessor :client_secret
|
26
28
|
|
27
29
|
# The code passed to your callback when the user granted access.
|
30
|
+
# @return [String]
|
28
31
|
attr_accessor :code
|
29
32
|
|
30
33
|
# When generating a new token use `authorization_code`.
|
34
|
+
# @return [String]
|
31
35
|
attr_accessor :grant_type
|
32
36
|
|
33
37
|
# Same as the state you specified earlier.
|
38
|
+
# @return [String]
|
34
39
|
attr_accessor :state
|
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 OAuthTokenRefreshRequest
|
21
21
|
# When refreshing an existing token use `refresh_token`.
|
22
|
+
# @return [String]
|
22
23
|
attr_accessor :grant_type
|
23
24
|
|
24
25
|
# The token provided when you got the expired access token.
|
26
|
+
# @return [String]
|
25
27
|
attr_accessor :refresh_token
|
26
28
|
|
27
29
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -18,15 +18,20 @@ end
|
|
18
18
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class OAuthTokenResponse
|
21
|
+
# @return [String]
|
21
22
|
attr_accessor :access_token
|
22
23
|
|
24
|
+
# @return [String]
|
23
25
|
attr_accessor :token_type
|
24
26
|
|
27
|
+
# @return [String]
|
25
28
|
attr_accessor :refresh_token
|
26
29
|
|
27
30
|
# Number of seconds until the `access_token` expires. Uses epoch time.
|
31
|
+
# @return [Integer]
|
28
32
|
attr_accessor :expires_in
|
29
33
|
|
34
|
+
# @return [String, nil]
|
30
35
|
attr_accessor :state
|
31
36
|
|
32
37
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,12 +19,15 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class ReportCreateRequest
|
21
21
|
# The (inclusive) end date for the report data in `MM/DD/YYYY` format.
|
22
|
+
# @return [String]
|
22
23
|
attr_accessor :end_date
|
23
24
|
|
24
25
|
# The type(s) of the report you are requesting. Allowed values are `user_activity` and `document_status`. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status).
|
26
|
+
# @return [Array<String>]
|
25
27
|
attr_accessor :report_type
|
26
28
|
|
27
29
|
# The (inclusive) start date for the report data in `MM/DD/YYYY` format.
|
30
|
+
# @return [String]
|
28
31
|
attr_accessor :start_date
|
29
32
|
|
30
33
|
class EnumAttributeValidator
|
@@ -18,9 +18,11 @@ end
|
|
18
18
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class ReportCreateResponse
|
21
|
+
# @return [ReportResponse]
|
21
22
|
attr_accessor :report
|
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.
|
@@ -20,15 +20,19 @@ module Dropbox::Sign
|
|
20
20
|
# Contains information about the report request.
|
21
21
|
class ReportResponse
|
22
22
|
# A message indicating the requested operation's success
|
23
|
+
# @return [String]
|
23
24
|
attr_accessor :success
|
24
25
|
|
25
26
|
# The (inclusive) start date for the report data in MM/DD/YYYY format.
|
27
|
+
# @return [String]
|
26
28
|
attr_accessor :start_date
|
27
29
|
|
28
30
|
# The (inclusive) end date for the report data in MM/DD/YYYY format.
|
31
|
+
# @return [String]
|
29
32
|
attr_accessor :end_date
|
30
33
|
|
31
34
|
# The type(s) of the report you are requesting. Allowed values are \"user_activity\" and \"document_status\". User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status).
|
35
|
+
# @return [Array<String>]
|
32
36
|
attr_accessor :report_type
|
33
37
|
|
34
38
|
class EnumAttributeValidator
|
data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb
CHANGED
@@ -19,42 +19,55 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class SignatureRequestBulkCreateEmbeddedWithTemplateRequest
|
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
|
# `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 ```
|
30
|
+
# @return [File]
|
28
31
|
attr_accessor :signer_file
|
29
32
|
|
30
33
|
# `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.
|
34
|
+
# @return [Array<SubBulkSignerList>]
|
31
35
|
attr_accessor :signer_list
|
32
36
|
|
33
37
|
# Allows signers to decline to sign a document if `true`. Defaults to `false`.
|
38
|
+
# @return [Boolean]
|
34
39
|
attr_accessor :allow_decline
|
35
40
|
|
36
41
|
# Add CC email recipients. Required when a CC role exists for the Template.
|
42
|
+
# @return [Array<SubCC>]
|
37
43
|
attr_accessor :ccs
|
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,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
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: <a href=\"/docs/openapi/form-fields-per-document\" target=\"_blank\">Using Form Fields per Document</a>.) **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.
|