docusign_esign 3.18.0 → 3.19.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 +5 -0
- data/lib/docusign_esign/api/accounts_api.rb +60 -60
- 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 +1223 -105
- 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 +2 -0
- 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 +537 -3
- 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 +15 -0
- 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 +2 -0
- 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 +214 -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/direct_debit_processor_information.rb +1 -0
- data/lib/docusign_esign/models/document.rb +3 -0
- 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_document.rb +7 -0
- 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 +12 -0
- 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 +1 -0
- 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 +40 -0
- 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/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 +1 -0
- metadata +7 -6
@@ -12,10 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# Contains information about an in-person recipient. This is a DocuSign user, acting as a Signing Host, who is in the same physical location as the signer. To learn about the fields used for the eNotary feature, see the [recipients resource][resource]. [resource]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#in-person-signer-recipient
|
15
16
|
class InPersonSigner
|
16
17
|
# If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
|
17
18
|
attr_accessor :access_code
|
18
19
|
|
20
|
+
# Metadata that indicates whether the `accessCode` property is editable. This property is read-only.
|
19
21
|
attr_accessor :access_code_metadata
|
20
22
|
|
21
23
|
# This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
|
@@ -60,6 +62,7 @@ module DocuSign_eSign
|
|
60
62
|
# Reserved: For DocuSign use only.
|
61
63
|
attr_accessor :delivery_method
|
62
64
|
|
65
|
+
# Reserved for DocuSign.
|
63
66
|
attr_accessor :delivery_method_metadata
|
64
67
|
|
65
68
|
#
|
@@ -74,13 +77,16 @@ module DocuSign_eSign
|
|
74
77
|
#
|
75
78
|
attr_accessor :email
|
76
79
|
|
80
|
+
# Metadata that indicates whether the `email` property is editable. This property is read-only.
|
77
81
|
attr_accessor :email_metadata
|
78
82
|
|
83
|
+
# An optional complex type that sets a specific email subject and body for this recipient's notification email. **Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`.
|
79
84
|
attr_accessor :email_notification
|
80
85
|
|
81
86
|
# Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
|
82
87
|
attr_accessor :embedded_recipient_start_url
|
83
88
|
|
89
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
84
90
|
attr_accessor :error_details
|
85
91
|
|
86
92
|
# Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.
|
@@ -89,25 +95,31 @@ module DocuSign_eSign
|
|
89
95
|
# Reserved:
|
90
96
|
attr_accessor :fax_number
|
91
97
|
|
98
|
+
# Reserved for DocuSign.
|
92
99
|
attr_accessor :fax_number_metadata
|
93
100
|
|
94
101
|
#
|
95
102
|
attr_accessor :host_email
|
96
103
|
|
104
|
+
# Metadata that indicates whether the `hostEmail` property is editable.
|
97
105
|
attr_accessor :host_email_metadata
|
98
106
|
|
99
107
|
# Specifies the name of the signing host. It is a required element for In Person Signers recipient Type. Maximum Length: 100 characters.
|
100
108
|
attr_accessor :host_name
|
101
109
|
|
110
|
+
# Metadata that indicates whether the `hostName` property is editable.
|
102
111
|
attr_accessor :host_name_metadata
|
103
112
|
|
104
113
|
# Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node.
|
105
114
|
attr_accessor :id_check_configuration_name
|
106
115
|
|
116
|
+
# Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only.
|
107
117
|
attr_accessor :id_check_configuration_name_metadata
|
108
118
|
|
119
|
+
# An object that contains input information related to a recipient ID check.
|
109
120
|
attr_accessor :id_check_information_input
|
110
121
|
|
122
|
+
# Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).
|
111
123
|
attr_accessor :identity_verification
|
112
124
|
|
113
125
|
# When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
|
@@ -116,6 +128,7 @@ module DocuSign_eSign
|
|
116
128
|
#
|
117
129
|
attr_accessor :in_person_signing_type
|
118
130
|
|
131
|
+
# Metadata that indicates whether the `inPersonSigningType` property is editable.
|
119
132
|
attr_accessor :in_person_signing_type_metadata
|
120
133
|
|
121
134
|
#
|
@@ -127,8 +140,10 @@ module DocuSign_eSign
|
|
127
140
|
#
|
128
141
|
attr_accessor :name
|
129
142
|
|
143
|
+
# Metadata that indicates whether the `name` property is editable. This property is read-only.
|
130
144
|
attr_accessor :name_metadata
|
131
145
|
|
146
|
+
# Information about the notary host. The following information is required when using the eNotary in-person signing flow: - `name`: The name of the notary. - `email`: The email address of the notary. - `recipientId`: A unique ID number for the notary signing host.
|
132
147
|
attr_accessor :notary_host
|
133
148
|
|
134
149
|
#
|
@@ -137,15 +152,19 @@ module DocuSign_eSign
|
|
137
152
|
# Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.
|
138
153
|
attr_accessor :note
|
139
154
|
|
155
|
+
# Metadata that indicates whether the `note` property is editable. This property is read-only.
|
140
156
|
attr_accessor :note_metadata
|
141
157
|
|
158
|
+
# Reserved for DocuSign.
|
142
159
|
attr_accessor :offline_attributes
|
143
160
|
|
161
|
+
# When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign.
|
144
162
|
attr_accessor :phone_authentication
|
145
163
|
|
146
164
|
# Reserved:
|
147
165
|
attr_accessor :recipient_attachments
|
148
166
|
|
167
|
+
# Information about the recipient's authentication status. This property is read-only.
|
149
168
|
attr_accessor :recipient_authentication_status
|
150
169
|
|
151
170
|
#
|
@@ -166,11 +185,13 @@ module DocuSign_eSign
|
|
166
185
|
#
|
167
186
|
attr_accessor :recipient_type
|
168
187
|
|
188
|
+
# Metadata that indicates whether the `recipientType` property is editable. This property is read-only.
|
169
189
|
attr_accessor :recipient_type_metadata
|
170
190
|
|
171
191
|
# When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
|
172
192
|
attr_accessor :require_id_lookup
|
173
193
|
|
194
|
+
# Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only.
|
174
195
|
attr_accessor :require_id_lookup_metadata
|
175
196
|
|
176
197
|
#
|
@@ -188,11 +209,13 @@ module DocuSign_eSign
|
|
188
209
|
# Specifies the routing order of the recipient in the envelope.
|
189
210
|
attr_accessor :routing_order
|
190
211
|
|
212
|
+
# Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.
|
191
213
|
attr_accessor :routing_order_metadata
|
192
214
|
|
193
215
|
# The date and time the envelope was sent.
|
194
216
|
attr_accessor :sent_date_time
|
195
217
|
|
218
|
+
# Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers.
|
196
219
|
attr_accessor :signature_info
|
197
220
|
|
198
221
|
# Reserved: For DocuSign use only.
|
@@ -201,31 +224,37 @@ module DocuSign_eSign
|
|
201
224
|
# The email address for an InPersonSigner recipient Type. Maximum Length: 100 characters.
|
202
225
|
attr_accessor :signer_email
|
203
226
|
|
227
|
+
# Metadata that indicates if the sender can edit the in-person signer's email address.
|
204
228
|
attr_accessor :signer_email_metadata
|
205
229
|
|
206
230
|
#
|
207
231
|
attr_accessor :signer_first_name
|
208
232
|
|
233
|
+
# Metadata that indicates if the `signerFirstName` property is editable.
|
209
234
|
attr_accessor :signer_first_name_metadata
|
210
235
|
|
211
236
|
#
|
212
237
|
attr_accessor :signer_last_name
|
213
238
|
|
239
|
+
# Metadata that indicates whether the `signerLastName` property is editable.
|
214
240
|
attr_accessor :signer_last_name_metadata
|
215
241
|
|
216
242
|
# Required. The full legal name of a signer for the envelope. Maximum Length: 100 characters.
|
217
243
|
attr_accessor :signer_name
|
218
244
|
|
245
|
+
# Metadata that indicates whether the `signerName` property is editable.
|
219
246
|
attr_accessor :signer_name_metadata
|
220
247
|
|
221
248
|
# When set to **true**, specifies that the signer must sign in all locations.
|
222
249
|
attr_accessor :sign_in_each_location
|
223
250
|
|
251
|
+
# Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only.
|
224
252
|
attr_accessor :sign_in_each_location_metadata
|
225
253
|
|
226
254
|
# When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
|
227
255
|
attr_accessor :signing_group_id
|
228
256
|
|
257
|
+
# Not applicable.
|
229
258
|
attr_accessor :signing_group_id_metadata
|
230
259
|
|
231
260
|
# The display name for the signing group. Maximum Length: 100 characters.
|
@@ -234,6 +263,7 @@ module DocuSign_eSign
|
|
234
263
|
# A complex type that contains information about users in the signing group.
|
235
264
|
attr_accessor :signing_group_users
|
236
265
|
|
266
|
+
# When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication.
|
237
267
|
attr_accessor :sms_authentication
|
238
268
|
|
239
269
|
# Lists the social ID type that can be used for recipient authentication.
|
@@ -248,6 +278,7 @@ module DocuSign_eSign
|
|
248
278
|
#
|
249
279
|
attr_accessor :suppress_emails
|
250
280
|
|
281
|
+
# A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.
|
251
282
|
attr_accessor :tabs
|
252
283
|
|
253
284
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
@@ -12,55 +12,66 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# A tab that allows the recipient to initial the document. May be optional.
|
15
16
|
class InitialHere
|
16
17
|
#
|
17
18
|
attr_accessor :anchor_allow_white_space_in_characters
|
18
19
|
|
20
|
+
# Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.
|
19
21
|
attr_accessor :anchor_allow_white_space_in_characters_metadata
|
20
22
|
|
21
23
|
# When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
|
22
24
|
attr_accessor :anchor_case_sensitive
|
23
25
|
|
26
|
+
# Metadata that indicates whether the `anchorCaseSensitive` property is editable.
|
24
27
|
attr_accessor :anchor_case_sensitive_metadata
|
25
28
|
|
26
29
|
# Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
|
27
30
|
attr_accessor :anchor_horizontal_alignment
|
28
31
|
|
32
|
+
# Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
|
29
33
|
attr_accessor :anchor_horizontal_alignment_metadata
|
30
34
|
|
31
35
|
# When set to **true**, this tab is ignored if anchorString is not found in the document.
|
32
36
|
attr_accessor :anchor_ignore_if_not_present
|
33
37
|
|
38
|
+
# Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.
|
34
39
|
attr_accessor :anchor_ignore_if_not_present_metadata
|
35
40
|
|
36
41
|
# When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.
|
37
42
|
attr_accessor :anchor_match_whole_word
|
38
43
|
|
44
|
+
# Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
|
39
45
|
attr_accessor :anchor_match_whole_word_metadata
|
40
46
|
|
41
47
|
# Anchor text information for a radio button.
|
42
48
|
attr_accessor :anchor_string
|
43
49
|
|
50
|
+
# Metadata that indicates whether the `anchorString` property is editable.
|
44
51
|
attr_accessor :anchor_string_metadata
|
45
52
|
|
46
53
|
#
|
47
54
|
attr_accessor :anchor_tab_processor_version
|
48
55
|
|
56
|
+
# Reserved for DocuSign.
|
49
57
|
attr_accessor :anchor_tab_processor_version_metadata
|
50
58
|
|
51
59
|
# Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
|
52
60
|
attr_accessor :anchor_units
|
53
61
|
|
62
|
+
# Metadata that indicates whether the `anchorUnits` property is editable.
|
54
63
|
attr_accessor :anchor_units_metadata
|
55
64
|
|
56
65
|
# Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
|
57
66
|
attr_accessor :anchor_x_offset
|
58
67
|
|
68
|
+
# Metadata that indicates whether the `anchorXOffset` property is editable.
|
59
69
|
attr_accessor :anchor_x_offset_metadata
|
60
70
|
|
61
71
|
# Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
|
62
72
|
attr_accessor :anchor_y_offset
|
63
73
|
|
74
|
+
# Metadata that indicates whether the `anchorYOffset` property is editable.
|
64
75
|
attr_accessor :anchor_y_offset_metadata
|
65
76
|
|
66
77
|
#
|
@@ -71,38 +82,46 @@ module DocuSign_eSign
|
|
71
82
|
# For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
|
72
83
|
attr_accessor :conditional_parent_label
|
73
84
|
|
85
|
+
# Metadata that indicates whether the `conditionalParentLabel` property is editable.
|
74
86
|
attr_accessor :conditional_parent_label_metadata
|
75
87
|
|
76
88
|
# For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.
|
77
89
|
attr_accessor :conditional_parent_value
|
78
90
|
|
91
|
+
# Metadata that indicates whether the `conditionalParentValue` property is editable.
|
79
92
|
attr_accessor :conditional_parent_value_metadata
|
80
93
|
|
81
94
|
# The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
|
82
95
|
attr_accessor :custom_tab_id
|
83
96
|
|
97
|
+
# Metadata that indicates whether the `customTabId` property is editable.
|
84
98
|
attr_accessor :custom_tab_id_metadata
|
85
99
|
|
86
100
|
# Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
|
87
101
|
attr_accessor :document_id
|
88
102
|
|
103
|
+
# Metadata that indicates whether the `documentId` property is editable.
|
89
104
|
attr_accessor :document_id_metadata
|
90
105
|
|
106
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
91
107
|
attr_accessor :error_details
|
92
108
|
|
93
109
|
#
|
94
110
|
attr_accessor :form_order
|
95
111
|
|
112
|
+
# Metadata that indicates whether the `formOrder` property is editable.
|
96
113
|
attr_accessor :form_order_metadata
|
97
114
|
|
98
115
|
#
|
99
116
|
attr_accessor :form_page_label
|
100
117
|
|
118
|
+
# Metadata that indicates whether the `formPageLabel` property is editable.
|
101
119
|
attr_accessor :form_page_label_metadata
|
102
120
|
|
103
121
|
#
|
104
122
|
attr_accessor :form_page_number
|
105
123
|
|
124
|
+
# Metadata that indicates whether the `fromPageNumber` property is editable.
|
106
125
|
attr_accessor :form_page_number_metadata
|
107
126
|
|
108
127
|
#
|
@@ -111,8 +130,10 @@ module DocuSign_eSign
|
|
111
130
|
# Height of the tab in pixels.
|
112
131
|
attr_accessor :height
|
113
132
|
|
133
|
+
# Metadata that indicates whether the `height` property is editable.
|
114
134
|
attr_accessor :height_metadata
|
115
135
|
|
136
|
+
# Contains the information necessary to map the tab to a field in SalesForce.
|
116
137
|
attr_accessor :merge_field
|
117
138
|
|
118
139
|
#
|
@@ -121,16 +142,19 @@ module DocuSign_eSign
|
|
121
142
|
# Specifies the tool tip text for the tab.
|
122
143
|
attr_accessor :name
|
123
144
|
|
145
|
+
# Metadata that indicates whether the `name` property is editable. This property is read-only.
|
124
146
|
attr_accessor :name_metadata
|
125
147
|
|
126
148
|
#
|
127
149
|
attr_accessor :optional
|
128
150
|
|
151
|
+
# Metadata that indicates whether the `optional` property is editable.
|
129
152
|
attr_accessor :optional_metadata
|
130
153
|
|
131
154
|
# Specifies the page number on which the tab is located.
|
132
155
|
attr_accessor :page_number
|
133
156
|
|
157
|
+
# Metadata that indicates whether the `pageNumber` property is editable.
|
134
158
|
attr_accessor :page_number_metadata
|
135
159
|
|
136
160
|
# Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
|
@@ -139,15 +163,19 @@ module DocuSign_eSign
|
|
139
163
|
#
|
140
164
|
attr_accessor :recipient_id_guid
|
141
165
|
|
166
|
+
# Metadata that indicates whether the `recipientIdGuid` property is editable.
|
142
167
|
attr_accessor :recipient_id_guid_metadata
|
143
168
|
|
169
|
+
# Metadata that indicates whether the `recipientId` property is editable.
|
144
170
|
attr_accessor :recipient_id_metadata
|
145
171
|
|
146
172
|
# Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size.
|
147
173
|
attr_accessor :scale_value
|
148
174
|
|
175
|
+
# Metadata that indicates whether the `scaleValue` property is editable.
|
149
176
|
attr_accessor :scale_value_metadata
|
150
177
|
|
178
|
+
# Reserved for DocuSign.
|
151
179
|
attr_accessor :smart_contract_information
|
152
180
|
|
153
181
|
#
|
@@ -156,61 +184,73 @@ module DocuSign_eSign
|
|
156
184
|
# Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
|
157
185
|
attr_accessor :status
|
158
186
|
|
187
|
+
# Metadata that indicates whether the `status` property is editable.
|
159
188
|
attr_accessor :status_metadata
|
160
189
|
|
161
190
|
#
|
162
191
|
attr_accessor :tab_group_labels
|
163
192
|
|
193
|
+
# Metadata that indicates whether the `tabGroupLabels` property is editable.
|
164
194
|
attr_accessor :tab_group_labels_metadata
|
165
195
|
|
166
196
|
# The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
|
167
197
|
attr_accessor :tab_id
|
168
198
|
|
199
|
+
# Metadata that indicates whether the `tabId` property is editable.
|
169
200
|
attr_accessor :tab_id_metadata
|
170
201
|
|
171
202
|
# The label string associated with the tab.
|
172
203
|
attr_accessor :tab_label
|
173
204
|
|
205
|
+
# Metadata that indicates whether the `tabLabel` property is editable.
|
174
206
|
attr_accessor :tab_label_metadata
|
175
207
|
|
176
208
|
#
|
177
209
|
attr_accessor :tab_order
|
178
210
|
|
211
|
+
# Metadata that indicates whether the `tabOrder` property is editable.
|
179
212
|
attr_accessor :tab_order_metadata
|
180
213
|
|
181
214
|
#
|
182
215
|
attr_accessor :tab_type
|
183
216
|
|
217
|
+
# Metadata that indicates whether the `tabType` property is editable.
|
184
218
|
attr_accessor :tab_type_metadata
|
185
219
|
|
186
220
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
187
221
|
attr_accessor :template_locked
|
188
222
|
|
223
|
+
# Metadata that indicates whether the `templateLocked` property is editable.
|
189
224
|
attr_accessor :template_locked_metadata
|
190
225
|
|
191
226
|
# When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
|
192
227
|
attr_accessor :template_required
|
193
228
|
|
229
|
+
# Metadata that indicates whether the `templateRequired` property is editable.
|
194
230
|
attr_accessor :template_required_metadata
|
195
231
|
|
196
232
|
#
|
197
233
|
attr_accessor :tooltip
|
198
234
|
|
235
|
+
# Metadata that indicates whether the `toolTip` property is editable.
|
199
236
|
attr_accessor :tool_tip_metadata
|
200
237
|
|
201
238
|
# Width of the tab in pixels.
|
202
239
|
attr_accessor :width
|
203
240
|
|
241
|
+
# Metadata that indicates whether the `width` property is editable.
|
204
242
|
attr_accessor :width_metadata
|
205
243
|
|
206
244
|
# This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
207
245
|
attr_accessor :x_position
|
208
246
|
|
247
|
+
# Metadata that indicates whether the `xPosition` property is editable.
|
209
248
|
attr_accessor :x_position_metadata
|
210
249
|
|
211
250
|
# This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
212
251
|
attr_accessor :y_position
|
213
252
|
|
253
|
+
# Metadata that indicates whether the `yPosition` property is editable.
|
214
254
|
attr_accessor :y_position_metadata
|
215
255
|
|
216
256
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -13,13 +13,16 @@ require 'date'
|
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
15
|
class InlineTemplate
|
16
|
+
# An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each `customField` string can be a maximum of 100 characters.
|
16
17
|
attr_accessor :custom_fields
|
17
18
|
|
18
19
|
# Complex element contains the details on the documents in the envelope.
|
19
20
|
attr_accessor :documents
|
20
21
|
|
22
|
+
# A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients.
|
21
23
|
attr_accessor :envelope
|
22
24
|
|
25
|
+
# An array of recipient objects that provides details about the recipients of the envelope.
|
23
26
|
attr_accessor :recipients
|
24
27
|
|
25
28
|
# Specifies the order in which templates are overlaid.
|
@@ -12,10 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# Contains information about an intermediary recipient. An intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added.
|
15
16
|
class Intermediary
|
16
17
|
# If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
|
17
18
|
attr_accessor :access_code
|
18
19
|
|
20
|
+
# Metadata that indicates whether the `accessCode` property is editable. This property is read-only.
|
19
21
|
attr_accessor :access_code_metadata
|
20
22
|
|
21
23
|
# This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
|
@@ -54,6 +56,7 @@ module DocuSign_eSign
|
|
54
56
|
# Reserved: For DocuSign use only.
|
55
57
|
attr_accessor :delivery_method
|
56
58
|
|
59
|
+
# Reserved for DocuSign.
|
57
60
|
attr_accessor :delivery_method_metadata
|
58
61
|
|
59
62
|
#
|
@@ -68,8 +71,10 @@ module DocuSign_eSign
|
|
68
71
|
# Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters.
|
69
72
|
attr_accessor :email
|
70
73
|
|
74
|
+
# Metadata that indicates whether the `email` property is editable. This property is read-only.
|
71
75
|
attr_accessor :email_metadata
|
72
76
|
|
77
|
+
# An optional complex type that sets a specific email subject and body for this recipient's notification email. **Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`.
|
73
78
|
attr_accessor :email_notification
|
74
79
|
|
75
80
|
#
|
@@ -78,6 +83,7 @@ module DocuSign_eSign
|
|
78
83
|
# Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
|
79
84
|
attr_accessor :embedded_recipient_start_url
|
80
85
|
|
86
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
81
87
|
attr_accessor :error_details
|
82
88
|
|
83
89
|
# Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.
|
@@ -86,25 +92,31 @@ module DocuSign_eSign
|
|
86
92
|
# Reserved:
|
87
93
|
attr_accessor :fax_number
|
88
94
|
|
95
|
+
# Reserved for DocuSign.
|
89
96
|
attr_accessor :fax_number_metadata
|
90
97
|
|
91
98
|
# The user's first name. Maximum Length: 50 characters.
|
92
99
|
attr_accessor :first_name
|
93
100
|
|
101
|
+
# Metadata that indicates whether the `firstName` property is editable. This property is read-only.
|
94
102
|
attr_accessor :first_name_metadata
|
95
103
|
|
96
104
|
#
|
97
105
|
attr_accessor :full_name
|
98
106
|
|
107
|
+
# Reserved for DocuSign.
|
99
108
|
attr_accessor :full_name_metadata
|
100
109
|
|
101
110
|
# Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node.
|
102
111
|
attr_accessor :id_check_configuration_name
|
103
112
|
|
113
|
+
# Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only.
|
104
114
|
attr_accessor :id_check_configuration_name_metadata
|
105
115
|
|
116
|
+
# An object that contains input information related to a recipient ID check.
|
106
117
|
attr_accessor :id_check_information_input
|
107
118
|
|
119
|
+
# Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).
|
108
120
|
attr_accessor :identity_verification
|
109
121
|
|
110
122
|
# When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
|
@@ -113,6 +125,7 @@ module DocuSign_eSign
|
|
113
125
|
#
|
114
126
|
attr_accessor :last_name
|
115
127
|
|
128
|
+
# Metadata that indicates whether the `lastName` property is editable. This property is read-only.
|
116
129
|
attr_accessor :last_name_metadata
|
117
130
|
|
118
131
|
#
|
@@ -124,20 +137,25 @@ module DocuSign_eSign
|
|
124
137
|
#
|
125
138
|
attr_accessor :name
|
126
139
|
|
140
|
+
# Metadata that indicates whether the `name` property is editable. This property is read-only.
|
127
141
|
attr_accessor :name_metadata
|
128
142
|
|
129
143
|
# Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.
|
130
144
|
attr_accessor :note
|
131
145
|
|
146
|
+
# Metadata that indicates whether the `note` property is editable. This property is read-only.
|
132
147
|
attr_accessor :note_metadata
|
133
148
|
|
149
|
+
# When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign.
|
134
150
|
attr_accessor :phone_authentication
|
135
151
|
|
152
|
+
# Describes the recipient phone number.
|
136
153
|
attr_accessor :phone_number
|
137
154
|
|
138
155
|
# Reserved:
|
139
156
|
attr_accessor :recipient_attachments
|
140
157
|
|
158
|
+
# Information about the recipient's authentication status. This property is read-only.
|
141
159
|
attr_accessor :recipient_authentication_status
|
142
160
|
|
143
161
|
#
|
@@ -152,11 +170,13 @@ module DocuSign_eSign
|
|
152
170
|
#
|
153
171
|
attr_accessor :recipient_type
|
154
172
|
|
173
|
+
# Metadata that indicates whether the `recipientType` property is editable. This property is read-only.
|
155
174
|
attr_accessor :recipient_type_metadata
|
156
175
|
|
157
176
|
# When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
|
158
177
|
attr_accessor :require_id_lookup
|
159
178
|
|
179
|
+
# Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only.
|
160
180
|
attr_accessor :require_id_lookup_metadata
|
161
181
|
|
162
182
|
# Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.
|
@@ -165,6 +185,7 @@ module DocuSign_eSign
|
|
165
185
|
# Specifies the routing order of the recipient in the envelope.
|
166
186
|
attr_accessor :routing_order
|
167
187
|
|
188
|
+
# Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.
|
168
189
|
attr_accessor :routing_order_metadata
|
169
190
|
|
170
191
|
# The date and time the envelope was sent.
|
@@ -176,6 +197,7 @@ module DocuSign_eSign
|
|
176
197
|
# When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
|
177
198
|
attr_accessor :signing_group_id
|
178
199
|
|
200
|
+
# Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only.
|
179
201
|
attr_accessor :signing_group_id_metadata
|
180
202
|
|
181
203
|
# The display name for the signing group. Maximum Length: 100 characters.
|
@@ -184,6 +206,7 @@ module DocuSign_eSign
|
|
184
206
|
# A complex type that contains information about users in the signing group.
|
185
207
|
attr_accessor :signing_group_users
|
186
208
|
|
209
|
+
# When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication.
|
187
210
|
attr_accessor :sms_authentication
|
188
211
|
|
189
212
|
# Lists the social ID type that can be used for recipient authentication.
|