docusign_esign 3.17.0 → 3.19.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/lib/docusign_esign/api/accounts_api.rb +60 -60
- data/lib/docusign_esign/api/billing_api.rb +2 -2
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +22 -22
- data/lib/docusign_esign/api/connect_api.rb +148 -0
- data/lib/docusign_esign/api/email_archive_api.rb +8 -8
- data/lib/docusign_esign/api/envelopes_api.rb +1353 -184
- data/lib/docusign_esign/api/notary_api.rb +16 -16
- data/lib/docusign_esign/api/power_forms_api.rb +24 -16
- data/lib/docusign_esign/api/templates_api.rb +20 -20
- data/lib/docusign_esign/api/users_api.rb +14 -14
- data/lib/docusign_esign/api/workspaces_api.rb +4 -4
- data/lib/docusign_esign/client/api_client.rb +1 -1
- data/lib/docusign_esign/models/access_code_format.rb +6 -0
- data/lib/docusign_esign/models/account_billing_plan.rb +1 -0
- data/lib/docusign_esign/models/account_billing_plan_response.rb +9 -0
- data/lib/docusign_esign/models/account_identity_verification_step.rb +1 -0
- data/lib/docusign_esign/models/account_identity_verification_workflow.rb +2 -0
- data/lib/docusign_esign/models/account_information.rb +11 -1
- data/lib/docusign_esign/models/account_notification.rb +3 -0
- data/lib/docusign_esign/models/account_password_questions_required.rb +1 -0
- data/lib/docusign_esign/models/account_password_rules.rb +7 -0
- data/lib/docusign_esign/models/account_role_settings.rb +39 -0
- data/lib/docusign_esign/models/account_settings_information.rb +611 -1
- data/lib/docusign_esign/models/account_shared_access.rb +1 -0
- data/lib/docusign_esign/models/account_signature.rb +2 -0
- data/lib/docusign_esign/models/account_signature_definition.rb +1 -0
- data/lib/docusign_esign/models/account_signature_provider.rb +1 -0
- data/lib/docusign_esign/models/account_signature_provider_option.rb +1 -0
- data/lib/docusign_esign/models/account_ui_settings.rb +15 -0
- data/lib/docusign_esign/models/address_information_input.rb +1 -0
- data/lib/docusign_esign/models/agent.rb +35 -1
- data/lib/docusign_esign/models/approve.rb +45 -0
- data/lib/docusign_esign/models/authentication_status.rb +19 -0
- data/lib/docusign_esign/models/bcc_email_archive.rb +3 -0
- data/lib/docusign_esign/models/bcc_email_archive_history.rb +2 -0
- data/lib/docusign_esign/models/bcc_email_archive_list.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_information.rb +19 -1
- data/lib/docusign_esign/models/billing_plan_preview.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_response.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_update_response.rb +1 -0
- data/lib/docusign_esign/models/brand.rb +4 -0
- data/lib/docusign_esign/models/brand_email_content.rb +1 -0
- data/lib/docusign_esign/models/brand_link.rb +1 -0
- data/lib/docusign_esign/models/brand_logos.rb +1 -0
- data/lib/docusign_esign/models/brand_request.rb +1 -0
- data/lib/docusign_esign/models/brand_resource_urls.rb +1 -0
- data/lib/docusign_esign/models/brand_resources.rb +3 -0
- data/lib/docusign_esign/models/brands_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_envelope.rb +1 -0
- data/lib/docusign_esign/models/bulk_recipients_update_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_action_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_status.rb +2 -0
- data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_summary.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_error_status.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_test_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +5 -0
- data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list_summary.rb +1 -0
- data/lib/docusign_esign/models/captive_recipient.rb +2 -0
- data/lib/docusign_esign/models/captive_recipient_information.rb +1 -0
- data/lib/docusign_esign/models/carbon_copy.rb +38 -1
- data/lib/docusign_esign/models/certified_delivery.rb +37 -1
- data/lib/docusign_esign/models/checkbox.rb +52 -39
- data/lib/docusign_esign/models/chunked_upload_part.rb +1 -0
- data/lib/docusign_esign/models/chunked_upload_request.rb +1 -0
- data/lib/docusign_esign/models/chunked_upload_response.rb +1 -0
- data/lib/docusign_esign/models/cloud_storage_provider.rb +2 -0
- data/lib/docusign_esign/models/comment_thread.rb +43 -0
- data/lib/docusign_esign/models/commission_county.rb +52 -0
- data/lib/docusign_esign/models/commission_expiration.rb +52 -0
- data/lib/docusign_esign/models/commission_number.rb +52 -0
- data/lib/docusign_esign/models/commission_state.rb +52 -0
- data/lib/docusign_esign/models/company.rb +52 -0
- data/lib/docusign_esign/models/composite_template.rb +2 -0
- data/lib/docusign_esign/models/conditional_recipient_rule.rb +2 -0
- data/lib/docusign_esign/models/connect_config_results.rb +1 -0
- data/lib/docusign_esign/models/connect_custom_configuration.rb +13 -1
- data/lib/docusign_esign/models/connect_debug_log.rb +1 -0
- data/lib/docusign_esign/models/connect_event_data.rb +1 -0
- data/lib/docusign_esign/models/connect_failure_filter.rb +1 -0
- data/lib/docusign_esign/models/connect_failure_result.rb +1 -0
- data/lib/docusign_esign/models/connect_historical_envelope_republish.rb +195 -0
- data/lib/docusign_esign/models/connect_log.rb +1 -0
- data/lib/docusign_esign/models/connect_o_auth_config.rb +214 -0
- data/lib/docusign_esign/models/connect_salesforce_field.rb +1 -0
- data/lib/docusign_esign/models/connect_salesforce_object.rb +1 -0
- data/lib/docusign_esign/models/consent_details.rb +204 -0
- data/lib/docusign_esign/models/console_view_request.rb +1 -0
- data/lib/docusign_esign/models/consumer_disclosure.rb +3 -0
- data/lib/docusign_esign/models/contact.rb +1 -0
- data/lib/docusign_esign/models/contact_get_response.rb +1 -0
- data/lib/docusign_esign/models/contact_mod_request.rb +1 -0
- data/lib/docusign_esign/models/contact_phone_number.rb +1 -0
- data/lib/docusign_esign/models/contact_update_response.rb +1 -0
- data/lib/docusign_esign/models/correct_view_request.rb +12 -1
- data/lib/docusign_esign/models/credit_card_information.rb +2 -0
- data/lib/docusign_esign/models/currency.rb +55 -0
- data/lib/docusign_esign/models/currency_feature_set_price.rb +1 -0
- data/lib/docusign_esign/models/currency_plan_price.rb +1 -0
- data/lib/docusign_esign/models/custom_field.rb +2 -0
- data/lib/docusign_esign/models/date.rb +59 -0
- data/lib/docusign_esign/models/date_signed.rb +46 -0
- data/lib/docusign_esign/models/date_stamp_properties.rb +1 -0
- data/lib/docusign_esign/models/decline.rb +46 -0
- data/lib/docusign_esign/models/direct_debit_processor_information.rb +1 -0
- data/lib/docusign_esign/models/document.rb +3 -0
- data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +1 -0
- data/lib/docusign_esign/models/document_html_definition.rb +1 -0
- data/lib/docusign_esign/models/document_html_definition_original.rb +1 -0
- data/lib/docusign_esign/models/document_html_display_anchor.rb +1 -0
- data/lib/docusign_esign/models/document_html_display_settings.rb +1 -0
- data/lib/docusign_esign/models/document_template.rb +1 -0
- data/lib/docusign_esign/models/document_visibility.rb +2 -0
- data/lib/docusign_esign/models/document_visibility_list.rb +1 -0
- data/lib/docusign_esign/models/downgrad_request_billing_info_response.rb +1 -0
- data/lib/docusign_esign/models/downgrade_billing_plan_information.rb +1 -0
- data/lib/docusign_esign/models/draw.rb +40 -0
- data/lib/docusign_esign/models/e_note_configuration.rb +1 -0
- data/lib/docusign_esign/models/editor.rb +36 -1
- data/lib/docusign_esign/models/email.rb +59 -0
- data/lib/docusign_esign/models/email_address.rb +46 -0
- data/lib/docusign_esign/models/envelope.rb +10 -0
- data/lib/docusign_esign/models/envelope_attachment.rb +1 -0
- data/lib/docusign_esign/models/envelope_definition.rb +13 -0
- data/lib/docusign_esign/models/envelope_document.rb +7 -0
- data/lib/docusign_esign/models/envelope_event.rb +1 -0
- data/lib/docusign_esign/models/envelope_form_data.rb +2 -0
- data/lib/docusign_esign/models/envelope_id.rb +45 -0
- data/lib/docusign_esign/models/envelope_ids_request.rb +1 -0
- data/lib/docusign_esign/models/envelope_notification_request.rb +3 -0
- data/lib/docusign_esign/models/envelope_publish_transaction.rb +307 -0
- data/lib/docusign_esign/models/envelope_publish_transaction_error_rollup.rb +194 -0
- data/lib/docusign_esign/models/envelope_purge_configuration.rb +1 -0
- data/lib/docusign_esign/models/envelope_summary.rb +3 -0
- data/lib/docusign_esign/models/envelope_template.rb +12 -0
- data/lib/docusign_esign/models/envelope_template_results.rb +1 -0
- data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -0
- data/lib/docusign_esign/models/envelope_transfer_rule.rb +6 -0
- data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +4 -0
- data/lib/docusign_esign/models/envelope_update_summary.rb +4 -0
- data/lib/docusign_esign/models/envelopes_information.rb +1 -0
- data/lib/docusign_esign/models/event_notification.rb +1 -0
- data/lib/docusign_esign/models/event_result.rb +1 -0
- data/lib/docusign_esign/models/external_document_sources.rb +6 -0
- data/lib/docusign_esign/models/external_file.rb +1 -0
- data/lib/docusign_esign/models/external_folder.rb +1 -0
- data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -0
- data/lib/docusign_esign/models/favorite_templates_info.rb +1 -0
- data/lib/docusign_esign/models/feature_set.rb +1 -0
- data/lib/docusign_esign/models/filter.rb +1 -0
- data/lib/docusign_esign/models/first_name.rb +46 -0
- data/lib/docusign_esign/models/folder.rb +4 -0
- data/lib/docusign_esign/models/folder_item_response.rb +1 -0
- data/lib/docusign_esign/models/folder_item_v2.rb +2 -0
- data/lib/docusign_esign/models/folder_shared_item.rb +3 -0
- data/lib/docusign_esign/models/folders_request.rb +1 -0
- data/lib/docusign_esign/models/form_data_item.rb +1 -0
- data/lib/docusign_esign/models/formula_tab.rb +64 -0
- data/lib/docusign_esign/models/full_name.rb +46 -0
- data/lib/docusign_esign/models/group.rb +2 -0
- data/lib/docusign_esign/models/id_check_configuration.rb +1 -0
- data/lib/docusign_esign/models/id_check_information_input.rb +4 -0
- data/lib/docusign_esign/models/in_person_signer.rb +31 -0
- data/lib/docusign_esign/models/initial_here.rb +40 -0
- data/lib/docusign_esign/models/inline_template.rb +3 -0
- data/lib/docusign_esign/models/intermediary.rb +36 -1
- data/lib/docusign_esign/models/jurisdiction.rb +1 -0
- data/lib/docusign_esign/models/last_name.rb +46 -0
- data/lib/docusign_esign/models/linked_external_primary_account.rb +1 -0
- data/lib/docusign_esign/models/list.rb +54 -0
- data/lib/docusign_esign/models/list_custom_field.rb +2 -0
- data/lib/docusign_esign/models/list_item.rb +4 -0
- data/lib/docusign_esign/models/locale_policy.rb +13 -0
- data/lib/docusign_esign/models/lock_information.rb +2 -0
- data/lib/docusign_esign/models/lock_request.rb +1 -0
- data/lib/docusign_esign/models/member_group_shared_item.rb +3 -0
- data/lib/docusign_esign/models/member_shared_items.rb +3 -0
- data/lib/docusign_esign/models/merge_field.rb +6 -0
- data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -0
- data/lib/docusign_esign/models/money.rb +1 -0
- data/lib/docusign_esign/models/name_value.rb +2 -0
- data/lib/docusign_esign/models/new_account_definition.rb +20 -1
- data/lib/docusign_esign/models/new_account_summary.rb +1 -0
- data/lib/docusign_esign/models/new_user.rb +2 -0
- data/lib/docusign_esign/models/new_users_summary.rb +1 -0
- data/lib/docusign_esign/models/notarize.rb +38 -0
- data/lib/docusign_esign/models/notary.rb +1 -0
- data/lib/docusign_esign/models/notary_host.rb +20 -0
- data/lib/docusign_esign/models/notary_journal.rb +2 -0
- data/lib/docusign_esign/models/notary_jurisdiction.rb +3 -0
- data/lib/docusign_esign/models/notary_jurisdiction_list.rb +1 -0
- data/lib/docusign_esign/models/notary_recipient.rb +52 -1
- data/lib/docusign_esign/models/notary_result.rb +2 -0
- data/lib/docusign_esign/models/notary_seal.rb +39 -0
- data/lib/docusign_esign/models/note.rb +47 -0
- data/lib/docusign_esign/models/notification.rb +2 -0
- data/lib/docusign_esign/models/notification_default_settings.rb +3 -0
- data/lib/docusign_esign/models/notification_defaults.rb +2 -0
- data/lib/docusign_esign/models/number.rb +61 -0
- data/lib/docusign_esign/models/page.rb +1 -0
- data/lib/docusign_esign/models/participant.rb +13 -1
- data/lib/docusign_esign/models/payment_details.rb +5 -0
- data/lib/docusign_esign/models/payment_gateway_account.rb +3 -0
- data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +1 -0
- data/lib/docusign_esign/models/payment_line_item.rb +1 -0
- data/lib/docusign_esign/models/payment_method_with_options.rb +1 -0
- data/lib/docusign_esign/models/payment_processor_information.rb +1 -0
- data/lib/docusign_esign/models/permission_profile.rb +2 -0
- data/lib/docusign_esign/models/permission_profile_information.rb +1 -0
- data/lib/docusign_esign/models/phone_number.rb +52 -0
- data/lib/docusign_esign/models/poly_line_overlay.rb +40 -0
- data/lib/docusign_esign/models/power_form.rb +2 -0
- data/lib/docusign_esign/models/power_form_recipient.rb +1 -0
- data/lib/docusign_esign/models/power_form_senders_response.rb +1 -0
- data/lib/docusign_esign/models/power_forms_response.rb +1 -0
- data/lib/docusign_esign/models/prefill_tabs.rb +1 -0
- data/lib/docusign_esign/models/property_metadata.rb +1 -0
- data/lib/docusign_esign/models/radio.rb +28 -0
- data/lib/docusign_esign/models/radio_group.rb +17 -0
- data/lib/docusign_esign/models/recipient_additional_notification.rb +3 -0
- data/lib/docusign_esign/models/recipient_email_notification.rb +3 -0
- data/lib/docusign_esign/models/recipient_group.rb +1 -0
- data/lib/docusign_esign/models/recipient_identity_phone_number.rb +3 -0
- data/lib/docusign_esign/models/recipient_identity_verification.rb +2 -0
- data/lib/docusign_esign/models/recipient_names_response.rb +1 -0
- data/lib/docusign_esign/models/recipient_option.rb +1 -0
- data/lib/docusign_esign/models/recipient_phone_authentication.rb +4 -0
- data/lib/docusign_esign/models/recipient_phone_number.rb +3 -0
- data/lib/docusign_esign/models/recipient_preview_request.rb +2 -0
- data/lib/docusign_esign/models/recipient_proof_file.rb +1 -0
- data/lib/docusign_esign/models/recipient_routing.rb +2 -0
- data/lib/docusign_esign/models/recipient_signature_provider.rb +3 -0
- data/lib/docusign_esign/models/recipient_signature_provider_options.rb +5 -0
- data/lib/docusign_esign/models/recipient_sms_authentication.rb +1 -0
- data/lib/docusign_esign/models/recipient_token_client_ur_ls.rb +30 -30
- data/lib/docusign_esign/models/recipient_update_response.rb +3 -0
- data/lib/docusign_esign/models/recipient_view_request.rb +2 -0
- data/lib/docusign_esign/models/recipients.rb +1 -0
- data/lib/docusign_esign/models/recipients_update_summary.rb +1 -0
- data/lib/docusign_esign/models/return_url_request.rb +1 -0
- data/lib/docusign_esign/models/scheduled_sending.rb +11 -1
- data/lib/docusign_esign/models/seal_sign.rb +17 -0
- data/lib/docusign_esign/models/seat_discount.rb +1 -0
- data/lib/docusign_esign/models/sender_company.rb +45 -0
- data/lib/docusign_esign/models/sender_email_notifications.rb +1 -0
- data/lib/docusign_esign/models/sender_name.rb +45 -0
- data/lib/docusign_esign/models/settings_metadata.rb +1 -0
- data/lib/docusign_esign/models/shared_item.rb +3 -0
- data/lib/docusign_esign/models/sign_here.rb +42 -0
- data/lib/docusign_esign/models/signature_provider_required_option.rb +1 -0
- data/lib/docusign_esign/models/signature_type.rb +1 -0
- data/lib/docusign_esign/models/signer.rb +43 -1
- data/lib/docusign_esign/models/signer_attachment.rb +40 -0
- data/lib/docusign_esign/models/signing_group.rb +2 -0
- data/lib/docusign_esign/models/signing_group_user.rb +1 -0
- data/lib/docusign_esign/models/smart_section.rb +41 -0
- data/lib/docusign_esign/models/smart_section_display_settings.rb +2 -0
- data/lib/docusign_esign/models/social_account_information.rb +1 -0
- data/lib/docusign_esign/models/ssn.rb +59 -0
- data/lib/docusign_esign/models/stamp.rb +2 -0
- data/lib/docusign_esign/models/supported_languages.rb +1 -0
- data/lib/docusign_esign/models/tab_account_settings.rb +22 -0
- data/lib/docusign_esign/models/tab_group.rb +41 -0
- data/lib/docusign_esign/models/tab_metadata.rb +14 -1
- data/lib/docusign_esign/models/tabs.rb +2 -0
- data/lib/docusign_esign/models/template_document_visibility_list.rb +1 -0
- data/lib/docusign_esign/models/template_notification_request.rb +2 -0
- data/lib/docusign_esign/models/template_recipients.rb +1 -0
- data/lib/docusign_esign/models/template_role.rb +4 -0
- data/lib/docusign_esign/models/template_shared_item.rb +3 -0
- data/lib/docusign_esign/models/template_summary.rb +3 -0
- data/lib/docusign_esign/models/template_tabs.rb +1 -0
- data/lib/docusign_esign/models/template_update_summary.rb +4 -0
- data/lib/docusign_esign/models/text.rb +61 -0
- data/lib/docusign_esign/models/text_custom_field.rb +2 -0
- data/lib/docusign_esign/models/title.rb +52 -0
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +32 -1
- data/lib/docusign_esign/models/user_info.rb +1 -0
- data/lib/docusign_esign/models/user_information.rb +6 -0
- data/lib/docusign_esign/models/user_information_list.rb +1 -0
- data/lib/docusign_esign/models/user_password_information.rb +1 -0
- data/lib/docusign_esign/models/user_password_rules.rb +2 -0
- data/lib/docusign_esign/models/user_profile.rb +3 -0
- data/lib/docusign_esign/models/user_settings_information.rb +61 -0
- data/lib/docusign_esign/models/user_shared_item.rb +3 -0
- data/lib/docusign_esign/models/user_signature.rb +2 -0
- data/lib/docusign_esign/models/user_signature_definition.rb +1 -0
- data/lib/docusign_esign/models/view.rb +46 -0
- data/lib/docusign_esign/models/witness.rb +43 -1
- data/lib/docusign_esign/models/workflow.rb +2 -0
- data/lib/docusign_esign/models/workflow_step.rb +3 -0
- data/lib/docusign_esign/models/workspace.rb +4 -0
- data/lib/docusign_esign/models/workspace_folder_contents.rb +1 -0
- data/lib/docusign_esign/models/workspace_item.rb +5 -0
- data/lib/docusign_esign/models/workspace_settings.rb +1 -0
- data/lib/docusign_esign/models/workspace_user.rb +1 -0
- data/lib/docusign_esign/models/workspace_user_authorization.rb +2 -0
- data/lib/docusign_esign/models/zip.rb +60 -0
- data/lib/docusign_esign/version.rb +1 -1
- data/lib/docusign_esign.rb +5 -0
- metadata +7 -2
@@ -12,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
|
+
# This tab is used with the Approve tab to handle supplemental documents.
|
15
16
|
class View
|
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
|
#
|
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,18 +187,22 @@ 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
|
|
165
196
|
# When set to **true**, the signer is required to fill out this tab
|
166
197
|
attr_accessor :required
|
167
198
|
|
199
|
+
# Metadata that indicates whether the `required` property is editable.
|
168
200
|
attr_accessor :required_metadata
|
169
201
|
|
170
202
|
#
|
171
203
|
attr_accessor :required_read
|
172
204
|
|
205
|
+
# Reserved for DocuSign.
|
173
206
|
attr_accessor :smart_contract_information
|
174
207
|
|
175
208
|
#
|
@@ -178,66 +211,79 @@ module DocuSign_eSign
|
|
178
211
|
# 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.
|
179
212
|
attr_accessor :status
|
180
213
|
|
214
|
+
# Metadata that indicates whether the `status` property is editable.
|
181
215
|
attr_accessor :status_metadata
|
182
216
|
|
183
217
|
#
|
184
218
|
attr_accessor :tab_group_labels
|
185
219
|
|
220
|
+
# Metadata that indicates whether the `tabGroupLabels` property is editable.
|
186
221
|
attr_accessor :tab_group_labels_metadata
|
187
222
|
|
188
223
|
# The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
|
189
224
|
attr_accessor :tab_id
|
190
225
|
|
226
|
+
# Metadata that indicates whether the `tabId` property is editable.
|
191
227
|
attr_accessor :tab_id_metadata
|
192
228
|
|
193
229
|
# The label string associated with the tab.
|
194
230
|
attr_accessor :tab_label
|
195
231
|
|
232
|
+
# Metadata that indicates whether the `tabLabel` property is editable.
|
196
233
|
attr_accessor :tab_label_metadata
|
197
234
|
|
198
235
|
#
|
199
236
|
attr_accessor :tab_order
|
200
237
|
|
238
|
+
# Metadata that indicates whether the `tabOrder` property is editable.
|
201
239
|
attr_accessor :tab_order_metadata
|
202
240
|
|
203
241
|
#
|
204
242
|
attr_accessor :tab_type
|
205
243
|
|
244
|
+
# Metadata that indicates whether the `tabType` property is editable.
|
206
245
|
attr_accessor :tab_type_metadata
|
207
246
|
|
208
247
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
209
248
|
attr_accessor :template_locked
|
210
249
|
|
250
|
+
# Metadata that indicates whether the `templateLocked` property is editable.
|
211
251
|
attr_accessor :template_locked_metadata
|
212
252
|
|
213
253
|
# When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
|
214
254
|
attr_accessor :template_required
|
215
255
|
|
256
|
+
# Metadata that indicates whether the `templateRequired` property is editable.
|
216
257
|
attr_accessor :template_required_metadata
|
217
258
|
|
218
259
|
#
|
219
260
|
attr_accessor :tooltip
|
220
261
|
|
262
|
+
# Metadata that indicates whether the `toolTip` property is editable.
|
221
263
|
attr_accessor :tool_tip_metadata
|
222
264
|
|
223
265
|
# When set to **true**, the information in the tab is underlined.
|
224
266
|
attr_accessor :underline
|
225
267
|
|
268
|
+
# Metadata that indicates whether the `underline` property is editable.
|
226
269
|
attr_accessor :underline_metadata
|
227
270
|
|
228
271
|
# Width of the tab in pixels.
|
229
272
|
attr_accessor :width
|
230
273
|
|
274
|
+
# Metadata that indicates whether the `width` property is editable.
|
231
275
|
attr_accessor :width_metadata
|
232
276
|
|
233
277
|
# This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
234
278
|
attr_accessor :x_position
|
235
279
|
|
280
|
+
# Metadata that indicates whether the `xPosition` property is editable.
|
236
281
|
attr_accessor :x_position_metadata
|
237
282
|
|
238
283
|
# This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
239
284
|
attr_accessor :y_position
|
240
285
|
|
286
|
+
# Metadata that indicates whether the `yPosition` property is editable.
|
241
287
|
attr_accessor :y_position_metadata
|
242
288
|
|
243
289
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -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
|
+
# A complex type containing information about a witness recipient. Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.
|
15
16
|
class Witness
|
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.
|
@@ -51,6 +53,9 @@ module DocuSign_eSign
|
|
51
53
|
#
|
52
54
|
attr_accessor :completed_count
|
53
55
|
|
56
|
+
#
|
57
|
+
attr_accessor :consent_details_list
|
58
|
+
|
54
59
|
#
|
55
60
|
attr_accessor :creation_reason
|
56
61
|
|
@@ -66,6 +71,7 @@ module DocuSign_eSign
|
|
66
71
|
#
|
67
72
|
attr_accessor :default_recipient
|
68
73
|
|
74
|
+
#
|
69
75
|
attr_accessor :delegated_by
|
70
76
|
|
71
77
|
#
|
@@ -77,6 +83,7 @@ module DocuSign_eSign
|
|
77
83
|
# Reserved: For DocuSign use only.
|
78
84
|
attr_accessor :delivery_method
|
79
85
|
|
86
|
+
# Reserved for DocuSign.
|
80
87
|
attr_accessor :delivery_method_metadata
|
81
88
|
|
82
89
|
#
|
@@ -91,8 +98,10 @@ module DocuSign_eSign
|
|
91
98
|
#
|
92
99
|
attr_accessor :email
|
93
100
|
|
101
|
+
# Metadata that indicates whether the `email` property is editable. This property is read-only.
|
94
102
|
attr_accessor :email_metadata
|
95
103
|
|
104
|
+
# An optional complex type that sets a specific email subject and body for this recipient's notification email. **Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`.
|
96
105
|
attr_accessor :email_notification
|
97
106
|
|
98
107
|
#
|
@@ -101,6 +110,7 @@ module DocuSign_eSign
|
|
101
110
|
# Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
|
102
111
|
attr_accessor :embedded_recipient_start_url
|
103
112
|
|
113
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
104
114
|
attr_accessor :error_details
|
105
115
|
|
106
116
|
# Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.
|
@@ -109,25 +119,31 @@ module DocuSign_eSign
|
|
109
119
|
# Reserved:
|
110
120
|
attr_accessor :fax_number
|
111
121
|
|
122
|
+
# Reserved for DocuSign.
|
112
123
|
attr_accessor :fax_number_metadata
|
113
124
|
|
114
125
|
# The user's first name. Maximum Length: 50 characters.
|
115
126
|
attr_accessor :first_name
|
116
127
|
|
128
|
+
# Metadata that indicates whether the `firstName` property is editable. This property is read-only.
|
117
129
|
attr_accessor :first_name_metadata
|
118
130
|
|
119
131
|
#
|
120
132
|
attr_accessor :full_name
|
121
133
|
|
134
|
+
# Reserved for DocuSign.
|
122
135
|
attr_accessor :full_name_metadata
|
123
136
|
|
124
137
|
# Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node.
|
125
138
|
attr_accessor :id_check_configuration_name
|
126
139
|
|
140
|
+
# Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only.
|
127
141
|
attr_accessor :id_check_configuration_name_metadata
|
128
142
|
|
143
|
+
# An object that contains input information related to a recipient ID check.
|
129
144
|
attr_accessor :id_check_information_input
|
130
145
|
|
146
|
+
# Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).
|
131
147
|
attr_accessor :identity_verification
|
132
148
|
|
133
149
|
# When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
|
@@ -136,11 +152,13 @@ module DocuSign_eSign
|
|
136
152
|
#
|
137
153
|
attr_accessor :is_bulk_recipient
|
138
154
|
|
155
|
+
# Reserved for DocuSign.
|
139
156
|
attr_accessor :is_bulk_recipient_metadata
|
140
157
|
|
141
158
|
#
|
142
159
|
attr_accessor :last_name
|
143
160
|
|
161
|
+
# Metadata that indicates whether the `lastName` property is editable. This property is read-only.
|
144
162
|
attr_accessor :last_name_metadata
|
145
163
|
|
146
164
|
#
|
@@ -152,6 +170,7 @@ module DocuSign_eSign
|
|
152
170
|
#
|
153
171
|
attr_accessor :name
|
154
172
|
|
173
|
+
# Metadata that indicates whether the `name` property is editable. This property is read-only.
|
155
174
|
attr_accessor :name_metadata
|
156
175
|
|
157
176
|
#
|
@@ -163,19 +182,25 @@ module DocuSign_eSign
|
|
163
182
|
# 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.
|
164
183
|
attr_accessor :note
|
165
184
|
|
185
|
+
# Metadata that indicates whether the `note` property is editable. This property is read-only.
|
166
186
|
attr_accessor :note_metadata
|
167
187
|
|
188
|
+
# Reserved for DocuSign.
|
168
189
|
attr_accessor :offline_attributes
|
169
190
|
|
191
|
+
# 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.
|
170
192
|
attr_accessor :phone_authentication
|
171
193
|
|
194
|
+
# Describes the recipient phone number.
|
172
195
|
attr_accessor :phone_number
|
173
196
|
|
197
|
+
# The proof file of the recipient.
|
174
198
|
attr_accessor :proof_file
|
175
199
|
|
176
200
|
# Reserved:
|
177
201
|
attr_accessor :recipient_attachments
|
178
202
|
|
203
|
+
# Information about the recipient's authentication status. This property is read-only.
|
179
204
|
attr_accessor :recipient_authentication_status
|
180
205
|
|
181
206
|
#
|
@@ -196,11 +221,13 @@ module DocuSign_eSign
|
|
196
221
|
#
|
197
222
|
attr_accessor :recipient_type
|
198
223
|
|
224
|
+
# Metadata that indicates whether the `recipientType` property is editable. This property is read-only.
|
199
225
|
attr_accessor :recipient_type_metadata
|
200
226
|
|
201
227
|
# When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
|
202
228
|
attr_accessor :require_id_lookup
|
203
229
|
|
230
|
+
# Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only.
|
204
231
|
attr_accessor :require_id_lookup_metadata
|
205
232
|
|
206
233
|
#
|
@@ -218,11 +245,13 @@ module DocuSign_eSign
|
|
218
245
|
# Specifies the routing order of the recipient in the envelope.
|
219
246
|
attr_accessor :routing_order
|
220
247
|
|
248
|
+
# Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.
|
221
249
|
attr_accessor :routing_order_metadata
|
222
250
|
|
223
251
|
# The date and time the envelope was sent.
|
224
252
|
attr_accessor :sent_date_time
|
225
253
|
|
254
|
+
# Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers.
|
226
255
|
attr_accessor :signature_info
|
227
256
|
|
228
257
|
# Reserved: For DocuSign use only.
|
@@ -231,11 +260,13 @@ module DocuSign_eSign
|
|
231
260
|
# When set to **true**, specifies that the signer must sign in all locations.
|
232
261
|
attr_accessor :sign_in_each_location
|
233
262
|
|
263
|
+
# Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only.
|
234
264
|
attr_accessor :sign_in_each_location_metadata
|
235
265
|
|
236
266
|
# 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).
|
237
267
|
attr_accessor :signing_group_id
|
238
268
|
|
269
|
+
# Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only.
|
239
270
|
attr_accessor :signing_group_id_metadata
|
240
271
|
|
241
272
|
# The display name for the signing group. Maximum Length: 100 characters.
|
@@ -244,6 +275,7 @@ module DocuSign_eSign
|
|
244
275
|
# A complex type that contains information about users in the signing group.
|
245
276
|
attr_accessor :signing_group_users
|
246
277
|
|
278
|
+
# 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.
|
247
279
|
attr_accessor :sms_authentication
|
248
280
|
|
249
281
|
# Lists the social ID type that can be used for recipient authentication.
|
@@ -258,6 +290,7 @@ module DocuSign_eSign
|
|
258
290
|
#
|
259
291
|
attr_accessor :suppress_emails
|
260
292
|
|
293
|
+
# A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.
|
261
294
|
attr_accessor :tabs
|
262
295
|
|
263
296
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
@@ -294,6 +327,7 @@ module DocuSign_eSign
|
|
294
327
|
:'can_sign_offline' => :'canSignOffline',
|
295
328
|
:'client_user_id' => :'clientUserId',
|
296
329
|
:'completed_count' => :'completedCount',
|
330
|
+
:'consent_details_list' => :'consentDetailsList',
|
297
331
|
:'creation_reason' => :'creationReason',
|
298
332
|
:'custom_fields' => :'customFields',
|
299
333
|
:'declined_date_time' => :'declinedDateTime',
|
@@ -398,6 +432,7 @@ module DocuSign_eSign
|
|
398
432
|
:'can_sign_offline' => :'String',
|
399
433
|
:'client_user_id' => :'String',
|
400
434
|
:'completed_count' => :'String',
|
435
|
+
:'consent_details_list' => :'Array<ConsentDetails>',
|
401
436
|
:'creation_reason' => :'String',
|
402
437
|
:'custom_fields' => :'Array<String>',
|
403
438
|
:'declined_date_time' => :'String',
|
@@ -548,6 +583,12 @@ module DocuSign_eSign
|
|
548
583
|
self.completed_count = attributes[:'completedCount']
|
549
584
|
end
|
550
585
|
|
586
|
+
if attributes.has_key?(:'consentDetailsList')
|
587
|
+
if (value = attributes[:'consentDetailsList']).is_a?(Array)
|
588
|
+
self.consent_details_list = value
|
589
|
+
end
|
590
|
+
end
|
591
|
+
|
551
592
|
if attributes.has_key?(:'creationReason')
|
552
593
|
self.creation_reason = attributes[:'creationReason']
|
553
594
|
end
|
@@ -938,6 +979,7 @@ module DocuSign_eSign
|
|
938
979
|
can_sign_offline == o.can_sign_offline &&
|
939
980
|
client_user_id == o.client_user_id &&
|
940
981
|
completed_count == o.completed_count &&
|
982
|
+
consent_details_list == o.consent_details_list &&
|
941
983
|
creation_reason == o.creation_reason &&
|
942
984
|
custom_fields == o.custom_fields &&
|
943
985
|
declined_date_time == o.declined_date_time &&
|
@@ -1034,7 +1076,7 @@ module DocuSign_eSign
|
|
1034
1076
|
# Calculates hash code according to all attributes.
|
1035
1077
|
# @return [Fixnum] Hash code
|
1036
1078
|
def hash
|
1037
|
-
[access_code, access_code_metadata, add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, auto_navigation, auto_responded_reason, bulk_recipients_uri, can_sign_offline, client_user_id, completed_count, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delegated_by, delegated_to, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, is_bulk_recipient, is_bulk_recipient_metadata, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, notary_signer_email_sent, note, note_metadata, offline_attributes, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, require_signer_certificate, require_sign_on_paper, require_upload_signature, role_name, routing_order, routing_order_metadata, sent_date_time, signature_info, signed_date_time, sign_in_each_location, sign_in_each_location_metadata, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id, witness_for, witness_for_guid].hash
|
1079
|
+
[access_code, access_code_metadata, add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, auto_navigation, auto_responded_reason, bulk_recipients_uri, can_sign_offline, client_user_id, completed_count, consent_details_list, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delegated_by, delegated_to, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, is_bulk_recipient, is_bulk_recipient_metadata, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, notary_signer_email_sent, note, note_metadata, offline_attributes, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, require_signer_certificate, require_sign_on_paper, require_upload_signature, role_name, routing_order, routing_order_metadata, sent_date_time, signature_info, signed_date_time, sign_in_each_location, sign_in_each_location_metadata, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id, witness_for, witness_for_guid].hash
|
1038
1080
|
end
|
1039
1081
|
|
1040
1082
|
# Builds the object from hash
|
@@ -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
|
+
# Describes the workflow for an envelope.
|
15
16
|
class Workflow
|
16
17
|
#
|
17
18
|
attr_accessor :current_workflow_step_id
|
@@ -22,6 +23,7 @@ module DocuSign_eSign
|
|
22
23
|
#
|
23
24
|
attr_accessor :resume_date
|
24
25
|
|
26
|
+
# An object that describes the settings for scheduled sending.
|
25
27
|
attr_accessor :scheduled_sending
|
26
28
|
|
27
29
|
#
|
@@ -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
|
+
# Describes a single step in a workflow.
|
15
16
|
class WorkflowStep
|
16
17
|
#
|
17
18
|
attr_accessor :action
|
@@ -19,11 +20,13 @@ module DocuSign_eSign
|
|
19
20
|
#
|
20
21
|
attr_accessor :completed_date
|
21
22
|
|
23
|
+
# A complex element that specifies the delayed routing settings for the workflow step.
|
22
24
|
attr_accessor :delayed_routing
|
23
25
|
|
24
26
|
#
|
25
27
|
attr_accessor :item_id
|
26
28
|
|
29
|
+
# The rules for recipient routing.
|
27
30
|
attr_accessor :recipient_routing
|
28
31
|
|
29
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.
|
@@ -17,18 +17,22 @@ module DocuSign_eSign
|
|
17
17
|
#
|
18
18
|
attr_accessor :billable_account_id
|
19
19
|
|
20
|
+
#
|
20
21
|
attr_accessor :caller_information
|
21
22
|
|
22
23
|
#
|
23
24
|
attr_accessor :created
|
24
25
|
|
26
|
+
# Details about the user who created the workspace.
|
25
27
|
attr_accessor :created_by_information
|
26
28
|
|
27
29
|
# Utc date and time the comment was last updated (can only be done by creator.)
|
28
30
|
attr_accessor :last_modified
|
29
31
|
|
32
|
+
# Details about the user who last modified the workspace.
|
30
33
|
attr_accessor :last_modified_by_information
|
31
34
|
|
35
|
+
# Information about the settings for the workspace.
|
32
36
|
attr_accessor :settings
|
33
37
|
|
34
38
|
# 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.
|
@@ -14,6 +14,7 @@ require 'date'
|
|
14
14
|
module DocuSign_eSign
|
15
15
|
# A workspaceItem (file type only) representing the file. This property is only returned in response to file specific GET call.
|
16
16
|
class WorkspaceItem
|
17
|
+
#
|
17
18
|
attr_accessor :caller_authorization
|
18
19
|
|
19
20
|
#
|
@@ -25,6 +26,7 @@ module DocuSign_eSign
|
|
25
26
|
#
|
26
27
|
attr_accessor :created_by_id
|
27
28
|
|
29
|
+
# Details about the user who created the workspace item.
|
28
30
|
attr_accessor :created_by_information
|
29
31
|
|
30
32
|
#
|
@@ -48,6 +50,7 @@ module DocuSign_eSign
|
|
48
50
|
# Utc date and time the comment was last updated (can only be done by creator)
|
49
51
|
attr_accessor :last_modified_by_id
|
50
52
|
|
53
|
+
# Details about the user who last modified the workspace item.
|
51
54
|
attr_accessor :last_modified_by_information
|
52
55
|
|
53
56
|
# A simple string description of the item, such as a file name or a folder name.
|
@@ -68,6 +71,7 @@ module DocuSign_eSign
|
|
68
71
|
#
|
69
72
|
attr_accessor :thumb_height
|
70
73
|
|
74
|
+
#
|
71
75
|
attr_accessor :thumbnail
|
72
76
|
|
73
77
|
#
|
@@ -79,6 +83,7 @@ module DocuSign_eSign
|
|
79
83
|
#
|
80
84
|
attr_accessor :uri
|
81
85
|
|
86
|
+
#
|
82
87
|
attr_accessor :user_authorization
|
83
88
|
|
84
89
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -32,6 +32,7 @@ module DocuSign_eSign
|
|
32
32
|
#
|
33
33
|
attr_accessor :created_by_id
|
34
34
|
|
35
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
35
36
|
attr_accessor :error_details
|
36
37
|
|
37
38
|
#
|
@@ -43,6 +44,7 @@ module DocuSign_eSign
|
|
43
44
|
#
|
44
45
|
attr_accessor :workspace_user_id
|
45
46
|
|
47
|
+
# An object that provides details about the workspace user.
|
46
48
|
attr_accessor :workspace_user_information
|
47
49
|
|
48
50
|
# Attribute mapping from ruby-style variable name to JSON key.
|