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/FaxApi.md
CHANGED
@@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [`fax_delete`](FaxApi.md#fax_delete) | **DELETE** `/fax/{fax_id}` | Delete Fax |
|
8
|
-
| [`fax_files`](FaxApi.md#fax_files) | **GET** `/fax/files/{fax_id}` |
|
8
|
+
| [`fax_files`](FaxApi.md#fax_files) | **GET** `/fax/files/{fax_id}` | Download Fax Files |
|
9
9
|
| [`fax_get`](FaxApi.md#fax_get) | **GET** `/fax/{fax_id}` | Get Fax |
|
10
10
|
| [`fax_list`](FaxApi.md#fax_list) | **GET** `/fax/list` | Lists Faxes |
|
11
11
|
| [`fax_send`](FaxApi.md#fax_send) | **POST** `/fax/send` | Send Fax |
|
@@ -17,24 +17,24 @@ All URIs are relative to *https://api.hellosign.com/v3*
|
|
17
17
|
|
18
18
|
Delete Fax
|
19
19
|
|
20
|
-
Deletes the specified Fax from the system
|
20
|
+
Deletes the specified Fax from the system
|
21
21
|
|
22
22
|
### Examples
|
23
23
|
|
24
24
|
```ruby
|
25
|
+
require "json"
|
25
26
|
require "dropbox-sign"
|
26
27
|
|
27
28
|
Dropbox::Sign.configure do |config|
|
28
|
-
# Configure HTTP basic authorization: api_key
|
29
29
|
config.username = "YOUR_API_KEY"
|
30
30
|
end
|
31
31
|
|
32
|
-
fax_api = Dropbox::Sign::FaxApi.new
|
33
|
-
|
34
32
|
begin
|
35
|
-
|
33
|
+
Dropbox::Sign::FaxApi.new.fax_delete(
|
34
|
+
"fa5c8a0b0f492d768749333ad6fcc214c111e967", # fax_id
|
35
|
+
)
|
36
36
|
rescue Dropbox::Sign::ApiError => e
|
37
|
-
puts "Exception when calling
|
37
|
+
puts "Exception when calling FaxApi#fax_delete: #{e}"
|
38
38
|
end
|
39
39
|
|
40
40
|
```
|
@@ -81,29 +81,28 @@ nil (empty response body)
|
|
81
81
|
|
82
82
|
> `File fax_files(fax_id)`
|
83
83
|
|
84
|
-
|
84
|
+
Download Fax Files
|
85
85
|
|
86
|
-
|
86
|
+
Downloads files associated with a Fax
|
87
87
|
|
88
88
|
### Examples
|
89
89
|
|
90
90
|
```ruby
|
91
|
+
require "json"
|
91
92
|
require "dropbox-sign"
|
92
93
|
|
93
94
|
Dropbox::Sign.configure do |config|
|
94
|
-
# Configure HTTP basic authorization: api_key
|
95
95
|
config.username = "YOUR_API_KEY"
|
96
96
|
end
|
97
97
|
|
98
|
-
fax_api = Dropbox::Sign::FaxApi.new
|
99
|
-
|
100
|
-
faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"
|
101
|
-
|
102
98
|
begin
|
103
|
-
|
104
|
-
|
99
|
+
response = Dropbox::Sign::FaxApi.new.fax_files(
|
100
|
+
"fa5c8a0b0f492d768749333ad6fcc214c111e967", # fax_id
|
101
|
+
)
|
102
|
+
|
103
|
+
FileUtils.cp(response.path, "./file_response")
|
105
104
|
rescue Dropbox::Sign::ApiError => e
|
106
|
-
puts "Exception when calling
|
105
|
+
puts "Exception when calling FaxApi#fax_files: #{e}"
|
107
106
|
end
|
108
107
|
|
109
108
|
```
|
@@ -116,7 +115,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
116
115
|
|
117
116
|
```ruby
|
118
117
|
begin
|
119
|
-
#
|
118
|
+
# Download Fax Files
|
120
119
|
data, status_code, headers = api_instance.fax_files_with_http_info(fax_id)
|
121
120
|
p status_code # => 2xx
|
122
121
|
p headers # => { ... }
|
@@ -152,27 +151,26 @@ end
|
|
152
151
|
|
153
152
|
Get Fax
|
154
153
|
|
155
|
-
Returns information about
|
154
|
+
Returns information about a Fax
|
156
155
|
|
157
156
|
### Examples
|
158
157
|
|
159
158
|
```ruby
|
159
|
+
require "json"
|
160
160
|
require "dropbox-sign"
|
161
161
|
|
162
162
|
Dropbox::Sign.configure do |config|
|
163
|
-
# Configure HTTP basic authorization: api_key
|
164
163
|
config.username = "YOUR_API_KEY"
|
165
164
|
end
|
166
165
|
|
167
|
-
fax_api = Dropbox::Sign::FaxApi.new
|
168
|
-
|
169
|
-
fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967"
|
170
|
-
|
171
166
|
begin
|
172
|
-
|
173
|
-
|
167
|
+
response = Dropbox::Sign::FaxApi.new.fax_get(
|
168
|
+
"fa5c8a0b0f492d768749333ad6fcc214c111e967", # fax_id
|
169
|
+
)
|
170
|
+
|
171
|
+
p response
|
174
172
|
rescue Dropbox::Sign::ApiError => e
|
175
|
-
puts "Exception when calling
|
173
|
+
puts "Exception when calling FaxApi#fax_get: #{e}"
|
176
174
|
end
|
177
175
|
|
178
176
|
```
|
@@ -221,28 +219,29 @@ end
|
|
221
219
|
|
222
220
|
Lists Faxes
|
223
221
|
|
224
|
-
Returns properties of multiple
|
222
|
+
Returns properties of multiple Faxes
|
225
223
|
|
226
224
|
### Examples
|
227
225
|
|
228
226
|
```ruby
|
227
|
+
require "json"
|
229
228
|
require "dropbox-sign"
|
230
229
|
|
231
230
|
Dropbox::Sign.configure do |config|
|
232
|
-
# Configure HTTP basic authorization: api_key
|
233
231
|
config.username = "YOUR_API_KEY"
|
234
232
|
end
|
235
233
|
|
236
|
-
fax_api = Dropbox::Sign::FaxApi.new
|
237
|
-
|
238
|
-
page = 1
|
239
|
-
page_size = 2
|
240
|
-
|
241
234
|
begin
|
242
|
-
|
243
|
-
|
235
|
+
response = Dropbox::Sign::FaxApi.new.fax_list(
|
236
|
+
{
|
237
|
+
page: 1,
|
238
|
+
page_size: 20,
|
239
|
+
},
|
240
|
+
)
|
241
|
+
|
242
|
+
p response
|
244
243
|
rescue Dropbox::Sign::ApiError => e
|
245
|
-
puts "Exception when calling
|
244
|
+
puts "Exception when calling FaxApi#fax_list: #{e}"
|
246
245
|
end
|
247
246
|
|
248
247
|
```
|
@@ -269,8 +268,8 @@ end
|
|
269
268
|
|
270
269
|
| Name | Type | Description | Notes |
|
271
270
|
| ---- | ---- | ----------- | ----- |
|
272
|
-
| `page` | **Integer** |
|
273
|
-
| `page_size` | **Integer** |
|
271
|
+
| `page` | **Integer** | Which page number of the Fax List to return. Defaults to `1`. | [optional][default to 1] |
|
272
|
+
| `page_size` | **Integer** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] |
|
274
273
|
|
275
274
|
### Return type
|
276
275
|
|
@@ -292,35 +291,38 @@ end
|
|
292
291
|
|
293
292
|
Send Fax
|
294
293
|
|
295
|
-
|
294
|
+
Creates and sends a new Fax with the submitted file(s)
|
296
295
|
|
297
296
|
### Examples
|
298
297
|
|
299
298
|
```ruby
|
299
|
+
require "json"
|
300
300
|
require "dropbox-sign"
|
301
301
|
|
302
302
|
Dropbox::Sign.configure do |config|
|
303
|
-
# Configure HTTP basic authorization: api_key
|
304
303
|
config.username = "YOUR_API_KEY"
|
305
304
|
end
|
306
305
|
|
307
|
-
|
308
|
-
|
309
|
-
|
310
|
-
|
311
|
-
|
312
|
-
|
313
|
-
|
314
|
-
|
315
|
-
|
316
|
-
|
317
|
-
|
306
|
+
fax_send_request = Dropbox::Sign::FaxSendRequest.new
|
307
|
+
fax_send_request.recipient = "16690000001"
|
308
|
+
fax_send_request.sender = "16690000000"
|
309
|
+
fax_send_request.test_mode = true
|
310
|
+
fax_send_request.cover_page_to = "Jill Fax"
|
311
|
+
fax_send_request.cover_page_from = "Faxer Faxerson"
|
312
|
+
fax_send_request.cover_page_message = "I'm sending you a fax!"
|
313
|
+
fax_send_request.title = "This is what the fax is about!"
|
314
|
+
fax_send_request.files = [
|
315
|
+
File.new("./example_fax.pdf", "r"),
|
316
|
+
]
|
318
317
|
|
319
318
|
begin
|
320
|
-
|
321
|
-
|
319
|
+
response = Dropbox::Sign::FaxApi.new.fax_send(
|
320
|
+
fax_send_request,
|
321
|
+
)
|
322
|
+
|
323
|
+
p response
|
322
324
|
rescue Dropbox::Sign::ApiError => e
|
323
|
-
puts "Exception when calling
|
325
|
+
puts "Exception when calling FaxApi#fax_send: #{e}"
|
324
326
|
end
|
325
327
|
|
326
328
|
```
|
@@ -6,7 +6,7 @@
|
|
6
6
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
|
-
| `number`<sup>*_required_</sup> | ```String``` | The Fax Line number
|
9
|
+
| `number`<sup>*_required_</sup> | ```String``` | The Fax Line number | |
|
10
10
|
| `account_id` | ```String``` | Account ID | |
|
11
11
|
| `email_address` | ```String``` | Email address | |
|
12
12
|
|
data/docs/FaxLineApi.md
CHANGED
@@ -24,24 +24,25 @@ Grants a user access to the specified Fax Line.
|
|
24
24
|
### Examples
|
25
25
|
|
26
26
|
```ruby
|
27
|
+
require "json"
|
27
28
|
require "dropbox-sign"
|
28
29
|
|
29
30
|
Dropbox::Sign.configure do |config|
|
30
|
-
# Configure HTTP basic authorization: api_key
|
31
31
|
config.username = "YOUR_API_KEY"
|
32
32
|
end
|
33
33
|
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
data.number = "[FAX_NUMBER]"
|
38
|
-
data.email_address = "member@dropboxsign.com"
|
34
|
+
fax_line_add_user_request = Dropbox::Sign::FaxLineAddUserRequest.new
|
35
|
+
fax_line_add_user_request.number = "[FAX_NUMBER]"
|
36
|
+
fax_line_add_user_request.email_address = "member@dropboxsign.com"
|
39
37
|
|
40
38
|
begin
|
41
|
-
|
42
|
-
|
39
|
+
response = Dropbox::Sign::FaxLineApi.new.fax_line_add_user(
|
40
|
+
fax_line_add_user_request,
|
41
|
+
)
|
42
|
+
|
43
|
+
p response
|
43
44
|
rescue Dropbox::Sign::ApiError => e
|
44
|
-
puts "Exception when calling
|
45
|
+
puts "Exception when calling FaxLineApi#fax_line_add_user: #{e}"
|
45
46
|
end
|
46
47
|
|
47
48
|
```
|
@@ -90,25 +91,26 @@ end
|
|
90
91
|
|
91
92
|
Get Available Fax Line Area Codes
|
92
93
|
|
93
|
-
Returns a
|
94
|
+
Returns a list of available area codes for a given state/province and city
|
94
95
|
|
95
96
|
### Examples
|
96
97
|
|
97
98
|
```ruby
|
99
|
+
require "json"
|
98
100
|
require "dropbox-sign"
|
99
101
|
|
100
102
|
Dropbox::Sign.configure do |config|
|
101
|
-
# Configure HTTP basic authorization: api_key
|
102
103
|
config.username = "YOUR_API_KEY"
|
103
104
|
end
|
104
105
|
|
105
|
-
fax_line_api = Dropbox::Sign::FaxLineApi.new
|
106
|
-
|
107
106
|
begin
|
108
|
-
|
109
|
-
|
107
|
+
response = Dropbox::Sign::FaxLineApi.new.fax_line_area_code_get(
|
108
|
+
"US", # country
|
109
|
+
)
|
110
|
+
|
111
|
+
p response
|
110
112
|
rescue Dropbox::Sign::ApiError => e
|
111
|
-
puts "Exception when calling
|
113
|
+
puts "Exception when calling FaxLineApi#fax_line_area_code_get: #{e}"
|
112
114
|
end
|
113
115
|
|
114
116
|
```
|
@@ -135,10 +137,10 @@ end
|
|
135
137
|
|
136
138
|
| Name | Type | Description | Notes |
|
137
139
|
| ---- | ---- | ----------- | ----- |
|
138
|
-
| `country` | **String** | Filter area codes by country
|
139
|
-
| `state` | **String** | Filter area codes by state
|
140
|
-
| `province` | **String** | Filter area codes by province
|
141
|
-
| `city` | **String** | Filter area codes by city
|
140
|
+
| `country` | **String** | Filter area codes by country | |
|
141
|
+
| `state` | **String** | Filter area codes by state | [optional] |
|
142
|
+
| `province` | **String** | Filter area codes by province | [optional] |
|
143
|
+
| `city` | **String** | Filter area codes by city | [optional] |
|
142
144
|
|
143
145
|
### Return type
|
144
146
|
|
@@ -160,29 +162,30 @@ end
|
|
160
162
|
|
161
163
|
Purchase Fax Line
|
162
164
|
|
163
|
-
Purchases a new Fax Line
|
165
|
+
Purchases a new Fax Line
|
164
166
|
|
165
167
|
### Examples
|
166
168
|
|
167
169
|
```ruby
|
170
|
+
require "json"
|
168
171
|
require "dropbox-sign"
|
169
172
|
|
170
173
|
Dropbox::Sign.configure do |config|
|
171
|
-
# Configure HTTP basic authorization: api_key
|
172
174
|
config.username = "YOUR_API_KEY"
|
173
175
|
end
|
174
176
|
|
175
|
-
|
176
|
-
|
177
|
-
|
178
|
-
data.area_code = 209
|
179
|
-
data.country = "US"
|
177
|
+
fax_line_create_request = Dropbox::Sign::FaxLineCreateRequest.new
|
178
|
+
fax_line_create_request.area_code = 209
|
179
|
+
fax_line_create_request.country = "US"
|
180
180
|
|
181
181
|
begin
|
182
|
-
|
183
|
-
|
182
|
+
response = Dropbox::Sign::FaxLineApi.new.fax_line_create(
|
183
|
+
fax_line_create_request,
|
184
|
+
)
|
185
|
+
|
186
|
+
p response
|
184
187
|
rescue Dropbox::Sign::ApiError => e
|
185
|
-
puts "Exception when calling
|
188
|
+
puts "Exception when calling FaxLineApi#fax_line_create: #{e}"
|
186
189
|
end
|
187
190
|
|
188
191
|
```
|
@@ -236,22 +239,22 @@ Deletes the specified Fax Line from the subscription.
|
|
236
239
|
### Examples
|
237
240
|
|
238
241
|
```ruby
|
242
|
+
require "json"
|
239
243
|
require "dropbox-sign"
|
240
244
|
|
241
245
|
Dropbox::Sign.configure do |config|
|
242
|
-
# Configure HTTP basic authorization: api_key
|
243
246
|
config.username = "YOUR_API_KEY"
|
244
247
|
end
|
245
248
|
|
246
|
-
|
247
|
-
|
248
|
-
data = Dropbox::Sign::FaxLineDeleteRequest.new
|
249
|
-
data.number = "[FAX_NUMBER]"
|
249
|
+
fax_line_delete_request = Dropbox::Sign::FaxLineDeleteRequest.new
|
250
|
+
fax_line_delete_request.number = "[FAX_NUMBER]"
|
250
251
|
|
251
252
|
begin
|
252
|
-
|
253
|
+
Dropbox::Sign::FaxLineApi.new.fax_line_delete(
|
254
|
+
fax_line_delete_request,
|
255
|
+
)
|
253
256
|
rescue Dropbox::Sign::ApiError => e
|
254
|
-
puts "Exception when calling
|
257
|
+
puts "Exception when calling FaxLineApi#fax_line_delete: #{e}"
|
255
258
|
end
|
256
259
|
|
257
260
|
```
|
@@ -305,20 +308,21 @@ Returns the properties and settings of a Fax Line.
|
|
305
308
|
### Examples
|
306
309
|
|
307
310
|
```ruby
|
311
|
+
require "json"
|
308
312
|
require "dropbox-sign"
|
309
313
|
|
310
314
|
Dropbox::Sign.configure do |config|
|
311
|
-
# Configure HTTP basic authorization: api_key
|
312
315
|
config.username = "YOUR_API_KEY"
|
313
316
|
end
|
314
317
|
|
315
|
-
fax_line_api = Dropbox::Sign::FaxLineApi.new
|
316
|
-
|
317
318
|
begin
|
318
|
-
|
319
|
-
|
319
|
+
response = Dropbox::Sign::FaxLineApi.new.fax_line_get(
|
320
|
+
"123-123-1234", # number
|
321
|
+
)
|
322
|
+
|
323
|
+
p response
|
320
324
|
rescue Dropbox::Sign::ApiError => e
|
321
|
-
puts "Exception when calling
|
325
|
+
puts "Exception when calling FaxLineApi#fax_line_get: #{e}"
|
322
326
|
end
|
323
327
|
|
324
328
|
```
|
@@ -345,7 +349,7 @@ end
|
|
345
349
|
|
346
350
|
| Name | Type | Description | Notes |
|
347
351
|
| ---- | ---- | ----------- | ----- |
|
348
|
-
| `number` | **String** | The Fax Line number
|
352
|
+
| `number` | **String** | The Fax Line number | |
|
349
353
|
|
350
354
|
### Return type
|
351
355
|
|
@@ -372,20 +376,26 @@ Returns the properties and settings of multiple Fax Lines.
|
|
372
376
|
### Examples
|
373
377
|
|
374
378
|
```ruby
|
379
|
+
require "json"
|
375
380
|
require "dropbox-sign"
|
376
381
|
|
377
382
|
Dropbox::Sign.configure do |config|
|
378
|
-
# Configure HTTP basic authorization: api_key
|
379
383
|
config.username = "YOUR_API_KEY"
|
380
384
|
end
|
381
385
|
|
382
|
-
fax_line_api = Dropbox::Sign::FaxLineApi.new
|
383
|
-
|
384
386
|
begin
|
385
|
-
|
386
|
-
|
387
|
+
response = Dropbox::Sign::FaxLineApi.new.fax_line_list(
|
388
|
+
{
|
389
|
+
account_id: "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97",
|
390
|
+
page: 1,
|
391
|
+
page_size: 20,
|
392
|
+
show_team_lines: nil,
|
393
|
+
},
|
394
|
+
)
|
395
|
+
|
396
|
+
p response
|
387
397
|
rescue Dropbox::Sign::ApiError => e
|
388
|
-
puts "Exception when calling
|
398
|
+
puts "Exception when calling FaxLineApi#fax_line_list: #{e}"
|
389
399
|
end
|
390
400
|
|
391
401
|
```
|
@@ -413,9 +423,9 @@ end
|
|
413
423
|
| Name | Type | Description | Notes |
|
414
424
|
| ---- | ---- | ----------- | ----- |
|
415
425
|
| `account_id` | **String** | Account ID | [optional] |
|
416
|
-
| `page` | **Integer** |
|
417
|
-
| `page_size` | **Integer** |
|
418
|
-
| `show_team_lines` | **Boolean** |
|
426
|
+
| `page` | **Integer** | Which page number of the Fax Line List to return. Defaults to `1`. | [optional][default to 1] |
|
427
|
+
| `page_size` | **Integer** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] |
|
428
|
+
| `show_team_lines` | **Boolean** | Include Fax Lines belonging to team members in the list | [optional] |
|
419
429
|
|
420
430
|
### Return type
|
421
431
|
|
@@ -437,29 +447,30 @@ end
|
|
437
447
|
|
438
448
|
Remove Fax Line Access
|
439
449
|
|
440
|
-
Removes a user's access to the specified Fax Line
|
450
|
+
Removes a user's access to the specified Fax Line
|
441
451
|
|
442
452
|
### Examples
|
443
453
|
|
444
454
|
```ruby
|
455
|
+
require "json"
|
445
456
|
require "dropbox-sign"
|
446
457
|
|
447
458
|
Dropbox::Sign.configure do |config|
|
448
|
-
# Configure HTTP basic authorization: api_key
|
449
459
|
config.username = "YOUR_API_KEY"
|
450
460
|
end
|
451
461
|
|
452
|
-
|
453
|
-
|
454
|
-
|
455
|
-
data.number = "[FAX_NUMBER]"
|
456
|
-
data.email_address = "member@dropboxsign.com"
|
462
|
+
fax_line_remove_user_request = Dropbox::Sign::FaxLineRemoveUserRequest.new
|
463
|
+
fax_line_remove_user_request.number = "[FAX_NUMBER]"
|
464
|
+
fax_line_remove_user_request.email_address = "member@dropboxsign.com"
|
457
465
|
|
458
466
|
begin
|
459
|
-
|
460
|
-
|
467
|
+
response = Dropbox::Sign::FaxLineApi.new.fax_line_remove_user(
|
468
|
+
fax_line_remove_user_request,
|
469
|
+
)
|
470
|
+
|
471
|
+
p response
|
461
472
|
rescue Dropbox::Sign::ApiError => e
|
462
|
-
puts "Exception when calling
|
473
|
+
puts "Exception when calling FaxLineApi#fax_line_remove_user: #{e}"
|
463
474
|
end
|
464
475
|
|
465
476
|
```
|
@@ -6,8 +6,8 @@
|
|
6
6
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
|
-
| `area_code`<sup>*_required_</sup> | ```Integer``` | Area code | |
|
10
|
-
| `country`<sup>*_required_</sup> | ```String``` | Country | |
|
11
|
-
| `city` | ```String``` | City | |
|
12
|
-
| `account_id` | ```String``` | Account ID | |
|
9
|
+
| `area_code`<sup>*_required_</sup> | ```Integer``` | Area code of the new Fax Line | |
|
10
|
+
| `country`<sup>*_required_</sup> | ```String``` | Country of the area code | |
|
11
|
+
| `city` | ```String``` | City of the area code | |
|
12
|
+
| `account_id` | ```String``` | Account ID of the account that will be assigned this new Fax Line | |
|
13
13
|
|
@@ -6,7 +6,7 @@
|
|
6
6
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
|
-
| `number`<sup>*_required_</sup> | ```String``` | The Fax Line number
|
10
|
-
| `account_id` | ```String``` | Account ID | |
|
11
|
-
| `email_address` | ```String``` | Email address | |
|
9
|
+
| `number`<sup>*_required_</sup> | ```String``` | The Fax Line number | |
|
10
|
+
| `account_id` | ```String``` | Account ID of the user to remove access | |
|
11
|
+
| `email_address` | ```String``` | Email address of the user to remove access | |
|
12
12
|
|
data/docs/FaxResponse.md
CHANGED
@@ -9,11 +9,12 @@
|
|
9
9
|
| `fax_id`<sup>*_required_</sup> | ```String``` | Fax ID | |
|
10
10
|
| `title`<sup>*_required_</sup> | ```String``` | Fax Title | |
|
11
11
|
| `original_title`<sup>*_required_</sup> | ```String``` | Fax Original Title | |
|
12
|
-
| `subject`<sup>*_required_</sup> | ```String``` | Fax Subject | |
|
13
|
-
| `message`<sup>*_required_</sup> | ```String``` | Fax Message | |
|
14
12
|
| `metadata`<sup>*_required_</sup> | ```Hash<String, Object>``` | Fax Metadata | |
|
15
13
|
| `created_at`<sup>*_required_</sup> | ```Integer``` | Fax Created At Timestamp | |
|
16
14
|
| `sender`<sup>*_required_</sup> | ```String``` | Fax Sender Email | |
|
17
|
-
| `transmissions`<sup>*_required_</sup> | [```Array<FaxResponseTransmission>```](FaxResponseTransmission.md) | Fax Transmissions List | |
|
18
15
|
| `files_url`<sup>*_required_</sup> | ```String``` | Fax Files URL | |
|
16
|
+
| `transmissions`<sup>*_required_</sup> | [```Array<FaxResponseTransmission>```](FaxResponseTransmission.md) | Fax Transmissions List | |
|
17
|
+
| `subject` | ```String``` | Fax Subject | |
|
18
|
+
| `message` | ```String``` | Fax Message | |
|
19
|
+
| `final_copy_uri` | ```String``` | The path where the completed document can be downloaded | |
|
19
20
|
|
@@ -7,7 +7,6 @@
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
9
|
| `recipient`<sup>*_required_</sup> | ```String``` | Fax Transmission Recipient | |
|
10
|
-
| `sender`<sup>*_required_</sup> | ```String``` | Fax Transmission Sender | |
|
11
10
|
| `status_code`<sup>*_required_</sup> | ```String``` | Fax Transmission Status Code | |
|
12
11
|
| `sent_at` | ```Integer``` | Fax Transmission Sent Timestamp | |
|
13
12
|
|
data/docs/FaxSendRequest.md
CHANGED
@@ -6,13 +6,13 @@
|
|
6
6
|
|
7
7
|
| Name | Type | Description | Notes |
|
8
8
|
| ---- | ---- | ----------- | ----- |
|
9
|
-
| `recipient`<sup>*_required_</sup> | ```String``` |
|
9
|
+
| `recipient`<sup>*_required_</sup> | ```String``` | Recipient of the fax Can be a phone number in E.164 format or email address | |
|
10
10
|
| `sender` | ```String``` | Fax Send From Sender (used only with fax number) | |
|
11
|
-
| `files` | ```Array<File>``` |
|
12
|
-
| `file_urls` | ```Array<String>``` | Fax
|
11
|
+
| `files` | ```Array<File>``` | Use `files[]` to indicate the uploaded file(s) to fax<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
|
12
|
+
| `file_urls` | ```Array<String>``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
|
13
13
|
| `test_mode` | ```Boolean``` | API Test Mode Setting | [default to false] |
|
14
|
-
| `cover_page_to` | ```String``` | Fax
|
15
|
-
| `cover_page_from` | ```String``` | Fax
|
14
|
+
| `cover_page_to` | ```String``` | Fax cover page recipient information | |
|
15
|
+
| `cover_page_from` | ```String``` | Fax cover page sender information | |
|
16
16
|
| `cover_page_message` | ```String``` | Fax Cover Page Message | |
|
17
17
|
| `title` | ```String``` | Fax Title | |
|
18
18
|
|
data/docs/OAuthApi.md
CHANGED
@@ -19,21 +19,27 @@ Once you have retrieved the code from the user callback, you will need to exchan
|
|
19
19
|
### Examples
|
20
20
|
|
21
21
|
```ruby
|
22
|
+
require "json"
|
22
23
|
require "dropbox-sign"
|
23
24
|
|
24
|
-
|
25
|
+
Dropbox::Sign.configure do |config|
|
26
|
+
end
|
25
27
|
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
28
|
+
o_auth_token_generate_request = Dropbox::Sign::OAuthTokenGenerateRequest.new
|
29
|
+
o_auth_token_generate_request.client_id = "cc91c61d00f8bb2ece1428035716b"
|
30
|
+
o_auth_token_generate_request.client_secret = "1d14434088507ffa390e6f5528465"
|
31
|
+
o_auth_token_generate_request.code = "1b0d28d90c86c141"
|
32
|
+
o_auth_token_generate_request.state = "900e06e2"
|
33
|
+
o_auth_token_generate_request.grant_type = "authorization_code"
|
31
34
|
|
32
35
|
begin
|
33
|
-
|
34
|
-
|
36
|
+
response = Dropbox::Sign::OAuthApi.new.oauth_token_generate(
|
37
|
+
o_auth_token_generate_request,
|
38
|
+
)
|
39
|
+
|
40
|
+
p response
|
35
41
|
rescue Dropbox::Sign::ApiError => e
|
36
|
-
puts "Exception when calling
|
42
|
+
puts "Exception when calling OAuthApi#oauth_token_generate: #{e}"
|
37
43
|
end
|
38
44
|
|
39
45
|
```
|
@@ -87,18 +93,24 @@ Access tokens are only valid for a given period of time (typically one hour) for
|
|
87
93
|
### Examples
|
88
94
|
|
89
95
|
```ruby
|
96
|
+
require "json"
|
90
97
|
require "dropbox-sign"
|
91
98
|
|
92
|
-
|
99
|
+
Dropbox::Sign.configure do |config|
|
100
|
+
end
|
93
101
|
|
94
|
-
|
95
|
-
|
102
|
+
o_auth_token_refresh_request = Dropbox::Sign::OAuthTokenRefreshRequest.new
|
103
|
+
o_auth_token_refresh_request.grant_type = "refresh_token"
|
104
|
+
o_auth_token_refresh_request.refresh_token = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"
|
96
105
|
|
97
106
|
begin
|
98
|
-
|
99
|
-
|
107
|
+
response = Dropbox::Sign::OAuthApi.new.oauth_token_refresh(
|
108
|
+
o_auth_token_refresh_request,
|
109
|
+
)
|
110
|
+
|
111
|
+
p response
|
100
112
|
rescue Dropbox::Sign::ApiError => e
|
101
|
-
puts "Exception when calling
|
113
|
+
puts "Exception when calling OAuthApi#oauth_token_refresh: #{e}"
|
102
114
|
end
|
103
115
|
|
104
116
|
```
|