dropbox-sign 1.7.0 → 1.9.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 +5 -5
- data/README.md +23 -16
- data/VERSION +1 -1
- data/docs/AccountApi.md +33 -38
- data/docs/ApiAppApi.md +64 -64
- data/docs/BulkSendJobApi.md +21 -21
- data/docs/BulkSendJobGetResponseSignatureRequests.md +1 -1
- data/docs/EmbeddedApi.md +22 -22
- data/docs/FaxApi.md +57 -55
- data/docs/FaxLineAddUserRequest.md +1 -1
- data/docs/FaxLineApi.md +74 -63
- data/docs/FaxLineCreateRequest.md +4 -4
- data/docs/FaxLineDeleteRequest.md +1 -1
- data/docs/FaxLineRemoveUserRequest.md +3 -3
- data/docs/FaxResponse.md +4 -3
- data/docs/FaxResponseTransmission.md +0 -1
- data/docs/FaxSendRequest.md +5 -5
- data/docs/OAuthApi.md +27 -15
- data/docs/ReportApi.md +14 -13
- data/docs/SignatureRequestApi.md +822 -311
- data/docs/SignatureRequestEditEmbeddedRequest.md +33 -0
- data/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md +24 -0
- data/docs/SignatureRequestEditRequest.md +34 -0
- data/docs/SignatureRequestEditWithTemplateRequest.md +25 -0
- data/docs/SignatureRequestResponse.md +1 -1
- data/docs/SignatureRequestResponseDataValueInitials.md +1 -0
- data/docs/SignatureRequestResponseDataValueSignature.md +1 -0
- data/docs/TeamApi.md +84 -95
- data/docs/TemplateApi.md +210 -166
- data/docs/TemplateResponse.md +1 -1
- data/docs/UnclaimedDraftApi.md +77 -91
- data/dropbox-sign.gemspec +1 -1
- data/examples/AccountCreateExample.rb +20 -0
- data/examples/AccountCreateOauthExample.rb +22 -0
- data/examples/AccountGetExample.rb +15 -0
- data/examples/AccountUpdateExample.rb +21 -0
- data/examples/AccountVerifyExample.rb +20 -0
- data/examples/ApiAppCreateExample.rb +37 -0
- data/examples/ApiAppDeleteExample.rb +15 -0
- data/examples/ApiAppGetExample.rb +17 -0
- data/examples/ApiAppListExample.rb +20 -0
- data/examples/ApiAppUpdateExample.rb +39 -0
- data/examples/BulkSendJobGetExample.rb +21 -0
- data/examples/BulkSendJobListExample.rb +20 -0
- data/examples/EmbeddedEditUrlExample.rb +27 -0
- data/examples/EmbeddedSignUrlExample.rb +17 -0
- data/examples/FaxDeleteExample.rb +14 -0
- data/examples/FaxFilesExample.rb +16 -0
- data/examples/FaxGetExample.rb +16 -0
- data/examples/FaxLineAddUserExample.rb +20 -0
- data/examples/FaxLineAreaCodeGetExample.rb +16 -0
- data/examples/FaxLineCreateExample.rb +20 -0
- data/examples/FaxLineDeleteExample.rb +17 -0
- data/examples/FaxLineGetExample.rb +16 -0
- data/examples/FaxLineListExample.rb +21 -0
- data/examples/FaxLineRemoveUserExample.rb +20 -0
- data/examples/FaxListExample.rb +19 -0
- data/examples/FaxSendExample.rb +28 -0
- data/examples/OauthTokenGenerateExample.rb +22 -0
- data/examples/OauthTokenRefreshExample.rb +19 -0
- data/examples/ReportCreateExample.rb +24 -0
- data/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb +84 -0
- data/examples/SignatureRequestBulkSendWithTemplateExample.rb +84 -0
- data/examples/SignatureRequestCancelExample.rb +15 -0
- data/examples/SignatureRequestCreateEmbeddedExample.rb +55 -0
- data/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.rb +81 -0
- data/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb +44 -0
- data/examples/SignatureRequestEditEmbeddedExample.rb +56 -0
- data/examples/SignatureRequestEditEmbeddedGroupedSignersExample.rb +82 -0
- data/examples/SignatureRequestEditEmbeddedWithTemplateExample.rb +45 -0
- data/examples/SignatureRequestEditExample.rb +66 -0
- data/examples/SignatureRequestEditGroupedSignersExample.rb +92 -0
- data/examples/SignatureRequestEditWithTemplateExample.rb +64 -0
- data/examples/SignatureRequestFilesAsDataUriExample.rb +17 -0
- data/examples/SignatureRequestFilesAsFileUrlExample.rb +20 -0
- data/examples/SignatureRequestFilesExample.rb +20 -0
- data/examples/SignatureRequestGetExample.rb +17 -0
- data/examples/SignatureRequestListExample.rb +22 -0
- data/examples/SignatureRequestReleaseHoldExample.rb +17 -0
- data/examples/SignatureRequestRemindExample.rb +21 -0
- data/examples/SignatureRequestRemoveExample.rb +14 -0
- data/examples/SignatureRequestSendExample.rb +65 -0
- data/examples/SignatureRequestSendGroupedSignersExample.rb +91 -0
- data/examples/SignatureRequestSendWithTemplateExample.rb +63 -0
- data/examples/SignatureRequestUpdateExample.rb +22 -0
- data/examples/TeamAddMemberAccountIdExample.rb +23 -0
- data/examples/TeamAddMemberExample.rb +23 -0
- data/examples/TeamCreateExample.rb +20 -0
- data/examples/TeamDeleteExample.rb +13 -0
- data/examples/TeamGetExample.rb +15 -0
- data/examples/TeamInfoExample.rb +19 -0
- data/examples/TeamInvitesExample.rb +15 -0
- data/examples/TeamMembersExample.rb +21 -0
- data/examples/TeamRemoveMemberAccountIdExample.rb +20 -0
- data/examples/TeamRemoveMemberExample.rb +21 -0
- data/examples/TeamSubTeamsExample.rb +21 -0
- data/examples/TeamUpdateExample.rb +20 -0
- data/examples/TemplateAddUserExample.rb +21 -0
- data/examples/TemplateCreateEmbeddedDraftExample.rb +62 -0
- data/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.rb +108 -0
- data/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.rb +124 -0
- data/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.rb +96 -0
- data/examples/TemplateCreateExample.rb +96 -0
- data/examples/TemplateCreateFormFieldGroupsExample.rb +108 -0
- data/examples/TemplateCreateFormFieldRulesExample.rb +124 -0
- data/examples/TemplateCreateFormFieldsPerDocumentExample.rb +96 -0
- data/examples/TemplateDeleteExample.rb +15 -0
- data/examples/TemplateFilesAsDataUriExample.rb +17 -0
- data/examples/TemplateFilesAsFileUrlExample.rb +20 -0
- data/examples/TemplateFilesExample.rb +17 -0
- data/examples/TemplateGetExample.rb +17 -0
- data/examples/TemplateListExample.rb +22 -0
- data/examples/TemplateRemoveUserExample.rb +21 -0
- data/examples/TemplateUpdateFilesExample.rb +23 -0
- data/examples/UnclaimedDraftCreateEmbeddedExample.rb +25 -0
- data/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.rb +71 -0
- data/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.rb +87 -0
- data/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.rb +59 -0
- data/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb +44 -0
- data/examples/UnclaimedDraftCreateExample.rb +34 -0
- data/examples/UnclaimedDraftCreateFormFieldGroupsExample.rb +70 -0
- data/examples/UnclaimedDraftCreateFormFieldRulesExample.rb +86 -0
- data/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.rb +58 -0
- data/examples/UnclaimedDraftEditAndResendExample.rb +22 -0
- data/lib/dropbox-sign/api/account_api.rb +1 -1
- data/lib/dropbox-sign/api/api_app_api.rb +1 -1
- data/lib/dropbox-sign/api/bulk_send_job_api.rb +1 -1
- data/lib/dropbox-sign/api/embedded_api.rb +1 -1
- data/lib/dropbox-sign/api/fax_api.rb +17 -17
- data/lib/dropbox-sign/api/fax_line_api.rb +23 -23
- 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 +461 -1
- data/lib/dropbox-sign/api/team_api.rb +1 -1
- data/lib/dropbox-sign/api/template_api.rb +1 -1
- data/lib/dropbox-sign/api/unclaimed_draft_api.rb +1 -1
- data/lib/dropbox-sign/api_client.rb +8 -9
- data/lib/dropbox-sign/api_error.rb +1 -1
- data/lib/dropbox-sign/configuration.rb +1 -1
- data/lib/dropbox-sign/event_callback_helper.rb +1 -1
- data/lib/dropbox-sign/models/account_create_request.rb +19 -3
- data/lib/dropbox-sign/models/account_create_response.rb +19 -3
- data/lib/dropbox-sign/models/account_get_response.rb +19 -3
- data/lib/dropbox-sign/models/account_response.rb +9 -3
- data/lib/dropbox-sign/models/account_response_quotas.rb +9 -3
- data/lib/dropbox-sign/models/account_response_usage.rb +9 -3
- data/lib/dropbox-sign/models/account_update_request.rb +9 -3
- data/lib/dropbox-sign/models/account_verify_request.rb +19 -3
- data/lib/dropbox-sign/models/account_verify_response.rb +9 -3
- data/lib/dropbox-sign/models/account_verify_response_account.rb +9 -3
- data/lib/dropbox-sign/models/api_app_create_request.rb +19 -3
- data/lib/dropbox-sign/models/api_app_get_response.rb +19 -3
- data/lib/dropbox-sign/models/api_app_list_response.rb +29 -3
- data/lib/dropbox-sign/models/api_app_response.rb +9 -3
- data/lib/dropbox-sign/models/api_app_response_o_auth.rb +9 -3
- data/lib/dropbox-sign/models/api_app_response_options.rb +9 -3
- data/lib/dropbox-sign/models/api_app_response_owner_account.rb +9 -3
- data/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb +9 -3
- data/lib/dropbox-sign/models/api_app_update_request.rb +9 -3
- data/lib/dropbox-sign/models/bulk_send_job_get_response.rb +39 -3
- data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +19 -10
- data/lib/dropbox-sign/models/bulk_send_job_list_response.rb +29 -3
- data/lib/dropbox-sign/models/bulk_send_job_response.rb +9 -3
- data/lib/dropbox-sign/models/bulk_send_job_send_response.rb +19 -3
- data/lib/dropbox-sign/models/embedded_edit_url_request.rb +9 -3
- data/lib/dropbox-sign/models/embedded_edit_url_response.rb +19 -3
- data/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb +9 -3
- data/lib/dropbox-sign/models/embedded_sign_url_response.rb +19 -3
- data/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb +9 -3
- data/lib/dropbox-sign/models/error_response.rb +19 -3
- data/lib/dropbox-sign/models/error_response_error.rb +29 -3
- data/lib/dropbox-sign/models/event_callback_request.rb +19 -3
- data/lib/dropbox-sign/models/event_callback_request_event.rb +29 -3
- data/lib/dropbox-sign/models/event_callback_request_event_metadata.rb +9 -3
- data/lib/dropbox-sign/models/fax_get_response.rb +19 -3
- data/lib/dropbox-sign/models/fax_line_add_user_request.rb +20 -4
- data/lib/dropbox-sign/models/fax_line_area_code_get_country_enum.rb +1 -1
- data/lib/dropbox-sign/models/fax_line_area_code_get_province_enum.rb +1 -1
- data/lib/dropbox-sign/models/fax_line_area_code_get_response.rb +19 -3
- data/lib/dropbox-sign/models/fax_line_area_code_get_state_enum.rb +1 -1
- data/lib/dropbox-sign/models/fax_line_create_request.rb +23 -7
- data/lib/dropbox-sign/models/fax_line_delete_request.rb +20 -4
- data/lib/dropbox-sign/models/fax_line_list_response.rb +29 -3
- data/lib/dropbox-sign/models/fax_line_remove_user_request.rb +22 -6
- data/lib/dropbox-sign/models/fax_line_response.rb +19 -3
- data/lib/dropbox-sign/models/fax_line_response_fax_line.rb +9 -3
- data/lib/dropbox-sign/models/fax_list_response.rb +29 -3
- data/lib/dropbox-sign/models/fax_response.rb +139 -49
- data/lib/dropbox-sign/models/fax_response_transmission.rb +20 -20
- data/lib/dropbox-sign/models/fax_send_request.rb +24 -8
- data/lib/dropbox-sign/models/file_response.rb +29 -3
- data/lib/dropbox-sign/models/file_response_data_uri.rb +19 -3
- data/lib/dropbox-sign/models/list_info_response.rb +9 -3
- data/lib/dropbox-sign/models/o_auth_token_generate_request.rb +59 -3
- data/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +29 -3
- data/lib/dropbox-sign/models/o_auth_token_response.rb +9 -3
- data/lib/dropbox-sign/models/report_create_request.rb +29 -3
- data/lib/dropbox-sign/models/report_create_response.rb +19 -3
- data/lib/dropbox-sign/models/report_response.rb +9 -3
- data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +29 -3
- data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +19 -3
- data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +19 -3
- data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +39 -3
- data/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb +604 -0
- data/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb +521 -0
- data/lib/dropbox-sign/models/signature_request_edit_request.rb +600 -0
- data/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb +518 -0
- data/lib/dropbox-sign/models/signature_request_get_response.rb +19 -3
- data/lib/dropbox-sign/models/signature_request_list_response.rb +29 -3
- data/lib/dropbox-sign/models/signature_request_remind_request.rb +19 -3
- data/lib/dropbox-sign/models/signature_request_response.rb +19 -10
- data/lib/dropbox-sign/models/signature_request_response_attachment.rb +49 -3
- data/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb +31 -4
- data/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb +19 -3
- data/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb +19 -3
- data/lib/dropbox-sign/models/signature_request_response_custom_field_type_enum.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_response_data_base.rb +9 -3
- data/lib/dropbox-sign/models/signature_request_response_data_type_enum.rb +1 -1
- data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb +9 -3
- data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb +9 -3
- data/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb +9 -3
- data/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb +9 -3
- data/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb +25 -7
- data/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb +9 -3
- data/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb +25 -7
- data/lib/dropbox-sign/models/signature_request_response_data_value_text.rb +9 -3
- data/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb +9 -3
- data/lib/dropbox-sign/models/signature_request_response_signatures.rb +9 -3
- data/lib/dropbox-sign/models/signature_request_send_request.rb +9 -3
- data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +29 -3
- data/lib/dropbox-sign/models/signature_request_update_request.rb +19 -3
- data/lib/dropbox-sign/models/sub_attachment.rb +29 -3
- data/lib/dropbox-sign/models/sub_bulk_signer_list.rb +9 -3
- data/lib/dropbox-sign/models/sub_bulk_signer_list_custom_field.rb +29 -3
- data/lib/dropbox-sign/models/sub_cc.rb +29 -3
- data/lib/dropbox-sign/models/sub_custom_field.rb +19 -3
- data/lib/dropbox-sign/models/sub_editor_options.rb +9 -3
- data/lib/dropbox-sign/models/sub_field_options.rb +9 -3
- data/lib/dropbox-sign/models/sub_form_field_group.rb +39 -3
- data/lib/dropbox-sign/models/sub_form_field_rule.rb +29 -3
- data/lib/dropbox-sign/models/sub_form_field_rule_action.rb +19 -3
- data/lib/dropbox-sign/models/sub_form_field_rule_trigger.rb +19 -3
- data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +99 -3
- data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb +29 -3
- data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox_merge.rb +19 -3
- data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +19 -3
- data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +19 -3
- data/lib/dropbox-sign/models/sub_form_fields_per_document_font_enum.rb +1 -1
- data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +39 -3
- data/lib/dropbox-sign/models/sub_form_fields_per_document_initials.rb +19 -3
- data/lib/dropbox-sign/models/sub_form_fields_per_document_radio.rb +39 -3
- data/lib/dropbox-sign/models/sub_form_fields_per_document_signature.rb +19 -3
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +19 -3
- data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +19 -3
- data/lib/dropbox-sign/models/sub_form_fields_per_document_type_enum.rb +1 -1
- data/lib/dropbox-sign/models/sub_merge_field.rb +19 -3
- data/lib/dropbox-sign/models/sub_o_auth.rb +9 -3
- data/lib/dropbox-sign/models/sub_options.rb +9 -3
- data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +29 -3
- data/lib/dropbox-sign/models/sub_signature_request_signer.rb +29 -3
- data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +39 -3
- data/lib/dropbox-sign/models/sub_signing_options.rb +9 -3
- data/lib/dropbox-sign/models/sub_team_response.rb +9 -3
- data/lib/dropbox-sign/models/sub_template_role.rb +9 -3
- data/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb +29 -3
- data/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb +39 -3
- data/lib/dropbox-sign/models/sub_white_labeling_options.rb +9 -3
- data/lib/dropbox-sign/models/team_add_member_request.rb +9 -3
- data/lib/dropbox-sign/models/team_create_request.rb +9 -3
- data/lib/dropbox-sign/models/team_get_info_response.rb +19 -3
- data/lib/dropbox-sign/models/team_get_response.rb +19 -3
- data/lib/dropbox-sign/models/team_info_response.rb +9 -3
- data/lib/dropbox-sign/models/team_invite_response.rb +9 -3
- data/lib/dropbox-sign/models/team_invites_response.rb +19 -3
- data/lib/dropbox-sign/models/team_member_response.rb +9 -3
- data/lib/dropbox-sign/models/team_members_response.rb +29 -3
- data/lib/dropbox-sign/models/team_parent_response.rb +9 -3
- data/lib/dropbox-sign/models/team_remove_member_request.rb +9 -3
- data/lib/dropbox-sign/models/team_response.rb +9 -3
- data/lib/dropbox-sign/models/team_sub_teams_response.rb +29 -3
- data/lib/dropbox-sign/models/team_update_request.rb +9 -3
- data/lib/dropbox-sign/models/template_add_user_request.rb +9 -3
- data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +19 -3
- data/lib/dropbox-sign/models/template_create_embedded_draft_response.rb +19 -3
- data/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb +9 -3
- data/lib/dropbox-sign/models/template_create_request.rb +29 -3
- data/lib/dropbox-sign/models/template_create_response.rb +19 -3
- data/lib/dropbox-sign/models/template_create_response_template.rb +9 -3
- data/lib/dropbox-sign/models/template_edit_response.rb +19 -3
- data/lib/dropbox-sign/models/template_get_response.rb +19 -3
- data/lib/dropbox-sign/models/template_list_response.rb +29 -3
- data/lib/dropbox-sign/models/template_remove_user_request.rb +9 -3
- data/lib/dropbox-sign/models/template_response.rb +14 -6
- data/lib/dropbox-sign/models/template_response_account.rb +9 -3
- data/lib/dropbox-sign/models/template_response_account_quota.rb +9 -3
- data/lib/dropbox-sign/models/template_response_cc_role.rb +9 -3
- data/lib/dropbox-sign/models/template_response_document.rb +9 -3
- data/lib/dropbox-sign/models/template_response_document_custom_field_base.rb +19 -3
- data/lib/dropbox-sign/models/template_response_document_custom_field_checkbox.rb +19 -3
- data/lib/dropbox-sign/models/template_response_document_custom_field_text.rb +19 -3
- data/lib/dropbox-sign/models/template_response_document_field_group.rb +9 -3
- data/lib/dropbox-sign/models/template_response_document_field_group_rule.rb +9 -3
- data/lib/dropbox-sign/models/template_response_document_form_field_base.rb +19 -3
- data/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb +19 -3
- data/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb +19 -3
- data/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb +19 -3
- data/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb +19 -3
- data/lib/dropbox-sign/models/template_response_document_form_field_initials.rb +19 -3
- data/lib/dropbox-sign/models/template_response_document_form_field_radio.rb +29 -3
- data/lib/dropbox-sign/models/template_response_document_form_field_signature.rb +19 -3
- data/lib/dropbox-sign/models/template_response_document_form_field_text.rb +19 -3
- data/lib/dropbox-sign/models/template_response_document_static_field_base.rb +19 -3
- data/lib/dropbox-sign/models/template_response_document_static_field_checkbox.rb +19 -3
- data/lib/dropbox-sign/models/template_response_document_static_field_date_signed.rb +19 -3
- data/lib/dropbox-sign/models/template_response_document_static_field_dropdown.rb +19 -3
- data/lib/dropbox-sign/models/template_response_document_static_field_hyperlink.rb +19 -3
- data/lib/dropbox-sign/models/template_response_document_static_field_initials.rb +19 -3
- data/lib/dropbox-sign/models/template_response_document_static_field_radio.rb +19 -3
- data/lib/dropbox-sign/models/template_response_document_static_field_signature.rb +19 -3
- data/lib/dropbox-sign/models/template_response_document_static_field_text.rb +19 -3
- data/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +9 -3
- data/lib/dropbox-sign/models/template_response_signer_role.rb +9 -3
- data/lib/dropbox-sign/models/template_update_files_request.rb +9 -3
- data/lib/dropbox-sign/models/template_update_files_response.rb +19 -3
- data/lib/dropbox-sign/models/template_update_files_response_template.rb +9 -3
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +29 -3
- data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +39 -3
- data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +9 -3
- data/lib/dropbox-sign/models/unclaimed_draft_create_response.rb +19 -3
- data/lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb +19 -3
- data/lib/dropbox-sign/models/unclaimed_draft_response.rb +9 -3
- data/lib/dropbox-sign/models/warning_response.rb +29 -3
- data/lib/dropbox-sign/version.rb +2 -2
- data/lib/dropbox-sign.rb +5 -1
- data/openapi-config.yaml +4 -1
- data/openapi-sdk.yaml +3359 -2713
- data/run-build +1 -1
- data/spec/spec_helper.rb +1 -1
- data/templates/README.mustache +2 -2
- data/templates/api_client_typhoeus_partial.mustache +7 -8
- data/templates/api_doc.mustache +2 -2
- data/templates/configuration.mustache +1 -1
- data/templates/partial_model_generic.mustache +28 -6
- data/test_fixtures/BulkSendJobGetResponse.json +9 -0
- data/test_fixtures/FaxGetResponse.json +9 -1
- data/test_fixtures/FaxListResponse.json +9 -1
- data/test_fixtures/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json +7 -1
- data/test_fixtures/SignatureRequestBulkSendWithTemplateRequest.json +7 -1
- data/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +7 -1
- data/test_fixtures/SignatureRequestCreateEmbeddedWithTemplateRequest.json +7 -1
- data/test_fixtures/SignatureRequestGetResponse.json +11 -1
- data/test_fixtures/SignatureRequestListResponse.json +9 -1
- data/test_fixtures/SignatureRequestSendRequest.json +5 -1
- data/test_fixtures/SignatureRequestSendWithTemplateRequest.json +7 -1
- data/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +5 -0
- data/test_fixtures/TemplateCreateRequest.json +5 -0
- data/test_fixtures/TemplateGetResponse.json +9 -1
- data/test_fixtures/TemplateListResponse.json +9 -1
- data/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +5 -0
- data/test_fixtures/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json +5 -0
- data/test_fixtures/UnclaimedDraftCreateRequest.json +5 -0
- metadata +109 -82
- data/examples/AccountCreate.rb +0 -21
- data/examples/AccountGet.rb +0 -18
- data/examples/AccountUpdate.rb +0 -21
- data/examples/AccountVerify.rb +0 -21
- data/examples/ApiAppCreate.rb +0 -35
- data/examples/ApiAppDelete.rb +0 -20
- data/examples/ApiAppGet.rb +0 -20
- data/examples/ApiAppList.rb +0 -21
- data/examples/ApiAppUpdate.rb +0 -32
- data/examples/BulkSendJobGet.rb +0 -20
- data/examples/BulkSendJobList.rb +0 -21
- data/examples/EmbeddedEditUrl.rb +0 -24
- data/examples/EmbeddedSignUrl.rb +0 -20
- data/examples/FaxDelete.rb +0 -14
- data/examples/FaxFiles.rb +0 -17
- data/examples/FaxGet.rb +0 -17
- data/examples/FaxLineAddUser.rb +0 -19
- data/examples/FaxLineAreaCodeGet.rb +0 -15
- data/examples/FaxLineCreate.rb +0 -19
- data/examples/FaxLineDelete.rb +0 -17
- data/examples/FaxLineGet.rb +0 -15
- data/examples/FaxLineList.rb +0 -15
- data/examples/FaxLineRemoveUser.rb +0 -19
- data/examples/FaxList.rb +0 -18
- data/examples/FaxSend.rb +0 -25
- data/examples/OauthTokenGenerate.rb +0 -16
- data/examples/OauthTokenRefresh.rb +0 -13
- data/examples/ReportCreate.rb +0 -23
- data/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb +0 -59
- data/examples/SignatureRequestBulkSendWithTemplate.rb +0 -58
- data/examples/SignatureRequestCancel.rb +0 -20
- data/examples/SignatureRequestCreateEmbedded.rb +0 -46
- data/examples/SignatureRequestCreateEmbeddedWithTemplate.rb +0 -39
- data/examples/SignatureRequestEdit.rb +0 -58
- data/examples/SignatureRequestEditEmbedded.rb +0 -48
- data/examples/SignatureRequestEditEmbeddedWithTemplate.rb +0 -41
- data/examples/SignatureRequestEditWithTemplate.rb +0 -52
- data/examples/SignatureRequestFiles.rb +0 -20
- data/examples/SignatureRequestFilesAsDataUri.rb +0 -20
- data/examples/SignatureRequestFilesAsFileUrl.rb +0 -20
- data/examples/SignatureRequestGet.rb +0 -20
- data/examples/SignatureRequestList.rb +0 -21
- data/examples/SignatureRequestReleaseHold.rb +0 -20
- data/examples/SignatureRequestRemind.rb +0 -23
- data/examples/SignatureRequestRemove.rb +0 -20
- data/examples/SignatureRequestSend.rb +0 -56
- data/examples/SignatureRequestSendWithTemplate.rb +0 -50
- data/examples/SignatureRequestUpdate.rb +0 -24
- data/examples/TeamAddMember.rb +0 -21
- data/examples/TeamCreate.rb +0 -21
- data/examples/TeamDelete.rb +0 -18
- data/examples/TeamGet.rb +0 -18
- data/examples/TeamInfo.rb +0 -18
- data/examples/TeamInvites.rb +0 -20
- data/examples/TeamMembers.rb +0 -20
- data/examples/TeamRemoveMember.rb +0 -22
- data/examples/TeamSubTeams.rb +0 -20
- data/examples/TeamUpdate.rb +0 -21
- data/examples/TemplateAddUser.rb +0 -23
- data/examples/TemplateCreate.rb +0 -49
- data/examples/TemplateCreateEmbeddedDraft.rb +0 -49
- data/examples/TemplateDelete.rb +0 -20
- data/examples/TemplateFiles.rb +0 -20
- data/examples/TemplateFilesAsDataUri.rb +0 -20
- data/examples/TemplateFilesAsFileUrl.rb +0 -20
- data/examples/TemplateGet.rb +0 -20
- data/examples/TemplateList.rb +0 -20
- data/examples/TemplateRemoveUser.rb +0 -23
- data/examples/TemplateUpdateFiles.rb +0 -23
- data/examples/UnclaimedDraftCreate.rb +0 -56
- data/examples/UnclaimedDraftCreateEmbedded.rb +0 -24
- data/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb +0 -35
- data/examples/UnclaimedDraftEditAndResend.rb +0 -24
- /data/examples/{EventCallback.rb → EventCallbackExample.rb} +0 -0
data/docs/SignatureRequestApi.md
CHANGED
@@ -9,6 +9,10 @@ All URIs are relative to *https://api.hellosign.com/v3*
|
|
9
9
|
| [`signature_request_cancel`](SignatureRequestApi.md#signature_request_cancel) | **POST** `/signature_request/cancel/{signature_request_id}` | Cancel Incomplete Signature Request |
|
10
10
|
| [`signature_request_create_embedded`](SignatureRequestApi.md#signature_request_create_embedded) | **POST** `/signature_request/create_embedded` | Create Embedded Signature Request |
|
11
11
|
| [`signature_request_create_embedded_with_template`](SignatureRequestApi.md#signature_request_create_embedded_with_template) | **POST** `/signature_request/create_embedded_with_template` | Create Embedded Signature Request with Template |
|
12
|
+
| [`signature_request_edit`](SignatureRequestApi.md#signature_request_edit) | **PUT** `/signature_request/edit/{signature_request_id}` | Edit Signature Request |
|
13
|
+
| [`signature_request_edit_embedded`](SignatureRequestApi.md#signature_request_edit_embedded) | **PUT** `/signature_request/edit_embedded/{signature_request_id}` | Edit Embedded Signature Request |
|
14
|
+
| [`signature_request_edit_embedded_with_template`](SignatureRequestApi.md#signature_request_edit_embedded_with_template) | **PUT** `/signature_request/edit_embedded_with_template/{signature_request_id}` | Edit Embedded Signature Request with Template |
|
15
|
+
| [`signature_request_edit_with_template`](SignatureRequestApi.md#signature_request_edit_with_template) | **PUT** `/signature_request/edit_with_template/{signature_request_id}` | Edit Signature Request With Template |
|
12
16
|
| [`signature_request_files`](SignatureRequestApi.md#signature_request_files) | **GET** `/signature_request/files/{signature_request_id}` | Download Files |
|
13
17
|
| [`signature_request_files_as_data_uri`](SignatureRequestApi.md#signature_request_files_as_data_uri) | **GET** `/signature_request/files_as_data_uri/{signature_request_id}` | Download Files as Data Uri |
|
14
18
|
| [`signature_request_files_as_file_url`](SignatureRequestApi.md#signature_request_files_as_file_url) | **GET** `/signature_request/files_as_file_url/{signature_request_id}` | Download Files as File Url |
|
@@ -33,64 +37,89 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of
|
|
33
37
|
### Examples
|
34
38
|
|
35
39
|
```ruby
|
40
|
+
require "json"
|
36
41
|
require "dropbox-sign"
|
37
42
|
|
38
43
|
Dropbox::Sign.configure do |config|
|
39
|
-
# Configure HTTP basic authorization: api_key
|
40
44
|
config.username = "YOUR_API_KEY"
|
41
|
-
|
42
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
43
|
-
# config.access_token = "YOUR_ACCESS_TOKEN"
|
44
45
|
end
|
45
46
|
|
46
|
-
|
47
|
+
signer_list_2_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new
|
48
|
+
signer_list_2_custom_fields_1.name = "company"
|
49
|
+
signer_list_2_custom_fields_1.value = "123 LLC"
|
47
50
|
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
signer_list_1_signer.email_address = "george@example.com"
|
52
|
-
signer_list_1_signer.pin = "d79a3td"
|
51
|
+
signer_list_2_custom_fields = [
|
52
|
+
signer_list_2_custom_fields_1,
|
53
|
+
]
|
53
54
|
|
54
|
-
|
55
|
-
|
56
|
-
|
55
|
+
signer_list_2_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
|
56
|
+
signer_list_2_signers_1.role = "Client"
|
57
|
+
signer_list_2_signers_1.name = "Mary"
|
58
|
+
signer_list_2_signers_1.email_address = "mary@example.com"
|
59
|
+
signer_list_2_signers_1.pin = "gd9as5b"
|
57
60
|
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
+
signer_list_2_signers = [
|
62
|
+
signer_list_2_signers_1,
|
63
|
+
]
|
64
|
+
|
65
|
+
signer_list_1_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new
|
66
|
+
signer_list_1_custom_fields_1.name = "company"
|
67
|
+
signer_list_1_custom_fields_1.value = "ABC Corp"
|
61
68
|
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
signer_list_2_signer.email_address = "mary@example.com"
|
66
|
-
signer_list_2_signer.pin = "gd9as5b"
|
69
|
+
signer_list_1_custom_fields = [
|
70
|
+
signer_list_1_custom_fields_1,
|
71
|
+
]
|
67
72
|
|
68
|
-
|
69
|
-
|
70
|
-
|
73
|
+
signer_list_1_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
|
74
|
+
signer_list_1_signers_1.role = "Client"
|
75
|
+
signer_list_1_signers_1.name = "George"
|
76
|
+
signer_list_1_signers_1.email_address = "george@example.com"
|
77
|
+
signer_list_1_signers_1.pin = "d79a3td"
|
78
|
+
|
79
|
+
signer_list_1_signers = [
|
80
|
+
signer_list_1_signers_1,
|
81
|
+
]
|
82
|
+
|
83
|
+
signer_list_1 = Dropbox::Sign::SubBulkSignerList.new
|
84
|
+
signer_list_1.custom_fields = signer_list_1_custom_fields
|
85
|
+
signer_list_1.signers = signer_list_1_signers
|
71
86
|
|
72
87
|
signer_list_2 = Dropbox::Sign::SubBulkSignerList.new
|
73
|
-
signer_list_2.
|
74
|
-
signer_list_2.
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
+
signer_list_2.custom_fields = signer_list_2_custom_fields
|
89
|
+
signer_list_2.signers = signer_list_2_signers
|
90
|
+
|
91
|
+
signer_list = [
|
92
|
+
signer_list_1,
|
93
|
+
signer_list_2,
|
94
|
+
]
|
95
|
+
|
96
|
+
ccs_1 = Dropbox::Sign::SubCC.new
|
97
|
+
ccs_1.role = "Accounting"
|
98
|
+
ccs_1.email_address = "accounting@example.com"
|
99
|
+
|
100
|
+
ccs = [
|
101
|
+
ccs_1,
|
102
|
+
]
|
103
|
+
|
104
|
+
signature_request_bulk_create_embedded_with_template_request = Dropbox::Sign::SignatureRequestBulkCreateEmbeddedWithTemplateRequest.new
|
105
|
+
signature_request_bulk_create_embedded_with_template_request.client_id = "1a659d9ad95bccd307ecad78d72192f8"
|
106
|
+
signature_request_bulk_create_embedded_with_template_request.template_ids = [
|
107
|
+
"c26b8a16784a872da37ea946b9ddec7c1e11dff6",
|
108
|
+
]
|
109
|
+
signature_request_bulk_create_embedded_with_template_request.message = "Glad we could come to an agreement."
|
110
|
+
signature_request_bulk_create_embedded_with_template_request.subject = "Purchase Order"
|
111
|
+
signature_request_bulk_create_embedded_with_template_request.test_mode = true
|
112
|
+
signature_request_bulk_create_embedded_with_template_request.signer_list = signer_list
|
113
|
+
signature_request_bulk_create_embedded_with_template_request.ccs = ccs
|
88
114
|
|
89
115
|
begin
|
90
|
-
|
91
|
-
|
116
|
+
response = Dropbox::Sign::SignatureRequestApi.new.signature_request_bulk_create_embedded_with_template(
|
117
|
+
signature_request_bulk_create_embedded_with_template_request,
|
118
|
+
)
|
119
|
+
|
120
|
+
p response
|
92
121
|
rescue Dropbox::Sign::ApiError => e
|
93
|
-
puts "Exception when calling
|
122
|
+
puts "Exception when calling SignatureRequestApi#signature_request_bulk_create_embedded_with_template: #{e}"
|
94
123
|
end
|
95
124
|
|
96
125
|
```
|
@@ -144,63 +173,89 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of
|
|
144
173
|
### Examples
|
145
174
|
|
146
175
|
```ruby
|
176
|
+
require "json"
|
147
177
|
require "dropbox-sign"
|
148
178
|
|
149
179
|
Dropbox::Sign.configure do |config|
|
150
|
-
# Configure HTTP basic authorization: api_key
|
151
180
|
config.username = "YOUR_API_KEY"
|
152
|
-
|
153
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
154
181
|
# config.access_token = "YOUR_ACCESS_TOKEN"
|
155
182
|
end
|
156
183
|
|
157
|
-
|
184
|
+
signer_list_2_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new
|
185
|
+
signer_list_2_custom_fields_1.name = "company"
|
186
|
+
signer_list_2_custom_fields_1.value = "123 LLC"
|
158
187
|
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
signer_list_1_signer.email_address = "george@example.com"
|
163
|
-
signer_list_1_signer.pin = "d79a3td"
|
188
|
+
signer_list_2_custom_fields = [
|
189
|
+
signer_list_2_custom_fields_1,
|
190
|
+
]
|
164
191
|
|
165
|
-
|
166
|
-
|
167
|
-
|
192
|
+
signer_list_2_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
|
193
|
+
signer_list_2_signers_1.role = "Client"
|
194
|
+
signer_list_2_signers_1.name = "Mary"
|
195
|
+
signer_list_2_signers_1.email_address = "mary@example.com"
|
196
|
+
signer_list_2_signers_1.pin = "gd9as5b"
|
168
197
|
|
169
|
-
|
170
|
-
|
171
|
-
|
198
|
+
signer_list_2_signers = [
|
199
|
+
signer_list_2_signers_1,
|
200
|
+
]
|
172
201
|
|
173
|
-
|
174
|
-
|
175
|
-
|
176
|
-
signer_list_2_signer.email_address = "mary@example.com"
|
177
|
-
signer_list_2_signer.pin = "gd9as5b"
|
202
|
+
signer_list_1_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new
|
203
|
+
signer_list_1_custom_fields_1.name = "company"
|
204
|
+
signer_list_1_custom_fields_1.value = "ABC Corp"
|
178
205
|
|
179
|
-
|
180
|
-
|
181
|
-
|
206
|
+
signer_list_1_custom_fields = [
|
207
|
+
signer_list_1_custom_fields_1,
|
208
|
+
]
|
209
|
+
|
210
|
+
signer_list_1_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
|
211
|
+
signer_list_1_signers_1.role = "Client"
|
212
|
+
signer_list_1_signers_1.name = "George"
|
213
|
+
signer_list_1_signers_1.email_address = "george@example.com"
|
214
|
+
signer_list_1_signers_1.pin = "d79a3td"
|
215
|
+
|
216
|
+
signer_list_1_signers = [
|
217
|
+
signer_list_1_signers_1,
|
218
|
+
]
|
219
|
+
|
220
|
+
signer_list_1 = Dropbox::Sign::SubBulkSignerList.new
|
221
|
+
signer_list_1.custom_fields = signer_list_1_custom_fields
|
222
|
+
signer_list_1.signers = signer_list_1_signers
|
182
223
|
|
183
224
|
signer_list_2 = Dropbox::Sign::SubBulkSignerList.new
|
184
|
-
signer_list_2.
|
185
|
-
signer_list_2.
|
225
|
+
signer_list_2.custom_fields = signer_list_2_custom_fields
|
226
|
+
signer_list_2.signers = signer_list_2_signers
|
186
227
|
|
187
|
-
|
188
|
-
|
189
|
-
|
228
|
+
signer_list = [
|
229
|
+
signer_list_1,
|
230
|
+
signer_list_2,
|
231
|
+
]
|
190
232
|
|
191
|
-
|
192
|
-
|
193
|
-
|
194
|
-
|
195
|
-
|
196
|
-
|
197
|
-
|
233
|
+
ccs_1 = Dropbox::Sign::SubCC.new
|
234
|
+
ccs_1.role = "Accounting"
|
235
|
+
ccs_1.email_address = "accounting@example.com"
|
236
|
+
|
237
|
+
ccs = [
|
238
|
+
ccs_1,
|
239
|
+
]
|
240
|
+
|
241
|
+
signature_request_bulk_send_with_template_request = Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest.new
|
242
|
+
signature_request_bulk_send_with_template_request.template_ids = [
|
243
|
+
"c26b8a16784a872da37ea946b9ddec7c1e11dff6",
|
244
|
+
]
|
245
|
+
signature_request_bulk_send_with_template_request.message = "Glad we could come to an agreement."
|
246
|
+
signature_request_bulk_send_with_template_request.subject = "Purchase Order"
|
247
|
+
signature_request_bulk_send_with_template_request.test_mode = true
|
248
|
+
signature_request_bulk_send_with_template_request.signer_list = signer_list
|
249
|
+
signature_request_bulk_send_with_template_request.ccs = ccs
|
198
250
|
|
199
251
|
begin
|
200
|
-
|
201
|
-
|
252
|
+
response = Dropbox::Sign::SignatureRequestApi.new.signature_request_bulk_send_with_template(
|
253
|
+
signature_request_bulk_send_with_template_request,
|
254
|
+
)
|
255
|
+
|
256
|
+
p response
|
202
257
|
rescue Dropbox::Sign::ApiError => e
|
203
|
-
puts "Exception when calling
|
258
|
+
puts "Exception when calling SignatureRequestApi#signature_request_bulk_send_with_template: #{e}"
|
204
259
|
end
|
205
260
|
|
206
261
|
```
|
@@ -254,25 +309,20 @@ Cancels an incomplete signature request. This action is **not reversible**. The
|
|
254
309
|
### Examples
|
255
310
|
|
256
311
|
```ruby
|
312
|
+
require "json"
|
257
313
|
require "dropbox-sign"
|
258
314
|
|
259
315
|
Dropbox::Sign.configure do |config|
|
260
|
-
# Configure HTTP basic authorization: api_key
|
261
316
|
config.username = "YOUR_API_KEY"
|
262
|
-
|
263
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
264
317
|
# config.access_token = "YOUR_ACCESS_TOKEN"
|
265
318
|
end
|
266
319
|
|
267
|
-
signature_request_api = Dropbox::Sign::SignatureRequestApi.new
|
268
|
-
|
269
|
-
signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
|
270
|
-
|
271
320
|
begin
|
272
|
-
|
273
|
-
|
321
|
+
Dropbox::Sign::SignatureRequestApi.new.signature_request_cancel(
|
322
|
+
"fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id
|
323
|
+
)
|
274
324
|
rescue Dropbox::Sign::ApiError => e
|
275
|
-
puts "Exception when calling
|
325
|
+
puts "Exception when calling SignatureRequestApi#signature_request_cancel: #{e}"
|
276
326
|
end
|
277
327
|
|
278
328
|
```
|
@@ -326,51 +376,60 @@ Creates a new SignatureRequest with the submitted documents to be signed in an e
|
|
326
376
|
### Examples
|
327
377
|
|
328
378
|
```ruby
|
379
|
+
require "json"
|
329
380
|
require "dropbox-sign"
|
330
381
|
|
331
382
|
Dropbox::Sign.configure do |config|
|
332
|
-
# Configure HTTP basic authorization: api_key
|
333
383
|
config.username = "YOUR_API_KEY"
|
334
|
-
|
335
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
336
384
|
# config.access_token = "YOUR_ACCESS_TOKEN"
|
337
385
|
end
|
338
386
|
|
339
|
-
signature_request_api = Dropbox::Sign::SignatureRequestApi.new
|
340
|
-
|
341
|
-
signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new
|
342
|
-
signer_1.email_address = "jack@example.com"
|
343
|
-
signer_1.name = "Jack"
|
344
|
-
signer_1.order = 0
|
345
|
-
|
346
|
-
signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new
|
347
|
-
signer_2.email_address = "jill@example.com"
|
348
|
-
signer_2.name = "Jill"
|
349
|
-
signer_2.order = 1
|
350
|
-
|
351
387
|
signing_options = Dropbox::Sign::SubSigningOptions.new
|
388
|
+
signing_options.default_type = "draw"
|
352
389
|
signing_options.draw = true
|
390
|
+
signing_options.phone = false
|
353
391
|
signing_options.type = true
|
354
392
|
signing_options.upload = true
|
355
|
-
signing_options.phone = true
|
356
|
-
signing_options.default_type = "draw"
|
357
393
|
|
358
|
-
|
359
|
-
|
360
|
-
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
394
|
+
signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new
|
395
|
+
signers_1.name = "Jack"
|
396
|
+
signers_1.email_address = "jack@example.com"
|
397
|
+
signers_1.order = 0
|
398
|
+
|
399
|
+
signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new
|
400
|
+
signers_2.name = "Jill"
|
401
|
+
signers_2.email_address = "jill@example.com"
|
402
|
+
signers_2.order = 1
|
403
|
+
|
404
|
+
signers = [
|
405
|
+
signers_1,
|
406
|
+
signers_2,
|
407
|
+
]
|
408
|
+
|
409
|
+
signature_request_create_embedded_request = Dropbox::Sign::SignatureRequestCreateEmbeddedRequest.new
|
410
|
+
signature_request_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"
|
411
|
+
signature_request_create_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."
|
412
|
+
signature_request_create_embedded_request.subject = "The NDA we talked about"
|
413
|
+
signature_request_create_embedded_request.test_mode = true
|
414
|
+
signature_request_create_embedded_request.title = "NDA with Acme Co."
|
415
|
+
signature_request_create_embedded_request.cc_email_addresses = [
|
416
|
+
"lawyer1@dropboxsign.com",
|
417
|
+
"lawyer2@dropboxsign.com",
|
418
|
+
]
|
419
|
+
signature_request_create_embedded_request.files = [
|
420
|
+
File.new("./example_signature_request.pdf", "r"),
|
421
|
+
]
|
422
|
+
signature_request_create_embedded_request.signing_options = signing_options
|
423
|
+
signature_request_create_embedded_request.signers = signers
|
368
424
|
|
369
425
|
begin
|
370
|
-
|
371
|
-
|
426
|
+
response = Dropbox::Sign::SignatureRequestApi.new.signature_request_create_embedded(
|
427
|
+
signature_request_create_embedded_request,
|
428
|
+
)
|
429
|
+
|
430
|
+
p response
|
372
431
|
rescue Dropbox::Sign::ApiError => e
|
373
|
-
puts "Exception when calling
|
432
|
+
puts "Exception when calling SignatureRequestApi#signature_request_create_embedded: #{e}"
|
374
433
|
end
|
375
434
|
|
376
435
|
```
|
@@ -424,44 +483,49 @@ Creates a new SignatureRequest based on the given Template(s) to be signed in an
|
|
424
483
|
### Examples
|
425
484
|
|
426
485
|
```ruby
|
486
|
+
require "json"
|
427
487
|
require "dropbox-sign"
|
428
488
|
|
429
489
|
Dropbox::Sign.configure do |config|
|
430
|
-
# Configure HTTP basic authorization: api_key
|
431
490
|
config.username = "YOUR_API_KEY"
|
432
|
-
|
433
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
434
491
|
# config.access_token = "YOUR_ACCESS_TOKEN"
|
435
492
|
end
|
436
493
|
|
437
|
-
signature_request_api = Dropbox::Sign::SignatureRequestApi.new
|
438
|
-
|
439
|
-
signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
|
440
|
-
signer_1.role = "Client"
|
441
|
-
signer_1.email_address = "jack@example.com"
|
442
|
-
signer_1.name = "Jack"
|
443
|
-
|
444
494
|
signing_options = Dropbox::Sign::SubSigningOptions.new
|
495
|
+
signing_options.default_type = "draw"
|
445
496
|
signing_options.draw = true
|
497
|
+
signing_options.phone = false
|
446
498
|
signing_options.type = true
|
447
499
|
signing_options.upload = true
|
448
|
-
signing_options.phone = true
|
449
|
-
signing_options.default_type = "draw"
|
450
500
|
|
451
|
-
|
452
|
-
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
|
457
|
-
|
458
|
-
|
501
|
+
signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
|
502
|
+
signers_1.role = "Client"
|
503
|
+
signers_1.name = "George"
|
504
|
+
signers_1.email_address = "george@example.com"
|
505
|
+
|
506
|
+
signers = [
|
507
|
+
signers_1,
|
508
|
+
]
|
509
|
+
|
510
|
+
signature_request_create_embedded_with_template_request = Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest.new
|
511
|
+
signature_request_create_embedded_with_template_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"
|
512
|
+
signature_request_create_embedded_with_template_request.template_ids = [
|
513
|
+
"c26b8a16784a872da37ea946b9ddec7c1e11dff6",
|
514
|
+
]
|
515
|
+
signature_request_create_embedded_with_template_request.message = "Glad we could come to an agreement."
|
516
|
+
signature_request_create_embedded_with_template_request.subject = "Purchase Order"
|
517
|
+
signature_request_create_embedded_with_template_request.test_mode = true
|
518
|
+
signature_request_create_embedded_with_template_request.signing_options = signing_options
|
519
|
+
signature_request_create_embedded_with_template_request.signers = signers
|
459
520
|
|
460
521
|
begin
|
461
|
-
|
462
|
-
|
522
|
+
response = Dropbox::Sign::SignatureRequestApi.new.signature_request_create_embedded_with_template(
|
523
|
+
signature_request_create_embedded_with_template_request,
|
524
|
+
)
|
525
|
+
|
526
|
+
p response
|
463
527
|
rescue Dropbox::Sign::ApiError => e
|
464
|
-
puts "Exception when calling
|
528
|
+
puts "Exception when calling SignatureRequestApi#signature_request_create_embedded_with_template: #{e}"
|
465
529
|
end
|
466
530
|
|
467
531
|
```
|
@@ -504,6 +568,449 @@ end
|
|
504
568
|
- **Accept**: application/json
|
505
569
|
|
506
570
|
|
571
|
+
## `signature_request_edit`
|
572
|
+
|
573
|
+
> `<SignatureRequestGetResponse> signature_request_edit(signature_request_id, signature_request_edit_request)`
|
574
|
+
|
575
|
+
Edit Signature Request
|
576
|
+
|
577
|
+
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* deduct your signature request quota.
|
578
|
+
|
579
|
+
### Examples
|
580
|
+
|
581
|
+
```ruby
|
582
|
+
require "json"
|
583
|
+
require "dropbox-sign"
|
584
|
+
|
585
|
+
Dropbox::Sign.configure do |config|
|
586
|
+
config.username = "YOUR_API_KEY"
|
587
|
+
# config.access_token = "YOUR_ACCESS_TOKEN"
|
588
|
+
end
|
589
|
+
|
590
|
+
field_options = Dropbox::Sign::SubFieldOptions.new
|
591
|
+
field_options.date_format = "DD - MM - YYYY"
|
592
|
+
|
593
|
+
signing_options = Dropbox::Sign::SubSigningOptions.new
|
594
|
+
signing_options.default_type = "draw"
|
595
|
+
signing_options.draw = true
|
596
|
+
signing_options.phone = false
|
597
|
+
signing_options.type = true
|
598
|
+
signing_options.upload = true
|
599
|
+
|
600
|
+
signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new
|
601
|
+
signers_1.name = "Jack"
|
602
|
+
signers_1.email_address = "jack@example.com"
|
603
|
+
signers_1.order = 0
|
604
|
+
|
605
|
+
signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new
|
606
|
+
signers_2.name = "Jill"
|
607
|
+
signers_2.email_address = "jill@example.com"
|
608
|
+
signers_2.order = 1
|
609
|
+
|
610
|
+
signers = [
|
611
|
+
signers_1,
|
612
|
+
signers_2,
|
613
|
+
]
|
614
|
+
|
615
|
+
signature_request_edit_request = Dropbox::Sign::SignatureRequestEditRequest.new
|
616
|
+
signature_request_edit_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."
|
617
|
+
signature_request_edit_request.subject = "The NDA we talked about"
|
618
|
+
signature_request_edit_request.test_mode = true
|
619
|
+
signature_request_edit_request.title = "NDA with Acme Co."
|
620
|
+
signature_request_edit_request.cc_email_addresses = [
|
621
|
+
"lawyer1@dropboxsign.com",
|
622
|
+
"lawyer2@dropboxsign.com",
|
623
|
+
]
|
624
|
+
signature_request_edit_request.files = [
|
625
|
+
File.new("./example_signature_request.pdf", "r"),
|
626
|
+
]
|
627
|
+
signature_request_edit_request.metadata = JSON.parse(<<-EOD
|
628
|
+
{
|
629
|
+
"custom_id": 1234,
|
630
|
+
"custom_text": "NDA #9"
|
631
|
+
}
|
632
|
+
EOD
|
633
|
+
)
|
634
|
+
signature_request_edit_request.field_options = field_options
|
635
|
+
signature_request_edit_request.signing_options = signing_options
|
636
|
+
signature_request_edit_request.signers = signers
|
637
|
+
|
638
|
+
begin
|
639
|
+
response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit(
|
640
|
+
"fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id
|
641
|
+
signature_request_edit_request,
|
642
|
+
)
|
643
|
+
|
644
|
+
p response
|
645
|
+
rescue Dropbox::Sign::ApiError => e
|
646
|
+
puts "Exception when calling SignatureRequestApi#signature_request_edit: #{e}"
|
647
|
+
end
|
648
|
+
|
649
|
+
```
|
650
|
+
|
651
|
+
#### Using the `signature_request_edit_with_http_info` variant
|
652
|
+
|
653
|
+
This returns an Array which contains the response data, status code and headers.
|
654
|
+
|
655
|
+
> `<Array(<SignatureRequestGetResponse>, Integer, Hash)> signature_request_edit_with_http_info(signature_request_id, signature_request_edit_request)`
|
656
|
+
|
657
|
+
```ruby
|
658
|
+
begin
|
659
|
+
# Edit Signature Request
|
660
|
+
data, status_code, headers = api_instance.signature_request_edit_with_http_info(signature_request_id, signature_request_edit_request)
|
661
|
+
p status_code # => 2xx
|
662
|
+
p headers # => { ... }
|
663
|
+
p data # => <SignatureRequestGetResponse>
|
664
|
+
rescue Dropbox::Sign::ApiError => e
|
665
|
+
puts "Error when calling SignatureRequestApi->signature_request_edit_with_http_info: #{e}"
|
666
|
+
end
|
667
|
+
```
|
668
|
+
|
669
|
+
### Parameters
|
670
|
+
|
671
|
+
| Name | Type | Description | Notes |
|
672
|
+
| ---- | ---- | ----------- | ----- |
|
673
|
+
| `signature_request_id` | **String** | The id of the SignatureRequest to edit. | |
|
674
|
+
| `signature_request_edit_request` | [**SignatureRequestEditRequest**](SignatureRequestEditRequest.md) | | |
|
675
|
+
|
676
|
+
### Return type
|
677
|
+
|
678
|
+
[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
|
679
|
+
|
680
|
+
### Authorization
|
681
|
+
|
682
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
683
|
+
|
684
|
+
### HTTP request headers
|
685
|
+
|
686
|
+
- **Content-Type**: application/json, multipart/form-data
|
687
|
+
- **Accept**: application/json
|
688
|
+
|
689
|
+
|
690
|
+
## `signature_request_edit_embedded`
|
691
|
+
|
692
|
+
> `<SignatureRequestGetResponse> signature_request_edit_embedded(signature_request_id, signature_request_edit_embedded_request)`
|
693
|
+
|
694
|
+
Edit Embedded Signature Request
|
695
|
+
|
696
|
+
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. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota.
|
697
|
+
|
698
|
+
### Examples
|
699
|
+
|
700
|
+
```ruby
|
701
|
+
require "json"
|
702
|
+
require "dropbox-sign"
|
703
|
+
|
704
|
+
Dropbox::Sign.configure do |config|
|
705
|
+
config.username = "YOUR_API_KEY"
|
706
|
+
# config.access_token = "YOUR_ACCESS_TOKEN"
|
707
|
+
end
|
708
|
+
|
709
|
+
signing_options = Dropbox::Sign::SubSigningOptions.new
|
710
|
+
signing_options.default_type = "draw"
|
711
|
+
signing_options.draw = true
|
712
|
+
signing_options.phone = false
|
713
|
+
signing_options.type = true
|
714
|
+
signing_options.upload = true
|
715
|
+
|
716
|
+
signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new
|
717
|
+
signers_1.name = "Jack"
|
718
|
+
signers_1.email_address = "jack@example.com"
|
719
|
+
signers_1.order = 0
|
720
|
+
|
721
|
+
signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new
|
722
|
+
signers_2.name = "Jill"
|
723
|
+
signers_2.email_address = "jill@example.com"
|
724
|
+
signers_2.order = 1
|
725
|
+
|
726
|
+
signers = [
|
727
|
+
signers_1,
|
728
|
+
signers_2,
|
729
|
+
]
|
730
|
+
|
731
|
+
signature_request_edit_embedded_request = Dropbox::Sign::SignatureRequestEditEmbeddedRequest.new
|
732
|
+
signature_request_edit_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"
|
733
|
+
signature_request_edit_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."
|
734
|
+
signature_request_edit_embedded_request.subject = "The NDA we talked about"
|
735
|
+
signature_request_edit_embedded_request.test_mode = true
|
736
|
+
signature_request_edit_embedded_request.title = "NDA with Acme Co."
|
737
|
+
signature_request_edit_embedded_request.cc_email_addresses = [
|
738
|
+
"lawyer1@dropboxsign.com",
|
739
|
+
"lawyer2@dropboxsign.com",
|
740
|
+
]
|
741
|
+
signature_request_edit_embedded_request.files = [
|
742
|
+
File.new("./example_signature_request.pdf", "r"),
|
743
|
+
]
|
744
|
+
signature_request_edit_embedded_request.signing_options = signing_options
|
745
|
+
signature_request_edit_embedded_request.signers = signers
|
746
|
+
|
747
|
+
begin
|
748
|
+
response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_embedded(
|
749
|
+
"fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id
|
750
|
+
signature_request_edit_embedded_request,
|
751
|
+
)
|
752
|
+
|
753
|
+
p response
|
754
|
+
rescue Dropbox::Sign::ApiError => e
|
755
|
+
puts "Exception when calling SignatureRequestApi#signature_request_edit_embedded: #{e}"
|
756
|
+
end
|
757
|
+
|
758
|
+
```
|
759
|
+
|
760
|
+
#### Using the `signature_request_edit_embedded_with_http_info` variant
|
761
|
+
|
762
|
+
This returns an Array which contains the response data, status code and headers.
|
763
|
+
|
764
|
+
> `<Array(<SignatureRequestGetResponse>, Integer, Hash)> signature_request_edit_embedded_with_http_info(signature_request_id, signature_request_edit_embedded_request)`
|
765
|
+
|
766
|
+
```ruby
|
767
|
+
begin
|
768
|
+
# Edit Embedded Signature Request
|
769
|
+
data, status_code, headers = api_instance.signature_request_edit_embedded_with_http_info(signature_request_id, signature_request_edit_embedded_request)
|
770
|
+
p status_code # => 2xx
|
771
|
+
p headers # => { ... }
|
772
|
+
p data # => <SignatureRequestGetResponse>
|
773
|
+
rescue Dropbox::Sign::ApiError => e
|
774
|
+
puts "Error when calling SignatureRequestApi->signature_request_edit_embedded_with_http_info: #{e}"
|
775
|
+
end
|
776
|
+
```
|
777
|
+
|
778
|
+
### Parameters
|
779
|
+
|
780
|
+
| Name | Type | Description | Notes |
|
781
|
+
| ---- | ---- | ----------- | ----- |
|
782
|
+
| `signature_request_id` | **String** | The id of the SignatureRequest to edit. | |
|
783
|
+
| `signature_request_edit_embedded_request` | [**SignatureRequestEditEmbeddedRequest**](SignatureRequestEditEmbeddedRequest.md) | | |
|
784
|
+
|
785
|
+
### Return type
|
786
|
+
|
787
|
+
[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
|
788
|
+
|
789
|
+
### Authorization
|
790
|
+
|
791
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
792
|
+
|
793
|
+
### HTTP request headers
|
794
|
+
|
795
|
+
- **Content-Type**: application/json, multipart/form-data
|
796
|
+
- **Accept**: application/json
|
797
|
+
|
798
|
+
|
799
|
+
## `signature_request_edit_embedded_with_template`
|
800
|
+
|
801
|
+
> `<SignatureRequestGetResponse> signature_request_edit_embedded_with_template(signature_request_id, signature_request_edit_embedded_with_template_request)`
|
802
|
+
|
803
|
+
Edit Embedded Signature Request with Template
|
804
|
+
|
805
|
+
Edits a 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. **NOTE:** Edit and resend *will* deduct your signature request quota.
|
806
|
+
|
807
|
+
### Examples
|
808
|
+
|
809
|
+
```ruby
|
810
|
+
require "json"
|
811
|
+
require "dropbox-sign"
|
812
|
+
|
813
|
+
Dropbox::Sign.configure do |config|
|
814
|
+
config.username = "YOUR_API_KEY"
|
815
|
+
# config.access_token = "YOUR_ACCESS_TOKEN"
|
816
|
+
end
|
817
|
+
|
818
|
+
signing_options = Dropbox::Sign::SubSigningOptions.new
|
819
|
+
signing_options.default_type = "draw"
|
820
|
+
signing_options.draw = true
|
821
|
+
signing_options.phone = false
|
822
|
+
signing_options.type = true
|
823
|
+
signing_options.upload = true
|
824
|
+
|
825
|
+
signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
|
826
|
+
signers_1.role = "Client"
|
827
|
+
signers_1.name = "George"
|
828
|
+
signers_1.email_address = "george@example.com"
|
829
|
+
|
830
|
+
signers = [
|
831
|
+
signers_1,
|
832
|
+
]
|
833
|
+
|
834
|
+
signature_request_edit_embedded_with_template_request = Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest.new
|
835
|
+
signature_request_edit_embedded_with_template_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"
|
836
|
+
signature_request_edit_embedded_with_template_request.template_ids = [
|
837
|
+
"c26b8a16784a872da37ea946b9ddec7c1e11dff6",
|
838
|
+
]
|
839
|
+
signature_request_edit_embedded_with_template_request.message = "Glad we could come to an agreement."
|
840
|
+
signature_request_edit_embedded_with_template_request.subject = "Purchase Order"
|
841
|
+
signature_request_edit_embedded_with_template_request.test_mode = true
|
842
|
+
signature_request_edit_embedded_with_template_request.signing_options = signing_options
|
843
|
+
signature_request_edit_embedded_with_template_request.signers = signers
|
844
|
+
|
845
|
+
begin
|
846
|
+
response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_embedded_with_template(
|
847
|
+
"fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id
|
848
|
+
signature_request_edit_embedded_with_template_request,
|
849
|
+
)
|
850
|
+
|
851
|
+
p response
|
852
|
+
rescue Dropbox::Sign::ApiError => e
|
853
|
+
puts "Exception when calling SignatureRequestApi#signature_request_edit_embedded_with_template: #{e}"
|
854
|
+
end
|
855
|
+
|
856
|
+
```
|
857
|
+
|
858
|
+
#### Using the `signature_request_edit_embedded_with_template_with_http_info` variant
|
859
|
+
|
860
|
+
This returns an Array which contains the response data, status code and headers.
|
861
|
+
|
862
|
+
> `<Array(<SignatureRequestGetResponse>, Integer, Hash)> signature_request_edit_embedded_with_template_with_http_info(signature_request_id, signature_request_edit_embedded_with_template_request)`
|
863
|
+
|
864
|
+
```ruby
|
865
|
+
begin
|
866
|
+
# Edit Embedded Signature Request with Template
|
867
|
+
data, status_code, headers = api_instance.signature_request_edit_embedded_with_template_with_http_info(signature_request_id, signature_request_edit_embedded_with_template_request)
|
868
|
+
p status_code # => 2xx
|
869
|
+
p headers # => { ... }
|
870
|
+
p data # => <SignatureRequestGetResponse>
|
871
|
+
rescue Dropbox::Sign::ApiError => e
|
872
|
+
puts "Error when calling SignatureRequestApi->signature_request_edit_embedded_with_template_with_http_info: #{e}"
|
873
|
+
end
|
874
|
+
```
|
875
|
+
|
876
|
+
### Parameters
|
877
|
+
|
878
|
+
| Name | Type | Description | Notes |
|
879
|
+
| ---- | ---- | ----------- | ----- |
|
880
|
+
| `signature_request_id` | **String** | The id of the SignatureRequest to edit. | |
|
881
|
+
| `signature_request_edit_embedded_with_template_request` | [**SignatureRequestEditEmbeddedWithTemplateRequest**](SignatureRequestEditEmbeddedWithTemplateRequest.md) | | |
|
882
|
+
|
883
|
+
### Return type
|
884
|
+
|
885
|
+
[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
|
886
|
+
|
887
|
+
### Authorization
|
888
|
+
|
889
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
890
|
+
|
891
|
+
### HTTP request headers
|
892
|
+
|
893
|
+
- **Content-Type**: application/json, multipart/form-data
|
894
|
+
- **Accept**: application/json
|
895
|
+
|
896
|
+
|
897
|
+
## `signature_request_edit_with_template`
|
898
|
+
|
899
|
+
> `<SignatureRequestGetResponse> signature_request_edit_with_template(signature_request_id, signature_request_edit_with_template_request)`
|
900
|
+
|
901
|
+
Edit Signature Request With Template
|
902
|
+
|
903
|
+
Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota.
|
904
|
+
|
905
|
+
### Examples
|
906
|
+
|
907
|
+
```ruby
|
908
|
+
require "json"
|
909
|
+
require "dropbox-sign"
|
910
|
+
|
911
|
+
Dropbox::Sign.configure do |config|
|
912
|
+
config.username = "YOUR_API_KEY"
|
913
|
+
# config.access_token = "YOUR_ACCESS_TOKEN"
|
914
|
+
end
|
915
|
+
|
916
|
+
signing_options = Dropbox::Sign::SubSigningOptions.new
|
917
|
+
signing_options.default_type = "draw"
|
918
|
+
signing_options.draw = true
|
919
|
+
signing_options.phone = false
|
920
|
+
signing_options.type = true
|
921
|
+
signing_options.upload = true
|
922
|
+
|
923
|
+
signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
|
924
|
+
signers_1.role = "Client"
|
925
|
+
signers_1.name = "George"
|
926
|
+
signers_1.email_address = "george@example.com"
|
927
|
+
|
928
|
+
signers = [
|
929
|
+
signers_1,
|
930
|
+
]
|
931
|
+
|
932
|
+
ccs_1 = Dropbox::Sign::SubCC.new
|
933
|
+
ccs_1.role = "Accounting"
|
934
|
+
ccs_1.email_address = "accounting@example.com"
|
935
|
+
|
936
|
+
ccs = [
|
937
|
+
ccs_1,
|
938
|
+
]
|
939
|
+
|
940
|
+
custom_fields_1 = Dropbox::Sign::SubCustomField.new
|
941
|
+
custom_fields_1.name = "Cost"
|
942
|
+
custom_fields_1.editor = "Client"
|
943
|
+
custom_fields_1.required = true
|
944
|
+
custom_fields_1.value = "$20,000"
|
945
|
+
|
946
|
+
custom_fields = [
|
947
|
+
custom_fields_1,
|
948
|
+
]
|
949
|
+
|
950
|
+
signature_request_edit_with_template_request = Dropbox::Sign::SignatureRequestEditWithTemplateRequest.new
|
951
|
+
signature_request_edit_with_template_request.template_ids = [
|
952
|
+
"61a832ff0d8423f91d503e76bfbcc750f7417c78",
|
953
|
+
]
|
954
|
+
signature_request_edit_with_template_request.message = "Glad we could come to an agreement."
|
955
|
+
signature_request_edit_with_template_request.subject = "Purchase Order"
|
956
|
+
signature_request_edit_with_template_request.test_mode = true
|
957
|
+
signature_request_edit_with_template_request.signing_options = signing_options
|
958
|
+
signature_request_edit_with_template_request.signers = signers
|
959
|
+
signature_request_edit_with_template_request.ccs = ccs
|
960
|
+
signature_request_edit_with_template_request.custom_fields = custom_fields
|
961
|
+
|
962
|
+
begin
|
963
|
+
response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_with_template(
|
964
|
+
"fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id
|
965
|
+
signature_request_edit_with_template_request,
|
966
|
+
)
|
967
|
+
|
968
|
+
p response
|
969
|
+
rescue Dropbox::Sign::ApiError => e
|
970
|
+
puts "Exception when calling SignatureRequestApi#signature_request_edit_with_template: #{e}"
|
971
|
+
end
|
972
|
+
|
973
|
+
```
|
974
|
+
|
975
|
+
#### Using the `signature_request_edit_with_template_with_http_info` variant
|
976
|
+
|
977
|
+
This returns an Array which contains the response data, status code and headers.
|
978
|
+
|
979
|
+
> `<Array(<SignatureRequestGetResponse>, Integer, Hash)> signature_request_edit_with_template_with_http_info(signature_request_id, signature_request_edit_with_template_request)`
|
980
|
+
|
981
|
+
```ruby
|
982
|
+
begin
|
983
|
+
# Edit Signature Request With Template
|
984
|
+
data, status_code, headers = api_instance.signature_request_edit_with_template_with_http_info(signature_request_id, signature_request_edit_with_template_request)
|
985
|
+
p status_code # => 2xx
|
986
|
+
p headers # => { ... }
|
987
|
+
p data # => <SignatureRequestGetResponse>
|
988
|
+
rescue Dropbox::Sign::ApiError => e
|
989
|
+
puts "Error when calling SignatureRequestApi->signature_request_edit_with_template_with_http_info: #{e}"
|
990
|
+
end
|
991
|
+
```
|
992
|
+
|
993
|
+
### Parameters
|
994
|
+
|
995
|
+
| Name | Type | Description | Notes |
|
996
|
+
| ---- | ---- | ----------- | ----- |
|
997
|
+
| `signature_request_id` | **String** | The id of the SignatureRequest to edit. | |
|
998
|
+
| `signature_request_edit_with_template_request` | [**SignatureRequestEditWithTemplateRequest**](SignatureRequestEditWithTemplateRequest.md) | | |
|
999
|
+
|
1000
|
+
### Return type
|
1001
|
+
|
1002
|
+
[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
|
1003
|
+
|
1004
|
+
### Authorization
|
1005
|
+
|
1006
|
+
[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
|
1007
|
+
|
1008
|
+
### HTTP request headers
|
1009
|
+
|
1010
|
+
- **Content-Type**: application/json, multipart/form-data
|
1011
|
+
- **Accept**: application/json
|
1012
|
+
|
1013
|
+
|
507
1014
|
## `signature_request_files`
|
508
1015
|
|
509
1016
|
> `File signature_request_files(signature_request_id, opts)`
|
@@ -515,25 +1022,25 @@ Obtain a copy of the current documents specified by the `signature_request_id` p
|
|
515
1022
|
### Examples
|
516
1023
|
|
517
1024
|
```ruby
|
1025
|
+
require "json"
|
518
1026
|
require "dropbox-sign"
|
519
1027
|
|
520
1028
|
Dropbox::Sign.configure do |config|
|
521
|
-
# Configure HTTP basic authorization: api_key
|
522
1029
|
config.username = "YOUR_API_KEY"
|
523
|
-
|
524
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
525
1030
|
# config.access_token = "YOUR_ACCESS_TOKEN"
|
526
1031
|
end
|
527
1032
|
|
528
|
-
signature_request_api = Dropbox::Sign::SignatureRequestApi.new
|
529
|
-
|
530
|
-
signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967"
|
531
|
-
|
532
1033
|
begin
|
533
|
-
|
534
|
-
|
1034
|
+
response = Dropbox::Sign::SignatureRequestApi.new.signature_request_files(
|
1035
|
+
"fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id
|
1036
|
+
{
|
1037
|
+
file_type: "pdf",
|
1038
|
+
},
|
1039
|
+
)
|
1040
|
+
|
1041
|
+
FileUtils.cp(response.path, "./file_response")
|
535
1042
|
rescue Dropbox::Sign::ApiError => e
|
536
|
-
puts "Exception when calling
|
1043
|
+
puts "Exception when calling SignatureRequestApi#signature_request_files: #{e}"
|
537
1044
|
end
|
538
1045
|
|
539
1046
|
```
|
@@ -588,25 +1095,22 @@ Obtain a copy of the current documents specified by the `signature_request_id` p
|
|
588
1095
|
### Examples
|
589
1096
|
|
590
1097
|
```ruby
|
1098
|
+
require "json"
|
591
1099
|
require "dropbox-sign"
|
592
1100
|
|
593
1101
|
Dropbox::Sign.configure do |config|
|
594
|
-
# Configure HTTP basic authorization: api_key
|
595
1102
|
config.username = "YOUR_API_KEY"
|
596
|
-
|
597
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
598
1103
|
# config.access_token = "YOUR_ACCESS_TOKEN"
|
599
1104
|
end
|
600
1105
|
|
601
|
-
signature_request_api = Dropbox::Sign::SignatureRequestApi.new
|
602
|
-
|
603
|
-
signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967"
|
604
|
-
|
605
1106
|
begin
|
606
|
-
|
607
|
-
|
1107
|
+
response = Dropbox::Sign::SignatureRequestApi.new.signature_request_files_as_data_uri(
|
1108
|
+
"fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id
|
1109
|
+
)
|
1110
|
+
|
1111
|
+
p response
|
608
1112
|
rescue Dropbox::Sign::ApiError => e
|
609
|
-
puts "Exception when calling
|
1113
|
+
puts "Exception when calling SignatureRequestApi#signature_request_files_as_data_uri: #{e}"
|
610
1114
|
end
|
611
1115
|
|
612
1116
|
```
|
@@ -660,25 +1164,25 @@ Obtain a copy of the current documents specified by the `signature_request_id` p
|
|
660
1164
|
### Examples
|
661
1165
|
|
662
1166
|
```ruby
|
1167
|
+
require "json"
|
663
1168
|
require "dropbox-sign"
|
664
1169
|
|
665
1170
|
Dropbox::Sign.configure do |config|
|
666
|
-
# Configure HTTP basic authorization: api_key
|
667
1171
|
config.username = "YOUR_API_KEY"
|
668
|
-
|
669
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
670
1172
|
# config.access_token = "YOUR_ACCESS_TOKEN"
|
671
1173
|
end
|
672
1174
|
|
673
|
-
signature_request_api = Dropbox::Sign::SignatureRequestApi.new
|
674
|
-
|
675
|
-
signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967"
|
676
|
-
|
677
1175
|
begin
|
678
|
-
|
679
|
-
|
1176
|
+
response = Dropbox::Sign::SignatureRequestApi.new.signature_request_files_as_file_url(
|
1177
|
+
"fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id
|
1178
|
+
{
|
1179
|
+
force_download: 1,
|
1180
|
+
},
|
1181
|
+
)
|
1182
|
+
|
1183
|
+
p response
|
680
1184
|
rescue Dropbox::Sign::ApiError => e
|
681
|
-
puts "Exception when calling
|
1185
|
+
puts "Exception when calling SignatureRequestApi#signature_request_files_as_file_url: #{e}"
|
682
1186
|
end
|
683
1187
|
|
684
1188
|
```
|
@@ -733,25 +1237,22 @@ Returns the status of the SignatureRequest specified by the `signature_request_i
|
|
733
1237
|
### Examples
|
734
1238
|
|
735
1239
|
```ruby
|
1240
|
+
require "json"
|
736
1241
|
require "dropbox-sign"
|
737
1242
|
|
738
1243
|
Dropbox::Sign.configure do |config|
|
739
|
-
# Configure HTTP basic authorization: api_key
|
740
1244
|
config.username = "YOUR_API_KEY"
|
741
|
-
|
742
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
743
1245
|
# config.access_token = "YOUR_ACCESS_TOKEN"
|
744
1246
|
end
|
745
1247
|
|
746
|
-
signature_request_api = Dropbox::Sign::SignatureRequestApi.new
|
747
|
-
|
748
|
-
signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967"
|
749
|
-
|
750
1248
|
begin
|
751
|
-
|
752
|
-
|
1249
|
+
response = Dropbox::Sign::SignatureRequestApi.new.signature_request_get(
|
1250
|
+
"fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id
|
1251
|
+
)
|
1252
|
+
|
1253
|
+
p response
|
753
1254
|
rescue Dropbox::Sign::ApiError => e
|
754
|
-
puts "Exception when calling
|
1255
|
+
puts "Exception when calling SignatureRequestApi#signature_request_get: #{e}"
|
755
1256
|
end
|
756
1257
|
|
757
1258
|
```
|
@@ -805,26 +1306,27 @@ Returns a list of SignatureRequests that you can access. This includes Signature
|
|
805
1306
|
### Examples
|
806
1307
|
|
807
1308
|
```ruby
|
1309
|
+
require "json"
|
808
1310
|
require "dropbox-sign"
|
809
1311
|
|
810
1312
|
Dropbox::Sign.configure do |config|
|
811
|
-
# Configure HTTP basic authorization: api_key
|
812
1313
|
config.username = "YOUR_API_KEY"
|
813
|
-
|
814
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
815
1314
|
# config.access_token = "YOUR_ACCESS_TOKEN"
|
816
1315
|
end
|
817
1316
|
|
818
|
-
signature_request_api = Dropbox::Sign::SignatureRequestApi.new
|
819
|
-
|
820
|
-
account_id = null
|
821
|
-
page = 1
|
822
|
-
|
823
1317
|
begin
|
824
|
-
|
825
|
-
|
1318
|
+
response = Dropbox::Sign::SignatureRequestApi.new.signature_request_list(
|
1319
|
+
{
|
1320
|
+
account_id: nil,
|
1321
|
+
page: 1,
|
1322
|
+
page_size: 20,
|
1323
|
+
query: nil,
|
1324
|
+
},
|
1325
|
+
)
|
1326
|
+
|
1327
|
+
p response
|
826
1328
|
rescue Dropbox::Sign::ApiError => e
|
827
|
-
puts "Exception when calling
|
1329
|
+
puts "Exception when calling SignatureRequestApi#signature_request_list: #{e}"
|
828
1330
|
end
|
829
1331
|
|
830
1332
|
```
|
@@ -881,25 +1383,22 @@ Releases a held SignatureRequest that was claimed and prepared from an [Unclaime
|
|
881
1383
|
### Examples
|
882
1384
|
|
883
1385
|
```ruby
|
1386
|
+
require "json"
|
884
1387
|
require "dropbox-sign"
|
885
1388
|
|
886
1389
|
Dropbox::Sign.configure do |config|
|
887
|
-
# Configure HTTP basic authorization: api_key
|
888
1390
|
config.username = "YOUR_API_KEY"
|
889
|
-
|
890
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
891
1391
|
# config.access_token = "YOUR_ACCESS_TOKEN"
|
892
1392
|
end
|
893
1393
|
|
894
|
-
signature_request_api = Dropbox::Sign::SignatureRequestApi.new
|
895
|
-
|
896
|
-
signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
|
897
|
-
|
898
1394
|
begin
|
899
|
-
|
900
|
-
|
1395
|
+
response = Dropbox::Sign::SignatureRequestApi.new.signature_request_release_hold(
|
1396
|
+
"fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id
|
1397
|
+
)
|
1398
|
+
|
1399
|
+
p response
|
901
1400
|
rescue Dropbox::Sign::ApiError => e
|
902
|
-
puts "Exception when calling
|
1401
|
+
puts "Exception when calling SignatureRequestApi#signature_request_release_hold: #{e}"
|
903
1402
|
end
|
904
1403
|
|
905
1404
|
```
|
@@ -953,28 +1452,26 @@ Sends an email to the signer reminding them to sign the signature request. You c
|
|
953
1452
|
### Examples
|
954
1453
|
|
955
1454
|
```ruby
|
1455
|
+
require "json"
|
956
1456
|
require "dropbox-sign"
|
957
1457
|
|
958
1458
|
Dropbox::Sign.configure do |config|
|
959
|
-
# Configure HTTP basic authorization: api_key
|
960
1459
|
config.username = "YOUR_API_KEY"
|
961
|
-
|
962
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
963
1460
|
# config.access_token = "YOUR_ACCESS_TOKEN"
|
964
1461
|
end
|
965
1462
|
|
966
|
-
|
967
|
-
|
968
|
-
data = Dropbox::Sign::SignatureRequestRemindRequest.new
|
969
|
-
data.email_address = "john@example.com"
|
970
|
-
|
971
|
-
signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
|
1463
|
+
signature_request_remind_request = Dropbox::Sign::SignatureRequestRemindRequest.new
|
1464
|
+
signature_request_remind_request.email_address = "john@example.com"
|
972
1465
|
|
973
1466
|
begin
|
974
|
-
|
975
|
-
|
1467
|
+
response = Dropbox::Sign::SignatureRequestApi.new.signature_request_remind(
|
1468
|
+
"fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id
|
1469
|
+
signature_request_remind_request,
|
1470
|
+
)
|
1471
|
+
|
1472
|
+
p response
|
976
1473
|
rescue Dropbox::Sign::ApiError => e
|
977
|
-
puts "Exception when calling
|
1474
|
+
puts "Exception when calling SignatureRequestApi#signature_request_remind: #{e}"
|
978
1475
|
end
|
979
1476
|
|
980
1477
|
```
|
@@ -1029,25 +1526,19 @@ Removes your access to a completed signature request. This action is **not rever
|
|
1029
1526
|
### Examples
|
1030
1527
|
|
1031
1528
|
```ruby
|
1529
|
+
require "json"
|
1032
1530
|
require "dropbox-sign"
|
1033
1531
|
|
1034
1532
|
Dropbox::Sign.configure do |config|
|
1035
|
-
# Configure HTTP basic authorization: api_key
|
1036
1533
|
config.username = "YOUR_API_KEY"
|
1037
|
-
|
1038
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
1039
|
-
# config.access_token = "YOUR_ACCESS_TOKEN"
|
1040
1534
|
end
|
1041
1535
|
|
1042
|
-
signature_request_api = Dropbox::Sign::SignatureRequestApi.new
|
1043
|
-
|
1044
|
-
signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
|
1045
|
-
|
1046
1536
|
begin
|
1047
|
-
|
1048
|
-
|
1537
|
+
Dropbox::Sign::SignatureRequestApi.new.signature_request_remove(
|
1538
|
+
"fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id
|
1539
|
+
)
|
1049
1540
|
rescue Dropbox::Sign::ApiError => e
|
1050
|
-
puts "Exception when calling
|
1541
|
+
puts "Exception when calling SignatureRequestApi#signature_request_remove: #{e}"
|
1051
1542
|
end
|
1052
1543
|
|
1053
1544
|
```
|
@@ -1101,61 +1592,70 @@ Creates and sends a new SignatureRequest with the submitted documents. If `form_
|
|
1101
1592
|
### Examples
|
1102
1593
|
|
1103
1594
|
```ruby
|
1595
|
+
require "json"
|
1104
1596
|
require "dropbox-sign"
|
1105
1597
|
|
1106
1598
|
Dropbox::Sign.configure do |config|
|
1107
|
-
# Configure HTTP basic authorization: api_key
|
1108
1599
|
config.username = "YOUR_API_KEY"
|
1109
|
-
|
1110
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
1111
1600
|
# config.access_token = "YOUR_ACCESS_TOKEN"
|
1112
1601
|
end
|
1113
1602
|
|
1114
|
-
|
1115
|
-
|
1116
|
-
signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new
|
1117
|
-
signer_1.email_address = "jack@example.com"
|
1118
|
-
signer_1.name = "Jack"
|
1119
|
-
signer_1.order = 0
|
1120
|
-
|
1121
|
-
signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new
|
1122
|
-
signer_2.email_address = "jill@example.com"
|
1123
|
-
signer_2.name = "Jill"
|
1124
|
-
signer_2.order = 1
|
1603
|
+
field_options = Dropbox::Sign::SubFieldOptions.new
|
1604
|
+
field_options.date_format = "DD - MM - YYYY"
|
1125
1605
|
|
1126
1606
|
signing_options = Dropbox::Sign::SubSigningOptions.new
|
1607
|
+
signing_options.default_type = "draw"
|
1127
1608
|
signing_options.draw = true
|
1609
|
+
signing_options.phone = false
|
1128
1610
|
signing_options.type = true
|
1129
1611
|
signing_options.upload = true
|
1130
|
-
signing_options.phone = true
|
1131
|
-
signing_options.default_type = "draw"
|
1132
1612
|
|
1133
|
-
|
1134
|
-
|
1613
|
+
signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new
|
1614
|
+
signers_1.name = "Jack"
|
1615
|
+
signers_1.email_address = "jack@example.com"
|
1616
|
+
signers_1.order = 0
|
1617
|
+
|
1618
|
+
signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new
|
1619
|
+
signers_2.name = "Jill"
|
1620
|
+
signers_2.email_address = "jill@example.com"
|
1621
|
+
signers_2.order = 1
|
1135
1622
|
|
1136
|
-
|
1137
|
-
|
1138
|
-
|
1139
|
-
|
1140
|
-
|
1141
|
-
|
1142
|
-
|
1143
|
-
|
1623
|
+
signers = [
|
1624
|
+
signers_1,
|
1625
|
+
signers_2,
|
1626
|
+
]
|
1627
|
+
|
1628
|
+
signature_request_send_request = Dropbox::Sign::SignatureRequestSendRequest.new
|
1629
|
+
signature_request_send_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."
|
1630
|
+
signature_request_send_request.subject = "The NDA we talked about"
|
1631
|
+
signature_request_send_request.test_mode = true
|
1632
|
+
signature_request_send_request.title = "NDA with Acme Co."
|
1633
|
+
signature_request_send_request.cc_email_addresses = [
|
1634
|
+
"lawyer1@dropboxsign.com",
|
1635
|
+
"lawyer2@dropboxsign.com",
|
1636
|
+
]
|
1637
|
+
signature_request_send_request.files = [
|
1638
|
+
File.new("./example_signature_request.pdf", "r"),
|
1144
1639
|
]
|
1145
|
-
|
1146
|
-
|
1147
|
-
|
1148
|
-
|
1149
|
-
}
|
1150
|
-
|
1151
|
-
|
1152
|
-
|
1640
|
+
signature_request_send_request.metadata = JSON.parse(<<-EOD
|
1641
|
+
{
|
1642
|
+
"custom_id": 1234,
|
1643
|
+
"custom_text": "NDA #9"
|
1644
|
+
}
|
1645
|
+
EOD
|
1646
|
+
)
|
1647
|
+
signature_request_send_request.field_options = field_options
|
1648
|
+
signature_request_send_request.signing_options = signing_options
|
1649
|
+
signature_request_send_request.signers = signers
|
1153
1650
|
|
1154
1651
|
begin
|
1155
|
-
|
1156
|
-
|
1652
|
+
response = Dropbox::Sign::SignatureRequestApi.new.signature_request_send(
|
1653
|
+
signature_request_send_request,
|
1654
|
+
)
|
1655
|
+
|
1656
|
+
p response
|
1157
1657
|
rescue Dropbox::Sign::ApiError => e
|
1158
|
-
puts "Exception when calling
|
1658
|
+
puts "Exception when calling SignatureRequestApi#signature_request_send: #{e}"
|
1159
1659
|
end
|
1160
1660
|
|
1161
1661
|
```
|
@@ -1209,55 +1709,68 @@ Creates and sends a new SignatureRequest based off of the Template(s) specified
|
|
1209
1709
|
### Examples
|
1210
1710
|
|
1211
1711
|
```ruby
|
1712
|
+
require "json"
|
1212
1713
|
require "dropbox-sign"
|
1213
1714
|
|
1214
1715
|
Dropbox::Sign.configure do |config|
|
1215
|
-
# Configure HTTP basic authorization: api_key
|
1216
1716
|
config.username = "YOUR_API_KEY"
|
1217
|
-
|
1218
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
1219
1717
|
# config.access_token = "YOUR_ACCESS_TOKEN"
|
1220
1718
|
end
|
1221
1719
|
|
1222
|
-
signature_request_api = Dropbox::Sign::SignatureRequestApi.new
|
1223
|
-
|
1224
|
-
signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
|
1225
|
-
signer_1.role = "Client"
|
1226
|
-
signer_1.email_address = "george@example.com"
|
1227
|
-
signer_1.name = "George"
|
1228
|
-
|
1229
|
-
cc_1 = Dropbox::Sign::SubCC.new
|
1230
|
-
cc_1.role = "Accounting"
|
1231
|
-
cc_1.email_address = "accounting@example.com"
|
1232
|
-
|
1233
|
-
custom_field_1 = Dropbox::Sign::SubCustomField.new
|
1234
|
-
custom_field_1.name = "Cost"
|
1235
|
-
custom_field_1.value = "$20,000"
|
1236
|
-
custom_field_1.editor = "Client"
|
1237
|
-
custom_field_1.required = true
|
1238
|
-
|
1239
1720
|
signing_options = Dropbox::Sign::SubSigningOptions.new
|
1721
|
+
signing_options.default_type = "draw"
|
1240
1722
|
signing_options.draw = true
|
1723
|
+
signing_options.phone = false
|
1241
1724
|
signing_options.type = true
|
1242
1725
|
signing_options.upload = true
|
1243
|
-
signing_options.phone = false
|
1244
|
-
signing_options.default_type = "draw"
|
1245
1726
|
|
1246
|
-
|
1247
|
-
|
1248
|
-
|
1249
|
-
|
1250
|
-
|
1251
|
-
|
1252
|
-
|
1253
|
-
|
1254
|
-
|
1727
|
+
signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new
|
1728
|
+
signers_1.role = "Client"
|
1729
|
+
signers_1.name = "George"
|
1730
|
+
signers_1.email_address = "george@example.com"
|
1731
|
+
|
1732
|
+
signers = [
|
1733
|
+
signers_1,
|
1734
|
+
]
|
1735
|
+
|
1736
|
+
ccs_1 = Dropbox::Sign::SubCC.new
|
1737
|
+
ccs_1.role = "Accounting"
|
1738
|
+
ccs_1.email_address = "accounting@example.com"
|
1739
|
+
|
1740
|
+
ccs = [
|
1741
|
+
ccs_1,
|
1742
|
+
]
|
1743
|
+
|
1744
|
+
custom_fields_1 = Dropbox::Sign::SubCustomField.new
|
1745
|
+
custom_fields_1.name = "Cost"
|
1746
|
+
custom_fields_1.editor = "Client"
|
1747
|
+
custom_fields_1.required = true
|
1748
|
+
custom_fields_1.value = "$20,000"
|
1749
|
+
|
1750
|
+
custom_fields = [
|
1751
|
+
custom_fields_1,
|
1752
|
+
]
|
1753
|
+
|
1754
|
+
signature_request_send_with_template_request = Dropbox::Sign::SignatureRequestSendWithTemplateRequest.new
|
1755
|
+
signature_request_send_with_template_request.template_ids = [
|
1756
|
+
"61a832ff0d8423f91d503e76bfbcc750f7417c78",
|
1757
|
+
]
|
1758
|
+
signature_request_send_with_template_request.message = "Glad we could come to an agreement."
|
1759
|
+
signature_request_send_with_template_request.subject = "Purchase Order"
|
1760
|
+
signature_request_send_with_template_request.test_mode = true
|
1761
|
+
signature_request_send_with_template_request.signing_options = signing_options
|
1762
|
+
signature_request_send_with_template_request.signers = signers
|
1763
|
+
signature_request_send_with_template_request.ccs = ccs
|
1764
|
+
signature_request_send_with_template_request.custom_fields = custom_fields
|
1255
1765
|
|
1256
1766
|
begin
|
1257
|
-
|
1258
|
-
|
1767
|
+
response = Dropbox::Sign::SignatureRequestApi.new.signature_request_send_with_template(
|
1768
|
+
signature_request_send_with_template_request,
|
1769
|
+
)
|
1770
|
+
|
1771
|
+
p response
|
1259
1772
|
rescue Dropbox::Sign::ApiError => e
|
1260
|
-
puts "Exception when calling
|
1773
|
+
puts "Exception when calling SignatureRequestApi#signature_request_send_with_template: #{e}"
|
1261
1774
|
end
|
1262
1775
|
|
1263
1776
|
```
|
@@ -1311,29 +1824,27 @@ Updates the email address and/or the name for a given signer on a signature requ
|
|
1311
1824
|
### Examples
|
1312
1825
|
|
1313
1826
|
```ruby
|
1827
|
+
require "json"
|
1314
1828
|
require "dropbox-sign"
|
1315
1829
|
|
1316
1830
|
Dropbox::Sign.configure do |config|
|
1317
|
-
# Configure HTTP basic authorization: api_key
|
1318
1831
|
config.username = "YOUR_API_KEY"
|
1319
|
-
|
1320
|
-
# or, configure Bearer (JWT) authorization: oauth2
|
1321
1832
|
# config.access_token = "YOUR_ACCESS_TOKEN"
|
1322
1833
|
end
|
1323
1834
|
|
1324
|
-
|
1325
|
-
|
1326
|
-
|
1327
|
-
data.email_address = "john@example.com"
|
1328
|
-
data.signature_id = "78caf2a1d01cd39cea2bc1cbb340dac3"
|
1329
|
-
|
1330
|
-
signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
|
1835
|
+
signature_request_update_request = Dropbox::Sign::SignatureRequestUpdateRequest.new
|
1836
|
+
signature_request_update_request.signature_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"
|
1837
|
+
signature_request_update_request.email_address = "john@example.com"
|
1331
1838
|
|
1332
1839
|
begin
|
1333
|
-
|
1334
|
-
|
1840
|
+
response = Dropbox::Sign::SignatureRequestApi.new.signature_request_update(
|
1841
|
+
"fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id
|
1842
|
+
signature_request_update_request,
|
1843
|
+
)
|
1844
|
+
|
1845
|
+
p response
|
1335
1846
|
rescue Dropbox::Sign::ApiError => e
|
1336
|
-
puts "Exception when calling
|
1847
|
+
puts "Exception when calling SignatureRequestApi#signature_request_update: #{e}"
|
1337
1848
|
end
|
1338
1849
|
|
1339
1850
|
```
|