docusign_esign 3.18.0 → 3.20.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 +64 -64
- 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 +1226 -104
- 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 +13 -1
- 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 +748 -5
- 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 +35 -1
- 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 +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_log.rb +1 -0
- data/lib/docusign_esign/models/connect_o_auth_config.rb +224 -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/delayed_routing.rb +3 -3
- data/lib/docusign_esign/models/direct_debit_processor_information.rb +1 -0
- data/lib/docusign_esign/models/doc_gen_form_field.rb +224 -0
- data/lib/docusign_esign/models/doc_gen_syntax_error.rb +204 -0
- data/lib/docusign_esign/models/document.rb +26 -1
- 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_delay_rule.rb +3 -2
- data/lib/docusign_esign/models/envelope_document.rb +52 -1
- 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 +23 -1
- data/lib/docusign_esign/models/envelope_template_results.rb +1 -0
- data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -0
- data/lib/docusign_esign/models/envelope_transfer_rule.rb +6 -0
- data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +4 -0
- data/lib/docusign_esign/models/envelope_update_summary.rb +4 -0
- data/lib/docusign_esign/models/envelopes_information.rb +1 -0
- data/lib/docusign_esign/models/event_notification.rb +12 -1
- data/lib/docusign_esign/models/event_result.rb +1 -0
- data/lib/docusign_esign/models/external_document_sources.rb +6 -0
- data/lib/docusign_esign/models/external_file.rb +1 -0
- data/lib/docusign_esign/models/external_folder.rb +1 -0
- data/lib/docusign_esign/models/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 +41 -1
- 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/scheduled_sending.rb +3 -3
- 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 +3 -0
- metadata +9 -6
@@ -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 the recipient's email as entered in the recipient information.
|
15
16
|
class EmailAddress
|
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
|
#
|
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,10 +187,13 @@ module DocuSign_eSign
|
|
158
187
|
#
|
159
188
|
attr_accessor :recipient_id_guid
|
160
189
|
|
190
|
+
# Metadata that indicates whether the `recipientIdGuid` property is editable.
|
161
191
|
attr_accessor :recipient_id_guid_metadata
|
162
192
|
|
193
|
+
# Metadata that indicates whether the `recipientId` property is editable.
|
163
194
|
attr_accessor :recipient_id_metadata
|
164
195
|
|
196
|
+
# Reserved for DocuSign.
|
165
197
|
attr_accessor :smart_contract_information
|
166
198
|
|
167
199
|
#
|
@@ -170,71 +202,85 @@ module DocuSign_eSign
|
|
170
202
|
# Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
|
171
203
|
attr_accessor :status
|
172
204
|
|
205
|
+
# Metadata that indicates whether the `status` property is editable.
|
173
206
|
attr_accessor :status_metadata
|
174
207
|
|
175
208
|
#
|
176
209
|
attr_accessor :tab_group_labels
|
177
210
|
|
211
|
+
# Metadata that indicates whether the `tabGroupLabels` property is editable.
|
178
212
|
attr_accessor :tab_group_labels_metadata
|
179
213
|
|
180
214
|
# The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
|
181
215
|
attr_accessor :tab_id
|
182
216
|
|
217
|
+
# Metadata that indicates whether the `tabId` property is editable.
|
183
218
|
attr_accessor :tab_id_metadata
|
184
219
|
|
185
220
|
# The label string associated with the tab.
|
186
221
|
attr_accessor :tab_label
|
187
222
|
|
223
|
+
# Metadata that indicates whether the `tabLabel` property is editable.
|
188
224
|
attr_accessor :tab_label_metadata
|
189
225
|
|
190
226
|
#
|
191
227
|
attr_accessor :tab_order
|
192
228
|
|
229
|
+
# Metadata that indicates whether the `tabOrder` property is editable.
|
193
230
|
attr_accessor :tab_order_metadata
|
194
231
|
|
195
232
|
#
|
196
233
|
attr_accessor :tab_type
|
197
234
|
|
235
|
+
# Metadata that indicates whether the `tabType` property is editable.
|
198
236
|
attr_accessor :tab_type_metadata
|
199
237
|
|
200
238
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
201
239
|
attr_accessor :template_locked
|
202
240
|
|
241
|
+
# Metadata that indicates whether the `templateLocked` property is editable.
|
203
242
|
attr_accessor :template_locked_metadata
|
204
243
|
|
205
244
|
# When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
|
206
245
|
attr_accessor :template_required
|
207
246
|
|
247
|
+
# Metadata that indicates whether the `templateRequired` property is editable.
|
208
248
|
attr_accessor :template_required_metadata
|
209
249
|
|
210
250
|
#
|
211
251
|
attr_accessor :tooltip
|
212
252
|
|
253
|
+
# Metadata that indicates whether the `toolTip` property is editable.
|
213
254
|
attr_accessor :tool_tip_metadata
|
214
255
|
|
215
256
|
# When set to **true**, the information in the tab is underlined.
|
216
257
|
attr_accessor :underline
|
217
258
|
|
259
|
+
# Metadata that indicates whether the `underline` property is editable.
|
218
260
|
attr_accessor :underline_metadata
|
219
261
|
|
220
262
|
# Specifies the value of the tab.
|
221
263
|
attr_accessor :value
|
222
264
|
|
265
|
+
# Metadata that indicates whether the `value` property is editable.
|
223
266
|
attr_accessor :value_metadata
|
224
267
|
|
225
268
|
# Width of the tab in pixels.
|
226
269
|
attr_accessor :width
|
227
270
|
|
271
|
+
# Metadata that indicates whether the `width` property is editable.
|
228
272
|
attr_accessor :width_metadata
|
229
273
|
|
230
274
|
# This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
231
275
|
attr_accessor :x_position
|
232
276
|
|
277
|
+
# Metadata that indicates whether the `xPosition` property is editable.
|
233
278
|
attr_accessor :x_position_metadata
|
234
279
|
|
235
280
|
# This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
236
281
|
attr_accessor :y_position
|
237
282
|
|
283
|
+
# Metadata that indicates whether the `yPosition` property is editable.
|
238
284
|
attr_accessor :y_position_metadata
|
239
285
|
|
240
286
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -64,6 +64,7 @@ module DocuSign_eSign
|
|
64
64
|
# Indicates the date and time the item was created.
|
65
65
|
attr_accessor :created_date_time
|
66
66
|
|
67
|
+
# An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each `customField` string can be a maximum of 100 characters.
|
67
68
|
attr_accessor :custom_fields
|
68
69
|
|
69
70
|
# Contains a URI for an endpoint that you can use to retrieve the custom fields.
|
@@ -93,6 +94,7 @@ module DocuSign_eSign
|
|
93
94
|
# This is the same as the email body. If specified it is included in email body for all envelope recipients.
|
94
95
|
attr_accessor :email_blurb
|
95
96
|
|
97
|
+
# A complex type that contains email settings.
|
96
98
|
attr_accessor :email_settings
|
97
99
|
|
98
100
|
# Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.
|
@@ -107,6 +109,7 @@ module DocuSign_eSign
|
|
107
109
|
#
|
108
110
|
attr_accessor :envelope_attachments
|
109
111
|
|
112
|
+
#
|
110
113
|
attr_accessor :envelope_custom_metadata
|
111
114
|
|
112
115
|
#
|
@@ -121,6 +124,7 @@ module DocuSign_eSign
|
|
121
124
|
#
|
122
125
|
attr_accessor :envelope_location
|
123
126
|
|
127
|
+
# Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service.
|
124
128
|
attr_accessor :envelope_metadata
|
125
129
|
|
126
130
|
# Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
|
@@ -171,16 +175,19 @@ module DocuSign_eSign
|
|
171
175
|
#
|
172
176
|
attr_accessor :location
|
173
177
|
|
178
|
+
# Provides lock information about an envelope that a user has locked.
|
174
179
|
attr_accessor :lock_information
|
175
180
|
|
176
181
|
# When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.
|
177
182
|
attr_accessor :message_lock
|
178
183
|
|
184
|
+
#
|
179
185
|
attr_accessor :notification
|
180
186
|
|
181
187
|
# Contains a URI for an endpoint that you can use to retrieve the notifications.
|
182
188
|
attr_accessor :notification_uri
|
183
189
|
|
190
|
+
# Information about any PowerForms that are included in the envelope.
|
184
191
|
attr_accessor :power_form
|
185
192
|
|
186
193
|
#
|
@@ -192,6 +199,7 @@ module DocuSign_eSign
|
|
192
199
|
#
|
193
200
|
attr_accessor :purge_state
|
194
201
|
|
202
|
+
# An array of recipient objects that provides details about the recipients of the envelope.
|
195
203
|
attr_accessor :recipients
|
196
204
|
|
197
205
|
# When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
|
@@ -200,6 +208,7 @@ module DocuSign_eSign
|
|
200
208
|
# Contains a URI for an endpoint that you can use to retrieve the recipients.
|
201
209
|
attr_accessor :recipients_uri
|
202
210
|
|
211
|
+
# Information about the sender of the envelope.
|
203
212
|
attr_accessor :sender
|
204
213
|
|
205
214
|
# The date and time the envelope was sent.
|
@@ -235,6 +244,7 @@ module DocuSign_eSign
|
|
235
244
|
# The reason the envelope or template was voided.
|
236
245
|
attr_accessor :voided_reason
|
237
246
|
|
247
|
+
#
|
238
248
|
attr_accessor :workflow
|
239
249
|
|
240
250
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# Envelope object definition.
|
15
16
|
class EnvelopeDefinition
|
16
17
|
#
|
17
18
|
attr_accessor :access_control_list_base64
|
@@ -76,6 +77,7 @@ module DocuSign_eSign
|
|
76
77
|
# Indicates the date and time the item was created.
|
77
78
|
attr_accessor :created_date_time
|
78
79
|
|
80
|
+
# An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each `customField` string can be a maximum of 100 characters. **Note:** Any custom fields you set with this API method will _replace_ custom fields you have defined with [Envelope Custom Fields in Admin](https://support.docusign.com/en/guides/ndse-admin-guide-document-labels), whether the **Show field to envelope creators** or **Make fields required for envelopes** options are checked or not.
|
79
81
|
attr_accessor :custom_fields
|
80
82
|
|
81
83
|
# Contains a URI for an endpoint that you can use to retrieve the custom fields.
|
@@ -108,6 +110,7 @@ module DocuSign_eSign
|
|
108
110
|
# Optional element. This is the same as the email body. If specified it is included in email body for all envelope recipients. This can be a maximum of 10000 characters
|
109
111
|
attr_accessor :email_blurb
|
110
112
|
|
113
|
+
# This optional complex element enables the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope, as well as the BCC email addresses to which an envelope is sent. When the `emailSettings` information is used for an envelope, it only applies to that envelope. **Important Note:** The `emailSettings` information is not returned in the GET method for envelope status. Use GET /email_settings to return information about the emailSettings.
|
111
114
|
attr_accessor :email_settings
|
112
115
|
|
113
116
|
# Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.
|
@@ -122,6 +125,7 @@ module DocuSign_eSign
|
|
122
125
|
#
|
123
126
|
attr_accessor :envelope_attachments
|
124
127
|
|
128
|
+
#
|
125
129
|
attr_accessor :envelope_custom_metadata
|
126
130
|
|
127
131
|
#
|
@@ -136,11 +140,13 @@ module DocuSign_eSign
|
|
136
140
|
#
|
137
141
|
attr_accessor :envelope_location
|
138
142
|
|
143
|
+
# Metadata about the features that are enabled for the envelope.
|
139
144
|
attr_accessor :envelope_metadata
|
140
145
|
|
141
146
|
# Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
|
142
147
|
attr_accessor :envelope_uri
|
143
148
|
|
149
|
+
# This optional object is used to register a webhook that will receive status changes for this envelope.
|
144
150
|
attr_accessor :event_notification
|
145
151
|
|
146
152
|
#
|
@@ -191,11 +197,13 @@ module DocuSign_eSign
|
|
191
197
|
#
|
192
198
|
attr_accessor :location
|
193
199
|
|
200
|
+
# Provides lock information about an envelope that a user has locked.
|
194
201
|
attr_accessor :lock_information
|
195
202
|
|
196
203
|
# When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.
|
197
204
|
attr_accessor :message_lock
|
198
205
|
|
206
|
+
# An optional complex element that specifies the notification options for the envelope.
|
199
207
|
attr_accessor :notification
|
200
208
|
|
201
209
|
# Contains a URI for an endpoint that you can use to retrieve the notifications.
|
@@ -204,6 +212,7 @@ module DocuSign_eSign
|
|
204
212
|
#
|
205
213
|
attr_accessor :password
|
206
214
|
|
215
|
+
# Information about any PowerForms that are included in the envelope.
|
207
216
|
attr_accessor :power_form
|
208
217
|
|
209
218
|
#
|
@@ -215,6 +224,7 @@ module DocuSign_eSign
|
|
215
224
|
# Initiates a purge request. Valid values are: * documents_queued: Places envelope documents in the purge queue. * documents_and_metadata_queued: Places envelope documents and metadata in the purge queue.
|
216
225
|
attr_accessor :purge_state
|
217
226
|
|
227
|
+
# Specifies the envelope recipients.
|
218
228
|
attr_accessor :recipients
|
219
229
|
|
220
230
|
# When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
|
@@ -223,8 +233,10 @@ module DocuSign_eSign
|
|
223
233
|
# Contains a URI for an endpoint that you can use to retrieve the recipients.
|
224
234
|
attr_accessor :recipients_uri
|
225
235
|
|
236
|
+
#
|
226
237
|
attr_accessor :recipient_view_request
|
227
238
|
|
239
|
+
# Information about the sender of the envelope.
|
228
240
|
attr_accessor :sender
|
229
241
|
|
230
242
|
# The date and time the envelope was sent.
|
@@ -266,6 +278,7 @@ module DocuSign_eSign
|
|
266
278
|
# The reason the envelope or template was voided.
|
267
279
|
attr_accessor :voided_reason
|
268
280
|
|
281
|
+
# Describes the workflow for this envelope.
|
269
282
|
attr_accessor :workflow
|
270
283
|
|
271
284
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -12,11 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# An envelope delay rule is a rule which determines how the envelope should be delayed either for sending or routing. It can expressed as either a delay in some number of days, hours, minutes and seconds or an exact resumeDate in the future.
|
15
16
|
class EnvelopeDelayRule
|
16
|
-
#
|
17
|
+
# A string timespan duration represented as d.hh:mm:ss where the d component is days, hh is hours measured on a 24-hour clock, mm is minutes and ss is seconds, indicating the expected delay for this envelope rule. The maximum delay is 30 days.
|
17
18
|
attr_accessor :delay
|
18
19
|
|
19
|
-
#
|
20
|
+
# A string formatted as an ISO 8601 DATETIME with TimeZone specified, indicating the expected resumeDate for this envelope rule. The specified datetime must occur in the future relative to the current UTC time hen the request is made. The maximum resumeDate must not exceed 30 days in the future.
|
20
21
|
attr_accessor :resume_date
|
21
22
|
|
22
23
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# This object contains details about the envelope document.
|
15
16
|
class EnvelopeDocument
|
16
17
|
#
|
17
18
|
attr_accessor :added_recipient_ids
|
@@ -22,6 +23,7 @@ module DocuSign_eSign
|
|
22
23
|
# Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.
|
23
24
|
attr_accessor :authoritative_copy
|
24
25
|
|
26
|
+
# Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents.
|
25
27
|
attr_accessor :authoritative_copy_metadata
|
26
28
|
|
27
29
|
#
|
@@ -33,8 +35,18 @@ module DocuSign_eSign
|
|
33
35
|
#
|
34
36
|
attr_accessor :display
|
35
37
|
|
38
|
+
# Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents.
|
36
39
|
attr_accessor :display_metadata
|
37
40
|
|
41
|
+
#
|
42
|
+
attr_accessor :doc_gen_document_status
|
43
|
+
|
44
|
+
#
|
45
|
+
attr_accessor :doc_gen_errors
|
46
|
+
|
47
|
+
#
|
48
|
+
attr_accessor :doc_gen_form_fields
|
49
|
+
|
38
50
|
#
|
39
51
|
attr_accessor :document_base64
|
40
52
|
|
@@ -47,16 +59,22 @@ module DocuSign_eSign
|
|
47
59
|
#
|
48
60
|
attr_accessor :document_id_guid
|
49
61
|
|
62
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
50
63
|
attr_accessor :error_details
|
51
64
|
|
52
65
|
#
|
53
66
|
attr_accessor :include_in_download
|
54
67
|
|
68
|
+
# Metadata that indicates if the sender can edit the `includeInDownload` property. Not applicable for template documents.
|
55
69
|
attr_accessor :include_in_download_metadata
|
56
70
|
|
71
|
+
#
|
72
|
+
attr_accessor :is_doc_gen_document
|
73
|
+
|
57
74
|
#
|
58
75
|
attr_accessor :name
|
59
76
|
|
77
|
+
# Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents.
|
60
78
|
attr_accessor :name_metadata
|
61
79
|
|
62
80
|
#
|
@@ -68,6 +86,7 @@ module DocuSign_eSign
|
|
68
86
|
#
|
69
87
|
attr_accessor :signer_must_acknowledge
|
70
88
|
|
89
|
+
# Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents.
|
71
90
|
attr_accessor :signer_must_acknowledge_metadata
|
72
91
|
|
73
92
|
#
|
@@ -96,6 +115,9 @@ module DocuSign_eSign
|
|
96
115
|
:'contains_pdf_form_fields' => :'containsPdfFormFields',
|
97
116
|
:'display' => :'display',
|
98
117
|
:'display_metadata' => :'displayMetadata',
|
118
|
+
:'doc_gen_document_status' => :'docGenDocumentStatus',
|
119
|
+
:'doc_gen_errors' => :'docGenErrors',
|
120
|
+
:'doc_gen_form_fields' => :'docGenFormFields',
|
99
121
|
:'document_base64' => :'documentBase64',
|
100
122
|
:'document_fields' => :'documentFields',
|
101
123
|
:'document_id' => :'documentId',
|
@@ -103,6 +125,7 @@ module DocuSign_eSign
|
|
103
125
|
:'error_details' => :'errorDetails',
|
104
126
|
:'include_in_download' => :'includeInDownload',
|
105
127
|
:'include_in_download_metadata' => :'includeInDownloadMetadata',
|
128
|
+
:'is_doc_gen_document' => :'isDocGenDocument',
|
106
129
|
:'name' => :'name',
|
107
130
|
:'name_metadata' => :'nameMetadata',
|
108
131
|
:'order' => :'order',
|
@@ -128,6 +151,9 @@ module DocuSign_eSign
|
|
128
151
|
:'contains_pdf_form_fields' => :'String',
|
129
152
|
:'display' => :'String',
|
130
153
|
:'display_metadata' => :'PropertyMetadata',
|
154
|
+
:'doc_gen_document_status' => :'String',
|
155
|
+
:'doc_gen_errors' => :'Array<DocGenSyntaxError>',
|
156
|
+
:'doc_gen_form_fields' => :'Array<DocGenFormField>',
|
131
157
|
:'document_base64' => :'String',
|
132
158
|
:'document_fields' => :'Array<NameValue>',
|
133
159
|
:'document_id' => :'String',
|
@@ -135,6 +161,7 @@ module DocuSign_eSign
|
|
135
161
|
:'error_details' => :'ErrorDetails',
|
136
162
|
:'include_in_download' => :'String',
|
137
163
|
:'include_in_download_metadata' => :'PropertyMetadata',
|
164
|
+
:'is_doc_gen_document' => :'String',
|
138
165
|
:'name' => :'String',
|
139
166
|
:'name_metadata' => :'PropertyMetadata',
|
140
167
|
:'order' => :'String',
|
@@ -193,6 +220,22 @@ module DocuSign_eSign
|
|
193
220
|
self.display_metadata = attributes[:'displayMetadata']
|
194
221
|
end
|
195
222
|
|
223
|
+
if attributes.has_key?(:'docGenDocumentStatus')
|
224
|
+
self.doc_gen_document_status = attributes[:'docGenDocumentStatus']
|
225
|
+
end
|
226
|
+
|
227
|
+
if attributes.has_key?(:'docGenErrors')
|
228
|
+
if (value = attributes[:'docGenErrors']).is_a?(Array)
|
229
|
+
self.doc_gen_errors = value
|
230
|
+
end
|
231
|
+
end
|
232
|
+
|
233
|
+
if attributes.has_key?(:'docGenFormFields')
|
234
|
+
if (value = attributes[:'docGenFormFields']).is_a?(Array)
|
235
|
+
self.doc_gen_form_fields = value
|
236
|
+
end
|
237
|
+
end
|
238
|
+
|
196
239
|
if attributes.has_key?(:'documentBase64')
|
197
240
|
self.document_base64 = attributes[:'documentBase64']
|
198
241
|
end
|
@@ -223,6 +266,10 @@ module DocuSign_eSign
|
|
223
266
|
self.include_in_download_metadata = attributes[:'includeInDownloadMetadata']
|
224
267
|
end
|
225
268
|
|
269
|
+
if attributes.has_key?(:'isDocGenDocument')
|
270
|
+
self.is_doc_gen_document = attributes[:'isDocGenDocument']
|
271
|
+
end
|
272
|
+
|
226
273
|
if attributes.has_key?(:'name')
|
227
274
|
self.name = attributes[:'name']
|
228
275
|
end
|
@@ -296,6 +343,9 @@ module DocuSign_eSign
|
|
296
343
|
contains_pdf_form_fields == o.contains_pdf_form_fields &&
|
297
344
|
display == o.display &&
|
298
345
|
display_metadata == o.display_metadata &&
|
346
|
+
doc_gen_document_status == o.doc_gen_document_status &&
|
347
|
+
doc_gen_errors == o.doc_gen_errors &&
|
348
|
+
doc_gen_form_fields == o.doc_gen_form_fields &&
|
299
349
|
document_base64 == o.document_base64 &&
|
300
350
|
document_fields == o.document_fields &&
|
301
351
|
document_id == o.document_id &&
|
@@ -303,6 +353,7 @@ module DocuSign_eSign
|
|
303
353
|
error_details == o.error_details &&
|
304
354
|
include_in_download == o.include_in_download &&
|
305
355
|
include_in_download_metadata == o.include_in_download_metadata &&
|
356
|
+
is_doc_gen_document == o.is_doc_gen_document &&
|
306
357
|
name == o.name &&
|
307
358
|
name_metadata == o.name_metadata &&
|
308
359
|
order == o.order &&
|
@@ -325,7 +376,7 @@ module DocuSign_eSign
|
|
325
376
|
# Calculates hash code according to all attributes.
|
326
377
|
# @return [Fixnum] Hash code
|
327
378
|
def hash
|
328
|
-
[added_recipient_ids, attachment_tab_id, authoritative_copy, authoritative_copy_metadata, available_document_types, contains_pdf_form_fields, display, display_metadata, document_base64, document_fields, document_id, document_id_guid, error_details, include_in_download, include_in_download_metadata, name, name_metadata, order, pages, signer_must_acknowledge, signer_must_acknowledge_metadata, size_bytes, template_locked, template_required, type, uri].hash
|
379
|
+
[added_recipient_ids, attachment_tab_id, authoritative_copy, authoritative_copy_metadata, available_document_types, contains_pdf_form_fields, display, display_metadata, doc_gen_document_status, doc_gen_errors, doc_gen_form_fields, document_base64, document_fields, document_id, document_id_guid, error_details, include_in_download, include_in_download_metadata, is_doc_gen_document, name, name_metadata, order, pages, signer_must_acknowledge, signer_must_acknowledge_metadata, size_bytes, template_locked, template_required, type, uri].hash
|
329
380
|
end
|
330
381
|
|
331
382
|
# 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
|
+
# For which envelope events should your webhook be called?
|
15
16
|
class EnvelopeEvent
|
16
17
|
# he envelope status, this can be Sent, Delivered, Completed, Declined, or Voided.
|
17
18
|
attr_accessor :envelope_event_status_code
|
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# Describes the form data of the envelope.
|
15
16
|
class EnvelopeFormData
|
16
17
|
# Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.
|
17
18
|
attr_accessor :email_subject
|
@@ -22,6 +23,7 @@ module DocuSign_eSign
|
|
22
23
|
#
|
23
24
|
attr_accessor :form_data
|
24
25
|
|
26
|
+
# An array of `formDataItem` objects for [prefill tabs](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs).
|
25
27
|
attr_accessor :prefill_form_data
|
26
28
|
|
27
29
|
#
|