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,55 +12,66 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/
|
15
16
|
class NotarySeal
|
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
|
#
|
@@ -71,45 +82,55 @@ module DocuSign_eSign
|
|
71
82
|
# For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
|
72
83
|
attr_accessor :conditional_parent_label
|
73
84
|
|
85
|
+
# Metadata that indicates whether the `conditionalParentLabel` property is editable.
|
74
86
|
attr_accessor :conditional_parent_label_metadata
|
75
87
|
|
76
88
|
# 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
89
|
attr_accessor :conditional_parent_value
|
78
90
|
|
91
|
+
# Metadata that indicates whether the `conditionalParentValue` property is editable.
|
79
92
|
attr_accessor :conditional_parent_value_metadata
|
80
93
|
|
81
94
|
# 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
95
|
attr_accessor :custom_tab_id
|
83
96
|
|
97
|
+
# Metadata that indicates whether the `customTabId` property is editable.
|
84
98
|
attr_accessor :custom_tab_id_metadata
|
85
99
|
|
86
100
|
# Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
|
87
101
|
attr_accessor :document_id
|
88
102
|
|
103
|
+
# Metadata that indicates whether the `documentId` property is editable.
|
89
104
|
attr_accessor :document_id_metadata
|
90
105
|
|
106
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
91
107
|
attr_accessor :error_details
|
92
108
|
|
93
109
|
#
|
94
110
|
attr_accessor :form_order
|
95
111
|
|
112
|
+
# Metadata that indicates whether the `formOrder` property is editable.
|
96
113
|
attr_accessor :form_order_metadata
|
97
114
|
|
98
115
|
#
|
99
116
|
attr_accessor :form_page_label
|
100
117
|
|
118
|
+
# Metadata that indicates whether the `formPageLabel` property is editable.
|
101
119
|
attr_accessor :form_page_label_metadata
|
102
120
|
|
103
121
|
#
|
104
122
|
attr_accessor :form_page_number
|
105
123
|
|
124
|
+
# Metadata that indicates whether the `fromPageNumber` property is editable.
|
106
125
|
attr_accessor :form_page_number_metadata
|
107
126
|
|
108
127
|
# Height of the tab in pixels.
|
109
128
|
attr_accessor :height
|
110
129
|
|
130
|
+
# Metadata that indicates whether the `height` property is editable.
|
111
131
|
attr_accessor :height_metadata
|
112
132
|
|
133
|
+
# Contains the information necessary to map the tab to a field in SalesForce.
|
113
134
|
attr_accessor :merge_field
|
114
135
|
|
115
136
|
#
|
@@ -118,11 +139,13 @@ module DocuSign_eSign
|
|
118
139
|
#
|
119
140
|
attr_accessor :name
|
120
141
|
|
142
|
+
# Metadata that indicates whether the `name` property is editable. This property is read-only.
|
121
143
|
attr_accessor :name_metadata
|
122
144
|
|
123
145
|
# Specifies the page number on which the tab is located.
|
124
146
|
attr_accessor :page_number
|
125
147
|
|
148
|
+
# Metadata that indicates whether the `pageNumber` property is editable.
|
126
149
|
attr_accessor :page_number_metadata
|
127
150
|
|
128
151
|
# Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
|
@@ -131,15 +154,19 @@ module DocuSign_eSign
|
|
131
154
|
#
|
132
155
|
attr_accessor :recipient_id_guid
|
133
156
|
|
157
|
+
# Metadata that indicates whether the `recipientIdGuid` property is editable.
|
134
158
|
attr_accessor :recipient_id_guid_metadata
|
135
159
|
|
160
|
+
# Metadata that indicates whether the `recipientId` property is editable.
|
136
161
|
attr_accessor :recipient_id_metadata
|
137
162
|
|
138
163
|
#
|
139
164
|
attr_accessor :scale_value
|
140
165
|
|
166
|
+
# Metadata that indicates whether the `scaleValue` property is editable.
|
141
167
|
attr_accessor :scale_value_metadata
|
142
168
|
|
169
|
+
# Reserved for DocuSign.
|
143
170
|
attr_accessor :smart_contract_information
|
144
171
|
|
145
172
|
#
|
@@ -148,61 +175,73 @@ module DocuSign_eSign
|
|
148
175
|
# 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.
|
149
176
|
attr_accessor :status
|
150
177
|
|
178
|
+
# Metadata that indicates whether the `status` property is editable.
|
151
179
|
attr_accessor :status_metadata
|
152
180
|
|
153
181
|
#
|
154
182
|
attr_accessor :tab_group_labels
|
155
183
|
|
184
|
+
# Metadata that indicates whether the `tabGroupLabels` property is editable.
|
156
185
|
attr_accessor :tab_group_labels_metadata
|
157
186
|
|
158
187
|
# The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
|
159
188
|
attr_accessor :tab_id
|
160
189
|
|
190
|
+
# Metadata that indicates whether the `tabId` property is editable.
|
161
191
|
attr_accessor :tab_id_metadata
|
162
192
|
|
163
193
|
# The label string associated with the tab.
|
164
194
|
attr_accessor :tab_label
|
165
195
|
|
196
|
+
# Metadata that indicates whether the `tabLabel` property is editable.
|
166
197
|
attr_accessor :tab_label_metadata
|
167
198
|
|
168
199
|
#
|
169
200
|
attr_accessor :tab_order
|
170
201
|
|
202
|
+
# Metadata that indicates whether the `tabOrder` property is editable.
|
171
203
|
attr_accessor :tab_order_metadata
|
172
204
|
|
173
205
|
#
|
174
206
|
attr_accessor :tab_type
|
175
207
|
|
208
|
+
# Metadata that indicates whether the `tabType` property is editable.
|
176
209
|
attr_accessor :tab_type_metadata
|
177
210
|
|
178
211
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
179
212
|
attr_accessor :template_locked
|
180
213
|
|
214
|
+
# Metadata that indicates whether the `templateLocked` property is editable.
|
181
215
|
attr_accessor :template_locked_metadata
|
182
216
|
|
183
217
|
# When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
|
184
218
|
attr_accessor :template_required
|
185
219
|
|
220
|
+
# Metadata that indicates whether the `templateRequired` property is editable.
|
186
221
|
attr_accessor :template_required_metadata
|
187
222
|
|
188
223
|
#
|
189
224
|
attr_accessor :tooltip
|
190
225
|
|
226
|
+
# Metadata that indicates whether the `toolTip` property is editable.
|
191
227
|
attr_accessor :tool_tip_metadata
|
192
228
|
|
193
229
|
# Width of the tab in pixels.
|
194
230
|
attr_accessor :width
|
195
231
|
|
232
|
+
# Metadata that indicates whether the `width` property is editable.
|
196
233
|
attr_accessor :width_metadata
|
197
234
|
|
198
235
|
# This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
199
236
|
attr_accessor :x_position
|
200
237
|
|
238
|
+
# Metadata that indicates whether the `xPosition` property is editable.
|
201
239
|
attr_accessor :x_position_metadata
|
202
240
|
|
203
241
|
# This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
204
242
|
attr_accessor :y_position
|
205
243
|
|
244
|
+
# Metadata that indicates whether the `yPosition` property is editable.
|
206
245
|
attr_accessor :y_position_metadata
|
207
246
|
|
208
247
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -12,60 +12,72 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# A tab that displays additional information, in the form of a note, for the recipient.
|
15
16
|
class Note
|
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
|
#
|
@@ -76,23 +88,28 @@ module DocuSign_eSign
|
|
76
88
|
# For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
|
77
89
|
attr_accessor :conditional_parent_label
|
78
90
|
|
91
|
+
# Metadata that indicates whether the `conditionalParentLabel` property is editable.
|
79
92
|
attr_accessor :conditional_parent_label_metadata
|
80
93
|
|
81
94
|
# 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.
|
82
95
|
attr_accessor :conditional_parent_value
|
83
96
|
|
97
|
+
# Metadata that indicates whether the `conditionalParentValue` property is editable.
|
84
98
|
attr_accessor :conditional_parent_value_metadata
|
85
99
|
|
86
100
|
# 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.
|
87
101
|
attr_accessor :custom_tab_id
|
88
102
|
|
103
|
+
# Metadata that indicates whether the `customTabId` property is editable.
|
89
104
|
attr_accessor :custom_tab_id_metadata
|
90
105
|
|
91
106
|
# Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
|
92
107
|
attr_accessor :document_id
|
93
108
|
|
109
|
+
# Metadata that indicates whether the `documentId` property is editable.
|
94
110
|
attr_accessor :document_id_metadata
|
95
111
|
|
112
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
96
113
|
attr_accessor :error_details
|
97
114
|
|
98
115
|
# 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.
|
@@ -101,42 +118,52 @@ module DocuSign_eSign
|
|
101
118
|
# The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
|
102
119
|
attr_accessor :font_color
|
103
120
|
|
121
|
+
# Metadata that indicates whether the `fontColor` property is editable.
|
104
122
|
attr_accessor :font_color_metadata
|
105
123
|
|
124
|
+
# Metadata that indicates whether the `font` property is editable.
|
106
125
|
attr_accessor :font_metadata
|
107
126
|
|
108
127
|
# 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.
|
109
128
|
attr_accessor :font_size
|
110
129
|
|
130
|
+
# Metadata that indicates whether the `fontSize` property is editable.
|
111
131
|
attr_accessor :font_size_metadata
|
112
132
|
|
113
133
|
#
|
114
134
|
attr_accessor :form_order
|
115
135
|
|
136
|
+
# Metadata that indicates whether the `formOrder` property is editable.
|
116
137
|
attr_accessor :form_order_metadata
|
117
138
|
|
118
139
|
#
|
119
140
|
attr_accessor :form_page_label
|
120
141
|
|
142
|
+
# Metadata that indicates whether the `formPageLabel` property is editable.
|
121
143
|
attr_accessor :form_page_label_metadata
|
122
144
|
|
123
145
|
#
|
124
146
|
attr_accessor :form_page_number
|
125
147
|
|
148
|
+
# Metadata that indicates whether the `fromPageNumber` property is editable.
|
126
149
|
attr_accessor :form_page_number_metadata
|
127
150
|
|
128
151
|
# Height of the tab in pixels.
|
129
152
|
attr_accessor :height
|
130
153
|
|
154
|
+
# Metadata that indicates whether the `height` property is editable.
|
131
155
|
attr_accessor :height_metadata
|
132
156
|
|
133
157
|
# When set to **true**, the information in the tab is italic.
|
134
158
|
attr_accessor :italic
|
135
159
|
|
160
|
+
# Metadata that indicates whether the `italic` property is editable.
|
136
161
|
attr_accessor :italic_metadata
|
137
162
|
|
163
|
+
# Reserved for DocuSign.
|
138
164
|
attr_accessor :locale_policy
|
139
165
|
|
166
|
+
# Contains the information necessary to map the tab to a field in SalesForce.
|
140
167
|
attr_accessor :merge_field
|
141
168
|
|
142
169
|
#
|
@@ -145,11 +172,13 @@ module DocuSign_eSign
|
|
145
172
|
# Specifies the tool tip text for the tab.
|
146
173
|
attr_accessor :name
|
147
174
|
|
175
|
+
# Metadata that indicates whether the `name` property is editable. This property is read-only.
|
148
176
|
attr_accessor :name_metadata
|
149
177
|
|
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,15 +187,19 @@ 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**, this custom tab is shared.
|
166
197
|
attr_accessor :shared
|
167
198
|
|
199
|
+
# Metadata that indicates whether the `shared` property is editable.
|
168
200
|
attr_accessor :shared_metadata
|
169
201
|
|
202
|
+
# Reserved for DocuSign.
|
170
203
|
attr_accessor :smart_contract_information
|
171
204
|
|
172
205
|
#
|
@@ -175,71 +208,85 @@ module DocuSign_eSign
|
|
175
208
|
# 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.
|
176
209
|
attr_accessor :status
|
177
210
|
|
211
|
+
# Metadata that indicates whether the `status` property is editable.
|
178
212
|
attr_accessor :status_metadata
|
179
213
|
|
180
214
|
#
|
181
215
|
attr_accessor :tab_group_labels
|
182
216
|
|
217
|
+
# Metadata that indicates whether the `tabGroupLabels` property is editable.
|
183
218
|
attr_accessor :tab_group_labels_metadata
|
184
219
|
|
185
220
|
# The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
|
186
221
|
attr_accessor :tab_id
|
187
222
|
|
223
|
+
# Metadata that indicates whether the `tabId` property is editable.
|
188
224
|
attr_accessor :tab_id_metadata
|
189
225
|
|
190
226
|
# The label string associated with the tab.
|
191
227
|
attr_accessor :tab_label
|
192
228
|
|
229
|
+
# Metadata that indicates whether the `tabLabel` property is editable.
|
193
230
|
attr_accessor :tab_label_metadata
|
194
231
|
|
195
232
|
#
|
196
233
|
attr_accessor :tab_order
|
197
234
|
|
235
|
+
# Metadata that indicates whether the `tabOrder` property is editable.
|
198
236
|
attr_accessor :tab_order_metadata
|
199
237
|
|
200
238
|
#
|
201
239
|
attr_accessor :tab_type
|
202
240
|
|
241
|
+
# Metadata that indicates whether the `tabType` property is editable.
|
203
242
|
attr_accessor :tab_type_metadata
|
204
243
|
|
205
244
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
206
245
|
attr_accessor :template_locked
|
207
246
|
|
247
|
+
# Metadata that indicates whether the `templateLocked` property is editable.
|
208
248
|
attr_accessor :template_locked_metadata
|
209
249
|
|
210
250
|
# When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
|
211
251
|
attr_accessor :template_required
|
212
252
|
|
253
|
+
# Metadata that indicates whether the `templateRequired` property is editable.
|
213
254
|
attr_accessor :template_required_metadata
|
214
255
|
|
215
256
|
#
|
216
257
|
attr_accessor :tooltip
|
217
258
|
|
259
|
+
# Metadata that indicates whether the `toolTip` property is editable.
|
218
260
|
attr_accessor :tool_tip_metadata
|
219
261
|
|
220
262
|
# When set to **true**, the information in the tab is underlined.
|
221
263
|
attr_accessor :underline
|
222
264
|
|
265
|
+
# Metadata that indicates whether the `underline` property is editable.
|
223
266
|
attr_accessor :underline_metadata
|
224
267
|
|
225
268
|
# Specifies the value of the tab.
|
226
269
|
attr_accessor :value
|
227
270
|
|
271
|
+
# Metadata that indicates whether the `value` property is editable.
|
228
272
|
attr_accessor :value_metadata
|
229
273
|
|
230
274
|
# Width of the tab in pixels.
|
231
275
|
attr_accessor :width
|
232
276
|
|
277
|
+
# Metadata that indicates whether the `width` property is editable.
|
233
278
|
attr_accessor :width_metadata
|
234
279
|
|
235
280
|
# This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
236
281
|
attr_accessor :x_position
|
237
282
|
|
283
|
+
# Metadata that indicates whether the `xPosition` property is editable.
|
238
284
|
attr_accessor :x_position_metadata
|
239
285
|
|
240
286
|
# This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
241
287
|
attr_accessor :y_position
|
242
288
|
|
289
|
+
# Metadata that indicates whether the `yPosition` property is editable.
|
243
290
|
attr_accessor :y_position_metadata
|
244
291
|
|
245
292
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -14,8 +14,10 @@ require 'date'
|
|
14
14
|
module DocuSign_eSign
|
15
15
|
# A complex element that specifies the notification options for the envelope. It consists of: * useAccountDefaults - When set to **true**, the account default notification settings are used for the envelope. * reminders - A complex element that specifies reminder settings for the envelope. It consists of: * reminderEnabled - When set to **true**, a reminder message is sent to the recipient. * reminderDelay - An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. * reminderFrequency - An interger that sets the interval, in days, between reminder emails. * expirations - A complex element that specifies the expiration settings for the envelope. It consists of: * expireEnabled - When set to **true**, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. * expireAfter - An integer that sets the number of days the envelope is active. * expireWarn - An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.
|
16
16
|
class Notification
|
17
|
+
# A complex element that specifies the expiration settings for the envelope.
|
17
18
|
attr_accessor :expirations
|
18
19
|
|
20
|
+
# A complex element that specifies reminder settings for the envelope.
|
19
21
|
attr_accessor :reminders
|
20
22
|
|
21
23
|
# When set to **true**, the account default notification settings are used for the envelope.
|
@@ -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
|
+
# Contains details about the default notification settings for the envelope notifications that senders and signers receive.
|
15
16
|
class NotificationDefaultSettings
|
17
|
+
# An array of email notifications that sets the email the user receives when they are a sender. When the specific email notification is set to true, the user will receive those types of email notifications from DocuSign. The user inherits the default account sender email notification settings when the user is created. The email notifications are: * envelopeComplete * changedSigner * senderEnvelopeDeclined * withdrawnConsent * recipientViewed * deliveryFailed
|
16
18
|
attr_accessor :sender_email_notifications
|
17
19
|
|
20
|
+
# An array of email notifications that specifies the email the user receives when they are a recipient. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account email notification settings when the user is created.
|
18
21
|
attr_accessor :signer_email_notifications
|
19
22
|
|
20
23
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -13,8 +13,10 @@ require 'date'
|
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
15
|
class NotificationDefaults
|
16
|
+
# The default notification settings for envelopes sent by using the console.
|
16
17
|
attr_accessor :api_email_notifications
|
17
18
|
|
19
|
+
# The default notification settings for envelopes sent by using the API.
|
18
20
|
attr_accessor :email_notifications
|
19
21
|
|
20
22
|
# Attribute mapping from ruby-style variable name to JSON key.
|