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,10 +12,13 @@ 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 CertifiedDelivery
|
16
17
|
# If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
|
17
18
|
attr_accessor :access_code
|
18
19
|
|
20
|
+
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
|
|
@@ -28,6 +31,9 @@ module DocuSign_eSign
|
|
28
31
|
# 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.
|
29
32
|
attr_accessor :client_user_id
|
30
33
|
|
34
|
+
#
|
35
|
+
attr_accessor :completed_count
|
36
|
+
|
31
37
|
# 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.
|
32
38
|
attr_accessor :custom_fields
|
33
39
|
|
@@ -43,16 +49,17 @@ module DocuSign_eSign
|
|
43
49
|
# Reserved: For DocuSign use only.
|
44
50
|
attr_accessor :delivery_method
|
45
51
|
|
52
|
+
attr_accessor :delivery_method_metadata
|
53
|
+
|
46
54
|
#
|
47
55
|
attr_accessor :document_visibility
|
48
56
|
|
49
57
|
#
|
50
58
|
attr_accessor :email
|
51
59
|
|
52
|
-
attr_accessor :
|
60
|
+
attr_accessor :email_metadata
|
53
61
|
|
54
|
-
|
55
|
-
attr_accessor :email_recipient_post_signing_url
|
62
|
+
attr_accessor :email_notification
|
56
63
|
|
57
64
|
# 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]]`
|
58
65
|
attr_accessor :embedded_recipient_start_url
|
@@ -65,18 +72,24 @@ module DocuSign_eSign
|
|
65
72
|
# Reserved:
|
66
73
|
attr_accessor :fax_number
|
67
74
|
|
75
|
+
attr_accessor :fax_number_metadata
|
76
|
+
|
68
77
|
# The user's first name. Maximum Length: 50 characters.
|
69
78
|
attr_accessor :first_name
|
70
79
|
|
80
|
+
attr_accessor :first_name_metadata
|
81
|
+
|
71
82
|
#
|
72
83
|
attr_accessor :full_name
|
73
84
|
|
85
|
+
attr_accessor :full_name_metadata
|
86
|
+
|
74
87
|
# 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.
|
75
88
|
attr_accessor :id_check_configuration_name
|
76
89
|
|
77
|
-
attr_accessor :
|
90
|
+
attr_accessor :id_check_configuration_name_metadata
|
78
91
|
|
79
|
-
attr_accessor :
|
92
|
+
attr_accessor :id_check_information_input
|
80
93
|
|
81
94
|
# 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.
|
82
95
|
attr_accessor :inherit_email_notification_configuration
|
@@ -84,37 +97,57 @@ module DocuSign_eSign
|
|
84
97
|
#
|
85
98
|
attr_accessor :last_name
|
86
99
|
|
100
|
+
attr_accessor :last_name_metadata
|
101
|
+
|
102
|
+
#
|
103
|
+
attr_accessor :locked_recipient_phone_auth_editable
|
104
|
+
|
105
|
+
#
|
106
|
+
attr_accessor :locked_recipient_sms_editable
|
107
|
+
|
87
108
|
#
|
88
109
|
attr_accessor :name
|
89
110
|
|
111
|
+
attr_accessor :name_metadata
|
112
|
+
|
90
113
|
# 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.
|
91
114
|
attr_accessor :note
|
92
115
|
|
93
|
-
attr_accessor :
|
116
|
+
attr_accessor :note_metadata
|
94
117
|
|
95
|
-
attr_accessor :
|
118
|
+
attr_accessor :phone_authentication
|
96
119
|
|
97
120
|
# Reserved:
|
98
121
|
attr_accessor :recipient_attachments
|
99
122
|
|
100
123
|
attr_accessor :recipient_authentication_status
|
101
124
|
|
125
|
+
#
|
126
|
+
attr_accessor :recipient_feature_metadata
|
127
|
+
|
102
128
|
# Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
|
103
129
|
attr_accessor :recipient_id
|
104
130
|
|
105
131
|
#
|
106
132
|
attr_accessor :recipient_id_guid
|
107
133
|
|
134
|
+
#
|
135
|
+
attr_accessor :recipient_type
|
136
|
+
|
137
|
+
attr_accessor :recipient_type_metadata
|
138
|
+
|
108
139
|
# When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
|
109
140
|
attr_accessor :require_id_lookup
|
110
141
|
|
142
|
+
attr_accessor :require_id_lookup_metadata
|
143
|
+
|
111
144
|
# Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.
|
112
145
|
attr_accessor :role_name
|
113
146
|
|
114
147
|
# Specifies the routing order of the recipient in the envelope.
|
115
148
|
attr_accessor :routing_order
|
116
149
|
|
117
|
-
attr_accessor :
|
150
|
+
attr_accessor :routing_order_metadata
|
118
151
|
|
119
152
|
# The date and time the envelope was sent.
|
120
153
|
attr_accessor :sent_date_time
|
@@ -125,6 +158,8 @@ module DocuSign_eSign
|
|
125
158
|
# 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).
|
126
159
|
attr_accessor :signing_group_id
|
127
160
|
|
161
|
+
attr_accessor :signing_group_id_metadata
|
162
|
+
|
128
163
|
# The display name for the signing group. Maximum Length: 100 characters.
|
129
164
|
attr_accessor :signing_group_name
|
130
165
|
|
@@ -139,6 +174,12 @@ module DocuSign_eSign
|
|
139
174
|
# 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.
|
140
175
|
attr_accessor :status
|
141
176
|
|
177
|
+
#
|
178
|
+
attr_accessor :status_code
|
179
|
+
|
180
|
+
#
|
181
|
+
attr_accessor :suppress_emails
|
182
|
+
|
142
183
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
143
184
|
attr_accessor :template_locked
|
144
185
|
|
@@ -151,54 +192,72 @@ module DocuSign_eSign
|
|
151
192
|
#
|
152
193
|
attr_accessor :user_id
|
153
194
|
|
195
|
+
|
154
196
|
# Attribute mapping from ruby-style variable name to JSON key.
|
155
197
|
def self.attribute_map
|
156
198
|
{
|
157
199
|
:'access_code' => :'accessCode',
|
200
|
+
:'access_code_metadata' => :'accessCodeMetadata',
|
158
201
|
:'add_access_code_to_email' => :'addAccessCodeToEmail',
|
159
202
|
:'agent_can_edit_email' => :'agentCanEditEmail',
|
160
203
|
:'agent_can_edit_name' => :'agentCanEditName',
|
161
204
|
:'client_user_id' => :'clientUserId',
|
205
|
+
:'completed_count' => :'completedCount',
|
162
206
|
:'custom_fields' => :'customFields',
|
163
207
|
:'declined_date_time' => :'declinedDateTime',
|
164
208
|
:'declined_reason' => :'declinedReason',
|
165
209
|
:'delivered_date_time' => :'deliveredDateTime',
|
166
210
|
:'delivery_method' => :'deliveryMethod',
|
211
|
+
:'delivery_method_metadata' => :'deliveryMethodMetadata',
|
167
212
|
:'document_visibility' => :'documentVisibility',
|
168
213
|
:'email' => :'email',
|
214
|
+
:'email_metadata' => :'emailMetadata',
|
169
215
|
:'email_notification' => :'emailNotification',
|
170
|
-
:'email_recipient_post_signing_url' => :'emailRecipientPostSigningURL',
|
171
216
|
:'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
|
172
217
|
:'error_details' => :'errorDetails',
|
173
218
|
:'excluded_documents' => :'excludedDocuments',
|
174
219
|
:'fax_number' => :'faxNumber',
|
220
|
+
:'fax_number_metadata' => :'faxNumberMetadata',
|
175
221
|
:'first_name' => :'firstName',
|
222
|
+
:'first_name_metadata' => :'firstNameMetadata',
|
176
223
|
:'full_name' => :'fullName',
|
224
|
+
:'full_name_metadata' => :'fullNameMetadata',
|
177
225
|
:'id_check_configuration_name' => :'idCheckConfigurationName',
|
226
|
+
:'id_check_configuration_name_metadata' => :'idCheckConfigurationNameMetadata',
|
178
227
|
:'id_check_information_input' => :'idCheckInformationInput',
|
179
|
-
:'identity_verification' => :'identityVerification',
|
180
228
|
:'inherit_email_notification_configuration' => :'inheritEmailNotificationConfiguration',
|
181
229
|
:'last_name' => :'lastName',
|
230
|
+
:'last_name_metadata' => :'lastNameMetadata',
|
231
|
+
:'locked_recipient_phone_auth_editable' => :'lockedRecipientPhoneAuthEditable',
|
232
|
+
:'locked_recipient_sms_editable' => :'lockedRecipientSmsEditable',
|
182
233
|
:'name' => :'name',
|
234
|
+
:'name_metadata' => :'nameMetadata',
|
183
235
|
:'note' => :'note',
|
236
|
+
:'note_metadata' => :'noteMetadata',
|
184
237
|
:'phone_authentication' => :'phoneAuthentication',
|
185
|
-
:'proof_file' => :'proofFile',
|
186
238
|
:'recipient_attachments' => :'recipientAttachments',
|
187
239
|
:'recipient_authentication_status' => :'recipientAuthenticationStatus',
|
240
|
+
:'recipient_feature_metadata' => :'recipientFeatureMetadata',
|
188
241
|
:'recipient_id' => :'recipientId',
|
189
242
|
:'recipient_id_guid' => :'recipientIdGuid',
|
243
|
+
:'recipient_type' => :'recipientType',
|
244
|
+
:'recipient_type_metadata' => :'recipientTypeMetadata',
|
190
245
|
:'require_id_lookup' => :'requireIdLookup',
|
246
|
+
:'require_id_lookup_metadata' => :'requireIdLookupMetadata',
|
191
247
|
:'role_name' => :'roleName',
|
192
248
|
:'routing_order' => :'routingOrder',
|
193
|
-
:'
|
249
|
+
:'routing_order_metadata' => :'routingOrderMetadata',
|
194
250
|
:'sent_date_time' => :'sentDateTime',
|
195
251
|
:'signed_date_time' => :'signedDateTime',
|
196
252
|
:'signing_group_id' => :'signingGroupId',
|
253
|
+
:'signing_group_id_metadata' => :'signingGroupIdMetadata',
|
197
254
|
:'signing_group_name' => :'signingGroupName',
|
198
255
|
:'signing_group_users' => :'signingGroupUsers',
|
199
256
|
:'sms_authentication' => :'smsAuthentication',
|
200
257
|
:'social_authentications' => :'socialAuthentications',
|
201
258
|
:'status' => :'status',
|
259
|
+
:'status_code' => :'statusCode',
|
260
|
+
:'suppress_emails' => :'suppressEmails',
|
202
261
|
:'template_locked' => :'templateLocked',
|
203
262
|
:'template_required' => :'templateRequired',
|
204
263
|
:'total_tab_count' => :'totalTabCount',
|
@@ -210,50 +269,67 @@ module DocuSign_eSign
|
|
210
269
|
def self.swagger_types
|
211
270
|
{
|
212
271
|
:'access_code' => :'String',
|
272
|
+
:'access_code_metadata' => :'PropertyMetadata',
|
213
273
|
:'add_access_code_to_email' => :'String',
|
214
274
|
:'agent_can_edit_email' => :'String',
|
215
275
|
:'agent_can_edit_name' => :'String',
|
216
276
|
:'client_user_id' => :'String',
|
277
|
+
:'completed_count' => :'String',
|
217
278
|
:'custom_fields' => :'Array<String>',
|
218
279
|
:'declined_date_time' => :'String',
|
219
280
|
:'declined_reason' => :'String',
|
220
281
|
:'delivered_date_time' => :'String',
|
221
282
|
:'delivery_method' => :'String',
|
283
|
+
:'delivery_method_metadata' => :'PropertyMetadata',
|
222
284
|
:'document_visibility' => :'Array<DocumentVisibility>',
|
223
285
|
:'email' => :'String',
|
286
|
+
:'email_metadata' => :'PropertyMetadata',
|
224
287
|
:'email_notification' => :'RecipientEmailNotification',
|
225
|
-
:'email_recipient_post_signing_url' => :'String',
|
226
288
|
:'embedded_recipient_start_url' => :'String',
|
227
289
|
:'error_details' => :'ErrorDetails',
|
228
290
|
:'excluded_documents' => :'Array<String>',
|
229
291
|
:'fax_number' => :'String',
|
292
|
+
:'fax_number_metadata' => :'PropertyMetadata',
|
230
293
|
:'first_name' => :'String',
|
294
|
+
:'first_name_metadata' => :'PropertyMetadata',
|
231
295
|
:'full_name' => :'String',
|
296
|
+
:'full_name_metadata' => :'PropertyMetadata',
|
232
297
|
:'id_check_configuration_name' => :'String',
|
298
|
+
:'id_check_configuration_name_metadata' => :'PropertyMetadata',
|
233
299
|
:'id_check_information_input' => :'IdCheckInformationInput',
|
234
|
-
:'identity_verification' => :'RecipientIdentityVerification',
|
235
300
|
:'inherit_email_notification_configuration' => :'String',
|
236
301
|
:'last_name' => :'String',
|
302
|
+
:'last_name_metadata' => :'PropertyMetadata',
|
303
|
+
:'locked_recipient_phone_auth_editable' => :'String',
|
304
|
+
:'locked_recipient_sms_editable' => :'String',
|
237
305
|
:'name' => :'String',
|
306
|
+
:'name_metadata' => :'PropertyMetadata',
|
238
307
|
:'note' => :'String',
|
308
|
+
:'note_metadata' => :'PropertyMetadata',
|
239
309
|
:'phone_authentication' => :'RecipientPhoneAuthentication',
|
240
|
-
:'proof_file' => :'RecipientProofFile',
|
241
310
|
:'recipient_attachments' => :'Array<RecipientAttachment>',
|
242
311
|
:'recipient_authentication_status' => :'AuthenticationStatus',
|
312
|
+
:'recipient_feature_metadata' => :'Array<FeatureAvailableMetadata>',
|
243
313
|
:'recipient_id' => :'String',
|
244
314
|
:'recipient_id_guid' => :'String',
|
315
|
+
:'recipient_type' => :'String',
|
316
|
+
:'recipient_type_metadata' => :'PropertyMetadata',
|
245
317
|
:'require_id_lookup' => :'String',
|
318
|
+
:'require_id_lookup_metadata' => :'PropertyMetadata',
|
246
319
|
:'role_name' => :'String',
|
247
320
|
:'routing_order' => :'String',
|
248
|
-
:'
|
321
|
+
:'routing_order_metadata' => :'PropertyMetadata',
|
249
322
|
:'sent_date_time' => :'String',
|
250
323
|
:'signed_date_time' => :'String',
|
251
324
|
:'signing_group_id' => :'String',
|
325
|
+
:'signing_group_id_metadata' => :'PropertyMetadata',
|
252
326
|
:'signing_group_name' => :'String',
|
253
327
|
:'signing_group_users' => :'Array<UserInfo>',
|
254
328
|
:'sms_authentication' => :'RecipientSMSAuthentication',
|
255
329
|
:'social_authentications' => :'Array<SocialAuthentication>',
|
256
330
|
:'status' => :'String',
|
331
|
+
:'status_code' => :'String',
|
332
|
+
:'suppress_emails' => :'String',
|
257
333
|
:'template_locked' => :'String',
|
258
334
|
:'template_required' => :'String',
|
259
335
|
:'total_tab_count' => :'String',
|
@@ -267,12 +343,16 @@ module DocuSign_eSign
|
|
267
343
|
return unless attributes.is_a?(Hash)
|
268
344
|
|
269
345
|
# convert string to symbol for hash key
|
270
|
-
attributes = attributes.each_with_object({})
|
346
|
+
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
271
347
|
|
272
348
|
if attributes.has_key?(:'accessCode')
|
273
349
|
self.access_code = attributes[:'accessCode']
|
274
350
|
end
|
275
351
|
|
352
|
+
if attributes.has_key?(:'accessCodeMetadata')
|
353
|
+
self.access_code_metadata = attributes[:'accessCodeMetadata']
|
354
|
+
end
|
355
|
+
|
276
356
|
if attributes.has_key?(:'addAccessCodeToEmail')
|
277
357
|
self.add_access_code_to_email = attributes[:'addAccessCodeToEmail']
|
278
358
|
end
|
@@ -289,6 +369,10 @@ module DocuSign_eSign
|
|
289
369
|
self.client_user_id = attributes[:'clientUserId']
|
290
370
|
end
|
291
371
|
|
372
|
+
if attributes.has_key?(:'completedCount')
|
373
|
+
self.completed_count = attributes[:'completedCount']
|
374
|
+
end
|
375
|
+
|
292
376
|
if attributes.has_key?(:'customFields')
|
293
377
|
if (value = attributes[:'customFields']).is_a?(Array)
|
294
378
|
self.custom_fields = value
|
@@ -311,6 +395,10 @@ module DocuSign_eSign
|
|
311
395
|
self.delivery_method = attributes[:'deliveryMethod']
|
312
396
|
end
|
313
397
|
|
398
|
+
if attributes.has_key?(:'deliveryMethodMetadata')
|
399
|
+
self.delivery_method_metadata = attributes[:'deliveryMethodMetadata']
|
400
|
+
end
|
401
|
+
|
314
402
|
if attributes.has_key?(:'documentVisibility')
|
315
403
|
if (value = attributes[:'documentVisibility']).is_a?(Array)
|
316
404
|
self.document_visibility = value
|
@@ -321,12 +409,12 @@ module DocuSign_eSign
|
|
321
409
|
self.email = attributes[:'email']
|
322
410
|
end
|
323
411
|
|
324
|
-
if attributes.has_key?(:'
|
325
|
-
self.
|
412
|
+
if attributes.has_key?(:'emailMetadata')
|
413
|
+
self.email_metadata = attributes[:'emailMetadata']
|
326
414
|
end
|
327
415
|
|
328
|
-
if attributes.has_key?(:'
|
329
|
-
self.
|
416
|
+
if attributes.has_key?(:'emailNotification')
|
417
|
+
self.email_notification = attributes[:'emailNotification']
|
330
418
|
end
|
331
419
|
|
332
420
|
if attributes.has_key?(:'embeddedRecipientStartURL')
|
@@ -347,24 +435,36 @@ module DocuSign_eSign
|
|
347
435
|
self.fax_number = attributes[:'faxNumber']
|
348
436
|
end
|
349
437
|
|
438
|
+
if attributes.has_key?(:'faxNumberMetadata')
|
439
|
+
self.fax_number_metadata = attributes[:'faxNumberMetadata']
|
440
|
+
end
|
441
|
+
|
350
442
|
if attributes.has_key?(:'firstName')
|
351
443
|
self.first_name = attributes[:'firstName']
|
352
444
|
end
|
353
445
|
|
446
|
+
if attributes.has_key?(:'firstNameMetadata')
|
447
|
+
self.first_name_metadata = attributes[:'firstNameMetadata']
|
448
|
+
end
|
449
|
+
|
354
450
|
if attributes.has_key?(:'fullName')
|
355
451
|
self.full_name = attributes[:'fullName']
|
356
452
|
end
|
357
453
|
|
454
|
+
if attributes.has_key?(:'fullNameMetadata')
|
455
|
+
self.full_name_metadata = attributes[:'fullNameMetadata']
|
456
|
+
end
|
457
|
+
|
358
458
|
if attributes.has_key?(:'idCheckConfigurationName')
|
359
459
|
self.id_check_configuration_name = attributes[:'idCheckConfigurationName']
|
360
460
|
end
|
361
461
|
|
362
|
-
if attributes.has_key?(:'
|
363
|
-
self.
|
462
|
+
if attributes.has_key?(:'idCheckConfigurationNameMetadata')
|
463
|
+
self.id_check_configuration_name_metadata = attributes[:'idCheckConfigurationNameMetadata']
|
364
464
|
end
|
365
465
|
|
366
|
-
if attributes.has_key?(:'
|
367
|
-
self.
|
466
|
+
if attributes.has_key?(:'idCheckInformationInput')
|
467
|
+
self.id_check_information_input = attributes[:'idCheckInformationInput']
|
368
468
|
end
|
369
469
|
|
370
470
|
if attributes.has_key?(:'inheritEmailNotificationConfiguration')
|
@@ -375,20 +475,36 @@ module DocuSign_eSign
|
|
375
475
|
self.last_name = attributes[:'lastName']
|
376
476
|
end
|
377
477
|
|
478
|
+
if attributes.has_key?(:'lastNameMetadata')
|
479
|
+
self.last_name_metadata = attributes[:'lastNameMetadata']
|
480
|
+
end
|
481
|
+
|
482
|
+
if attributes.has_key?(:'lockedRecipientPhoneAuthEditable')
|
483
|
+
self.locked_recipient_phone_auth_editable = attributes[:'lockedRecipientPhoneAuthEditable']
|
484
|
+
end
|
485
|
+
|
486
|
+
if attributes.has_key?(:'lockedRecipientSmsEditable')
|
487
|
+
self.locked_recipient_sms_editable = attributes[:'lockedRecipientSmsEditable']
|
488
|
+
end
|
489
|
+
|
378
490
|
if attributes.has_key?(:'name')
|
379
491
|
self.name = attributes[:'name']
|
380
492
|
end
|
381
493
|
|
494
|
+
if attributes.has_key?(:'nameMetadata')
|
495
|
+
self.name_metadata = attributes[:'nameMetadata']
|
496
|
+
end
|
497
|
+
|
382
498
|
if attributes.has_key?(:'note')
|
383
499
|
self.note = attributes[:'note']
|
384
500
|
end
|
385
501
|
|
386
|
-
if attributes.has_key?(:'
|
387
|
-
self.
|
502
|
+
if attributes.has_key?(:'noteMetadata')
|
503
|
+
self.note_metadata = attributes[:'noteMetadata']
|
388
504
|
end
|
389
505
|
|
390
|
-
if attributes.has_key?(:'
|
391
|
-
self.
|
506
|
+
if attributes.has_key?(:'phoneAuthentication')
|
507
|
+
self.phone_authentication = attributes[:'phoneAuthentication']
|
392
508
|
end
|
393
509
|
|
394
510
|
if attributes.has_key?(:'recipientAttachments')
|
@@ -401,6 +517,12 @@ module DocuSign_eSign
|
|
401
517
|
self.recipient_authentication_status = attributes[:'recipientAuthenticationStatus']
|
402
518
|
end
|
403
519
|
|
520
|
+
if attributes.has_key?(:'recipientFeatureMetadata')
|
521
|
+
if (value = attributes[:'recipientFeatureMetadata']).is_a?(Array)
|
522
|
+
self.recipient_feature_metadata = value
|
523
|
+
end
|
524
|
+
end
|
525
|
+
|
404
526
|
if attributes.has_key?(:'recipientId')
|
405
527
|
self.recipient_id = attributes[:'recipientId']
|
406
528
|
end
|
@@ -409,10 +531,22 @@ module DocuSign_eSign
|
|
409
531
|
self.recipient_id_guid = attributes[:'recipientIdGuid']
|
410
532
|
end
|
411
533
|
|
534
|
+
if attributes.has_key?(:'recipientType')
|
535
|
+
self.recipient_type = attributes[:'recipientType']
|
536
|
+
end
|
537
|
+
|
538
|
+
if attributes.has_key?(:'recipientTypeMetadata')
|
539
|
+
self.recipient_type_metadata = attributes[:'recipientTypeMetadata']
|
540
|
+
end
|
541
|
+
|
412
542
|
if attributes.has_key?(:'requireIdLookup')
|
413
543
|
self.require_id_lookup = attributes[:'requireIdLookup']
|
414
544
|
end
|
415
545
|
|
546
|
+
if attributes.has_key?(:'requireIdLookupMetadata')
|
547
|
+
self.require_id_lookup_metadata = attributes[:'requireIdLookupMetadata']
|
548
|
+
end
|
549
|
+
|
416
550
|
if attributes.has_key?(:'roleName')
|
417
551
|
self.role_name = attributes[:'roleName']
|
418
552
|
end
|
@@ -421,8 +555,8 @@ module DocuSign_eSign
|
|
421
555
|
self.routing_order = attributes[:'routingOrder']
|
422
556
|
end
|
423
557
|
|
424
|
-
if attributes.has_key?(:'
|
425
|
-
self.
|
558
|
+
if attributes.has_key?(:'routingOrderMetadata')
|
559
|
+
self.routing_order_metadata = attributes[:'routingOrderMetadata']
|
426
560
|
end
|
427
561
|
|
428
562
|
if attributes.has_key?(:'sentDateTime')
|
@@ -437,6 +571,10 @@ module DocuSign_eSign
|
|
437
571
|
self.signing_group_id = attributes[:'signingGroupId']
|
438
572
|
end
|
439
573
|
|
574
|
+
if attributes.has_key?(:'signingGroupIdMetadata')
|
575
|
+
self.signing_group_id_metadata = attributes[:'signingGroupIdMetadata']
|
576
|
+
end
|
577
|
+
|
440
578
|
if attributes.has_key?(:'signingGroupName')
|
441
579
|
self.signing_group_name = attributes[:'signingGroupName']
|
442
580
|
end
|
@@ -461,6 +599,14 @@ module DocuSign_eSign
|
|
461
599
|
self.status = attributes[:'status']
|
462
600
|
end
|
463
601
|
|
602
|
+
if attributes.has_key?(:'statusCode')
|
603
|
+
self.status_code = attributes[:'statusCode']
|
604
|
+
end
|
605
|
+
|
606
|
+
if attributes.has_key?(:'suppressEmails')
|
607
|
+
self.suppress_emails = attributes[:'suppressEmails']
|
608
|
+
end
|
609
|
+
|
464
610
|
if attributes.has_key?(:'templateLocked')
|
465
611
|
self.template_locked = attributes[:'templateLocked']
|
466
612
|
end
|
@@ -476,19 +622,20 @@ module DocuSign_eSign
|
|
476
622
|
if attributes.has_key?(:'userId')
|
477
623
|
self.user_id = attributes[:'userId']
|
478
624
|
end
|
625
|
+
|
479
626
|
end
|
480
627
|
|
481
628
|
# Show invalid properties with the reasons. Usually used together with valid?
|
482
|
-
# @return Array for valid
|
629
|
+
# @return Array for valid properies with the reasons
|
483
630
|
def list_invalid_properties
|
484
631
|
invalid_properties = Array.new
|
485
|
-
invalid_properties
|
632
|
+
return invalid_properties
|
486
633
|
end
|
487
634
|
|
488
635
|
# Check to see if the all the properties in the model are valid
|
489
636
|
# @return true if the model is valid
|
490
637
|
def valid?
|
491
|
-
true
|
638
|
+
return true
|
492
639
|
end
|
493
640
|
|
494
641
|
# Checks equality by comparing each attribute.
|
@@ -497,50 +644,67 @@ module DocuSign_eSign
|
|
497
644
|
return true if self.equal?(o)
|
498
645
|
self.class == o.class &&
|
499
646
|
access_code == o.access_code &&
|
647
|
+
access_code_metadata == o.access_code_metadata &&
|
500
648
|
add_access_code_to_email == o.add_access_code_to_email &&
|
501
649
|
agent_can_edit_email == o.agent_can_edit_email &&
|
502
650
|
agent_can_edit_name == o.agent_can_edit_name &&
|
503
651
|
client_user_id == o.client_user_id &&
|
652
|
+
completed_count == o.completed_count &&
|
504
653
|
custom_fields == o.custom_fields &&
|
505
654
|
declined_date_time == o.declined_date_time &&
|
506
655
|
declined_reason == o.declined_reason &&
|
507
656
|
delivered_date_time == o.delivered_date_time &&
|
508
657
|
delivery_method == o.delivery_method &&
|
658
|
+
delivery_method_metadata == o.delivery_method_metadata &&
|
509
659
|
document_visibility == o.document_visibility &&
|
510
660
|
email == o.email &&
|
661
|
+
email_metadata == o.email_metadata &&
|
511
662
|
email_notification == o.email_notification &&
|
512
|
-
email_recipient_post_signing_url == o.email_recipient_post_signing_url &&
|
513
663
|
embedded_recipient_start_url == o.embedded_recipient_start_url &&
|
514
664
|
error_details == o.error_details &&
|
515
665
|
excluded_documents == o.excluded_documents &&
|
516
666
|
fax_number == o.fax_number &&
|
667
|
+
fax_number_metadata == o.fax_number_metadata &&
|
517
668
|
first_name == o.first_name &&
|
669
|
+
first_name_metadata == o.first_name_metadata &&
|
518
670
|
full_name == o.full_name &&
|
671
|
+
full_name_metadata == o.full_name_metadata &&
|
519
672
|
id_check_configuration_name == o.id_check_configuration_name &&
|
673
|
+
id_check_configuration_name_metadata == o.id_check_configuration_name_metadata &&
|
520
674
|
id_check_information_input == o.id_check_information_input &&
|
521
|
-
identity_verification == o.identity_verification &&
|
522
675
|
inherit_email_notification_configuration == o.inherit_email_notification_configuration &&
|
523
676
|
last_name == o.last_name &&
|
677
|
+
last_name_metadata == o.last_name_metadata &&
|
678
|
+
locked_recipient_phone_auth_editable == o.locked_recipient_phone_auth_editable &&
|
679
|
+
locked_recipient_sms_editable == o.locked_recipient_sms_editable &&
|
524
680
|
name == o.name &&
|
681
|
+
name_metadata == o.name_metadata &&
|
525
682
|
note == o.note &&
|
683
|
+
note_metadata == o.note_metadata &&
|
526
684
|
phone_authentication == o.phone_authentication &&
|
527
|
-
proof_file == o.proof_file &&
|
528
685
|
recipient_attachments == o.recipient_attachments &&
|
529
686
|
recipient_authentication_status == o.recipient_authentication_status &&
|
687
|
+
recipient_feature_metadata == o.recipient_feature_metadata &&
|
530
688
|
recipient_id == o.recipient_id &&
|
531
689
|
recipient_id_guid == o.recipient_id_guid &&
|
690
|
+
recipient_type == o.recipient_type &&
|
691
|
+
recipient_type_metadata == o.recipient_type_metadata &&
|
532
692
|
require_id_lookup == o.require_id_lookup &&
|
693
|
+
require_id_lookup_metadata == o.require_id_lookup_metadata &&
|
533
694
|
role_name == o.role_name &&
|
534
695
|
routing_order == o.routing_order &&
|
535
|
-
|
696
|
+
routing_order_metadata == o.routing_order_metadata &&
|
536
697
|
sent_date_time == o.sent_date_time &&
|
537
698
|
signed_date_time == o.signed_date_time &&
|
538
699
|
signing_group_id == o.signing_group_id &&
|
700
|
+
signing_group_id_metadata == o.signing_group_id_metadata &&
|
539
701
|
signing_group_name == o.signing_group_name &&
|
540
702
|
signing_group_users == o.signing_group_users &&
|
541
703
|
sms_authentication == o.sms_authentication &&
|
542
704
|
social_authentications == o.social_authentications &&
|
543
705
|
status == o.status &&
|
706
|
+
status_code == o.status_code &&
|
707
|
+
suppress_emails == o.suppress_emails &&
|
544
708
|
template_locked == o.template_locked &&
|
545
709
|
template_required == o.template_required &&
|
546
710
|
total_tab_count == o.total_tab_count &&
|
@@ -556,7 +720,7 @@ module DocuSign_eSign
|
|
556
720
|
# Calculates hash code according to all attributes.
|
557
721
|
# @return [Fixnum] Hash code
|
558
722
|
def hash
|
559
|
-
[access_code, add_access_code_to_email, agent_can_edit_email, agent_can_edit_name, client_user_id, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, document_visibility, email,
|
723
|
+
[access_code, access_code_metadata, add_access_code_to_email, agent_can_edit_email, agent_can_edit_name, 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, 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, inherit_email_notification_configuration, last_name, last_name_metadata, 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, template_locked, template_required, total_tab_count, user_id].hash
|
560
724
|
end
|
561
725
|
|
562
726
|
# Builds the object from hash
|
@@ -566,10 +730,10 @@ module DocuSign_eSign
|
|
566
730
|
return nil unless attributes.is_a?(Hash)
|
567
731
|
self.class.swagger_types.each_pair do |key, type|
|
568
732
|
if type =~ /\AArray<(.*)>/i
|
569
|
-
# check to ensure the input is an array given that the attribute
|
733
|
+
# check to ensure the input is an array given that the the attribute
|
570
734
|
# is documented as an array but the input is not
|
571
735
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
572
|
-
self.send("#{key}=", attributes[self.class.attribute_map[key]].map
|
736
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
|
573
737
|
end
|
574
738
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
575
739
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
@@ -651,7 +815,7 @@ module DocuSign_eSign
|
|
651
815
|
# @return [Hash] Returns the value in the form of hash
|
652
816
|
def _to_hash(value)
|
653
817
|
if value.is_a?(Array)
|
654
|
-
value.compact.map
|
818
|
+
value.compact.map{ |v| _to_hash(v) }
|
655
819
|
elsif value.is_a?(Hash)
|
656
820
|
{}.tap do |hash|
|
657
821
|
value.each { |k, v| hash[k] = _to_hash(v) }
|
@@ -664,4 +828,5 @@ module DocuSign_eSign
|
|
664
828
|
end
|
665
829
|
|
666
830
|
end
|
831
|
+
|
667
832
|
end
|