docusign_esign 3.17.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 +10 -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 +1353 -184
- data/lib/docusign_esign/api/notary_api.rb +16 -16
- data/lib/docusign_esign/api/power_forms_api.rb +24 -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 +11 -1
- 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 +611 -1
- 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 +35 -1
- 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 +38 -1
- data/lib/docusign_esign/models/certified_delivery.rb +37 -1
- 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_historical_envelope_republish.rb +195 -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/consent_details.rb +204 -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 +36 -1
- 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_publish_transaction.rb +307 -0
- data/lib/docusign_esign/models/envelope_publish_transaction_error_rollup.rb +194 -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 +36 -1
- 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 +52 -1
- 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/participant.rb +13 -1
- 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 +11 -1
- 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 +43 -1
- 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 +32 -1
- 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 +43 -1
- 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 +5 -0
- metadata +7 -2
@@ -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
|
+
# This object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`. It describes information about the notary host. The following information is required when using the eNotary in-person signing flow: * `name`: Specifies the notary's full legal name. * `email`: Specifies the notary's email address. * `recipientId`: A unique ID number for the notary signing host.
|
15
16
|
class NotaryHost
|
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.
|
@@ -48,6 +50,7 @@ module DocuSign_eSign
|
|
48
50
|
# Reserved: For DocuSign use only.
|
49
51
|
attr_accessor :delivery_method
|
50
52
|
|
53
|
+
# Reserved for DocuSign.
|
51
54
|
attr_accessor :delivery_method_metadata
|
52
55
|
|
53
56
|
#
|
@@ -62,18 +65,22 @@ module DocuSign_eSign
|
|
62
65
|
#
|
63
66
|
attr_accessor :email
|
64
67
|
|
68
|
+
# Metadata that indicates whether the `email` property is editable. This property is read-only.
|
65
69
|
attr_accessor :email_metadata
|
66
70
|
|
71
|
+
# 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`.
|
67
72
|
attr_accessor :email_notification
|
68
73
|
|
69
74
|
# 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]]`
|
70
75
|
attr_accessor :embedded_recipient_start_url
|
71
76
|
|
77
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
72
78
|
attr_accessor :error_details
|
73
79
|
|
74
80
|
# Reserved:
|
75
81
|
attr_accessor :fax_number
|
76
82
|
|
83
|
+
# Reserved for DocuSign.
|
77
84
|
attr_accessor :fax_number_metadata
|
78
85
|
|
79
86
|
#
|
@@ -82,10 +89,13 @@ module DocuSign_eSign
|
|
82
89
|
# 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.
|
83
90
|
attr_accessor :id_check_configuration_name
|
84
91
|
|
92
|
+
# Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only.
|
85
93
|
attr_accessor :id_check_configuration_name_metadata
|
86
94
|
|
95
|
+
# An object that contains input information related to a recipient ID check.
|
87
96
|
attr_accessor :id_check_information_input
|
88
97
|
|
98
|
+
# 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).
|
89
99
|
attr_accessor :identity_verification
|
90
100
|
|
91
101
|
# 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.
|
@@ -100,18 +110,22 @@ module DocuSign_eSign
|
|
100
110
|
#
|
101
111
|
attr_accessor :name
|
102
112
|
|
113
|
+
# Metadata that indicates whether the `name` property is editable. This property is read-only.
|
103
114
|
attr_accessor :name_metadata
|
104
115
|
|
105
116
|
# 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.
|
106
117
|
attr_accessor :note
|
107
118
|
|
119
|
+
# Metadata that indicates whether the `note` property is editable. This property is read-only.
|
108
120
|
attr_accessor :note_metadata
|
109
121
|
|
122
|
+
# 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.
|
110
123
|
attr_accessor :phone_authentication
|
111
124
|
|
112
125
|
# Reserved:
|
113
126
|
attr_accessor :recipient_attachments
|
114
127
|
|
128
|
+
# Information about the recipient's authentication status. This property is read-only.
|
115
129
|
attr_accessor :recipient_authentication_status
|
116
130
|
|
117
131
|
#
|
@@ -126,11 +140,13 @@ module DocuSign_eSign
|
|
126
140
|
#
|
127
141
|
attr_accessor :recipient_type
|
128
142
|
|
143
|
+
# Metadata that indicates whether the `recipientType` property is editable. This property is read-only.
|
129
144
|
attr_accessor :recipient_type_metadata
|
130
145
|
|
131
146
|
# When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
|
132
147
|
attr_accessor :require_id_lookup
|
133
148
|
|
149
|
+
# Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only.
|
134
150
|
attr_accessor :require_id_lookup_metadata
|
135
151
|
|
136
152
|
# Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.
|
@@ -139,6 +155,7 @@ module DocuSign_eSign
|
|
139
155
|
# Specifies the routing order of the recipient in the envelope.
|
140
156
|
attr_accessor :routing_order
|
141
157
|
|
158
|
+
# Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.
|
142
159
|
attr_accessor :routing_order_metadata
|
143
160
|
|
144
161
|
# The date and time the envelope was sent.
|
@@ -150,6 +167,7 @@ module DocuSign_eSign
|
|
150
167
|
# 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).
|
151
168
|
attr_accessor :signing_group_id
|
152
169
|
|
170
|
+
# Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only.
|
153
171
|
attr_accessor :signing_group_id_metadata
|
154
172
|
|
155
173
|
# The display name for the signing group. Maximum Length: 100 characters.
|
@@ -158,6 +176,7 @@ module DocuSign_eSign
|
|
158
176
|
# A complex type that contains information about users in the signing group.
|
159
177
|
attr_accessor :signing_group_users
|
160
178
|
|
179
|
+
# 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.
|
161
180
|
attr_accessor :sms_authentication
|
162
181
|
|
163
182
|
# Lists the social ID type that can be used for recipient authentication.
|
@@ -172,6 +191,7 @@ module DocuSign_eSign
|
|
172
191
|
#
|
173
192
|
attr_accessor :suppress_emails
|
174
193
|
|
194
|
+
# 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.
|
175
195
|
attr_accessor :tabs
|
176
196
|
|
177
197
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
@@ -19,11 +19,13 @@ module DocuSign_eSign
|
|
19
19
|
#
|
20
20
|
attr_accessor :document_name
|
21
21
|
|
22
|
+
# The notary's jurisdiction.
|
22
23
|
attr_accessor :jurisdiction
|
23
24
|
|
24
25
|
#
|
25
26
|
attr_accessor :notary_journal_id
|
26
27
|
|
28
|
+
# Additional journal data such as the witness list and signature image.
|
27
29
|
attr_accessor :notary_journal_meta_data
|
28
30
|
|
29
31
|
#
|
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# A notary jurisdiction.
|
15
16
|
class NotaryJurisdiction
|
16
17
|
#
|
17
18
|
attr_accessor :commission_expiration
|
@@ -22,8 +23,10 @@ module DocuSign_eSign
|
|
22
23
|
#
|
23
24
|
attr_accessor :county
|
24
25
|
|
26
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
25
27
|
attr_accessor :error_details
|
26
28
|
|
29
|
+
# Description of the jurisdiction for this notary. This is a read-only property.
|
27
30
|
attr_accessor :jurisdiction
|
28
31
|
|
29
32
|
#
|
@@ -16,6 +16,7 @@ module DocuSign_eSign
|
|
16
16
|
# 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
17
|
attr_accessor :access_code
|
18
18
|
|
19
|
+
# Metadata that indicates whether the `accessCode` property is editable. This property is read-only.
|
19
20
|
attr_accessor :access_code_metadata
|
20
21
|
|
21
22
|
# 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.
|
@@ -51,6 +52,9 @@ module DocuSign_eSign
|
|
51
52
|
#
|
52
53
|
attr_accessor :completed_count
|
53
54
|
|
55
|
+
#
|
56
|
+
attr_accessor :consent_details_list
|
57
|
+
|
54
58
|
#
|
55
59
|
attr_accessor :creation_reason
|
56
60
|
|
@@ -66,6 +70,7 @@ module DocuSign_eSign
|
|
66
70
|
#
|
67
71
|
attr_accessor :default_recipient
|
68
72
|
|
73
|
+
#
|
69
74
|
attr_accessor :delegated_by
|
70
75
|
|
71
76
|
#
|
@@ -77,6 +82,7 @@ module DocuSign_eSign
|
|
77
82
|
# Reserved: For DocuSign use only.
|
78
83
|
attr_accessor :delivery_method
|
79
84
|
|
85
|
+
# Reserved for DocuSign.
|
80
86
|
attr_accessor :delivery_method_metadata
|
81
87
|
|
82
88
|
#
|
@@ -91,8 +97,10 @@ module DocuSign_eSign
|
|
91
97
|
#
|
92
98
|
attr_accessor :email
|
93
99
|
|
100
|
+
# Metadata that indicates whether the `email` property is editable. This property is read-only.
|
94
101
|
attr_accessor :email_metadata
|
95
102
|
|
103
|
+
# 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`.
|
96
104
|
attr_accessor :email_notification
|
97
105
|
|
98
106
|
#
|
@@ -101,6 +109,7 @@ module DocuSign_eSign
|
|
101
109
|
# 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]]`
|
102
110
|
attr_accessor :embedded_recipient_start_url
|
103
111
|
|
112
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
104
113
|
attr_accessor :error_details
|
105
114
|
|
106
115
|
# 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.
|
@@ -109,25 +118,31 @@ module DocuSign_eSign
|
|
109
118
|
# Reserved:
|
110
119
|
attr_accessor :fax_number
|
111
120
|
|
121
|
+
# Reserved for DocuSign.
|
112
122
|
attr_accessor :fax_number_metadata
|
113
123
|
|
114
124
|
# The user's first name. Maximum Length: 50 characters.
|
115
125
|
attr_accessor :first_name
|
116
126
|
|
127
|
+
# Metadata that indicates whether the `firstName` property is editable. This property is read-only.
|
117
128
|
attr_accessor :first_name_metadata
|
118
129
|
|
119
130
|
#
|
120
131
|
attr_accessor :full_name
|
121
132
|
|
133
|
+
# Reserved for DocuSign.
|
122
134
|
attr_accessor :full_name_metadata
|
123
135
|
|
124
136
|
# 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.
|
125
137
|
attr_accessor :id_check_configuration_name
|
126
138
|
|
139
|
+
# Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only.
|
127
140
|
attr_accessor :id_check_configuration_name_metadata
|
128
141
|
|
142
|
+
# An object that contains input information related to a recipient ID check.
|
129
143
|
attr_accessor :id_check_information_input
|
130
144
|
|
145
|
+
# 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).
|
131
146
|
attr_accessor :identity_verification
|
132
147
|
|
133
148
|
# 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.
|
@@ -136,11 +151,13 @@ module DocuSign_eSign
|
|
136
151
|
#
|
137
152
|
attr_accessor :is_bulk_recipient
|
138
153
|
|
154
|
+
# Reserved for DocuSign.
|
139
155
|
attr_accessor :is_bulk_recipient_metadata
|
140
156
|
|
141
157
|
#
|
142
158
|
attr_accessor :last_name
|
143
159
|
|
160
|
+
# Metadata that indicates whether the `lastName` property is editable. This property is read-only.
|
144
161
|
attr_accessor :last_name_metadata
|
145
162
|
|
146
163
|
#
|
@@ -155,6 +172,7 @@ module DocuSign_eSign
|
|
155
172
|
#
|
156
173
|
attr_accessor :name
|
157
174
|
|
175
|
+
# Metadata that indicates whether the `name` property is editable. This property is read-only.
|
158
176
|
attr_accessor :name_metadata
|
159
177
|
|
160
178
|
#
|
@@ -166,25 +184,34 @@ module DocuSign_eSign
|
|
166
184
|
#
|
167
185
|
attr_accessor :notary_signers
|
168
186
|
|
187
|
+
#
|
188
|
+
attr_accessor :notary_source_type
|
189
|
+
|
169
190
|
#
|
170
191
|
attr_accessor :notary_type
|
171
192
|
|
172
193
|
# 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.
|
173
194
|
attr_accessor :note
|
174
195
|
|
196
|
+
# Metadata that indicates whether the `note` property is editable. This property is read-only.
|
175
197
|
attr_accessor :note_metadata
|
176
198
|
|
199
|
+
# Reserved for DocuSign.
|
177
200
|
attr_accessor :offline_attributes
|
178
201
|
|
202
|
+
# 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.
|
179
203
|
attr_accessor :phone_authentication
|
180
204
|
|
205
|
+
# Describes the recipient phone number.
|
181
206
|
attr_accessor :phone_number
|
182
207
|
|
208
|
+
#
|
183
209
|
attr_accessor :proof_file
|
184
210
|
|
185
211
|
# Reserved:
|
186
212
|
attr_accessor :recipient_attachments
|
187
213
|
|
214
|
+
# Information about the recipient's authentication status. This property is read-only.
|
188
215
|
attr_accessor :recipient_authentication_status
|
189
216
|
|
190
217
|
#
|
@@ -205,11 +232,13 @@ module DocuSign_eSign
|
|
205
232
|
#
|
206
233
|
attr_accessor :recipient_type
|
207
234
|
|
235
|
+
# Metadata that indicates whether the `recipientType` property is editable. This property is read-only.
|
208
236
|
attr_accessor :recipient_type_metadata
|
209
237
|
|
210
238
|
# When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
|
211
239
|
attr_accessor :require_id_lookup
|
212
240
|
|
241
|
+
# Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only.
|
213
242
|
attr_accessor :require_id_lookup_metadata
|
214
243
|
|
215
244
|
#
|
@@ -227,11 +256,13 @@ module DocuSign_eSign
|
|
227
256
|
# Specifies the routing order of the recipient in the envelope.
|
228
257
|
attr_accessor :routing_order
|
229
258
|
|
259
|
+
# Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.
|
230
260
|
attr_accessor :routing_order_metadata
|
231
261
|
|
232
262
|
# The date and time the envelope was sent.
|
233
263
|
attr_accessor :sent_date_time
|
234
264
|
|
265
|
+
# 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.
|
235
266
|
attr_accessor :signature_info
|
236
267
|
|
237
268
|
# Reserved: For DocuSign use only.
|
@@ -240,11 +271,13 @@ module DocuSign_eSign
|
|
240
271
|
# When set to **true**, specifies that the signer must sign in all locations.
|
241
272
|
attr_accessor :sign_in_each_location
|
242
273
|
|
274
|
+
# Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only.
|
243
275
|
attr_accessor :sign_in_each_location_metadata
|
244
276
|
|
245
277
|
# 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).
|
246
278
|
attr_accessor :signing_group_id
|
247
279
|
|
280
|
+
# Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only.
|
248
281
|
attr_accessor :signing_group_id_metadata
|
249
282
|
|
250
283
|
# The display name for the signing group. Maximum Length: 100 characters.
|
@@ -253,6 +286,7 @@ module DocuSign_eSign
|
|
253
286
|
# A complex type that contains information about users in the signing group.
|
254
287
|
attr_accessor :signing_group_users
|
255
288
|
|
289
|
+
# 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.
|
256
290
|
attr_accessor :sms_authentication
|
257
291
|
|
258
292
|
# Lists the social ID type that can be used for recipient authentication.
|
@@ -267,6 +301,7 @@ module DocuSign_eSign
|
|
267
301
|
#
|
268
302
|
attr_accessor :suppress_emails
|
269
303
|
|
304
|
+
# 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.
|
270
305
|
attr_accessor :tabs
|
271
306
|
|
272
307
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
@@ -297,6 +332,7 @@ module DocuSign_eSign
|
|
297
332
|
:'can_sign_offline' => :'canSignOffline',
|
298
333
|
:'client_user_id' => :'clientUserId',
|
299
334
|
:'completed_count' => :'completedCount',
|
335
|
+
:'consent_details_list' => :'consentDetailsList',
|
300
336
|
:'creation_reason' => :'creationReason',
|
301
337
|
:'custom_fields' => :'customFields',
|
302
338
|
:'declined_date_time' => :'declinedDateTime',
|
@@ -340,6 +376,7 @@ module DocuSign_eSign
|
|
340
376
|
:'notary_id' => :'notaryId',
|
341
377
|
:'notary_signer_email_sent' => :'notarySignerEmailSent',
|
342
378
|
:'notary_signers' => :'notarySigners',
|
379
|
+
:'notary_source_type' => :'notarySourceType',
|
343
380
|
:'notary_type' => :'notaryType',
|
344
381
|
:'note' => :'note',
|
345
382
|
:'note_metadata' => :'noteMetadata',
|
@@ -402,6 +439,7 @@ module DocuSign_eSign
|
|
402
439
|
:'can_sign_offline' => :'String',
|
403
440
|
:'client_user_id' => :'String',
|
404
441
|
:'completed_count' => :'String',
|
442
|
+
:'consent_details_list' => :'Array<ConsentDetails>',
|
405
443
|
:'creation_reason' => :'String',
|
406
444
|
:'custom_fields' => :'Array<String>',
|
407
445
|
:'declined_date_time' => :'String',
|
@@ -445,6 +483,7 @@ module DocuSign_eSign
|
|
445
483
|
:'notary_id' => :'String',
|
446
484
|
:'notary_signer_email_sent' => :'String',
|
447
485
|
:'notary_signers' => :'Array<String>',
|
486
|
+
:'notary_source_type' => :'String',
|
448
487
|
:'notary_type' => :'String',
|
449
488
|
:'note' => :'String',
|
450
489
|
:'note_metadata' => :'PropertyMetadata',
|
@@ -553,6 +592,12 @@ module DocuSign_eSign
|
|
553
592
|
self.completed_count = attributes[:'completedCount']
|
554
593
|
end
|
555
594
|
|
595
|
+
if attributes.has_key?(:'consentDetailsList')
|
596
|
+
if (value = attributes[:'consentDetailsList']).is_a?(Array)
|
597
|
+
self.consent_details_list = value
|
598
|
+
end
|
599
|
+
end
|
600
|
+
|
556
601
|
if attributes.has_key?(:'creationReason')
|
557
602
|
self.creation_reason = attributes[:'creationReason']
|
558
603
|
end
|
@@ -735,6 +780,10 @@ module DocuSign_eSign
|
|
735
780
|
end
|
736
781
|
end
|
737
782
|
|
783
|
+
if attributes.has_key?(:'notarySourceType')
|
784
|
+
self.notary_source_type = attributes[:'notarySourceType']
|
785
|
+
end
|
786
|
+
|
738
787
|
if attributes.has_key?(:'notaryType')
|
739
788
|
self.notary_type = attributes[:'notaryType']
|
740
789
|
end
|
@@ -949,6 +998,7 @@ module DocuSign_eSign
|
|
949
998
|
can_sign_offline == o.can_sign_offline &&
|
950
999
|
client_user_id == o.client_user_id &&
|
951
1000
|
completed_count == o.completed_count &&
|
1001
|
+
consent_details_list == o.consent_details_list &&
|
952
1002
|
creation_reason == o.creation_reason &&
|
953
1003
|
custom_fields == o.custom_fields &&
|
954
1004
|
declined_date_time == o.declined_date_time &&
|
@@ -992,6 +1042,7 @@ module DocuSign_eSign
|
|
992
1042
|
notary_id == o.notary_id &&
|
993
1043
|
notary_signer_email_sent == o.notary_signer_email_sent &&
|
994
1044
|
notary_signers == o.notary_signers &&
|
1045
|
+
notary_source_type == o.notary_source_type &&
|
995
1046
|
notary_type == o.notary_type &&
|
996
1047
|
note == o.note &&
|
997
1048
|
note_metadata == o.note_metadata &&
|
@@ -1046,7 +1097,7 @@ module DocuSign_eSign
|
|
1046
1097
|
# Calculates hash code according to all attributes.
|
1047
1098
|
# @return [Fixnum] Hash code
|
1048
1099
|
def hash
|
1049
|
-
[access_code, access_code_metadata, add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, auto_navigation, auto_responded_reason, bulk_recipients_uri, can_sign_offline, client_user_id, completed_count, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delegated_by, delegated_to, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, is_bulk_recipient, is_bulk_recipient_metadata, last_name, last_name_metadata, live_oak_start_url, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, notary_signer_email_sent, notary_signers, notary_type, note, note_metadata, offline_attributes, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, require_signer_certificate, require_sign_on_paper, require_upload_signature, role_name, routing_order, routing_order_metadata, sent_date_time, signature_info, signed_date_time, sign_in_each_location, sign_in_each_location_metadata, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id].hash
|
1100
|
+
[access_code, access_code_metadata, add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, auto_navigation, auto_responded_reason, bulk_recipients_uri, can_sign_offline, client_user_id, completed_count, consent_details_list, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delegated_by, delegated_to, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, is_bulk_recipient, is_bulk_recipient_metadata, last_name, last_name_metadata, live_oak_start_url, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, notary_signer_email_sent, notary_signers, notary_source_type, notary_type, note, note_metadata, offline_attributes, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, require_signer_certificate, require_sign_on_paper, require_upload_signature, role_name, routing_order, routing_order_metadata, sent_date_time, signature_info, signed_date_time, sign_in_each_location, sign_in_each_location_metadata, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id].hash
|
1050
1101
|
end
|
1051
1102
|
|
1052
1103
|
# Builds the object from hash
|
@@ -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
|
+
# Describes a single notary jurisdiction.
|
15
16
|
class NotaryResult
|
16
17
|
#
|
17
18
|
attr_accessor :jurisdictions
|
18
19
|
|
20
|
+
#
|
19
21
|
attr_accessor :notary
|
20
22
|
|
21
23
|
# Attribute mapping from ruby-style variable name to JSON key.
|