docusign_esign 3.18.0 → 3.20.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/lib/docusign_esign/api/accounts_api.rb +64 -64
- data/lib/docusign_esign/api/billing_api.rb +2 -2
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +22 -22
- data/lib/docusign_esign/api/connect_api.rb +148 -0
- data/lib/docusign_esign/api/email_archive_api.rb +8 -8
- data/lib/docusign_esign/api/envelopes_api.rb +1226 -104
- data/lib/docusign_esign/api/notary_api.rb +16 -16
- data/lib/docusign_esign/api/power_forms_api.rb +16 -16
- data/lib/docusign_esign/api/templates_api.rb +20 -20
- data/lib/docusign_esign/api/users_api.rb +14 -14
- data/lib/docusign_esign/api/workspaces_api.rb +4 -4
- data/lib/docusign_esign/client/api_client.rb +1 -1
- data/lib/docusign_esign/models/access_code_format.rb +6 -0
- data/lib/docusign_esign/models/account_billing_plan.rb +1 -0
- data/lib/docusign_esign/models/account_billing_plan_response.rb +9 -0
- data/lib/docusign_esign/models/account_identity_verification_step.rb +1 -0
- data/lib/docusign_esign/models/account_identity_verification_workflow.rb +13 -1
- data/lib/docusign_esign/models/account_information.rb +1 -0
- data/lib/docusign_esign/models/account_notification.rb +3 -0
- data/lib/docusign_esign/models/account_password_questions_required.rb +1 -0
- data/lib/docusign_esign/models/account_password_rules.rb +7 -0
- data/lib/docusign_esign/models/account_role_settings.rb +39 -0
- data/lib/docusign_esign/models/account_settings_information.rb +748 -5
- data/lib/docusign_esign/models/account_shared_access.rb +1 -0
- data/lib/docusign_esign/models/account_signature.rb +2 -0
- data/lib/docusign_esign/models/account_signature_definition.rb +1 -0
- data/lib/docusign_esign/models/account_signature_provider.rb +1 -0
- data/lib/docusign_esign/models/account_signature_provider_option.rb +1 -0
- data/lib/docusign_esign/models/account_ui_settings.rb +35 -1
- data/lib/docusign_esign/models/address_information_input.rb +1 -0
- data/lib/docusign_esign/models/agent.rb +22 -0
- data/lib/docusign_esign/models/approve.rb +45 -0
- data/lib/docusign_esign/models/authentication_status.rb +19 -0
- data/lib/docusign_esign/models/bcc_email_archive.rb +3 -0
- data/lib/docusign_esign/models/bcc_email_archive_history.rb +2 -0
- data/lib/docusign_esign/models/bcc_email_archive_list.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_information.rb +19 -1
- data/lib/docusign_esign/models/billing_plan_preview.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_response.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_update_response.rb +1 -0
- data/lib/docusign_esign/models/brand.rb +4 -0
- data/lib/docusign_esign/models/brand_email_content.rb +1 -0
- data/lib/docusign_esign/models/brand_link.rb +1 -0
- data/lib/docusign_esign/models/brand_logos.rb +1 -0
- data/lib/docusign_esign/models/brand_request.rb +1 -0
- data/lib/docusign_esign/models/brand_resource_urls.rb +1 -0
- data/lib/docusign_esign/models/brand_resources.rb +3 -0
- data/lib/docusign_esign/models/brands_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_envelope.rb +1 -0
- data/lib/docusign_esign/models/bulk_recipients_update_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_action_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_status.rb +2 -0
- data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_summary.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_error_status.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_test_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +5 -0
- data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list_summary.rb +1 -0
- data/lib/docusign_esign/models/captive_recipient.rb +2 -0
- data/lib/docusign_esign/models/captive_recipient_information.rb +1 -0
- data/lib/docusign_esign/models/carbon_copy.rb +25 -0
- data/lib/docusign_esign/models/certified_delivery.rb +24 -0
- data/lib/docusign_esign/models/checkbox.rb +52 -39
- data/lib/docusign_esign/models/chunked_upload_part.rb +1 -0
- data/lib/docusign_esign/models/chunked_upload_request.rb +1 -0
- data/lib/docusign_esign/models/chunked_upload_response.rb +1 -0
- data/lib/docusign_esign/models/cloud_storage_provider.rb +2 -0
- data/lib/docusign_esign/models/comment_thread.rb +43 -0
- data/lib/docusign_esign/models/commission_county.rb +52 -0
- data/lib/docusign_esign/models/commission_expiration.rb +52 -0
- data/lib/docusign_esign/models/commission_number.rb +52 -0
- data/lib/docusign_esign/models/commission_state.rb +52 -0
- data/lib/docusign_esign/models/company.rb +52 -0
- data/lib/docusign_esign/models/composite_template.rb +2 -0
- data/lib/docusign_esign/models/conditional_recipient_rule.rb +2 -0
- data/lib/docusign_esign/models/connect_config_results.rb +1 -0
- data/lib/docusign_esign/models/connect_custom_configuration.rb +13 -1
- data/lib/docusign_esign/models/connect_debug_log.rb +1 -0
- data/lib/docusign_esign/models/connect_event_data.rb +1 -0
- data/lib/docusign_esign/models/connect_failure_filter.rb +1 -0
- data/lib/docusign_esign/models/connect_failure_result.rb +1 -0
- data/lib/docusign_esign/models/connect_log.rb +1 -0
- data/lib/docusign_esign/models/connect_o_auth_config.rb +224 -0
- data/lib/docusign_esign/models/connect_salesforce_field.rb +1 -0
- data/lib/docusign_esign/models/connect_salesforce_object.rb +1 -0
- data/lib/docusign_esign/models/console_view_request.rb +1 -0
- data/lib/docusign_esign/models/consumer_disclosure.rb +3 -0
- data/lib/docusign_esign/models/contact.rb +1 -0
- data/lib/docusign_esign/models/contact_get_response.rb +1 -0
- data/lib/docusign_esign/models/contact_mod_request.rb +1 -0
- data/lib/docusign_esign/models/contact_phone_number.rb +1 -0
- data/lib/docusign_esign/models/contact_update_response.rb +1 -0
- data/lib/docusign_esign/models/correct_view_request.rb +12 -1
- data/lib/docusign_esign/models/credit_card_information.rb +2 -0
- data/lib/docusign_esign/models/currency.rb +55 -0
- data/lib/docusign_esign/models/currency_feature_set_price.rb +1 -0
- data/lib/docusign_esign/models/currency_plan_price.rb +1 -0
- data/lib/docusign_esign/models/custom_field.rb +2 -0
- data/lib/docusign_esign/models/date.rb +59 -0
- data/lib/docusign_esign/models/date_signed.rb +46 -0
- data/lib/docusign_esign/models/date_stamp_properties.rb +1 -0
- data/lib/docusign_esign/models/decline.rb +46 -0
- data/lib/docusign_esign/models/delayed_routing.rb +3 -3
- data/lib/docusign_esign/models/direct_debit_processor_information.rb +1 -0
- data/lib/docusign_esign/models/doc_gen_form_field.rb +224 -0
- data/lib/docusign_esign/models/doc_gen_syntax_error.rb +204 -0
- data/lib/docusign_esign/models/document.rb +26 -1
- data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +1 -0
- data/lib/docusign_esign/models/document_html_definition.rb +1 -0
- data/lib/docusign_esign/models/document_html_definition_original.rb +1 -0
- data/lib/docusign_esign/models/document_html_display_anchor.rb +1 -0
- data/lib/docusign_esign/models/document_html_display_settings.rb +1 -0
- data/lib/docusign_esign/models/document_template.rb +1 -0
- data/lib/docusign_esign/models/document_visibility.rb +2 -0
- data/lib/docusign_esign/models/document_visibility_list.rb +1 -0
- data/lib/docusign_esign/models/downgrad_request_billing_info_response.rb +1 -0
- data/lib/docusign_esign/models/downgrade_billing_plan_information.rb +1 -0
- data/lib/docusign_esign/models/draw.rb +40 -0
- data/lib/docusign_esign/models/e_note_configuration.rb +1 -0
- data/lib/docusign_esign/models/editor.rb +23 -0
- data/lib/docusign_esign/models/email.rb +59 -0
- data/lib/docusign_esign/models/email_address.rb +46 -0
- data/lib/docusign_esign/models/envelope.rb +10 -0
- data/lib/docusign_esign/models/envelope_attachment.rb +1 -0
- data/lib/docusign_esign/models/envelope_definition.rb +13 -0
- data/lib/docusign_esign/models/envelope_delay_rule.rb +3 -2
- data/lib/docusign_esign/models/envelope_document.rb +52 -1
- data/lib/docusign_esign/models/envelope_event.rb +1 -0
- data/lib/docusign_esign/models/envelope_form_data.rb +2 -0
- data/lib/docusign_esign/models/envelope_id.rb +45 -0
- data/lib/docusign_esign/models/envelope_ids_request.rb +1 -0
- data/lib/docusign_esign/models/envelope_notification_request.rb +3 -0
- data/lib/docusign_esign/models/envelope_purge_configuration.rb +1 -0
- data/lib/docusign_esign/models/envelope_summary.rb +3 -0
- data/lib/docusign_esign/models/envelope_template.rb +23 -1
- data/lib/docusign_esign/models/envelope_template_results.rb +1 -0
- data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -0
- data/lib/docusign_esign/models/envelope_transfer_rule.rb +6 -0
- data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +4 -0
- data/lib/docusign_esign/models/envelope_update_summary.rb +4 -0
- data/lib/docusign_esign/models/envelopes_information.rb +1 -0
- data/lib/docusign_esign/models/event_notification.rb +12 -1
- data/lib/docusign_esign/models/event_result.rb +1 -0
- data/lib/docusign_esign/models/external_document_sources.rb +6 -0
- data/lib/docusign_esign/models/external_file.rb +1 -0
- data/lib/docusign_esign/models/external_folder.rb +1 -0
- data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -0
- data/lib/docusign_esign/models/favorite_templates_info.rb +1 -0
- data/lib/docusign_esign/models/feature_set.rb +1 -0
- data/lib/docusign_esign/models/filter.rb +1 -0
- data/lib/docusign_esign/models/first_name.rb +46 -0
- data/lib/docusign_esign/models/folder.rb +4 -0
- data/lib/docusign_esign/models/folder_item_response.rb +1 -0
- data/lib/docusign_esign/models/folder_item_v2.rb +2 -0
- data/lib/docusign_esign/models/folder_shared_item.rb +3 -0
- data/lib/docusign_esign/models/folders_request.rb +1 -0
- data/lib/docusign_esign/models/form_data_item.rb +1 -0
- data/lib/docusign_esign/models/formula_tab.rb +64 -0
- data/lib/docusign_esign/models/full_name.rb +46 -0
- data/lib/docusign_esign/models/group.rb +2 -0
- data/lib/docusign_esign/models/id_check_configuration.rb +1 -0
- data/lib/docusign_esign/models/id_check_information_input.rb +4 -0
- data/lib/docusign_esign/models/in_person_signer.rb +31 -0
- data/lib/docusign_esign/models/initial_here.rb +41 -1
- data/lib/docusign_esign/models/inline_template.rb +3 -0
- data/lib/docusign_esign/models/intermediary.rb +23 -0
- data/lib/docusign_esign/models/jurisdiction.rb +1 -0
- data/lib/docusign_esign/models/last_name.rb +46 -0
- data/lib/docusign_esign/models/linked_external_primary_account.rb +1 -0
- data/lib/docusign_esign/models/list.rb +54 -0
- data/lib/docusign_esign/models/list_custom_field.rb +2 -0
- data/lib/docusign_esign/models/list_item.rb +4 -0
- data/lib/docusign_esign/models/locale_policy.rb +13 -0
- data/lib/docusign_esign/models/lock_information.rb +2 -0
- data/lib/docusign_esign/models/lock_request.rb +1 -0
- data/lib/docusign_esign/models/member_group_shared_item.rb +3 -0
- data/lib/docusign_esign/models/member_shared_items.rb +3 -0
- data/lib/docusign_esign/models/merge_field.rb +6 -0
- data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -0
- data/lib/docusign_esign/models/money.rb +1 -0
- data/lib/docusign_esign/models/name_value.rb +2 -0
- data/lib/docusign_esign/models/new_account_definition.rb +20 -1
- data/lib/docusign_esign/models/new_account_summary.rb +1 -0
- data/lib/docusign_esign/models/new_user.rb +2 -0
- data/lib/docusign_esign/models/new_users_summary.rb +1 -0
- data/lib/docusign_esign/models/notarize.rb +38 -0
- data/lib/docusign_esign/models/notary.rb +1 -0
- data/lib/docusign_esign/models/notary_host.rb +20 -0
- data/lib/docusign_esign/models/notary_journal.rb +2 -0
- data/lib/docusign_esign/models/notary_jurisdiction.rb +3 -0
- data/lib/docusign_esign/models/notary_jurisdiction_list.rb +1 -0
- data/lib/docusign_esign/models/notary_recipient.rb +29 -0
- data/lib/docusign_esign/models/notary_result.rb +2 -0
- data/lib/docusign_esign/models/notary_seal.rb +39 -0
- data/lib/docusign_esign/models/note.rb +47 -0
- data/lib/docusign_esign/models/notification.rb +2 -0
- data/lib/docusign_esign/models/notification_default_settings.rb +3 -0
- data/lib/docusign_esign/models/notification_defaults.rb +2 -0
- data/lib/docusign_esign/models/number.rb +61 -0
- data/lib/docusign_esign/models/page.rb +1 -0
- data/lib/docusign_esign/models/payment_details.rb +5 -0
- data/lib/docusign_esign/models/payment_gateway_account.rb +3 -0
- data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +1 -0
- data/lib/docusign_esign/models/payment_line_item.rb +1 -0
- data/lib/docusign_esign/models/payment_method_with_options.rb +1 -0
- data/lib/docusign_esign/models/payment_processor_information.rb +1 -0
- data/lib/docusign_esign/models/permission_profile.rb +2 -0
- data/lib/docusign_esign/models/permission_profile_information.rb +1 -0
- data/lib/docusign_esign/models/phone_number.rb +52 -0
- data/lib/docusign_esign/models/poly_line_overlay.rb +40 -0
- data/lib/docusign_esign/models/power_form.rb +2 -0
- data/lib/docusign_esign/models/power_form_recipient.rb +1 -0
- data/lib/docusign_esign/models/power_form_senders_response.rb +1 -0
- data/lib/docusign_esign/models/power_forms_response.rb +1 -0
- data/lib/docusign_esign/models/prefill_tabs.rb +1 -0
- data/lib/docusign_esign/models/property_metadata.rb +1 -0
- data/lib/docusign_esign/models/radio.rb +28 -0
- data/lib/docusign_esign/models/radio_group.rb +17 -0
- data/lib/docusign_esign/models/recipient_additional_notification.rb +3 -0
- data/lib/docusign_esign/models/recipient_email_notification.rb +3 -0
- data/lib/docusign_esign/models/recipient_group.rb +1 -0
- data/lib/docusign_esign/models/recipient_identity_phone_number.rb +3 -0
- data/lib/docusign_esign/models/recipient_identity_verification.rb +2 -0
- data/lib/docusign_esign/models/recipient_names_response.rb +1 -0
- data/lib/docusign_esign/models/recipient_option.rb +1 -0
- data/lib/docusign_esign/models/recipient_phone_authentication.rb +4 -0
- data/lib/docusign_esign/models/recipient_phone_number.rb +3 -0
- data/lib/docusign_esign/models/recipient_preview_request.rb +2 -0
- data/lib/docusign_esign/models/recipient_proof_file.rb +1 -0
- data/lib/docusign_esign/models/recipient_routing.rb +2 -0
- data/lib/docusign_esign/models/recipient_signature_provider.rb +3 -0
- data/lib/docusign_esign/models/recipient_signature_provider_options.rb +5 -0
- data/lib/docusign_esign/models/recipient_sms_authentication.rb +1 -0
- data/lib/docusign_esign/models/recipient_token_client_ur_ls.rb +30 -30
- data/lib/docusign_esign/models/recipient_update_response.rb +3 -0
- data/lib/docusign_esign/models/recipient_view_request.rb +2 -0
- data/lib/docusign_esign/models/recipients.rb +1 -0
- data/lib/docusign_esign/models/recipients_update_summary.rb +1 -0
- data/lib/docusign_esign/models/return_url_request.rb +1 -0
- data/lib/docusign_esign/models/scheduled_sending.rb +3 -3
- data/lib/docusign_esign/models/seal_sign.rb +17 -0
- data/lib/docusign_esign/models/seat_discount.rb +1 -0
- data/lib/docusign_esign/models/sender_company.rb +45 -0
- data/lib/docusign_esign/models/sender_email_notifications.rb +1 -0
- data/lib/docusign_esign/models/sender_name.rb +45 -0
- data/lib/docusign_esign/models/settings_metadata.rb +1 -0
- data/lib/docusign_esign/models/shared_item.rb +3 -0
- data/lib/docusign_esign/models/sign_here.rb +42 -0
- data/lib/docusign_esign/models/signature_provider_required_option.rb +1 -0
- data/lib/docusign_esign/models/signature_type.rb +1 -0
- data/lib/docusign_esign/models/signer.rb +30 -0
- data/lib/docusign_esign/models/signer_attachment.rb +40 -0
- data/lib/docusign_esign/models/signing_group.rb +2 -0
- data/lib/docusign_esign/models/signing_group_user.rb +1 -0
- data/lib/docusign_esign/models/smart_section.rb +41 -0
- data/lib/docusign_esign/models/smart_section_display_settings.rb +2 -0
- data/lib/docusign_esign/models/social_account_information.rb +1 -0
- data/lib/docusign_esign/models/ssn.rb +59 -0
- data/lib/docusign_esign/models/stamp.rb +2 -0
- data/lib/docusign_esign/models/supported_languages.rb +1 -0
- data/lib/docusign_esign/models/tab_account_settings.rb +22 -0
- data/lib/docusign_esign/models/tab_group.rb +41 -0
- data/lib/docusign_esign/models/tab_metadata.rb +14 -1
- data/lib/docusign_esign/models/tabs.rb +2 -0
- data/lib/docusign_esign/models/template_document_visibility_list.rb +1 -0
- data/lib/docusign_esign/models/template_notification_request.rb +2 -0
- data/lib/docusign_esign/models/template_recipients.rb +1 -0
- data/lib/docusign_esign/models/template_role.rb +4 -0
- data/lib/docusign_esign/models/template_shared_item.rb +3 -0
- data/lib/docusign_esign/models/template_summary.rb +3 -0
- data/lib/docusign_esign/models/template_tabs.rb +1 -0
- data/lib/docusign_esign/models/template_update_summary.rb +4 -0
- data/lib/docusign_esign/models/text.rb +61 -0
- data/lib/docusign_esign/models/text_custom_field.rb +2 -0
- data/lib/docusign_esign/models/title.rb +52 -0
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +12 -0
- data/lib/docusign_esign/models/user_info.rb +1 -0
- data/lib/docusign_esign/models/user_information.rb +6 -0
- data/lib/docusign_esign/models/user_information_list.rb +1 -0
- data/lib/docusign_esign/models/user_password_information.rb +1 -0
- data/lib/docusign_esign/models/user_password_rules.rb +2 -0
- data/lib/docusign_esign/models/user_profile.rb +3 -0
- data/lib/docusign_esign/models/user_settings_information.rb +61 -0
- data/lib/docusign_esign/models/user_shared_item.rb +3 -0
- data/lib/docusign_esign/models/user_signature.rb +2 -0
- data/lib/docusign_esign/models/user_signature_definition.rb +1 -0
- data/lib/docusign_esign/models/view.rb +46 -0
- data/lib/docusign_esign/models/witness.rb +30 -0
- data/lib/docusign_esign/models/workflow.rb +2 -0
- data/lib/docusign_esign/models/workflow_step.rb +3 -0
- data/lib/docusign_esign/models/workspace.rb +4 -0
- data/lib/docusign_esign/models/workspace_folder_contents.rb +1 -0
- data/lib/docusign_esign/models/workspace_item.rb +5 -0
- data/lib/docusign_esign/models/workspace_settings.rb +1 -0
- data/lib/docusign_esign/models/workspace_user.rb +1 -0
- data/lib/docusign_esign/models/workspace_user_authorization.rb +2 -0
- data/lib/docusign_esign/models/zip.rb +60 -0
- data/lib/docusign_esign/version.rb +1 -1
- data/lib/docusign_esign.rb +3 -0
- metadata +9 -6
@@ -12,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
|
+
# **Note:** For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`.
|
15
16
|
class PowerFormRecipient
|
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
|
@@ -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 includes information about the users who have sent PowerForms.
|
15
16
|
class PowerFormSendersResponse
|
16
17
|
# The last position in the result set.
|
17
18
|
attr_accessor :end_position
|
@@ -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
|
+
# Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. Only the following tab types can be prefill tabs: - text - check boxes - radio buttons [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields
|
15
16
|
class PrefillTabs
|
16
17
|
# Specifies a tag on the document in a location where the recipient can select an option.
|
17
18
|
attr_accessor :checkbox_tabs
|
@@ -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
|
+
# One of the selectable radio buttons in the `radios` property of a [`radioGroup`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) tab.
|
15
16
|
class Radio
|
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
|
#
|
@@ -73,6 +85,7 @@ module DocuSign_eSign
|
|
73
85
|
|
74
86
|
attr_accessor :caption_metadata
|
75
87
|
|
88
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
76
89
|
attr_accessor :error_details
|
77
90
|
|
78
91
|
# 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.
|
@@ -81,73 +94,88 @@ module DocuSign_eSign
|
|
81
94
|
# The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
|
82
95
|
attr_accessor :font_color
|
83
96
|
|
97
|
+
# Metadata that indicates whether the `fontColor` property is editable.
|
84
98
|
attr_accessor :font_color_metadata
|
85
99
|
|
100
|
+
# Metadata that indicates whether the `font` property is editable.
|
86
101
|
attr_accessor :font_metadata
|
87
102
|
|
88
103
|
# 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.
|
89
104
|
attr_accessor :font_size
|
90
105
|
|
106
|
+
# Metadata that indicates whether the `fontSize` property is editable.
|
91
107
|
attr_accessor :font_size_metadata
|
92
108
|
|
93
109
|
# When set to **true**, the information in the tab is italic.
|
94
110
|
attr_accessor :italic
|
95
111
|
|
112
|
+
# Metadata that indicates whether the `italic` property is editable.
|
96
113
|
attr_accessor :italic_metadata
|
97
114
|
|
98
115
|
# When set to **true**, the signer cannot change the data of the custom tab.
|
99
116
|
attr_accessor :locked
|
100
117
|
|
118
|
+
# Metadata that indicates whether the `locked` property is editable.
|
101
119
|
attr_accessor :locked_metadata
|
102
120
|
|
103
121
|
# Specifies the page number on which the tab is located.
|
104
122
|
attr_accessor :page_number
|
105
123
|
|
124
|
+
# Metadata that indicates whether the `pageNumber` property is editable.
|
106
125
|
attr_accessor :page_number_metadata
|
107
126
|
|
108
127
|
# When set to **true**, the signer is required to fill out this tab
|
109
128
|
attr_accessor :required
|
110
129
|
|
130
|
+
# Metadata that indicates whether the `required` property is editable.
|
111
131
|
attr_accessor :required_metadata
|
112
132
|
|
113
133
|
# When set to **true**, the radio button is selected.
|
114
134
|
attr_accessor :selected
|
115
135
|
|
136
|
+
# Metadata that indicates whether the `selected` property is editable.
|
116
137
|
attr_accessor :selected_metadata
|
117
138
|
|
118
139
|
# 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.
|
119
140
|
attr_accessor :status
|
120
141
|
|
142
|
+
# Metadata that indicates whether the `status` property is editable.
|
121
143
|
attr_accessor :status_metadata
|
122
144
|
|
123
145
|
# The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
|
124
146
|
attr_accessor :tab_id
|
125
147
|
|
148
|
+
# Metadata that indicates whether the `tabId` property is editable.
|
126
149
|
attr_accessor :tab_id_metadata
|
127
150
|
|
128
151
|
#
|
129
152
|
attr_accessor :tab_order
|
130
153
|
|
154
|
+
# Metadata that indicates whether the `tabOrder` property is editable.
|
131
155
|
attr_accessor :tab_order_metadata
|
132
156
|
|
133
157
|
# When set to **true**, the information in the tab is underlined.
|
134
158
|
attr_accessor :underline
|
135
159
|
|
160
|
+
# Metadata that indicates whether the `underline` property is editable.
|
136
161
|
attr_accessor :underline_metadata
|
137
162
|
|
138
163
|
# Specifies the value of the tab.
|
139
164
|
attr_accessor :value
|
140
165
|
|
166
|
+
# Metadata that indicates whether the `value` property is editable.
|
141
167
|
attr_accessor :value_metadata
|
142
168
|
|
143
169
|
# This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
144
170
|
attr_accessor :x_position
|
145
171
|
|
172
|
+
# Metadata that indicates whether the `xPosition` property is editable.
|
146
173
|
attr_accessor :x_position_metadata
|
147
174
|
|
148
175
|
# This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
149
176
|
attr_accessor :y_position
|
150
177
|
|
178
|
+
# Metadata that indicates whether the `yPosition` property is editable.
|
151
179
|
attr_accessor :y_position_metadata
|
152
180
|
|
153
181
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -12,30 +12,36 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# This group tab is used to place radio buttons on a document. The `radios` property contains a list of [`radio`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) objects associated with the group. Only one radio button can be selected in a group.
|
15
16
|
class RadioGroup
|
16
17
|
# For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
|
17
18
|
attr_accessor :conditional_parent_label
|
18
19
|
|
20
|
+
# Metadata that indicates whether the `conditionalParentLabel` property is editable.
|
19
21
|
attr_accessor :conditional_parent_label_metadata
|
20
22
|
|
21
23
|
# 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.
|
22
24
|
attr_accessor :conditional_parent_value
|
23
25
|
|
26
|
+
# Metadata that indicates whether the `conditionalParentValue` property is editable.
|
24
27
|
attr_accessor :conditional_parent_value_metadata
|
25
28
|
|
26
29
|
# Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
|
27
30
|
attr_accessor :document_id
|
28
31
|
|
32
|
+
# Metadata that indicates whether the `documentId` property is editable.
|
29
33
|
attr_accessor :document_id_metadata
|
30
34
|
|
31
35
|
# The name of the group.
|
32
36
|
attr_accessor :group_name
|
33
37
|
|
38
|
+
# Metadata that indicates whether the `groupName` property is editable.
|
34
39
|
attr_accessor :group_name_metadata
|
35
40
|
|
36
41
|
# The initial value of the tab when it was sent to the recipient.
|
37
42
|
attr_accessor :original_value
|
38
43
|
|
44
|
+
# Metadata that indicates whether the `originalValue` property is editable.
|
39
45
|
attr_accessor :original_value_metadata
|
40
46
|
|
41
47
|
# Specifies the locations and status for radio buttons that are grouped together.
|
@@ -47,53 +53,64 @@ module DocuSign_eSign
|
|
47
53
|
#
|
48
54
|
attr_accessor :recipient_id_guid
|
49
55
|
|
56
|
+
# Metadata that indicates whether the `recipientIdGuid` property is editable.
|
50
57
|
attr_accessor :recipient_id_guid_metadata
|
51
58
|
|
59
|
+
# Metadata that indicates whether the `recipientId` property is editable.
|
52
60
|
attr_accessor :recipient_id_metadata
|
53
61
|
|
54
62
|
# When set to **true** and shared is true, information must be entered in this field to complete the envelope.
|
55
63
|
attr_accessor :require_all
|
56
64
|
|
65
|
+
# Metadata that indicates whether the `requireAll` property is editable.
|
57
66
|
attr_accessor :require_all_metadata
|
58
67
|
|
59
68
|
# Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
|
60
69
|
attr_accessor :require_initial_on_shared_change
|
61
70
|
|
71
|
+
# Metadata that indicates whether the `requireInitialOnSharedChange` property is editable.
|
62
72
|
attr_accessor :require_initial_on_shared_change_metadata
|
63
73
|
|
64
74
|
# When set to **true**, this custom tab is shared.
|
65
75
|
attr_accessor :shared
|
66
76
|
|
77
|
+
# Metadata that indicates whether the `shared` property is editable.
|
67
78
|
attr_accessor :shared_metadata
|
68
79
|
|
69
80
|
#
|
70
81
|
attr_accessor :share_to_recipients
|
71
82
|
|
83
|
+
# Reserved for DocuSign.
|
72
84
|
attr_accessor :share_to_recipients_metadata
|
73
85
|
|
74
86
|
#
|
75
87
|
attr_accessor :tab_type
|
76
88
|
|
89
|
+
# Metadata that indicates whether the `tabType` property is editable.
|
77
90
|
attr_accessor :tab_type_metadata
|
78
91
|
|
79
92
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
80
93
|
attr_accessor :template_locked
|
81
94
|
|
95
|
+
# Metadata that indicates whether the `templateLocked` property is editable.
|
82
96
|
attr_accessor :template_locked_metadata
|
83
97
|
|
84
98
|
# When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
|
85
99
|
attr_accessor :template_required
|
86
100
|
|
101
|
+
# Metadata that indicates whether the `templateRequired` property is editable.
|
87
102
|
attr_accessor :template_required_metadata
|
88
103
|
|
89
104
|
#
|
90
105
|
attr_accessor :tooltip
|
91
106
|
|
107
|
+
# Metadata that indicates whether the `tooltip` property is editable.
|
92
108
|
attr_accessor :tooltip_metadata
|
93
109
|
|
94
110
|
# Specifies the value of the tab.
|
95
111
|
attr_accessor :value
|
96
112
|
|
113
|
+
# Metadata that indicates whether the `value` property is editable.
|
97
114
|
attr_accessor :value_metadata
|
98
115
|
|
99
116
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -12,12 +12,15 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# Describes an additional notification method.
|
15
16
|
class RecipientAdditionalNotification
|
17
|
+
# The phone number to receive the additional notifcation.
|
16
18
|
attr_accessor :phone_number
|
17
19
|
|
18
20
|
#
|
19
21
|
attr_accessor :secondary_delivery_method
|
20
22
|
|
23
|
+
# Metadata about the delivery method.
|
21
24
|
attr_accessor :secondary_delivery_method_metadata
|
22
25
|
|
23
26
|
#
|
@@ -16,16 +16,19 @@ module DocuSign_eSign
|
|
16
16
|
# Specifies the email body of the message sent to the recipient. Maximum length: 10000 characters.
|
17
17
|
attr_accessor :email_body
|
18
18
|
|
19
|
+
# Metadata that indicates whether the `emailBody` property can be edited.
|
19
20
|
attr_accessor :email_body_metadata
|
20
21
|
|
21
22
|
# Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.
|
22
23
|
attr_accessor :email_subject
|
23
24
|
|
25
|
+
# Metadata that indicates whether the `emailSubject` property can be edited.
|
24
26
|
attr_accessor :email_subject_metadata
|
25
27
|
|
26
28
|
# A simple type enumeration of the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Armenian (hy), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi).
|
27
29
|
attr_accessor :supported_language
|
28
30
|
|
31
|
+
# Metadata that indicates whether the `supportedLanguage` property can be edited.
|
29
32
|
attr_accessor :supported_language_metadata
|
30
33
|
|
31
34
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -19,16 +19,19 @@ module DocuSign_eSign
|
|
19
19
|
#
|
20
20
|
attr_accessor :country_code_lock
|
21
21
|
|
22
|
+
# Metadata that indicates if the `countryCode` property is editable.
|
22
23
|
attr_accessor :country_code_metadata
|
23
24
|
|
24
25
|
#
|
25
26
|
attr_accessor :extension
|
26
27
|
|
28
|
+
# Metadata that indicates if the `extension` property is editable.
|
27
29
|
attr_accessor :extension_metadata
|
28
30
|
|
29
31
|
#
|
30
32
|
attr_accessor :number
|
31
33
|
|
34
|
+
# Metadata that indicates if the `number` property is editable.
|
32
35
|
attr_accessor :number_metadata
|
33
36
|
|
34
37
|
# 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
|
+
# Specifies ID Verification applied on an envelope by workflow ID. 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. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
|
15
16
|
class RecipientIdentityVerification
|
16
17
|
#
|
17
18
|
attr_accessor :input_options
|
@@ -19,6 +20,7 @@ module DocuSign_eSign
|
|
19
20
|
#
|
20
21
|
attr_accessor :workflow_id
|
21
22
|
|
23
|
+
#
|
22
24
|
attr_accessor :workflow_id_metadata
|
23
25
|
|
24
26
|
# 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 response object contains a list of recipients.
|
15
16
|
class RecipientNamesResponse
|
16
17
|
# Indicates whether email address is used by more than one user.
|
17
18
|
attr_accessor :multiple_users
|
@@ -17,21 +17,25 @@ module DocuSign_eSign
|
|
17
17
|
# Boolean. When set to **true**, the recipient can supply a phone number their choice.
|
18
18
|
attr_accessor :recip_may_provide_number
|
19
19
|
|
20
|
+
# Metadata that indicates whether the `recipMayProvideNumber` property can be edited.
|
20
21
|
attr_accessor :recip_may_provide_number_metadata
|
21
22
|
|
22
23
|
# Reserved.
|
23
24
|
attr_accessor :record_voice_print
|
24
25
|
|
26
|
+
# Reserved for DocuSign.
|
25
27
|
attr_accessor :record_voice_print_metadata
|
26
28
|
|
27
29
|
# An Array containing a list of phone numbers the recipient may use for SMS text authentication.
|
28
30
|
attr_accessor :sender_provided_numbers
|
29
31
|
|
32
|
+
# Metadata that indicates whether the `senderProvidedNumbers` property can be edited.
|
30
33
|
attr_accessor :sender_provided_numbers_metadata
|
31
34
|
|
32
35
|
# Reserved.
|
33
36
|
attr_accessor :validate_recip_provided_number
|
34
37
|
|
38
|
+
# Reserved for DocuSign.
|
35
39
|
attr_accessor :validate_recip_provided_number_metadata
|
36
40
|
|
37
41
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -12,15 +12,18 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# Describes the recipient phone number.
|
15
16
|
class RecipientPhoneNumber
|
16
17
|
#
|
17
18
|
attr_accessor :country_code
|
18
19
|
|
20
|
+
# Metadata that indicates if the `countryCode` property is editable.
|
19
21
|
attr_accessor :country_code_metadata
|
20
22
|
|
21
23
|
#
|
22
24
|
attr_accessor :number
|
23
25
|
|
26
|
+
# Metadata that indicates if the `number` property is editable.
|
24
27
|
attr_accessor :number_metadata
|
25
28
|
|
26
29
|
# 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 request object contains the information necessary to create a recipient preview.
|
15
16
|
class RecipientPreviewRequest
|
16
17
|
#
|
17
18
|
attr_accessor :assertion_id
|
@@ -22,6 +23,7 @@ module DocuSign_eSign
|
|
22
23
|
#
|
23
24
|
attr_accessor :authentication_method
|
24
25
|
|
26
|
+
#
|
25
27
|
attr_accessor :client_ur_ls
|
26
28
|
|
27
29
|
#
|
@@ -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
|
+
# The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/)
|
15
16
|
class RecipientProofFile
|
16
17
|
#
|
17
18
|
attr_accessor :has_identity_attempts
|
@@ -12,7 +12,9 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# Describes the recipient routing rules.
|
15
16
|
class RecipientRouting
|
17
|
+
# The recipient routing rules.
|
16
18
|
attr_accessor :rules
|
17
19
|
|
18
20
|
# 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
|
+
# An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/).
|
15
16
|
class RecipientSignatureProvider
|
16
17
|
#
|
17
18
|
attr_accessor :seal_documents_with_tabs_only
|
@@ -22,8 +23,10 @@ module DocuSign_eSign
|
|
22
23
|
#
|
23
24
|
attr_accessor :signature_provider_name
|
24
25
|
|
26
|
+
# Metadata that indicates whether the `signatureProviderName` property is editable.
|
25
27
|
attr_accessor :signature_provider_name_metadata
|
26
28
|
|
29
|
+
# Not applicable for this object.
|
27
30
|
attr_accessor :signature_provider_options
|
28
31
|
|
29
32
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -12,25 +12,30 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/)
|
15
16
|
class RecipientSignatureProviderOptions
|
16
17
|
#
|
17
18
|
attr_accessor :cpf_number
|
18
19
|
|
20
|
+
# Reserved for DocuSign.
|
19
21
|
attr_accessor :cpf_number_metadata
|
20
22
|
|
21
23
|
#
|
22
24
|
attr_accessor :one_time_password
|
23
25
|
|
26
|
+
# Metadata that indicates whether the `oneTimePassword` property is editable.
|
24
27
|
attr_accessor :one_time_password_metadata
|
25
28
|
|
26
29
|
#
|
27
30
|
attr_accessor :signer_role
|
28
31
|
|
32
|
+
# Metadata that indicates whether the `signerRole` property is editable.
|
29
33
|
attr_accessor :signer_role_metadata
|
30
34
|
|
31
35
|
#
|
32
36
|
attr_accessor :sms
|
33
37
|
|
38
|
+
# Metadata that indicates whether the `sms` property is editable.
|
34
39
|
attr_accessor :sms_metadata
|
35
40
|
|
36
41
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -17,6 +17,7 @@ module DocuSign_eSign
|
|
17
17
|
# An Array containing a list of phone numbers the recipient may use for SMS text authentication.
|
18
18
|
attr_accessor :sender_provided_numbers
|
19
19
|
|
20
|
+
# Metadata that indicates whether the `senderProvidedNumbers` property can be edited.
|
20
21
|
attr_accessor :sender_provided_numbers_metadata
|
21
22
|
|
22
23
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -46,16 +46,16 @@ module DocuSign_eSign
|
|
46
46
|
# Attribute mapping from ruby-style variable name to JSON key.
|
47
47
|
def self.attribute_map
|
48
48
|
{
|
49
|
-
:'on_access_code_failed' => :'
|
50
|
-
:'on_cancel' => :'
|
51
|
-
:'on_decline' => :'
|
52
|
-
:'on_exception' => :'
|
53
|
-
:'on_fax_pending' => :'
|
54
|
-
:'on_id_check_failed' => :'
|
55
|
-
:'on_session_timeout' => :'
|
56
|
-
:'on_signing_complete' => :'
|
57
|
-
:'on_ttl_expired' => :'
|
58
|
-
:'on_viewing_complete' => :'
|
49
|
+
:'on_access_code_failed' => :'onAccessCodeFailed',
|
50
|
+
:'on_cancel' => :'onCancel',
|
51
|
+
:'on_decline' => :'onDecline',
|
52
|
+
:'on_exception' => :'onException',
|
53
|
+
:'on_fax_pending' => :'onFaxPending',
|
54
|
+
:'on_id_check_failed' => :'onIdCheckFailed',
|
55
|
+
:'on_session_timeout' => :'onSessionTimeout',
|
56
|
+
:'on_signing_complete' => :'onSigningComplete',
|
57
|
+
:'on_ttl_expired' => :'onTTLExpired',
|
58
|
+
:'on_viewing_complete' => :'onViewingComplete'
|
59
59
|
}
|
60
60
|
end
|
61
61
|
|
@@ -83,44 +83,44 @@ module DocuSign_eSign
|
|
83
83
|
# convert string to symbol for hash key
|
84
84
|
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
85
85
|
|
86
|
-
if attributes.has_key?(:'
|
87
|
-
self.on_access_code_failed = attributes[:'
|
86
|
+
if attributes.has_key?(:'onAccessCodeFailed')
|
87
|
+
self.on_access_code_failed = attributes[:'onAccessCodeFailed']
|
88
88
|
end
|
89
89
|
|
90
|
-
if attributes.has_key?(:'
|
91
|
-
self.on_cancel = attributes[:'
|
90
|
+
if attributes.has_key?(:'onCancel')
|
91
|
+
self.on_cancel = attributes[:'onCancel']
|
92
92
|
end
|
93
93
|
|
94
|
-
if attributes.has_key?(:'
|
95
|
-
self.on_decline = attributes[:'
|
94
|
+
if attributes.has_key?(:'onDecline')
|
95
|
+
self.on_decline = attributes[:'onDecline']
|
96
96
|
end
|
97
97
|
|
98
|
-
if attributes.has_key?(:'
|
99
|
-
self.on_exception = attributes[:'
|
98
|
+
if attributes.has_key?(:'onException')
|
99
|
+
self.on_exception = attributes[:'onException']
|
100
100
|
end
|
101
101
|
|
102
|
-
if attributes.has_key?(:'
|
103
|
-
self.on_fax_pending = attributes[:'
|
102
|
+
if attributes.has_key?(:'onFaxPending')
|
103
|
+
self.on_fax_pending = attributes[:'onFaxPending']
|
104
104
|
end
|
105
105
|
|
106
|
-
if attributes.has_key?(:'
|
107
|
-
self.on_id_check_failed = attributes[:'
|
106
|
+
if attributes.has_key?(:'onIdCheckFailed')
|
107
|
+
self.on_id_check_failed = attributes[:'onIdCheckFailed']
|
108
108
|
end
|
109
109
|
|
110
|
-
if attributes.has_key?(:'
|
111
|
-
self.on_session_timeout = attributes[:'
|
110
|
+
if attributes.has_key?(:'onSessionTimeout')
|
111
|
+
self.on_session_timeout = attributes[:'onSessionTimeout']
|
112
112
|
end
|
113
113
|
|
114
|
-
if attributes.has_key?(:'
|
115
|
-
self.on_signing_complete = attributes[:'
|
114
|
+
if attributes.has_key?(:'onSigningComplete')
|
115
|
+
self.on_signing_complete = attributes[:'onSigningComplete']
|
116
116
|
end
|
117
117
|
|
118
|
-
if attributes.has_key?(:'
|
119
|
-
self.on_ttl_expired = attributes[:'
|
118
|
+
if attributes.has_key?(:'onTTLExpired')
|
119
|
+
self.on_ttl_expired = attributes[:'onTTLExpired']
|
120
120
|
end
|
121
121
|
|
122
|
-
if attributes.has_key?(:'
|
123
|
-
self.on_viewing_complete = attributes[:'
|
122
|
+
if attributes.has_key?(:'onViewingComplete')
|
123
|
+
self.on_viewing_complete = attributes[:'onViewingComplete']
|
124
124
|
end
|
125
125
|
end
|
126
126
|
|