docusign_esign 2.11.0 → 3.0.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/CHANGELOG.md +0 -55
- data/Gemfile +1 -1
- data/Gemfile.lock +31 -31
- data/README.md +40 -22
- data/docusign_esign-3.0.0.gem +0 -0
- data/docusign_esign.gemspec +1 -2
- data/lib/docusign_esign/api/accounts_api.rb +427 -89
- data/lib/docusign_esign/api/authentication_api.rb +1 -1
- data/lib/docusign_esign/api/billing_api.rb +14 -14
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +195 -155
- data/lib/docusign_esign/api/cloud_storage_api.rb +13 -9
- data/lib/docusign_esign/api/connect_api.rb +16 -167
- data/lib/docusign_esign/api/custom_tabs_api.rb +7 -7
- data/lib/docusign_esign/api/data_feed_api.rb +76 -0
- data/lib/docusign_esign/api/diagnostics_api.rb +8 -8
- data/lib/docusign_esign/api/email_archive_api.rb +261 -0
- data/lib/docusign_esign/api/envelopes_api.rb +1692 -375
- data/lib/docusign_esign/api/folders_api.rb +20 -11
- data/lib/docusign_esign/api/groups_api.rb +25 -21
- data/lib/docusign_esign/api/notary_api.rb +3 -3
- data/lib/docusign_esign/api/power_forms_api.rb +10 -10
- data/lib/docusign_esign/api/signing_groups_api.rb +11 -11
- data/lib/docusign_esign/api/templates_api.rb +323 -79
- data/lib/docusign_esign/api/trust_service_providers_api.rb +3 -3
- data/lib/docusign_esign/api/users_api.rb +66 -38
- data/lib/docusign_esign/api/workspaces_api.rb +13 -13
- data/lib/docusign_esign/client/api_client.rb +2 -3
- data/lib/docusign_esign/configuration.rb +3 -4
- data/lib/docusign_esign/models/access_code_format.rb +273 -0
- data/lib/docusign_esign/models/account_address.rb +11 -8
- data/lib/docusign_esign/models/account_billing_plan.rb +12 -59
- data/lib/docusign_esign/models/account_billing_plan_response.rb +31 -9
- data/lib/docusign_esign/models/account_identity_verification_response.rb +12 -8
- data/lib/docusign_esign/models/account_identity_verification_step.rb +12 -8
- data/lib/docusign_esign/models/account_identity_verification_workflow.rb +45 -12
- data/lib/docusign_esign/models/account_information.rb +45 -19
- data/lib/docusign_esign/models/account_minimum_password_length.rb +12 -8
- data/lib/docusign_esign/models/account_notification.rb +206 -0
- data/lib/docusign_esign/models/account_password_expire_password_days.rb +12 -8
- data/lib/docusign_esign/models/account_password_lockout_duration_minutes.rb +12 -8
- data/lib/docusign_esign/models/account_password_lockout_duration_type.rb +12 -8
- data/lib/docusign_esign/models/account_password_minimum_password_age_days.rb +12 -8
- data/lib/docusign_esign/models/account_password_questions_required.rb +12 -8
- data/lib/docusign_esign/models/account_password_rules.rb +12 -8
- data/lib/docusign_esign/models/account_password_strength_type.rb +12 -8
- data/lib/docusign_esign/models/account_password_strength_type_option.rb +12 -8
- data/lib/docusign_esign/models/account_role_settings.rb +41 -9
- data/lib/docusign_esign/models/account_seals.rb +12 -8
- data/lib/docusign_esign/models/account_settings_information.rb +4700 -27
- data/lib/docusign_esign/models/account_shared_access.rb +11 -8
- data/lib/docusign_esign/models/account_signature_provider.rb +12 -8
- data/lib/docusign_esign/models/account_signature_provider_option.rb +12 -8
- data/lib/docusign_esign/models/account_signature_providers.rb +12 -8
- data/lib/docusign_esign/models/account_ui_settings.rb +330 -0
- data/lib/docusign_esign/models/add_on.rb +11 -8
- data/lib/docusign_esign/models/address_information.rb +44 -51
- data/lib/docusign_esign/models/address_information_input.rb +11 -8
- data/lib/docusign_esign/models/address_information_v2.rb +11 -7
- data/lib/docusign_esign/models/agent.rb +207 -34
- data/lib/docusign_esign/models/api_request_log.rb +11 -8
- data/lib/docusign_esign/models/api_request_logs_result.rb +11 -8
- data/lib/docusign_esign/models/app_store_product.rb +11 -8
- data/lib/docusign_esign/models/app_store_receipt.rb +11 -8
- data/lib/docusign_esign/models/approve.rb +448 -14
- data/lib/docusign_esign/models/attachment.rb +11 -8
- data/lib/docusign_esign/models/authentication_method.rb +12 -9
- data/lib/docusign_esign/models/authentication_status.rb +11 -8
- data/lib/docusign_esign/models/bcc_email_address.rb +11 -8
- data/lib/docusign_esign/models/bcc_email_archive.rb +276 -0
- data/lib/docusign_esign/models/bcc_email_archive_history.rb +237 -0
- data/lib/docusign_esign/models/bcc_email_archive_history_list.rb +250 -0
- data/lib/docusign_esign/models/bcc_email_archive_list.rb +250 -0
- data/lib/docusign_esign/models/billing_charge.rb +11 -8
- data/lib/docusign_esign/models/billing_charge_response.rb +11 -8
- data/lib/docusign_esign/models/billing_discount.rb +12 -8
- data/lib/docusign_esign/models/billing_invoice.rb +11 -8
- data/lib/docusign_esign/models/billing_invoice_item.rb +11 -8
- data/lib/docusign_esign/models/billing_invoices_response.rb +11 -8
- data/lib/docusign_esign/models/billing_invoices_summary.rb +12 -8
- data/lib/docusign_esign/models/billing_payment.rb +11 -8
- data/lib/docusign_esign/models/billing_payment_item.rb +11 -8
- data/lib/docusign_esign/models/billing_payment_request.rb +12 -8
- data/lib/docusign_esign/models/billing_payment_response.rb +11 -8
- data/lib/docusign_esign/models/billing_payments_response.rb +11 -8
- data/lib/docusign_esign/models/billing_plan.rb +11 -8
- data/lib/docusign_esign/models/billing_plan_information.rb +32 -9
- data/lib/docusign_esign/models/billing_plan_preview.rb +11 -8
- data/lib/docusign_esign/models/billing_plan_response.rb +11 -8
- data/lib/docusign_esign/models/billing_plan_update_response.rb +11 -8
- data/lib/docusign_esign/models/billing_plans_response.rb +11 -8
- data/lib/docusign_esign/models/billing_price.rb +12 -8
- data/lib/docusign_esign/models/brand.rb +38 -12
- data/lib/docusign_esign/models/brand_email_content.rb +12 -8
- data/lib/docusign_esign/models/brand_link.rb +12 -8
- data/lib/docusign_esign/models/brand_logos.rb +12 -8
- data/lib/docusign_esign/models/brand_request.rb +12 -8
- data/lib/docusign_esign/models/brand_resource_urls.rb +12 -8
- data/lib/docusign_esign/models/brand_resources.rb +25 -9
- data/lib/docusign_esign/models/brand_resources_list.rb +12 -8
- data/lib/docusign_esign/models/brands_request.rb +12 -8
- data/lib/docusign_esign/models/brands_response.rb +12 -8
- data/lib/docusign_esign/models/bulk_envelope.rb +12 -8
- data/lib/docusign_esign/models/bulk_envelope_status.rb +12 -8
- data/lib/docusign_esign/models/bulk_envelopes_response.rb +12 -8
- data/lib/docusign_esign/models/bulk_recipient.rb +12 -8
- data/lib/docusign_esign/models/bulk_recipient_signature_provider.rb +12 -8
- data/lib/docusign_esign/models/bulk_recipient_tab_label.rb +12 -8
- data/lib/docusign_esign/models/bulk_recipients_request.rb +12 -8
- data/lib/docusign_esign/models/bulk_recipients_response.rb +12 -8
- data/lib/docusign_esign/models/bulk_recipients_summary_response.rb +12 -8
- data/lib/docusign_esign/models/bulk_recipients_update_response.rb +12 -8
- data/lib/docusign_esign/models/{envelope_form_data_prefill_form_data.rb → bulk_send_request.rb} +20 -18
- data/lib/docusign_esign/models/{group_brands.rb → bulk_send_response.rb} +48 -33
- data/lib/docusign_esign/models/bulk_send_test_response.rb +212 -0
- data/lib/docusign_esign/models/bulk_sending_copy.rb +222 -0
- data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +198 -0
- data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +382 -0
- data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +198 -0
- data/lib/docusign_esign/models/bulk_sending_list.rb +210 -0
- data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +190 -0
- data/lib/docusign_esign/models/bulk_sending_list_summary.rb +218 -0
- data/lib/docusign_esign/models/captive_recipient.rb +12 -8
- data/lib/docusign_esign/models/captive_recipient_information.rb +12 -8
- data/lib/docusign_esign/models/carbon_copy.rb +217 -43
- data/lib/docusign_esign/models/certified_delivery.rb +208 -43
- data/lib/docusign_esign/models/checkbox.rb +562 -12
- data/lib/docusign_esign/models/chunked_upload_part.rb +12 -8
- data/lib/docusign_esign/models/chunked_upload_request.rb +12 -8
- data/lib/docusign_esign/models/chunked_upload_response.rb +12 -8
- data/lib/docusign_esign/models/cloud_storage_provider.rb +12 -8
- data/lib/docusign_esign/models/cloud_storage_providers.rb +12 -8
- data/lib/docusign_esign/models/comment.rb +392 -0
- data/lib/docusign_esign/models/{prefill_form_data.rb → comment_history_result.rb} +39 -35
- data/lib/docusign_esign/models/comment_publish.rb +244 -0
- data/lib/docusign_esign/models/comment_thread.rb +961 -0
- data/lib/docusign_esign/models/comments_publish.rb +190 -0
- data/lib/docusign_esign/models/company.rb +521 -14
- data/lib/docusign_esign/models/complete_sign_hash_response.rb +12 -8
- data/lib/docusign_esign/models/complete_sign_request.rb +11 -7
- data/lib/docusign_esign/models/composite_template.rb +12 -8
- data/lib/docusign_esign/models/connect_config_results.rb +12 -8
- data/lib/docusign_esign/models/connect_custom_configuration.rb +159 -15
- data/lib/docusign_esign/models/connect_debug_log.rb +12 -8
- data/lib/docusign_esign/models/connect_failure_filter.rb +12 -8
- data/lib/docusign_esign/models/connect_failure_result.rb +12 -8
- data/lib/docusign_esign/models/connect_failure_results.rb +12 -8
- data/lib/docusign_esign/models/connect_log.rb +12 -8
- data/lib/docusign_esign/models/connect_logs.rb +12 -8
- data/lib/docusign_esign/models/connect_salesforce_field.rb +258 -0
- data/lib/docusign_esign/models/connect_salesforce_object.rb +272 -0
- data/lib/docusign_esign/models/connect_user_object.rb +230 -0
- data/lib/docusign_esign/models/console_view_request.rb +12 -8
- data/lib/docusign_esign/models/consumer_disclosure.rb +12 -8
- data/lib/docusign_esign/models/contact.rb +43 -9
- data/lib/docusign_esign/models/contact_get_response.rb +12 -8
- data/lib/docusign_esign/models/contact_mod_request.rb +20 -16
- data/lib/docusign_esign/models/contact_phone_number.rb +12 -8
- data/lib/docusign_esign/models/contact_update_response.rb +12 -8
- data/lib/docusign_esign/models/correct_view_request.rb +14 -20
- data/lib/docusign_esign/models/country.rb +12 -8
- data/lib/docusign_esign/models/credential.rb +11 -7
- data/lib/docusign_esign/models/credit_card_information.rb +23 -9
- data/lib/docusign_esign/models/credit_card_types.rb +12 -8
- data/lib/docusign_esign/models/currency_feature_set_price.rb +12 -8
- data/lib/docusign_esign/models/currency_plan_price.rb +12 -8
- data/lib/docusign_esign/models/custom_field.rb +12 -8
- data/lib/docusign_esign/models/custom_field_v2.rb +11 -7
- data/lib/docusign_esign/models/custom_fields.rb +11 -8
- data/lib/docusign_esign/models/custom_fields_envelope.rb +12 -8
- data/lib/docusign_esign/models/custom_settings_information.rb +12 -8
- data/lib/docusign_esign/models/date.rb +575 -14
- data/lib/docusign_esign/models/date_signed.rb +475 -12
- data/lib/docusign_esign/models/date_stamp_properties.rb +12 -8
- data/lib/docusign_esign/models/decline.rb +457 -14
- data/lib/docusign_esign/models/diagnostics_settings_information.rb +12 -8
- data/lib/docusign_esign/models/direct_debit_processor_information.rb +298 -0
- data/lib/docusign_esign/models/display_appliance_document.rb +258 -0
- data/lib/docusign_esign/models/display_appliance_document_page.rb +278 -0
- data/lib/docusign_esign/models/display_appliance_envelope.rb +328 -0
- data/lib/docusign_esign/models/display_appliance_info.rb +235 -0
- data/lib/docusign_esign/models/display_appliance_page.rb +278 -0
- data/lib/docusign_esign/models/display_appliance_pdf.rb +267 -0
- data/lib/docusign_esign/models/display_appliance_recipient.rb +388 -0
- data/lib/docusign_esign/models/{offline_attributes.rb → display_appliance_signer_attachment.rb} +65 -52
- data/lib/docusign_esign/models/dob_information_input.rb +11 -8
- data/lib/docusign_esign/models/document.rb +64 -19
- data/lib/docusign_esign/models/document_fields_information.rb +12 -8
- data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +12 -8
- data/lib/docusign_esign/models/document_html_definition.rb +12 -8
- data/lib/docusign_esign/models/document_html_definition_original.rb +12 -8
- data/lib/docusign_esign/models/document_html_definition_originals.rb +12 -8
- data/lib/docusign_esign/models/document_html_definitions.rb +12 -8
- data/lib/docusign_esign/models/document_html_display_anchor.rb +12 -8
- data/lib/docusign_esign/models/document_html_display_settings.rb +13 -19
- data/lib/docusign_esign/models/document_security_store.rb +11 -7
- data/lib/docusign_esign/models/document_template.rb +12 -8
- data/lib/docusign_esign/models/document_template_list.rb +12 -8
- data/lib/docusign_esign/models/document_update_info.rb +11 -7
- data/lib/docusign_esign/models/document_visibility.rb +12 -8
- data/lib/docusign_esign/models/document_visibility_list.rb +12 -8
- data/lib/docusign_esign/models/e_note_configuration.rb +12 -8
- data/lib/docusign_esign/models/editor.rb +208 -34
- data/lib/docusign_esign/models/email.rb +575 -14
- data/lib/docusign_esign/models/email_address.rb +475 -12
- data/lib/docusign_esign/models/email_settings.rb +11 -8
- data/lib/docusign_esign/models/envelope.rb +246 -19
- data/lib/docusign_esign/models/envelope_attachment.rb +12 -8
- data/lib/docusign_esign/models/envelope_attachments_request.rb +12 -8
- data/lib/docusign_esign/models/envelope_attachments_result.rb +12 -8
- data/lib/docusign_esign/models/envelope_audit_event.rb +12 -8
- data/lib/docusign_esign/models/envelope_audit_event_response.rb +12 -8
- data/lib/docusign_esign/models/envelope_definition.rb +258 -19
- data/lib/docusign_esign/models/envelope_document.rb +111 -18
- data/lib/docusign_esign/models/envelope_documents_result.rb +12 -8
- data/lib/docusign_esign/models/envelope_event.rb +12 -8
- data/lib/docusign_esign/models/envelope_form_data.rb +14 -19
- data/lib/docusign_esign/models/envelope_id.rb +466 -12
- data/lib/docusign_esign/models/envelope_ids_request.rb +12 -8
- data/lib/docusign_esign/models/envelope_metadata.rb +208 -0
- data/lib/docusign_esign/models/envelope_notification_request.rb +12 -8
- data/lib/docusign_esign/models/envelope_purge_configuration.rb +218 -0
- data/lib/docusign_esign/models/envelope_summary.rb +31 -9
- data/lib/docusign_esign/models/envelope_template.rb +461 -21
- data/lib/docusign_esign/models/envelope_template_definition.rb +10 -7
- data/lib/docusign_esign/models/envelope_template_result.rb +12 -28
- data/lib/docusign_esign/models/envelope_template_results.rb +13 -9
- data/lib/docusign_esign/models/envelope_transaction_status.rb +12 -8
- data/lib/docusign_esign/models/envelope_transfer_rule.rb +273 -0
- data/lib/docusign_esign/models/envelope_transfer_rule_information.rb +250 -0
- data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +279 -0
- data/lib/docusign_esign/models/envelope_update_summary.rb +23 -9
- data/lib/docusign_esign/models/envelopes_information.rb +25 -9
- data/lib/docusign_esign/models/error_details.rb +11 -8
- data/lib/docusign_esign/models/event_notification.rb +11 -8
- data/lib/docusign_esign/models/event_result.rb +12 -8
- data/lib/docusign_esign/models/expirations.rb +11 -8
- data/lib/docusign_esign/models/external_claim.rb +218 -0
- data/lib/docusign_esign/models/external_doc_service_error_details.rb +12 -8
- data/lib/docusign_esign/models/external_document_sources.rb +273 -0
- data/lib/docusign_esign/models/external_file.rb +12 -8
- data/lib/docusign_esign/models/external_folder.rb +12 -8
- data/lib/docusign_esign/models/favorite_templates_content_item.rb +207 -0
- data/lib/docusign_esign/models/favorite_templates_info.rb +209 -0
- data/lib/docusign_esign/models/feature_available_metadata.rb +198 -0
- data/lib/docusign_esign/models/feature_set.rb +12 -8
- data/lib/docusign_esign/models/file_type.rb +12 -8
- data/lib/docusign_esign/models/file_type_list.rb +12 -8
- data/lib/docusign_esign/models/filter.rb +12 -8
- data/lib/docusign_esign/models/first_name.rb +475 -12
- data/lib/docusign_esign/models/folder.rb +65 -30
- data/lib/docusign_esign/models/folder_item.rb +11 -7
- data/lib/docusign_esign/models/folder_item_response.rb +12 -8
- data/lib/docusign_esign/models/folder_item_v2.rb +36 -32
- data/lib/docusign_esign/models/folder_items_response.rb +33 -17
- data/lib/docusign_esign/models/folder_shared_item.rb +289 -0
- data/lib/docusign_esign/models/folders_request.rb +25 -9
- data/lib/docusign_esign/models/folders_response.rb +88 -12
- data/lib/docusign_esign/models/forgotten_password_information.rb +11 -8
- data/lib/docusign_esign/models/form_data_item.rb +227 -0
- data/lib/docusign_esign/models/formula_tab.rb +611 -14
- data/lib/docusign_esign/models/full_name.rb +475 -12
- data/lib/docusign_esign/models/graphics_context.rb +208 -0
- data/lib/docusign_esign/models/group.rb +26 -12
- data/lib/docusign_esign/models/group_information.rb +12 -8
- data/lib/docusign_esign/models/id_check_configuration.rb +210 -0
- data/lib/docusign_esign/models/id_check_information_input.rb +11 -8
- data/lib/docusign_esign/models/{payment_signer_values.rb → id_check_security_step.rb} +20 -16
- data/lib/docusign_esign/models/in_person_signer.rb +283 -24
- data/lib/docusign_esign/models/initial_here.rb +422 -13
- data/lib/docusign_esign/models/inline_template.rb +12 -8
- data/lib/docusign_esign/models/integrated_user_info_list.rb +12 -8
- data/lib/docusign_esign/models/intermediary.rb +208 -34
- data/lib/docusign_esign/models/jurisdiction.rb +12 -8
- data/lib/docusign_esign/models/last_name.rb +475 -12
- data/lib/docusign_esign/models/list.rb +530 -13
- data/lib/docusign_esign/models/list_custom_field.rb +12 -8
- data/lib/docusign_esign/models/list_item.rb +43 -12
- data/lib/docusign_esign/models/locale_policy.rb +595 -0
- data/lib/docusign_esign/models/locale_policy_tab.rb +298 -0
- data/lib/docusign_esign/models/lock_information.rb +12 -8
- data/lib/docusign_esign/models/lock_request.rb +12 -8
- data/lib/docusign_esign/models/login_account.rb +12 -8
- data/lib/docusign_esign/models/login_information.rb +12 -8
- data/lib/docusign_esign/models/match_box.rb +17 -13
- data/lib/docusign_esign/models/member_group_shared_item.rb +12 -8
- data/lib/docusign_esign/models/member_shared_items.rb +25 -9
- data/lib/docusign_esign/models/merge_field.rb +81 -12
- data/lib/docusign_esign/models/mobile_notifier_configuration.rb +12 -8
- data/lib/docusign_esign/models/mobile_notifier_configuration_information.rb +12 -8
- data/lib/docusign_esign/models/money.rb +12 -8
- data/lib/docusign_esign/models/name_value.rb +12 -8
- data/lib/docusign_esign/models/new_account_definition.rb +37 -17
- data/lib/docusign_esign/models/new_account_summary.rb +12 -8
- data/lib/docusign_esign/models/new_user.rb +13 -19
- data/lib/docusign_esign/models/new_users_definition.rb +12 -8
- data/lib/docusign_esign/models/new_users_summary.rb +12 -8
- data/lib/docusign_esign/models/notarize.rb +403 -12
- data/lib/docusign_esign/models/notary_host.rb +213 -24
- data/lib/docusign_esign/models/notary_journal.rb +12 -8
- data/lib/docusign_esign/models/notary_journal_credible_witness.rb +12 -8
- data/lib/docusign_esign/models/notary_journal_list.rb +12 -8
- data/lib/docusign_esign/models/notary_journal_meta_data.rb +12 -8
- data/lib/docusign_esign/models/note.rb +466 -14
- data/lib/docusign_esign/models/notification.rb +11 -8
- data/lib/docusign_esign/models/notification_default_settings.rb +196 -0
- data/lib/docusign_esign/models/notification_defaults.rb +196 -0
- data/lib/docusign_esign/models/number.rb +593 -14
- data/lib/docusign_esign/models/oauth_access.rb +12 -8
- data/lib/docusign_esign/models/page.rb +11 -8
- data/lib/docusign_esign/models/page_images.rb +12 -8
- data/lib/docusign_esign/models/page_request.rb +12 -8
- data/lib/docusign_esign/models/page_size.rb +198 -0
- data/lib/docusign_esign/models/{recipient_identity_input_option.rb → path_extended_element.rb} +26 -24
- data/lib/docusign_esign/models/pay_pal_legacy_settings.rb +228 -0
- data/lib/docusign_esign/models/payment_details.rb +31 -18
- data/lib/docusign_esign/models/payment_gateway_account.rb +110 -12
- data/lib/docusign_esign/models/payment_gateway_account_setting.rb +218 -0
- data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +12 -8
- data/lib/docusign_esign/models/payment_line_item.rb +12 -8
- data/lib/docusign_esign/models/payment_method_with_options.rb +200 -0
- data/lib/docusign_esign/models/payment_processor_information.rb +12 -8
- data/lib/docusign_esign/models/permission_profile.rb +12 -8
- data/lib/docusign_esign/models/permission_profile_information.rb +12 -8
- data/lib/docusign_esign/models/plan_information.rb +11 -8
- data/lib/docusign_esign/models/{recipient_identity_phone_number.rb → poly_line.rb} +42 -28
- data/lib/docusign_esign/models/poly_line_overlay.rb +885 -0
- data/lib/docusign_esign/models/power_form.rb +12 -8
- data/lib/docusign_esign/models/power_form_form_data_envelope.rb +12 -8
- data/lib/docusign_esign/models/power_form_form_data_recipient.rb +12 -8
- data/lib/docusign_esign/models/power_form_recipient.rb +12 -8
- data/lib/docusign_esign/models/power_form_senders_response.rb +16 -12
- data/lib/docusign_esign/models/power_forms_form_data_response.rb +12 -8
- data/lib/docusign_esign/models/power_forms_request.rb +12 -8
- data/lib/docusign_esign/models/power_forms_response.rb +16 -12
- data/lib/docusign_esign/models/property_metadata.rb +12 -8
- data/lib/docusign_esign/models/province.rb +12 -8
- data/lib/docusign_esign/models/provisioning_information.rb +12 -8
- data/lib/docusign_esign/models/purchased_envelopes_information.rb +12 -8
- data/lib/docusign_esign/models/radio.rb +321 -12
- data/lib/docusign_esign/models/radio_group.rb +153 -12
- data/lib/docusign_esign/models/recipient_attachment.rb +12 -8
- data/lib/docusign_esign/models/recipient_domain.rb +12 -8
- data/lib/docusign_esign/models/recipient_email_notification.rb +44 -13
- data/lib/docusign_esign/models/recipient_event.rb +12 -8
- data/lib/docusign_esign/models/recipient_form_data.rb +25 -21
- data/lib/docusign_esign/models/recipient_identity_verification.rb +13 -21
- data/lib/docusign_esign/models/recipient_names_response.rb +12 -8
- data/lib/docusign_esign/models/recipient_phone_authentication.rb +51 -12
- data/lib/docusign_esign/models/recipient_preview_request.rb +278 -0
- data/lib/docusign_esign/models/recipient_saml_authentication.rb +10 -7
- data/lib/docusign_esign/models/recipient_signature_information.rb +11 -8
- data/lib/docusign_esign/models/recipient_signature_provider.rb +22 -9
- data/lib/docusign_esign/models/recipient_signature_provider_options.rb +52 -12
- data/lib/docusign_esign/models/recipient_sms_authentication.rb +24 -12
- data/lib/docusign_esign/models/recipient_update_response.rb +33 -9
- data/lib/docusign_esign/models/recipient_view_request.rb +13 -33
- data/lib/docusign_esign/models/recipients.rb +11 -8
- data/lib/docusign_esign/models/recipients_update_summary.rb +12 -8
- data/lib/docusign_esign/models/referral_information.rb +11 -8
- data/lib/docusign_esign/models/reminders.rb +11 -8
- data/lib/docusign_esign/models/resource_information.rb +12 -8
- data/lib/docusign_esign/models/return_url_request.rb +12 -8
- data/lib/docusign_esign/models/revision.rb +11 -7
- data/lib/docusign_esign/models/saml_assertion_attribute.rb +11 -7
- data/lib/docusign_esign/models/seal.rb +13 -9
- data/lib/docusign_esign/models/seal_identifier.rb +12 -8
- data/lib/docusign_esign/models/seal_sign.rb +154 -24
- data/lib/docusign_esign/models/seat_discount.rb +12 -8
- data/lib/docusign_esign/models/sender.rb +11 -7
- data/lib/docusign_esign/models/sender_email_notifications.rb +19 -15
- data/lib/docusign_esign/models/server_template.rb +12 -8
- data/lib/docusign_esign/models/service_information.rb +12 -8
- data/lib/docusign_esign/models/service_version.rb +12 -8
- data/lib/docusign_esign/models/settings_metadata.rb +12 -8
- data/lib/docusign_esign/models/shared_item.rb +12 -8
- data/lib/docusign_esign/models/sign_hash_document.rb +11 -7
- data/lib/docusign_esign/models/sign_hash_session_info_response.rb +11 -7
- data/lib/docusign_esign/models/sign_here.rb +432 -13
- data/lib/docusign_esign/models/sign_session_info_request.rb +11 -7
- data/lib/docusign_esign/models/signature_data_info.rb +11 -7
- data/lib/docusign_esign/models/signature_properties.rb +198 -0
- data/lib/docusign_esign/models/signature_provider_required_option.rb +12 -8
- data/lib/docusign_esign/models/signature_type.rb +12 -8
- data/lib/docusign_esign/models/signer.rb +236 -34
- data/lib/docusign_esign/models/signer_attachment.rb +422 -13
- data/lib/docusign_esign/models/signer_email_notifications.rb +11 -8
- data/lib/docusign_esign/models/signing_group.rb +12 -8
- data/lib/docusign_esign/models/signing_group_information.rb +12 -8
- data/lib/docusign_esign/models/signing_group_user.rb +12 -8
- data/lib/docusign_esign/models/signing_group_users.rb +12 -8
- data/lib/docusign_esign/models/smart_section.rb +452 -12
- data/lib/docusign_esign/models/smart_section_anchor_position.rb +12 -8
- data/lib/docusign_esign/models/smart_section_collapsible_display_settings.rb +12 -8
- data/lib/docusign_esign/models/smart_section_display_settings.rb +13 -19
- data/lib/docusign_esign/models/social_account_information.rb +12 -8
- data/lib/docusign_esign/models/social_authentication.rb +12 -8
- data/lib/docusign_esign/models/ssn.rb +575 -14
- data/lib/docusign_esign/models/ssn4_information_input.rb +12 -8
- data/lib/docusign_esign/models/ssn9_information_input.rb +12 -8
- data/lib/docusign_esign/models/supported_languages.rb +12 -8
- data/lib/docusign_esign/models/tab_account_settings.rb +19 -15
- data/lib/docusign_esign/models/tab_group.rb +911 -0
- data/lib/docusign_esign/models/tab_metadata.rb +13 -39
- data/lib/docusign_esign/models/tab_metadata_list.rb +12 -8
- data/lib/docusign_esign/models/tabs.rb +50 -10
- data/lib/docusign_esign/models/template_custom_fields.rb +12 -8
- data/lib/docusign_esign/models/template_document_visibility_list.rb +12 -8
- data/lib/docusign_esign/models/template_documents_result.rb +12 -8
- data/lib/docusign_esign/models/template_information.rb +12 -8
- data/lib/docusign_esign/models/template_match.rb +12 -8
- data/lib/docusign_esign/models/template_notification_request.rb +12 -8
- data/lib/docusign_esign/models/template_recipients.rb +12 -8
- data/lib/docusign_esign/models/template_role.rb +12 -8
- data/lib/docusign_esign/models/template_shared_item.rb +23 -9
- data/lib/docusign_esign/models/template_summary.rb +22 -9
- data/lib/docusign_esign/models/template_tabs.rb +50 -10
- data/lib/docusign_esign/models/template_update_summary.rb +23 -9
- data/lib/docusign_esign/models/text.rb +584 -15
- data/lib/docusign_esign/models/text_custom_field.rb +12 -8
- data/lib/docusign_esign/models/time_stamp_field.rb +11 -7
- data/lib/docusign_esign/models/title.rb +521 -14
- data/lib/docusign_esign/models/tsp_health_check_request.rb +11 -7
- data/lib/docusign_esign/models/tsp_health_check_status_description.rb +11 -7
- data/lib/docusign_esign/models/update_transaction_request.rb +11 -7
- data/lib/docusign_esign/models/update_transaction_response.rb +11 -7
- data/lib/docusign_esign/models/usage_history.rb +13 -10
- data/lib/docusign_esign/models/user.rb +11 -7
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +14 -67
- data/lib/docusign_esign/models/user_info.rb +43 -9
- data/lib/docusign_esign/models/user_info_list.rb +12 -8
- data/lib/docusign_esign/models/user_info_response.rb +11 -7
- data/lib/docusign_esign/models/user_information.rb +69 -25
- data/lib/docusign_esign/models/user_information_list.rb +12 -8
- data/lib/docusign_esign/models/user_password_information.rb +12 -8
- data/lib/docusign_esign/models/user_password_rules.rb +12 -8
- data/lib/docusign_esign/models/user_profile.rb +13 -9
- data/lib/docusign_esign/models/user_settings_information.rb +1115 -17
- data/lib/docusign_esign/models/user_shared_item.rb +12 -8
- data/lib/docusign_esign/models/user_signature.rb +93 -9
- data/lib/docusign_esign/models/user_signature_definition.rb +115 -12
- data/lib/docusign_esign/models/user_signatures_information.rb +12 -8
- data/lib/docusign_esign/models/user_social_id_result.rb +12 -8
- data/lib/docusign_esign/models/users_response.rb +12 -8
- data/lib/docusign_esign/models/view.rb +457 -14
- data/lib/docusign_esign/models/view_url.rb +12 -8
- data/lib/docusign_esign/models/watermark.rb +12 -8
- data/lib/docusign_esign/models/witness.rb +236 -34
- data/lib/docusign_esign/models/workspace.rb +30 -9
- data/lib/docusign_esign/models/workspace_folder_contents.rb +11 -8
- data/lib/docusign_esign/models/workspace_item.rb +63 -12
- data/lib/docusign_esign/models/workspace_item_list.rb +11 -8
- data/lib/docusign_esign/models/workspace_list.rb +11 -8
- data/lib/docusign_esign/models/{recipient_proof_file.rb → workspace_settings.rb} +20 -16
- data/lib/docusign_esign/models/workspace_user.rb +45 -12
- data/lib/docusign_esign/models/workspace_user_authorization.rb +11 -8
- data/lib/docusign_esign/models/zip.rb +584 -14
- data/lib/docusign_esign/version.rb +1 -1
- data/lib/docusign_esign.rb +138 -60
- data/tests/.DS_Store +0 -0
- data/tests/Gemfile.lock +21 -21
- data/{lib/docusign_esign/api → tests/spec}/.DS_Store +0 -0
- data/tests/spec/unit_tests_using_jwt_spec.rb +2 -61
- metadata +102 -69
- data/docusign_esign-3.11.0.gem +0 -0
- data/lib/docusign_esign/.DS_Store +0 -0
- data/lib/docusign_esign/api/organizations_api.rb +0 -128
- data/lib/docusign_esign/api/signature_api.rb +0 -256
- data/lib/docusign_esign/api/tsps_api.rb +0 -256
- data/lib/docusign_esign/client/.DS_Store +0 -0
- data/tests/docs/private.pem +0 -27
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
|
5
5
|
|
6
|
-
OpenAPI spec version: v2
|
6
|
+
OpenAPI spec version: v2.1
|
7
7
|
Contact: devcenter@docusign.com
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
9
|
|
@@ -12,16 +12,22 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
|
15
16
|
class NotaryHost
|
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
|
+
attr_accessor :access_code_metadata
|
21
|
+
|
19
22
|
# 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.
|
20
23
|
attr_accessor :add_access_code_to_email
|
21
24
|
|
22
25
|
# Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters.
|
23
26
|
attr_accessor :client_user_id
|
24
27
|
|
28
|
+
#
|
29
|
+
attr_accessor :completed_count
|
30
|
+
|
25
31
|
# An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
|
26
32
|
attr_accessor :custom_fields
|
27
33
|
|
@@ -37,12 +43,16 @@ module DocuSign_eSign
|
|
37
43
|
# Reserved: For DocuSign use only.
|
38
44
|
attr_accessor :delivery_method
|
39
45
|
|
46
|
+
attr_accessor :delivery_method_metadata
|
47
|
+
|
40
48
|
#
|
41
49
|
attr_accessor :document_visibility
|
42
50
|
|
43
51
|
#
|
44
52
|
attr_accessor :email
|
45
53
|
|
54
|
+
attr_accessor :email_metadata
|
55
|
+
|
46
56
|
attr_accessor :email_notification
|
47
57
|
|
48
58
|
# 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]]`
|
@@ -53,25 +63,37 @@ module DocuSign_eSign
|
|
53
63
|
# Reserved:
|
54
64
|
attr_accessor :fax_number
|
55
65
|
|
66
|
+
attr_accessor :fax_number_metadata
|
67
|
+
|
56
68
|
#
|
57
69
|
attr_accessor :host_recipient_id
|
58
70
|
|
59
71
|
# 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.
|
60
72
|
attr_accessor :id_check_configuration_name
|
61
73
|
|
62
|
-
attr_accessor :
|
74
|
+
attr_accessor :id_check_configuration_name_metadata
|
63
75
|
|
64
|
-
attr_accessor :
|
76
|
+
attr_accessor :id_check_information_input
|
65
77
|
|
66
78
|
# 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.
|
67
79
|
attr_accessor :inherit_email_notification_configuration
|
68
80
|
|
81
|
+
#
|
82
|
+
attr_accessor :locked_recipient_phone_auth_editable
|
83
|
+
|
84
|
+
#
|
85
|
+
attr_accessor :locked_recipient_sms_editable
|
86
|
+
|
69
87
|
#
|
70
88
|
attr_accessor :name
|
71
89
|
|
90
|
+
attr_accessor :name_metadata
|
91
|
+
|
72
92
|
# 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.
|
73
93
|
attr_accessor :note
|
74
94
|
|
95
|
+
attr_accessor :note_metadata
|
96
|
+
|
75
97
|
attr_accessor :phone_authentication
|
76
98
|
|
77
99
|
# Reserved:
|
@@ -79,22 +101,32 @@ module DocuSign_eSign
|
|
79
101
|
|
80
102
|
attr_accessor :recipient_authentication_status
|
81
103
|
|
104
|
+
#
|
105
|
+
attr_accessor :recipient_feature_metadata
|
106
|
+
|
82
107
|
# Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
|
83
108
|
attr_accessor :recipient_id
|
84
109
|
|
85
110
|
#
|
86
111
|
attr_accessor :recipient_id_guid
|
87
112
|
|
113
|
+
#
|
114
|
+
attr_accessor :recipient_type
|
115
|
+
|
116
|
+
attr_accessor :recipient_type_metadata
|
117
|
+
|
88
118
|
# When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
|
89
119
|
attr_accessor :require_id_lookup
|
90
120
|
|
121
|
+
attr_accessor :require_id_lookup_metadata
|
122
|
+
|
91
123
|
# Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.
|
92
124
|
attr_accessor :role_name
|
93
125
|
|
94
126
|
# Specifies the routing order of the recipient in the envelope.
|
95
127
|
attr_accessor :routing_order
|
96
128
|
|
97
|
-
attr_accessor :
|
129
|
+
attr_accessor :routing_order_metadata
|
98
130
|
|
99
131
|
# The date and time the envelope was sent.
|
100
132
|
attr_accessor :sent_date_time
|
@@ -102,6 +134,17 @@ module DocuSign_eSign
|
|
102
134
|
# Reserved: For DocuSign use only.
|
103
135
|
attr_accessor :signed_date_time
|
104
136
|
|
137
|
+
# 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).
|
138
|
+
attr_accessor :signing_group_id
|
139
|
+
|
140
|
+
attr_accessor :signing_group_id_metadata
|
141
|
+
|
142
|
+
# The display name for the signing group. Maximum Length: 100 characters.
|
143
|
+
attr_accessor :signing_group_name
|
144
|
+
|
145
|
+
# A complex type that contains information about users in the signing group.
|
146
|
+
attr_accessor :signing_group_users
|
147
|
+
|
105
148
|
attr_accessor :sms_authentication
|
106
149
|
|
107
150
|
# Lists the social ID type that can be used for recipient authentication.
|
@@ -110,6 +153,12 @@ module DocuSign_eSign
|
|
110
153
|
# 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.
|
111
154
|
attr_accessor :status
|
112
155
|
|
156
|
+
#
|
157
|
+
attr_accessor :status_code
|
158
|
+
|
159
|
+
#
|
160
|
+
attr_accessor :suppress_emails
|
161
|
+
|
113
162
|
attr_accessor :tabs
|
114
163
|
|
115
164
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
@@ -124,44 +173,64 @@ module DocuSign_eSign
|
|
124
173
|
#
|
125
174
|
attr_accessor :user_id
|
126
175
|
|
176
|
+
|
127
177
|
# Attribute mapping from ruby-style variable name to JSON key.
|
128
178
|
def self.attribute_map
|
129
179
|
{
|
130
180
|
:'access_code' => :'accessCode',
|
181
|
+
:'access_code_metadata' => :'accessCodeMetadata',
|
131
182
|
:'add_access_code_to_email' => :'addAccessCodeToEmail',
|
132
183
|
:'client_user_id' => :'clientUserId',
|
184
|
+
:'completed_count' => :'completedCount',
|
133
185
|
:'custom_fields' => :'customFields',
|
134
186
|
:'declined_date_time' => :'declinedDateTime',
|
135
187
|
:'declined_reason' => :'declinedReason',
|
136
188
|
:'delivered_date_time' => :'deliveredDateTime',
|
137
189
|
:'delivery_method' => :'deliveryMethod',
|
190
|
+
:'delivery_method_metadata' => :'deliveryMethodMetadata',
|
138
191
|
:'document_visibility' => :'documentVisibility',
|
139
192
|
:'email' => :'email',
|
193
|
+
:'email_metadata' => :'emailMetadata',
|
140
194
|
:'email_notification' => :'emailNotification',
|
141
195
|
:'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
|
142
196
|
:'error_details' => :'errorDetails',
|
143
197
|
:'fax_number' => :'faxNumber',
|
198
|
+
:'fax_number_metadata' => :'faxNumberMetadata',
|
144
199
|
:'host_recipient_id' => :'hostRecipientId',
|
145
200
|
:'id_check_configuration_name' => :'idCheckConfigurationName',
|
201
|
+
:'id_check_configuration_name_metadata' => :'idCheckConfigurationNameMetadata',
|
146
202
|
:'id_check_information_input' => :'idCheckInformationInput',
|
147
|
-
:'identity_verification' => :'identityVerification',
|
148
203
|
:'inherit_email_notification_configuration' => :'inheritEmailNotificationConfiguration',
|
204
|
+
:'locked_recipient_phone_auth_editable' => :'lockedRecipientPhoneAuthEditable',
|
205
|
+
:'locked_recipient_sms_editable' => :'lockedRecipientSmsEditable',
|
149
206
|
:'name' => :'name',
|
207
|
+
:'name_metadata' => :'nameMetadata',
|
150
208
|
:'note' => :'note',
|
209
|
+
:'note_metadata' => :'noteMetadata',
|
151
210
|
:'phone_authentication' => :'phoneAuthentication',
|
152
211
|
:'recipient_attachments' => :'recipientAttachments',
|
153
212
|
:'recipient_authentication_status' => :'recipientAuthenticationStatus',
|
213
|
+
:'recipient_feature_metadata' => :'recipientFeatureMetadata',
|
154
214
|
:'recipient_id' => :'recipientId',
|
155
215
|
:'recipient_id_guid' => :'recipientIdGuid',
|
216
|
+
:'recipient_type' => :'recipientType',
|
217
|
+
:'recipient_type_metadata' => :'recipientTypeMetadata',
|
156
218
|
:'require_id_lookup' => :'requireIdLookup',
|
219
|
+
:'require_id_lookup_metadata' => :'requireIdLookupMetadata',
|
157
220
|
:'role_name' => :'roleName',
|
158
221
|
:'routing_order' => :'routingOrder',
|
159
|
-
:'
|
222
|
+
:'routing_order_metadata' => :'routingOrderMetadata',
|
160
223
|
:'sent_date_time' => :'sentDateTime',
|
161
224
|
:'signed_date_time' => :'signedDateTime',
|
225
|
+
:'signing_group_id' => :'signingGroupId',
|
226
|
+
:'signing_group_id_metadata' => :'signingGroupIdMetadata',
|
227
|
+
:'signing_group_name' => :'signingGroupName',
|
228
|
+
:'signing_group_users' => :'signingGroupUsers',
|
162
229
|
:'sms_authentication' => :'smsAuthentication',
|
163
230
|
:'social_authentications' => :'socialAuthentications',
|
164
231
|
:'status' => :'status',
|
232
|
+
:'status_code' => :'statusCode',
|
233
|
+
:'suppress_emails' => :'suppressEmails',
|
165
234
|
:'tabs' => :'tabs',
|
166
235
|
:'template_locked' => :'templateLocked',
|
167
236
|
:'template_required' => :'templateRequired',
|
@@ -174,40 +243,59 @@ module DocuSign_eSign
|
|
174
243
|
def self.swagger_types
|
175
244
|
{
|
176
245
|
:'access_code' => :'String',
|
246
|
+
:'access_code_metadata' => :'PropertyMetadata',
|
177
247
|
:'add_access_code_to_email' => :'String',
|
178
248
|
:'client_user_id' => :'String',
|
249
|
+
:'completed_count' => :'String',
|
179
250
|
:'custom_fields' => :'Array<String>',
|
180
251
|
:'declined_date_time' => :'String',
|
181
252
|
:'declined_reason' => :'String',
|
182
253
|
:'delivered_date_time' => :'String',
|
183
254
|
:'delivery_method' => :'String',
|
255
|
+
:'delivery_method_metadata' => :'PropertyMetadata',
|
184
256
|
:'document_visibility' => :'Array<DocumentVisibility>',
|
185
257
|
:'email' => :'String',
|
258
|
+
:'email_metadata' => :'PropertyMetadata',
|
186
259
|
:'email_notification' => :'RecipientEmailNotification',
|
187
260
|
:'embedded_recipient_start_url' => :'String',
|
188
261
|
:'error_details' => :'ErrorDetails',
|
189
262
|
:'fax_number' => :'String',
|
263
|
+
:'fax_number_metadata' => :'PropertyMetadata',
|
190
264
|
:'host_recipient_id' => :'String',
|
191
265
|
:'id_check_configuration_name' => :'String',
|
266
|
+
:'id_check_configuration_name_metadata' => :'PropertyMetadata',
|
192
267
|
:'id_check_information_input' => :'IdCheckInformationInput',
|
193
|
-
:'identity_verification' => :'RecipientIdentityVerification',
|
194
268
|
:'inherit_email_notification_configuration' => :'String',
|
269
|
+
:'locked_recipient_phone_auth_editable' => :'String',
|
270
|
+
:'locked_recipient_sms_editable' => :'String',
|
195
271
|
:'name' => :'String',
|
272
|
+
:'name_metadata' => :'PropertyMetadata',
|
196
273
|
:'note' => :'String',
|
274
|
+
:'note_metadata' => :'PropertyMetadata',
|
197
275
|
:'phone_authentication' => :'RecipientPhoneAuthentication',
|
198
276
|
:'recipient_attachments' => :'Array<RecipientAttachment>',
|
199
277
|
:'recipient_authentication_status' => :'AuthenticationStatus',
|
278
|
+
:'recipient_feature_metadata' => :'Array<FeatureAvailableMetadata>',
|
200
279
|
:'recipient_id' => :'String',
|
201
280
|
:'recipient_id_guid' => :'String',
|
281
|
+
:'recipient_type' => :'String',
|
282
|
+
:'recipient_type_metadata' => :'PropertyMetadata',
|
202
283
|
:'require_id_lookup' => :'String',
|
284
|
+
:'require_id_lookup_metadata' => :'PropertyMetadata',
|
203
285
|
:'role_name' => :'String',
|
204
286
|
:'routing_order' => :'String',
|
205
|
-
:'
|
287
|
+
:'routing_order_metadata' => :'PropertyMetadata',
|
206
288
|
:'sent_date_time' => :'String',
|
207
289
|
:'signed_date_time' => :'String',
|
290
|
+
:'signing_group_id' => :'String',
|
291
|
+
:'signing_group_id_metadata' => :'PropertyMetadata',
|
292
|
+
:'signing_group_name' => :'String',
|
293
|
+
:'signing_group_users' => :'Array<UserInfo>',
|
208
294
|
:'sms_authentication' => :'RecipientSMSAuthentication',
|
209
295
|
:'social_authentications' => :'Array<SocialAuthentication>',
|
210
296
|
:'status' => :'String',
|
297
|
+
:'status_code' => :'String',
|
298
|
+
:'suppress_emails' => :'String',
|
211
299
|
:'tabs' => :'Tabs',
|
212
300
|
:'template_locked' => :'String',
|
213
301
|
:'template_required' => :'String',
|
@@ -222,12 +310,16 @@ module DocuSign_eSign
|
|
222
310
|
return unless attributes.is_a?(Hash)
|
223
311
|
|
224
312
|
# convert string to symbol for hash key
|
225
|
-
attributes = attributes.each_with_object({})
|
313
|
+
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
226
314
|
|
227
315
|
if attributes.has_key?(:'accessCode')
|
228
316
|
self.access_code = attributes[:'accessCode']
|
229
317
|
end
|
230
318
|
|
319
|
+
if attributes.has_key?(:'accessCodeMetadata')
|
320
|
+
self.access_code_metadata = attributes[:'accessCodeMetadata']
|
321
|
+
end
|
322
|
+
|
231
323
|
if attributes.has_key?(:'addAccessCodeToEmail')
|
232
324
|
self.add_access_code_to_email = attributes[:'addAccessCodeToEmail']
|
233
325
|
end
|
@@ -236,6 +328,10 @@ module DocuSign_eSign
|
|
236
328
|
self.client_user_id = attributes[:'clientUserId']
|
237
329
|
end
|
238
330
|
|
331
|
+
if attributes.has_key?(:'completedCount')
|
332
|
+
self.completed_count = attributes[:'completedCount']
|
333
|
+
end
|
334
|
+
|
239
335
|
if attributes.has_key?(:'customFields')
|
240
336
|
if (value = attributes[:'customFields']).is_a?(Array)
|
241
337
|
self.custom_fields = value
|
@@ -258,6 +354,10 @@ module DocuSign_eSign
|
|
258
354
|
self.delivery_method = attributes[:'deliveryMethod']
|
259
355
|
end
|
260
356
|
|
357
|
+
if attributes.has_key?(:'deliveryMethodMetadata')
|
358
|
+
self.delivery_method_metadata = attributes[:'deliveryMethodMetadata']
|
359
|
+
end
|
360
|
+
|
261
361
|
if attributes.has_key?(:'documentVisibility')
|
262
362
|
if (value = attributes[:'documentVisibility']).is_a?(Array)
|
263
363
|
self.document_visibility = value
|
@@ -268,6 +368,10 @@ module DocuSign_eSign
|
|
268
368
|
self.email = attributes[:'email']
|
269
369
|
end
|
270
370
|
|
371
|
+
if attributes.has_key?(:'emailMetadata')
|
372
|
+
self.email_metadata = attributes[:'emailMetadata']
|
373
|
+
end
|
374
|
+
|
271
375
|
if attributes.has_key?(:'emailNotification')
|
272
376
|
self.email_notification = attributes[:'emailNotification']
|
273
377
|
end
|
@@ -284,6 +388,10 @@ module DocuSign_eSign
|
|
284
388
|
self.fax_number = attributes[:'faxNumber']
|
285
389
|
end
|
286
390
|
|
391
|
+
if attributes.has_key?(:'faxNumberMetadata')
|
392
|
+
self.fax_number_metadata = attributes[:'faxNumberMetadata']
|
393
|
+
end
|
394
|
+
|
287
395
|
if attributes.has_key?(:'hostRecipientId')
|
288
396
|
self.host_recipient_id = attributes[:'hostRecipientId']
|
289
397
|
end
|
@@ -292,26 +400,42 @@ module DocuSign_eSign
|
|
292
400
|
self.id_check_configuration_name = attributes[:'idCheckConfigurationName']
|
293
401
|
end
|
294
402
|
|
295
|
-
if attributes.has_key?(:'
|
296
|
-
self.
|
403
|
+
if attributes.has_key?(:'idCheckConfigurationNameMetadata')
|
404
|
+
self.id_check_configuration_name_metadata = attributes[:'idCheckConfigurationNameMetadata']
|
297
405
|
end
|
298
406
|
|
299
|
-
if attributes.has_key?(:'
|
300
|
-
self.
|
407
|
+
if attributes.has_key?(:'idCheckInformationInput')
|
408
|
+
self.id_check_information_input = attributes[:'idCheckInformationInput']
|
301
409
|
end
|
302
410
|
|
303
411
|
if attributes.has_key?(:'inheritEmailNotificationConfiguration')
|
304
412
|
self.inherit_email_notification_configuration = attributes[:'inheritEmailNotificationConfiguration']
|
305
413
|
end
|
306
414
|
|
415
|
+
if attributes.has_key?(:'lockedRecipientPhoneAuthEditable')
|
416
|
+
self.locked_recipient_phone_auth_editable = attributes[:'lockedRecipientPhoneAuthEditable']
|
417
|
+
end
|
418
|
+
|
419
|
+
if attributes.has_key?(:'lockedRecipientSmsEditable')
|
420
|
+
self.locked_recipient_sms_editable = attributes[:'lockedRecipientSmsEditable']
|
421
|
+
end
|
422
|
+
|
307
423
|
if attributes.has_key?(:'name')
|
308
424
|
self.name = attributes[:'name']
|
309
425
|
end
|
310
426
|
|
427
|
+
if attributes.has_key?(:'nameMetadata')
|
428
|
+
self.name_metadata = attributes[:'nameMetadata']
|
429
|
+
end
|
430
|
+
|
311
431
|
if attributes.has_key?(:'note')
|
312
432
|
self.note = attributes[:'note']
|
313
433
|
end
|
314
434
|
|
435
|
+
if attributes.has_key?(:'noteMetadata')
|
436
|
+
self.note_metadata = attributes[:'noteMetadata']
|
437
|
+
end
|
438
|
+
|
315
439
|
if attributes.has_key?(:'phoneAuthentication')
|
316
440
|
self.phone_authentication = attributes[:'phoneAuthentication']
|
317
441
|
end
|
@@ -326,6 +450,12 @@ module DocuSign_eSign
|
|
326
450
|
self.recipient_authentication_status = attributes[:'recipientAuthenticationStatus']
|
327
451
|
end
|
328
452
|
|
453
|
+
if attributes.has_key?(:'recipientFeatureMetadata')
|
454
|
+
if (value = attributes[:'recipientFeatureMetadata']).is_a?(Array)
|
455
|
+
self.recipient_feature_metadata = value
|
456
|
+
end
|
457
|
+
end
|
458
|
+
|
329
459
|
if attributes.has_key?(:'recipientId')
|
330
460
|
self.recipient_id = attributes[:'recipientId']
|
331
461
|
end
|
@@ -334,10 +464,22 @@ module DocuSign_eSign
|
|
334
464
|
self.recipient_id_guid = attributes[:'recipientIdGuid']
|
335
465
|
end
|
336
466
|
|
467
|
+
if attributes.has_key?(:'recipientType')
|
468
|
+
self.recipient_type = attributes[:'recipientType']
|
469
|
+
end
|
470
|
+
|
471
|
+
if attributes.has_key?(:'recipientTypeMetadata')
|
472
|
+
self.recipient_type_metadata = attributes[:'recipientTypeMetadata']
|
473
|
+
end
|
474
|
+
|
337
475
|
if attributes.has_key?(:'requireIdLookup')
|
338
476
|
self.require_id_lookup = attributes[:'requireIdLookup']
|
339
477
|
end
|
340
478
|
|
479
|
+
if attributes.has_key?(:'requireIdLookupMetadata')
|
480
|
+
self.require_id_lookup_metadata = attributes[:'requireIdLookupMetadata']
|
481
|
+
end
|
482
|
+
|
341
483
|
if attributes.has_key?(:'roleName')
|
342
484
|
self.role_name = attributes[:'roleName']
|
343
485
|
end
|
@@ -346,8 +488,8 @@ module DocuSign_eSign
|
|
346
488
|
self.routing_order = attributes[:'routingOrder']
|
347
489
|
end
|
348
490
|
|
349
|
-
if attributes.has_key?(:'
|
350
|
-
self.
|
491
|
+
if attributes.has_key?(:'routingOrderMetadata')
|
492
|
+
self.routing_order_metadata = attributes[:'routingOrderMetadata']
|
351
493
|
end
|
352
494
|
|
353
495
|
if attributes.has_key?(:'sentDateTime')
|
@@ -358,6 +500,24 @@ module DocuSign_eSign
|
|
358
500
|
self.signed_date_time = attributes[:'signedDateTime']
|
359
501
|
end
|
360
502
|
|
503
|
+
if attributes.has_key?(:'signingGroupId')
|
504
|
+
self.signing_group_id = attributes[:'signingGroupId']
|
505
|
+
end
|
506
|
+
|
507
|
+
if attributes.has_key?(:'signingGroupIdMetadata')
|
508
|
+
self.signing_group_id_metadata = attributes[:'signingGroupIdMetadata']
|
509
|
+
end
|
510
|
+
|
511
|
+
if attributes.has_key?(:'signingGroupName')
|
512
|
+
self.signing_group_name = attributes[:'signingGroupName']
|
513
|
+
end
|
514
|
+
|
515
|
+
if attributes.has_key?(:'signingGroupUsers')
|
516
|
+
if (value = attributes[:'signingGroupUsers']).is_a?(Array)
|
517
|
+
self.signing_group_users = value
|
518
|
+
end
|
519
|
+
end
|
520
|
+
|
361
521
|
if attributes.has_key?(:'smsAuthentication')
|
362
522
|
self.sms_authentication = attributes[:'smsAuthentication']
|
363
523
|
end
|
@@ -372,6 +532,14 @@ module DocuSign_eSign
|
|
372
532
|
self.status = attributes[:'status']
|
373
533
|
end
|
374
534
|
|
535
|
+
if attributes.has_key?(:'statusCode')
|
536
|
+
self.status_code = attributes[:'statusCode']
|
537
|
+
end
|
538
|
+
|
539
|
+
if attributes.has_key?(:'suppressEmails')
|
540
|
+
self.suppress_emails = attributes[:'suppressEmails']
|
541
|
+
end
|
542
|
+
|
375
543
|
if attributes.has_key?(:'tabs')
|
376
544
|
self.tabs = attributes[:'tabs']
|
377
545
|
end
|
@@ -391,19 +559,20 @@ module DocuSign_eSign
|
|
391
559
|
if attributes.has_key?(:'userId')
|
392
560
|
self.user_id = attributes[:'userId']
|
393
561
|
end
|
562
|
+
|
394
563
|
end
|
395
564
|
|
396
565
|
# Show invalid properties with the reasons. Usually used together with valid?
|
397
|
-
# @return Array for valid
|
566
|
+
# @return Array for valid properies with the reasons
|
398
567
|
def list_invalid_properties
|
399
568
|
invalid_properties = Array.new
|
400
|
-
invalid_properties
|
569
|
+
return invalid_properties
|
401
570
|
end
|
402
571
|
|
403
572
|
# Check to see if the all the properties in the model are valid
|
404
573
|
# @return true if the model is valid
|
405
574
|
def valid?
|
406
|
-
true
|
575
|
+
return true
|
407
576
|
end
|
408
577
|
|
409
578
|
# Checks equality by comparing each attribute.
|
@@ -412,40 +581,59 @@ module DocuSign_eSign
|
|
412
581
|
return true if self.equal?(o)
|
413
582
|
self.class == o.class &&
|
414
583
|
access_code == o.access_code &&
|
584
|
+
access_code_metadata == o.access_code_metadata &&
|
415
585
|
add_access_code_to_email == o.add_access_code_to_email &&
|
416
586
|
client_user_id == o.client_user_id &&
|
587
|
+
completed_count == o.completed_count &&
|
417
588
|
custom_fields == o.custom_fields &&
|
418
589
|
declined_date_time == o.declined_date_time &&
|
419
590
|
declined_reason == o.declined_reason &&
|
420
591
|
delivered_date_time == o.delivered_date_time &&
|
421
592
|
delivery_method == o.delivery_method &&
|
593
|
+
delivery_method_metadata == o.delivery_method_metadata &&
|
422
594
|
document_visibility == o.document_visibility &&
|
423
595
|
email == o.email &&
|
596
|
+
email_metadata == o.email_metadata &&
|
424
597
|
email_notification == o.email_notification &&
|
425
598
|
embedded_recipient_start_url == o.embedded_recipient_start_url &&
|
426
599
|
error_details == o.error_details &&
|
427
600
|
fax_number == o.fax_number &&
|
601
|
+
fax_number_metadata == o.fax_number_metadata &&
|
428
602
|
host_recipient_id == o.host_recipient_id &&
|
429
603
|
id_check_configuration_name == o.id_check_configuration_name &&
|
604
|
+
id_check_configuration_name_metadata == o.id_check_configuration_name_metadata &&
|
430
605
|
id_check_information_input == o.id_check_information_input &&
|
431
|
-
identity_verification == o.identity_verification &&
|
432
606
|
inherit_email_notification_configuration == o.inherit_email_notification_configuration &&
|
607
|
+
locked_recipient_phone_auth_editable == o.locked_recipient_phone_auth_editable &&
|
608
|
+
locked_recipient_sms_editable == o.locked_recipient_sms_editable &&
|
433
609
|
name == o.name &&
|
610
|
+
name_metadata == o.name_metadata &&
|
434
611
|
note == o.note &&
|
612
|
+
note_metadata == o.note_metadata &&
|
435
613
|
phone_authentication == o.phone_authentication &&
|
436
614
|
recipient_attachments == o.recipient_attachments &&
|
437
615
|
recipient_authentication_status == o.recipient_authentication_status &&
|
616
|
+
recipient_feature_metadata == o.recipient_feature_metadata &&
|
438
617
|
recipient_id == o.recipient_id &&
|
439
618
|
recipient_id_guid == o.recipient_id_guid &&
|
619
|
+
recipient_type == o.recipient_type &&
|
620
|
+
recipient_type_metadata == o.recipient_type_metadata &&
|
440
621
|
require_id_lookup == o.require_id_lookup &&
|
622
|
+
require_id_lookup_metadata == o.require_id_lookup_metadata &&
|
441
623
|
role_name == o.role_name &&
|
442
624
|
routing_order == o.routing_order &&
|
443
|
-
|
625
|
+
routing_order_metadata == o.routing_order_metadata &&
|
444
626
|
sent_date_time == o.sent_date_time &&
|
445
627
|
signed_date_time == o.signed_date_time &&
|
628
|
+
signing_group_id == o.signing_group_id &&
|
629
|
+
signing_group_id_metadata == o.signing_group_id_metadata &&
|
630
|
+
signing_group_name == o.signing_group_name &&
|
631
|
+
signing_group_users == o.signing_group_users &&
|
446
632
|
sms_authentication == o.sms_authentication &&
|
447
633
|
social_authentications == o.social_authentications &&
|
448
634
|
status == o.status &&
|
635
|
+
status_code == o.status_code &&
|
636
|
+
suppress_emails == o.suppress_emails &&
|
449
637
|
tabs == o.tabs &&
|
450
638
|
template_locked == o.template_locked &&
|
451
639
|
template_required == o.template_required &&
|
@@ -462,7 +650,7 @@ module DocuSign_eSign
|
|
462
650
|
# Calculates hash code according to all attributes.
|
463
651
|
# @return [Fixnum] Hash code
|
464
652
|
def hash
|
465
|
-
[access_code, add_access_code_to_email, client_user_id, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, document_visibility, email, email_notification, embedded_recipient_start_url, error_details, fax_number, host_recipient_id, id_check_configuration_name,
|
653
|
+
[access_code, access_code_metadata, add_access_code_to_email, client_user_id, completed_count, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, delivery_method_metadata, document_visibility, email, email_metadata, email_notification, embedded_recipient_start_url, error_details, fax_number, fax_number_metadata, host_recipient_id, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, inherit_email_notification_configuration, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, 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
|
466
654
|
end
|
467
655
|
|
468
656
|
# Builds the object from hash
|
@@ -472,10 +660,10 @@ module DocuSign_eSign
|
|
472
660
|
return nil unless attributes.is_a?(Hash)
|
473
661
|
self.class.swagger_types.each_pair do |key, type|
|
474
662
|
if type =~ /\AArray<(.*)>/i
|
475
|
-
# check to ensure the input is an array given that the attribute
|
663
|
+
# check to ensure the input is an array given that the the attribute
|
476
664
|
# is documented as an array but the input is not
|
477
665
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
478
|
-
self.send("#{key}=", attributes[self.class.attribute_map[key]].map
|
666
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
|
479
667
|
end
|
480
668
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
481
669
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
@@ -557,7 +745,7 @@ module DocuSign_eSign
|
|
557
745
|
# @return [Hash] Returns the value in the form of hash
|
558
746
|
def _to_hash(value)
|
559
747
|
if value.is_a?(Array)
|
560
|
-
value.compact.map
|
748
|
+
value.compact.map{ |v| _to_hash(v) }
|
561
749
|
elsif value.is_a?(Hash)
|
562
750
|
{}.tap do |hash|
|
563
751
|
value.each { |k, v| hash[k] = _to_hash(v) }
|
@@ -570,4 +758,5 @@ module DocuSign_eSign
|
|
570
758
|
end
|
571
759
|
|
572
760
|
end
|
761
|
+
|
573
762
|
end
|