docusign_esign 3.18.0 → 3.19.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/lib/docusign_esign/api/accounts_api.rb +60 -60
- data/lib/docusign_esign/api/billing_api.rb +2 -2
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +22 -22
- data/lib/docusign_esign/api/connect_api.rb +148 -0
- data/lib/docusign_esign/api/email_archive_api.rb +8 -8
- data/lib/docusign_esign/api/envelopes_api.rb +1223 -105
- data/lib/docusign_esign/api/notary_api.rb +16 -16
- data/lib/docusign_esign/api/power_forms_api.rb +16 -16
- data/lib/docusign_esign/api/templates_api.rb +20 -20
- data/lib/docusign_esign/api/users_api.rb +14 -14
- data/lib/docusign_esign/api/workspaces_api.rb +4 -4
- data/lib/docusign_esign/client/api_client.rb +1 -1
- data/lib/docusign_esign/models/access_code_format.rb +6 -0
- data/lib/docusign_esign/models/account_billing_plan.rb +1 -0
- data/lib/docusign_esign/models/account_billing_plan_response.rb +9 -0
- data/lib/docusign_esign/models/account_identity_verification_step.rb +1 -0
- data/lib/docusign_esign/models/account_identity_verification_workflow.rb +2 -0
- data/lib/docusign_esign/models/account_information.rb +1 -0
- data/lib/docusign_esign/models/account_notification.rb +3 -0
- data/lib/docusign_esign/models/account_password_questions_required.rb +1 -0
- data/lib/docusign_esign/models/account_password_rules.rb +7 -0
- data/lib/docusign_esign/models/account_role_settings.rb +39 -0
- data/lib/docusign_esign/models/account_settings_information.rb +537 -3
- data/lib/docusign_esign/models/account_shared_access.rb +1 -0
- data/lib/docusign_esign/models/account_signature.rb +2 -0
- data/lib/docusign_esign/models/account_signature_definition.rb +1 -0
- data/lib/docusign_esign/models/account_signature_provider.rb +1 -0
- data/lib/docusign_esign/models/account_signature_provider_option.rb +1 -0
- data/lib/docusign_esign/models/account_ui_settings.rb +15 -0
- data/lib/docusign_esign/models/address_information_input.rb +1 -0
- data/lib/docusign_esign/models/agent.rb +22 -0
- data/lib/docusign_esign/models/approve.rb +45 -0
- data/lib/docusign_esign/models/authentication_status.rb +19 -0
- data/lib/docusign_esign/models/bcc_email_archive.rb +3 -0
- data/lib/docusign_esign/models/bcc_email_archive_history.rb +2 -0
- data/lib/docusign_esign/models/bcc_email_archive_list.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_information.rb +19 -1
- data/lib/docusign_esign/models/billing_plan_preview.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_response.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_update_response.rb +1 -0
- data/lib/docusign_esign/models/brand.rb +4 -0
- data/lib/docusign_esign/models/brand_email_content.rb +1 -0
- data/lib/docusign_esign/models/brand_link.rb +1 -0
- data/lib/docusign_esign/models/brand_logos.rb +1 -0
- data/lib/docusign_esign/models/brand_request.rb +1 -0
- data/lib/docusign_esign/models/brand_resource_urls.rb +1 -0
- data/lib/docusign_esign/models/brand_resources.rb +3 -0
- data/lib/docusign_esign/models/brands_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_envelope.rb +1 -0
- data/lib/docusign_esign/models/bulk_recipients_update_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_action_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_status.rb +2 -0
- data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_summary.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_error_status.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_test_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +5 -0
- data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list_summary.rb +1 -0
- data/lib/docusign_esign/models/captive_recipient.rb +2 -0
- data/lib/docusign_esign/models/captive_recipient_information.rb +1 -0
- data/lib/docusign_esign/models/carbon_copy.rb +25 -0
- data/lib/docusign_esign/models/certified_delivery.rb +24 -0
- data/lib/docusign_esign/models/checkbox.rb +52 -39
- data/lib/docusign_esign/models/chunked_upload_part.rb +1 -0
- data/lib/docusign_esign/models/chunked_upload_request.rb +1 -0
- data/lib/docusign_esign/models/chunked_upload_response.rb +1 -0
- data/lib/docusign_esign/models/cloud_storage_provider.rb +2 -0
- data/lib/docusign_esign/models/comment_thread.rb +43 -0
- data/lib/docusign_esign/models/commission_county.rb +52 -0
- data/lib/docusign_esign/models/commission_expiration.rb +52 -0
- data/lib/docusign_esign/models/commission_number.rb +52 -0
- data/lib/docusign_esign/models/commission_state.rb +52 -0
- data/lib/docusign_esign/models/company.rb +52 -0
- data/lib/docusign_esign/models/composite_template.rb +2 -0
- data/lib/docusign_esign/models/conditional_recipient_rule.rb +2 -0
- data/lib/docusign_esign/models/connect_config_results.rb +1 -0
- data/lib/docusign_esign/models/connect_custom_configuration.rb +2 -0
- data/lib/docusign_esign/models/connect_debug_log.rb +1 -0
- data/lib/docusign_esign/models/connect_event_data.rb +1 -0
- data/lib/docusign_esign/models/connect_failure_filter.rb +1 -0
- data/lib/docusign_esign/models/connect_failure_result.rb +1 -0
- data/lib/docusign_esign/models/connect_log.rb +1 -0
- data/lib/docusign_esign/models/connect_o_auth_config.rb +214 -0
- data/lib/docusign_esign/models/connect_salesforce_field.rb +1 -0
- data/lib/docusign_esign/models/connect_salesforce_object.rb +1 -0
- data/lib/docusign_esign/models/console_view_request.rb +1 -0
- data/lib/docusign_esign/models/consumer_disclosure.rb +3 -0
- data/lib/docusign_esign/models/contact.rb +1 -0
- data/lib/docusign_esign/models/contact_get_response.rb +1 -0
- data/lib/docusign_esign/models/contact_mod_request.rb +1 -0
- data/lib/docusign_esign/models/contact_phone_number.rb +1 -0
- data/lib/docusign_esign/models/contact_update_response.rb +1 -0
- data/lib/docusign_esign/models/correct_view_request.rb +12 -1
- data/lib/docusign_esign/models/credit_card_information.rb +2 -0
- data/lib/docusign_esign/models/currency.rb +55 -0
- data/lib/docusign_esign/models/currency_feature_set_price.rb +1 -0
- data/lib/docusign_esign/models/currency_plan_price.rb +1 -0
- data/lib/docusign_esign/models/custom_field.rb +2 -0
- data/lib/docusign_esign/models/date.rb +59 -0
- data/lib/docusign_esign/models/date_signed.rb +46 -0
- data/lib/docusign_esign/models/date_stamp_properties.rb +1 -0
- data/lib/docusign_esign/models/decline.rb +46 -0
- data/lib/docusign_esign/models/direct_debit_processor_information.rb +1 -0
- data/lib/docusign_esign/models/document.rb +3 -0
- data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +1 -0
- data/lib/docusign_esign/models/document_html_definition.rb +1 -0
- data/lib/docusign_esign/models/document_html_definition_original.rb +1 -0
- data/lib/docusign_esign/models/document_html_display_anchor.rb +1 -0
- data/lib/docusign_esign/models/document_html_display_settings.rb +1 -0
- data/lib/docusign_esign/models/document_template.rb +1 -0
- data/lib/docusign_esign/models/document_visibility.rb +2 -0
- data/lib/docusign_esign/models/document_visibility_list.rb +1 -0
- data/lib/docusign_esign/models/downgrad_request_billing_info_response.rb +1 -0
- data/lib/docusign_esign/models/downgrade_billing_plan_information.rb +1 -0
- data/lib/docusign_esign/models/draw.rb +40 -0
- data/lib/docusign_esign/models/e_note_configuration.rb +1 -0
- data/lib/docusign_esign/models/editor.rb +23 -0
- data/lib/docusign_esign/models/email.rb +59 -0
- data/lib/docusign_esign/models/email_address.rb +46 -0
- data/lib/docusign_esign/models/envelope.rb +10 -0
- data/lib/docusign_esign/models/envelope_attachment.rb +1 -0
- data/lib/docusign_esign/models/envelope_definition.rb +13 -0
- data/lib/docusign_esign/models/envelope_document.rb +7 -0
- data/lib/docusign_esign/models/envelope_event.rb +1 -0
- data/lib/docusign_esign/models/envelope_form_data.rb +2 -0
- data/lib/docusign_esign/models/envelope_id.rb +45 -0
- data/lib/docusign_esign/models/envelope_ids_request.rb +1 -0
- data/lib/docusign_esign/models/envelope_notification_request.rb +3 -0
- data/lib/docusign_esign/models/envelope_purge_configuration.rb +1 -0
- data/lib/docusign_esign/models/envelope_summary.rb +3 -0
- data/lib/docusign_esign/models/envelope_template.rb +12 -0
- data/lib/docusign_esign/models/envelope_template_results.rb +1 -0
- data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -0
- data/lib/docusign_esign/models/envelope_transfer_rule.rb +6 -0
- data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +4 -0
- data/lib/docusign_esign/models/envelope_update_summary.rb +4 -0
- data/lib/docusign_esign/models/envelopes_information.rb +1 -0
- data/lib/docusign_esign/models/event_notification.rb +1 -0
- data/lib/docusign_esign/models/event_result.rb +1 -0
- data/lib/docusign_esign/models/external_document_sources.rb +6 -0
- data/lib/docusign_esign/models/external_file.rb +1 -0
- data/lib/docusign_esign/models/external_folder.rb +1 -0
- data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -0
- data/lib/docusign_esign/models/favorite_templates_info.rb +1 -0
- data/lib/docusign_esign/models/feature_set.rb +1 -0
- data/lib/docusign_esign/models/filter.rb +1 -0
- data/lib/docusign_esign/models/first_name.rb +46 -0
- data/lib/docusign_esign/models/folder.rb +4 -0
- data/lib/docusign_esign/models/folder_item_response.rb +1 -0
- data/lib/docusign_esign/models/folder_item_v2.rb +2 -0
- data/lib/docusign_esign/models/folder_shared_item.rb +3 -0
- data/lib/docusign_esign/models/folders_request.rb +1 -0
- data/lib/docusign_esign/models/form_data_item.rb +1 -0
- data/lib/docusign_esign/models/formula_tab.rb +64 -0
- data/lib/docusign_esign/models/full_name.rb +46 -0
- data/lib/docusign_esign/models/group.rb +2 -0
- data/lib/docusign_esign/models/id_check_configuration.rb +1 -0
- data/lib/docusign_esign/models/id_check_information_input.rb +4 -0
- data/lib/docusign_esign/models/in_person_signer.rb +31 -0
- data/lib/docusign_esign/models/initial_here.rb +40 -0
- data/lib/docusign_esign/models/inline_template.rb +3 -0
- data/lib/docusign_esign/models/intermediary.rb +23 -0
- data/lib/docusign_esign/models/jurisdiction.rb +1 -0
- data/lib/docusign_esign/models/last_name.rb +46 -0
- data/lib/docusign_esign/models/linked_external_primary_account.rb +1 -0
- data/lib/docusign_esign/models/list.rb +54 -0
- data/lib/docusign_esign/models/list_custom_field.rb +2 -0
- data/lib/docusign_esign/models/list_item.rb +4 -0
- data/lib/docusign_esign/models/locale_policy.rb +13 -0
- data/lib/docusign_esign/models/lock_information.rb +2 -0
- data/lib/docusign_esign/models/lock_request.rb +1 -0
- data/lib/docusign_esign/models/member_group_shared_item.rb +3 -0
- data/lib/docusign_esign/models/member_shared_items.rb +3 -0
- data/lib/docusign_esign/models/merge_field.rb +6 -0
- data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -0
- data/lib/docusign_esign/models/money.rb +1 -0
- data/lib/docusign_esign/models/name_value.rb +2 -0
- data/lib/docusign_esign/models/new_account_definition.rb +20 -1
- data/lib/docusign_esign/models/new_account_summary.rb +1 -0
- data/lib/docusign_esign/models/new_user.rb +2 -0
- data/lib/docusign_esign/models/new_users_summary.rb +1 -0
- data/lib/docusign_esign/models/notarize.rb +38 -0
- data/lib/docusign_esign/models/notary.rb +1 -0
- data/lib/docusign_esign/models/notary_host.rb +20 -0
- data/lib/docusign_esign/models/notary_journal.rb +2 -0
- data/lib/docusign_esign/models/notary_jurisdiction.rb +3 -0
- data/lib/docusign_esign/models/notary_jurisdiction_list.rb +1 -0
- data/lib/docusign_esign/models/notary_recipient.rb +29 -0
- data/lib/docusign_esign/models/notary_result.rb +2 -0
- data/lib/docusign_esign/models/notary_seal.rb +39 -0
- data/lib/docusign_esign/models/note.rb +47 -0
- data/lib/docusign_esign/models/notification.rb +2 -0
- data/lib/docusign_esign/models/notification_default_settings.rb +3 -0
- data/lib/docusign_esign/models/notification_defaults.rb +2 -0
- data/lib/docusign_esign/models/number.rb +61 -0
- data/lib/docusign_esign/models/page.rb +1 -0
- data/lib/docusign_esign/models/payment_details.rb +5 -0
- data/lib/docusign_esign/models/payment_gateway_account.rb +3 -0
- data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +1 -0
- data/lib/docusign_esign/models/payment_line_item.rb +1 -0
- data/lib/docusign_esign/models/payment_method_with_options.rb +1 -0
- data/lib/docusign_esign/models/payment_processor_information.rb +1 -0
- data/lib/docusign_esign/models/permission_profile.rb +2 -0
- data/lib/docusign_esign/models/permission_profile_information.rb +1 -0
- data/lib/docusign_esign/models/phone_number.rb +52 -0
- data/lib/docusign_esign/models/poly_line_overlay.rb +40 -0
- data/lib/docusign_esign/models/power_form.rb +2 -0
- data/lib/docusign_esign/models/power_form_recipient.rb +1 -0
- data/lib/docusign_esign/models/power_form_senders_response.rb +1 -0
- data/lib/docusign_esign/models/power_forms_response.rb +1 -0
- data/lib/docusign_esign/models/prefill_tabs.rb +1 -0
- data/lib/docusign_esign/models/property_metadata.rb +1 -0
- data/lib/docusign_esign/models/radio.rb +28 -0
- data/lib/docusign_esign/models/radio_group.rb +17 -0
- data/lib/docusign_esign/models/recipient_additional_notification.rb +3 -0
- data/lib/docusign_esign/models/recipient_email_notification.rb +3 -0
- data/lib/docusign_esign/models/recipient_group.rb +1 -0
- data/lib/docusign_esign/models/recipient_identity_phone_number.rb +3 -0
- data/lib/docusign_esign/models/recipient_identity_verification.rb +2 -0
- data/lib/docusign_esign/models/recipient_names_response.rb +1 -0
- data/lib/docusign_esign/models/recipient_option.rb +1 -0
- data/lib/docusign_esign/models/recipient_phone_authentication.rb +4 -0
- data/lib/docusign_esign/models/recipient_phone_number.rb +3 -0
- data/lib/docusign_esign/models/recipient_preview_request.rb +2 -0
- data/lib/docusign_esign/models/recipient_proof_file.rb +1 -0
- data/lib/docusign_esign/models/recipient_routing.rb +2 -0
- data/lib/docusign_esign/models/recipient_signature_provider.rb +3 -0
- data/lib/docusign_esign/models/recipient_signature_provider_options.rb +5 -0
- data/lib/docusign_esign/models/recipient_sms_authentication.rb +1 -0
- data/lib/docusign_esign/models/recipient_token_client_ur_ls.rb +30 -30
- data/lib/docusign_esign/models/recipient_update_response.rb +3 -0
- data/lib/docusign_esign/models/recipient_view_request.rb +2 -0
- data/lib/docusign_esign/models/recipients.rb +1 -0
- data/lib/docusign_esign/models/recipients_update_summary.rb +1 -0
- data/lib/docusign_esign/models/return_url_request.rb +1 -0
- data/lib/docusign_esign/models/seal_sign.rb +17 -0
- data/lib/docusign_esign/models/seat_discount.rb +1 -0
- data/lib/docusign_esign/models/sender_company.rb +45 -0
- data/lib/docusign_esign/models/sender_email_notifications.rb +1 -0
- data/lib/docusign_esign/models/sender_name.rb +45 -0
- data/lib/docusign_esign/models/settings_metadata.rb +1 -0
- data/lib/docusign_esign/models/shared_item.rb +3 -0
- data/lib/docusign_esign/models/sign_here.rb +42 -0
- data/lib/docusign_esign/models/signature_provider_required_option.rb +1 -0
- data/lib/docusign_esign/models/signature_type.rb +1 -0
- data/lib/docusign_esign/models/signer.rb +30 -0
- data/lib/docusign_esign/models/signer_attachment.rb +40 -0
- data/lib/docusign_esign/models/signing_group.rb +2 -0
- data/lib/docusign_esign/models/signing_group_user.rb +1 -0
- data/lib/docusign_esign/models/smart_section.rb +41 -0
- data/lib/docusign_esign/models/smart_section_display_settings.rb +2 -0
- data/lib/docusign_esign/models/social_account_information.rb +1 -0
- data/lib/docusign_esign/models/ssn.rb +59 -0
- data/lib/docusign_esign/models/stamp.rb +2 -0
- data/lib/docusign_esign/models/supported_languages.rb +1 -0
- data/lib/docusign_esign/models/tab_account_settings.rb +22 -0
- data/lib/docusign_esign/models/tab_group.rb +41 -0
- data/lib/docusign_esign/models/tab_metadata.rb +14 -1
- data/lib/docusign_esign/models/tabs.rb +2 -0
- data/lib/docusign_esign/models/template_document_visibility_list.rb +1 -0
- data/lib/docusign_esign/models/template_notification_request.rb +2 -0
- data/lib/docusign_esign/models/template_recipients.rb +1 -0
- data/lib/docusign_esign/models/template_role.rb +4 -0
- data/lib/docusign_esign/models/template_shared_item.rb +3 -0
- data/lib/docusign_esign/models/template_summary.rb +3 -0
- data/lib/docusign_esign/models/template_tabs.rb +1 -0
- data/lib/docusign_esign/models/template_update_summary.rb +4 -0
- data/lib/docusign_esign/models/text.rb +61 -0
- data/lib/docusign_esign/models/text_custom_field.rb +2 -0
- data/lib/docusign_esign/models/title.rb +52 -0
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +12 -0
- data/lib/docusign_esign/models/user_info.rb +1 -0
- data/lib/docusign_esign/models/user_information.rb +6 -0
- data/lib/docusign_esign/models/user_information_list.rb +1 -0
- data/lib/docusign_esign/models/user_password_information.rb +1 -0
- data/lib/docusign_esign/models/user_password_rules.rb +2 -0
- data/lib/docusign_esign/models/user_profile.rb +3 -0
- data/lib/docusign_esign/models/user_settings_information.rb +61 -0
- data/lib/docusign_esign/models/user_shared_item.rb +3 -0
- data/lib/docusign_esign/models/user_signature.rb +2 -0
- data/lib/docusign_esign/models/user_signature_definition.rb +1 -0
- data/lib/docusign_esign/models/view.rb +46 -0
- data/lib/docusign_esign/models/witness.rb +30 -0
- data/lib/docusign_esign/models/workflow.rb +2 -0
- data/lib/docusign_esign/models/workflow_step.rb +3 -0
- data/lib/docusign_esign/models/workspace.rb +4 -0
- data/lib/docusign_esign/models/workspace_folder_contents.rb +1 -0
- data/lib/docusign_esign/models/workspace_item.rb +5 -0
- data/lib/docusign_esign/models/workspace_settings.rb +1 -0
- data/lib/docusign_esign/models/workspace_user.rb +1 -0
- data/lib/docusign_esign/models/workspace_user_authorization.rb +2 -0
- data/lib/docusign_esign/models/zip.rb +60 -0
- data/lib/docusign_esign/version.rb +1 -1
- data/lib/docusign_esign.rb +1 -0
- metadata +7 -6
@@ -20,6 +20,7 @@ module DocuSign_eSign
|
|
20
20
|
# The last position in the result set.
|
21
21
|
attr_accessor :end_position
|
22
22
|
|
23
|
+
# A complex type containing an errorCode and message identifying the error that occurred.
|
23
24
|
attr_accessor :error_details
|
24
25
|
|
25
26
|
# The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.
|
@@ -22,11 +22,13 @@ module DocuSign_eSign
|
|
22
22
|
#
|
23
23
|
attr_accessor :custom_field
|
24
24
|
|
25
|
+
# Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle.
|
25
26
|
attr_accessor :date_stamp_properties
|
26
27
|
|
27
28
|
#
|
28
29
|
attr_accessor :disallow_user_resize_stamp
|
29
30
|
|
31
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
30
32
|
attr_accessor :error_details
|
31
33
|
|
32
34
|
#
|
@@ -13,6 +13,7 @@ require 'date'
|
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
15
|
class AccountSignatureDefinition
|
16
|
+
# Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle.
|
16
17
|
attr_accessor :date_stamp_properties
|
17
18
|
|
18
19
|
#
|
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# Contains information abotu the signature provider associated with the Identity Verification workflow. If empty, then this specific workflow is not intended for signers.
|
15
16
|
class AccountSignatureProvider
|
16
17
|
#
|
17
18
|
attr_accessor :is_required
|
@@ -12,29 +12,36 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# An object that defines the options that are available to non-administrators in the UI.
|
15
16
|
class AccountUISettings
|
17
|
+
#
|
16
18
|
attr_accessor :admin_message
|
17
19
|
|
20
|
+
#
|
18
21
|
attr_accessor :ask_an_admin
|
19
22
|
|
20
23
|
#
|
21
24
|
attr_accessor :enable_admin_message
|
22
25
|
|
26
|
+
#
|
23
27
|
attr_accessor :enable_admin_message_metadata
|
24
28
|
|
25
29
|
#
|
26
30
|
attr_accessor :enable_easy_sign_can_use_multi_template_apply
|
27
31
|
|
32
|
+
#
|
28
33
|
attr_accessor :enable_easy_sign_can_use_multi_template_apply_metadata
|
29
34
|
|
30
35
|
#
|
31
36
|
attr_accessor :enable_easy_sign_template_upload
|
32
37
|
|
38
|
+
#
|
33
39
|
attr_accessor :enable_easy_sign_template_upload_metadata
|
34
40
|
|
35
41
|
#
|
36
42
|
attr_accessor :enable_envelope_copy_with_data
|
37
43
|
|
44
|
+
#
|
38
45
|
attr_accessor :enable_envelope_copy_with_data_metadata
|
39
46
|
|
40
47
|
#
|
@@ -45,11 +52,13 @@ module DocuSign_eSign
|
|
45
52
|
#
|
46
53
|
attr_accessor :has_external_linked_accounts
|
47
54
|
|
55
|
+
#
|
48
56
|
attr_accessor :has_external_linked_accounts_metadata
|
49
57
|
|
50
58
|
#
|
51
59
|
attr_accessor :hide_send_an_envelope
|
52
60
|
|
61
|
+
#
|
53
62
|
attr_accessor :hide_send_an_envelope_metadata
|
54
63
|
|
55
64
|
#
|
@@ -58,28 +67,34 @@ module DocuSign_eSign
|
|
58
67
|
#
|
59
68
|
attr_accessor :hide_use_a_template_in_prepare
|
60
69
|
|
70
|
+
#
|
61
71
|
attr_accessor :hide_use_a_template_in_prepare_metadata
|
62
72
|
|
73
|
+
#
|
63
74
|
attr_accessor :hide_use_a_template_metadata
|
64
75
|
|
65
76
|
#
|
66
77
|
attr_accessor :order_based_recipient_id_generation
|
67
78
|
|
79
|
+
#
|
68
80
|
attr_accessor :order_based_recipient_id_generation_metadata
|
69
81
|
|
70
82
|
#
|
71
83
|
attr_accessor :remove_envelope_forwarding
|
72
84
|
|
85
|
+
#
|
73
86
|
attr_accessor :remove_envelope_forwarding_metadata
|
74
87
|
|
75
88
|
#
|
76
89
|
attr_accessor :should_redact_access_code
|
77
90
|
|
91
|
+
#
|
78
92
|
attr_accessor :should_redact_access_code_metadata
|
79
93
|
|
80
94
|
#
|
81
95
|
attr_accessor :upload_new_image_to_sign_or_initial
|
82
96
|
|
97
|
+
#
|
83
98
|
attr_accessor :upload_new_image_to_sign_or_initial_metadata
|
84
99
|
|
85
100
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -14,6 +14,7 @@ require 'date'
|
|
14
14
|
module DocuSign_eSign
|
15
15
|
# Contains address input information.
|
16
16
|
class AddressInformationInput
|
17
|
+
# A complex type that contains the following information for the new account: `address1`, `address2`, `city`, `country`, `fax`, `phone`, `postalCode` and `stateOrProvince`. The maximum characters for the strings are: * `address1`, `address2`, `city`, `country` and `stateOrProvince`: 100 characters * `postalCode`, `phone`, and `fax`: 20 characters **Note:** If country is US (United States), `stateOrProvince` codes are validated. Otherwise, `stateOrProvince` is treated as a non-validated string used to specify a state, province, or region.
|
17
18
|
attr_accessor :address_information
|
18
19
|
|
19
20
|
# Specifies the display level for the recipient. Valid values are: * ReadOnly * Editable * DoNotDisplay
|
@@ -17,6 +17,7 @@ module DocuSign_eSign
|
|
17
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.
|
18
18
|
attr_accessor :access_code
|
19
19
|
|
20
|
+
# Metadata that indicates whether the `accessCode` property is editable. This property is read-only.
|
20
21
|
attr_accessor :access_code_metadata
|
21
22
|
|
22
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.
|
@@ -55,6 +56,7 @@ module DocuSign_eSign
|
|
55
56
|
# Reserved: For DocuSign use only.
|
56
57
|
attr_accessor :delivery_method
|
57
58
|
|
59
|
+
# Reserved for DocuSign.
|
58
60
|
attr_accessor :delivery_method_metadata
|
59
61
|
|
60
62
|
#
|
@@ -69,8 +71,10 @@ module DocuSign_eSign
|
|
69
71
|
# Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters.
|
70
72
|
attr_accessor :email
|
71
73
|
|
74
|
+
# Metadata that indicates whether the `email` property is editable. This property is read-only.
|
72
75
|
attr_accessor :email_metadata
|
73
76
|
|
77
|
+
# An optional complex type that sets a specific email subject and body for this recipient's notification email. **Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`.
|
74
78
|
attr_accessor :email_notification
|
75
79
|
|
76
80
|
#
|
@@ -79,6 +83,7 @@ module DocuSign_eSign
|
|
79
83
|
# Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
|
80
84
|
attr_accessor :embedded_recipient_start_url
|
81
85
|
|
86
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
82
87
|
attr_accessor :error_details
|
83
88
|
|
84
89
|
# Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.
|
@@ -87,25 +92,31 @@ module DocuSign_eSign
|
|
87
92
|
# Reserved:
|
88
93
|
attr_accessor :fax_number
|
89
94
|
|
95
|
+
# Reserved for DocuSign.
|
90
96
|
attr_accessor :fax_number_metadata
|
91
97
|
|
92
98
|
# The user's first name. Maximum Length: 50 characters.
|
93
99
|
attr_accessor :first_name
|
94
100
|
|
101
|
+
# Metadata that indicates whether the `firstName` property is editable. This property is read-only.
|
95
102
|
attr_accessor :first_name_metadata
|
96
103
|
|
97
104
|
#
|
98
105
|
attr_accessor :full_name
|
99
106
|
|
107
|
+
# Reserved for DocuSign.
|
100
108
|
attr_accessor :full_name_metadata
|
101
109
|
|
102
110
|
# Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node.
|
103
111
|
attr_accessor :id_check_configuration_name
|
104
112
|
|
113
|
+
# Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only.
|
105
114
|
attr_accessor :id_check_configuration_name_metadata
|
106
115
|
|
116
|
+
# An object that contains input information related to a recipient ID check.
|
107
117
|
attr_accessor :id_check_information_input
|
108
118
|
|
119
|
+
# Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).
|
109
120
|
attr_accessor :identity_verification
|
110
121
|
|
111
122
|
# When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
|
@@ -114,6 +125,7 @@ module DocuSign_eSign
|
|
114
125
|
#
|
115
126
|
attr_accessor :last_name
|
116
127
|
|
128
|
+
# Metadata that indicates whether the `lastName` property is editable. This property is read-only.
|
117
129
|
attr_accessor :last_name_metadata
|
118
130
|
|
119
131
|
#
|
@@ -125,20 +137,25 @@ module DocuSign_eSign
|
|
125
137
|
#
|
126
138
|
attr_accessor :name
|
127
139
|
|
140
|
+
# Metadata that indicates whether the `name` property is editable. This property is read-only.
|
128
141
|
attr_accessor :name_metadata
|
129
142
|
|
130
143
|
# Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.
|
131
144
|
attr_accessor :note
|
132
145
|
|
146
|
+
# Metadata that indicates whether the `note` property is editable. This property is read-only.
|
133
147
|
attr_accessor :note_metadata
|
134
148
|
|
149
|
+
# When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign.
|
135
150
|
attr_accessor :phone_authentication
|
136
151
|
|
152
|
+
# Describes the recipient phone number.
|
137
153
|
attr_accessor :phone_number
|
138
154
|
|
139
155
|
# Reserved:
|
140
156
|
attr_accessor :recipient_attachments
|
141
157
|
|
158
|
+
# Information about the recipient's authentication status. This property is read-only.
|
142
159
|
attr_accessor :recipient_authentication_status
|
143
160
|
|
144
161
|
#
|
@@ -153,11 +170,13 @@ module DocuSign_eSign
|
|
153
170
|
#
|
154
171
|
attr_accessor :recipient_type
|
155
172
|
|
173
|
+
# Metadata that indicates whether the `recipientType` property is editable. This property is read-only.
|
156
174
|
attr_accessor :recipient_type_metadata
|
157
175
|
|
158
176
|
# When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
|
159
177
|
attr_accessor :require_id_lookup
|
160
178
|
|
179
|
+
# Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only.
|
161
180
|
attr_accessor :require_id_lookup_metadata
|
162
181
|
|
163
182
|
# Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.
|
@@ -166,6 +185,7 @@ module DocuSign_eSign
|
|
166
185
|
# Specifies the routing order of the recipient in the envelope.
|
167
186
|
attr_accessor :routing_order
|
168
187
|
|
188
|
+
# Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.
|
169
189
|
attr_accessor :routing_order_metadata
|
170
190
|
|
171
191
|
# The date and time the envelope was sent.
|
@@ -177,6 +197,7 @@ module DocuSign_eSign
|
|
177
197
|
# When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
|
178
198
|
attr_accessor :signing_group_id
|
179
199
|
|
200
|
+
# Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only.
|
180
201
|
attr_accessor :signing_group_id_metadata
|
181
202
|
|
182
203
|
# The display name for the signing group. Maximum Length: 100 characters.
|
@@ -185,6 +206,7 @@ module DocuSign_eSign
|
|
185
206
|
# A complex type that contains information about users in the signing group.
|
186
207
|
attr_accessor :signing_group_users
|
187
208
|
|
209
|
+
# When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication.
|
188
210
|
attr_accessor :sms_authentication
|
189
211
|
|
190
212
|
# Lists the social ID type that can be used for recipient authentication.
|
@@ -12,65 +12,78 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# A tab that allows the recipient to approve documents without placing a signature or initials on the document.
|
15
16
|
class Approve
|
16
17
|
#
|
17
18
|
attr_accessor :anchor_allow_white_space_in_characters
|
18
19
|
|
20
|
+
# Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.
|
19
21
|
attr_accessor :anchor_allow_white_space_in_characters_metadata
|
20
22
|
|
21
23
|
# When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
|
22
24
|
attr_accessor :anchor_case_sensitive
|
23
25
|
|
26
|
+
# Metadata that indicates whether the `anchorCaseSensitive` property is editable.
|
24
27
|
attr_accessor :anchor_case_sensitive_metadata
|
25
28
|
|
26
29
|
# Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
|
27
30
|
attr_accessor :anchor_horizontal_alignment
|
28
31
|
|
32
|
+
# Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
|
29
33
|
attr_accessor :anchor_horizontal_alignment_metadata
|
30
34
|
|
31
35
|
# When set to **true**, this tab is ignored if anchorString is not found in the document.
|
32
36
|
attr_accessor :anchor_ignore_if_not_present
|
33
37
|
|
38
|
+
# Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.
|
34
39
|
attr_accessor :anchor_ignore_if_not_present_metadata
|
35
40
|
|
36
41
|
# When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.
|
37
42
|
attr_accessor :anchor_match_whole_word
|
38
43
|
|
44
|
+
# Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
|
39
45
|
attr_accessor :anchor_match_whole_word_metadata
|
40
46
|
|
41
47
|
# Anchor text information for a radio button.
|
42
48
|
attr_accessor :anchor_string
|
43
49
|
|
50
|
+
# Metadata that indicates whether the `anchorString` property is editable.
|
44
51
|
attr_accessor :anchor_string_metadata
|
45
52
|
|
46
53
|
#
|
47
54
|
attr_accessor :anchor_tab_processor_version
|
48
55
|
|
56
|
+
# Reserved for DocuSign.
|
49
57
|
attr_accessor :anchor_tab_processor_version_metadata
|
50
58
|
|
51
59
|
# Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
|
52
60
|
attr_accessor :anchor_units
|
53
61
|
|
62
|
+
# Metadata that indicates whether the `anchorUnits` property is editable.
|
54
63
|
attr_accessor :anchor_units_metadata
|
55
64
|
|
56
65
|
# Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
|
57
66
|
attr_accessor :anchor_x_offset
|
58
67
|
|
68
|
+
# Metadata that indicates whether the `anchorXOffset` property is editable.
|
59
69
|
attr_accessor :anchor_x_offset_metadata
|
60
70
|
|
61
71
|
# Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
|
62
72
|
attr_accessor :anchor_y_offset
|
63
73
|
|
74
|
+
# Metadata that indicates whether the `anchorYOffset` property is editable.
|
64
75
|
attr_accessor :anchor_y_offset_metadata
|
65
76
|
|
66
77
|
# When set to **true**, the information in the tab is bold.
|
67
78
|
attr_accessor :bold
|
68
79
|
|
80
|
+
# Metadata that indicates whether the `bold` property is editable.
|
69
81
|
attr_accessor :bold_metadata
|
70
82
|
|
71
83
|
# Specifies the approval text displayed in the tab.
|
72
84
|
attr_accessor :button_text
|
73
85
|
|
86
|
+
# Metadata that indicates whether the `buttonText` property is editable.
|
74
87
|
attr_accessor :button_text_metadata
|
75
88
|
|
76
89
|
#
|
@@ -81,23 +94,28 @@ module DocuSign_eSign
|
|
81
94
|
# For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
|
82
95
|
attr_accessor :conditional_parent_label
|
83
96
|
|
97
|
+
# Metadata that indicates whether the `conditionalParentLabel` property is editable.
|
84
98
|
attr_accessor :conditional_parent_label_metadata
|
85
99
|
|
86
100
|
# For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.
|
87
101
|
attr_accessor :conditional_parent_value
|
88
102
|
|
103
|
+
# Metadata that indicates whether the `conditionalParentValue` property is editable.
|
89
104
|
attr_accessor :conditional_parent_value_metadata
|
90
105
|
|
91
106
|
# The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
|
92
107
|
attr_accessor :custom_tab_id
|
93
108
|
|
109
|
+
# Metadata that indicates whether the `customTabId` property is editable.
|
94
110
|
attr_accessor :custom_tab_id_metadata
|
95
111
|
|
96
112
|
# Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
|
97
113
|
attr_accessor :document_id
|
98
114
|
|
115
|
+
# Metadata that indicates whether the `documentId` property is editable.
|
99
116
|
attr_accessor :document_id_metadata
|
100
117
|
|
118
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
101
119
|
attr_accessor :error_details
|
102
120
|
|
103
121
|
# The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
|
@@ -106,42 +124,52 @@ module DocuSign_eSign
|
|
106
124
|
# The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
|
107
125
|
attr_accessor :font_color
|
108
126
|
|
127
|
+
# Metadata that indicates whether the `fontColor` property is editable.
|
109
128
|
attr_accessor :font_color_metadata
|
110
129
|
|
130
|
+
# Metadata that indicates whether the `font` property is editable.
|
111
131
|
attr_accessor :font_metadata
|
112
132
|
|
113
133
|
# The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.
|
114
134
|
attr_accessor :font_size
|
115
135
|
|
136
|
+
# Metadata that indicates whether the `fontSize` property is editable.
|
116
137
|
attr_accessor :font_size_metadata
|
117
138
|
|
118
139
|
#
|
119
140
|
attr_accessor :form_order
|
120
141
|
|
142
|
+
# Metadata that indicates whether the `formOrder` property is editable.
|
121
143
|
attr_accessor :form_order_metadata
|
122
144
|
|
123
145
|
#
|
124
146
|
attr_accessor :form_page_label
|
125
147
|
|
148
|
+
# Metadata that indicates whether the `formPageLabel` property is editable.
|
126
149
|
attr_accessor :form_page_label_metadata
|
127
150
|
|
128
151
|
#
|
129
152
|
attr_accessor :form_page_number
|
130
153
|
|
154
|
+
# Metadata that indicates whether the `fromPageNumber` property is editable.
|
131
155
|
attr_accessor :form_page_number_metadata
|
132
156
|
|
133
157
|
# Height of the tab in pixels.
|
134
158
|
attr_accessor :height
|
135
159
|
|
160
|
+
# Metadata that indicates whether the `height` property is editable.
|
136
161
|
attr_accessor :height_metadata
|
137
162
|
|
138
163
|
# When set to **true**, the information in the tab is italic.
|
139
164
|
attr_accessor :italic
|
140
165
|
|
166
|
+
# Metadata that indicates whether the `italic` property is editable.
|
141
167
|
attr_accessor :italic_metadata
|
142
168
|
|
169
|
+
# Reserved for DocuSign.
|
143
170
|
attr_accessor :locale_policy
|
144
171
|
|
172
|
+
# Contains the information necessary to map the tab to a field in SalesForce.
|
145
173
|
attr_accessor :merge_field
|
146
174
|
|
147
175
|
#
|
@@ -150,6 +178,7 @@ module DocuSign_eSign
|
|
150
178
|
# Specifies the page number on which the tab is located.
|
151
179
|
attr_accessor :page_number
|
152
180
|
|
181
|
+
# Metadata that indicates whether the `pageNumber` property is editable.
|
153
182
|
attr_accessor :page_number_metadata
|
154
183
|
|
155
184
|
# Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
|
@@ -158,10 +187,13 @@ module DocuSign_eSign
|
|
158
187
|
#
|
159
188
|
attr_accessor :recipient_id_guid
|
160
189
|
|
190
|
+
# Metadata that indicates whether the `recipientIdGuid` property is editable.
|
161
191
|
attr_accessor :recipient_id_guid_metadata
|
162
192
|
|
193
|
+
# Metadata that indicates whether the `recipientId` property is editable.
|
163
194
|
attr_accessor :recipient_id_metadata
|
164
195
|
|
196
|
+
# Reserved for DocuSign.
|
165
197
|
attr_accessor :smart_contract_information
|
166
198
|
|
167
199
|
#
|
@@ -170,66 +202,79 @@ module DocuSign_eSign
|
|
170
202
|
# Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
|
171
203
|
attr_accessor :status
|
172
204
|
|
205
|
+
# Metadata that indicates whether the `status` property is editable.
|
173
206
|
attr_accessor :status_metadata
|
174
207
|
|
175
208
|
#
|
176
209
|
attr_accessor :tab_group_labels
|
177
210
|
|
211
|
+
# Metadata that indicates whether the `tabGroupLabels` property is editable.
|
178
212
|
attr_accessor :tab_group_labels_metadata
|
179
213
|
|
180
214
|
# The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
|
181
215
|
attr_accessor :tab_id
|
182
216
|
|
217
|
+
# Metadata that indicates whether the `tabId` property is editable.
|
183
218
|
attr_accessor :tab_id_metadata
|
184
219
|
|
185
220
|
# The label string associated with the tab.
|
186
221
|
attr_accessor :tab_label
|
187
222
|
|
223
|
+
# Metadata that indicates whether the `tabLabel` property is editable.
|
188
224
|
attr_accessor :tab_label_metadata
|
189
225
|
|
190
226
|
#
|
191
227
|
attr_accessor :tab_order
|
192
228
|
|
229
|
+
# Metadata that indicates whether the `tabOrder` property is editable.
|
193
230
|
attr_accessor :tab_order_metadata
|
194
231
|
|
195
232
|
#
|
196
233
|
attr_accessor :tab_type
|
197
234
|
|
235
|
+
# Metadata that indicates whether the `tabType` property is editable.
|
198
236
|
attr_accessor :tab_type_metadata
|
199
237
|
|
200
238
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
201
239
|
attr_accessor :template_locked
|
202
240
|
|
241
|
+
# Metadata that indicates whether the `templateLocked` property is editable.
|
203
242
|
attr_accessor :template_locked_metadata
|
204
243
|
|
205
244
|
# When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
|
206
245
|
attr_accessor :template_required
|
207
246
|
|
247
|
+
# Metadata that indicates whether the `templateRequired` property is editable.
|
208
248
|
attr_accessor :template_required_metadata
|
209
249
|
|
210
250
|
#
|
211
251
|
attr_accessor :tooltip
|
212
252
|
|
253
|
+
# Metadata that indicates whether the `toolTip` property is editable.
|
213
254
|
attr_accessor :tool_tip_metadata
|
214
255
|
|
215
256
|
# When set to **true**, the information in the tab is underlined.
|
216
257
|
attr_accessor :underline
|
217
258
|
|
259
|
+
# Metadata that indicates whether the `underline` property is editable.
|
218
260
|
attr_accessor :underline_metadata
|
219
261
|
|
220
262
|
# Width of the tab in pixels.
|
221
263
|
attr_accessor :width
|
222
264
|
|
265
|
+
# Metadata that indicates whether the `width` property is editable.
|
223
266
|
attr_accessor :width_metadata
|
224
267
|
|
225
268
|
# This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
226
269
|
attr_accessor :x_position
|
227
270
|
|
271
|
+
# Metadata that indicates whether the `xPosition` property is editable.
|
228
272
|
attr_accessor :x_position_metadata
|
229
273
|
|
230
274
|
# This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
231
275
|
attr_accessor :y_position
|
232
276
|
|
277
|
+
# Metadata that indicates whether the `yPosition` property is editable.
|
233
278
|
attr_accessor :y_position_metadata
|
234
279
|
|
235
280
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -14,42 +14,61 @@ require 'date'
|
|
14
14
|
module DocuSign_eSign
|
15
15
|
# Contains information about the authentication status.
|
16
16
|
class AuthenticationStatus
|
17
|
+
# The result of a user's attempt to authenticate by using an access code. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
|
17
18
|
attr_accessor :access_code_result
|
18
19
|
|
20
|
+
# The result of an age verification check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
|
19
21
|
attr_accessor :age_verify_result
|
20
22
|
|
23
|
+
# Deprecated.
|
21
24
|
attr_accessor :any_social_id_result
|
22
25
|
|
26
|
+
# Deprecated.
|
23
27
|
attr_accessor :facebook_result
|
24
28
|
|
29
|
+
# Deprecated.
|
25
30
|
attr_accessor :google_result
|
26
31
|
|
32
|
+
# The result of an [Identity Verification][IDV] workflow. [IDV]: /docs/esign-rest-api/reference/accounts/identityverifications/
|
27
33
|
attr_accessor :identity_verification_result
|
28
34
|
|
35
|
+
# The result of an ID lookup authentication check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
|
29
36
|
attr_accessor :id_lookup_result
|
30
37
|
|
38
|
+
# The result of the user's answers to ID challenge questions. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
|
31
39
|
attr_accessor :id_questions_result
|
32
40
|
|
41
|
+
# Deprecated.
|
33
42
|
attr_accessor :linkedin_result
|
34
43
|
|
44
|
+
# Deprecated.
|
35
45
|
attr_accessor :live_id_result
|
36
46
|
|
47
|
+
# The result of an Office of Foreign Asset Control (OFAC) check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
|
37
48
|
attr_accessor :ofac_result
|
38
49
|
|
50
|
+
# Deprecated.
|
39
51
|
attr_accessor :open_id_result
|
40
52
|
|
53
|
+
# The result of the user's attempt to authenticate by using two-factor authentication (2FA) through phone messaging. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
|
41
54
|
attr_accessor :phone_auth_result
|
42
55
|
|
56
|
+
# Success/failure result of authentication using sign-in with a Salesforce account. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
|
43
57
|
attr_accessor :salesforce_result
|
44
58
|
|
59
|
+
# The result of the user's attempt to authenticate by using a signature provider.
|
45
60
|
attr_accessor :signature_provider_result
|
46
61
|
|
62
|
+
# The result of the user's attempt to authenticate by using two-factor authentication (2FA) through SMS messaging on a mobile phone.
|
47
63
|
attr_accessor :sms_auth_result
|
48
64
|
|
65
|
+
# The result of a Student Authentication Network (STAN) authentication check. It returns: - `Status`: `Pass` or `Fail`. - `dateTime`: The date and time that the event occurred. - `FailureDescription`: A string containing the details about a failed authentication. - `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
|
49
66
|
attr_accessor :s_tan_pin_result
|
50
67
|
|
68
|
+
# Deprecated.
|
51
69
|
attr_accessor :twitter_result
|
52
70
|
|
71
|
+
# Deprecated.
|
53
72
|
attr_accessor :yahoo_result
|
54
73
|
|
55
74
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# This object contains information abut a BCC email archive configuration (a BCC email address used to archive DocuSign-generated emails).
|
15
16
|
class BccEmailArchive
|
16
17
|
# The account ID associated with the envelope.
|
17
18
|
attr_accessor :account_id
|
@@ -22,6 +23,7 @@ module DocuSign_eSign
|
|
22
23
|
#
|
23
24
|
attr_accessor :created
|
24
25
|
|
26
|
+
# Details about the user who created the BCC email archive configuration.
|
25
27
|
attr_accessor :created_by
|
26
28
|
|
27
29
|
#
|
@@ -33,6 +35,7 @@ module DocuSign_eSign
|
|
33
35
|
#
|
34
36
|
attr_accessor :modified
|
35
37
|
|
38
|
+
# Details about the user who last modified the BCC email archive configuration.
|
36
39
|
attr_accessor :modified_by
|
37
40
|
|
38
41
|
# Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
|
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# Contains details about the history of the BCC email archive configuration.
|
15
16
|
class BccEmailArchiveHistory
|
16
17
|
# The account ID associated with the envelope.
|
17
18
|
attr_accessor :account_id
|
@@ -25,6 +26,7 @@ module DocuSign_eSign
|
|
25
26
|
#
|
26
27
|
attr_accessor :modified
|
27
28
|
|
29
|
+
# Details about the user who last modified the BCC email archive configuration.
|
28
30
|
attr_accessor :modified_by
|
29
31
|
|
30
32
|
# Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
|