docusign_esign 3.12.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 +54 -0
- data/docusign_esign.gemspec +5 -5
- data/lib/docusign_esign/api/accounts_api.rb +83 -433
- data/lib/docusign_esign/api/billing_api.rb +12 -4
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +93 -26
- data/lib/docusign_esign/api/bulk_process_data_api.rb +412 -0
- data/lib/docusign_esign/api/bulk_process_data_send_api.rb +252 -0
- data/lib/docusign_esign/api/connect_api.rb +239 -5
- data/lib/docusign_esign/api/email_archive_api.rb +8 -8
- data/lib/docusign_esign/api/envelopes_api.rb +1435 -207
- data/lib/docusign_esign/api/notary_api.rb +16 -16
- data/lib/docusign_esign/api/organizations_api.rb +8 -60
- data/lib/docusign_esign/api/power_forms_api.rb +24 -16
- data/lib/docusign_esign/api/templates_api.rb +20 -79
- data/lib/docusign_esign/api/users_api.rb +22 -14
- data/lib/docusign_esign/api/workspaces_api.rb +4 -4
- data/lib/docusign_esign/client/api_client.rb +16 -10
- data/lib/docusign_esign/client/api_error.rb +1 -1
- data/lib/docusign_esign/client/auth/oauth.rb +1 -1
- data/lib/docusign_esign/models/access_code_format.rb +6 -0
- data/lib/docusign_esign/models/account_billing_plan.rb +25 -4
- data/lib/docusign_esign/models/account_billing_plan_response.rb +37 -10
- 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 +11 -1
- 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 +81 -4
- data/lib/docusign_esign/models/account_settings_information.rb +1075 -13
- 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 +28 -13
- data/lib/docusign_esign/models/address_information_input.rb +1 -0
- data/lib/docusign_esign/models/agent.rb +45 -1
- data/lib/docusign_esign/models/app_store_receipt.rb +21 -1
- data/lib/docusign_esign/models/approve.rb +65 -1
- 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_charge.rb +1 -1
- data/lib/docusign_esign/models/billing_entity_information_response.rb +214 -0
- data/lib/docusign_esign/models/billing_invoice_item.rb +21 -1
- data/lib/docusign_esign/models/billing_invoices_summary.rb +21 -1
- data/lib/docusign_esign/models/billing_plan_information.rb +52 -4
- 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_process_request.rb +194 -0
- data/lib/docusign_esign/models/bulk_process_response.rb +248 -0
- data/lib/docusign_esign/models/bulk_process_result.rb +206 -0
- data/lib/docusign_esign/models/bulk_processing_list_summaries.rb +186 -0
- data/lib/docusign_esign/models/bulk_processing_list_summary.rb +214 -0
- data/lib/docusign_esign/models/bulk_processing_lists.rb +186 -0
- data/lib/docusign_esign/models/bulk_recipients_update_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_action_request.rb +204 -0
- data/lib/docusign_esign/models/bulk_send_batch_error.rb +194 -0
- data/lib/docusign_esign/models/bulk_send_batch_status.rb +42 -1
- data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +22 -1
- data/lib/docusign_esign/models/bulk_send_batch_summary.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_envelopes_info.rb +304 -0
- data/lib/docusign_esign/models/bulk_send_error_status.rb +12 -1
- 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 +48 -1
- data/lib/docusign_esign/models/certified_delivery.rb +47 -1
- data/lib/docusign_esign/models/checkbox.rb +109 -1
- 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 +63 -1
- data/lib/docusign_esign/models/commission_county.rb +72 -1
- data/lib/docusign_esign/models/commission_expiration.rb +72 -1
- data/lib/docusign_esign/models/commission_number.rb +72 -1
- data/lib/docusign_esign/models/commission_state.rb +72 -1
- data/lib/docusign_esign/models/company.rb +72 -1
- 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 +60 -4
- data/lib/docusign_esign/models/connect_debug_log.rb +1 -0
- data/lib/docusign_esign/models/connect_delete_failure_result.rb +174 -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_historical_envelope_republish.rb +195 -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/connect_user_info.rb +214 -0
- data/lib/docusign_esign/models/consent_details.rb +204 -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 +12 -1
- 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 +95 -1
- 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 +98 -1
- data/lib/docusign_esign/models/date_signed.rb +66 -1
- data/lib/docusign_esign/models/date_stamp_properties.rb +1 -0
- data/lib/docusign_esign/models/decline.rb +66 -1
- data/lib/docusign_esign/models/delayed_routing.rb +206 -0
- data/lib/docusign_esign/models/delayed_routing_api_model.rb +206 -0
- data/lib/docusign_esign/models/delegation_info.rb +214 -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/downgrade_plan_update_response.rb +11 -1
- data/lib/docusign_esign/models/downgrade_request_information.rb +204 -0
- data/lib/docusign_esign/models/draw.rb +60 -1
- data/lib/docusign_esign/models/e_note_configuration.rb +1 -0
- data/lib/docusign_esign/models/editor.rb +46 -1
- data/lib/docusign_esign/models/email.rb +98 -1
- data/lib/docusign_esign/models/email_address.rb +66 -1
- data/lib/docusign_esign/models/envelope.rb +20 -1
- data/lib/docusign_esign/models/envelope_attachment.rb +1 -0
- data/lib/docusign_esign/models/envelope_custom_metadata.rb +186 -0
- data/lib/docusign_esign/models/envelope_definition.rb +23 -1
- data/lib/docusign_esign/models/envelope_delay_rule.rb +194 -0
- data/lib/docusign_esign/models/envelope_delay_rule_api_model.rb +195 -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 +65 -1
- 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_publish_transaction.rb +307 -0
- data/lib/docusign_esign/models/envelope_publish_transaction_error_rollup.rb +194 -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 +22 -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 +24 -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/external_primary_account_recipient_auth_requirements.rb +214 -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 +66 -1
- 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 +13 -1
- 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 +103 -1
- data/lib/docusign_esign/models/full_name.rb +66 -1
- data/lib/docusign_esign/models/group.rb +13 -1
- 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/id_evidence_resource_token.rb +194 -0
- data/lib/docusign_esign/models/id_evidence_view_link.rb +184 -0
- data/lib/docusign_esign/models/in_person_signer.rb +31 -0
- data/lib/docusign_esign/models/initial_here.rb +60 -1
- data/lib/docusign_esign/models/inline_template.rb +3 -0
- data/lib/docusign_esign/models/integrated_connect_user_info_list.rb +246 -0
- data/lib/docusign_esign/models/intermediary.rb +46 -1
- data/lib/docusign_esign/models/jurisdiction.rb +1 -0
- data/lib/docusign_esign/models/last_name.rb +66 -1
- data/lib/docusign_esign/models/linked_external_primary_account.rb +21 -1
- data/lib/docusign_esign/models/list.rb +112 -1
- 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 +53 -4
- 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 +58 -1
- 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 +93 -1
- data/lib/docusign_esign/models/notary_result.rb +2 -0
- data/lib/docusign_esign/models/notary_seal.rb +59 -1
- data/lib/docusign_esign/models/note.rb +67 -1
- 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 +100 -1
- data/lib/docusign_esign/models/page.rb +1 -0
- data/lib/docusign_esign/models/participant.rb +908 -0
- data/lib/docusign_esign/models/payment_details.rb +16 -1
- 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 +72 -1
- data/lib/docusign_esign/models/poly_line_overlay.rb +60 -1
- 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 +65 -4
- data/lib/docusign_esign/models/property_metadata.rb +1 -0
- data/lib/docusign_esign/models/radio.rb +48 -1
- data/lib/docusign_esign/models/radio_group.rb +78 -4
- 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 +44 -4
- data/lib/docusign_esign/models/recipient_identity_verification.rb +15 -4
- 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 +102 -2
- 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 +14 -1
- data/lib/docusign_esign/models/recipients_update_summary.rb +1 -0
- data/lib/docusign_esign/models/reserved_domain_existence.rb +194 -0
- data/lib/docusign_esign/models/return_url_request.rb +1 -0
- data/lib/docusign_esign/models/scheduled_sending.rb +216 -0
- data/lib/docusign_esign/models/scheduled_sending_api_model.rb +206 -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 +65 -1
- data/lib/docusign_esign/models/sender_email_notifications.rb +12 -1
- data/lib/docusign_esign/models/sender_name.rb +65 -1
- 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 +62 -1
- 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 +84 -1
- data/lib/docusign_esign/models/signer_attachment.rb +60 -1
- 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 +61 -1
- 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 +98 -1
- 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 +42 -1
- data/lib/docusign_esign/models/tab_group.rb +61 -1
- data/lib/docusign_esign/models/tab_metadata.rb +34 -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 +14 -1
- 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 +100 -1
- data/lib/docusign_esign/models/text_custom_field.rb +2 -0
- data/lib/docusign_esign/models/title.rb +72 -1
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +70 -1
- data/lib/docusign_esign/models/user_info.rb +1 -0
- data/lib/docusign_esign/models/user_information.rb +17 -1
- 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 +103 -4
- 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 +66 -1
- data/lib/docusign_esign/models/witness.rb +84 -1
- data/lib/docusign_esign/models/workflow.rb +32 -1
- data/lib/docusign_esign/models/workflow_step.rb +13 -1
- 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 +99 -1
- data/lib/docusign_esign/version.rb +1 -1
- data/lib/docusign_esign.rb +30 -17
- data/tests/spec/unit_tests_using_jwt_spec.rb +605 -449
- metadata +70 -44
- data/Gemfile.lock +0 -73
- data/docusign_esign-2.12.0.rc1.gem +0 -0
- data/docusign_esign-3.12.0.rc1.gem +0 -0
- data/lib/docusign_esign/.DS_Store +0 -0
- data/lib/docusign_esign/api/.DS_Store +0 -0
- data/lib/docusign_esign/client/.DS_Store +0 -0
- data/tests/.DS_Store +0 -0
- data/tests/Gemfile.lock +0 -46
- data/tests/docs/private.pem +0 -27
@@ -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
|
+
# A complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document.
|
15
16
|
class Signer
|
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.
|
@@ -51,6 +53,9 @@ module DocuSign_eSign
|
|
51
53
|
#
|
52
54
|
attr_accessor :completed_count
|
53
55
|
|
56
|
+
#
|
57
|
+
attr_accessor :consent_details_list
|
58
|
+
|
54
59
|
#
|
55
60
|
attr_accessor :creation_reason
|
56
61
|
|
@@ -66,12 +71,19 @@ module DocuSign_eSign
|
|
66
71
|
#
|
67
72
|
attr_accessor :default_recipient
|
68
73
|
|
74
|
+
#
|
75
|
+
attr_accessor :delegated_by
|
76
|
+
|
77
|
+
#
|
78
|
+
attr_accessor :delegated_to
|
79
|
+
|
69
80
|
# Reserved: For DocuSign use only.
|
70
81
|
attr_accessor :delivered_date_time
|
71
82
|
|
72
83
|
# Reserved: For DocuSign use only.
|
73
84
|
attr_accessor :delivery_method
|
74
85
|
|
86
|
+
# Reserved for DocuSign.
|
75
87
|
attr_accessor :delivery_method_metadata
|
76
88
|
|
77
89
|
#
|
@@ -86,13 +98,19 @@ module DocuSign_eSign
|
|
86
98
|
# Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters.
|
87
99
|
attr_accessor :email
|
88
100
|
|
101
|
+
# Metadata that indicates whether the `email` property is editable. This property is read-only.
|
89
102
|
attr_accessor :email_metadata
|
90
103
|
|
104
|
+
# 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`.
|
91
105
|
attr_accessor :email_notification
|
92
106
|
|
107
|
+
#
|
108
|
+
attr_accessor :email_recipient_post_signing_url
|
109
|
+
|
93
110
|
# 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]]`
|
94
111
|
attr_accessor :embedded_recipient_start_url
|
95
112
|
|
113
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
96
114
|
attr_accessor :error_details
|
97
115
|
|
98
116
|
# 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.
|
@@ -101,25 +119,31 @@ module DocuSign_eSign
|
|
101
119
|
# Reserved:
|
102
120
|
attr_accessor :fax_number
|
103
121
|
|
122
|
+
# Reserved for DocuSign.
|
104
123
|
attr_accessor :fax_number_metadata
|
105
124
|
|
106
125
|
# The user's first name. Maximum Length: 50 characters.
|
107
126
|
attr_accessor :first_name
|
108
127
|
|
128
|
+
# Metadata that indicates whether the `firstName` property is editable. This property is read-only.
|
109
129
|
attr_accessor :first_name_metadata
|
110
130
|
|
111
131
|
#
|
112
132
|
attr_accessor :full_name
|
113
133
|
|
134
|
+
# Reserved for DocuSign.
|
114
135
|
attr_accessor :full_name_metadata
|
115
136
|
|
116
137
|
# 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.
|
117
138
|
attr_accessor :id_check_configuration_name
|
118
139
|
|
140
|
+
# Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only.
|
119
141
|
attr_accessor :id_check_configuration_name_metadata
|
120
142
|
|
143
|
+
# An object that contains input information related to a recipient ID check.
|
121
144
|
attr_accessor :id_check_information_input
|
122
145
|
|
146
|
+
# 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).
|
123
147
|
attr_accessor :identity_verification
|
124
148
|
|
125
149
|
# 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.
|
@@ -128,11 +152,13 @@ module DocuSign_eSign
|
|
128
152
|
# When set to **true**, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. Note that when this is true the email and name for the recipient becomes bulk@recipient.com and \"Bulk Recipient\". These fields can not be changed for the bulk recipient.
|
129
153
|
attr_accessor :is_bulk_recipient
|
130
154
|
|
155
|
+
# Reserved for DocuSign.
|
131
156
|
attr_accessor :is_bulk_recipient_metadata
|
132
157
|
|
133
158
|
#
|
134
159
|
attr_accessor :last_name
|
135
160
|
|
161
|
+
# Metadata that indicates whether the `lastName` property is editable. This property is read-only.
|
136
162
|
attr_accessor :last_name_metadata
|
137
163
|
|
138
164
|
#
|
@@ -144,27 +170,37 @@ module DocuSign_eSign
|
|
144
170
|
#
|
145
171
|
attr_accessor :name
|
146
172
|
|
173
|
+
# Metadata that indicates whether the `name` property is editable. This property is read-only.
|
147
174
|
attr_accessor :name_metadata
|
148
175
|
|
149
176
|
#
|
150
177
|
attr_accessor :notary_id
|
151
178
|
|
179
|
+
#
|
180
|
+
attr_accessor :notary_signer_email_sent
|
181
|
+
|
152
182
|
# 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.
|
153
183
|
attr_accessor :note
|
154
184
|
|
185
|
+
# Metadata that indicates whether the `note` property is editable. This property is read-only.
|
155
186
|
attr_accessor :note_metadata
|
156
187
|
|
188
|
+
# Reserved for DocuSign.
|
157
189
|
attr_accessor :offline_attributes
|
158
190
|
|
191
|
+
# 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.
|
159
192
|
attr_accessor :phone_authentication
|
160
193
|
|
194
|
+
# Describes the recipient phone number.
|
161
195
|
attr_accessor :phone_number
|
162
196
|
|
197
|
+
# The proof file of the recipient.
|
163
198
|
attr_accessor :proof_file
|
164
199
|
|
165
200
|
# Reserved:
|
166
201
|
attr_accessor :recipient_attachments
|
167
202
|
|
203
|
+
# Information about the recipient's authentication status. This property is read-only.
|
168
204
|
attr_accessor :recipient_authentication_status
|
169
205
|
|
170
206
|
#
|
@@ -185,11 +221,13 @@ module DocuSign_eSign
|
|
185
221
|
#
|
186
222
|
attr_accessor :recipient_type
|
187
223
|
|
224
|
+
# Metadata that indicates whether the `recipientType` property is editable. This property is read-only.
|
188
225
|
attr_accessor :recipient_type_metadata
|
189
226
|
|
190
227
|
# When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
|
191
228
|
attr_accessor :require_id_lookup
|
192
229
|
|
230
|
+
# Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only.
|
193
231
|
attr_accessor :require_id_lookup_metadata
|
194
232
|
|
195
233
|
# Sets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. The possible values are: * docusign_express - Requires a DocuSign Express certificate. * safe - Requires a SAFE-BioPharma certificate. * open_trust - Requires an OpenTrust certificate. **Important**: There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See [ML:OpenTrust Rules and Restrictions] for more information.
|
@@ -207,11 +245,13 @@ module DocuSign_eSign
|
|
207
245
|
# Specifies the routing order of the recipient in the envelope.
|
208
246
|
attr_accessor :routing_order
|
209
247
|
|
248
|
+
# Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.
|
210
249
|
attr_accessor :routing_order_metadata
|
211
250
|
|
212
251
|
# The date and time the envelope was sent.
|
213
252
|
attr_accessor :sent_date_time
|
214
253
|
|
254
|
+
# Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers.
|
215
255
|
attr_accessor :signature_info
|
216
256
|
|
217
257
|
# Reserved: For DocuSign use only.
|
@@ -220,11 +260,13 @@ module DocuSign_eSign
|
|
220
260
|
# When set to **true**, specifies that the signer must sign in all locations.
|
221
261
|
attr_accessor :sign_in_each_location
|
222
262
|
|
263
|
+
# Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only.
|
223
264
|
attr_accessor :sign_in_each_location_metadata
|
224
265
|
|
225
266
|
# 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).
|
226
267
|
attr_accessor :signing_group_id
|
227
268
|
|
269
|
+
# Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only.
|
228
270
|
attr_accessor :signing_group_id_metadata
|
229
271
|
|
230
272
|
# The display name for the signing group. Maximum Length: 100 characters.
|
@@ -233,6 +275,7 @@ module DocuSign_eSign
|
|
233
275
|
# A complex type that contains information about users in the signing group.
|
234
276
|
attr_accessor :signing_group_users
|
235
277
|
|
278
|
+
# 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.
|
236
279
|
attr_accessor :sms_authentication
|
237
280
|
|
238
281
|
# Lists the social ID type that can be used for recipient authentication.
|
@@ -247,6 +290,7 @@ module DocuSign_eSign
|
|
247
290
|
#
|
248
291
|
attr_accessor :suppress_emails
|
249
292
|
|
293
|
+
# The tabs to assign to the recipient. [More information](/docs/esign-rest-api/esign101/concepts/tabs/).
|
250
294
|
attr_accessor :tabs
|
251
295
|
|
252
296
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
@@ -277,11 +321,14 @@ module DocuSign_eSign
|
|
277
321
|
:'can_sign_offline' => :'canSignOffline',
|
278
322
|
:'client_user_id' => :'clientUserId',
|
279
323
|
:'completed_count' => :'completedCount',
|
324
|
+
:'consent_details_list' => :'consentDetailsList',
|
280
325
|
:'creation_reason' => :'creationReason',
|
281
326
|
:'custom_fields' => :'customFields',
|
282
327
|
:'declined_date_time' => :'declinedDateTime',
|
283
328
|
:'declined_reason' => :'declinedReason',
|
284
329
|
:'default_recipient' => :'defaultRecipient',
|
330
|
+
:'delegated_by' => :'delegatedBy',
|
331
|
+
:'delegated_to' => :'delegatedTo',
|
285
332
|
:'delivered_date_time' => :'deliveredDateTime',
|
286
333
|
:'delivery_method' => :'deliveryMethod',
|
287
334
|
:'delivery_method_metadata' => :'deliveryMethodMetadata',
|
@@ -291,6 +338,7 @@ module DocuSign_eSign
|
|
291
338
|
:'email' => :'email',
|
292
339
|
:'email_metadata' => :'emailMetadata',
|
293
340
|
:'email_notification' => :'emailNotification',
|
341
|
+
:'email_recipient_post_signing_url' => :'emailRecipientPostSigningURL',
|
294
342
|
:'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
|
295
343
|
:'error_details' => :'errorDetails',
|
296
344
|
:'excluded_documents' => :'excludedDocuments',
|
@@ -314,6 +362,7 @@ module DocuSign_eSign
|
|
314
362
|
:'name' => :'name',
|
315
363
|
:'name_metadata' => :'nameMetadata',
|
316
364
|
:'notary_id' => :'notaryId',
|
365
|
+
:'notary_signer_email_sent' => :'notarySignerEmailSent',
|
317
366
|
:'note' => :'note',
|
318
367
|
:'note_metadata' => :'noteMetadata',
|
319
368
|
:'offline_attributes' => :'offlineAttributes',
|
@@ -375,11 +424,14 @@ module DocuSign_eSign
|
|
375
424
|
:'can_sign_offline' => :'String',
|
376
425
|
:'client_user_id' => :'String',
|
377
426
|
:'completed_count' => :'String',
|
427
|
+
:'consent_details_list' => :'Array<ConsentDetails>',
|
378
428
|
:'creation_reason' => :'String',
|
379
429
|
:'custom_fields' => :'Array<String>',
|
380
430
|
:'declined_date_time' => :'String',
|
381
431
|
:'declined_reason' => :'String',
|
382
432
|
:'default_recipient' => :'String',
|
433
|
+
:'delegated_by' => :'DelegationInfo',
|
434
|
+
:'delegated_to' => :'Array<DelegationInfo>',
|
383
435
|
:'delivered_date_time' => :'String',
|
384
436
|
:'delivery_method' => :'String',
|
385
437
|
:'delivery_method_metadata' => :'PropertyMetadata',
|
@@ -389,6 +441,7 @@ module DocuSign_eSign
|
|
389
441
|
:'email' => :'String',
|
390
442
|
:'email_metadata' => :'PropertyMetadata',
|
391
443
|
:'email_notification' => :'RecipientEmailNotification',
|
444
|
+
:'email_recipient_post_signing_url' => :'String',
|
392
445
|
:'embedded_recipient_start_url' => :'String',
|
393
446
|
:'error_details' => :'ErrorDetails',
|
394
447
|
:'excluded_documents' => :'Array<String>',
|
@@ -412,6 +465,7 @@ module DocuSign_eSign
|
|
412
465
|
:'name' => :'String',
|
413
466
|
:'name_metadata' => :'PropertyMetadata',
|
414
467
|
:'notary_id' => :'String',
|
468
|
+
:'notary_signer_email_sent' => :'String',
|
415
469
|
:'note' => :'String',
|
416
470
|
:'note_metadata' => :'PropertyMetadata',
|
417
471
|
:'offline_attributes' => :'OfflineAttributes',
|
@@ -519,6 +573,12 @@ module DocuSign_eSign
|
|
519
573
|
self.completed_count = attributes[:'completedCount']
|
520
574
|
end
|
521
575
|
|
576
|
+
if attributes.has_key?(:'consentDetailsList')
|
577
|
+
if (value = attributes[:'consentDetailsList']).is_a?(Array)
|
578
|
+
self.consent_details_list = value
|
579
|
+
end
|
580
|
+
end
|
581
|
+
|
522
582
|
if attributes.has_key?(:'creationReason')
|
523
583
|
self.creation_reason = attributes[:'creationReason']
|
524
584
|
end
|
@@ -541,6 +601,16 @@ module DocuSign_eSign
|
|
541
601
|
self.default_recipient = attributes[:'defaultRecipient']
|
542
602
|
end
|
543
603
|
|
604
|
+
if attributes.has_key?(:'delegatedBy')
|
605
|
+
self.delegated_by = attributes[:'delegatedBy']
|
606
|
+
end
|
607
|
+
|
608
|
+
if attributes.has_key?(:'delegatedTo')
|
609
|
+
if (value = attributes[:'delegatedTo']).is_a?(Array)
|
610
|
+
self.delegated_to = value
|
611
|
+
end
|
612
|
+
end
|
613
|
+
|
544
614
|
if attributes.has_key?(:'deliveredDateTime')
|
545
615
|
self.delivered_date_time = attributes[:'deliveredDateTime']
|
546
616
|
end
|
@@ -579,6 +649,10 @@ module DocuSign_eSign
|
|
579
649
|
self.email_notification = attributes[:'emailNotification']
|
580
650
|
end
|
581
651
|
|
652
|
+
if attributes.has_key?(:'emailRecipientPostSigningURL')
|
653
|
+
self.email_recipient_post_signing_url = attributes[:'emailRecipientPostSigningURL']
|
654
|
+
end
|
655
|
+
|
582
656
|
if attributes.has_key?(:'embeddedRecipientStartURL')
|
583
657
|
self.embedded_recipient_start_url = attributes[:'embeddedRecipientStartURL']
|
584
658
|
end
|
@@ -673,6 +747,10 @@ module DocuSign_eSign
|
|
673
747
|
self.notary_id = attributes[:'notaryId']
|
674
748
|
end
|
675
749
|
|
750
|
+
if attributes.has_key?(:'notarySignerEmailSent')
|
751
|
+
self.notary_signer_email_sent = attributes[:'notarySignerEmailSent']
|
752
|
+
end
|
753
|
+
|
676
754
|
if attributes.has_key?(:'note')
|
677
755
|
self.note = attributes[:'note']
|
678
756
|
end
|
@@ -883,11 +961,14 @@ module DocuSign_eSign
|
|
883
961
|
can_sign_offline == o.can_sign_offline &&
|
884
962
|
client_user_id == o.client_user_id &&
|
885
963
|
completed_count == o.completed_count &&
|
964
|
+
consent_details_list == o.consent_details_list &&
|
886
965
|
creation_reason == o.creation_reason &&
|
887
966
|
custom_fields == o.custom_fields &&
|
888
967
|
declined_date_time == o.declined_date_time &&
|
889
968
|
declined_reason == o.declined_reason &&
|
890
969
|
default_recipient == o.default_recipient &&
|
970
|
+
delegated_by == o.delegated_by &&
|
971
|
+
delegated_to == o.delegated_to &&
|
891
972
|
delivered_date_time == o.delivered_date_time &&
|
892
973
|
delivery_method == o.delivery_method &&
|
893
974
|
delivery_method_metadata == o.delivery_method_metadata &&
|
@@ -897,6 +978,7 @@ module DocuSign_eSign
|
|
897
978
|
email == o.email &&
|
898
979
|
email_metadata == o.email_metadata &&
|
899
980
|
email_notification == o.email_notification &&
|
981
|
+
email_recipient_post_signing_url == o.email_recipient_post_signing_url &&
|
900
982
|
embedded_recipient_start_url == o.embedded_recipient_start_url &&
|
901
983
|
error_details == o.error_details &&
|
902
984
|
excluded_documents == o.excluded_documents &&
|
@@ -920,6 +1002,7 @@ module DocuSign_eSign
|
|
920
1002
|
name == o.name &&
|
921
1003
|
name_metadata == o.name_metadata &&
|
922
1004
|
notary_id == o.notary_id &&
|
1005
|
+
notary_signer_email_sent == o.notary_signer_email_sent &&
|
923
1006
|
note == o.note &&
|
924
1007
|
note_metadata == o.note_metadata &&
|
925
1008
|
offline_attributes == o.offline_attributes &&
|
@@ -973,7 +1056,7 @@ module DocuSign_eSign
|
|
973
1056
|
# Calculates hash code according to all attributes.
|
974
1057
|
# @return [Fixnum] Hash code
|
975
1058
|
def hash
|
976
|
-
[access_code, access_code_metadata, add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, auto_navigation, auto_responded_reason, bulk_recipients_uri, can_sign_offline, client_user_id, completed_count, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, is_bulk_recipient, is_bulk_recipient_metadata, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, note, note_metadata, offline_attributes, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, require_signer_certificate, require_sign_on_paper, require_upload_signature, role_name, routing_order, routing_order_metadata, sent_date_time, signature_info, signed_date_time, sign_in_each_location, sign_in_each_location_metadata, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id].hash
|
1059
|
+
[access_code, access_code_metadata, add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, auto_navigation, auto_responded_reason, bulk_recipients_uri, can_sign_offline, client_user_id, completed_count, consent_details_list, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delegated_by, delegated_to, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, is_bulk_recipient, is_bulk_recipient_metadata, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, notary_id, notary_signer_email_sent, note, note_metadata, offline_attributes, phone_authentication, phone_number, proof_file, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, require_signer_certificate, require_sign_on_paper, require_upload_signature, role_name, routing_order, routing_order_metadata, sent_date_time, signature_info, signed_date_time, sign_in_each_location, sign_in_each_location_metadata, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id].hash
|
977
1060
|
end
|
978
1061
|
|
979
1062
|
# Builds the object from hash
|
@@ -12,92 +12,116 @@ 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 attach supporting documents to an envelope.
|
15
16
|
class SignerAttachment
|
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
|
|
77
|
+
#
|
78
|
+
attr_accessor :caption
|
79
|
+
|
80
|
+
attr_accessor :caption_metadata
|
81
|
+
|
66
82
|
# For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
|
67
83
|
attr_accessor :conditional_parent_label
|
68
84
|
|
85
|
+
# Metadata that indicates whether the `conditionalParentLabel` property is editable.
|
69
86
|
attr_accessor :conditional_parent_label_metadata
|
70
87
|
|
71
88
|
# 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.
|
72
89
|
attr_accessor :conditional_parent_value
|
73
90
|
|
91
|
+
# Metadata that indicates whether the `conditionalParentValue` property is editable.
|
74
92
|
attr_accessor :conditional_parent_value_metadata
|
75
93
|
|
76
94
|
# 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.
|
77
95
|
attr_accessor :custom_tab_id
|
78
96
|
|
97
|
+
# Metadata that indicates whether the `customTabId` property is editable.
|
79
98
|
attr_accessor :custom_tab_id_metadata
|
80
99
|
|
81
100
|
# Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
|
82
101
|
attr_accessor :document_id
|
83
102
|
|
103
|
+
# Metadata that indicates whether the `documentId` property is editable.
|
84
104
|
attr_accessor :document_id_metadata
|
85
105
|
|
106
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
86
107
|
attr_accessor :error_details
|
87
108
|
|
88
109
|
#
|
89
110
|
attr_accessor :form_order
|
90
111
|
|
112
|
+
# Metadata that indicates whether the `formOrder` property is editable.
|
91
113
|
attr_accessor :form_order_metadata
|
92
114
|
|
93
115
|
#
|
94
116
|
attr_accessor :form_page_label
|
95
117
|
|
118
|
+
# Metadata that indicates whether the `formPageLabel` property is editable.
|
96
119
|
attr_accessor :form_page_label_metadata
|
97
120
|
|
98
121
|
#
|
99
122
|
attr_accessor :form_page_number
|
100
123
|
|
124
|
+
# Metadata that indicates whether the `fromPageNumber` property is editable.
|
101
125
|
attr_accessor :form_page_number_metadata
|
102
126
|
|
103
127
|
#
|
@@ -106,8 +130,10 @@ module DocuSign_eSign
|
|
106
130
|
# Height of the tab in pixels.
|
107
131
|
attr_accessor :height
|
108
132
|
|
133
|
+
# Metadata that indicates whether the `height` property is editable.
|
109
134
|
attr_accessor :height_metadata
|
110
135
|
|
136
|
+
# Contains the information necessary to map the tab to a field in SalesForce.
|
111
137
|
attr_accessor :merge_field
|
112
138
|
|
113
139
|
#
|
@@ -116,16 +142,19 @@ module DocuSign_eSign
|
|
116
142
|
#
|
117
143
|
attr_accessor :name
|
118
144
|
|
145
|
+
# Metadata that indicates whether the `name` property is editable. This property is read-only.
|
119
146
|
attr_accessor :name_metadata
|
120
147
|
|
121
148
|
#
|
122
149
|
attr_accessor :optional
|
123
150
|
|
151
|
+
# Metadata that indicates whether the `optional` property is editable.
|
124
152
|
attr_accessor :optional_metadata
|
125
153
|
|
126
154
|
# Specifies the page number on which the tab is located.
|
127
155
|
attr_accessor :page_number
|
128
156
|
|
157
|
+
# Metadata that indicates whether the `pageNumber` property is editable.
|
129
158
|
attr_accessor :page_number_metadata
|
130
159
|
|
131
160
|
# Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
|
@@ -134,15 +163,19 @@ module DocuSign_eSign
|
|
134
163
|
#
|
135
164
|
attr_accessor :recipient_id_guid
|
136
165
|
|
166
|
+
# Metadata that indicates whether the `recipientIdGuid` property is editable.
|
137
167
|
attr_accessor :recipient_id_guid_metadata
|
138
168
|
|
169
|
+
# Metadata that indicates whether the `recipientId` property is editable.
|
139
170
|
attr_accessor :recipient_id_metadata
|
140
171
|
|
141
172
|
#
|
142
173
|
attr_accessor :scale_value
|
143
174
|
|
175
|
+
# Metadata that indicates whether the `scaleValue` property is editable.
|
144
176
|
attr_accessor :scale_value_metadata
|
145
177
|
|
178
|
+
# Reserved for DocuSign.
|
146
179
|
attr_accessor :smart_contract_information
|
147
180
|
|
148
181
|
#
|
@@ -151,61 +184,73 @@ module DocuSign_eSign
|
|
151
184
|
# Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
|
152
185
|
attr_accessor :status
|
153
186
|
|
187
|
+
# Metadata that indicates whether the `status` property is editable.
|
154
188
|
attr_accessor :status_metadata
|
155
189
|
|
156
190
|
#
|
157
191
|
attr_accessor :tab_group_labels
|
158
192
|
|
193
|
+
# Metadata that indicates whether the `tabGroupLabels` property is editable.
|
159
194
|
attr_accessor :tab_group_labels_metadata
|
160
195
|
|
161
196
|
# The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
|
162
197
|
attr_accessor :tab_id
|
163
198
|
|
199
|
+
# Metadata that indicates whether the `tabId` property is editable.
|
164
200
|
attr_accessor :tab_id_metadata
|
165
201
|
|
166
202
|
# The label string associated with the tab.
|
167
203
|
attr_accessor :tab_label
|
168
204
|
|
205
|
+
# Metadata that indicates whether the `tabLabel` property is editable.
|
169
206
|
attr_accessor :tab_label_metadata
|
170
207
|
|
171
208
|
#
|
172
209
|
attr_accessor :tab_order
|
173
210
|
|
211
|
+
# Metadata that indicates whether the `tabOrder` property is editable.
|
174
212
|
attr_accessor :tab_order_metadata
|
175
213
|
|
176
214
|
#
|
177
215
|
attr_accessor :tab_type
|
178
216
|
|
217
|
+
# Metadata that indicates whether the `tabType` property is editable.
|
179
218
|
attr_accessor :tab_type_metadata
|
180
219
|
|
181
220
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
182
221
|
attr_accessor :template_locked
|
183
222
|
|
223
|
+
# Metadata that indicates whether the `templateLocked` property is editable.
|
184
224
|
attr_accessor :template_locked_metadata
|
185
225
|
|
186
226
|
# When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
|
187
227
|
attr_accessor :template_required
|
188
228
|
|
229
|
+
# Metadata that indicates whether the `templateRequired` property is editable.
|
189
230
|
attr_accessor :template_required_metadata
|
190
231
|
|
191
232
|
#
|
192
233
|
attr_accessor :tooltip
|
193
234
|
|
235
|
+
# Metadata that indicates whether the `toolTip` property is editable.
|
194
236
|
attr_accessor :tool_tip_metadata
|
195
237
|
|
196
238
|
# Width of the tab in pixels.
|
197
239
|
attr_accessor :width
|
198
240
|
|
241
|
+
# Metadata that indicates whether the `width` property is editable.
|
199
242
|
attr_accessor :width_metadata
|
200
243
|
|
201
244
|
# This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
202
245
|
attr_accessor :x_position
|
203
246
|
|
247
|
+
# Metadata that indicates whether the `xPosition` property is editable.
|
204
248
|
attr_accessor :x_position_metadata
|
205
249
|
|
206
250
|
# This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
207
251
|
attr_accessor :y_position
|
208
252
|
|
253
|
+
# Metadata that indicates whether the `yPosition` property is editable.
|
209
254
|
attr_accessor :y_position_metadata
|
210
255
|
|
211
256
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -231,6 +276,8 @@ module DocuSign_eSign
|
|
231
276
|
:'anchor_x_offset_metadata' => :'anchorXOffsetMetadata',
|
232
277
|
:'anchor_y_offset' => :'anchorYOffset',
|
233
278
|
:'anchor_y_offset_metadata' => :'anchorYOffsetMetadata',
|
279
|
+
:'caption' => :'caption',
|
280
|
+
:'caption_metadata' => :'captionMetadata',
|
234
281
|
:'conditional_parent_label' => :'conditionalParentLabel',
|
235
282
|
:'conditional_parent_label_metadata' => :'conditionalParentLabelMetadata',
|
236
283
|
:'conditional_parent_value' => :'conditionalParentValue',
|
@@ -315,6 +362,8 @@ module DocuSign_eSign
|
|
315
362
|
:'anchor_x_offset_metadata' => :'PropertyMetadata',
|
316
363
|
:'anchor_y_offset' => :'String',
|
317
364
|
:'anchor_y_offset_metadata' => :'PropertyMetadata',
|
365
|
+
:'caption' => :'String',
|
366
|
+
:'caption_metadata' => :'PropertyMetadata',
|
318
367
|
:'conditional_parent_label' => :'String',
|
319
368
|
:'conditional_parent_label_metadata' => :'PropertyMetadata',
|
320
369
|
:'conditional_parent_value' => :'String',
|
@@ -464,6 +513,14 @@ module DocuSign_eSign
|
|
464
513
|
self.anchor_y_offset_metadata = attributes[:'anchorYOffsetMetadata']
|
465
514
|
end
|
466
515
|
|
516
|
+
if attributes.has_key?(:'caption')
|
517
|
+
self.caption = attributes[:'caption']
|
518
|
+
end
|
519
|
+
|
520
|
+
if attributes.has_key?(:'captionMetadata')
|
521
|
+
self.caption_metadata = attributes[:'captionMetadata']
|
522
|
+
end
|
523
|
+
|
467
524
|
if attributes.has_key?(:'conditionalParentLabel')
|
468
525
|
self.conditional_parent_label = attributes[:'conditionalParentLabel']
|
469
526
|
end
|
@@ -737,6 +794,8 @@ module DocuSign_eSign
|
|
737
794
|
anchor_x_offset_metadata == o.anchor_x_offset_metadata &&
|
738
795
|
anchor_y_offset == o.anchor_y_offset &&
|
739
796
|
anchor_y_offset_metadata == o.anchor_y_offset_metadata &&
|
797
|
+
caption == o.caption &&
|
798
|
+
caption_metadata == o.caption_metadata &&
|
740
799
|
conditional_parent_label == o.conditional_parent_label &&
|
741
800
|
conditional_parent_label_metadata == o.conditional_parent_label_metadata &&
|
742
801
|
conditional_parent_value == o.conditional_parent_value &&
|
@@ -806,7 +865,7 @@ module DocuSign_eSign
|
|
806
865
|
# Calculates hash code according to all attributes.
|
807
866
|
# @return [Fixnum] Hash code
|
808
867
|
def hash
|
809
|
-
[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, 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, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, hand_draw_required, height, height_metadata, merge_field, merge_field_xml, name, name_metadata, optional, optional_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, scale_value, scale_value_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, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
|
868
|
+
[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, 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, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, hand_draw_required, height, height_metadata, merge_field, merge_field_xml, name, name_metadata, optional, optional_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, scale_value, scale_value_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, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
|
810
869
|
end
|
811
870
|
|
812
871
|
# Builds the object from hash
|