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
@@ -16,111 +16,133 @@ module DocuSign_eSign
|
|
16
16
|
#
|
17
17
|
attr_accessor :allow_tab_order
|
18
18
|
|
19
|
+
# Metadata that indicates whether the `allowTabOrder` property is editable.
|
19
20
|
attr_accessor :allow_tab_order_metadata
|
20
21
|
|
21
22
|
#
|
22
23
|
attr_accessor :approve_decline_tabs_enabled
|
23
24
|
|
25
|
+
# Metadata that indicates whether the `approveDeclineTabs` property is editable.
|
24
26
|
attr_accessor :approve_decline_tabs_metadata
|
25
27
|
|
26
28
|
#
|
27
29
|
attr_accessor :calculated_fields_enabled
|
28
30
|
|
31
|
+
# Metadata that indicates whether the `calculatedFields` property is editable.
|
29
32
|
attr_accessor :calculated_fields_metadata
|
30
33
|
|
31
34
|
#
|
32
35
|
attr_accessor :checkbox_tabs_enabled
|
33
36
|
|
37
|
+
# Metadata that indicates whether the `checkBoxTabs` property is editable.
|
34
38
|
attr_accessor :check_box_tabs_metadata
|
35
39
|
|
36
40
|
#
|
37
41
|
attr_accessor :currency_tabs_enabled
|
38
42
|
|
43
|
+
#
|
39
44
|
attr_accessor :currency_tabs_metadata
|
40
45
|
|
41
46
|
#
|
42
47
|
attr_accessor :data_field_regex_enabled
|
43
48
|
|
49
|
+
# Metadata that indicates whether the `dataFieldRegex` property is editable.
|
44
50
|
attr_accessor :data_field_regex_metadata
|
45
51
|
|
46
52
|
#
|
47
53
|
attr_accessor :data_field_size_enabled
|
48
54
|
|
55
|
+
# Metadata that indicates whether the `dataFieldSize` property is editable.
|
49
56
|
attr_accessor :data_field_size_metadata
|
50
57
|
|
51
58
|
#
|
52
59
|
attr_accessor :draw_tabs_enabled
|
53
60
|
|
61
|
+
#
|
54
62
|
attr_accessor :draw_tabs_metadata
|
55
63
|
|
56
64
|
#
|
57
65
|
attr_accessor :first_last_email_tabs_enabled
|
58
66
|
|
67
|
+
# Reserved for DocuSign.
|
59
68
|
attr_accessor :first_last_email_tabs_metadata
|
60
69
|
|
61
70
|
#
|
62
71
|
attr_accessor :list_tabs_enabled
|
63
72
|
|
73
|
+
# Metadata that indicates whether the `listTabs` property is editable.
|
64
74
|
attr_accessor :list_tabs_metadata
|
65
75
|
|
66
76
|
#
|
67
77
|
attr_accessor :note_tabs_enabled
|
68
78
|
|
79
|
+
# Metadata that indicates whether the `noteTabs` property is editable.
|
69
80
|
attr_accessor :note_tabs_metadata
|
70
81
|
|
71
82
|
#
|
72
83
|
attr_accessor :prefill_tabs_enabled
|
73
84
|
|
85
|
+
#
|
74
86
|
attr_accessor :prefill_tabs_metadata
|
75
87
|
|
76
88
|
#
|
77
89
|
attr_accessor :radio_tabs_enabled
|
78
90
|
|
91
|
+
# Metadata that indicates whether the `radioTabs` property is editable.
|
79
92
|
attr_accessor :radio_tabs_metadata
|
80
93
|
|
81
94
|
#
|
82
95
|
attr_accessor :saving_custom_tabs_enabled
|
83
96
|
|
97
|
+
# Metadata that indicates whether the `savingCustomTabs` property is editable.
|
84
98
|
attr_accessor :saving_custom_tabs_metadata
|
85
99
|
|
86
100
|
#
|
87
101
|
attr_accessor :sender_to_change_tab_assignments_enabled
|
88
102
|
|
103
|
+
# Reserved for DocuSign.
|
89
104
|
attr_accessor :sender_to_change_tab_assignments_metadata
|
90
105
|
|
91
106
|
#
|
92
107
|
attr_accessor :shared_custom_tabs_enabled
|
93
108
|
|
109
|
+
# Metadata that indicates whether the `sharedCustomTabs` property is editable.
|
94
110
|
attr_accessor :shared_custom_tabs_metadata
|
95
111
|
|
96
112
|
#
|
97
113
|
attr_accessor :tab_data_label_enabled
|
98
114
|
|
115
|
+
# Metadata that indicates whether the `tabDataLabel` property is editable.
|
99
116
|
attr_accessor :tab_data_label_metadata
|
100
117
|
|
101
118
|
#
|
102
119
|
attr_accessor :tab_location_enabled
|
103
120
|
|
121
|
+
# Reserved for DocuSign.
|
104
122
|
attr_accessor :tab_location_metadata
|
105
123
|
|
106
124
|
#
|
107
125
|
attr_accessor :tab_locking_enabled
|
108
126
|
|
127
|
+
# Metadata that indicates whether the `tabLocking` property is editable.
|
109
128
|
attr_accessor :tab_locking_metadata
|
110
129
|
|
111
130
|
#
|
112
131
|
attr_accessor :tab_scale_enabled
|
113
132
|
|
133
|
+
# Reserved for DocuSign.
|
114
134
|
attr_accessor :tab_scale_metadata
|
115
135
|
|
116
136
|
#
|
117
137
|
attr_accessor :tab_text_formatting_enabled
|
118
138
|
|
139
|
+
# Metadata that indicates whether the `tabTextFormatting` property is editable.
|
119
140
|
attr_accessor :tab_text_formatting_metadata
|
120
141
|
|
121
142
|
#
|
122
143
|
attr_accessor :text_tabs_enabled
|
123
144
|
|
145
|
+
# Metadata that indicates whether the `textTabs` property is editable.
|
124
146
|
attr_accessor :text_tabs_metadata
|
125
147
|
|
126
148
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -16,51 +16,61 @@ module DocuSign_eSign
|
|
16
16
|
#
|
17
17
|
attr_accessor :anchor_allow_white_space_in_characters
|
18
18
|
|
19
|
+
# Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.
|
19
20
|
attr_accessor :anchor_allow_white_space_in_characters_metadata
|
20
21
|
|
21
22
|
# When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
|
22
23
|
attr_accessor :anchor_case_sensitive
|
23
24
|
|
25
|
+
# Metadata that indicates whether the `anchorCaseSensitive` property is editable.
|
24
26
|
attr_accessor :anchor_case_sensitive_metadata
|
25
27
|
|
26
28
|
# Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
|
27
29
|
attr_accessor :anchor_horizontal_alignment
|
28
30
|
|
31
|
+
# Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
|
29
32
|
attr_accessor :anchor_horizontal_alignment_metadata
|
30
33
|
|
31
34
|
# When set to **true**, this tab is ignored if anchorString is not found in the document.
|
32
35
|
attr_accessor :anchor_ignore_if_not_present
|
33
36
|
|
37
|
+
# Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.
|
34
38
|
attr_accessor :anchor_ignore_if_not_present_metadata
|
35
39
|
|
36
40
|
# 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
41
|
attr_accessor :anchor_match_whole_word
|
38
42
|
|
43
|
+
# Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
|
39
44
|
attr_accessor :anchor_match_whole_word_metadata
|
40
45
|
|
41
46
|
# Anchor text information for a radio button.
|
42
47
|
attr_accessor :anchor_string
|
43
48
|
|
49
|
+
# Metadata that indicates whether the `anchorString` property is editable.
|
44
50
|
attr_accessor :anchor_string_metadata
|
45
51
|
|
46
52
|
#
|
47
53
|
attr_accessor :anchor_tab_processor_version
|
48
54
|
|
55
|
+
# Reserved for DocuSign.
|
49
56
|
attr_accessor :anchor_tab_processor_version_metadata
|
50
57
|
|
51
58
|
# Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
|
52
59
|
attr_accessor :anchor_units
|
53
60
|
|
61
|
+
# Metadata that indicates whether the `anchorUnits` property is editable.
|
54
62
|
attr_accessor :anchor_units_metadata
|
55
63
|
|
56
64
|
# Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
|
57
65
|
attr_accessor :anchor_x_offset
|
58
66
|
|
67
|
+
# Metadata that indicates whether the `anchorXOffset` property is editable.
|
59
68
|
attr_accessor :anchor_x_offset_metadata
|
60
69
|
|
61
70
|
# Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
|
62
71
|
attr_accessor :anchor_y_offset
|
63
72
|
|
73
|
+
# Metadata that indicates whether the `anchorYOffset` property is editable.
|
64
74
|
attr_accessor :anchor_y_offset_metadata
|
65
75
|
|
66
76
|
#
|
@@ -71,60 +81,73 @@ module DocuSign_eSign
|
|
71
81
|
# For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
|
72
82
|
attr_accessor :conditional_parent_label
|
73
83
|
|
84
|
+
# Metadata that indicates whether the `conditionalParentLabel` property is editable.
|
74
85
|
attr_accessor :conditional_parent_label_metadata
|
75
86
|
|
76
87
|
# 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.
|
77
88
|
attr_accessor :conditional_parent_value
|
78
89
|
|
90
|
+
# Metadata that indicates whether the `conditionalParentValue` property is editable.
|
79
91
|
attr_accessor :conditional_parent_value_metadata
|
80
92
|
|
81
93
|
# 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.
|
82
94
|
attr_accessor :custom_tab_id
|
83
95
|
|
96
|
+
# Metadata that indicates whether the `customTabId` property is editable.
|
84
97
|
attr_accessor :custom_tab_id_metadata
|
85
98
|
|
86
99
|
# Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
|
87
100
|
attr_accessor :document_id
|
88
101
|
|
102
|
+
# Metadata that indicates whether the `documentId` property is editable.
|
89
103
|
attr_accessor :document_id_metadata
|
90
104
|
|
105
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
91
106
|
attr_accessor :error_details
|
92
107
|
|
93
108
|
#
|
94
109
|
attr_accessor :form_order
|
95
110
|
|
111
|
+
# Metadata that indicates whether the `formOrder` property is editable.
|
96
112
|
attr_accessor :form_order_metadata
|
97
113
|
|
98
114
|
#
|
99
115
|
attr_accessor :form_page_label
|
100
116
|
|
117
|
+
# Metadata that indicates whether the `formPageLabel` property is editable.
|
101
118
|
attr_accessor :form_page_label_metadata
|
102
119
|
|
103
120
|
#
|
104
121
|
attr_accessor :form_page_number
|
105
122
|
|
123
|
+
# Metadata that indicates whether the `fromPageNumber` property is editable.
|
106
124
|
attr_accessor :form_page_number_metadata
|
107
125
|
|
108
126
|
#
|
109
127
|
attr_accessor :group_label
|
110
128
|
|
129
|
+
# Metadata that indicates whether the `groupLabel` property is editable.
|
111
130
|
attr_accessor :group_label_metadata
|
112
131
|
|
113
132
|
#
|
114
133
|
attr_accessor :group_rule
|
115
134
|
|
135
|
+
# Metadata that indicates whether the `groupRule` property is editable.
|
116
136
|
attr_accessor :group_rule_metadata
|
117
137
|
|
118
138
|
# Height of the tab in pixels.
|
119
139
|
attr_accessor :height
|
120
140
|
|
141
|
+
# Metadata that indicates whether the `height` property is editable.
|
121
142
|
attr_accessor :height_metadata
|
122
143
|
|
123
144
|
#
|
124
145
|
attr_accessor :maximum_allowed
|
125
146
|
|
147
|
+
# Metadata that indicates whether the `maximumAllowed` property is editable.
|
126
148
|
attr_accessor :maximum_allowed_metadata
|
127
149
|
|
150
|
+
# Contains the information necessary to map the tab to a field in SalesForce.
|
128
151
|
attr_accessor :merge_field
|
129
152
|
|
130
153
|
#
|
@@ -133,11 +156,13 @@ module DocuSign_eSign
|
|
133
156
|
#
|
134
157
|
attr_accessor :minimum_required
|
135
158
|
|
159
|
+
# Metadata that indicates whether the `minimumRequired` property is editable.
|
136
160
|
attr_accessor :minimum_required_metadata
|
137
161
|
|
138
162
|
# Specifies the page number on which the tab is located.
|
139
163
|
attr_accessor :page_number
|
140
164
|
|
165
|
+
# Metadata that indicates whether the `pageNumber` property is editable.
|
141
166
|
attr_accessor :page_number_metadata
|
142
167
|
|
143
168
|
# Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
|
@@ -146,10 +171,13 @@ module DocuSign_eSign
|
|
146
171
|
#
|
147
172
|
attr_accessor :recipient_id_guid
|
148
173
|
|
174
|
+
# Metadata that indicates whether the `recipientIdGuid` property is editable.
|
149
175
|
attr_accessor :recipient_id_guid_metadata
|
150
176
|
|
177
|
+
# Metadata that indicates whether the `recipientId` property is editable.
|
151
178
|
attr_accessor :recipient_id_metadata
|
152
179
|
|
180
|
+
# Reserved for DocuSign.
|
153
181
|
attr_accessor :smart_contract_information
|
154
182
|
|
155
183
|
#
|
@@ -158,66 +186,79 @@ module DocuSign_eSign
|
|
158
186
|
# 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.
|
159
187
|
attr_accessor :status
|
160
188
|
|
189
|
+
# Metadata that indicates whether the `status` property is editable.
|
161
190
|
attr_accessor :status_metadata
|
162
191
|
|
163
192
|
#
|
164
193
|
attr_accessor :tab_group_labels
|
165
194
|
|
195
|
+
# Metadata that indicates whether the `tabGroupLabels` property is editable.
|
166
196
|
attr_accessor :tab_group_labels_metadata
|
167
197
|
|
168
198
|
# The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
|
169
199
|
attr_accessor :tab_id
|
170
200
|
|
201
|
+
# Metadata that indicates whether the `tabId` property is editable.
|
171
202
|
attr_accessor :tab_id_metadata
|
172
203
|
|
173
204
|
#
|
174
205
|
attr_accessor :tab_order
|
175
206
|
|
207
|
+
# Metadata that indicates whether the `tabOrder` property is editable.
|
176
208
|
attr_accessor :tab_order_metadata
|
177
209
|
|
178
210
|
#
|
179
211
|
attr_accessor :tab_scope
|
180
212
|
|
213
|
+
# Metadata that indicates whether the `tabScope` property is editable.
|
181
214
|
attr_accessor :tab_scope_metadata
|
182
215
|
|
183
216
|
#
|
184
217
|
attr_accessor :tab_type
|
185
218
|
|
219
|
+
# Metadata that indicates whether the `tabType` property is editable.
|
186
220
|
attr_accessor :tab_type_metadata
|
187
221
|
|
188
222
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
189
223
|
attr_accessor :template_locked
|
190
224
|
|
225
|
+
# Metadata that indicates whether the `templateLocked` property is editable.
|
191
226
|
attr_accessor :template_locked_metadata
|
192
227
|
|
193
228
|
# When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
|
194
229
|
attr_accessor :template_required
|
195
230
|
|
231
|
+
# Metadata that indicates whether the `templateRequired` property is editable.
|
196
232
|
attr_accessor :template_required_metadata
|
197
233
|
|
198
234
|
#
|
199
235
|
attr_accessor :tooltip
|
200
236
|
|
237
|
+
# Metadata that indicates whether the `toolTip` property is editable.
|
201
238
|
attr_accessor :tool_tip_metadata
|
202
239
|
|
203
240
|
# The message displayed if the custom tab fails input validation (either custom of embedded).
|
204
241
|
attr_accessor :validation_message
|
205
242
|
|
243
|
+
# Metadata that indicates whether the `validationMessage` property is editable.
|
206
244
|
attr_accessor :validation_message_metadata
|
207
245
|
|
208
246
|
# Width of the tab in pixels.
|
209
247
|
attr_accessor :width
|
210
248
|
|
249
|
+
# Metadata that indicates whether the `width` property is editable.
|
211
250
|
attr_accessor :width_metadata
|
212
251
|
|
213
252
|
# This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
214
253
|
attr_accessor :x_position
|
215
254
|
|
255
|
+
# Metadata that indicates whether the `xPosition` property is editable.
|
216
256
|
attr_accessor :x_position_metadata
|
217
257
|
|
218
258
|
# This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
219
259
|
attr_accessor :y_position
|
220
260
|
|
261
|
+
# Metadata that indicates whether the `yPosition` property is editable.
|
221
262
|
attr_accessor :y_position_metadata
|
222
263
|
|
223
264
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -94,6 +94,7 @@ module DocuSign_eSign
|
|
94
94
|
# The userId of the DocuSign user who last modified this object.
|
95
95
|
attr_accessor :last_modified_by_user_id
|
96
96
|
|
97
|
+
# Reserved for DocuSign.
|
97
98
|
attr_accessor :locale_policy
|
98
99
|
|
99
100
|
# When set to **true**, the signer cannot change the data of the custom tab.
|
@@ -105,6 +106,7 @@ module DocuSign_eSign
|
|
105
106
|
#
|
106
107
|
attr_accessor :max_numerical_value
|
107
108
|
|
109
|
+
# Contains the information necessary to map the tab to a field in SalesForce.
|
108
110
|
attr_accessor :merge_field
|
109
111
|
|
110
112
|
#
|
@@ -143,9 +145,13 @@ module DocuSign_eSign
|
|
143
145
|
# When set to **true**, this custom tab is shared.
|
144
146
|
attr_accessor :shared
|
145
147
|
|
148
|
+
#
|
149
|
+
attr_accessor :signature_provider_id
|
150
|
+
|
146
151
|
#
|
147
152
|
attr_accessor :stamp_type
|
148
153
|
|
154
|
+
# Metadata that indicates whether the `stampType` property is editable.
|
149
155
|
attr_accessor :stamp_type_metadata
|
150
156
|
|
151
157
|
# The label string associated with the tab.
|
@@ -213,6 +219,7 @@ module DocuSign_eSign
|
|
213
219
|
:'scale_value' => :'scaleValue',
|
214
220
|
:'selected' => :'selected',
|
215
221
|
:'shared' => :'shared',
|
222
|
+
:'signature_provider_id' => :'signatureProviderId',
|
216
223
|
:'stamp_type' => :'stampType',
|
217
224
|
:'stamp_type_metadata' => :'stampTypeMetadata',
|
218
225
|
:'tab_label' => :'tabLabel',
|
@@ -271,6 +278,7 @@ module DocuSign_eSign
|
|
271
278
|
:'scale_value' => :'String',
|
272
279
|
:'selected' => :'String',
|
273
280
|
:'shared' => :'String',
|
281
|
+
:'signature_provider_id' => :'String',
|
274
282
|
:'stamp_type' => :'String',
|
275
283
|
:'stamp_type_metadata' => :'PropertyMetadata',
|
276
284
|
:'tab_label' => :'String',
|
@@ -468,6 +476,10 @@ module DocuSign_eSign
|
|
468
476
|
self.shared = attributes[:'shared']
|
469
477
|
end
|
470
478
|
|
479
|
+
if attributes.has_key?(:'signatureProviderId')
|
480
|
+
self.signature_provider_id = attributes[:'signatureProviderId']
|
481
|
+
end
|
482
|
+
|
471
483
|
if attributes.has_key?(:'stampType')
|
472
484
|
self.stamp_type = attributes[:'stampType']
|
473
485
|
end
|
@@ -563,6 +575,7 @@ module DocuSign_eSign
|
|
563
575
|
scale_value == o.scale_value &&
|
564
576
|
selected == o.selected &&
|
565
577
|
shared == o.shared &&
|
578
|
+
signature_provider_id == o.signature_provider_id &&
|
566
579
|
stamp_type == o.stamp_type &&
|
567
580
|
stamp_type_metadata == o.stamp_type_metadata &&
|
568
581
|
tab_label == o.tab_label &&
|
@@ -582,7 +595,7 @@ module DocuSign_eSign
|
|
582
595
|
# Calculates hash code according to all attributes.
|
583
596
|
# @return [Fixnum] Hash code
|
584
597
|
def hash
|
585
|
-
[anchor, anchor_case_sensitive, anchor_horizontal_alignment, anchor_ignore_if_not_present, anchor_match_whole_word, anchor_units, anchor_x_offset, anchor_y_offset, bold, collaborative, conceal_value_on_document, created_by_display_name, created_by_user_id, custom_tab_id, disable_auto_size, editable, font, font_color, font_size, height, included_in_email, initial_value, italic, items, last_modified, last_modified_by_display_name, last_modified_by_user_id, locale_policy, locked, maximum_length, max_numerical_value, merge_field, min_numerical_value, name, numerical_value, payment_item_code, payment_item_description, payment_item_name, require_all, required, require_initial_on_shared_change, scale_value, selected, shared, stamp_type, stamp_type_metadata, tab_label, type, underline, validation_message, validation_pattern, width].hash
|
598
|
+
[anchor, anchor_case_sensitive, anchor_horizontal_alignment, anchor_ignore_if_not_present, anchor_match_whole_word, anchor_units, anchor_x_offset, anchor_y_offset, bold, collaborative, conceal_value_on_document, created_by_display_name, created_by_user_id, custom_tab_id, disable_auto_size, editable, font, font_color, font_size, height, included_in_email, initial_value, italic, items, last_modified, last_modified_by_display_name, last_modified_by_user_id, locale_policy, locked, maximum_length, max_numerical_value, merge_field, min_numerical_value, name, numerical_value, payment_item_code, payment_item_description, payment_item_name, require_all, required, require_initial_on_shared_change, scale_value, selected, shared, signature_provider_id, stamp_type, stamp_type_metadata, tab_label, type, underline, validation_message, validation_pattern, width].hash
|
586
599
|
end
|
587
600
|
|
588
601
|
# 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
|
+
# Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients.
|
15
16
|
class Tabs
|
16
17
|
# Specifies a tag on the document where you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tag during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history.
|
17
18
|
attr_accessor :approve_tabs
|
@@ -97,6 +98,7 @@ module DocuSign_eSign
|
|
97
98
|
#
|
98
99
|
attr_accessor :poly_line_overlay_tabs
|
99
100
|
|
101
|
+
# Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields
|
100
102
|
attr_accessor :prefill_tabs
|
101
103
|
|
102
104
|
# Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document.
|
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# A list of `documentVisibility` objects that specify whether the documents associated with a template are visible to recipients.
|
15
16
|
class TemplateDocumentVisibilityList
|
16
17
|
#
|
17
18
|
attr_accessor :document_visibility
|
@@ -13,11 +13,13 @@ require 'date'
|
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
15
|
class TemplateNotificationRequest
|
16
|
+
# A complex element that specifies the expiration settings for the envelope.
|
16
17
|
attr_accessor :expirations
|
17
18
|
|
18
19
|
#
|
19
20
|
attr_accessor :password
|
20
21
|
|
22
|
+
# A complex element that specifies reminder settings for the envelope.
|
21
23
|
attr_accessor :reminders
|
22
24
|
|
23
25
|
# When set to **true**, the account default notification settings are used for the envelope.
|
@@ -28,6 +28,7 @@ module DocuSign_eSign
|
|
28
28
|
#
|
29
29
|
attr_accessor :editors
|
30
30
|
|
31
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
31
32
|
attr_accessor :error_details
|
32
33
|
|
33
34
|
# Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.
|
@@ -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
|
+
# Information about a specific role.
|
15
16
|
class TemplateRole
|
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
|
@@ -28,6 +29,7 @@ module DocuSign_eSign
|
|
28
29
|
# Specifies the email associated with a role name.
|
29
30
|
attr_accessor :email
|
30
31
|
|
32
|
+
# 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`.
|
31
33
|
attr_accessor :email_notification
|
32
34
|
|
33
35
|
# 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]]`
|
@@ -39,6 +41,7 @@ module DocuSign_eSign
|
|
39
41
|
# Specifies the recipient's name.
|
40
42
|
attr_accessor :name
|
41
43
|
|
44
|
+
# Describes the recipient phone number.
|
42
45
|
attr_accessor :phone_number
|
43
46
|
|
44
47
|
#
|
@@ -53,6 +56,7 @@ module DocuSign_eSign
|
|
53
56
|
# 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).
|
54
57
|
attr_accessor :signing_group_id
|
55
58
|
|
59
|
+
# 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.
|
56
60
|
attr_accessor :tabs
|
57
61
|
|
58
62
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -12,9 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# Information about shared templates.
|
15
16
|
class TemplateSharedItem
|
17
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
16
18
|
attr_accessor :error_details
|
17
19
|
|
20
|
+
# Information about the user who owns the template.
|
18
21
|
attr_accessor :owner
|
19
22
|
|
20
23
|
#
|
@@ -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
|
+
# Summary of a template request.
|
15
16
|
class TemplateSummary
|
16
17
|
# Reserved: TBD
|
17
18
|
attr_accessor :applied
|
@@ -22,6 +23,7 @@ module DocuSign_eSign
|
|
22
23
|
#
|
23
24
|
attr_accessor :document_name
|
24
25
|
|
26
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
25
27
|
attr_accessor :error_details
|
26
28
|
|
27
29
|
#
|
@@ -30,6 +32,7 @@ module DocuSign_eSign
|
|
30
32
|
# The unique identifier of the template. If this is not provided, DocuSign will generate a value.
|
31
33
|
attr_accessor :template_id
|
32
34
|
|
35
|
+
#
|
33
36
|
attr_accessor :template_match
|
34
37
|
|
35
38
|
#
|
@@ -97,6 +97,7 @@ module DocuSign_eSign
|
|
97
97
|
#
|
98
98
|
attr_accessor :poly_line_overlay_tabs
|
99
99
|
|
100
|
+
# Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields
|
100
101
|
attr_accessor :prefill_tabs
|
101
102
|
|
102
103
|
# Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document.
|
@@ -13,16 +13,19 @@ require 'date'
|
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
15
|
class TemplateUpdateSummary
|
16
|
+
# An object that describes the status of the bulk send envelopes.
|
16
17
|
attr_accessor :bulk_envelope_status
|
17
18
|
|
18
19
|
# The envelope ID of the envelope status that failed to post.
|
19
20
|
attr_accessor :envelope_id
|
20
21
|
|
22
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
21
23
|
attr_accessor :error_details
|
22
24
|
|
23
25
|
#
|
24
26
|
attr_accessor :list_custom_field_update_results
|
25
27
|
|
28
|
+
# Provides lock information about an envelope that a user has locked.
|
26
29
|
attr_accessor :lock_information
|
27
30
|
|
28
31
|
#
|
@@ -31,6 +34,7 @@ module DocuSign_eSign
|
|
31
34
|
#
|
32
35
|
attr_accessor :recipient_update_results
|
33
36
|
|
37
|
+
#
|
34
38
|
attr_accessor :tab_update_results
|
35
39
|
|
36
40
|
#
|