docusign_esign 3.18.0 → 3.20.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/lib/docusign_esign/api/accounts_api.rb +64 -64
- data/lib/docusign_esign/api/billing_api.rb +2 -2
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +22 -22
- data/lib/docusign_esign/api/connect_api.rb +148 -0
- data/lib/docusign_esign/api/email_archive_api.rb +8 -8
- data/lib/docusign_esign/api/envelopes_api.rb +1226 -104
- data/lib/docusign_esign/api/notary_api.rb +16 -16
- data/lib/docusign_esign/api/power_forms_api.rb +16 -16
- data/lib/docusign_esign/api/templates_api.rb +20 -20
- data/lib/docusign_esign/api/users_api.rb +14 -14
- data/lib/docusign_esign/api/workspaces_api.rb +4 -4
- data/lib/docusign_esign/client/api_client.rb +1 -1
- data/lib/docusign_esign/models/access_code_format.rb +6 -0
- data/lib/docusign_esign/models/account_billing_plan.rb +1 -0
- data/lib/docusign_esign/models/account_billing_plan_response.rb +9 -0
- data/lib/docusign_esign/models/account_identity_verification_step.rb +1 -0
- data/lib/docusign_esign/models/account_identity_verification_workflow.rb +13 -1
- data/lib/docusign_esign/models/account_information.rb +1 -0
- data/lib/docusign_esign/models/account_notification.rb +3 -0
- data/lib/docusign_esign/models/account_password_questions_required.rb +1 -0
- data/lib/docusign_esign/models/account_password_rules.rb +7 -0
- data/lib/docusign_esign/models/account_role_settings.rb +39 -0
- data/lib/docusign_esign/models/account_settings_information.rb +748 -5
- data/lib/docusign_esign/models/account_shared_access.rb +1 -0
- data/lib/docusign_esign/models/account_signature.rb +2 -0
- data/lib/docusign_esign/models/account_signature_definition.rb +1 -0
- data/lib/docusign_esign/models/account_signature_provider.rb +1 -0
- data/lib/docusign_esign/models/account_signature_provider_option.rb +1 -0
- data/lib/docusign_esign/models/account_ui_settings.rb +35 -1
- data/lib/docusign_esign/models/address_information_input.rb +1 -0
- data/lib/docusign_esign/models/agent.rb +22 -0
- data/lib/docusign_esign/models/approve.rb +45 -0
- data/lib/docusign_esign/models/authentication_status.rb +19 -0
- data/lib/docusign_esign/models/bcc_email_archive.rb +3 -0
- data/lib/docusign_esign/models/bcc_email_archive_history.rb +2 -0
- data/lib/docusign_esign/models/bcc_email_archive_list.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_information.rb +19 -1
- data/lib/docusign_esign/models/billing_plan_preview.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_response.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_update_response.rb +1 -0
- data/lib/docusign_esign/models/brand.rb +4 -0
- data/lib/docusign_esign/models/brand_email_content.rb +1 -0
- data/lib/docusign_esign/models/brand_link.rb +1 -0
- data/lib/docusign_esign/models/brand_logos.rb +1 -0
- data/lib/docusign_esign/models/brand_request.rb +1 -0
- data/lib/docusign_esign/models/brand_resource_urls.rb +1 -0
- data/lib/docusign_esign/models/brand_resources.rb +3 -0
- data/lib/docusign_esign/models/brands_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_envelope.rb +1 -0
- data/lib/docusign_esign/models/bulk_recipients_update_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_action_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_status.rb +2 -0
- data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_summary.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_error_status.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_test_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +5 -0
- data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list_summary.rb +1 -0
- data/lib/docusign_esign/models/captive_recipient.rb +2 -0
- data/lib/docusign_esign/models/captive_recipient_information.rb +1 -0
- data/lib/docusign_esign/models/carbon_copy.rb +25 -0
- data/lib/docusign_esign/models/certified_delivery.rb +24 -0
- data/lib/docusign_esign/models/checkbox.rb +52 -39
- data/lib/docusign_esign/models/chunked_upload_part.rb +1 -0
- data/lib/docusign_esign/models/chunked_upload_request.rb +1 -0
- data/lib/docusign_esign/models/chunked_upload_response.rb +1 -0
- data/lib/docusign_esign/models/cloud_storage_provider.rb +2 -0
- data/lib/docusign_esign/models/comment_thread.rb +43 -0
- data/lib/docusign_esign/models/commission_county.rb +52 -0
- data/lib/docusign_esign/models/commission_expiration.rb +52 -0
- data/lib/docusign_esign/models/commission_number.rb +52 -0
- data/lib/docusign_esign/models/commission_state.rb +52 -0
- data/lib/docusign_esign/models/company.rb +52 -0
- data/lib/docusign_esign/models/composite_template.rb +2 -0
- data/lib/docusign_esign/models/conditional_recipient_rule.rb +2 -0
- data/lib/docusign_esign/models/connect_config_results.rb +1 -0
- data/lib/docusign_esign/models/connect_custom_configuration.rb +13 -1
- data/lib/docusign_esign/models/connect_debug_log.rb +1 -0
- data/lib/docusign_esign/models/connect_event_data.rb +1 -0
- data/lib/docusign_esign/models/connect_failure_filter.rb +1 -0
- data/lib/docusign_esign/models/connect_failure_result.rb +1 -0
- data/lib/docusign_esign/models/connect_log.rb +1 -0
- data/lib/docusign_esign/models/connect_o_auth_config.rb +224 -0
- data/lib/docusign_esign/models/connect_salesforce_field.rb +1 -0
- data/lib/docusign_esign/models/connect_salesforce_object.rb +1 -0
- data/lib/docusign_esign/models/console_view_request.rb +1 -0
- data/lib/docusign_esign/models/consumer_disclosure.rb +3 -0
- data/lib/docusign_esign/models/contact.rb +1 -0
- data/lib/docusign_esign/models/contact_get_response.rb +1 -0
- data/lib/docusign_esign/models/contact_mod_request.rb +1 -0
- data/lib/docusign_esign/models/contact_phone_number.rb +1 -0
- data/lib/docusign_esign/models/contact_update_response.rb +1 -0
- data/lib/docusign_esign/models/correct_view_request.rb +12 -1
- data/lib/docusign_esign/models/credit_card_information.rb +2 -0
- data/lib/docusign_esign/models/currency.rb +55 -0
- data/lib/docusign_esign/models/currency_feature_set_price.rb +1 -0
- data/lib/docusign_esign/models/currency_plan_price.rb +1 -0
- data/lib/docusign_esign/models/custom_field.rb +2 -0
- data/lib/docusign_esign/models/date.rb +59 -0
- data/lib/docusign_esign/models/date_signed.rb +46 -0
- data/lib/docusign_esign/models/date_stamp_properties.rb +1 -0
- data/lib/docusign_esign/models/decline.rb +46 -0
- data/lib/docusign_esign/models/delayed_routing.rb +3 -3
- data/lib/docusign_esign/models/direct_debit_processor_information.rb +1 -0
- data/lib/docusign_esign/models/doc_gen_form_field.rb +224 -0
- data/lib/docusign_esign/models/doc_gen_syntax_error.rb +204 -0
- data/lib/docusign_esign/models/document.rb +26 -1
- data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +1 -0
- data/lib/docusign_esign/models/document_html_definition.rb +1 -0
- data/lib/docusign_esign/models/document_html_definition_original.rb +1 -0
- data/lib/docusign_esign/models/document_html_display_anchor.rb +1 -0
- data/lib/docusign_esign/models/document_html_display_settings.rb +1 -0
- data/lib/docusign_esign/models/document_template.rb +1 -0
- data/lib/docusign_esign/models/document_visibility.rb +2 -0
- data/lib/docusign_esign/models/document_visibility_list.rb +1 -0
- data/lib/docusign_esign/models/downgrad_request_billing_info_response.rb +1 -0
- data/lib/docusign_esign/models/downgrade_billing_plan_information.rb +1 -0
- data/lib/docusign_esign/models/draw.rb +40 -0
- data/lib/docusign_esign/models/e_note_configuration.rb +1 -0
- data/lib/docusign_esign/models/editor.rb +23 -0
- data/lib/docusign_esign/models/email.rb +59 -0
- data/lib/docusign_esign/models/email_address.rb +46 -0
- data/lib/docusign_esign/models/envelope.rb +10 -0
- data/lib/docusign_esign/models/envelope_attachment.rb +1 -0
- data/lib/docusign_esign/models/envelope_definition.rb +13 -0
- data/lib/docusign_esign/models/envelope_delay_rule.rb +3 -2
- data/lib/docusign_esign/models/envelope_document.rb +52 -1
- data/lib/docusign_esign/models/envelope_event.rb +1 -0
- data/lib/docusign_esign/models/envelope_form_data.rb +2 -0
- data/lib/docusign_esign/models/envelope_id.rb +45 -0
- data/lib/docusign_esign/models/envelope_ids_request.rb +1 -0
- data/lib/docusign_esign/models/envelope_notification_request.rb +3 -0
- data/lib/docusign_esign/models/envelope_purge_configuration.rb +1 -0
- data/lib/docusign_esign/models/envelope_summary.rb +3 -0
- data/lib/docusign_esign/models/envelope_template.rb +23 -1
- data/lib/docusign_esign/models/envelope_template_results.rb +1 -0
- data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -0
- data/lib/docusign_esign/models/envelope_transfer_rule.rb +6 -0
- data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +4 -0
- data/lib/docusign_esign/models/envelope_update_summary.rb +4 -0
- data/lib/docusign_esign/models/envelopes_information.rb +1 -0
- data/lib/docusign_esign/models/event_notification.rb +12 -1
- data/lib/docusign_esign/models/event_result.rb +1 -0
- data/lib/docusign_esign/models/external_document_sources.rb +6 -0
- data/lib/docusign_esign/models/external_file.rb +1 -0
- data/lib/docusign_esign/models/external_folder.rb +1 -0
- data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -0
- data/lib/docusign_esign/models/favorite_templates_info.rb +1 -0
- data/lib/docusign_esign/models/feature_set.rb +1 -0
- data/lib/docusign_esign/models/filter.rb +1 -0
- data/lib/docusign_esign/models/first_name.rb +46 -0
- data/lib/docusign_esign/models/folder.rb +4 -0
- data/lib/docusign_esign/models/folder_item_response.rb +1 -0
- data/lib/docusign_esign/models/folder_item_v2.rb +2 -0
- data/lib/docusign_esign/models/folder_shared_item.rb +3 -0
- data/lib/docusign_esign/models/folders_request.rb +1 -0
- data/lib/docusign_esign/models/form_data_item.rb +1 -0
- data/lib/docusign_esign/models/formula_tab.rb +64 -0
- data/lib/docusign_esign/models/full_name.rb +46 -0
- data/lib/docusign_esign/models/group.rb +2 -0
- data/lib/docusign_esign/models/id_check_configuration.rb +1 -0
- data/lib/docusign_esign/models/id_check_information_input.rb +4 -0
- data/lib/docusign_esign/models/in_person_signer.rb +31 -0
- data/lib/docusign_esign/models/initial_here.rb +41 -1
- data/lib/docusign_esign/models/inline_template.rb +3 -0
- data/lib/docusign_esign/models/intermediary.rb +23 -0
- data/lib/docusign_esign/models/jurisdiction.rb +1 -0
- data/lib/docusign_esign/models/last_name.rb +46 -0
- data/lib/docusign_esign/models/linked_external_primary_account.rb +1 -0
- data/lib/docusign_esign/models/list.rb +54 -0
- data/lib/docusign_esign/models/list_custom_field.rb +2 -0
- data/lib/docusign_esign/models/list_item.rb +4 -0
- data/lib/docusign_esign/models/locale_policy.rb +13 -0
- data/lib/docusign_esign/models/lock_information.rb +2 -0
- data/lib/docusign_esign/models/lock_request.rb +1 -0
- data/lib/docusign_esign/models/member_group_shared_item.rb +3 -0
- data/lib/docusign_esign/models/member_shared_items.rb +3 -0
- data/lib/docusign_esign/models/merge_field.rb +6 -0
- data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -0
- data/lib/docusign_esign/models/money.rb +1 -0
- data/lib/docusign_esign/models/name_value.rb +2 -0
- data/lib/docusign_esign/models/new_account_definition.rb +20 -1
- data/lib/docusign_esign/models/new_account_summary.rb +1 -0
- data/lib/docusign_esign/models/new_user.rb +2 -0
- data/lib/docusign_esign/models/new_users_summary.rb +1 -0
- data/lib/docusign_esign/models/notarize.rb +38 -0
- data/lib/docusign_esign/models/notary.rb +1 -0
- data/lib/docusign_esign/models/notary_host.rb +20 -0
- data/lib/docusign_esign/models/notary_journal.rb +2 -0
- data/lib/docusign_esign/models/notary_jurisdiction.rb +3 -0
- data/lib/docusign_esign/models/notary_jurisdiction_list.rb +1 -0
- data/lib/docusign_esign/models/notary_recipient.rb +29 -0
- data/lib/docusign_esign/models/notary_result.rb +2 -0
- data/lib/docusign_esign/models/notary_seal.rb +39 -0
- data/lib/docusign_esign/models/note.rb +47 -0
- data/lib/docusign_esign/models/notification.rb +2 -0
- data/lib/docusign_esign/models/notification_default_settings.rb +3 -0
- data/lib/docusign_esign/models/notification_defaults.rb +2 -0
- data/lib/docusign_esign/models/number.rb +61 -0
- data/lib/docusign_esign/models/page.rb +1 -0
- data/lib/docusign_esign/models/payment_details.rb +5 -0
- data/lib/docusign_esign/models/payment_gateway_account.rb +3 -0
- data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +1 -0
- data/lib/docusign_esign/models/payment_line_item.rb +1 -0
- data/lib/docusign_esign/models/payment_method_with_options.rb +1 -0
- data/lib/docusign_esign/models/payment_processor_information.rb +1 -0
- data/lib/docusign_esign/models/permission_profile.rb +2 -0
- data/lib/docusign_esign/models/permission_profile_information.rb +1 -0
- data/lib/docusign_esign/models/phone_number.rb +52 -0
- data/lib/docusign_esign/models/poly_line_overlay.rb +40 -0
- data/lib/docusign_esign/models/power_form.rb +2 -0
- data/lib/docusign_esign/models/power_form_recipient.rb +1 -0
- data/lib/docusign_esign/models/power_form_senders_response.rb +1 -0
- data/lib/docusign_esign/models/power_forms_response.rb +1 -0
- data/lib/docusign_esign/models/prefill_tabs.rb +1 -0
- data/lib/docusign_esign/models/property_metadata.rb +1 -0
- data/lib/docusign_esign/models/radio.rb +28 -0
- data/lib/docusign_esign/models/radio_group.rb +17 -0
- data/lib/docusign_esign/models/recipient_additional_notification.rb +3 -0
- data/lib/docusign_esign/models/recipient_email_notification.rb +3 -0
- data/lib/docusign_esign/models/recipient_group.rb +1 -0
- data/lib/docusign_esign/models/recipient_identity_phone_number.rb +3 -0
- data/lib/docusign_esign/models/recipient_identity_verification.rb +2 -0
- data/lib/docusign_esign/models/recipient_names_response.rb +1 -0
- data/lib/docusign_esign/models/recipient_option.rb +1 -0
- data/lib/docusign_esign/models/recipient_phone_authentication.rb +4 -0
- data/lib/docusign_esign/models/recipient_phone_number.rb +3 -0
- data/lib/docusign_esign/models/recipient_preview_request.rb +2 -0
- data/lib/docusign_esign/models/recipient_proof_file.rb +1 -0
- data/lib/docusign_esign/models/recipient_routing.rb +2 -0
- data/lib/docusign_esign/models/recipient_signature_provider.rb +3 -0
- data/lib/docusign_esign/models/recipient_signature_provider_options.rb +5 -0
- data/lib/docusign_esign/models/recipient_sms_authentication.rb +1 -0
- data/lib/docusign_esign/models/recipient_token_client_ur_ls.rb +30 -30
- data/lib/docusign_esign/models/recipient_update_response.rb +3 -0
- data/lib/docusign_esign/models/recipient_view_request.rb +2 -0
- data/lib/docusign_esign/models/recipients.rb +1 -0
- data/lib/docusign_esign/models/recipients_update_summary.rb +1 -0
- data/lib/docusign_esign/models/return_url_request.rb +1 -0
- data/lib/docusign_esign/models/scheduled_sending.rb +3 -3
- data/lib/docusign_esign/models/seal_sign.rb +17 -0
- data/lib/docusign_esign/models/seat_discount.rb +1 -0
- data/lib/docusign_esign/models/sender_company.rb +45 -0
- data/lib/docusign_esign/models/sender_email_notifications.rb +1 -0
- data/lib/docusign_esign/models/sender_name.rb +45 -0
- data/lib/docusign_esign/models/settings_metadata.rb +1 -0
- data/lib/docusign_esign/models/shared_item.rb +3 -0
- data/lib/docusign_esign/models/sign_here.rb +42 -0
- data/lib/docusign_esign/models/signature_provider_required_option.rb +1 -0
- data/lib/docusign_esign/models/signature_type.rb +1 -0
- data/lib/docusign_esign/models/signer.rb +30 -0
- data/lib/docusign_esign/models/signer_attachment.rb +40 -0
- data/lib/docusign_esign/models/signing_group.rb +2 -0
- data/lib/docusign_esign/models/signing_group_user.rb +1 -0
- data/lib/docusign_esign/models/smart_section.rb +41 -0
- data/lib/docusign_esign/models/smart_section_display_settings.rb +2 -0
- data/lib/docusign_esign/models/social_account_information.rb +1 -0
- data/lib/docusign_esign/models/ssn.rb +59 -0
- data/lib/docusign_esign/models/stamp.rb +2 -0
- data/lib/docusign_esign/models/supported_languages.rb +1 -0
- data/lib/docusign_esign/models/tab_account_settings.rb +22 -0
- data/lib/docusign_esign/models/tab_group.rb +41 -0
- data/lib/docusign_esign/models/tab_metadata.rb +14 -1
- data/lib/docusign_esign/models/tabs.rb +2 -0
- data/lib/docusign_esign/models/template_document_visibility_list.rb +1 -0
- data/lib/docusign_esign/models/template_notification_request.rb +2 -0
- data/lib/docusign_esign/models/template_recipients.rb +1 -0
- data/lib/docusign_esign/models/template_role.rb +4 -0
- data/lib/docusign_esign/models/template_shared_item.rb +3 -0
- data/lib/docusign_esign/models/template_summary.rb +3 -0
- data/lib/docusign_esign/models/template_tabs.rb +1 -0
- data/lib/docusign_esign/models/template_update_summary.rb +4 -0
- data/lib/docusign_esign/models/text.rb +61 -0
- data/lib/docusign_esign/models/text_custom_field.rb +2 -0
- data/lib/docusign_esign/models/title.rb +52 -0
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +12 -0
- data/lib/docusign_esign/models/user_info.rb +1 -0
- data/lib/docusign_esign/models/user_information.rb +6 -0
- data/lib/docusign_esign/models/user_information_list.rb +1 -0
- data/lib/docusign_esign/models/user_password_information.rb +1 -0
- data/lib/docusign_esign/models/user_password_rules.rb +2 -0
- data/lib/docusign_esign/models/user_profile.rb +3 -0
- data/lib/docusign_esign/models/user_settings_information.rb +61 -0
- data/lib/docusign_esign/models/user_shared_item.rb +3 -0
- data/lib/docusign_esign/models/user_signature.rb +2 -0
- data/lib/docusign_esign/models/user_signature_definition.rb +1 -0
- data/lib/docusign_esign/models/view.rb +46 -0
- data/lib/docusign_esign/models/witness.rb +30 -0
- data/lib/docusign_esign/models/workflow.rb +2 -0
- data/lib/docusign_esign/models/workflow_step.rb +3 -0
- data/lib/docusign_esign/models/workspace.rb +4 -0
- data/lib/docusign_esign/models/workspace_folder_contents.rb +1 -0
- data/lib/docusign_esign/models/workspace_item.rb +5 -0
- data/lib/docusign_esign/models/workspace_settings.rb +1 -0
- data/lib/docusign_esign/models/workspace_user.rb +1 -0
- data/lib/docusign_esign/models/workspace_user_authorization.rb +2 -0
- data/lib/docusign_esign/models/zip.rb +60 -0
- data/lib/docusign_esign/version.rb +1 -1
- data/lib/docusign_esign.rb +3 -0
- metadata +9 -6
@@ -46,7 +46,7 @@ module DocuSign_eSign
|
|
46
46
|
end
|
47
47
|
|
48
48
|
# Add a notary to the system
|
49
|
-
#
|
49
|
+
# Registers the current user as a notary.
|
50
50
|
# @param notary (optional parameter)
|
51
51
|
# @return [Notary]
|
52
52
|
def create_notary(notary)
|
@@ -55,7 +55,7 @@ module DocuSign_eSign
|
|
55
55
|
end
|
56
56
|
|
57
57
|
# Add a notary to the system
|
58
|
-
#
|
58
|
+
# Registers the current user as a notary.
|
59
59
|
# @param notary (optional parameter)
|
60
60
|
# @return [Array<(Notary, Fixnum, Hash)>] Notary data, response status code and response headers
|
61
61
|
def create_notary_with_http_info(notary)
|
@@ -93,7 +93,7 @@ module DocuSign_eSign
|
|
93
93
|
end
|
94
94
|
|
95
95
|
# Add a notary jurisdiction to the system
|
96
|
-
#
|
96
|
+
# Creates a jurisdiction object.
|
97
97
|
# @param notary_jurisdiction (optional parameter)
|
98
98
|
# @return [NotaryJurisdiction]
|
99
99
|
def create_notary_jurisdictions(notary_jurisdiction)
|
@@ -102,7 +102,7 @@ module DocuSign_eSign
|
|
102
102
|
end
|
103
103
|
|
104
104
|
# Add a notary jurisdiction to the system
|
105
|
-
#
|
105
|
+
# Creates a jurisdiction object.
|
106
106
|
# @param notary_jurisdiction (optional parameter)
|
107
107
|
# @return [Array<(NotaryJurisdiction, Fixnum, Hash)>] NotaryJurisdiction data, response status code and response headers
|
108
108
|
def create_notary_jurisdictions_with_http_info(notary_jurisdiction)
|
@@ -140,7 +140,7 @@ module DocuSign_eSign
|
|
140
140
|
end
|
141
141
|
|
142
142
|
# Delete a notary jurisdiction a specified user.
|
143
|
-
#
|
143
|
+
# Deletes the specified jurisdiction.
|
144
144
|
# @param jurisdiction_id
|
145
145
|
# @return [nil]
|
146
146
|
def delete_notary_jurisdiction(jurisdiction_id)
|
@@ -149,7 +149,7 @@ module DocuSign_eSign
|
|
149
149
|
end
|
150
150
|
|
151
151
|
# Delete a notary jurisdiction a specified user.
|
152
|
-
#
|
152
|
+
# Deletes the specified jurisdiction.
|
153
153
|
# @param jurisdiction_id
|
154
154
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
155
155
|
def delete_notary_jurisdiction_with_http_info(jurisdiction_id)
|
@@ -188,7 +188,7 @@ module DocuSign_eSign
|
|
188
188
|
end
|
189
189
|
|
190
190
|
# Get notary settings for a user
|
191
|
-
#
|
191
|
+
# Gets settings for a notary user. The current user must be a notary.
|
192
192
|
# @param DocuSign_eSign::GetNotaryOptions Options for modifying the behavior of the function.
|
193
193
|
# @return [NotaryResult]
|
194
194
|
def get_notary(options = DocuSign_eSign::GetNotaryOptions.default)
|
@@ -197,7 +197,7 @@ module DocuSign_eSign
|
|
197
197
|
end
|
198
198
|
|
199
199
|
# Get notary settings for a user
|
200
|
-
#
|
200
|
+
# Gets settings for a notary user. The current user must be a notary.
|
201
201
|
# @param DocuSign_eSign::GetNotaryOptions Options for modifying the behavior of the function.
|
202
202
|
# @return [Array<(NotaryResult, Fixnum, Hash)>] NotaryResult data, response status code and response headers
|
203
203
|
def get_notary_with_http_info(options = DocuSign_eSign::GetNotaryOptions.default)
|
@@ -236,7 +236,7 @@ module DocuSign_eSign
|
|
236
236
|
end
|
237
237
|
|
238
238
|
# Get notary a jurisdiction for a user
|
239
|
-
#
|
239
|
+
# Gets a jurisdiction object for the current user. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` must be a jurisdiction that the notary is registered for.
|
240
240
|
# @param jurisdiction_id
|
241
241
|
# @return [NotaryJurisdiction]
|
242
242
|
def get_notary_jurisdiction(jurisdiction_id)
|
@@ -245,7 +245,7 @@ module DocuSign_eSign
|
|
245
245
|
end
|
246
246
|
|
247
247
|
# Get notary a jurisdiction for a user
|
248
|
-
#
|
248
|
+
# Gets a jurisdiction object for the current user. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` must be a jurisdiction that the notary is registered for.
|
249
249
|
# @param jurisdiction_id
|
250
250
|
# @return [Array<(NotaryJurisdiction, Fixnum, Hash)>] NotaryJurisdiction data, response status code and response headers
|
251
251
|
def get_notary_jurisdiction_with_http_info(jurisdiction_id)
|
@@ -333,7 +333,7 @@ module DocuSign_eSign
|
|
333
333
|
end
|
334
334
|
|
335
335
|
# Get notary jurisdictions for a user
|
336
|
-
#
|
336
|
+
# Returns a list of jurisdictions that the notary is registered in. The current user must be a notary.
|
337
337
|
# @return [NotaryJurisdictionList]
|
338
338
|
def get_notary_jurisdictions()
|
339
339
|
data, _status_code, _headers = get_notary_jurisdictions_with_http_info()
|
@@ -341,7 +341,7 @@ module DocuSign_eSign
|
|
341
341
|
end
|
342
342
|
|
343
343
|
# Get notary jurisdictions for a user
|
344
|
-
#
|
344
|
+
# Returns a list of jurisdictions that the notary is registered in. The current user must be a notary.
|
345
345
|
# @return [Array<(NotaryJurisdictionList, Fixnum, Hash)>] NotaryJurisdictionList data, response status code and response headers
|
346
346
|
def get_notary_jurisdictions_with_http_info()
|
347
347
|
if @api_client.config.debugging
|
@@ -428,7 +428,7 @@ module DocuSign_eSign
|
|
428
428
|
end
|
429
429
|
|
430
430
|
# Update a notary
|
431
|
-
#
|
431
|
+
# Updates notary information for the current user.
|
432
432
|
# @param notary (optional parameter)
|
433
433
|
# @return [Notary]
|
434
434
|
def update_notary(notary)
|
@@ -437,7 +437,7 @@ module DocuSign_eSign
|
|
437
437
|
end
|
438
438
|
|
439
439
|
# Update a notary
|
440
|
-
#
|
440
|
+
# Updates notary information for the current user.
|
441
441
|
# @param notary (optional parameter)
|
442
442
|
# @return [Array<(Notary, Fixnum, Hash)>] Notary data, response status code and response headers
|
443
443
|
def update_notary_with_http_info(notary)
|
@@ -475,7 +475,7 @@ module DocuSign_eSign
|
|
475
475
|
end
|
476
476
|
|
477
477
|
# Update a notary jurisdiction
|
478
|
-
#
|
478
|
+
# Updates the jurisdiction information about a notary. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` path parameter must be a jurisdiction that the notary is registered for. - The `jurisdictionId` path parameter must match the request body's `jurisdiction.jurisdictionId`. The request body must have a full `jurisdiction` object for the jurisdiction property. The best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change. For example, assume `getNotaryJurisdiction` returns this: ``` { \"jurisdiction\": { \"jurisdictionId\": \"15\", \"name\": \"Iowa\", \"county\": \"\", \"enabled\": \"true\", \"countyInSeal\": \"false\", \"commissionIdInSeal\": \"true\", \"stateNameInSeal\": \"true\", \"notaryPublicInSeal\": \"true\", \"allowSystemCreatedSeal\": \"true\", \"allowUserUploadedSeal\": \"false\" }, \"commissionId\": \"123456\", \"commissionExpiration\": \"2020-08-31T07:00:00.0000000Z\", \"registeredName\": \"Bob Notary\", \"county\": \"Adams\", \"sealType\": \"system_created\" } ``` If you want to change the name of the notary from \"Bob Notary\" to \"Robert Notary\", your request body would be: ``` { \"jurisdiction\": { \"jurisdictionId\": \"15\", \"name\": \"Iowa\", \"county\": \"\", \"enabled\": \"true\", \"countyInSeal\": \"false\", \"commissionIdInSeal\": \"true\", \"stateNameInSeal\": \"true\", \"notaryPublicInSeal\": \"true\", \"allowSystemCreatedSeal\": \"true\", \"allowUserUploadedSeal\": \"false\" }, \"commissionId\": \"123456\", \"commissionExpiration\": \"2020-08-31T07:00:00.0000000Z\", \"registeredName\": \"Robert Notary\", \"county\": \"Adams\", \"sealType\": \"system_created\" } ```
|
479
479
|
# @param jurisdiction_id
|
480
480
|
# @param notary_jurisdiction (optional parameter)
|
481
481
|
# @return [NotaryJurisdiction]
|
@@ -485,7 +485,7 @@ module DocuSign_eSign
|
|
485
485
|
end
|
486
486
|
|
487
487
|
# Update a notary jurisdiction
|
488
|
-
#
|
488
|
+
# Updates the jurisdiction information about a notary. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` path parameter must be a jurisdiction that the notary is registered for. - The `jurisdictionId` path parameter must match the request body's `jurisdiction.jurisdictionId`. The request body must have a full `jurisdiction` object for the jurisdiction property. The best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change. For example, assume `getNotaryJurisdiction` returns this: ``` { \"jurisdiction\": { \"jurisdictionId\": \"15\", \"name\": \"Iowa\", \"county\": \"\", \"enabled\": \"true\", \"countyInSeal\": \"false\", \"commissionIdInSeal\": \"true\", \"stateNameInSeal\": \"true\", \"notaryPublicInSeal\": \"true\", \"allowSystemCreatedSeal\": \"true\", \"allowUserUploadedSeal\": \"false\" }, \"commissionId\": \"123456\", \"commissionExpiration\": \"2020-08-31T07:00:00.0000000Z\", \"registeredName\": \"Bob Notary\", \"county\": \"Adams\", \"sealType\": \"system_created\" } ``` If you want to change the name of the notary from \"Bob Notary\" to \"Robert Notary\", your request body would be: ``` { \"jurisdiction\": { \"jurisdictionId\": \"15\", \"name\": \"Iowa\", \"county\": \"\", \"enabled\": \"true\", \"countyInSeal\": \"false\", \"commissionIdInSeal\": \"true\", \"stateNameInSeal\": \"true\", \"notaryPublicInSeal\": \"true\", \"allowSystemCreatedSeal\": \"true\", \"allowUserUploadedSeal\": \"false\" }, \"commissionId\": \"123456\", \"commissionExpiration\": \"2020-08-31T07:00:00.0000000Z\", \"registeredName\": \"Robert Notary\", \"county\": \"Adams\", \"sealType\": \"system_created\" } ```
|
489
489
|
# @param jurisdiction_id
|
490
490
|
# @param notary_jurisdiction (optional parameter)
|
491
491
|
# @return [Array<(NotaryJurisdiction, Fixnum, Hash)>] NotaryJurisdiction data, response status code and response headers
|
@@ -70,7 +70,7 @@ module DocuSign_eSign
|
|
70
70
|
end
|
71
71
|
|
72
72
|
# Creates a new PowerForm.
|
73
|
-
#
|
73
|
+
# This method creates a new PowerForm. You create a PowerForm from an existing DocuSign [template](/docs/esign-rest-api/reference/templates/templates/create/), based on the `templateId` in the request body. PowerForms that you create from a template are referred to as *web PowerForms*. **Note:** The DocuSign Admin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a *PDF PowerForm*). However, PDF PowerForms are deprecated and are not supported in the API. **Note:** A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm *initiator*.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm. ### Signing modes You can use one of the following signing modes for a PowerForm: **`email`** This mode verifies the recipient's identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document. Alternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the `activateonly` flag to the PowerForm URL and set it to true by passing in the value `1`. When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code. Example: `activateonly=1` **`direct`** This mode does not require any verification. After a recipient enters their email address on the landing page and clicks **Begin Signing,** a new browser tab opens and the recipient can immediately begin the signing process. Because the `direct` signing mode does not verify the recipient's identity by using email authentication, we strongly recommend that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check). **Note:** In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`. ### Redirect URLs You can control the URL to which signers are redirected after signing your PowerForm. However, the URL is specified elsewhere, outside of the PowerForm creation process. For details, see [How do I specify a URL to redirect to when a PowerForm is completed?](https://support.docusign.com/en/articles/How-do-I-specify-a-URL-to-redirect-to-when-a-Powerform-is-completed). ### More information For more information about creating PowerForms, see [Create a PowerForm](https://support.docusign.com/en/guides/ndse-user-guide-create-a-powerform).
|
74
74
|
# @param account_id The external account number (int) or account ID Guid.
|
75
75
|
# @param power_form (optional parameter)
|
76
76
|
# @return [PowerForm]
|
@@ -80,7 +80,7 @@ module DocuSign_eSign
|
|
80
80
|
end
|
81
81
|
|
82
82
|
# Creates a new PowerForm.
|
83
|
-
#
|
83
|
+
# This method creates a new PowerForm. You create a PowerForm from an existing DocuSign [template](/docs/esign-rest-api/reference/templates/templates/create/), based on the `templateId` in the request body. PowerForms that you create from a template are referred to as *web PowerForms*. **Note:** The DocuSign Admin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a *PDF PowerForm*). However, PDF PowerForms are deprecated and are not supported in the API. **Note:** A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm *initiator*.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm. ### Signing modes You can use one of the following signing modes for a PowerForm: **`email`** This mode verifies the recipient's identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document. Alternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the `activateonly` flag to the PowerForm URL and set it to true by passing in the value `1`. When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code. Example: `activateonly=1` **`direct`** This mode does not require any verification. After a recipient enters their email address on the landing page and clicks **Begin Signing,** a new browser tab opens and the recipient can immediately begin the signing process. Because the `direct` signing mode does not verify the recipient's identity by using email authentication, we strongly recommend that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check). **Note:** In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`. ### Redirect URLs You can control the URL to which signers are redirected after signing your PowerForm. However, the URL is specified elsewhere, outside of the PowerForm creation process. For details, see [How do I specify a URL to redirect to when a PowerForm is completed?](https://support.docusign.com/en/articles/How-do-I-specify-a-URL-to-redirect-to-when-a-Powerform-is-completed). ### More information For more information about creating PowerForms, see [Create a PowerForm](https://support.docusign.com/en/guides/ndse-user-guide-create-a-powerform).
|
84
84
|
# @param account_id The external account number (int) or account ID Guid.
|
85
85
|
# @param power_form (optional parameter)
|
86
86
|
# @return [Array<(PowerForm, Fixnum, Hash)>] PowerForm data, response status code and response headers
|
@@ -121,7 +121,7 @@ module DocuSign_eSign
|
|
121
121
|
end
|
122
122
|
|
123
123
|
# Delete a PowerForm.
|
124
|
-
#
|
124
|
+
# This method deletes a PowerForm.
|
125
125
|
# @param account_id The external account number (int) or account ID Guid.
|
126
126
|
# @param power_form_id
|
127
127
|
# @return [nil]
|
@@ -131,7 +131,7 @@ module DocuSign_eSign
|
|
131
131
|
end
|
132
132
|
|
133
133
|
# Delete a PowerForm.
|
134
|
-
#
|
134
|
+
# This method deletes a PowerForm.
|
135
135
|
# @param account_id The external account number (int) or account ID Guid.
|
136
136
|
# @param power_form_id
|
137
137
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
@@ -173,7 +173,7 @@ module DocuSign_eSign
|
|
173
173
|
end
|
174
174
|
|
175
175
|
# Deletes one or more PowerForms
|
176
|
-
#
|
176
|
+
# This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the `powerFormId`.
|
177
177
|
# @param account_id The external account number (int) or account ID Guid.
|
178
178
|
# @param power_forms_request (optional parameter)
|
179
179
|
# @return [PowerFormsResponse]
|
@@ -183,7 +183,7 @@ module DocuSign_eSign
|
|
183
183
|
end
|
184
184
|
|
185
185
|
# Deletes one or more PowerForms
|
186
|
-
#
|
186
|
+
# This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the `powerFormId`.
|
187
187
|
# @param account_id The external account number (int) or account ID Guid.
|
188
188
|
# @param power_forms_request (optional parameter)
|
189
189
|
# @return [Array<(PowerFormsResponse, Fixnum, Hash)>] PowerFormsResponse data, response status code and response headers
|
@@ -224,7 +224,7 @@ module DocuSign_eSign
|
|
224
224
|
end
|
225
225
|
|
226
226
|
# Returns a single PowerForm.
|
227
|
-
#
|
227
|
+
# This method returns detailed information about a specific PowerForm.
|
228
228
|
# @param account_id The external account number (int) or account ID Guid.
|
229
229
|
# @param power_form_id
|
230
230
|
# @return [PowerForm]
|
@@ -234,7 +234,7 @@ module DocuSign_eSign
|
|
234
234
|
end
|
235
235
|
|
236
236
|
# Returns a single PowerForm.
|
237
|
-
#
|
237
|
+
# This method returns detailed information about a specific PowerForm.
|
238
238
|
# @param account_id The external account number (int) or account ID Guid.
|
239
239
|
# @param power_form_id
|
240
240
|
# @return [Array<(PowerForm, Fixnum, Hash)>] PowerForm data, response status code and response headers
|
@@ -277,7 +277,7 @@ module DocuSign_eSign
|
|
277
277
|
end
|
278
278
|
|
279
279
|
# Returns the form data associated with the usage of a PowerForm.
|
280
|
-
#
|
280
|
+
# This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm. You specify the format in which you want to retrieve the data in the `Accept` header. This header accepts the following values: - `application/json`: JSON format - `application/xml`: XML format - `text/csv`: Comma-separated value (CSV) format **Note:** Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.
|
281
281
|
# @param account_id The external account number (int) or account ID Guid.
|
282
282
|
# @param power_form_id
|
283
283
|
# @param DocuSign_eSign::GetPowerFormDataOptions Options for modifying the behavior of the function.
|
@@ -288,7 +288,7 @@ module DocuSign_eSign
|
|
288
288
|
end
|
289
289
|
|
290
290
|
# Returns the form data associated with the usage of a PowerForm.
|
291
|
-
#
|
291
|
+
# This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm. You specify the format in which you want to retrieve the data in the `Accept` header. This header accepts the following values: - `application/json`: JSON format - `application/xml`: XML format - `text/csv`: Comma-separated value (CSV) format **Note:** Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.
|
292
292
|
# @param account_id The external account number (int) or account ID Guid.
|
293
293
|
# @param power_form_id
|
294
294
|
# @param DocuSign_eSign::GetPowerFormDataOptions Options for modifying the behavior of the function.
|
@@ -335,7 +335,7 @@ module DocuSign_eSign
|
|
335
335
|
end
|
336
336
|
|
337
337
|
# Returns the list of PowerForms available to the user.
|
338
|
-
#
|
338
|
+
# This method returns a list of users who have sent PowerForms.
|
339
339
|
# @param account_id The external account number (int) or account ID Guid.
|
340
340
|
# @param DocuSign_eSign::ListPowerFormSendersOptions Options for modifying the behavior of the function.
|
341
341
|
# @return [PowerFormSendersResponse]
|
@@ -345,7 +345,7 @@ module DocuSign_eSign
|
|
345
345
|
end
|
346
346
|
|
347
347
|
# Returns the list of PowerForms available to the user.
|
348
|
-
#
|
348
|
+
# This method returns a list of users who have sent PowerForms.
|
349
349
|
# @param account_id The external account number (int) or account ID Guid.
|
350
350
|
# @param DocuSign_eSign::ListPowerFormSendersOptions Options for modifying the behavior of the function.
|
351
351
|
# @return [Array<(PowerFormSendersResponse, Fixnum, Hash)>] PowerFormSendersResponse data, response status code and response headers
|
@@ -387,7 +387,7 @@ module DocuSign_eSign
|
|
387
387
|
end
|
388
388
|
|
389
389
|
# Returns the list of PowerForms available to the user.
|
390
|
-
#
|
390
|
+
# This method returns a list of PowerForms that are available to the user.
|
391
391
|
# @param account_id The external account number (int) or account ID Guid.
|
392
392
|
# @param DocuSign_eSign::ListPowerFormsOptions Options for modifying the behavior of the function.
|
393
393
|
# @return [PowerFormsResponse]
|
@@ -397,7 +397,7 @@ module DocuSign_eSign
|
|
397
397
|
end
|
398
398
|
|
399
399
|
# Returns the list of PowerForms available to the user.
|
400
|
-
#
|
400
|
+
# This method returns a list of PowerForms that are available to the user.
|
401
401
|
# @param account_id The external account number (int) or account ID Guid.
|
402
402
|
# @param DocuSign_eSign::ListPowerFormsOptions Options for modifying the behavior of the function.
|
403
403
|
# @return [Array<(PowerFormsResponse, Fixnum, Hash)>] PowerFormsResponse data, response status code and response headers
|
@@ -444,7 +444,7 @@ module DocuSign_eSign
|
|
444
444
|
end
|
445
445
|
|
446
446
|
# Creates a new PowerForm.
|
447
|
-
#
|
447
|
+
# This method updates an existing PowerForm.
|
448
448
|
# @param account_id The external account number (int) or account ID Guid.
|
449
449
|
# @param power_form_id
|
450
450
|
# @param power_form (optional parameter)
|
@@ -455,7 +455,7 @@ module DocuSign_eSign
|
|
455
455
|
end
|
456
456
|
|
457
457
|
# Creates a new PowerForm.
|
458
|
-
#
|
458
|
+
# This method updates an existing PowerForm.
|
459
459
|
# @param account_id The external account number (int) or account ID Guid.
|
460
460
|
# @param power_form_id
|
461
461
|
# @param power_form (optional parameter)
|
@@ -361,7 +361,7 @@ module DocuSign_eSign
|
|
361
361
|
end
|
362
362
|
|
363
363
|
# Provides a URL to start an edit view of the Template UI
|
364
|
-
#
|
364
|
+
# This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.
|
365
365
|
# @param account_id The external account number (int) or account ID Guid.
|
366
366
|
# @param template_id The ID of the template being accessed.
|
367
367
|
# @param return_url_request (optional parameter)
|
@@ -372,7 +372,7 @@ module DocuSign_eSign
|
|
372
372
|
end
|
373
373
|
|
374
374
|
# Provides a URL to start an edit view of the Template UI
|
375
|
-
#
|
375
|
+
# This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI.
|
376
376
|
# @param account_id The external account number (int) or account ID Guid.
|
377
377
|
# @param template_id The ID of the template being accessed.
|
378
378
|
# @param return_url_request (optional parameter)
|
@@ -639,7 +639,7 @@ module DocuSign_eSign
|
|
639
639
|
end
|
640
640
|
|
641
641
|
# Post Responsive HTML Preview for a document in a template.
|
642
|
-
#
|
642
|
+
# Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.
|
643
643
|
# @param account_id The external account number (int) or account ID Guid.
|
644
644
|
# @param document_id The ID of the document being accessed.
|
645
645
|
# @param template_id The ID of the template being accessed.
|
@@ -651,7 +651,7 @@ module DocuSign_eSign
|
|
651
651
|
end
|
652
652
|
|
653
653
|
# Post Responsive HTML Preview for a document in a template.
|
654
|
-
#
|
654
|
+
# Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.
|
655
655
|
# @param account_id The external account number (int) or account ID Guid.
|
656
656
|
# @param document_id The ID of the document being accessed.
|
657
657
|
# @param template_id The ID of the template being accessed.
|
@@ -698,7 +698,7 @@ module DocuSign_eSign
|
|
698
698
|
end
|
699
699
|
|
700
700
|
# Adds the tabs to a tempate
|
701
|
-
#
|
701
|
+
# Adds tabs to the document specified by `documentId` in the template specified by `templateId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text [prefill tab](/docs/esign-rest-api/reference/templates/templatedocumenttabs/create/#definition__templatetabs_prefilltabs), your request body might look like this: ``` { \"prefillTabs\": { \"textTabs\": [ { \"value\": \"a prefill text tab\", \"pageNumber\": \"1\", \"documentId\": \"1\", \"xPosition\": 316, \"yPosition\": 97 } ] } } ```
|
702
702
|
# @param account_id The external account number (int) or account ID Guid.
|
703
703
|
# @param document_id The ID of the document being accessed.
|
704
704
|
# @param template_id The ID of the template being accessed.
|
@@ -710,7 +710,7 @@ module DocuSign_eSign
|
|
710
710
|
end
|
711
711
|
|
712
712
|
# Adds the tabs to a tempate
|
713
|
-
#
|
713
|
+
# Adds tabs to the document specified by `documentId` in the template specified by `templateId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text [prefill tab](/docs/esign-rest-api/reference/templates/templatedocumenttabs/create/#definition__templatetabs_prefilltabs), your request body might look like this: ``` { \"prefillTabs\": { \"textTabs\": [ { \"value\": \"a prefill text tab\", \"pageNumber\": \"1\", \"documentId\": \"1\", \"xPosition\": 316, \"yPosition\": 97 } ] } } ```
|
714
714
|
# @param account_id The external account number (int) or account ID Guid.
|
715
715
|
# @param document_id The ID of the document being accessed.
|
716
716
|
# @param template_id The ID of the template being accessed.
|
@@ -757,7 +757,7 @@ module DocuSign_eSign
|
|
757
757
|
end
|
758
758
|
|
759
759
|
# Provides a URL to start a recipient view of the Envelope UI
|
760
|
-
#
|
760
|
+
# This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see [Preview and Send](https://support.docusign.com/en/guides/ndse-user-guide-send-your-documents).
|
761
761
|
# @param account_id The external account number (int) or account ID Guid.
|
762
762
|
# @param template_id The ID of the template being accessed.
|
763
763
|
# @param recipient_preview_request (optional parameter)
|
@@ -768,7 +768,7 @@ module DocuSign_eSign
|
|
768
768
|
end
|
769
769
|
|
770
770
|
# Provides a URL to start a recipient view of the Envelope UI
|
771
|
-
#
|
771
|
+
# This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see [Preview and Send](https://support.docusign.com/en/guides/ndse-user-guide-send-your-documents).
|
772
772
|
# @param account_id The external account number (int) or account ID Guid.
|
773
773
|
# @param template_id The ID of the template being accessed.
|
774
774
|
# @param recipient_preview_request (optional parameter)
|
@@ -812,7 +812,7 @@ module DocuSign_eSign
|
|
812
812
|
end
|
813
813
|
|
814
814
|
# Get Responsive HTML Preview for all documents in a template.
|
815
|
-
#
|
815
|
+
# Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.
|
816
816
|
# @param account_id The external account number (int) or account ID Guid.
|
817
817
|
# @param template_id The ID of the template being accessed.
|
818
818
|
# @param document_html_definition (optional parameter)
|
@@ -823,7 +823,7 @@ module DocuSign_eSign
|
|
823
823
|
end
|
824
824
|
|
825
825
|
# Get Responsive HTML Preview for all documents in a template.
|
826
|
-
#
|
826
|
+
# Creates a preview of the [responsive](/docs/esign-rest-api/esign101/concepts/responsive/), HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.
|
827
827
|
# @param account_id The external account number (int) or account ID Guid.
|
828
828
|
# @param template_id The ID of the template being accessed.
|
829
829
|
# @param document_html_definition (optional parameter)
|
@@ -1442,7 +1442,7 @@ module DocuSign_eSign
|
|
1442
1442
|
end
|
1443
1443
|
|
1444
1444
|
# Deletes tabs from an envelope document
|
1445
|
-
#
|
1445
|
+
# Deletes tabs from the document specified by `documentId` in the template specified by `templateId`.
|
1446
1446
|
# @param account_id The external account number (int) or account ID Guid.
|
1447
1447
|
# @param document_id The ID of the document being accessed.
|
1448
1448
|
# @param template_id The ID of the template being accessed.
|
@@ -1454,7 +1454,7 @@ module DocuSign_eSign
|
|
1454
1454
|
end
|
1455
1455
|
|
1456
1456
|
# Deletes tabs from an envelope document
|
1457
|
-
#
|
1457
|
+
# Deletes tabs from the document specified by `documentId` in the template specified by `templateId`.
|
1458
1458
|
# @param account_id The external account number (int) or account ID Guid.
|
1459
1459
|
# @param document_id The ID of the document being accessed.
|
1460
1460
|
# @param template_id The ID of the template being accessed.
|
@@ -1685,7 +1685,7 @@ module DocuSign_eSign
|
|
1685
1685
|
end
|
1686
1686
|
|
1687
1687
|
# Returns tabs on the document.
|
1688
|
-
#
|
1688
|
+
# Returns the tabs on the document specified by `documentId` in the template specified by `templateId`.
|
1689
1689
|
# @param account_id The external account number (int) or account ID Guid.
|
1690
1690
|
# @param document_id The ID of the document being accessed.
|
1691
1691
|
# @param template_id The ID of the template being accessed.
|
@@ -1697,7 +1697,7 @@ module DocuSign_eSign
|
|
1697
1697
|
end
|
1698
1698
|
|
1699
1699
|
# Returns tabs on the document.
|
1700
|
-
#
|
1700
|
+
# Returns the tabs on the document specified by `documentId` in the template specified by `templateId`.
|
1701
1701
|
# @param account_id The external account number (int) or account ID Guid.
|
1702
1702
|
# @param document_id The ID of the document being accessed.
|
1703
1703
|
# @param template_id The ID of the template being accessed.
|
@@ -1851,7 +1851,7 @@ module DocuSign_eSign
|
|
1851
1851
|
end
|
1852
1852
|
|
1853
1853
|
# Returns tabs on the specified page.
|
1854
|
-
#
|
1854
|
+
# Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the template specified by `templateId`.
|
1855
1855
|
# @param account_id The external account number (int) or account ID Guid.
|
1856
1856
|
# @param document_id The ID of the document being accessed.
|
1857
1857
|
# @param page_number The page number being accessed.
|
@@ -1863,7 +1863,7 @@ module DocuSign_eSign
|
|
1863
1863
|
end
|
1864
1864
|
|
1865
1865
|
# Returns tabs on the specified page.
|
1866
|
-
#
|
1866
|
+
# Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the template specified by `templateId`.
|
1867
1867
|
# @param account_id The external account number (int) or account ID Guid.
|
1868
1868
|
# @param document_id The ID of the document being accessed.
|
1869
1869
|
# @param page_number The page number being accessed.
|
@@ -1912,7 +1912,7 @@ module DocuSign_eSign
|
|
1912
1912
|
end
|
1913
1913
|
|
1914
1914
|
# Returns document page image(s) based on input.
|
1915
|
-
#
|
1915
|
+
# Returns images of the pages in a template document for display based on the parameters that you specify.
|
1916
1916
|
# @param account_id The external account number (int) or account ID Guid.
|
1917
1917
|
# @param document_id The ID of the document being accessed.
|
1918
1918
|
# @param template_id The ID of the template being accessed.
|
@@ -1924,7 +1924,7 @@ module DocuSign_eSign
|
|
1924
1924
|
end
|
1925
1925
|
|
1926
1926
|
# Returns document page image(s) based on input.
|
1927
|
-
#
|
1927
|
+
# Returns images of the pages in a template document for display based on the parameters that you specify.
|
1928
1928
|
# @param account_id The external account number (int) or account ID Guid.
|
1929
1929
|
# @param document_id The ID of the document being accessed.
|
1930
1930
|
# @param template_id The ID of the template being accessed.
|
@@ -3142,7 +3142,7 @@ module DocuSign_eSign
|
|
3142
3142
|
end
|
3143
3143
|
|
3144
3144
|
# Updates the tabs for a template
|
3145
|
-
#
|
3145
|
+
# Updates tabs in the document specified by `documentId` in the template specified by `templateId`.
|
3146
3146
|
# @param account_id The external account number (int) or account ID Guid.
|
3147
3147
|
# @param document_id The ID of the document being accessed.
|
3148
3148
|
# @param template_id The ID of the template being accessed.
|
@@ -3154,7 +3154,7 @@ module DocuSign_eSign
|
|
3154
3154
|
end
|
3155
3155
|
|
3156
3156
|
# Updates the tabs for a template
|
3157
|
-
#
|
3157
|
+
# Updates tabs in the document specified by `documentId` in the template specified by `templateId`.
|
3158
3158
|
# @param account_id The external account number (int) or account ID Guid.
|
3159
3159
|
# @param document_id The ID of the document being accessed.
|
3160
3160
|
# @param template_id The ID of the template being accessed.
|
@@ -329,7 +329,7 @@ module DocuSign_eSign
|
|
329
329
|
end
|
330
330
|
|
331
331
|
# Replaces a particular contact associated with an account for the DocuSign service.
|
332
|
-
#
|
332
|
+
# This method deletes a contact associated with an account.
|
333
333
|
# @param account_id The external account number (int) or account ID Guid.
|
334
334
|
# @param contact_id The unique identifier of a person in the contacts address book.
|
335
335
|
# @return [ContactUpdateResponse]
|
@@ -339,7 +339,7 @@ module DocuSign_eSign
|
|
339
339
|
end
|
340
340
|
|
341
341
|
# Replaces a particular contact associated with an account for the DocuSign service.
|
342
|
-
#
|
342
|
+
# This method deletes a contact associated with an account.
|
343
343
|
# @param account_id The external account number (int) or account ID Guid.
|
344
344
|
# @param contact_id The unique identifier of a person in the contacts address book.
|
345
345
|
# @return [Array<(ContactUpdateResponse, Fixnum, Hash)>] ContactUpdateResponse data, response status code and response headers
|
@@ -382,7 +382,7 @@ module DocuSign_eSign
|
|
382
382
|
end
|
383
383
|
|
384
384
|
# Delete contacts associated with an account for the DocuSign service.
|
385
|
-
#
|
385
|
+
# This method deletes multiple contacts associated with an account.
|
386
386
|
# @param account_id The external account number (int) or account ID Guid.
|
387
387
|
# @param contact_mod_request (optional parameter)
|
388
388
|
# @return [ContactUpdateResponse]
|
@@ -392,7 +392,7 @@ module DocuSign_eSign
|
|
392
392
|
end
|
393
393
|
|
394
394
|
# Delete contacts associated with an account for the DocuSign service.
|
395
|
-
#
|
395
|
+
# This method deletes multiple contacts associated with an account.
|
396
396
|
# @param account_id The external account number (int) or account ID Guid.
|
397
397
|
# @param contact_mod_request (optional parameter)
|
398
398
|
# @return [Array<(ContactUpdateResponse, Fixnum, Hash)>] ContactUpdateResponse data, response status code and response headers
|
@@ -657,7 +657,7 @@ module DocuSign_eSign
|
|
657
657
|
end
|
658
658
|
|
659
659
|
# Gets a particular contact associated with the user's account.
|
660
|
-
#
|
660
|
+
# This method returns one or more contacts associated with a DocuSign account. You can also retrieve contacts from connected [cloud storage][CloudStorage] providers by using the `cloud_provider` query parameter. By default, contacts are retrieved from the DocuSign account's default address book. To return a specific contact, use the `contactId` query parameter. To return all contacts associated with an account, omit this parameter. [CloudStorage]: /docs/esign-rest-api/reference/cloudstorage/
|
661
661
|
# @param account_id The external account number (int) or account ID Guid.
|
662
662
|
# @param contact_id The unique identifier of a person in the contacts address book.
|
663
663
|
# @param DocuSign_eSign::GetContactByIdOptions Options for modifying the behavior of the function.
|
@@ -668,7 +668,7 @@ module DocuSign_eSign
|
|
668
668
|
end
|
669
669
|
|
670
670
|
# Gets a particular contact associated with the user's account.
|
671
|
-
#
|
671
|
+
# This method returns one or more contacts associated with a DocuSign account. You can also retrieve contacts from connected [cloud storage][CloudStorage] providers by using the `cloud_provider` query parameter. By default, contacts are retrieved from the DocuSign account's default address book. To return a specific contact, use the `contactId` query parameter. To return all contacts associated with an account, omit this parameter. [CloudStorage]: /docs/esign-rest-api/reference/cloudstorage/
|
672
672
|
# @param account_id The external account number (int) or account ID Guid.
|
673
673
|
# @param contact_id The unique identifier of a person in the contacts address book.
|
674
674
|
# @param DocuSign_eSign::GetContactByIdOptions Options for modifying the behavior of the function.
|
@@ -1226,7 +1226,7 @@ module DocuSign_eSign
|
|
1226
1226
|
end
|
1227
1227
|
|
1228
1228
|
# Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).
|
1229
|
-
#
|
1229
|
+
# This method adds multiple contacts into a contacts list.
|
1230
1230
|
# @param account_id The external account number (int) or account ID Guid.
|
1231
1231
|
# @param contact_mod_request (optional parameter)
|
1232
1232
|
# @return [ContactUpdateResponse]
|
@@ -1236,7 +1236,7 @@ module DocuSign_eSign
|
|
1236
1236
|
end
|
1237
1237
|
|
1238
1238
|
# Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).
|
1239
|
-
#
|
1239
|
+
# This method adds multiple contacts into a contacts list.
|
1240
1240
|
# @param account_id The external account number (int) or account ID Guid.
|
1241
1241
|
# @param contact_mod_request (optional parameter)
|
1242
1242
|
# @return [Array<(ContactUpdateResponse, Fixnum, Hash)>] ContactUpdateResponse data, response status code and response headers
|
@@ -1277,7 +1277,7 @@ module DocuSign_eSign
|
|
1277
1277
|
end
|
1278
1278
|
|
1279
1279
|
# Replaces contacts associated with an account for the DocuSign service.
|
1280
|
-
#
|
1280
|
+
# This method updates one or more contacts associated with an account.
|
1281
1281
|
# @param account_id The external account number (int) or account ID Guid.
|
1282
1282
|
# @param contact_mod_request (optional parameter)
|
1283
1283
|
# @return [ContactUpdateResponse]
|
@@ -1287,7 +1287,7 @@ module DocuSign_eSign
|
|
1287
1287
|
end
|
1288
1288
|
|
1289
1289
|
# Replaces contacts associated with an account for the DocuSign service.
|
1290
|
-
#
|
1290
|
+
# This method updates one or more contacts associated with an account.
|
1291
1291
|
# @param account_id The external account number (int) or account ID Guid.
|
1292
1292
|
# @param contact_mod_request (optional parameter)
|
1293
1293
|
# @return [Array<(ContactUpdateResponse, Fixnum, Hash)>] ContactUpdateResponse data, response status code and response headers
|
@@ -1731,7 +1731,7 @@ module DocuSign_eSign
|
|
1731
1731
|
end
|
1732
1732
|
|
1733
1733
|
# Updates the specified user information.
|
1734
|
-
#
|
1734
|
+
# To update user information for a specific user, submit a [Users](#Users) object with updated field values in the request body of this operation.
|
1735
1735
|
# @param account_id The external account number (int) or account ID Guid.
|
1736
1736
|
# @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
|
1737
1737
|
# @param user_information (optional parameter)
|
@@ -1743,7 +1743,7 @@ module DocuSign_eSign
|
|
1743
1743
|
end
|
1744
1744
|
|
1745
1745
|
# Updates the specified user information.
|
1746
|
-
#
|
1746
|
+
# To update user information for a specific user, submit a [Users](#Users) object with updated field values in the request body of this operation.
|
1747
1747
|
# @param account_id The external account number (int) or account ID Guid.
|
1748
1748
|
# @param user_id The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
|
1749
1749
|
# @param user_information (optional parameter)
|
@@ -1789,7 +1789,7 @@ module DocuSign_eSign
|
|
1789
1789
|
end
|
1790
1790
|
|
1791
1791
|
# Change one or more user in the specified account.
|
1792
|
-
#
|
1792
|
+
# This method updates the information about one or more account users.
|
1793
1793
|
# @param account_id The external account number (int) or account ID Guid.
|
1794
1794
|
# @param user_information_list (optional parameter)
|
1795
1795
|
# @param DocuSign_eSign::UpdateUsersOptions Options for modifying the behavior of the function.
|
@@ -1800,7 +1800,7 @@ module DocuSign_eSign
|
|
1800
1800
|
end
|
1801
1801
|
|
1802
1802
|
# Change one or more user in the specified account.
|
1803
|
-
#
|
1803
|
+
# This method updates the information about one or more account users.
|
1804
1804
|
# @param account_id The external account number (int) or account ID Guid.
|
1805
1805
|
# @param user_information_list (optional parameter)
|
1806
1806
|
# @param DocuSign_eSign::UpdateUsersOptions Options for modifying the behavior of the function.
|
@@ -133,7 +133,7 @@ module DocuSign_eSign
|
|
133
133
|
end
|
134
134
|
|
135
135
|
# Creates a workspace file.
|
136
|
-
#
|
136
|
+
# This method adds a file to a workspace.
|
137
137
|
# @param account_id The external account number (int) or account ID Guid.
|
138
138
|
# @param folder_id The ID of the folder being accessed.
|
139
139
|
# @param workspace_id Specifies the workspace ID GUID.
|
@@ -144,7 +144,7 @@ module DocuSign_eSign
|
|
144
144
|
end
|
145
145
|
|
146
146
|
# Creates a workspace file.
|
147
|
-
#
|
147
|
+
# This method adds a file to a workspace.
|
148
148
|
# @param account_id The external account number (int) or account ID Guid.
|
149
149
|
# @param folder_id The ID of the folder being accessed.
|
150
150
|
# @param workspace_id Specifies the workspace ID GUID.
|
@@ -243,7 +243,7 @@ module DocuSign_eSign
|
|
243
243
|
end
|
244
244
|
|
245
245
|
# Deletes workspace one or more specific files/folders from the given folder or root.
|
246
|
-
#
|
246
|
+
# This method deletes one or more files or sub-folders from a workspace folder or root. Note: To delete items from a workspace, the `status` of the workspace must be `active`.
|
247
247
|
# @param account_id The external account number (int) or account ID Guid.
|
248
248
|
# @param folder_id The ID of the folder being accessed.
|
249
249
|
# @param workspace_id Specifies the workspace ID GUID.
|
@@ -255,7 +255,7 @@ module DocuSign_eSign
|
|
255
255
|
end
|
256
256
|
|
257
257
|
# Deletes workspace one or more specific files/folders from the given folder or root.
|
258
|
-
#
|
258
|
+
# This method deletes one or more files or sub-folders from a workspace folder or root. Note: To delete items from a workspace, the `status` of the workspace must be `active`.
|
259
259
|
# @param account_id The external account number (int) or account ID Guid.
|
260
260
|
# @param folder_id The ID of the folder being accessed.
|
261
261
|
# @param workspace_id Specifies the workspace ID GUID.
|
@@ -35,7 +35,7 @@ module DocuSign_eSign
|
|
35
35
|
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
36
36
|
def initialize(config = Configuration.default)
|
37
37
|
@config = config
|
38
|
-
@user_agent = "Swagger-Codegen/3.
|
38
|
+
@user_agent = "Swagger-Codegen/3.20.0/ruby"
|
39
39
|
@default_headers = {
|
40
40
|
'Content-Type' => "application/json",
|
41
41
|
'User-Agent' => @user_agent
|