dropbox-sign 1.4.0 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +30 -25
- data/README.md +6 -12
- data/VERSION +1 -1
- data/docs/AccountResponse.md +1 -0
- data/docs/AccountResponseQuotas.md +1 -0
- data/docs/AccountResponseUsage.md +10 -0
- data/docs/EmbeddedEditUrlRequest.md +1 -1
- data/docs/SignatureRequestApi.md +7 -422
- data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestBulkSendWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestCreateEmbeddedRequest.md +4 -4
- data/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +1 -1
- data/docs/SignatureRequestSendRequest.md +5 -5
- data/docs/SignatureRequestSendWithTemplateRequest.md +2 -2
- data/docs/SignatureRequestUpdateRequest.md +2 -2
- data/docs/SubAttachment.md +1 -1
- data/docs/SubCustomField.md +1 -1
- data/docs/SubFieldOptions.md +1 -1
- data/docs/SubFormFieldsPerDocumentBase.md +2 -2
- data/docs/SubFormFieldsPerDocumentDateSigned.md +1 -1
- data/docs/SubFormFieldsPerDocumentDropdown.md +1 -1
- data/docs/SubFormFieldsPerDocumentHyperlink.md +1 -1
- data/docs/SubFormFieldsPerDocumentText.md +2 -2
- data/docs/SubFormFieldsPerDocumentTextMerge.md +1 -1
- data/docs/SubSignatureRequestGroupedSigners.md +1 -1
- data/docs/SubSignatureRequestSigner.md +1 -1
- data/docs/SubSignatureRequestTemplateSigner.md +1 -1
- data/docs/SubSigningOptions.md +1 -1
- data/docs/TeamAddMemberRequest.md +1 -1
- data/docs/TeamRemoveMemberRequest.md +2 -2
- data/docs/TemplateAddUserRequest.md +2 -2
- data/docs/TemplateCreateEmbeddedDraftRequest.md +2 -2
- data/docs/TemplateCreateRequest.md +2 -2
- data/docs/TemplateResponseDocument.md +1 -1
- data/docs/TemplateResponseDocumentStaticFieldBase.md +1 -1
- data/docs/UnclaimedDraftApi.md +3 -3
- data/docs/UnclaimedDraftCreateEmbeddedRequest.md +4 -4
- data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +3 -3
- data/docs/UnclaimedDraftCreateRequest.md +2 -2
- data/dropbox-sign.gemspec +2 -1
- data/lib/dropbox-sign/api/account_api.rb +1 -1
- data/lib/dropbox-sign/api/api_app_api.rb +3 -3
- data/lib/dropbox-sign/api/bulk_send_job_api.rb +5 -5
- data/lib/dropbox-sign/api/embedded_api.rb +1 -1
- data/lib/dropbox-sign/api/o_auth_api.rb +1 -1
- data/lib/dropbox-sign/api/report_api.rb +1 -1
- data/lib/dropbox-sign/api/signature_request_api.rb +19 -479
- data/lib/dropbox-sign/api/team_api.rb +5 -5
- data/lib/dropbox-sign/api/template_api.rb +4 -4
- data/lib/dropbox-sign/api/unclaimed_draft_api.rb +7 -7
- data/lib/dropbox-sign/api_client.rb +27 -24
- data/lib/dropbox-sign/api_error.rb +2 -1
- data/lib/dropbox-sign/configuration.rb +39 -9
- data/lib/dropbox-sign/event_callback_helper.rb +1 -1
- data/lib/dropbox-sign/models/account_create_request.rb +2 -4
- data/lib/dropbox-sign/models/account_create_response.rb +2 -4
- data/lib/dropbox-sign/models/account_get_response.rb +2 -4
- data/lib/dropbox-sign/models/account_response.rb +17 -9
- data/lib/dropbox-sign/models/account_response_quotas.rb +19 -9
- data/lib/dropbox-sign/models/account_response_usage.rb +251 -0
- data/lib/dropbox-sign/models/account_update_request.rb +2 -4
- data/lib/dropbox-sign/models/account_verify_request.rb +2 -4
- data/lib/dropbox-sign/models/account_verify_response.rb +2 -4
- data/lib/dropbox-sign/models/account_verify_response_account.rb +2 -4
- data/lib/dropbox-sign/models/api_app_create_request.rb +2 -4
- data/lib/dropbox-sign/models/api_app_get_response.rb +2 -4
- data/lib/dropbox-sign/models/api_app_list_response.rb +2 -4
- data/lib/dropbox-sign/models/api_app_response.rb +2 -4
- data/lib/dropbox-sign/models/api_app_response_o_auth.rb +2 -4
- data/lib/dropbox-sign/models/api_app_response_options.rb +2 -4
- data/lib/dropbox-sign/models/api_app_response_owner_account.rb +2 -4
- data/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb +2 -4
- data/lib/dropbox-sign/models/api_app_update_request.rb +3 -5
- data/lib/dropbox-sign/models/bulk_send_job_get_response.rb +2 -4
- data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +2 -4
- data/lib/dropbox-sign/models/bulk_send_job_list_response.rb +2 -4
- data/lib/dropbox-sign/models/bulk_send_job_response.rb +2 -4
- data/lib/dropbox-sign/models/bulk_send_job_send_response.rb +2 -4
- data/lib/dropbox-sign/models/embedded_edit_url_request.rb +3 -5
- data/lib/dropbox-sign/models/embedded_edit_url_response.rb +2 -4
- data/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb +2 -4
- data/lib/dropbox-sign/models/embedded_sign_url_response.rb +2 -4
- data/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb +2 -4
- data/lib/dropbox-sign/models/error_response.rb +2 -4
- data/lib/dropbox-sign/models/error_response_error.rb +2 -4
- data/lib/dropbox-sign/models/event_callback_request.rb +2 -4
- data/lib/dropbox-sign/models/event_callback_request_event.rb +2 -4
- data/lib/dropbox-sign/models/event_callback_request_event_metadata.rb +2 -4
- data/lib/dropbox-sign/models/file_response.rb +2 -4
- data/lib/dropbox-sign/models/file_response_data_uri.rb +2 -4
- data/lib/dropbox-sign/models/list_info_response.rb +2 -4
- data/lib/dropbox-sign/models/o_auth_token_generate_request.rb +2 -4
- data/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +2 -4
- data/lib/dropbox-sign/models/o_auth_token_response.rb +2 -4
- data/lib/dropbox-sign/models/report_create_request.rb +2 -4
- data/lib/dropbox-sign/models/report_create_response.rb +2 -4
- data/lib/dropbox-sign/models/report_response.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +6 -8
- data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +6 -8
- data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +9 -11
- data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +6 -8
- data/lib/dropbox-sign/models/signature_request_get_response.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_list_response.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_remind_request.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_response.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_response_attachment.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_response_custom_field_type_enum.rb +8 -4
- data/lib/dropbox-sign/models/signature_request_response_data_base.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_response_data_type_enum.rb +8 -4
- data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_response_data_value_text.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_response_signatures.rb +2 -4
- data/lib/dropbox-sign/models/signature_request_send_request.rb +10 -12
- data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +8 -9
- data/lib/dropbox-sign/models/signature_request_update_request.rb +4 -6
- data/lib/dropbox-sign/models/sub_attachment.rb +3 -5
- data/lib/dropbox-sign/models/sub_bulk_signer_list.rb +2 -4
- data/lib/dropbox-sign/models/sub_bulk_signer_list_custom_field.rb +2 -4
- data/lib/dropbox-sign/models/sub_cc.rb +2 -4
- data/lib/dropbox-sign/models/sub_custom_field.rb +3 -5
- data/lib/dropbox-sign/models/sub_editor_options.rb +2 -4
- data/lib/dropbox-sign/models/sub_field_options.rb +3 -5
- data/lib/dropbox-sign/models/sub_form_field_group.rb +2 -4
- data/lib/dropbox-sign/models/sub_form_field_rule.rb +2 -4
- data/lib/dropbox-sign/models/sub_form_field_rule_action.rb +2 -4
- data/lib/dropbox-sign/models/sub_form_field_rule_trigger.rb +2 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +4 -6
- data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb +2 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox_merge.rb +2 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +3 -5
- data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +3 -5
- data/lib/dropbox-sign/models/sub_form_fields_per_document_font_enum.rb +8 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +3 -5
- data/lib/dropbox-sign/models/sub_form_fields_per_document_initials.rb +2 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_radio.rb +2 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_signature.rb +2 -4
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +4 -6
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +3 -5
- data/lib/dropbox-sign/models/sub_form_fields_per_document_type_enum.rb +8 -4
- data/lib/dropbox-sign/models/sub_merge_field.rb +2 -4
- data/lib/dropbox-sign/models/sub_o_auth.rb +2 -4
- data/lib/dropbox-sign/models/sub_options.rb +2 -4
- data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +3 -5
- data/lib/dropbox-sign/models/sub_signature_request_signer.rb +5 -7
- data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +5 -7
- data/lib/dropbox-sign/models/sub_signing_options.rb +3 -5
- data/lib/dropbox-sign/models/sub_team_response.rb +2 -4
- data/lib/dropbox-sign/models/sub_template_role.rb +2 -4
- data/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb +2 -4
- data/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb +2 -4
- data/lib/dropbox-sign/models/sub_white_labeling_options.rb +2 -4
- data/lib/dropbox-sign/models/team_add_member_request.rb +3 -5
- data/lib/dropbox-sign/models/team_create_request.rb +2 -4
- data/lib/dropbox-sign/models/team_get_info_response.rb +2 -4
- data/lib/dropbox-sign/models/team_get_response.rb +2 -4
- data/lib/dropbox-sign/models/team_info_response.rb +2 -4
- data/lib/dropbox-sign/models/team_invite_response.rb +2 -4
- data/lib/dropbox-sign/models/team_invites_response.rb +2 -4
- data/lib/dropbox-sign/models/team_member_response.rb +2 -4
- data/lib/dropbox-sign/models/team_members_response.rb +2 -4
- data/lib/dropbox-sign/models/team_parent_response.rb +2 -4
- data/lib/dropbox-sign/models/team_remove_member_request.rb +4 -6
- data/lib/dropbox-sign/models/team_response.rb +2 -4
- data/lib/dropbox-sign/models/team_sub_teams_response.rb +2 -4
- data/lib/dropbox-sign/models/team_update_request.rb +2 -4
- data/lib/dropbox-sign/models/template_add_user_request.rb +4 -6
- data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +6 -8
- data/lib/dropbox-sign/models/template_create_embedded_draft_response.rb +2 -4
- data/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb +2 -4
- data/lib/dropbox-sign/models/template_create_request.rb +6 -8
- data/lib/dropbox-sign/models/template_create_response.rb +2 -4
- data/lib/dropbox-sign/models/template_create_response_template.rb +2 -4
- data/lib/dropbox-sign/models/template_edit_response.rb +2 -4
- data/lib/dropbox-sign/models/template_get_response.rb +2 -4
- data/lib/dropbox-sign/models/template_list_response.rb +2 -4
- data/lib/dropbox-sign/models/template_remove_user_request.rb +2 -4
- data/lib/dropbox-sign/models/template_response.rb +2 -4
- data/lib/dropbox-sign/models/template_response_account.rb +2 -4
- data/lib/dropbox-sign/models/template_response_account_quota.rb +2 -4
- data/lib/dropbox-sign/models/template_response_cc_role.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document.rb +3 -5
- data/lib/dropbox-sign/models/template_response_document_custom_field_base.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_custom_field_checkbox.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_custom_field_text.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_field_group.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_field_group_rule.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_form_field_base.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_form_field_initials.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_form_field_radio.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_form_field_signature.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_form_field_text.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_static_field_base.rb +3 -5
- data/lib/dropbox-sign/models/template_response_document_static_field_checkbox.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_static_field_date_signed.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_static_field_dropdown.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_static_field_hyperlink.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_static_field_initials.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_static_field_radio.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_static_field_signature.rb +2 -4
- data/lib/dropbox-sign/models/template_response_document_static_field_text.rb +2 -4
- data/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +2 -4
- data/lib/dropbox-sign/models/template_response_signer_role.rb +2 -4
- data/lib/dropbox-sign/models/template_update_files_request.rb +4 -6
- data/lib/dropbox-sign/models/template_update_files_response.rb +2 -4
- data/lib/dropbox-sign/models/template_update_files_response_template.rb +2 -4
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +9 -10
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +8 -10
- data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +7 -8
- data/lib/dropbox-sign/models/unclaimed_draft_create_response.rb +2 -4
- data/lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb +2 -4
- data/lib/dropbox-sign/models/unclaimed_draft_response.rb +2 -4
- data/lib/dropbox-sign/models/warning_response.rb +2 -4
- data/lib/dropbox-sign/version.rb +2 -2
- data/lib/dropbox-sign.rb +2 -5
- data/openapi-config.yaml +1 -1
- data/openapi-sdk.yaml +1565 -2574
- data/run-build +1 -1
- data/spec/api_client_spec.rb +3 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- data/templates/README.mustache +1 -0
- data/templates/api.mustache +58 -12
- data/templates/api_client.mustache +16 -35
- data/templates/api_client_faraday_partial.mustache +102 -44
- data/templates/api_client_httpx_partial.mustache +134 -0
- data/templates/api_client_typhoeus_partial.mustache +23 -15
- data/templates/api_doc.mustache +1 -1
- data/templates/api_error.mustache +1 -0
- data/templates/api_info.mustache +1 -1
- data/templates/api_test.mustache +1 -1
- data/templates/base_object.mustache +1 -3
- data/templates/configuration.mustache +139 -33
- data/templates/configuration_faraday_partial.mustache +40 -0
- data/templates/configuration_httpx_partial.mustache +11 -0
- data/templates/configuration_typhoeus_partial.mustache +41 -0
- data/templates/gem.mustache +14 -0
- data/templates/gemspec.mustache +10 -4
- data/templates/model_test.mustache +3 -2
- data/templates/partial_model_enum_class.mustache +7 -4
- data/templates/partial_model_generic.mustache +7 -7
- data/templates/partial_oneof_module.mustache +4 -4
- data/templates/partial_oneof_module_doc.mustache +1 -0
- data/templates/travis.mustache +1 -4
- metadata +14 -16
- data/docs/SignatureRequestEditEmbeddedRequest.md +0 -33
- data/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md +0 -24
- data/docs/SignatureRequestEditRequest.md +0 -35
- data/docs/SignatureRequestEditWithTemplateRequest.md +0 -26
- data/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb +0 -593
- data/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb +0 -490
- data/lib/dropbox-sign/models/signature_request_edit_request.rb +0 -612
- data/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb +0 -509
@@ -6,7 +6,7 @@
|
|
6
6
|
The version of the OpenAPI document: 3.0.0
|
7
7
|
Contact: apisupport@hellosign.com
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
|
9
|
+
Generator version: 7.7.0
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -23,7 +23,7 @@ module Dropbox::Sign
|
|
23
23
|
@api_client = api_client
|
24
24
|
end
|
25
25
|
# Embedded Bulk Send with Template
|
26
|
-
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE
|
26
|
+
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher.
|
27
27
|
# @param signature_request_bulk_create_embedded_with_template_request [SignatureRequestBulkCreateEmbeddedWithTemplateRequest]
|
28
28
|
# @param [Hash] opts the optional parameters
|
29
29
|
# @return [BulkSendJobSendResponse]
|
@@ -33,7 +33,7 @@ module Dropbox::Sign
|
|
33
33
|
end
|
34
34
|
|
35
35
|
# Embedded Bulk Send with Template
|
36
|
-
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE
|
36
|
+
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher.
|
37
37
|
# @param signature_request_bulk_create_embedded_with_template_request [SignatureRequestBulkCreateEmbeddedWithTemplateRequest]
|
38
38
|
# @param [Hash] opts the optional parameters
|
39
39
|
# @return [Array<(BulkSendJobSendResponse, Integer, Hash)>] BulkSendJobSendResponse data, response status code and response headers
|
@@ -132,7 +132,7 @@ module Dropbox::Sign
|
|
132
132
|
end
|
133
133
|
|
134
134
|
# Bulk Send with Template
|
135
|
-
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE
|
135
|
+
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher.
|
136
136
|
# @param signature_request_bulk_send_with_template_request [SignatureRequestBulkSendWithTemplateRequest]
|
137
137
|
# @param [Hash] opts the optional parameters
|
138
138
|
# @return [BulkSendJobSendResponse]
|
@@ -142,7 +142,7 @@ module Dropbox::Sign
|
|
142
142
|
end
|
143
143
|
|
144
144
|
# Bulk Send with Template
|
145
|
-
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE
|
145
|
+
# Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher.
|
146
146
|
# @param signature_request_bulk_send_with_template_request [SignatureRequestBulkSendWithTemplateRequest]
|
147
147
|
# @param [Hash] opts the optional parameters
|
148
148
|
# @return [Array<(BulkSendJobSendResponse, Integer, Hash)>] BulkSendJobSendResponse data, response status code and response headers
|
@@ -241,7 +241,7 @@ module Dropbox::Sign
|
|
241
241
|
end
|
242
242
|
|
243
243
|
# Cancel Incomplete Signature Request
|
244
|
-
# Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE
|
244
|
+
# Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
|
245
245
|
# @param signature_request_id [String] The id of the incomplete SignatureRequest to cancel.
|
246
246
|
# @param [Hash] opts the optional parameters
|
247
247
|
# @return [nil]
|
@@ -251,7 +251,7 @@ module Dropbox::Sign
|
|
251
251
|
end
|
252
252
|
|
253
253
|
# Cancel Incomplete Signature Request
|
254
|
-
# Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE
|
254
|
+
# Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
|
255
255
|
# @param signature_request_id [String] The id of the incomplete SignatureRequest to cancel.
|
256
256
|
# @param [Hash] opts the optional parameters
|
257
257
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
@@ -308,7 +308,7 @@ module Dropbox::Sign
|
|
308
308
|
end
|
309
309
|
|
310
310
|
# Create Embedded Signature Request
|
311
|
-
# Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
|
311
|
+
# Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
|
312
312
|
# @param signature_request_create_embedded_request [SignatureRequestCreateEmbeddedRequest]
|
313
313
|
# @param [Hash] opts the optional parameters
|
314
314
|
# @return [SignatureRequestGetResponse]
|
@@ -318,7 +318,7 @@ module Dropbox::Sign
|
|
318
318
|
end
|
319
319
|
|
320
320
|
# Create Embedded Signature Request
|
321
|
-
# Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
|
321
|
+
# Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
|
322
322
|
# @param signature_request_create_embedded_request [SignatureRequestCreateEmbeddedRequest]
|
323
323
|
# @param [Hash] opts the optional parameters
|
324
324
|
# @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
|
@@ -417,7 +417,7 @@ module Dropbox::Sign
|
|
417
417
|
end
|
418
418
|
|
419
419
|
# Create Embedded Signature Request with Template
|
420
|
-
# Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame.
|
420
|
+
# Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
|
421
421
|
# @param signature_request_create_embedded_with_template_request [SignatureRequestCreateEmbeddedWithTemplateRequest]
|
422
422
|
# @param [Hash] opts the optional parameters
|
423
423
|
# @return [SignatureRequestGetResponse]
|
@@ -427,7 +427,7 @@ module Dropbox::Sign
|
|
427
427
|
end
|
428
428
|
|
429
429
|
# Create Embedded Signature Request with Template
|
430
|
-
# Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame.
|
430
|
+
# Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
|
431
431
|
# @param signature_request_create_embedded_with_template_request [SignatureRequestCreateEmbeddedWithTemplateRequest]
|
432
432
|
# @param [Hash] opts the optional parameters
|
433
433
|
# @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
|
@@ -525,466 +525,6 @@ module Dropbox::Sign
|
|
525
525
|
return data, status_code, headers
|
526
526
|
end
|
527
527
|
|
528
|
-
# Edit Signature Request
|
529
|
-
# Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota.
|
530
|
-
# @param signature_request_id [String] The id of the SignatureRequest to edit.
|
531
|
-
# @param signature_request_edit_request [SignatureRequestEditRequest]
|
532
|
-
# @param [Hash] opts the optional parameters
|
533
|
-
# @return [SignatureRequestGetResponse]
|
534
|
-
def signature_request_edit(signature_request_id, signature_request_edit_request, opts = {})
|
535
|
-
data, _status_code, _headers = signature_request_edit_with_http_info(signature_request_id, signature_request_edit_request, opts)
|
536
|
-
data
|
537
|
-
end
|
538
|
-
|
539
|
-
# Edit Signature Request
|
540
|
-
# Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend will not deduct your signature request quota.
|
541
|
-
# @param signature_request_id [String] The id of the SignatureRequest to edit.
|
542
|
-
# @param signature_request_edit_request [SignatureRequestEditRequest]
|
543
|
-
# @param [Hash] opts the optional parameters
|
544
|
-
# @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
|
545
|
-
def signature_request_edit_with_http_info(signature_request_id, signature_request_edit_request, opts = {})
|
546
|
-
if @api_client.config.debugging
|
547
|
-
@api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_edit ...'
|
548
|
-
end
|
549
|
-
# verify the required parameter 'signature_request_id' is set
|
550
|
-
if @api_client.config.client_side_validation && signature_request_id.nil?
|
551
|
-
fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_edit"
|
552
|
-
end
|
553
|
-
# verify the required parameter 'signature_request_edit_request' is set
|
554
|
-
if @api_client.config.client_side_validation && signature_request_edit_request.nil?
|
555
|
-
fail ArgumentError, "Missing the required parameter 'signature_request_edit_request' when calling SignatureRequestApi.signature_request_edit"
|
556
|
-
end
|
557
|
-
# resource path
|
558
|
-
local_var_path = '/signature_request/edit/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
|
559
|
-
|
560
|
-
# query parameters
|
561
|
-
query_params = opts[:query_params] || {}
|
562
|
-
|
563
|
-
# header parameters
|
564
|
-
header_params = opts[:header_params] || {}
|
565
|
-
# HTTP header 'Accept' (if needed)
|
566
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
567
|
-
# HTTP header 'Content-Type'
|
568
|
-
content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
|
569
|
-
if !content_type.nil?
|
570
|
-
header_params['Content-Type'] = content_type
|
571
|
-
end
|
572
|
-
|
573
|
-
post_body = {}
|
574
|
-
form_params = opts[:form_params] || {}
|
575
|
-
result = @api_client.generate_form_data(
|
576
|
-
signature_request_edit_request,
|
577
|
-
Dropbox::Sign::SignatureRequestEditRequest.openapi_types
|
578
|
-
)
|
579
|
-
|
580
|
-
# form parameters
|
581
|
-
if result[:has_file]
|
582
|
-
form_params = opts[:form_params] || result[:params]
|
583
|
-
header_params['Content-Type'] = 'multipart/form-data'
|
584
|
-
else
|
585
|
-
# http body (model)
|
586
|
-
post_body = opts[:debug_body] || result[:params]
|
587
|
-
end
|
588
|
-
|
589
|
-
# return_type
|
590
|
-
return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
|
591
|
-
|
592
|
-
# auth_names
|
593
|
-
auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
|
594
|
-
|
595
|
-
new_options = opts.merge(
|
596
|
-
:operation => :"SignatureRequestApi.signature_request_edit",
|
597
|
-
:header_params => header_params,
|
598
|
-
:query_params => query_params,
|
599
|
-
:form_params => form_params,
|
600
|
-
:body => post_body,
|
601
|
-
:auth_names => auth_names,
|
602
|
-
:return_type => return_type
|
603
|
-
)
|
604
|
-
|
605
|
-
begin
|
606
|
-
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
607
|
-
rescue Dropbox::Sign::ApiError => e
|
608
|
-
if e.code === 200
|
609
|
-
body = @api_client.convert_to_type(
|
610
|
-
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
611
|
-
"Dropbox::Sign::SignatureRequestGetResponse"
|
612
|
-
)
|
613
|
-
|
614
|
-
fail ApiError.new(:code => e.code,
|
615
|
-
:response_headers => e.response_headers,
|
616
|
-
:response_body => body),
|
617
|
-
e.message
|
618
|
-
end
|
619
|
-
|
620
|
-
range_code = "4XX".split('').first
|
621
|
-
range_code_left = "#{range_code}00".to_i
|
622
|
-
range_code_right = "#{range_code}99".to_i
|
623
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
624
|
-
body = @api_client.convert_to_type(
|
625
|
-
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
626
|
-
"Dropbox::Sign::ErrorResponse"
|
627
|
-
)
|
628
|
-
|
629
|
-
fail ApiError.new(:code => e.code,
|
630
|
-
:response_headers => e.response_headers,
|
631
|
-
:response_body => body),
|
632
|
-
e.message
|
633
|
-
end
|
634
|
-
|
635
|
-
end
|
636
|
-
|
637
|
-
if @api_client.config.debugging
|
638
|
-
@api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_edit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
639
|
-
end
|
640
|
-
return data, status_code, headers
|
641
|
-
end
|
642
|
-
|
643
|
-
# Edit Embedded Signature Request
|
644
|
-
# Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
|
645
|
-
# @param signature_request_id [String] The id of the SignatureRequest to edit.
|
646
|
-
# @param signature_request_edit_embedded_request [SignatureRequestEditEmbeddedRequest]
|
647
|
-
# @param [Hash] opts the optional parameters
|
648
|
-
# @return [SignatureRequestGetResponse]
|
649
|
-
def signature_request_edit_embedded(signature_request_id, signature_request_edit_embedded_request, opts = {})
|
650
|
-
data, _status_code, _headers = signature_request_edit_embedded_with_http_info(signature_request_id, signature_request_edit_embedded_request, opts)
|
651
|
-
data
|
652
|
-
end
|
653
|
-
|
654
|
-
# Edit Embedded Signature Request
|
655
|
-
# Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
|
656
|
-
# @param signature_request_id [String] The id of the SignatureRequest to edit.
|
657
|
-
# @param signature_request_edit_embedded_request [SignatureRequestEditEmbeddedRequest]
|
658
|
-
# @param [Hash] opts the optional parameters
|
659
|
-
# @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
|
660
|
-
def signature_request_edit_embedded_with_http_info(signature_request_id, signature_request_edit_embedded_request, opts = {})
|
661
|
-
if @api_client.config.debugging
|
662
|
-
@api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_edit_embedded ...'
|
663
|
-
end
|
664
|
-
# verify the required parameter 'signature_request_id' is set
|
665
|
-
if @api_client.config.client_side_validation && signature_request_id.nil?
|
666
|
-
fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_edit_embedded"
|
667
|
-
end
|
668
|
-
# verify the required parameter 'signature_request_edit_embedded_request' is set
|
669
|
-
if @api_client.config.client_side_validation && signature_request_edit_embedded_request.nil?
|
670
|
-
fail ArgumentError, "Missing the required parameter 'signature_request_edit_embedded_request' when calling SignatureRequestApi.signature_request_edit_embedded"
|
671
|
-
end
|
672
|
-
# resource path
|
673
|
-
local_var_path = '/signature_request/edit_embedded/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
|
674
|
-
|
675
|
-
# query parameters
|
676
|
-
query_params = opts[:query_params] || {}
|
677
|
-
|
678
|
-
# header parameters
|
679
|
-
header_params = opts[:header_params] || {}
|
680
|
-
# HTTP header 'Accept' (if needed)
|
681
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
682
|
-
# HTTP header 'Content-Type'
|
683
|
-
content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
|
684
|
-
if !content_type.nil?
|
685
|
-
header_params['Content-Type'] = content_type
|
686
|
-
end
|
687
|
-
|
688
|
-
post_body = {}
|
689
|
-
form_params = opts[:form_params] || {}
|
690
|
-
result = @api_client.generate_form_data(
|
691
|
-
signature_request_edit_embedded_request,
|
692
|
-
Dropbox::Sign::SignatureRequestEditEmbeddedRequest.openapi_types
|
693
|
-
)
|
694
|
-
|
695
|
-
# form parameters
|
696
|
-
if result[:has_file]
|
697
|
-
form_params = opts[:form_params] || result[:params]
|
698
|
-
header_params['Content-Type'] = 'multipart/form-data'
|
699
|
-
else
|
700
|
-
# http body (model)
|
701
|
-
post_body = opts[:debug_body] || result[:params]
|
702
|
-
end
|
703
|
-
|
704
|
-
# return_type
|
705
|
-
return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
|
706
|
-
|
707
|
-
# auth_names
|
708
|
-
auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
|
709
|
-
|
710
|
-
new_options = opts.merge(
|
711
|
-
:operation => :"SignatureRequestApi.signature_request_edit_embedded",
|
712
|
-
:header_params => header_params,
|
713
|
-
:query_params => query_params,
|
714
|
-
:form_params => form_params,
|
715
|
-
:body => post_body,
|
716
|
-
:auth_names => auth_names,
|
717
|
-
:return_type => return_type
|
718
|
-
)
|
719
|
-
|
720
|
-
begin
|
721
|
-
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
722
|
-
rescue Dropbox::Sign::ApiError => e
|
723
|
-
if e.code === 200
|
724
|
-
body = @api_client.convert_to_type(
|
725
|
-
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
726
|
-
"Dropbox::Sign::SignatureRequestGetResponse"
|
727
|
-
)
|
728
|
-
|
729
|
-
fail ApiError.new(:code => e.code,
|
730
|
-
:response_headers => e.response_headers,
|
731
|
-
:response_body => body),
|
732
|
-
e.message
|
733
|
-
end
|
734
|
-
|
735
|
-
range_code = "4XX".split('').first
|
736
|
-
range_code_left = "#{range_code}00".to_i
|
737
|
-
range_code_right = "#{range_code}99".to_i
|
738
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
739
|
-
body = @api_client.convert_to_type(
|
740
|
-
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
741
|
-
"Dropbox::Sign::ErrorResponse"
|
742
|
-
)
|
743
|
-
|
744
|
-
fail ApiError.new(:code => e.code,
|
745
|
-
:response_headers => e.response_headers,
|
746
|
-
:response_body => body),
|
747
|
-
e.message
|
748
|
-
end
|
749
|
-
|
750
|
-
end
|
751
|
-
|
752
|
-
if @api_client.config.debugging
|
753
|
-
@api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_edit_embedded\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
754
|
-
end
|
755
|
-
return data, status_code, headers
|
756
|
-
end
|
757
|
-
|
758
|
-
# Edit Embedded Signature Request with Template
|
759
|
-
# Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
|
760
|
-
# @param signature_request_id [String] The id of the SignatureRequest to edit.
|
761
|
-
# @param signature_request_edit_embedded_with_template_request [SignatureRequestEditEmbeddedWithTemplateRequest]
|
762
|
-
# @param [Hash] opts the optional parameters
|
763
|
-
# @return [SignatureRequestGetResponse]
|
764
|
-
def signature_request_edit_embedded_with_template(signature_request_id, signature_request_edit_embedded_with_template_request, opts = {})
|
765
|
-
data, _status_code, _headers = signature_request_edit_embedded_with_template_with_http_info(signature_request_id, signature_request_edit_embedded_with_template_request, opts)
|
766
|
-
data
|
767
|
-
end
|
768
|
-
|
769
|
-
# Edit Embedded Signature Request with Template
|
770
|
-
# Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
|
771
|
-
# @param signature_request_id [String] The id of the SignatureRequest to edit.
|
772
|
-
# @param signature_request_edit_embedded_with_template_request [SignatureRequestEditEmbeddedWithTemplateRequest]
|
773
|
-
# @param [Hash] opts the optional parameters
|
774
|
-
# @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
|
775
|
-
def signature_request_edit_embedded_with_template_with_http_info(signature_request_id, signature_request_edit_embedded_with_template_request, opts = {})
|
776
|
-
if @api_client.config.debugging
|
777
|
-
@api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_edit_embedded_with_template ...'
|
778
|
-
end
|
779
|
-
# verify the required parameter 'signature_request_id' is set
|
780
|
-
if @api_client.config.client_side_validation && signature_request_id.nil?
|
781
|
-
fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_edit_embedded_with_template"
|
782
|
-
end
|
783
|
-
# verify the required parameter 'signature_request_edit_embedded_with_template_request' is set
|
784
|
-
if @api_client.config.client_side_validation && signature_request_edit_embedded_with_template_request.nil?
|
785
|
-
fail ArgumentError, "Missing the required parameter 'signature_request_edit_embedded_with_template_request' when calling SignatureRequestApi.signature_request_edit_embedded_with_template"
|
786
|
-
end
|
787
|
-
# resource path
|
788
|
-
local_var_path = '/signature_request/edit_embedded_with_template/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
|
789
|
-
|
790
|
-
# query parameters
|
791
|
-
query_params = opts[:query_params] || {}
|
792
|
-
|
793
|
-
# header parameters
|
794
|
-
header_params = opts[:header_params] || {}
|
795
|
-
# HTTP header 'Accept' (if needed)
|
796
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
797
|
-
# HTTP header 'Content-Type'
|
798
|
-
content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
|
799
|
-
if !content_type.nil?
|
800
|
-
header_params['Content-Type'] = content_type
|
801
|
-
end
|
802
|
-
|
803
|
-
post_body = {}
|
804
|
-
form_params = opts[:form_params] || {}
|
805
|
-
result = @api_client.generate_form_data(
|
806
|
-
signature_request_edit_embedded_with_template_request,
|
807
|
-
Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest.openapi_types
|
808
|
-
)
|
809
|
-
|
810
|
-
# form parameters
|
811
|
-
if result[:has_file]
|
812
|
-
form_params = opts[:form_params] || result[:params]
|
813
|
-
header_params['Content-Type'] = 'multipart/form-data'
|
814
|
-
else
|
815
|
-
# http body (model)
|
816
|
-
post_body = opts[:debug_body] || result[:params]
|
817
|
-
end
|
818
|
-
|
819
|
-
# return_type
|
820
|
-
return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
|
821
|
-
|
822
|
-
# auth_names
|
823
|
-
auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
|
824
|
-
|
825
|
-
new_options = opts.merge(
|
826
|
-
:operation => :"SignatureRequestApi.signature_request_edit_embedded_with_template",
|
827
|
-
:header_params => header_params,
|
828
|
-
:query_params => query_params,
|
829
|
-
:form_params => form_params,
|
830
|
-
:body => post_body,
|
831
|
-
:auth_names => auth_names,
|
832
|
-
:return_type => return_type
|
833
|
-
)
|
834
|
-
|
835
|
-
begin
|
836
|
-
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
837
|
-
rescue Dropbox::Sign::ApiError => e
|
838
|
-
if e.code === 200
|
839
|
-
body = @api_client.convert_to_type(
|
840
|
-
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
841
|
-
"Dropbox::Sign::SignatureRequestGetResponse"
|
842
|
-
)
|
843
|
-
|
844
|
-
fail ApiError.new(:code => e.code,
|
845
|
-
:response_headers => e.response_headers,
|
846
|
-
:response_body => body),
|
847
|
-
e.message
|
848
|
-
end
|
849
|
-
|
850
|
-
range_code = "4XX".split('').first
|
851
|
-
range_code_left = "#{range_code}00".to_i
|
852
|
-
range_code_right = "#{range_code}99".to_i
|
853
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
854
|
-
body = @api_client.convert_to_type(
|
855
|
-
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
856
|
-
"Dropbox::Sign::ErrorResponse"
|
857
|
-
)
|
858
|
-
|
859
|
-
fail ApiError.new(:code => e.code,
|
860
|
-
:response_headers => e.response_headers,
|
861
|
-
:response_body => body),
|
862
|
-
e.message
|
863
|
-
end
|
864
|
-
|
865
|
-
end
|
866
|
-
|
867
|
-
if @api_client.config.debugging
|
868
|
-
@api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_edit_embedded_with_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
869
|
-
end
|
870
|
-
return data, status_code, headers
|
871
|
-
end
|
872
|
-
|
873
|
-
# Edit Signature Request With Template
|
874
|
-
# Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota.
|
875
|
-
# @param signature_request_id [String] The id of the SignatureRequest to edit.
|
876
|
-
# @param signature_request_edit_with_template_request [SignatureRequestEditWithTemplateRequest]
|
877
|
-
# @param [Hash] opts the optional parameters
|
878
|
-
# @return [SignatureRequestGetResponse]
|
879
|
-
def signature_request_edit_with_template(signature_request_id, signature_request_edit_with_template_request, opts = {})
|
880
|
-
data, _status_code, _headers = signature_request_edit_with_template_with_http_info(signature_request_id, signature_request_edit_with_template_request, opts)
|
881
|
-
data
|
882
|
-
end
|
883
|
-
|
884
|
-
# Edit Signature Request With Template
|
885
|
-
# Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota.
|
886
|
-
# @param signature_request_id [String] The id of the SignatureRequest to edit.
|
887
|
-
# @param signature_request_edit_with_template_request [SignatureRequestEditWithTemplateRequest]
|
888
|
-
# @param [Hash] opts the optional parameters
|
889
|
-
# @return [Array<(SignatureRequestGetResponse, Integer, Hash)>] SignatureRequestGetResponse data, response status code and response headers
|
890
|
-
def signature_request_edit_with_template_with_http_info(signature_request_id, signature_request_edit_with_template_request, opts = {})
|
891
|
-
if @api_client.config.debugging
|
892
|
-
@api_client.config.logger.debug 'Calling API: SignatureRequestApi.signature_request_edit_with_template ...'
|
893
|
-
end
|
894
|
-
# verify the required parameter 'signature_request_id' is set
|
895
|
-
if @api_client.config.client_side_validation && signature_request_id.nil?
|
896
|
-
fail ArgumentError, "Missing the required parameter 'signature_request_id' when calling SignatureRequestApi.signature_request_edit_with_template"
|
897
|
-
end
|
898
|
-
# verify the required parameter 'signature_request_edit_with_template_request' is set
|
899
|
-
if @api_client.config.client_side_validation && signature_request_edit_with_template_request.nil?
|
900
|
-
fail ArgumentError, "Missing the required parameter 'signature_request_edit_with_template_request' when calling SignatureRequestApi.signature_request_edit_with_template"
|
901
|
-
end
|
902
|
-
# resource path
|
903
|
-
local_var_path = '/signature_request/edit_with_template/{signature_request_id}'.sub('{' + 'signature_request_id' + '}', CGI.escape(signature_request_id.to_s))
|
904
|
-
|
905
|
-
# query parameters
|
906
|
-
query_params = opts[:query_params] || {}
|
907
|
-
|
908
|
-
# header parameters
|
909
|
-
header_params = opts[:header_params] || {}
|
910
|
-
# HTTP header 'Accept' (if needed)
|
911
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
912
|
-
# HTTP header 'Content-Type'
|
913
|
-
content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
|
914
|
-
if !content_type.nil?
|
915
|
-
header_params['Content-Type'] = content_type
|
916
|
-
end
|
917
|
-
|
918
|
-
post_body = {}
|
919
|
-
form_params = opts[:form_params] || {}
|
920
|
-
result = @api_client.generate_form_data(
|
921
|
-
signature_request_edit_with_template_request,
|
922
|
-
Dropbox::Sign::SignatureRequestEditWithTemplateRequest.openapi_types
|
923
|
-
)
|
924
|
-
|
925
|
-
# form parameters
|
926
|
-
if result[:has_file]
|
927
|
-
form_params = opts[:form_params] || result[:params]
|
928
|
-
header_params['Content-Type'] = 'multipart/form-data'
|
929
|
-
else
|
930
|
-
# http body (model)
|
931
|
-
post_body = opts[:debug_body] || result[:params]
|
932
|
-
end
|
933
|
-
|
934
|
-
# return_type
|
935
|
-
return_type = opts[:debug_return_type] || 'SignatureRequestGetResponse'
|
936
|
-
|
937
|
-
# auth_names
|
938
|
-
auth_names = opts[:debug_auth_names] || ['api_key', 'oauth2']
|
939
|
-
|
940
|
-
new_options = opts.merge(
|
941
|
-
:operation => :"SignatureRequestApi.signature_request_edit_with_template",
|
942
|
-
:header_params => header_params,
|
943
|
-
:query_params => query_params,
|
944
|
-
:form_params => form_params,
|
945
|
-
:body => post_body,
|
946
|
-
:auth_names => auth_names,
|
947
|
-
:return_type => return_type
|
948
|
-
)
|
949
|
-
|
950
|
-
begin
|
951
|
-
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
952
|
-
rescue Dropbox::Sign::ApiError => e
|
953
|
-
if e.code === 200
|
954
|
-
body = @api_client.convert_to_type(
|
955
|
-
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
956
|
-
"Dropbox::Sign::SignatureRequestGetResponse"
|
957
|
-
)
|
958
|
-
|
959
|
-
fail ApiError.new(:code => e.code,
|
960
|
-
:response_headers => e.response_headers,
|
961
|
-
:response_body => body),
|
962
|
-
e.message
|
963
|
-
end
|
964
|
-
|
965
|
-
range_code = "4XX".split('').first
|
966
|
-
range_code_left = "#{range_code}00".to_i
|
967
|
-
range_code_right = "#{range_code}99".to_i
|
968
|
-
if e.code >= range_code_left && e.code <= range_code_right
|
969
|
-
body = @api_client.convert_to_type(
|
970
|
-
JSON.parse("[#{e.response_body}]", :symbolize_names => true)[0],
|
971
|
-
"Dropbox::Sign::ErrorResponse"
|
972
|
-
)
|
973
|
-
|
974
|
-
fail ApiError.new(:code => e.code,
|
975
|
-
:response_headers => e.response_headers,
|
976
|
-
:response_body => body),
|
977
|
-
e.message
|
978
|
-
end
|
979
|
-
|
980
|
-
end
|
981
|
-
|
982
|
-
if @api_client.config.debugging
|
983
|
-
@api_client.config.logger.debug "API called: SignatureRequestApi#signature_request_edit_with_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
984
|
-
end
|
985
|
-
return data, status_code, headers
|
986
|
-
end
|
987
|
-
|
988
528
|
# Download Files
|
989
529
|
# Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead.
|
990
530
|
# @param signature_request_id [String] The id of the SignatureRequest to retrieve.
|
@@ -1000,7 +540,7 @@ module Dropbox::Sign
|
|
1000
540
|
# Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead.
|
1001
541
|
# @param signature_request_id [String] The id of the SignatureRequest to retrieve.
|
1002
542
|
# @param [Hash] opts the optional parameters
|
1003
|
-
# @option opts [String] :file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents.
|
543
|
+
# @option opts [String] :file_type Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (default to 'pdf')
|
1004
544
|
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
|
1005
545
|
def signature_request_files_with_http_info(signature_request_id, opts = {})
|
1006
546
|
if @api_client.config.debugging
|
@@ -1195,7 +735,7 @@ module Dropbox::Sign
|
|
1195
735
|
# Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead.
|
1196
736
|
# @param signature_request_id [String] The id of the SignatureRequest to retrieve.
|
1197
737
|
# @param [Hash] opts the optional parameters
|
1198
|
-
# @option opts [Integer] :force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.
|
738
|
+
# @option opts [Integer] :force_download By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (default to 1)
|
1199
739
|
# @return [Array<(FileResponse, Integer, Hash)>] FileResponse data, response status code and response headers
|
1200
740
|
def signature_request_files_as_file_url_with_http_info(signature_request_id, opts = {})
|
1201
741
|
if @api_client.config.debugging
|
@@ -1388,8 +928,8 @@ module Dropbox::Sign
|
|
1388
928
|
# Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests.
|
1389
929
|
# @param [Hash] opts the optional parameters
|
1390
930
|
# @option opts [String] :account_id Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.
|
1391
|
-
# @option opts [Integer] :page Which page number of the SignatureRequest List to return. Defaults to `1`.
|
1392
|
-
# @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.
|
931
|
+
# @option opts [Integer] :page Which page number of the SignatureRequest List to return. Defaults to `1`. (default to 1)
|
932
|
+
# @option opts [Integer] :page_size Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (default to 20)
|
1393
933
|
# @option opts [String] :query String that includes search terms and/or fields to be used to filter the SignatureRequest objects.
|
1394
934
|
# @return [Array<(SignatureRequestListResponse, Integer, Hash)>] SignatureRequestListResponse data, response status code and response headers
|
1395
935
|
def signature_request_list_with_http_info(opts = {})
|
@@ -1566,7 +1106,7 @@ module Dropbox::Sign
|
|
1566
1106
|
end
|
1567
1107
|
|
1568
1108
|
# Send Request Reminder
|
1569
|
-
# Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE
|
1109
|
+
# Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests.
|
1570
1110
|
# @param signature_request_id [String] The id of the SignatureRequest to send a reminder for.
|
1571
1111
|
# @param signature_request_remind_request [SignatureRequestRemindRequest]
|
1572
1112
|
# @param [Hash] opts the optional parameters
|
@@ -1577,7 +1117,7 @@ module Dropbox::Sign
|
|
1577
1117
|
end
|
1578
1118
|
|
1579
1119
|
# Send Request Reminder
|
1580
|
-
# Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE
|
1120
|
+
# Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests.
|
1581
1121
|
# @param signature_request_id [String] The id of the SignatureRequest to send a reminder for.
|
1582
1122
|
# @param signature_request_remind_request [SignatureRequestRemindRequest]
|
1583
1123
|
# @param [Hash] opts the optional parameters
|
@@ -1966,7 +1506,7 @@ module Dropbox::Sign
|
|
1966
1506
|
end
|
1967
1507
|
|
1968
1508
|
# Update Signature Request
|
1969
|
-
# Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE
|
1509
|
+
# Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page.
|
1970
1510
|
# @param signature_request_id [String] The id of the SignatureRequest to update.
|
1971
1511
|
# @param signature_request_update_request [SignatureRequestUpdateRequest]
|
1972
1512
|
# @param [Hash] opts the optional parameters
|
@@ -1977,7 +1517,7 @@ module Dropbox::Sign
|
|
1977
1517
|
end
|
1978
1518
|
|
1979
1519
|
# Update Signature Request
|
1980
|
-
# Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE
|
1520
|
+
# Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page.
|
1981
1521
|
# @param signature_request_id [String] The id of the SignatureRequest to update.
|
1982
1522
|
# @param signature_request_update_request [SignatureRequestUpdateRequest]
|
1983
1523
|
# @param [Hash] opts the optional parameters
|