docusign_esign 3.18.0 → 3.19.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/lib/docusign_esign/api/accounts_api.rb +60 -60
- data/lib/docusign_esign/api/billing_api.rb +2 -2
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +22 -22
- data/lib/docusign_esign/api/connect_api.rb +148 -0
- data/lib/docusign_esign/api/email_archive_api.rb +8 -8
- data/lib/docusign_esign/api/envelopes_api.rb +1223 -105
- data/lib/docusign_esign/api/notary_api.rb +16 -16
- data/lib/docusign_esign/api/power_forms_api.rb +16 -16
- data/lib/docusign_esign/api/templates_api.rb +20 -20
- data/lib/docusign_esign/api/users_api.rb +14 -14
- data/lib/docusign_esign/api/workspaces_api.rb +4 -4
- data/lib/docusign_esign/client/api_client.rb +1 -1
- data/lib/docusign_esign/models/access_code_format.rb +6 -0
- data/lib/docusign_esign/models/account_billing_plan.rb +1 -0
- data/lib/docusign_esign/models/account_billing_plan_response.rb +9 -0
- data/lib/docusign_esign/models/account_identity_verification_step.rb +1 -0
- data/lib/docusign_esign/models/account_identity_verification_workflow.rb +2 -0
- data/lib/docusign_esign/models/account_information.rb +1 -0
- data/lib/docusign_esign/models/account_notification.rb +3 -0
- data/lib/docusign_esign/models/account_password_questions_required.rb +1 -0
- data/lib/docusign_esign/models/account_password_rules.rb +7 -0
- data/lib/docusign_esign/models/account_role_settings.rb +39 -0
- data/lib/docusign_esign/models/account_settings_information.rb +537 -3
- data/lib/docusign_esign/models/account_shared_access.rb +1 -0
- data/lib/docusign_esign/models/account_signature.rb +2 -0
- data/lib/docusign_esign/models/account_signature_definition.rb +1 -0
- data/lib/docusign_esign/models/account_signature_provider.rb +1 -0
- data/lib/docusign_esign/models/account_signature_provider_option.rb +1 -0
- data/lib/docusign_esign/models/account_ui_settings.rb +15 -0
- data/lib/docusign_esign/models/address_information_input.rb +1 -0
- data/lib/docusign_esign/models/agent.rb +22 -0
- data/lib/docusign_esign/models/approve.rb +45 -0
- data/lib/docusign_esign/models/authentication_status.rb +19 -0
- data/lib/docusign_esign/models/bcc_email_archive.rb +3 -0
- data/lib/docusign_esign/models/bcc_email_archive_history.rb +2 -0
- data/lib/docusign_esign/models/bcc_email_archive_list.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_information.rb +19 -1
- data/lib/docusign_esign/models/billing_plan_preview.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_response.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_update_response.rb +1 -0
- data/lib/docusign_esign/models/brand.rb +4 -0
- data/lib/docusign_esign/models/brand_email_content.rb +1 -0
- data/lib/docusign_esign/models/brand_link.rb +1 -0
- data/lib/docusign_esign/models/brand_logos.rb +1 -0
- data/lib/docusign_esign/models/brand_request.rb +1 -0
- data/lib/docusign_esign/models/brand_resource_urls.rb +1 -0
- data/lib/docusign_esign/models/brand_resources.rb +3 -0
- data/lib/docusign_esign/models/brands_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_envelope.rb +1 -0
- data/lib/docusign_esign/models/bulk_recipients_update_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_action_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_status.rb +2 -0
- data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_summary.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_error_status.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_test_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +5 -0
- data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list_summary.rb +1 -0
- data/lib/docusign_esign/models/captive_recipient.rb +2 -0
- data/lib/docusign_esign/models/captive_recipient_information.rb +1 -0
- data/lib/docusign_esign/models/carbon_copy.rb +25 -0
- data/lib/docusign_esign/models/certified_delivery.rb +24 -0
- data/lib/docusign_esign/models/checkbox.rb +52 -39
- data/lib/docusign_esign/models/chunked_upload_part.rb +1 -0
- data/lib/docusign_esign/models/chunked_upload_request.rb +1 -0
- data/lib/docusign_esign/models/chunked_upload_response.rb +1 -0
- data/lib/docusign_esign/models/cloud_storage_provider.rb +2 -0
- data/lib/docusign_esign/models/comment_thread.rb +43 -0
- data/lib/docusign_esign/models/commission_county.rb +52 -0
- data/lib/docusign_esign/models/commission_expiration.rb +52 -0
- data/lib/docusign_esign/models/commission_number.rb +52 -0
- data/lib/docusign_esign/models/commission_state.rb +52 -0
- data/lib/docusign_esign/models/company.rb +52 -0
- data/lib/docusign_esign/models/composite_template.rb +2 -0
- data/lib/docusign_esign/models/conditional_recipient_rule.rb +2 -0
- data/lib/docusign_esign/models/connect_config_results.rb +1 -0
- data/lib/docusign_esign/models/connect_custom_configuration.rb +2 -0
- data/lib/docusign_esign/models/connect_debug_log.rb +1 -0
- data/lib/docusign_esign/models/connect_event_data.rb +1 -0
- data/lib/docusign_esign/models/connect_failure_filter.rb +1 -0
- data/lib/docusign_esign/models/connect_failure_result.rb +1 -0
- data/lib/docusign_esign/models/connect_log.rb +1 -0
- data/lib/docusign_esign/models/connect_o_auth_config.rb +214 -0
- data/lib/docusign_esign/models/connect_salesforce_field.rb +1 -0
- data/lib/docusign_esign/models/connect_salesforce_object.rb +1 -0
- data/lib/docusign_esign/models/console_view_request.rb +1 -0
- data/lib/docusign_esign/models/consumer_disclosure.rb +3 -0
- data/lib/docusign_esign/models/contact.rb +1 -0
- data/lib/docusign_esign/models/contact_get_response.rb +1 -0
- data/lib/docusign_esign/models/contact_mod_request.rb +1 -0
- data/lib/docusign_esign/models/contact_phone_number.rb +1 -0
- data/lib/docusign_esign/models/contact_update_response.rb +1 -0
- data/lib/docusign_esign/models/correct_view_request.rb +12 -1
- data/lib/docusign_esign/models/credit_card_information.rb +2 -0
- data/lib/docusign_esign/models/currency.rb +55 -0
- data/lib/docusign_esign/models/currency_feature_set_price.rb +1 -0
- data/lib/docusign_esign/models/currency_plan_price.rb +1 -0
- data/lib/docusign_esign/models/custom_field.rb +2 -0
- data/lib/docusign_esign/models/date.rb +59 -0
- data/lib/docusign_esign/models/date_signed.rb +46 -0
- data/lib/docusign_esign/models/date_stamp_properties.rb +1 -0
- data/lib/docusign_esign/models/decline.rb +46 -0
- data/lib/docusign_esign/models/direct_debit_processor_information.rb +1 -0
- data/lib/docusign_esign/models/document.rb +3 -0
- data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +1 -0
- data/lib/docusign_esign/models/document_html_definition.rb +1 -0
- data/lib/docusign_esign/models/document_html_definition_original.rb +1 -0
- data/lib/docusign_esign/models/document_html_display_anchor.rb +1 -0
- data/lib/docusign_esign/models/document_html_display_settings.rb +1 -0
- data/lib/docusign_esign/models/document_template.rb +1 -0
- data/lib/docusign_esign/models/document_visibility.rb +2 -0
- data/lib/docusign_esign/models/document_visibility_list.rb +1 -0
- data/lib/docusign_esign/models/downgrad_request_billing_info_response.rb +1 -0
- data/lib/docusign_esign/models/downgrade_billing_plan_information.rb +1 -0
- data/lib/docusign_esign/models/draw.rb +40 -0
- data/lib/docusign_esign/models/e_note_configuration.rb +1 -0
- data/lib/docusign_esign/models/editor.rb +23 -0
- data/lib/docusign_esign/models/email.rb +59 -0
- data/lib/docusign_esign/models/email_address.rb +46 -0
- data/lib/docusign_esign/models/envelope.rb +10 -0
- data/lib/docusign_esign/models/envelope_attachment.rb +1 -0
- data/lib/docusign_esign/models/envelope_definition.rb +13 -0
- data/lib/docusign_esign/models/envelope_document.rb +7 -0
- data/lib/docusign_esign/models/envelope_event.rb +1 -0
- data/lib/docusign_esign/models/envelope_form_data.rb +2 -0
- data/lib/docusign_esign/models/envelope_id.rb +45 -0
- data/lib/docusign_esign/models/envelope_ids_request.rb +1 -0
- data/lib/docusign_esign/models/envelope_notification_request.rb +3 -0
- data/lib/docusign_esign/models/envelope_purge_configuration.rb +1 -0
- data/lib/docusign_esign/models/envelope_summary.rb +3 -0
- data/lib/docusign_esign/models/envelope_template.rb +12 -0
- data/lib/docusign_esign/models/envelope_template_results.rb +1 -0
- data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -0
- data/lib/docusign_esign/models/envelope_transfer_rule.rb +6 -0
- data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +4 -0
- data/lib/docusign_esign/models/envelope_update_summary.rb +4 -0
- data/lib/docusign_esign/models/envelopes_information.rb +1 -0
- data/lib/docusign_esign/models/event_notification.rb +1 -0
- data/lib/docusign_esign/models/event_result.rb +1 -0
- data/lib/docusign_esign/models/external_document_sources.rb +6 -0
- data/lib/docusign_esign/models/external_file.rb +1 -0
- data/lib/docusign_esign/models/external_folder.rb +1 -0
- data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -0
- data/lib/docusign_esign/models/favorite_templates_info.rb +1 -0
- data/lib/docusign_esign/models/feature_set.rb +1 -0
- data/lib/docusign_esign/models/filter.rb +1 -0
- data/lib/docusign_esign/models/first_name.rb +46 -0
- data/lib/docusign_esign/models/folder.rb +4 -0
- data/lib/docusign_esign/models/folder_item_response.rb +1 -0
- data/lib/docusign_esign/models/folder_item_v2.rb +2 -0
- data/lib/docusign_esign/models/folder_shared_item.rb +3 -0
- data/lib/docusign_esign/models/folders_request.rb +1 -0
- data/lib/docusign_esign/models/form_data_item.rb +1 -0
- data/lib/docusign_esign/models/formula_tab.rb +64 -0
- data/lib/docusign_esign/models/full_name.rb +46 -0
- data/lib/docusign_esign/models/group.rb +2 -0
- data/lib/docusign_esign/models/id_check_configuration.rb +1 -0
- data/lib/docusign_esign/models/id_check_information_input.rb +4 -0
- data/lib/docusign_esign/models/in_person_signer.rb +31 -0
- data/lib/docusign_esign/models/initial_here.rb +40 -0
- data/lib/docusign_esign/models/inline_template.rb +3 -0
- data/lib/docusign_esign/models/intermediary.rb +23 -0
- data/lib/docusign_esign/models/jurisdiction.rb +1 -0
- data/lib/docusign_esign/models/last_name.rb +46 -0
- data/lib/docusign_esign/models/linked_external_primary_account.rb +1 -0
- data/lib/docusign_esign/models/list.rb +54 -0
- data/lib/docusign_esign/models/list_custom_field.rb +2 -0
- data/lib/docusign_esign/models/list_item.rb +4 -0
- data/lib/docusign_esign/models/locale_policy.rb +13 -0
- data/lib/docusign_esign/models/lock_information.rb +2 -0
- data/lib/docusign_esign/models/lock_request.rb +1 -0
- data/lib/docusign_esign/models/member_group_shared_item.rb +3 -0
- data/lib/docusign_esign/models/member_shared_items.rb +3 -0
- data/lib/docusign_esign/models/merge_field.rb +6 -0
- data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -0
- data/lib/docusign_esign/models/money.rb +1 -0
- data/lib/docusign_esign/models/name_value.rb +2 -0
- data/lib/docusign_esign/models/new_account_definition.rb +20 -1
- data/lib/docusign_esign/models/new_account_summary.rb +1 -0
- data/lib/docusign_esign/models/new_user.rb +2 -0
- data/lib/docusign_esign/models/new_users_summary.rb +1 -0
- data/lib/docusign_esign/models/notarize.rb +38 -0
- data/lib/docusign_esign/models/notary.rb +1 -0
- data/lib/docusign_esign/models/notary_host.rb +20 -0
- data/lib/docusign_esign/models/notary_journal.rb +2 -0
- data/lib/docusign_esign/models/notary_jurisdiction.rb +3 -0
- data/lib/docusign_esign/models/notary_jurisdiction_list.rb +1 -0
- data/lib/docusign_esign/models/notary_recipient.rb +29 -0
- data/lib/docusign_esign/models/notary_result.rb +2 -0
- data/lib/docusign_esign/models/notary_seal.rb +39 -0
- data/lib/docusign_esign/models/note.rb +47 -0
- data/lib/docusign_esign/models/notification.rb +2 -0
- data/lib/docusign_esign/models/notification_default_settings.rb +3 -0
- data/lib/docusign_esign/models/notification_defaults.rb +2 -0
- data/lib/docusign_esign/models/number.rb +61 -0
- data/lib/docusign_esign/models/page.rb +1 -0
- data/lib/docusign_esign/models/payment_details.rb +5 -0
- data/lib/docusign_esign/models/payment_gateway_account.rb +3 -0
- data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +1 -0
- data/lib/docusign_esign/models/payment_line_item.rb +1 -0
- data/lib/docusign_esign/models/payment_method_with_options.rb +1 -0
- data/lib/docusign_esign/models/payment_processor_information.rb +1 -0
- data/lib/docusign_esign/models/permission_profile.rb +2 -0
- data/lib/docusign_esign/models/permission_profile_information.rb +1 -0
- data/lib/docusign_esign/models/phone_number.rb +52 -0
- data/lib/docusign_esign/models/poly_line_overlay.rb +40 -0
- data/lib/docusign_esign/models/power_form.rb +2 -0
- data/lib/docusign_esign/models/power_form_recipient.rb +1 -0
- data/lib/docusign_esign/models/power_form_senders_response.rb +1 -0
- data/lib/docusign_esign/models/power_forms_response.rb +1 -0
- data/lib/docusign_esign/models/prefill_tabs.rb +1 -0
- data/lib/docusign_esign/models/property_metadata.rb +1 -0
- data/lib/docusign_esign/models/radio.rb +28 -0
- data/lib/docusign_esign/models/radio_group.rb +17 -0
- data/lib/docusign_esign/models/recipient_additional_notification.rb +3 -0
- data/lib/docusign_esign/models/recipient_email_notification.rb +3 -0
- data/lib/docusign_esign/models/recipient_group.rb +1 -0
- data/lib/docusign_esign/models/recipient_identity_phone_number.rb +3 -0
- data/lib/docusign_esign/models/recipient_identity_verification.rb +2 -0
- data/lib/docusign_esign/models/recipient_names_response.rb +1 -0
- data/lib/docusign_esign/models/recipient_option.rb +1 -0
- data/lib/docusign_esign/models/recipient_phone_authentication.rb +4 -0
- data/lib/docusign_esign/models/recipient_phone_number.rb +3 -0
- data/lib/docusign_esign/models/recipient_preview_request.rb +2 -0
- data/lib/docusign_esign/models/recipient_proof_file.rb +1 -0
- data/lib/docusign_esign/models/recipient_routing.rb +2 -0
- data/lib/docusign_esign/models/recipient_signature_provider.rb +3 -0
- data/lib/docusign_esign/models/recipient_signature_provider_options.rb +5 -0
- data/lib/docusign_esign/models/recipient_sms_authentication.rb +1 -0
- data/lib/docusign_esign/models/recipient_token_client_ur_ls.rb +30 -30
- data/lib/docusign_esign/models/recipient_update_response.rb +3 -0
- data/lib/docusign_esign/models/recipient_view_request.rb +2 -0
- data/lib/docusign_esign/models/recipients.rb +1 -0
- data/lib/docusign_esign/models/recipients_update_summary.rb +1 -0
- data/lib/docusign_esign/models/return_url_request.rb +1 -0
- data/lib/docusign_esign/models/seal_sign.rb +17 -0
- data/lib/docusign_esign/models/seat_discount.rb +1 -0
- data/lib/docusign_esign/models/sender_company.rb +45 -0
- data/lib/docusign_esign/models/sender_email_notifications.rb +1 -0
- data/lib/docusign_esign/models/sender_name.rb +45 -0
- data/lib/docusign_esign/models/settings_metadata.rb +1 -0
- data/lib/docusign_esign/models/shared_item.rb +3 -0
- data/lib/docusign_esign/models/sign_here.rb +42 -0
- data/lib/docusign_esign/models/signature_provider_required_option.rb +1 -0
- data/lib/docusign_esign/models/signature_type.rb +1 -0
- data/lib/docusign_esign/models/signer.rb +30 -0
- data/lib/docusign_esign/models/signer_attachment.rb +40 -0
- data/lib/docusign_esign/models/signing_group.rb +2 -0
- data/lib/docusign_esign/models/signing_group_user.rb +1 -0
- data/lib/docusign_esign/models/smart_section.rb +41 -0
- data/lib/docusign_esign/models/smart_section_display_settings.rb +2 -0
- data/lib/docusign_esign/models/social_account_information.rb +1 -0
- data/lib/docusign_esign/models/ssn.rb +59 -0
- data/lib/docusign_esign/models/stamp.rb +2 -0
- data/lib/docusign_esign/models/supported_languages.rb +1 -0
- data/lib/docusign_esign/models/tab_account_settings.rb +22 -0
- data/lib/docusign_esign/models/tab_group.rb +41 -0
- data/lib/docusign_esign/models/tab_metadata.rb +14 -1
- data/lib/docusign_esign/models/tabs.rb +2 -0
- data/lib/docusign_esign/models/template_document_visibility_list.rb +1 -0
- data/lib/docusign_esign/models/template_notification_request.rb +2 -0
- data/lib/docusign_esign/models/template_recipients.rb +1 -0
- data/lib/docusign_esign/models/template_role.rb +4 -0
- data/lib/docusign_esign/models/template_shared_item.rb +3 -0
- data/lib/docusign_esign/models/template_summary.rb +3 -0
- data/lib/docusign_esign/models/template_tabs.rb +1 -0
- data/lib/docusign_esign/models/template_update_summary.rb +4 -0
- data/lib/docusign_esign/models/text.rb +61 -0
- data/lib/docusign_esign/models/text_custom_field.rb +2 -0
- data/lib/docusign_esign/models/title.rb +52 -0
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +12 -0
- data/lib/docusign_esign/models/user_info.rb +1 -0
- data/lib/docusign_esign/models/user_information.rb +6 -0
- data/lib/docusign_esign/models/user_information_list.rb +1 -0
- data/lib/docusign_esign/models/user_password_information.rb +1 -0
- data/lib/docusign_esign/models/user_password_rules.rb +2 -0
- data/lib/docusign_esign/models/user_profile.rb +3 -0
- data/lib/docusign_esign/models/user_settings_information.rb +61 -0
- data/lib/docusign_esign/models/user_shared_item.rb +3 -0
- data/lib/docusign_esign/models/user_signature.rb +2 -0
- data/lib/docusign_esign/models/user_signature_definition.rb +1 -0
- data/lib/docusign_esign/models/view.rb +46 -0
- data/lib/docusign_esign/models/witness.rb +30 -0
- data/lib/docusign_esign/models/workflow.rb +2 -0
- data/lib/docusign_esign/models/workflow_step.rb +3 -0
- data/lib/docusign_esign/models/workspace.rb +4 -0
- data/lib/docusign_esign/models/workspace_folder_contents.rb +1 -0
- data/lib/docusign_esign/models/workspace_item.rb +5 -0
- data/lib/docusign_esign/models/workspace_settings.rb +1 -0
- data/lib/docusign_esign/models/workspace_user.rb +1 -0
- data/lib/docusign_esign/models/workspace_user_authorization.rb +2 -0
- data/lib/docusign_esign/models/zip.rb +60 -0
- data/lib/docusign_esign/version.rb +1 -1
- data/lib/docusign_esign.rb +1 -0
- metadata +7 -6
@@ -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
|
+
# Contains information about a certified delivery recipient. Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents.
|
15
16
|
class CertifiedDelivery
|
16
17
|
# If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
|
17
18
|
attr_accessor :access_code
|
18
19
|
|
20
|
+
# Metadata that indicates whether the `accessCode` property is editable. This property is read-only.
|
19
21
|
attr_accessor :access_code_metadata
|
20
22
|
|
21
23
|
# This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
|
@@ -60,6 +62,7 @@ module DocuSign_eSign
|
|
60
62
|
# Reserved: For DocuSign use only.
|
61
63
|
attr_accessor :delivery_method
|
62
64
|
|
65
|
+
# Reserved for DocuSign.
|
63
66
|
attr_accessor :delivery_method_metadata
|
64
67
|
|
65
68
|
#
|
@@ -74,8 +77,10 @@ module DocuSign_eSign
|
|
74
77
|
#
|
75
78
|
attr_accessor :email
|
76
79
|
|
80
|
+
# Metadata that indicates whether the `email` property is editable. This property is read-only.
|
77
81
|
attr_accessor :email_metadata
|
78
82
|
|
83
|
+
# An optional complex type that sets a specific email subject and body for this recipient's notification email. **Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`.
|
79
84
|
attr_accessor :email_notification
|
80
85
|
|
81
86
|
#
|
@@ -84,6 +89,7 @@ module DocuSign_eSign
|
|
84
89
|
# Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`
|
85
90
|
attr_accessor :embedded_recipient_start_url
|
86
91
|
|
92
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
87
93
|
attr_accessor :error_details
|
88
94
|
|
89
95
|
# Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.
|
@@ -92,25 +98,31 @@ module DocuSign_eSign
|
|
92
98
|
# Reserved:
|
93
99
|
attr_accessor :fax_number
|
94
100
|
|
101
|
+
# Reserved for DocuSign.
|
95
102
|
attr_accessor :fax_number_metadata
|
96
103
|
|
97
104
|
# The user's first name. Maximum Length: 50 characters.
|
98
105
|
attr_accessor :first_name
|
99
106
|
|
107
|
+
# Metadata that indicates whether the `firstName` property is editable. This property is read-only.
|
100
108
|
attr_accessor :first_name_metadata
|
101
109
|
|
102
110
|
#
|
103
111
|
attr_accessor :full_name
|
104
112
|
|
113
|
+
# Reserved for DocuSign.
|
105
114
|
attr_accessor :full_name_metadata
|
106
115
|
|
107
116
|
# Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node.
|
108
117
|
attr_accessor :id_check_configuration_name
|
109
118
|
|
119
|
+
# Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only.
|
110
120
|
attr_accessor :id_check_configuration_name_metadata
|
111
121
|
|
122
|
+
# An object that contains input information related to a recipient ID check.
|
112
123
|
attr_accessor :id_check_information_input
|
113
124
|
|
125
|
+
# Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).
|
114
126
|
attr_accessor :identity_verification
|
115
127
|
|
116
128
|
# When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account.
|
@@ -119,6 +131,7 @@ module DocuSign_eSign
|
|
119
131
|
#
|
120
132
|
attr_accessor :last_name
|
121
133
|
|
134
|
+
# Metadata that indicates whether the `lastName` property is editable. This property is read-only.
|
122
135
|
attr_accessor :last_name_metadata
|
123
136
|
|
124
137
|
#
|
@@ -130,22 +143,28 @@ module DocuSign_eSign
|
|
130
143
|
#
|
131
144
|
attr_accessor :name
|
132
145
|
|
146
|
+
# Metadata that indicates whether the `name` property is editable. This property is read-only.
|
133
147
|
attr_accessor :name_metadata
|
134
148
|
|
135
149
|
# Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.
|
136
150
|
attr_accessor :note
|
137
151
|
|
152
|
+
# Metadata that indicates whether the `note` property is editable. This property is read-only.
|
138
153
|
attr_accessor :note_metadata
|
139
154
|
|
155
|
+
# When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign.
|
140
156
|
attr_accessor :phone_authentication
|
141
157
|
|
158
|
+
# Describes the recipient phone number.
|
142
159
|
attr_accessor :phone_number
|
143
160
|
|
161
|
+
# The proof file of the recipient.
|
144
162
|
attr_accessor :proof_file
|
145
163
|
|
146
164
|
# Reserved:
|
147
165
|
attr_accessor :recipient_attachments
|
148
166
|
|
167
|
+
# Information about the recipient's authentication status. This property is read-only.
|
149
168
|
attr_accessor :recipient_authentication_status
|
150
169
|
|
151
170
|
#
|
@@ -160,11 +179,13 @@ module DocuSign_eSign
|
|
160
179
|
#
|
161
180
|
attr_accessor :recipient_type
|
162
181
|
|
182
|
+
# Metadata that indicates whether the `recipientType` property is editable. This property is read-only.
|
163
183
|
attr_accessor :recipient_type_metadata
|
164
184
|
|
165
185
|
# When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
|
166
186
|
attr_accessor :require_id_lookup
|
167
187
|
|
188
|
+
# Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only.
|
168
189
|
attr_accessor :require_id_lookup_metadata
|
169
190
|
|
170
191
|
# Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.
|
@@ -173,6 +194,7 @@ module DocuSign_eSign
|
|
173
194
|
# Specifies the routing order of the recipient in the envelope.
|
174
195
|
attr_accessor :routing_order
|
175
196
|
|
197
|
+
# Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.
|
176
198
|
attr_accessor :routing_order_metadata
|
177
199
|
|
178
200
|
# The date and time the envelope was sent.
|
@@ -184,6 +206,7 @@ module DocuSign_eSign
|
|
184
206
|
# When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
|
185
207
|
attr_accessor :signing_group_id
|
186
208
|
|
209
|
+
# Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only.
|
187
210
|
attr_accessor :signing_group_id_metadata
|
188
211
|
|
189
212
|
# The display name for the signing group. Maximum Length: 100 characters.
|
@@ -192,6 +215,7 @@ module DocuSign_eSign
|
|
192
215
|
# A complex type that contains information about users in the signing group.
|
193
216
|
attr_accessor :signing_group_users
|
194
217
|
|
218
|
+
# When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication.
|
195
219
|
attr_accessor :sms_authentication
|
196
220
|
|
197
221
|
# Lists the social ID type that can be used for recipient authentication.
|
@@ -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 allows the recipient to select a yes/no (on/off) option.
|
15
16
|
class Checkbox
|
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,45 +118,55 @@ 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
|
|
138
163
|
# When set to **true**, the signer cannot change the data of the custom tab.
|
139
164
|
attr_accessor :locked
|
140
165
|
|
166
|
+
# Metadata that indicates whether the `locked` property is editable.
|
141
167
|
attr_accessor :locked_metadata
|
142
168
|
|
169
|
+
# Contains the information necessary to map the tab to a field in SalesForce.
|
143
170
|
attr_accessor :merge_field
|
144
171
|
|
145
172
|
#
|
@@ -148,16 +175,13 @@ module DocuSign_eSign
|
|
148
175
|
# Specifies the tool tip text for the tab.
|
149
176
|
attr_accessor :name
|
150
177
|
|
178
|
+
# Metadata that indicates whether the `name` property is editable. This property is read-only.
|
151
179
|
attr_accessor :name_metadata
|
152
180
|
|
153
|
-
# The initial value of the tab when it was sent to the recipient.
|
154
|
-
attr_accessor :original_value
|
155
|
-
|
156
|
-
attr_accessor :original_value_metadata
|
157
|
-
|
158
181
|
# Specifies the page number on which the tab is located.
|
159
182
|
attr_accessor :page_number
|
160
183
|
|
184
|
+
# Metadata that indicates whether the `pageNumber` property is editable.
|
161
185
|
attr_accessor :page_number_metadata
|
162
186
|
|
163
187
|
# Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
|
@@ -166,40 +190,49 @@ module DocuSign_eSign
|
|
166
190
|
#
|
167
191
|
attr_accessor :recipient_id_guid
|
168
192
|
|
193
|
+
# Metadata that indicates whether the `recipientIdGuid` property is editable.
|
169
194
|
attr_accessor :recipient_id_guid_metadata
|
170
195
|
|
196
|
+
# Metadata that indicates whether the `recipientId` property is editable.
|
171
197
|
attr_accessor :recipient_id_metadata
|
172
198
|
|
173
199
|
# When set to **true**, the signer is required to fill out this tab
|
174
200
|
attr_accessor :required
|
175
201
|
|
202
|
+
# Metadata that indicates whether the `required` property is editable.
|
176
203
|
attr_accessor :required_metadata
|
177
204
|
|
178
205
|
# Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
|
179
206
|
attr_accessor :require_initial_on_shared_change
|
180
207
|
|
208
|
+
# Metadata that indicates whether the `requireInitialOnSharedChange` property is editable.
|
181
209
|
attr_accessor :require_initial_on_shared_change_metadata
|
182
210
|
|
183
211
|
# When set to **true**, the checkbox is selected.
|
184
212
|
attr_accessor :selected
|
185
213
|
|
214
|
+
# Metadata that indicates whether the `selected` property is editable.
|
186
215
|
attr_accessor :selected_metadata
|
187
216
|
|
188
217
|
#
|
189
218
|
attr_accessor :selected_original
|
190
219
|
|
220
|
+
#
|
191
221
|
attr_accessor :selected_original_metadata
|
192
222
|
|
193
223
|
# When set to **true**, this custom tab is shared.
|
194
224
|
attr_accessor :shared
|
195
225
|
|
226
|
+
# Metadata that indicates whether the `shared` property is editable.
|
196
227
|
attr_accessor :shared_metadata
|
197
228
|
|
198
229
|
#
|
199
230
|
attr_accessor :share_to_recipients
|
200
231
|
|
232
|
+
# Reserved for DocuSign.
|
201
233
|
attr_accessor :share_to_recipients_metadata
|
202
234
|
|
235
|
+
# Reserved for DocuSign.
|
203
236
|
attr_accessor :smart_contract_information
|
204
237
|
|
205
238
|
#
|
@@ -208,71 +241,79 @@ module DocuSign_eSign
|
|
208
241
|
# 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.
|
209
242
|
attr_accessor :status
|
210
243
|
|
244
|
+
# Metadata that indicates whether the `status` property is editable.
|
211
245
|
attr_accessor :status_metadata
|
212
246
|
|
213
247
|
#
|
214
248
|
attr_accessor :tab_group_labels
|
215
249
|
|
250
|
+
# Metadata that indicates whether the `tabGroupLabels` property is editable.
|
216
251
|
attr_accessor :tab_group_labels_metadata
|
217
252
|
|
218
253
|
# The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
|
219
254
|
attr_accessor :tab_id
|
220
255
|
|
256
|
+
# Metadata that indicates whether the `tabId` property is editable.
|
221
257
|
attr_accessor :tab_id_metadata
|
222
258
|
|
223
259
|
# The label string associated with the tab.
|
224
260
|
attr_accessor :tab_label
|
225
261
|
|
262
|
+
# Metadata that indicates whether the `tabLabel` property is editable.
|
226
263
|
attr_accessor :tab_label_metadata
|
227
264
|
|
228
265
|
#
|
229
266
|
attr_accessor :tab_order
|
230
267
|
|
268
|
+
# Metadata that indicates whether the `tabOrder` property is editable.
|
231
269
|
attr_accessor :tab_order_metadata
|
232
270
|
|
233
271
|
#
|
234
272
|
attr_accessor :tab_type
|
235
273
|
|
274
|
+
# Metadata that indicates whether the `tabType` property is editable.
|
236
275
|
attr_accessor :tab_type_metadata
|
237
276
|
|
238
277
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
239
278
|
attr_accessor :template_locked
|
240
279
|
|
280
|
+
# Metadata that indicates whether the `templateLocked` property is editable.
|
241
281
|
attr_accessor :template_locked_metadata
|
242
282
|
|
243
283
|
# When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
|
244
284
|
attr_accessor :template_required
|
245
285
|
|
286
|
+
# Metadata that indicates whether the `templateRequired` property is editable.
|
246
287
|
attr_accessor :template_required_metadata
|
247
288
|
|
248
289
|
#
|
249
290
|
attr_accessor :tooltip
|
250
291
|
|
292
|
+
# Metadata that indicates whether the `toolTip` property is editable.
|
251
293
|
attr_accessor :tool_tip_metadata
|
252
294
|
|
253
295
|
# When set to **true**, the information in the tab is underlined.
|
254
296
|
attr_accessor :underline
|
255
297
|
|
298
|
+
# Metadata that indicates whether the `underline` property is editable.
|
256
299
|
attr_accessor :underline_metadata
|
257
300
|
|
258
|
-
# Specifies the value of the tab.
|
259
|
-
attr_accessor :value
|
260
|
-
|
261
|
-
attr_accessor :value_metadata
|
262
|
-
|
263
301
|
# Width of the tab in pixels.
|
264
302
|
attr_accessor :width
|
265
303
|
|
304
|
+
# Metadata that indicates whether the `width` property is editable.
|
266
305
|
attr_accessor :width_metadata
|
267
306
|
|
268
307
|
# This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
269
308
|
attr_accessor :x_position
|
270
309
|
|
310
|
+
# Metadata that indicates whether the `xPosition` property is editable.
|
271
311
|
attr_accessor :x_position_metadata
|
272
312
|
|
273
313
|
# This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
274
314
|
attr_accessor :y_position
|
275
315
|
|
316
|
+
# Metadata that indicates whether the `yPosition` property is editable.
|
276
317
|
attr_accessor :y_position_metadata
|
277
318
|
|
278
319
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -333,8 +374,6 @@ module DocuSign_eSign
|
|
333
374
|
:'merge_field_xml' => :'mergeFieldXml',
|
334
375
|
:'name' => :'name',
|
335
376
|
:'name_metadata' => :'nameMetadata',
|
336
|
-
:'original_value' => :'originalValue',
|
337
|
-
:'original_value_metadata' => :'originalValueMetadata',
|
338
377
|
:'page_number' => :'pageNumber',
|
339
378
|
:'page_number_metadata' => :'pageNumberMetadata',
|
340
379
|
:'recipient_id' => :'recipientId',
|
@@ -375,8 +414,6 @@ module DocuSign_eSign
|
|
375
414
|
:'tool_tip_metadata' => :'toolTipMetadata',
|
376
415
|
:'underline' => :'underline',
|
377
416
|
:'underline_metadata' => :'underlineMetadata',
|
378
|
-
:'value' => :'value',
|
379
|
-
:'value_metadata' => :'valueMetadata',
|
380
417
|
:'width' => :'width',
|
381
418
|
:'width_metadata' => :'widthMetadata',
|
382
419
|
:'x_position' => :'xPosition',
|
@@ -444,8 +481,6 @@ module DocuSign_eSign
|
|
444
481
|
:'merge_field_xml' => :'String',
|
445
482
|
:'name' => :'String',
|
446
483
|
:'name_metadata' => :'PropertyMetadata',
|
447
|
-
:'original_value' => :'String',
|
448
|
-
:'original_value_metadata' => :'PropertyMetadata',
|
449
484
|
:'page_number' => :'String',
|
450
485
|
:'page_number_metadata' => :'PropertyMetadata',
|
451
486
|
:'recipient_id' => :'String',
|
@@ -486,8 +521,6 @@ module DocuSign_eSign
|
|
486
521
|
:'tool_tip_metadata' => :'PropertyMetadata',
|
487
522
|
:'underline' => :'String',
|
488
523
|
:'underline_metadata' => :'PropertyMetadata',
|
489
|
-
:'value' => :'String',
|
490
|
-
:'value_metadata' => :'PropertyMetadata',
|
491
524
|
:'width' => :'String',
|
492
525
|
:'width_metadata' => :'PropertyMetadata',
|
493
526
|
:'x_position' => :'String',
|
@@ -725,14 +758,6 @@ module DocuSign_eSign
|
|
725
758
|
self.name_metadata = attributes[:'nameMetadata']
|
726
759
|
end
|
727
760
|
|
728
|
-
if attributes.has_key?(:'originalValue')
|
729
|
-
self.original_value = attributes[:'originalValue']
|
730
|
-
end
|
731
|
-
|
732
|
-
if attributes.has_key?(:'originalValueMetadata')
|
733
|
-
self.original_value_metadata = attributes[:'originalValueMetadata']
|
734
|
-
end
|
735
|
-
|
736
761
|
if attributes.has_key?(:'pageNumber')
|
737
762
|
self.page_number = attributes[:'pageNumber']
|
738
763
|
end
|
@@ -895,14 +920,6 @@ module DocuSign_eSign
|
|
895
920
|
self.underline_metadata = attributes[:'underlineMetadata']
|
896
921
|
end
|
897
922
|
|
898
|
-
if attributes.has_key?(:'value')
|
899
|
-
self.value = attributes[:'value']
|
900
|
-
end
|
901
|
-
|
902
|
-
if attributes.has_key?(:'valueMetadata')
|
903
|
-
self.value_metadata = attributes[:'valueMetadata']
|
904
|
-
end
|
905
|
-
|
906
923
|
if attributes.has_key?(:'width')
|
907
924
|
self.width = attributes[:'width']
|
908
925
|
end
|
@@ -1001,8 +1018,6 @@ module DocuSign_eSign
|
|
1001
1018
|
merge_field_xml == o.merge_field_xml &&
|
1002
1019
|
name == o.name &&
|
1003
1020
|
name_metadata == o.name_metadata &&
|
1004
|
-
original_value == o.original_value &&
|
1005
|
-
original_value_metadata == o.original_value_metadata &&
|
1006
1021
|
page_number == o.page_number &&
|
1007
1022
|
page_number_metadata == o.page_number_metadata &&
|
1008
1023
|
recipient_id == o.recipient_id &&
|
@@ -1043,8 +1058,6 @@ module DocuSign_eSign
|
|
1043
1058
|
tool_tip_metadata == o.tool_tip_metadata &&
|
1044
1059
|
underline == o.underline &&
|
1045
1060
|
underline_metadata == o.underline_metadata &&
|
1046
|
-
value == o.value &&
|
1047
|
-
value_metadata == o.value_metadata &&
|
1048
1061
|
width == o.width &&
|
1049
1062
|
width_metadata == o.width_metadata &&
|
1050
1063
|
x_position == o.x_position &&
|
@@ -1062,7 +1075,7 @@ module DocuSign_eSign
|
|
1062
1075
|
# Calculates hash code according to all attributes.
|
1063
1076
|
# @return [Fixnum] Hash code
|
1064
1077
|
def hash
|
1065
|
-
[anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, caption, caption_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locked, locked_metadata, merge_field, merge_field_xml, name, name_metadata,
|
1078
|
+
[anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, caption, caption_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locked, locked_metadata, merge_field, merge_field_xml, name, name_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, required, required_metadata, require_initial_on_shared_change, require_initial_on_shared_change_metadata, selected, selected_metadata, selected_original, selected_original_metadata, shared, shared_metadata, share_to_recipients, share_to_recipients_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
|
1066
1079
|
end
|
1067
1080
|
|
1068
1081
|
# Builds the object from hash
|
@@ -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
|
+
# Contains details about a specific cloud storage provider.
|
15
16
|
class CloudStorageProvider
|
16
17
|
# The authentication URL used for the cloud storage provider. This information is only included in the response if the user has not passed authentication for the cloud storage provider. If the redirectUrl query string is provided, the returnUrl is appended to the authenticationUrl.
|
17
18
|
attr_accessor :authentication_url
|
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
|
# The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl. The redirectUrl is restricted to URLs in the docusign.com or docusign.net domains.
|