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
|
+
# Contains information about a carbon copy recipient. Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date or add information to any of the documents.
|
15
16
|
class CarbonCopy
|
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.
|
@@ -42,6 +44,9 @@ module DocuSign_eSign
|
|
42
44
|
#
|
43
45
|
attr_accessor :completed_count
|
44
46
|
|
47
|
+
#
|
48
|
+
attr_accessor :consent_details_list
|
49
|
+
|
45
50
|
# An optional array of strings that allows 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.
|
46
51
|
attr_accessor :custom_fields
|
47
52
|
|
@@ -57,6 +62,7 @@ module DocuSign_eSign
|
|
57
62
|
# Reserved: For DocuSign use only.
|
58
63
|
attr_accessor :delivery_method
|
59
64
|
|
65
|
+
# Reserved for DocuSign.
|
60
66
|
attr_accessor :delivery_method_metadata
|
61
67
|
|
62
68
|
#
|
@@ -71,8 +77,10 @@ module DocuSign_eSign
|
|
71
77
|
# Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters.
|
72
78
|
attr_accessor :email
|
73
79
|
|
80
|
+
# Metadata that indicates whether the `email` property is editable. This property is read-only.
|
74
81
|
attr_accessor :email_metadata
|
75
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`.
|
76
84
|
attr_accessor :email_notification
|
77
85
|
|
78
86
|
#
|
@@ -81,6 +89,7 @@ module DocuSign_eSign
|
|
81
89
|
# 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
90
|
attr_accessor :embedded_recipient_start_url
|
83
91
|
|
92
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
84
93
|
attr_accessor :error_details
|
85
94
|
|
86
95
|
# 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 +98,31 @@ module DocuSign_eSign
|
|
89
98
|
# Reserved:
|
90
99
|
attr_accessor :fax_number
|
91
100
|
|
101
|
+
# Reserved for DocuSign.
|
92
102
|
attr_accessor :fax_number_metadata
|
93
103
|
|
94
104
|
# The user's first name. Maximum Length: 50 characters.
|
95
105
|
attr_accessor :first_name
|
96
106
|
|
107
|
+
# Metadata that indicates whether the `firstName` property is editable. This property is read-only.
|
97
108
|
attr_accessor :first_name_metadata
|
98
109
|
|
99
110
|
#
|
100
111
|
attr_accessor :full_name
|
101
112
|
|
113
|
+
# Reserved for DocuSign.
|
102
114
|
attr_accessor :full_name_metadata
|
103
115
|
|
104
116
|
# 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
117
|
attr_accessor :id_check_configuration_name
|
106
118
|
|
119
|
+
# Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only.
|
107
120
|
attr_accessor :id_check_configuration_name_metadata
|
108
121
|
|
122
|
+
# An object that contains input information related to a recipient ID check.
|
109
123
|
attr_accessor :id_check_information_input
|
110
124
|
|
125
|
+
# 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
126
|
attr_accessor :identity_verification
|
112
127
|
|
113
128
|
# 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 +131,7 @@ module DocuSign_eSign
|
|
116
131
|
#
|
117
132
|
attr_accessor :last_name
|
118
133
|
|
134
|
+
# Metadata that indicates whether the `lastName` property is editable. This property is read-only.
|
119
135
|
attr_accessor :last_name_metadata
|
120
136
|
|
121
137
|
#
|
@@ -130,22 +146,28 @@ module DocuSign_eSign
|
|
130
146
|
# legal name of the recipient. Maximum Length: 100 characters.
|
131
147
|
attr_accessor :name
|
132
148
|
|
149
|
+
# Metadata that indicates whether the `name` property is editable. This property is read-only.
|
133
150
|
attr_accessor :name_metadata
|
134
151
|
|
135
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.
|
136
153
|
attr_accessor :note
|
137
154
|
|
155
|
+
# Metadata that indicates whether the `note` property is editable. This property is read-only.
|
138
156
|
attr_accessor :note_metadata
|
139
157
|
|
158
|
+
# 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.
|
140
159
|
attr_accessor :phone_authentication
|
141
160
|
|
161
|
+
# Describes the recipient phone number.
|
142
162
|
attr_accessor :phone_number
|
143
163
|
|
164
|
+
# The proof file of the recipient.
|
144
165
|
attr_accessor :proof_file
|
145
166
|
|
146
167
|
# Reserved:
|
147
168
|
attr_accessor :recipient_attachments
|
148
169
|
|
170
|
+
# Information about the recipient's authentication status. This property is read-only.
|
149
171
|
attr_accessor :recipient_authentication_status
|
150
172
|
|
151
173
|
#
|
@@ -160,11 +182,13 @@ module DocuSign_eSign
|
|
160
182
|
#
|
161
183
|
attr_accessor :recipient_type
|
162
184
|
|
185
|
+
# Metadata that indicates whether the `recipientType` property is editable. This property is read-only.
|
163
186
|
attr_accessor :recipient_type_metadata
|
164
187
|
|
165
188
|
# When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
|
166
189
|
attr_accessor :require_id_lookup
|
167
190
|
|
191
|
+
# Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only.
|
168
192
|
attr_accessor :require_id_lookup_metadata
|
169
193
|
|
170
194
|
# Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.
|
@@ -173,6 +197,7 @@ module DocuSign_eSign
|
|
173
197
|
# Specifies the routing order of the recipient in the envelope.
|
174
198
|
attr_accessor :routing_order
|
175
199
|
|
200
|
+
# Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.
|
176
201
|
attr_accessor :routing_order_metadata
|
177
202
|
|
178
203
|
# The date and time the envelope was sent.
|
@@ -184,6 +209,7 @@ module DocuSign_eSign
|
|
184
209
|
# 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).
|
185
210
|
attr_accessor :signing_group_id
|
186
211
|
|
212
|
+
# Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only.
|
187
213
|
attr_accessor :signing_group_id_metadata
|
188
214
|
|
189
215
|
# The display name for the signing group. Maximum Length: 100 characters.
|
@@ -192,6 +218,7 @@ module DocuSign_eSign
|
|
192
218
|
# A complex type that contains information about users in the signing group.
|
193
219
|
attr_accessor :signing_group_users
|
194
220
|
|
221
|
+
# 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.
|
195
222
|
attr_accessor :sms_authentication
|
196
223
|
|
197
224
|
# Lists the social ID type that can be used for recipient authentication.
|
@@ -206,6 +233,7 @@ module DocuSign_eSign
|
|
206
233
|
#
|
207
234
|
attr_accessor :suppress_emails
|
208
235
|
|
236
|
+
# A list of `commentTabs` that contains the Carbon Copy recipient's comments.
|
209
237
|
attr_accessor :tabs
|
210
238
|
|
211
239
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
@@ -233,6 +261,7 @@ module DocuSign_eSign
|
|
233
261
|
:'auto_responded_reason' => :'autoRespondedReason',
|
234
262
|
:'client_user_id' => :'clientUserId',
|
235
263
|
:'completed_count' => :'completedCount',
|
264
|
+
:'consent_details_list' => :'consentDetailsList',
|
236
265
|
:'custom_fields' => :'customFields',
|
237
266
|
:'declined_date_time' => :'declinedDateTime',
|
238
267
|
:'declined_reason' => :'declinedReason',
|
@@ -316,6 +345,7 @@ module DocuSign_eSign
|
|
316
345
|
:'auto_responded_reason' => :'String',
|
317
346
|
:'client_user_id' => :'String',
|
318
347
|
:'completed_count' => :'String',
|
348
|
+
:'consent_details_list' => :'Array<ConsentDetails>',
|
319
349
|
:'custom_fields' => :'Array<String>',
|
320
350
|
:'declined_date_time' => :'String',
|
321
351
|
:'declined_reason' => :'String',
|
@@ -436,6 +466,12 @@ module DocuSign_eSign
|
|
436
466
|
self.completed_count = attributes[:'completedCount']
|
437
467
|
end
|
438
468
|
|
469
|
+
if attributes.has_key?(:'consentDetailsList')
|
470
|
+
if (value = attributes[:'consentDetailsList']).is_a?(Array)
|
471
|
+
self.consent_details_list = value
|
472
|
+
end
|
473
|
+
end
|
474
|
+
|
439
475
|
if attributes.has_key?(:'customFields')
|
440
476
|
if (value = attributes[:'customFields']).is_a?(Array)
|
441
477
|
self.custom_fields = value
|
@@ -747,6 +783,7 @@ module DocuSign_eSign
|
|
747
783
|
auto_responded_reason == o.auto_responded_reason &&
|
748
784
|
client_user_id == o.client_user_id &&
|
749
785
|
completed_count == o.completed_count &&
|
786
|
+
consent_details_list == o.consent_details_list &&
|
750
787
|
custom_fields == o.custom_fields &&
|
751
788
|
declined_date_time == o.declined_date_time &&
|
752
789
|
declined_reason == o.declined_reason &&
|
@@ -825,7 +862,7 @@ module DocuSign_eSign
|
|
825
862
|
# Calculates hash code according to all attributes.
|
826
863
|
# @return [Fixnum] Hash code
|
827
864
|
def hash
|
828
|
-
[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_responded_reason, client_user_id, completed_count, custom_fields, declined_date_time, declined_reason, 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, last_name, last_name_metadata, linked_account_configuration_id, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, 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
|
865
|
+
[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_responded_reason, client_user_id, completed_count, consent_details_list, custom_fields, declined_date_time, declined_reason, 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, last_name, last_name_metadata, linked_account_configuration_id, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, 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
|
829
866
|
end
|
830
867
|
|
831
868
|
# 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
|
+
# Contains information about a certified delivery recipient. Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents.
|
15
16
|
class CertifiedDelivery
|
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.
|
@@ -42,6 +44,9 @@ module DocuSign_eSign
|
|
42
44
|
#
|
43
45
|
attr_accessor :completed_count
|
44
46
|
|
47
|
+
#
|
48
|
+
attr_accessor :consent_details_list
|
49
|
+
|
45
50
|
# An optional array of strings that allows 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.
|
46
51
|
attr_accessor :custom_fields
|
47
52
|
|
@@ -57,6 +62,7 @@ module DocuSign_eSign
|
|
57
62
|
# Reserved: For DocuSign use only.
|
58
63
|
attr_accessor :delivery_method
|
59
64
|
|
65
|
+
# Reserved for DocuSign.
|
60
66
|
attr_accessor :delivery_method_metadata
|
61
67
|
|
62
68
|
#
|
@@ -71,8 +77,10 @@ module DocuSign_eSign
|
|
71
77
|
#
|
72
78
|
attr_accessor :email
|
73
79
|
|
80
|
+
# Metadata that indicates whether the `email` property is editable. This property is read-only.
|
74
81
|
attr_accessor :email_metadata
|
75
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`.
|
76
84
|
attr_accessor :email_notification
|
77
85
|
|
78
86
|
#
|
@@ -81,6 +89,7 @@ module DocuSign_eSign
|
|
81
89
|
# 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
90
|
attr_accessor :embedded_recipient_start_url
|
83
91
|
|
92
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
84
93
|
attr_accessor :error_details
|
85
94
|
|
86
95
|
# 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 +98,31 @@ module DocuSign_eSign
|
|
89
98
|
# Reserved:
|
90
99
|
attr_accessor :fax_number
|
91
100
|
|
101
|
+
# Reserved for DocuSign.
|
92
102
|
attr_accessor :fax_number_metadata
|
93
103
|
|
94
104
|
# The user's first name. Maximum Length: 50 characters.
|
95
105
|
attr_accessor :first_name
|
96
106
|
|
107
|
+
# Metadata that indicates whether the `firstName` property is editable. This property is read-only.
|
97
108
|
attr_accessor :first_name_metadata
|
98
109
|
|
99
110
|
#
|
100
111
|
attr_accessor :full_name
|
101
112
|
|
113
|
+
# Reserved for DocuSign.
|
102
114
|
attr_accessor :full_name_metadata
|
103
115
|
|
104
116
|
# 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
117
|
attr_accessor :id_check_configuration_name
|
106
118
|
|
119
|
+
# Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only.
|
107
120
|
attr_accessor :id_check_configuration_name_metadata
|
108
121
|
|
122
|
+
# An object that contains input information related to a recipient ID check.
|
109
123
|
attr_accessor :id_check_information_input
|
110
124
|
|
125
|
+
# 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
126
|
attr_accessor :identity_verification
|
112
127
|
|
113
128
|
# 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 +131,7 @@ module DocuSign_eSign
|
|
116
131
|
#
|
117
132
|
attr_accessor :last_name
|
118
133
|
|
134
|
+
# Metadata that indicates whether the `lastName` property is editable. This property is read-only.
|
119
135
|
attr_accessor :last_name_metadata
|
120
136
|
|
121
137
|
#
|
@@ -127,22 +143,28 @@ module DocuSign_eSign
|
|
127
143
|
#
|
128
144
|
attr_accessor :name
|
129
145
|
|
146
|
+
# Metadata that indicates whether the `name` property is editable. This property is read-only.
|
130
147
|
attr_accessor :name_metadata
|
131
148
|
|
132
149
|
# 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.
|
133
150
|
attr_accessor :note
|
134
151
|
|
152
|
+
# Metadata that indicates whether the `note` property is editable. This property is read-only.
|
135
153
|
attr_accessor :note_metadata
|
136
154
|
|
155
|
+
# 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.
|
137
156
|
attr_accessor :phone_authentication
|
138
157
|
|
158
|
+
# Describes the recipient phone number.
|
139
159
|
attr_accessor :phone_number
|
140
160
|
|
161
|
+
# The proof file of the recipient.
|
141
162
|
attr_accessor :proof_file
|
142
163
|
|
143
164
|
# Reserved:
|
144
165
|
attr_accessor :recipient_attachments
|
145
166
|
|
167
|
+
# Information about the recipient's authentication status. This property is read-only.
|
146
168
|
attr_accessor :recipient_authentication_status
|
147
169
|
|
148
170
|
#
|
@@ -157,11 +179,13 @@ module DocuSign_eSign
|
|
157
179
|
#
|
158
180
|
attr_accessor :recipient_type
|
159
181
|
|
182
|
+
# Metadata that indicates whether the `recipientType` property is editable. This property is read-only.
|
160
183
|
attr_accessor :recipient_type_metadata
|
161
184
|
|
162
185
|
# When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
|
163
186
|
attr_accessor :require_id_lookup
|
164
187
|
|
188
|
+
# Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only.
|
165
189
|
attr_accessor :require_id_lookup_metadata
|
166
190
|
|
167
191
|
# Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.
|
@@ -170,6 +194,7 @@ module DocuSign_eSign
|
|
170
194
|
# Specifies the routing order of the recipient in the envelope.
|
171
195
|
attr_accessor :routing_order
|
172
196
|
|
197
|
+
# Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.
|
173
198
|
attr_accessor :routing_order_metadata
|
174
199
|
|
175
200
|
# The date and time the envelope was sent.
|
@@ -181,6 +206,7 @@ module DocuSign_eSign
|
|
181
206
|
# 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).
|
182
207
|
attr_accessor :signing_group_id
|
183
208
|
|
209
|
+
# Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only.
|
184
210
|
attr_accessor :signing_group_id_metadata
|
185
211
|
|
186
212
|
# The display name for the signing group. Maximum Length: 100 characters.
|
@@ -189,6 +215,7 @@ module DocuSign_eSign
|
|
189
215
|
# A complex type that contains information about users in the signing group.
|
190
216
|
attr_accessor :signing_group_users
|
191
217
|
|
218
|
+
# 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.
|
192
219
|
attr_accessor :sms_authentication
|
193
220
|
|
194
221
|
# Lists the social ID type that can be used for recipient authentication.
|
@@ -228,6 +255,7 @@ module DocuSign_eSign
|
|
228
255
|
:'auto_responded_reason' => :'autoRespondedReason',
|
229
256
|
:'client_user_id' => :'clientUserId',
|
230
257
|
:'completed_count' => :'completedCount',
|
258
|
+
:'consent_details_list' => :'consentDetailsList',
|
231
259
|
:'custom_fields' => :'customFields',
|
232
260
|
:'declined_date_time' => :'declinedDateTime',
|
233
261
|
:'declined_reason' => :'declinedReason',
|
@@ -309,6 +337,7 @@ module DocuSign_eSign
|
|
309
337
|
:'auto_responded_reason' => :'String',
|
310
338
|
:'client_user_id' => :'String',
|
311
339
|
:'completed_count' => :'String',
|
340
|
+
:'consent_details_list' => :'Array<ConsentDetails>',
|
312
341
|
:'custom_fields' => :'Array<String>',
|
313
342
|
:'declined_date_time' => :'String',
|
314
343
|
:'declined_reason' => :'String',
|
@@ -427,6 +456,12 @@ module DocuSign_eSign
|
|
427
456
|
self.completed_count = attributes[:'completedCount']
|
428
457
|
end
|
429
458
|
|
459
|
+
if attributes.has_key?(:'consentDetailsList')
|
460
|
+
if (value = attributes[:'consentDetailsList']).is_a?(Array)
|
461
|
+
self.consent_details_list = value
|
462
|
+
end
|
463
|
+
end
|
464
|
+
|
430
465
|
if attributes.has_key?(:'customFields')
|
431
466
|
if (value = attributes[:'customFields']).is_a?(Array)
|
432
467
|
self.custom_fields = value
|
@@ -730,6 +765,7 @@ module DocuSign_eSign
|
|
730
765
|
auto_responded_reason == o.auto_responded_reason &&
|
731
766
|
client_user_id == o.client_user_id &&
|
732
767
|
completed_count == o.completed_count &&
|
768
|
+
consent_details_list == o.consent_details_list &&
|
733
769
|
custom_fields == o.custom_fields &&
|
734
770
|
declined_date_time == o.declined_date_time &&
|
735
771
|
declined_reason == o.declined_reason &&
|
@@ -806,7 +842,7 @@ module DocuSign_eSign
|
|
806
842
|
# Calculates hash code according to all attributes.
|
807
843
|
# @return [Fixnum] Hash code
|
808
844
|
def hash
|
809
|
-
[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_responded_reason, client_user_id, completed_count, custom_fields, declined_date_time, declined_reason, 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, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, template_locked, template_required, total_tab_count, user_id].hash
|
845
|
+
[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_responded_reason, client_user_id, completed_count, consent_details_list, custom_fields, declined_date_time, declined_reason, 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, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, template_locked, template_required, total_tab_count, user_id].hash
|
810
846
|
end
|
811
847
|
|
812
848
|
# Builds the object from hash
|