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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a00ffe37b1c97e9977cfeaa6f04b676720cad031f3b0bd764be2db025cc1c3a1
|
4
|
+
data.tar.gz: 10f96f7af1b7a26f125d86e9ced22ac0db87c3f78311275353dd688dc42cdbe6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 664ca8924e0707330f433760cfc76188d3a8fe3919310508a271d2004ce05b227d3cca8295f12885f9a4087381cfcc11f8a4e2f8e51babd0abfc1bb1a3b6267e
|
7
|
+
data.tar.gz: 99f8508768449c93a8243f435fcdd72f1f223d482b4bbad3c0ffbade2bad7d82a2d6a7fb9a097f6cde1ee67eabbc56636ec511beac224b36bc036ddb76d94629
|
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.0
|
28
|
+
- Package version: 1.0.0
|
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.0
|
49
|
+
gem install ./dropbox-sign-1.0.0.gem
|
50
50
|
```
|
51
51
|
|
52
|
-
(for development, run `gem install --dev ./dropbox-sign-1.0.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.0.gem` to install the development dependencies)
|
55
53
|
|
56
54
|
Finally add this to the Gemfile:
|
57
55
|
|
58
|
-
gem 'dropbox-sign', '~> 1.0.0
|
56
|
+
gem 'dropbox-sign', '~> 1.0.0'
|
59
57
|
|
60
58
|
### Install from Git
|
61
59
|
|
@@ -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/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)
|
@@ -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.
|
@@ -19,32 +19,46 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
# An object with options to customize the app's signer page
|
21
21
|
class ApiAppResponseWhiteLabelingOptions
|
22
|
+
# @return [String]
|
22
23
|
attr_accessor :header_background_color
|
23
24
|
|
25
|
+
# @return [String]
|
24
26
|
attr_accessor :legal_version
|
25
27
|
|
28
|
+
# @return [String]
|
26
29
|
attr_accessor :link_color
|
27
30
|
|
31
|
+
# @return [String]
|
28
32
|
attr_accessor :page_background_color
|
29
33
|
|
34
|
+
# @return [String]
|
30
35
|
attr_accessor :primary_button_color
|
31
36
|
|
37
|
+
# @return [String]
|
32
38
|
attr_accessor :primary_button_color_hover
|
33
39
|
|
40
|
+
# @return [String]
|
34
41
|
attr_accessor :primary_button_text_color
|
35
42
|
|
43
|
+
# @return [String]
|
36
44
|
attr_accessor :primary_button_text_color_hover
|
37
45
|
|
46
|
+
# @return [String]
|
38
47
|
attr_accessor :secondary_button_color
|
39
48
|
|
49
|
+
# @return [String]
|
40
50
|
attr_accessor :secondary_button_color_hover
|
41
51
|
|
52
|
+
# @return [String]
|
42
53
|
attr_accessor :secondary_button_text_color
|
43
54
|
|
55
|
+
# @return [String]
|
44
56
|
attr_accessor :secondary_button_text_color_hover
|
45
57
|
|
58
|
+
# @return [String]
|
46
59
|
attr_accessor :text_color1
|
47
60
|
|
61
|
+
# @return [String]
|
48
62
|
attr_accessor :text_color2
|
49
63
|
|
50
64
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,21 +19,28 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class ApiAppUpdateRequest
|
21
21
|
# The URL at which the API App should receive event callbacks.
|
22
|
+
# @return [String]
|
22
23
|
attr_accessor :callback_url
|
23
24
|
|
24
25
|
# An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)
|
26
|
+
# @return [File]
|
25
27
|
attr_accessor :custom_logo_file
|
26
28
|
|
27
29
|
# The domain names the ApiApp will be associated with.
|
30
|
+
# @return [Array<String>]
|
28
31
|
attr_accessor :domains
|
29
32
|
|
30
33
|
# The name you want to assign to the ApiApp.
|
34
|
+
# @return [String]
|
31
35
|
attr_accessor :name
|
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,14 +18,18 @@ end
|
|
18
18
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class BulkSendJobGetResponse
|
21
|
+
# @return [BulkSendJobResponse]
|
21
22
|
attr_accessor :bulk_send_job
|
22
23
|
|
24
|
+
# @return [ListInfoResponse]
|
23
25
|
attr_accessor :list_info
|
24
26
|
|
25
27
|
# Contains information about the Signature Requests sent in bulk.
|
28
|
+
# @return [Array<BulkSendJobGetResponseSignatureRequests>]
|
26
29
|
attr_accessor :signature_requests
|
27
30
|
|
28
31
|
# A list of warnings.
|
32
|
+
# @return [Array<WarningResponse>]
|
29
33
|
attr_accessor :warnings
|
30
34
|
|
31
35
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,75 +19,99 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class BulkSendJobGetResponseSignatureRequests
|
21
21
|
# Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.
|
22
|
+
# @return [Boolean, nil]
|
22
23
|
attr_accessor :test_mode
|
23
24
|
|
24
25
|
# The id of the SignatureRequest.
|
26
|
+
# @return [String]
|
25
27
|
attr_accessor :signature_request_id
|
26
28
|
|
27
29
|
# The email address of the initiator of the SignatureRequest.
|
30
|
+
# @return [String]
|
28
31
|
attr_accessor :requester_email_address
|
29
32
|
|
30
33
|
# The title the specified Account uses for the SignatureRequest.
|
34
|
+
# @return [String]
|
31
35
|
attr_accessor :title
|
32
36
|
|
33
37
|
# Default Label for account.
|
38
|
+
# @return [String]
|
34
39
|
attr_accessor :original_title
|
35
40
|
|
36
41
|
# The subject in the email that was initially sent to the signers.
|
42
|
+
# @return [String, nil]
|
37
43
|
attr_accessor :subject
|
38
44
|
|
39
45
|
# The custom message in the email that was initially sent to the signers.
|
46
|
+
# @return [String, nil]
|
40
47
|
attr_accessor :message
|
41
48
|
|
42
49
|
# The metadata attached to the signature request.
|
50
|
+
# @return [Object]
|
43
51
|
attr_accessor :metadata
|
44
52
|
|
45
53
|
# Time the signature request was created.
|
54
|
+
# @return [Integer]
|
46
55
|
attr_accessor :created_at
|
47
56
|
|
48
57
|
# 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.
|
58
|
+
# @return [Integer]
|
49
59
|
attr_accessor :expires_at
|
50
60
|
|
51
61
|
# Whether or not the SignatureRequest has been fully executed by all signers.
|
62
|
+
# @return [Boolean]
|
52
63
|
attr_accessor :is_complete
|
53
64
|
|
54
65
|
# Whether or not the SignatureRequest has been declined by a signer.
|
66
|
+
# @return [Boolean]
|
55
67
|
attr_accessor :is_declined
|
56
68
|
|
57
69
|
# Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).
|
70
|
+
# @return [Boolean]
|
58
71
|
attr_accessor :has_error
|
59
72
|
|
60
73
|
# The URL where a copy of the request's documents can be downloaded.
|
74
|
+
# @return [String]
|
61
75
|
attr_accessor :files_url
|
62
76
|
|
63
77
|
# 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.
|
78
|
+
# @return [String, nil]
|
64
79
|
attr_accessor :signing_url
|
65
80
|
|
66
81
|
# The URL where the requester and the signers can view the current status of the SignatureRequest.
|
82
|
+
# @return [String]
|
67
83
|
attr_accessor :details_url
|
68
84
|
|
69
85
|
# 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.
|
86
|
+
# @return [Array<String>]
|
70
87
|
attr_accessor :cc_email_addresses
|
71
88
|
|
72
89
|
# The URL you want the signer redirected to after they successfully sign.
|
90
|
+
# @return [String, nil]
|
73
91
|
attr_accessor :signing_redirect_url
|
74
92
|
|
75
93
|
# Templates IDs used in this SignatureRequest (if any).
|
94
|
+
# @return [Array<String>, nil]
|
76
95
|
attr_accessor :template_ids
|
77
96
|
|
78
97
|
# An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`
|
98
|
+
# @return [Array<SignatureRequestResponseCustomFieldBase>, nil]
|
79
99
|
attr_accessor :custom_fields
|
80
100
|
|
81
101
|
# Signer attachments.
|
102
|
+
# @return [Array<SignatureRequestResponseAttachment>, nil]
|
82
103
|
attr_accessor :attachments
|
83
104
|
|
84
105
|
# An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.
|
106
|
+
# @return [Array<SignatureRequestResponseDataBase>, nil]
|
85
107
|
attr_accessor :response_data
|
86
108
|
|
87
109
|
# An array of signature objects, 1 for each signer.
|
110
|
+
# @return [Array<SignatureRequestResponseSignatures>]
|
88
111
|
attr_accessor :signatures
|
89
112
|
|
90
113
|
# The id of the BulkSendJob.
|
114
|
+
# @return [String]
|
91
115
|
attr_accessor :bulk_send_job_id
|
92
116
|
|
93
117
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,11 +19,14 @@ end
|
|
19
19
|
module Dropbox::Sign
|
20
20
|
class BulkSendJobListResponse
|
21
21
|
# Contains a list of BulkSendJobs that the API caller has access to.
|
22
|
+
# @return [Array<BulkSendJobResponse>]
|
22
23
|
attr_accessor :bulk_send_jobs
|
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,15 +20,19 @@ module Dropbox::Sign
|
|
20
20
|
# Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.
|
21
21
|
class BulkSendJobResponse
|
22
22
|
# The id of the BulkSendJob.
|
23
|
+
# @return [String, nil]
|
23
24
|
attr_accessor :bulk_send_job_id
|
24
25
|
|
25
26
|
# The total amount of Signature Requests queued for sending.
|
27
|
+
# @return [Integer]
|
26
28
|
attr_accessor :total
|
27
29
|
|
28
30
|
# True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member.
|
31
|
+
# @return [Boolean]
|
29
32
|
attr_accessor :is_creator
|
30
33
|
|
31
34
|
# Time that the BulkSendJob was created.
|
35
|
+
# @return [Integer]
|
32
36
|
attr_accessor :created_at
|
33
37
|
|
34
38
|
# 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 BulkSendJobSendResponse
|
21
|
+
# @return [BulkSendJobResponse]
|
21
22
|
attr_accessor :bulk_send_job
|
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.
|