docusign_esign 3.12.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 +54 -0
- data/docusign_esign.gemspec +5 -5
- data/lib/docusign_esign/api/accounts_api.rb +83 -433
- data/lib/docusign_esign/api/billing_api.rb +12 -4
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +93 -26
- data/lib/docusign_esign/api/bulk_process_data_api.rb +412 -0
- data/lib/docusign_esign/api/bulk_process_data_send_api.rb +252 -0
- data/lib/docusign_esign/api/connect_api.rb +239 -5
- data/lib/docusign_esign/api/email_archive_api.rb +8 -8
- data/lib/docusign_esign/api/envelopes_api.rb +1435 -207
- data/lib/docusign_esign/api/notary_api.rb +16 -16
- data/lib/docusign_esign/api/organizations_api.rb +8 -60
- data/lib/docusign_esign/api/power_forms_api.rb +24 -16
- data/lib/docusign_esign/api/templates_api.rb +20 -79
- data/lib/docusign_esign/api/users_api.rb +22 -14
- data/lib/docusign_esign/api/workspaces_api.rb +4 -4
- data/lib/docusign_esign/client/api_client.rb +16 -10
- data/lib/docusign_esign/client/api_error.rb +1 -1
- data/lib/docusign_esign/client/auth/oauth.rb +1 -1
- data/lib/docusign_esign/models/access_code_format.rb +6 -0
- data/lib/docusign_esign/models/account_billing_plan.rb +25 -4
- data/lib/docusign_esign/models/account_billing_plan_response.rb +37 -10
- 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 +81 -4
- data/lib/docusign_esign/models/account_settings_information.rb +1075 -13
- 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 +28 -13
- data/lib/docusign_esign/models/address_information_input.rb +1 -0
- data/lib/docusign_esign/models/agent.rb +45 -1
- data/lib/docusign_esign/models/app_store_receipt.rb +21 -1
- data/lib/docusign_esign/models/approve.rb +65 -1
- 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_charge.rb +1 -1
- data/lib/docusign_esign/models/billing_entity_information_response.rb +214 -0
- data/lib/docusign_esign/models/billing_invoice_item.rb +21 -1
- data/lib/docusign_esign/models/billing_invoices_summary.rb +21 -1
- data/lib/docusign_esign/models/billing_plan_information.rb +52 -4
- 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_process_request.rb +194 -0
- data/lib/docusign_esign/models/bulk_process_response.rb +248 -0
- data/lib/docusign_esign/models/bulk_process_result.rb +206 -0
- data/lib/docusign_esign/models/bulk_processing_list_summaries.rb +186 -0
- data/lib/docusign_esign/models/bulk_processing_list_summary.rb +214 -0
- data/lib/docusign_esign/models/bulk_processing_lists.rb +186 -0
- data/lib/docusign_esign/models/bulk_recipients_update_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_action_request.rb +204 -0
- data/lib/docusign_esign/models/bulk_send_batch_error.rb +194 -0
- data/lib/docusign_esign/models/bulk_send_batch_status.rb +42 -1
- data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +22 -1
- data/lib/docusign_esign/models/bulk_send_batch_summary.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_envelopes_info.rb +304 -0
- data/lib/docusign_esign/models/bulk_send_error_status.rb +12 -1
- 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 +48 -1
- data/lib/docusign_esign/models/certified_delivery.rb +47 -1
- data/lib/docusign_esign/models/checkbox.rb +109 -1
- 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 +63 -1
- data/lib/docusign_esign/models/commission_county.rb +72 -1
- data/lib/docusign_esign/models/commission_expiration.rb +72 -1
- data/lib/docusign_esign/models/commission_number.rb +72 -1
- data/lib/docusign_esign/models/commission_state.rb +72 -1
- data/lib/docusign_esign/models/company.rb +72 -1
- 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 +60 -4
- data/lib/docusign_esign/models/connect_debug_log.rb +1 -0
- data/lib/docusign_esign/models/connect_delete_failure_result.rb +174 -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/connect_user_info.rb +214 -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 +12 -1
- 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 +95 -1
- 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 +98 -1
- data/lib/docusign_esign/models/date_signed.rb +66 -1
- data/lib/docusign_esign/models/date_stamp_properties.rb +1 -0
- data/lib/docusign_esign/models/decline.rb +66 -1
- data/lib/docusign_esign/models/delayed_routing.rb +206 -0
- data/lib/docusign_esign/models/delayed_routing_api_model.rb +206 -0
- data/lib/docusign_esign/models/delegation_info.rb +214 -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/downgrade_plan_update_response.rb +11 -1
- data/lib/docusign_esign/models/downgrade_request_information.rb +204 -0
- data/lib/docusign_esign/models/draw.rb +60 -1
- data/lib/docusign_esign/models/e_note_configuration.rb +1 -0
- data/lib/docusign_esign/models/editor.rb +46 -1
- data/lib/docusign_esign/models/email.rb +98 -1
- data/lib/docusign_esign/models/email_address.rb +66 -1
- data/lib/docusign_esign/models/envelope.rb +20 -1
- data/lib/docusign_esign/models/envelope_attachment.rb +1 -0
- data/lib/docusign_esign/models/envelope_custom_metadata.rb +186 -0
- data/lib/docusign_esign/models/envelope_definition.rb +23 -1
- data/lib/docusign_esign/models/envelope_delay_rule.rb +194 -0
- data/lib/docusign_esign/models/envelope_delay_rule_api_model.rb +195 -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 +65 -1
- 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 +22 -1
- data/lib/docusign_esign/models/envelope_template_results.rb +1 -0
- data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -0
- data/lib/docusign_esign/models/envelope_transfer_rule.rb +6 -0
- data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +4 -0
- data/lib/docusign_esign/models/envelope_update_summary.rb +4 -0
- data/lib/docusign_esign/models/envelopes_information.rb +1 -0
- data/lib/docusign_esign/models/event_notification.rb +24 -1
- data/lib/docusign_esign/models/event_result.rb +1 -0
- data/lib/docusign_esign/models/external_document_sources.rb +6 -0
- data/lib/docusign_esign/models/external_file.rb +1 -0
- data/lib/docusign_esign/models/external_folder.rb +1 -0
- data/lib/docusign_esign/models/external_primary_account_recipient_auth_requirements.rb +214 -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 +66 -1
- 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 +13 -1
- 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 +103 -1
- data/lib/docusign_esign/models/full_name.rb +66 -1
- data/lib/docusign_esign/models/group.rb +13 -1
- 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/id_evidence_resource_token.rb +194 -0
- data/lib/docusign_esign/models/id_evidence_view_link.rb +184 -0
- data/lib/docusign_esign/models/in_person_signer.rb +31 -0
- data/lib/docusign_esign/models/initial_here.rb +60 -1
- data/lib/docusign_esign/models/inline_template.rb +3 -0
- data/lib/docusign_esign/models/integrated_connect_user_info_list.rb +246 -0
- data/lib/docusign_esign/models/intermediary.rb +46 -1
- data/lib/docusign_esign/models/jurisdiction.rb +1 -0
- data/lib/docusign_esign/models/last_name.rb +66 -1
- data/lib/docusign_esign/models/linked_external_primary_account.rb +21 -1
- data/lib/docusign_esign/models/list.rb +112 -1
- 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 +53 -4
- 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 +58 -1
- 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 +93 -1
- data/lib/docusign_esign/models/notary_result.rb +2 -0
- data/lib/docusign_esign/models/notary_seal.rb +59 -1
- data/lib/docusign_esign/models/note.rb +67 -1
- 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 +100 -1
- data/lib/docusign_esign/models/page.rb +1 -0
- data/lib/docusign_esign/models/participant.rb +908 -0
- data/lib/docusign_esign/models/payment_details.rb +16 -1
- 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 +72 -1
- data/lib/docusign_esign/models/poly_line_overlay.rb +60 -1
- 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 +65 -4
- data/lib/docusign_esign/models/property_metadata.rb +1 -0
- data/lib/docusign_esign/models/radio.rb +48 -1
- data/lib/docusign_esign/models/radio_group.rb +78 -4
- 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 +44 -4
- data/lib/docusign_esign/models/recipient_identity_verification.rb +15 -4
- 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 +102 -2
- 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 +14 -1
- data/lib/docusign_esign/models/recipients_update_summary.rb +1 -0
- data/lib/docusign_esign/models/reserved_domain_existence.rb +194 -0
- data/lib/docusign_esign/models/return_url_request.rb +1 -0
- data/lib/docusign_esign/models/scheduled_sending.rb +216 -0
- data/lib/docusign_esign/models/scheduled_sending_api_model.rb +206 -0
- data/lib/docusign_esign/models/seal_sign.rb +17 -0
- data/lib/docusign_esign/models/seat_discount.rb +1 -0
- data/lib/docusign_esign/models/sender_company.rb +65 -1
- data/lib/docusign_esign/models/sender_email_notifications.rb +12 -1
- data/lib/docusign_esign/models/sender_name.rb +65 -1
- 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 +62 -1
- 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 +84 -1
- data/lib/docusign_esign/models/signer_attachment.rb +60 -1
- 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 +61 -1
- 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 +98 -1
- 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 +42 -1
- data/lib/docusign_esign/models/tab_group.rb +61 -1
- data/lib/docusign_esign/models/tab_metadata.rb +34 -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 +14 -1
- 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 +100 -1
- data/lib/docusign_esign/models/text_custom_field.rb +2 -0
- data/lib/docusign_esign/models/title.rb +72 -1
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +70 -1
- data/lib/docusign_esign/models/user_info.rb +1 -0
- data/lib/docusign_esign/models/user_information.rb +17 -1
- 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 +103 -4
- 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 +66 -1
- data/lib/docusign_esign/models/witness.rb +84 -1
- data/lib/docusign_esign/models/workflow.rb +32 -1
- data/lib/docusign_esign/models/workflow_step.rb +13 -1
- 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 +99 -1
- data/lib/docusign_esign/version.rb +1 -1
- data/lib/docusign_esign.rb +30 -17
- data/tests/spec/unit_tests_using_jwt_spec.rb +605 -449
- metadata +70 -44
- data/Gemfile.lock +0 -73
- data/docusign_esign-2.12.0.rc1.gem +0 -0
- data/docusign_esign-3.12.0.rc1.gem +0 -0
- data/lib/docusign_esign/.DS_Store +0 -0
- data/lib/docusign_esign/api/.DS_Store +0 -0
- data/lib/docusign_esign/client/.DS_Store +0 -0
- data/tests/.DS_Store +0 -0
- data/tests/Gemfile.lock +0 -46
- data/tests/docs/private.pem +0 -27
@@ -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,13 +77,19 @@ 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
|
|
86
|
+
#
|
87
|
+
attr_accessor :email_recipient_post_signing_url
|
88
|
+
|
78
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]]`
|
79
90
|
attr_accessor :embedded_recipient_start_url
|
80
91
|
|
92
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
81
93
|
attr_accessor :error_details
|
82
94
|
|
83
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.
|
@@ -86,25 +98,31 @@ module DocuSign_eSign
|
|
86
98
|
# Reserved:
|
87
99
|
attr_accessor :fax_number
|
88
100
|
|
101
|
+
# Reserved for DocuSign.
|
89
102
|
attr_accessor :fax_number_metadata
|
90
103
|
|
91
104
|
# The user's first name. Maximum Length: 50 characters.
|
92
105
|
attr_accessor :first_name
|
93
106
|
|
107
|
+
# Metadata that indicates whether the `firstName` property is editable. This property is read-only.
|
94
108
|
attr_accessor :first_name_metadata
|
95
109
|
|
96
110
|
#
|
97
111
|
attr_accessor :full_name
|
98
112
|
|
113
|
+
# Reserved for DocuSign.
|
99
114
|
attr_accessor :full_name_metadata
|
100
115
|
|
101
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.
|
102
117
|
attr_accessor :id_check_configuration_name
|
103
118
|
|
119
|
+
# Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only.
|
104
120
|
attr_accessor :id_check_configuration_name_metadata
|
105
121
|
|
122
|
+
# An object that contains input information related to a recipient ID check.
|
106
123
|
attr_accessor :id_check_information_input
|
107
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).
|
108
126
|
attr_accessor :identity_verification
|
109
127
|
|
110
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.
|
@@ -113,6 +131,7 @@ module DocuSign_eSign
|
|
113
131
|
#
|
114
132
|
attr_accessor :last_name
|
115
133
|
|
134
|
+
# Metadata that indicates whether the `lastName` property is editable. This property is read-only.
|
116
135
|
attr_accessor :last_name_metadata
|
117
136
|
|
118
137
|
#
|
@@ -127,22 +146,28 @@ module DocuSign_eSign
|
|
127
146
|
# legal name of the recipient. Maximum Length: 100 characters.
|
128
147
|
attr_accessor :name
|
129
148
|
|
149
|
+
# Metadata that indicates whether the `name` property is editable. This property is read-only.
|
130
150
|
attr_accessor :name_metadata
|
131
151
|
|
132
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.
|
133
153
|
attr_accessor :note
|
134
154
|
|
155
|
+
# Metadata that indicates whether the `note` property is editable. This property is read-only.
|
135
156
|
attr_accessor :note_metadata
|
136
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.
|
137
159
|
attr_accessor :phone_authentication
|
138
160
|
|
161
|
+
# Describes the recipient phone number.
|
139
162
|
attr_accessor :phone_number
|
140
163
|
|
164
|
+
# The proof file of the recipient.
|
141
165
|
attr_accessor :proof_file
|
142
166
|
|
143
167
|
# Reserved:
|
144
168
|
attr_accessor :recipient_attachments
|
145
169
|
|
170
|
+
# Information about the recipient's authentication status. This property is read-only.
|
146
171
|
attr_accessor :recipient_authentication_status
|
147
172
|
|
148
173
|
#
|
@@ -157,11 +182,13 @@ module DocuSign_eSign
|
|
157
182
|
#
|
158
183
|
attr_accessor :recipient_type
|
159
184
|
|
185
|
+
# Metadata that indicates whether the `recipientType` property is editable. This property is read-only.
|
160
186
|
attr_accessor :recipient_type_metadata
|
161
187
|
|
162
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.
|
163
189
|
attr_accessor :require_id_lookup
|
164
190
|
|
191
|
+
# Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only.
|
165
192
|
attr_accessor :require_id_lookup_metadata
|
166
193
|
|
167
194
|
# Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.
|
@@ -170,6 +197,7 @@ module DocuSign_eSign
|
|
170
197
|
# Specifies the routing order of the recipient in the envelope.
|
171
198
|
attr_accessor :routing_order
|
172
199
|
|
200
|
+
# Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.
|
173
201
|
attr_accessor :routing_order_metadata
|
174
202
|
|
175
203
|
# The date and time the envelope was sent.
|
@@ -181,6 +209,7 @@ module DocuSign_eSign
|
|
181
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).
|
182
210
|
attr_accessor :signing_group_id
|
183
211
|
|
212
|
+
# Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only.
|
184
213
|
attr_accessor :signing_group_id_metadata
|
185
214
|
|
186
215
|
# The display name for the signing group. Maximum Length: 100 characters.
|
@@ -189,6 +218,7 @@ module DocuSign_eSign
|
|
189
218
|
# A complex type that contains information about users in the signing group.
|
190
219
|
attr_accessor :signing_group_users
|
191
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.
|
192
222
|
attr_accessor :sms_authentication
|
193
223
|
|
194
224
|
# Lists the social ID type that can be used for recipient authentication.
|
@@ -203,6 +233,7 @@ module DocuSign_eSign
|
|
203
233
|
#
|
204
234
|
attr_accessor :suppress_emails
|
205
235
|
|
236
|
+
# A list of `commentTabs` that contains the Carbon Copy recipient's comments.
|
206
237
|
attr_accessor :tabs
|
207
238
|
|
208
239
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
@@ -230,6 +261,7 @@ module DocuSign_eSign
|
|
230
261
|
:'auto_responded_reason' => :'autoRespondedReason',
|
231
262
|
:'client_user_id' => :'clientUserId',
|
232
263
|
:'completed_count' => :'completedCount',
|
264
|
+
:'consent_details_list' => :'consentDetailsList',
|
233
265
|
:'custom_fields' => :'customFields',
|
234
266
|
:'declined_date_time' => :'declinedDateTime',
|
235
267
|
:'declined_reason' => :'declinedReason',
|
@@ -242,6 +274,7 @@ module DocuSign_eSign
|
|
242
274
|
:'email' => :'email',
|
243
275
|
:'email_metadata' => :'emailMetadata',
|
244
276
|
:'email_notification' => :'emailNotification',
|
277
|
+
:'email_recipient_post_signing_url' => :'emailRecipientPostSigningURL',
|
245
278
|
:'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
|
246
279
|
:'error_details' => :'errorDetails',
|
247
280
|
:'excluded_documents' => :'excludedDocuments',
|
@@ -312,6 +345,7 @@ module DocuSign_eSign
|
|
312
345
|
:'auto_responded_reason' => :'String',
|
313
346
|
:'client_user_id' => :'String',
|
314
347
|
:'completed_count' => :'String',
|
348
|
+
:'consent_details_list' => :'Array<ConsentDetails>',
|
315
349
|
:'custom_fields' => :'Array<String>',
|
316
350
|
:'declined_date_time' => :'String',
|
317
351
|
:'declined_reason' => :'String',
|
@@ -324,6 +358,7 @@ module DocuSign_eSign
|
|
324
358
|
:'email' => :'String',
|
325
359
|
:'email_metadata' => :'PropertyMetadata',
|
326
360
|
:'email_notification' => :'RecipientEmailNotification',
|
361
|
+
:'email_recipient_post_signing_url' => :'String',
|
327
362
|
:'embedded_recipient_start_url' => :'String',
|
328
363
|
:'error_details' => :'ErrorDetails',
|
329
364
|
:'excluded_documents' => :'Array<String>',
|
@@ -431,6 +466,12 @@ module DocuSign_eSign
|
|
431
466
|
self.completed_count = attributes[:'completedCount']
|
432
467
|
end
|
433
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
|
+
|
434
475
|
if attributes.has_key?(:'customFields')
|
435
476
|
if (value = attributes[:'customFields']).is_a?(Array)
|
436
477
|
self.custom_fields = value
|
@@ -483,6 +524,10 @@ module DocuSign_eSign
|
|
483
524
|
self.email_notification = attributes[:'emailNotification']
|
484
525
|
end
|
485
526
|
|
527
|
+
if attributes.has_key?(:'emailRecipientPostSigningURL')
|
528
|
+
self.email_recipient_post_signing_url = attributes[:'emailRecipientPostSigningURL']
|
529
|
+
end
|
530
|
+
|
486
531
|
if attributes.has_key?(:'embeddedRecipientStartURL')
|
487
532
|
self.embedded_recipient_start_url = attributes[:'embeddedRecipientStartURL']
|
488
533
|
end
|
@@ -738,6 +783,7 @@ module DocuSign_eSign
|
|
738
783
|
auto_responded_reason == o.auto_responded_reason &&
|
739
784
|
client_user_id == o.client_user_id &&
|
740
785
|
completed_count == o.completed_count &&
|
786
|
+
consent_details_list == o.consent_details_list &&
|
741
787
|
custom_fields == o.custom_fields &&
|
742
788
|
declined_date_time == o.declined_date_time &&
|
743
789
|
declined_reason == o.declined_reason &&
|
@@ -750,6 +796,7 @@ module DocuSign_eSign
|
|
750
796
|
email == o.email &&
|
751
797
|
email_metadata == o.email_metadata &&
|
752
798
|
email_notification == o.email_notification &&
|
799
|
+
email_recipient_post_signing_url == o.email_recipient_post_signing_url &&
|
753
800
|
embedded_recipient_start_url == o.embedded_recipient_start_url &&
|
754
801
|
error_details == o.error_details &&
|
755
802
|
excluded_documents == o.excluded_documents &&
|
@@ -815,7 +862,7 @@ module DocuSign_eSign
|
|
815
862
|
# Calculates hash code according to all attributes.
|
816
863
|
# @return [Fixnum] Hash code
|
817
864
|
def hash
|
818
|
-
[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, 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
|
819
866
|
end
|
820
867
|
|
821
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,13 +77,19 @@ 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
|
|
86
|
+
#
|
87
|
+
attr_accessor :email_recipient_post_signing_url
|
88
|
+
|
78
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]]`
|
79
90
|
attr_accessor :embedded_recipient_start_url
|
80
91
|
|
92
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
81
93
|
attr_accessor :error_details
|
82
94
|
|
83
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.
|
@@ -86,25 +98,31 @@ module DocuSign_eSign
|
|
86
98
|
# Reserved:
|
87
99
|
attr_accessor :fax_number
|
88
100
|
|
101
|
+
# Reserved for DocuSign.
|
89
102
|
attr_accessor :fax_number_metadata
|
90
103
|
|
91
104
|
# The user's first name. Maximum Length: 50 characters.
|
92
105
|
attr_accessor :first_name
|
93
106
|
|
107
|
+
# Metadata that indicates whether the `firstName` property is editable. This property is read-only.
|
94
108
|
attr_accessor :first_name_metadata
|
95
109
|
|
96
110
|
#
|
97
111
|
attr_accessor :full_name
|
98
112
|
|
113
|
+
# Reserved for DocuSign.
|
99
114
|
attr_accessor :full_name_metadata
|
100
115
|
|
101
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.
|
102
117
|
attr_accessor :id_check_configuration_name
|
103
118
|
|
119
|
+
# Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only.
|
104
120
|
attr_accessor :id_check_configuration_name_metadata
|
105
121
|
|
122
|
+
# An object that contains input information related to a recipient ID check.
|
106
123
|
attr_accessor :id_check_information_input
|
107
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).
|
108
126
|
attr_accessor :identity_verification
|
109
127
|
|
110
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.
|
@@ -113,6 +131,7 @@ module DocuSign_eSign
|
|
113
131
|
#
|
114
132
|
attr_accessor :last_name
|
115
133
|
|
134
|
+
# Metadata that indicates whether the `lastName` property is editable. This property is read-only.
|
116
135
|
attr_accessor :last_name_metadata
|
117
136
|
|
118
137
|
#
|
@@ -124,22 +143,28 @@ module DocuSign_eSign
|
|
124
143
|
#
|
125
144
|
attr_accessor :name
|
126
145
|
|
146
|
+
# Metadata that indicates whether the `name` property is editable. This property is read-only.
|
127
147
|
attr_accessor :name_metadata
|
128
148
|
|
129
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.
|
130
150
|
attr_accessor :note
|
131
151
|
|
152
|
+
# Metadata that indicates whether the `note` property is editable. This property is read-only.
|
132
153
|
attr_accessor :note_metadata
|
133
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.
|
134
156
|
attr_accessor :phone_authentication
|
135
157
|
|
158
|
+
# Describes the recipient phone number.
|
136
159
|
attr_accessor :phone_number
|
137
160
|
|
161
|
+
# The proof file of the recipient.
|
138
162
|
attr_accessor :proof_file
|
139
163
|
|
140
164
|
# Reserved:
|
141
165
|
attr_accessor :recipient_attachments
|
142
166
|
|
167
|
+
# Information about the recipient's authentication status. This property is read-only.
|
143
168
|
attr_accessor :recipient_authentication_status
|
144
169
|
|
145
170
|
#
|
@@ -154,11 +179,13 @@ module DocuSign_eSign
|
|
154
179
|
#
|
155
180
|
attr_accessor :recipient_type
|
156
181
|
|
182
|
+
# Metadata that indicates whether the `recipientType` property is editable. This property is read-only.
|
157
183
|
attr_accessor :recipient_type_metadata
|
158
184
|
|
159
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.
|
160
186
|
attr_accessor :require_id_lookup
|
161
187
|
|
188
|
+
# Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only.
|
162
189
|
attr_accessor :require_id_lookup_metadata
|
163
190
|
|
164
191
|
# Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.
|
@@ -167,6 +194,7 @@ module DocuSign_eSign
|
|
167
194
|
# Specifies the routing order of the recipient in the envelope.
|
168
195
|
attr_accessor :routing_order
|
169
196
|
|
197
|
+
# Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.
|
170
198
|
attr_accessor :routing_order_metadata
|
171
199
|
|
172
200
|
# The date and time the envelope was sent.
|
@@ -178,6 +206,7 @@ module DocuSign_eSign
|
|
178
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).
|
179
207
|
attr_accessor :signing_group_id
|
180
208
|
|
209
|
+
# Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only.
|
181
210
|
attr_accessor :signing_group_id_metadata
|
182
211
|
|
183
212
|
# The display name for the signing group. Maximum Length: 100 characters.
|
@@ -186,6 +215,7 @@ module DocuSign_eSign
|
|
186
215
|
# A complex type that contains information about users in the signing group.
|
187
216
|
attr_accessor :signing_group_users
|
188
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.
|
189
219
|
attr_accessor :sms_authentication
|
190
220
|
|
191
221
|
# Lists the social ID type that can be used for recipient authentication.
|
@@ -225,6 +255,7 @@ module DocuSign_eSign
|
|
225
255
|
:'auto_responded_reason' => :'autoRespondedReason',
|
226
256
|
:'client_user_id' => :'clientUserId',
|
227
257
|
:'completed_count' => :'completedCount',
|
258
|
+
:'consent_details_list' => :'consentDetailsList',
|
228
259
|
:'custom_fields' => :'customFields',
|
229
260
|
:'declined_date_time' => :'declinedDateTime',
|
230
261
|
:'declined_reason' => :'declinedReason',
|
@@ -237,6 +268,7 @@ module DocuSign_eSign
|
|
237
268
|
:'email' => :'email',
|
238
269
|
:'email_metadata' => :'emailMetadata',
|
239
270
|
:'email_notification' => :'emailNotification',
|
271
|
+
:'email_recipient_post_signing_url' => :'emailRecipientPostSigningURL',
|
240
272
|
:'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
|
241
273
|
:'error_details' => :'errorDetails',
|
242
274
|
:'excluded_documents' => :'excludedDocuments',
|
@@ -305,6 +337,7 @@ module DocuSign_eSign
|
|
305
337
|
:'auto_responded_reason' => :'String',
|
306
338
|
:'client_user_id' => :'String',
|
307
339
|
:'completed_count' => :'String',
|
340
|
+
:'consent_details_list' => :'Array<ConsentDetails>',
|
308
341
|
:'custom_fields' => :'Array<String>',
|
309
342
|
:'declined_date_time' => :'String',
|
310
343
|
:'declined_reason' => :'String',
|
@@ -317,6 +350,7 @@ module DocuSign_eSign
|
|
317
350
|
:'email' => :'String',
|
318
351
|
:'email_metadata' => :'PropertyMetadata',
|
319
352
|
:'email_notification' => :'RecipientEmailNotification',
|
353
|
+
:'email_recipient_post_signing_url' => :'String',
|
320
354
|
:'embedded_recipient_start_url' => :'String',
|
321
355
|
:'error_details' => :'ErrorDetails',
|
322
356
|
:'excluded_documents' => :'Array<String>',
|
@@ -422,6 +456,12 @@ module DocuSign_eSign
|
|
422
456
|
self.completed_count = attributes[:'completedCount']
|
423
457
|
end
|
424
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
|
+
|
425
465
|
if attributes.has_key?(:'customFields')
|
426
466
|
if (value = attributes[:'customFields']).is_a?(Array)
|
427
467
|
self.custom_fields = value
|
@@ -474,6 +514,10 @@ module DocuSign_eSign
|
|
474
514
|
self.email_notification = attributes[:'emailNotification']
|
475
515
|
end
|
476
516
|
|
517
|
+
if attributes.has_key?(:'emailRecipientPostSigningURL')
|
518
|
+
self.email_recipient_post_signing_url = attributes[:'emailRecipientPostSigningURL']
|
519
|
+
end
|
520
|
+
|
477
521
|
if attributes.has_key?(:'embeddedRecipientStartURL')
|
478
522
|
self.embedded_recipient_start_url = attributes[:'embeddedRecipientStartURL']
|
479
523
|
end
|
@@ -721,6 +765,7 @@ module DocuSign_eSign
|
|
721
765
|
auto_responded_reason == o.auto_responded_reason &&
|
722
766
|
client_user_id == o.client_user_id &&
|
723
767
|
completed_count == o.completed_count &&
|
768
|
+
consent_details_list == o.consent_details_list &&
|
724
769
|
custom_fields == o.custom_fields &&
|
725
770
|
declined_date_time == o.declined_date_time &&
|
726
771
|
declined_reason == o.declined_reason &&
|
@@ -733,6 +778,7 @@ module DocuSign_eSign
|
|
733
778
|
email == o.email &&
|
734
779
|
email_metadata == o.email_metadata &&
|
735
780
|
email_notification == o.email_notification &&
|
781
|
+
email_recipient_post_signing_url == o.email_recipient_post_signing_url &&
|
736
782
|
embedded_recipient_start_url == o.embedded_recipient_start_url &&
|
737
783
|
error_details == o.error_details &&
|
738
784
|
excluded_documents == o.excluded_documents &&
|
@@ -796,7 +842,7 @@ module DocuSign_eSign
|
|
796
842
|
# Calculates hash code according to all attributes.
|
797
843
|
# @return [Fixnum] Hash code
|
798
844
|
def hash
|
799
|
-
[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, 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
|
800
846
|
end
|
801
847
|
|
802
848
|
# Builds the object from hash
|