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
@@ -0,0 +1,204 @@
|
|
1
|
+
=begin
|
2
|
+
#DocuSign REST API
|
3
|
+
|
4
|
+
#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
|
5
|
+
|
6
|
+
OpenAPI spec version: v2.1
|
7
|
+
Contact: devcenter@docusign.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
=end
|
11
|
+
|
12
|
+
require 'date'
|
13
|
+
|
14
|
+
module DocuSign_eSign
|
15
|
+
class DocGenSyntaxError
|
16
|
+
#
|
17
|
+
attr_accessor :error_code
|
18
|
+
|
19
|
+
#
|
20
|
+
attr_accessor :message
|
21
|
+
|
22
|
+
#
|
23
|
+
attr_accessor :tag_identifier
|
24
|
+
|
25
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
26
|
+
def self.attribute_map
|
27
|
+
{
|
28
|
+
:'error_code' => :'errorCode',
|
29
|
+
:'message' => :'message',
|
30
|
+
:'tag_identifier' => :'tagIdentifier'
|
31
|
+
}
|
32
|
+
end
|
33
|
+
|
34
|
+
# Attribute type mapping.
|
35
|
+
def self.swagger_types
|
36
|
+
{
|
37
|
+
:'error_code' => :'String',
|
38
|
+
:'message' => :'String',
|
39
|
+
:'tag_identifier' => :'String'
|
40
|
+
}
|
41
|
+
end
|
42
|
+
|
43
|
+
# Initializes the object
|
44
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
45
|
+
def initialize(attributes = {})
|
46
|
+
return unless attributes.is_a?(Hash)
|
47
|
+
|
48
|
+
# convert string to symbol for hash key
|
49
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
50
|
+
|
51
|
+
if attributes.has_key?(:'errorCode')
|
52
|
+
self.error_code = attributes[:'errorCode']
|
53
|
+
end
|
54
|
+
|
55
|
+
if attributes.has_key?(:'message')
|
56
|
+
self.message = attributes[:'message']
|
57
|
+
end
|
58
|
+
|
59
|
+
if attributes.has_key?(:'tagIdentifier')
|
60
|
+
self.tag_identifier = attributes[:'tagIdentifier']
|
61
|
+
end
|
62
|
+
end
|
63
|
+
|
64
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
65
|
+
# @return Array for valid properties with the reasons
|
66
|
+
def list_invalid_properties
|
67
|
+
invalid_properties = Array.new
|
68
|
+
invalid_properties
|
69
|
+
end
|
70
|
+
|
71
|
+
# Check to see if the all the properties in the model are valid
|
72
|
+
# @return true if the model is valid
|
73
|
+
def valid?
|
74
|
+
true
|
75
|
+
end
|
76
|
+
|
77
|
+
# Checks equality by comparing each attribute.
|
78
|
+
# @param [Object] Object to be compared
|
79
|
+
def ==(o)
|
80
|
+
return true if self.equal?(o)
|
81
|
+
self.class == o.class &&
|
82
|
+
error_code == o.error_code &&
|
83
|
+
message == o.message &&
|
84
|
+
tag_identifier == o.tag_identifier
|
85
|
+
end
|
86
|
+
|
87
|
+
# @see the `==` method
|
88
|
+
# @param [Object] Object to be compared
|
89
|
+
def eql?(o)
|
90
|
+
self == o
|
91
|
+
end
|
92
|
+
|
93
|
+
# Calculates hash code according to all attributes.
|
94
|
+
# @return [Fixnum] Hash code
|
95
|
+
def hash
|
96
|
+
[error_code, message, tag_identifier].hash
|
97
|
+
end
|
98
|
+
|
99
|
+
# Builds the object from hash
|
100
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
101
|
+
# @return [Object] Returns the model itself
|
102
|
+
def build_from_hash(attributes)
|
103
|
+
return nil unless attributes.is_a?(Hash)
|
104
|
+
self.class.swagger_types.each_pair do |key, type|
|
105
|
+
if type =~ /\AArray<(.*)>/i
|
106
|
+
# check to ensure the input is an array given that the attribute
|
107
|
+
# is documented as an array but the input is not
|
108
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
109
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
110
|
+
end
|
111
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
112
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
113
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
114
|
+
end
|
115
|
+
|
116
|
+
self
|
117
|
+
end
|
118
|
+
|
119
|
+
# Deserializes the data based on type
|
120
|
+
# @param string type Data type
|
121
|
+
# @param string value Value to be deserialized
|
122
|
+
# @return [Object] Deserialized data
|
123
|
+
def _deserialize(type, value)
|
124
|
+
case type.to_sym
|
125
|
+
when :DateTime
|
126
|
+
DateTime.parse(value)
|
127
|
+
when :Date
|
128
|
+
Date.parse(value)
|
129
|
+
when :String
|
130
|
+
value.to_s
|
131
|
+
when :Integer
|
132
|
+
value.to_i
|
133
|
+
when :Float
|
134
|
+
value.to_f
|
135
|
+
when :BOOLEAN
|
136
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
137
|
+
true
|
138
|
+
else
|
139
|
+
false
|
140
|
+
end
|
141
|
+
when :Object
|
142
|
+
# generic object (usually a Hash), return directly
|
143
|
+
value
|
144
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
145
|
+
inner_type = Regexp.last_match[:inner_type]
|
146
|
+
value.map { |v| _deserialize(inner_type, v) }
|
147
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
148
|
+
k_type = Regexp.last_match[:k_type]
|
149
|
+
v_type = Regexp.last_match[:v_type]
|
150
|
+
{}.tap do |hash|
|
151
|
+
value.each do |k, v|
|
152
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
153
|
+
end
|
154
|
+
end
|
155
|
+
else # model
|
156
|
+
temp_model = DocuSign_eSign.const_get(type).new
|
157
|
+
temp_model.build_from_hash(value)
|
158
|
+
end
|
159
|
+
end
|
160
|
+
|
161
|
+
# Returns the string representation of the object
|
162
|
+
# @return [String] String presentation of the object
|
163
|
+
def to_s
|
164
|
+
to_hash.to_s
|
165
|
+
end
|
166
|
+
|
167
|
+
# to_body is an alias to to_hash (backward compatibility)
|
168
|
+
# @return [Hash] Returns the object in the form of hash
|
169
|
+
def to_body
|
170
|
+
to_hash
|
171
|
+
end
|
172
|
+
|
173
|
+
# Returns the object in the form of hash
|
174
|
+
# @return [Hash] Returns the object in the form of hash
|
175
|
+
def to_hash
|
176
|
+
hash = {}
|
177
|
+
self.class.attribute_map.each_pair do |attr, param|
|
178
|
+
value = self.send(attr)
|
179
|
+
next if value.nil?
|
180
|
+
hash[param] = _to_hash(value)
|
181
|
+
end
|
182
|
+
hash
|
183
|
+
end
|
184
|
+
|
185
|
+
# Outputs non-array value in the form of hash
|
186
|
+
# For object, use to_hash. Otherwise, just return the value
|
187
|
+
# @param [Object] value Any valid value
|
188
|
+
# @return [Hash] Returns the value in the form of hash
|
189
|
+
def _to_hash(value)
|
190
|
+
if value.is_a?(Array)
|
191
|
+
value.compact.map { |v| _to_hash(v) }
|
192
|
+
elsif value.is_a?(Hash)
|
193
|
+
{}.tap do |hash|
|
194
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
195
|
+
end
|
196
|
+
elsif value.respond_to? :to_hash
|
197
|
+
value.to_hash
|
198
|
+
else
|
199
|
+
value
|
200
|
+
end
|
201
|
+
end
|
202
|
+
|
203
|
+
end
|
204
|
+
end
|
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# A document object.
|
15
16
|
class Document
|
16
17
|
# Reserved: TBD
|
17
18
|
attr_accessor :apply_anchor_tabs
|
@@ -22,6 +23,9 @@ module DocuSign_eSign
|
|
22
23
|
#
|
23
24
|
attr_accessor :display
|
24
25
|
|
26
|
+
#
|
27
|
+
attr_accessor :doc_gen_form_fields
|
28
|
+
|
25
29
|
# The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding.
|
26
30
|
attr_accessor :document_base64
|
27
31
|
|
@@ -40,11 +44,15 @@ module DocuSign_eSign
|
|
40
44
|
#
|
41
45
|
attr_accessor :file_format_hint
|
42
46
|
|
47
|
+
# Defines how to generate the responsive-formatted HTML for the document. See [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) in the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/).
|
43
48
|
attr_accessor :html_definition
|
44
49
|
|
45
50
|
#
|
46
51
|
attr_accessor :include_in_download
|
47
52
|
|
53
|
+
#
|
54
|
+
attr_accessor :is_doc_gen_document
|
55
|
+
|
48
56
|
# Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. A matchbox consists of 5 elements: * pageNumber - The document page number on which the matchbox will appear. * xPosition - The x position of the matchbox on a page. * yPosition - The y position of the matchbox on a page. * width - The width of the matchbox. * height - The height of the matchbox.
|
49
57
|
attr_accessor :match_boxes
|
50
58
|
|
@@ -72,6 +80,7 @@ module DocuSign_eSign
|
|
72
80
|
#
|
73
81
|
attr_accessor :signer_must_acknowledge_use_account_default
|
74
82
|
|
83
|
+
# A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.
|
75
84
|
attr_accessor :tabs
|
76
85
|
|
77
86
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
@@ -92,6 +101,7 @@ module DocuSign_eSign
|
|
92
101
|
:'apply_anchor_tabs' => :'applyAnchorTabs',
|
93
102
|
:'assign_tabs_to_recipient_id' => :'assignTabsToRecipientId',
|
94
103
|
:'display' => :'display',
|
104
|
+
:'doc_gen_form_fields' => :'docGenFormFields',
|
95
105
|
:'document_base64' => :'documentBase64',
|
96
106
|
:'document_fields' => :'documentFields',
|
97
107
|
:'document_id' => :'documentId',
|
@@ -100,6 +110,7 @@ module DocuSign_eSign
|
|
100
110
|
:'file_format_hint' => :'fileFormatHint',
|
101
111
|
:'html_definition' => :'htmlDefinition',
|
102
112
|
:'include_in_download' => :'includeInDownload',
|
113
|
+
:'is_doc_gen_document' => :'isDocGenDocument',
|
103
114
|
:'match_boxes' => :'matchBoxes',
|
104
115
|
:'name' => :'name',
|
105
116
|
:'order' => :'order',
|
@@ -123,6 +134,7 @@ module DocuSign_eSign
|
|
123
134
|
:'apply_anchor_tabs' => :'String',
|
124
135
|
:'assign_tabs_to_recipient_id' => :'String',
|
125
136
|
:'display' => :'String',
|
137
|
+
:'doc_gen_form_fields' => :'Array<DocGenFormField>',
|
126
138
|
:'document_base64' => :'String',
|
127
139
|
:'document_fields' => :'Array<NameValue>',
|
128
140
|
:'document_id' => :'String',
|
@@ -131,6 +143,7 @@ module DocuSign_eSign
|
|
131
143
|
:'file_format_hint' => :'String',
|
132
144
|
:'html_definition' => :'DocumentHtmlDefinition',
|
133
145
|
:'include_in_download' => :'String',
|
146
|
+
:'is_doc_gen_document' => :'String',
|
134
147
|
:'match_boxes' => :'Array<MatchBox>',
|
135
148
|
:'name' => :'String',
|
136
149
|
:'order' => :'String',
|
@@ -168,6 +181,12 @@ module DocuSign_eSign
|
|
168
181
|
self.display = attributes[:'display']
|
169
182
|
end
|
170
183
|
|
184
|
+
if attributes.has_key?(:'docGenFormFields')
|
185
|
+
if (value = attributes[:'docGenFormFields']).is_a?(Array)
|
186
|
+
self.doc_gen_form_fields = value
|
187
|
+
end
|
188
|
+
end
|
189
|
+
|
171
190
|
if attributes.has_key?(:'documentBase64')
|
172
191
|
self.document_base64 = attributes[:'documentBase64']
|
173
192
|
end
|
@@ -202,6 +221,10 @@ module DocuSign_eSign
|
|
202
221
|
self.include_in_download = attributes[:'includeInDownload']
|
203
222
|
end
|
204
223
|
|
224
|
+
if attributes.has_key?(:'isDocGenDocument')
|
225
|
+
self.is_doc_gen_document = attributes[:'isDocGenDocument']
|
226
|
+
end
|
227
|
+
|
205
228
|
if attributes.has_key?(:'matchBoxes')
|
206
229
|
if (value = attributes[:'matchBoxes']).is_a?(Array)
|
207
230
|
self.match_boxes = value
|
@@ -282,6 +305,7 @@ module DocuSign_eSign
|
|
282
305
|
apply_anchor_tabs == o.apply_anchor_tabs &&
|
283
306
|
assign_tabs_to_recipient_id == o.assign_tabs_to_recipient_id &&
|
284
307
|
display == o.display &&
|
308
|
+
doc_gen_form_fields == o.doc_gen_form_fields &&
|
285
309
|
document_base64 == o.document_base64 &&
|
286
310
|
document_fields == o.document_fields &&
|
287
311
|
document_id == o.document_id &&
|
@@ -290,6 +314,7 @@ module DocuSign_eSign
|
|
290
314
|
file_format_hint == o.file_format_hint &&
|
291
315
|
html_definition == o.html_definition &&
|
292
316
|
include_in_download == o.include_in_download &&
|
317
|
+
is_doc_gen_document == o.is_doc_gen_document &&
|
293
318
|
match_boxes == o.match_boxes &&
|
294
319
|
name == o.name &&
|
295
320
|
order == o.order &&
|
@@ -315,7 +340,7 @@ module DocuSign_eSign
|
|
315
340
|
# Calculates hash code according to all attributes.
|
316
341
|
# @return [Fixnum] Hash code
|
317
342
|
def hash
|
318
|
-
[apply_anchor_tabs, assign_tabs_to_recipient_id, display, document_base64, document_fields, document_id, encrypted_with_key_manager, file_extension, file_format_hint, html_definition, include_in_download, match_boxes, name, order, pages, password, pdf_form_field_option, remote_url, signer_must_acknowledge, signer_must_acknowledge_use_account_default, tabs, template_locked, template_required, transform_pdf_fields, uri].hash
|
343
|
+
[apply_anchor_tabs, assign_tabs_to_recipient_id, display, doc_gen_form_fields, document_base64, document_fields, document_id, encrypted_with_key_manager, file_extension, file_format_hint, html_definition, include_in_download, is_doc_gen_document, match_boxes, name, order, pages, password, pdf_form_field_option, remote_url, signer_must_acknowledge, signer_must_acknowledge_use_account_default, tabs, template_locked, template_required, transform_pdf_fields, uri].hash
|
319
344
|
end
|
320
345
|
|
321
346
|
# 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
|
+
# Holds the properties that define how to generate the responsive-formatted HTML for the document. See [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) in the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/).
|
15
16
|
class DocumentHtmlDefinition
|
16
17
|
#
|
17
18
|
attr_accessor :display_anchor_prefix
|
@@ -22,6 +22,7 @@ module DocuSign_eSign
|
|
22
22
|
#
|
23
23
|
attr_accessor :document_start_page
|
24
24
|
|
25
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
25
26
|
attr_accessor :error_details
|
26
27
|
|
27
28
|
# The unique identifier of the template. If this is not provided, DocuSign will generate a value.
|
@@ -12,10 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# This object configures a recipient's read/write access to a document.
|
15
16
|
class DocumentVisibility
|
16
17
|
# Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
|
17
18
|
attr_accessor :document_id
|
18
19
|
|
20
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
19
21
|
attr_accessor :error_details
|
20
22
|
|
21
23
|
# Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
|
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# A list of `documentVisibility` objects that specify whether documents are visible to recipients.
|
15
16
|
class DocumentVisibilityList
|
16
17
|
#
|
17
18
|
attr_accessor :document_visibility
|
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# A tab that allows the recipient to add a free-form drawing to the document.
|
15
16
|
class Draw
|
16
17
|
#
|
17
18
|
attr_accessor :allow_signer_upload
|
@@ -19,51 +20,61 @@ module DocuSign_eSign
|
|
19
20
|
#
|
20
21
|
attr_accessor :anchor_allow_white_space_in_characters
|
21
22
|
|
23
|
+
# Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.
|
22
24
|
attr_accessor :anchor_allow_white_space_in_characters_metadata
|
23
25
|
|
24
26
|
# When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
|
25
27
|
attr_accessor :anchor_case_sensitive
|
26
28
|
|
29
|
+
# Metadata that indicates whether the `anchorCaseSensitive` property is editable.
|
27
30
|
attr_accessor :anchor_case_sensitive_metadata
|
28
31
|
|
29
32
|
# Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
|
30
33
|
attr_accessor :anchor_horizontal_alignment
|
31
34
|
|
35
|
+
# Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
|
32
36
|
attr_accessor :anchor_horizontal_alignment_metadata
|
33
37
|
|
34
38
|
# When set to **true**, this tab is ignored if anchorString is not found in the document.
|
35
39
|
attr_accessor :anchor_ignore_if_not_present
|
36
40
|
|
41
|
+
# Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.
|
37
42
|
attr_accessor :anchor_ignore_if_not_present_metadata
|
38
43
|
|
39
44
|
# 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**.
|
40
45
|
attr_accessor :anchor_match_whole_word
|
41
46
|
|
47
|
+
# Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
|
42
48
|
attr_accessor :anchor_match_whole_word_metadata
|
43
49
|
|
44
50
|
# Anchor text information for a radio button.
|
45
51
|
attr_accessor :anchor_string
|
46
52
|
|
53
|
+
# Metadata that indicates whether the `anchorString` property is editable.
|
47
54
|
attr_accessor :anchor_string_metadata
|
48
55
|
|
49
56
|
#
|
50
57
|
attr_accessor :anchor_tab_processor_version
|
51
58
|
|
59
|
+
# Reserved for DocuSign.
|
52
60
|
attr_accessor :anchor_tab_processor_version_metadata
|
53
61
|
|
54
62
|
# Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
|
55
63
|
attr_accessor :anchor_units
|
56
64
|
|
65
|
+
# Metadata that indicates whether the `anchorUnits` property is editable.
|
57
66
|
attr_accessor :anchor_units_metadata
|
58
67
|
|
59
68
|
# Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
|
60
69
|
attr_accessor :anchor_x_offset
|
61
70
|
|
71
|
+
# Metadata that indicates whether the `anchorXOffset` property is editable.
|
62
72
|
attr_accessor :anchor_x_offset_metadata
|
63
73
|
|
64
74
|
# Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
|
65
75
|
attr_accessor :anchor_y_offset
|
66
76
|
|
77
|
+
# Metadata that indicates whether the `anchorYOffset` property is editable.
|
67
78
|
attr_accessor :anchor_y_offset_metadata
|
68
79
|
|
69
80
|
#
|
@@ -74,50 +85,61 @@ module DocuSign_eSign
|
|
74
85
|
# For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
|
75
86
|
attr_accessor :conditional_parent_label
|
76
87
|
|
88
|
+
# Metadata that indicates whether the `conditionalParentLabel` property is editable.
|
77
89
|
attr_accessor :conditional_parent_label_metadata
|
78
90
|
|
79
91
|
# 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.
|
80
92
|
attr_accessor :conditional_parent_value
|
81
93
|
|
94
|
+
# Metadata that indicates whether the `conditionalParentValue` property is editable.
|
82
95
|
attr_accessor :conditional_parent_value_metadata
|
83
96
|
|
84
97
|
# 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.
|
85
98
|
attr_accessor :custom_tab_id
|
86
99
|
|
100
|
+
# Metadata that indicates whether the `customTabId` property is editable.
|
87
101
|
attr_accessor :custom_tab_id_metadata
|
88
102
|
|
89
103
|
# Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
|
90
104
|
attr_accessor :document_id
|
91
105
|
|
106
|
+
# Metadata that indicates whether the `documentId` property is editable.
|
92
107
|
attr_accessor :document_id_metadata
|
93
108
|
|
109
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
94
110
|
attr_accessor :error_details
|
95
111
|
|
96
112
|
#
|
97
113
|
attr_accessor :form_order
|
98
114
|
|
115
|
+
# Metadata that indicates whether the `formOrder` property is editable.
|
99
116
|
attr_accessor :form_order_metadata
|
100
117
|
|
101
118
|
#
|
102
119
|
attr_accessor :form_page_label
|
103
120
|
|
121
|
+
# Metadata that indicates whether the `formPageLabel` property is editable.
|
104
122
|
attr_accessor :form_page_label_metadata
|
105
123
|
|
106
124
|
#
|
107
125
|
attr_accessor :form_page_number
|
108
126
|
|
127
|
+
# Metadata that indicates whether the `fromPageNumber` property is editable.
|
109
128
|
attr_accessor :form_page_number_metadata
|
110
129
|
|
111
130
|
# Height of the tab in pixels.
|
112
131
|
attr_accessor :height
|
113
132
|
|
133
|
+
# Metadata that indicates whether the `height` property is editable.
|
114
134
|
attr_accessor :height_metadata
|
115
135
|
|
116
136
|
# When set to **true**, the signer cannot change the data of the custom tab.
|
117
137
|
attr_accessor :locked
|
118
138
|
|
139
|
+
# Metadata that indicates whether the `locked` property is editable.
|
119
140
|
attr_accessor :locked_metadata
|
120
141
|
|
142
|
+
# Contains the information necessary to map the tab to a field in SalesForce.
|
121
143
|
attr_accessor :merge_field
|
122
144
|
|
123
145
|
#
|
@@ -126,6 +148,7 @@ module DocuSign_eSign
|
|
126
148
|
# Specifies the page number on which the tab is located.
|
127
149
|
attr_accessor :page_number
|
128
150
|
|
151
|
+
# Metadata that indicates whether the `pageNumber` property is editable.
|
129
152
|
attr_accessor :page_number_metadata
|
130
153
|
|
131
154
|
# Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
|
@@ -134,20 +157,25 @@ module DocuSign_eSign
|
|
134
157
|
#
|
135
158
|
attr_accessor :recipient_id_guid
|
136
159
|
|
160
|
+
# Metadata that indicates whether the `recipientIdGuid` property is editable.
|
137
161
|
attr_accessor :recipient_id_guid_metadata
|
138
162
|
|
163
|
+
# Metadata that indicates whether the `recipientId` property is editable.
|
139
164
|
attr_accessor :recipient_id_metadata
|
140
165
|
|
141
166
|
# When set to **true**, the signer is required to fill out this tab
|
142
167
|
attr_accessor :required
|
143
168
|
|
169
|
+
# Metadata that indicates whether the `required` property is editable.
|
144
170
|
attr_accessor :required_metadata
|
145
171
|
|
146
172
|
# When set to **true**, this custom tab is shared.
|
147
173
|
attr_accessor :shared
|
148
174
|
|
175
|
+
# Metadata that indicates whether the `shared` property is editable.
|
149
176
|
attr_accessor :shared_metadata
|
150
177
|
|
178
|
+
# Reserved for DocuSign.
|
151
179
|
attr_accessor :smart_contract_information
|
152
180
|
|
153
181
|
#
|
@@ -156,43 +184,52 @@ module DocuSign_eSign
|
|
156
184
|
# 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.
|
157
185
|
attr_accessor :status
|
158
186
|
|
187
|
+
# Metadata that indicates whether the `status` property is editable.
|
159
188
|
attr_accessor :status_metadata
|
160
189
|
|
161
190
|
#
|
162
191
|
attr_accessor :tab_group_labels
|
163
192
|
|
193
|
+
# Metadata that indicates whether the `tabGroupLabels` property is editable.
|
164
194
|
attr_accessor :tab_group_labels_metadata
|
165
195
|
|
166
196
|
# The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
|
167
197
|
attr_accessor :tab_id
|
168
198
|
|
199
|
+
# Metadata that indicates whether the `tabId` property is editable.
|
169
200
|
attr_accessor :tab_id_metadata
|
170
201
|
|
202
|
+
# Metadata that indicates whether the `tabLabel` property is editable.
|
171
203
|
attr_accessor :tab_label_metadata
|
172
204
|
|
173
205
|
#
|
174
206
|
attr_accessor :tab_order
|
175
207
|
|
208
|
+
# Metadata that indicates whether the `tabOrder` property is editable.
|
176
209
|
attr_accessor :tab_order_metadata
|
177
210
|
|
178
211
|
#
|
179
212
|
attr_accessor :tab_type
|
180
213
|
|
214
|
+
# Metadata that indicates whether the `tabType` property is editable.
|
181
215
|
attr_accessor :tab_type_metadata
|
182
216
|
|
183
217
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
184
218
|
attr_accessor :template_locked
|
185
219
|
|
220
|
+
# Metadata that indicates whether the `templateLocked` property is editable.
|
186
221
|
attr_accessor :template_locked_metadata
|
187
222
|
|
188
223
|
# When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
|
189
224
|
attr_accessor :template_required
|
190
225
|
|
226
|
+
# Metadata that indicates whether the `templateRequired` property is editable.
|
191
227
|
attr_accessor :template_required_metadata
|
192
228
|
|
193
229
|
#
|
194
230
|
attr_accessor :tooltip
|
195
231
|
|
232
|
+
# Metadata that indicates whether the `toolTip` property is editable.
|
196
233
|
attr_accessor :tool_tip_metadata
|
197
234
|
|
198
235
|
#
|
@@ -201,16 +238,19 @@ module DocuSign_eSign
|
|
201
238
|
# Width of the tab in pixels.
|
202
239
|
attr_accessor :width
|
203
240
|
|
241
|
+
# Metadata that indicates whether the `width` property is editable.
|
204
242
|
attr_accessor :width_metadata
|
205
243
|
|
206
244
|
# This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
207
245
|
attr_accessor :x_position
|
208
246
|
|
247
|
+
# Metadata that indicates whether the `xPosition` property is editable.
|
209
248
|
attr_accessor :x_position_metadata
|
210
249
|
|
211
250
|
# This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
212
251
|
attr_accessor :y_position
|
213
252
|
|
253
|
+
# Metadata that indicates whether the `yPosition` property is editable.
|
214
254
|
attr_accessor :y_position_metadata
|
215
255
|
|
216
256
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# This object contains information used to configure [eNote](https://www.docusign.com/products/enote) functionality. To use eNote, the Allow eNote for eOriginal account plan item must be on, and the Connect configuration for eOriginal must be set correctly.
|
15
16
|
class ENoteConfiguration
|
16
17
|
#
|
17
18
|
attr_accessor :api_key
|