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,65 +12,78 @@ 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 the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided.
|
15
16
|
class Decline
|
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
|
# Specifies the decline text displayed in the tab.
|
72
84
|
attr_accessor :button_text
|
73
85
|
|
86
|
+
# Metadata that indicates whether the `buttonText` property is editable.
|
74
87
|
attr_accessor :button_text_metadata
|
75
88
|
|
76
89
|
#
|
@@ -81,28 +94,34 @@ module DocuSign_eSign
|
|
81
94
|
# For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
|
82
95
|
attr_accessor :conditional_parent_label
|
83
96
|
|
97
|
+
# Metadata that indicates whether the `conditionalParentLabel` property is editable.
|
84
98
|
attr_accessor :conditional_parent_label_metadata
|
85
99
|
|
86
100
|
# 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.
|
87
101
|
attr_accessor :conditional_parent_value
|
88
102
|
|
103
|
+
# Metadata that indicates whether the `conditionalParentValue` property is editable.
|
89
104
|
attr_accessor :conditional_parent_value_metadata
|
90
105
|
|
91
106
|
# 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.
|
92
107
|
attr_accessor :custom_tab_id
|
93
108
|
|
109
|
+
# Metadata that indicates whether the `customTabId` property is editable.
|
94
110
|
attr_accessor :custom_tab_id_metadata
|
95
111
|
|
96
112
|
# The reason the recipient declined the document.
|
97
113
|
attr_accessor :decline_reason
|
98
114
|
|
115
|
+
# Metadata that indicates whether the `declineReason` property is editable.
|
99
116
|
attr_accessor :decline_reason_metadata
|
100
117
|
|
101
118
|
# Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
|
102
119
|
attr_accessor :document_id
|
103
120
|
|
121
|
+
# Metadata that indicates whether the `documentId` property is editable.
|
104
122
|
attr_accessor :document_id_metadata
|
105
123
|
|
124
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
106
125
|
attr_accessor :error_details
|
107
126
|
|
108
127
|
# 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.
|
@@ -111,42 +130,52 @@ module DocuSign_eSign
|
|
111
130
|
# The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
|
112
131
|
attr_accessor :font_color
|
113
132
|
|
133
|
+
# Metadata that indicates whether the `fontColor` property is editable.
|
114
134
|
attr_accessor :font_color_metadata
|
115
135
|
|
136
|
+
# Metadata that indicates whether the `font` property is editable.
|
116
137
|
attr_accessor :font_metadata
|
117
138
|
|
118
139
|
# 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.
|
119
140
|
attr_accessor :font_size
|
120
141
|
|
142
|
+
# Metadata that indicates whether the `fontSize` property is editable.
|
121
143
|
attr_accessor :font_size_metadata
|
122
144
|
|
123
145
|
#
|
124
146
|
attr_accessor :form_order
|
125
147
|
|
148
|
+
# Metadata that indicates whether the `formOrder` property is editable.
|
126
149
|
attr_accessor :form_order_metadata
|
127
150
|
|
128
151
|
#
|
129
152
|
attr_accessor :form_page_label
|
130
153
|
|
154
|
+
# Metadata that indicates whether the `formPageLabel` property is editable.
|
131
155
|
attr_accessor :form_page_label_metadata
|
132
156
|
|
133
157
|
#
|
134
158
|
attr_accessor :form_page_number
|
135
159
|
|
160
|
+
# Metadata that indicates whether the `fromPageNumber` property is editable.
|
136
161
|
attr_accessor :form_page_number_metadata
|
137
162
|
|
138
163
|
# Height of the tab in pixels.
|
139
164
|
attr_accessor :height
|
140
165
|
|
166
|
+
# Metadata that indicates whether the `height` property is editable.
|
141
167
|
attr_accessor :height_metadata
|
142
168
|
|
143
169
|
# When set to **true**, the information in the tab is italic.
|
144
170
|
attr_accessor :italic
|
145
171
|
|
172
|
+
# Metadata that indicates whether the `italic` property is editable.
|
146
173
|
attr_accessor :italic_metadata
|
147
174
|
|
175
|
+
# Reserved for DocuSign.
|
148
176
|
attr_accessor :locale_policy
|
149
177
|
|
178
|
+
# Contains the information necessary to map the tab to a field in SalesForce.
|
150
179
|
attr_accessor :merge_field
|
151
180
|
|
152
181
|
#
|
@@ -155,6 +184,7 @@ module DocuSign_eSign
|
|
155
184
|
# Specifies the page number on which the tab is located.
|
156
185
|
attr_accessor :page_number
|
157
186
|
|
187
|
+
# Metadata that indicates whether the `pageNumber` property is editable.
|
158
188
|
attr_accessor :page_number_metadata
|
159
189
|
|
160
190
|
# Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
|
@@ -163,10 +193,13 @@ module DocuSign_eSign
|
|
163
193
|
#
|
164
194
|
attr_accessor :recipient_id_guid
|
165
195
|
|
196
|
+
# Metadata that indicates whether the `recipientIdGuid` property is editable.
|
166
197
|
attr_accessor :recipient_id_guid_metadata
|
167
198
|
|
199
|
+
# Metadata that indicates whether the `recipientId` property is editable.
|
168
200
|
attr_accessor :recipient_id_metadata
|
169
201
|
|
202
|
+
# Reserved for DocuSign.
|
170
203
|
attr_accessor :smart_contract_information
|
171
204
|
|
172
205
|
#
|
@@ -175,66 +208,79 @@ module DocuSign_eSign
|
|
175
208
|
# Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
|
176
209
|
attr_accessor :status
|
177
210
|
|
211
|
+
# Metadata that indicates whether the `status` property is editable.
|
178
212
|
attr_accessor :status_metadata
|
179
213
|
|
180
214
|
#
|
181
215
|
attr_accessor :tab_group_labels
|
182
216
|
|
217
|
+
# Metadata that indicates whether the `tabGroupLabels` property is editable.
|
183
218
|
attr_accessor :tab_group_labels_metadata
|
184
219
|
|
185
220
|
# The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
|
186
221
|
attr_accessor :tab_id
|
187
222
|
|
223
|
+
# Metadata that indicates whether the `tabId` property is editable.
|
188
224
|
attr_accessor :tab_id_metadata
|
189
225
|
|
190
226
|
# The label string associated with the tab.
|
191
227
|
attr_accessor :tab_label
|
192
228
|
|
229
|
+
# Metadata that indicates whether the `tabLabel` property is editable.
|
193
230
|
attr_accessor :tab_label_metadata
|
194
231
|
|
195
232
|
#
|
196
233
|
attr_accessor :tab_order
|
197
234
|
|
235
|
+
# Metadata that indicates whether the `tabOrder` property is editable.
|
198
236
|
attr_accessor :tab_order_metadata
|
199
237
|
|
200
238
|
#
|
201
239
|
attr_accessor :tab_type
|
202
240
|
|
241
|
+
# Metadata that indicates whether the `tabType` property is editable.
|
203
242
|
attr_accessor :tab_type_metadata
|
204
243
|
|
205
244
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
206
245
|
attr_accessor :template_locked
|
207
246
|
|
247
|
+
# Metadata that indicates whether the `templateLocked` property is editable.
|
208
248
|
attr_accessor :template_locked_metadata
|
209
249
|
|
210
250
|
# When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
|
211
251
|
attr_accessor :template_required
|
212
252
|
|
253
|
+
# Metadata that indicates whether the `templateRequired` property is editable.
|
213
254
|
attr_accessor :template_required_metadata
|
214
255
|
|
215
256
|
#
|
216
257
|
attr_accessor :tooltip
|
217
258
|
|
259
|
+
# Metadata that indicates whether the `toolTip` property is editable.
|
218
260
|
attr_accessor :tool_tip_metadata
|
219
261
|
|
220
262
|
# When set to **true**, the information in the tab is underlined.
|
221
263
|
attr_accessor :underline
|
222
264
|
|
265
|
+
# Metadata that indicates whether the `underline` property is editable.
|
223
266
|
attr_accessor :underline_metadata
|
224
267
|
|
225
268
|
# Width of the tab in pixels.
|
226
269
|
attr_accessor :width
|
227
270
|
|
271
|
+
# Metadata that indicates whether the `width` property is editable.
|
228
272
|
attr_accessor :width_metadata
|
229
273
|
|
230
274
|
# This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
231
275
|
attr_accessor :x_position
|
232
276
|
|
277
|
+
# Metadata that indicates whether the `xPosition` property is editable.
|
233
278
|
attr_accessor :x_position_metadata
|
234
279
|
|
235
280
|
# This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
236
281
|
attr_accessor :y_position
|
237
282
|
|
283
|
+
# Metadata that indicates whether the `yPosition` property is editable.
|
238
284
|
attr_accessor :y_position_metadata
|
239
285
|
|
240
286
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -13,13 +13,13 @@ require 'date'
|
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
15
|
class DelayedRouting
|
16
|
-
#
|
16
|
+
# An ISO 8601 formatted datetime string indicating the date and time that the envelope is (or was) scheduled to be sent to the recipients associated with the current workflow step or null if the envelope has not yet begun processing the current workflow step.
|
17
17
|
attr_accessor :resume_date
|
18
18
|
|
19
|
-
#
|
19
|
+
# A list of envelope delay rules specified by the user indicating how and when the envelope should be sent in the future for the current workflow step and its associated recipients. Currently only 1 rule may be specified.
|
20
20
|
attr_accessor :rules
|
21
21
|
|
22
|
-
#
|
22
|
+
# \\\"pending\\\" if the current workflow step has not been reached and the delay has not yet started. \\\"started\\\" if the delay is in progress. \\\"completed\\\" if the delay has elapsed and the envelope has been sent to the current workflow step's recipients.
|
23
23
|
attr_accessor :status
|
24
24
|
|
25
25
|
# 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
|
+
# Contains information about a bank that processes a customer's direct debit payments.
|
15
16
|
class DirectDebitProcessorInformation
|
16
17
|
#
|
17
18
|
attr_accessor :bank_branch_code
|
@@ -0,0 +1,224 @@
|
|
1
|
+
=begin
|
2
|
+
#DocuSign REST API
|
3
|
+
|
4
|
+
#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
|
5
|
+
|
6
|
+
OpenAPI spec version: v2.1
|
7
|
+
Contact: devcenter@docusign.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
=end
|
11
|
+
|
12
|
+
require 'date'
|
13
|
+
|
14
|
+
module DocuSign_eSign
|
15
|
+
class DocGenFormField
|
16
|
+
#
|
17
|
+
attr_accessor :label
|
18
|
+
|
19
|
+
#
|
20
|
+
attr_accessor :name
|
21
|
+
|
22
|
+
# When set to **true**, the signer is required to fill out this tab
|
23
|
+
attr_accessor :required
|
24
|
+
|
25
|
+
#
|
26
|
+
attr_accessor :type
|
27
|
+
|
28
|
+
# Specifies the value of the tab.
|
29
|
+
attr_accessor :value
|
30
|
+
|
31
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
32
|
+
def self.attribute_map
|
33
|
+
{
|
34
|
+
:'label' => :'label',
|
35
|
+
:'name' => :'name',
|
36
|
+
:'required' => :'required',
|
37
|
+
:'type' => :'type',
|
38
|
+
:'value' => :'value'
|
39
|
+
}
|
40
|
+
end
|
41
|
+
|
42
|
+
# Attribute type mapping.
|
43
|
+
def self.swagger_types
|
44
|
+
{
|
45
|
+
:'label' => :'String',
|
46
|
+
:'name' => :'String',
|
47
|
+
:'required' => :'String',
|
48
|
+
:'type' => :'String',
|
49
|
+
:'value' => :'String'
|
50
|
+
}
|
51
|
+
end
|
52
|
+
|
53
|
+
# Initializes the object
|
54
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
55
|
+
def initialize(attributes = {})
|
56
|
+
return unless attributes.is_a?(Hash)
|
57
|
+
|
58
|
+
# convert string to symbol for hash key
|
59
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
60
|
+
|
61
|
+
if attributes.has_key?(:'label')
|
62
|
+
self.label = attributes[:'label']
|
63
|
+
end
|
64
|
+
|
65
|
+
if attributes.has_key?(:'name')
|
66
|
+
self.name = attributes[:'name']
|
67
|
+
end
|
68
|
+
|
69
|
+
if attributes.has_key?(:'required')
|
70
|
+
self.required = attributes[:'required']
|
71
|
+
end
|
72
|
+
|
73
|
+
if attributes.has_key?(:'type')
|
74
|
+
self.type = attributes[:'type']
|
75
|
+
end
|
76
|
+
|
77
|
+
if attributes.has_key?(:'value')
|
78
|
+
self.value = attributes[:'value']
|
79
|
+
end
|
80
|
+
end
|
81
|
+
|
82
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
83
|
+
# @return Array for valid properties with the reasons
|
84
|
+
def list_invalid_properties
|
85
|
+
invalid_properties = Array.new
|
86
|
+
invalid_properties
|
87
|
+
end
|
88
|
+
|
89
|
+
# Check to see if the all the properties in the model are valid
|
90
|
+
# @return true if the model is valid
|
91
|
+
def valid?
|
92
|
+
true
|
93
|
+
end
|
94
|
+
|
95
|
+
# Checks equality by comparing each attribute.
|
96
|
+
# @param [Object] Object to be compared
|
97
|
+
def ==(o)
|
98
|
+
return true if self.equal?(o)
|
99
|
+
self.class == o.class &&
|
100
|
+
label == o.label &&
|
101
|
+
name == o.name &&
|
102
|
+
required == o.required &&
|
103
|
+
type == o.type &&
|
104
|
+
value == o.value
|
105
|
+
end
|
106
|
+
|
107
|
+
# @see the `==` method
|
108
|
+
# @param [Object] Object to be compared
|
109
|
+
def eql?(o)
|
110
|
+
self == o
|
111
|
+
end
|
112
|
+
|
113
|
+
# Calculates hash code according to all attributes.
|
114
|
+
# @return [Fixnum] Hash code
|
115
|
+
def hash
|
116
|
+
[label, name, required, type, value].hash
|
117
|
+
end
|
118
|
+
|
119
|
+
# Builds the object from hash
|
120
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
121
|
+
# @return [Object] Returns the model itself
|
122
|
+
def build_from_hash(attributes)
|
123
|
+
return nil unless attributes.is_a?(Hash)
|
124
|
+
self.class.swagger_types.each_pair do |key, type|
|
125
|
+
if type =~ /\AArray<(.*)>/i
|
126
|
+
# check to ensure the input is an array given that the attribute
|
127
|
+
# is documented as an array but the input is not
|
128
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
129
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
130
|
+
end
|
131
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
132
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
133
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
134
|
+
end
|
135
|
+
|
136
|
+
self
|
137
|
+
end
|
138
|
+
|
139
|
+
# Deserializes the data based on type
|
140
|
+
# @param string type Data type
|
141
|
+
# @param string value Value to be deserialized
|
142
|
+
# @return [Object] Deserialized data
|
143
|
+
def _deserialize(type, value)
|
144
|
+
case type.to_sym
|
145
|
+
when :DateTime
|
146
|
+
DateTime.parse(value)
|
147
|
+
when :Date
|
148
|
+
Date.parse(value)
|
149
|
+
when :String
|
150
|
+
value.to_s
|
151
|
+
when :Integer
|
152
|
+
value.to_i
|
153
|
+
when :Float
|
154
|
+
value.to_f
|
155
|
+
when :BOOLEAN
|
156
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
157
|
+
true
|
158
|
+
else
|
159
|
+
false
|
160
|
+
end
|
161
|
+
when :Object
|
162
|
+
# generic object (usually a Hash), return directly
|
163
|
+
value
|
164
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
165
|
+
inner_type = Regexp.last_match[:inner_type]
|
166
|
+
value.map { |v| _deserialize(inner_type, v) }
|
167
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
168
|
+
k_type = Regexp.last_match[:k_type]
|
169
|
+
v_type = Regexp.last_match[:v_type]
|
170
|
+
{}.tap do |hash|
|
171
|
+
value.each do |k, v|
|
172
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
173
|
+
end
|
174
|
+
end
|
175
|
+
else # model
|
176
|
+
temp_model = DocuSign_eSign.const_get(type).new
|
177
|
+
temp_model.build_from_hash(value)
|
178
|
+
end
|
179
|
+
end
|
180
|
+
|
181
|
+
# Returns the string representation of the object
|
182
|
+
# @return [String] String presentation of the object
|
183
|
+
def to_s
|
184
|
+
to_hash.to_s
|
185
|
+
end
|
186
|
+
|
187
|
+
# to_body is an alias to to_hash (backward compatibility)
|
188
|
+
# @return [Hash] Returns the object in the form of hash
|
189
|
+
def to_body
|
190
|
+
to_hash
|
191
|
+
end
|
192
|
+
|
193
|
+
# Returns the object in the form of hash
|
194
|
+
# @return [Hash] Returns the object in the form of hash
|
195
|
+
def to_hash
|
196
|
+
hash = {}
|
197
|
+
self.class.attribute_map.each_pair do |attr, param|
|
198
|
+
value = self.send(attr)
|
199
|
+
next if value.nil?
|
200
|
+
hash[param] = _to_hash(value)
|
201
|
+
end
|
202
|
+
hash
|
203
|
+
end
|
204
|
+
|
205
|
+
# Outputs non-array value in the form of hash
|
206
|
+
# For object, use to_hash. Otherwise, just return the value
|
207
|
+
# @param [Object] value Any valid value
|
208
|
+
# @return [Hash] Returns the value in the form of hash
|
209
|
+
def _to_hash(value)
|
210
|
+
if value.is_a?(Array)
|
211
|
+
value.compact.map { |v| _to_hash(v) }
|
212
|
+
elsif value.is_a?(Hash)
|
213
|
+
{}.tap do |hash|
|
214
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
215
|
+
end
|
216
|
+
elsif value.respond_to? :to_hash
|
217
|
+
value.to_hash
|
218
|
+
else
|
219
|
+
value
|
220
|
+
end
|
221
|
+
end
|
222
|
+
|
223
|
+
end
|
224
|
+
end
|