docusign_esign 3.12.0 → 3.19.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +54 -0
- data/docusign_esign.gemspec +5 -5
- data/lib/docusign_esign/api/accounts_api.rb +83 -433
- data/lib/docusign_esign/api/billing_api.rb +12 -4
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +93 -26
- data/lib/docusign_esign/api/bulk_process_data_api.rb +412 -0
- data/lib/docusign_esign/api/bulk_process_data_send_api.rb +252 -0
- data/lib/docusign_esign/api/connect_api.rb +239 -5
- data/lib/docusign_esign/api/email_archive_api.rb +8 -8
- data/lib/docusign_esign/api/envelopes_api.rb +1435 -207
- data/lib/docusign_esign/api/notary_api.rb +16 -16
- data/lib/docusign_esign/api/organizations_api.rb +8 -60
- data/lib/docusign_esign/api/power_forms_api.rb +24 -16
- data/lib/docusign_esign/api/templates_api.rb +20 -79
- data/lib/docusign_esign/api/users_api.rb +22 -14
- data/lib/docusign_esign/api/workspaces_api.rb +4 -4
- data/lib/docusign_esign/client/api_client.rb +16 -10
- data/lib/docusign_esign/client/api_error.rb +1 -1
- data/lib/docusign_esign/client/auth/oauth.rb +1 -1
- data/lib/docusign_esign/models/access_code_format.rb +6 -0
- data/lib/docusign_esign/models/account_billing_plan.rb +25 -4
- data/lib/docusign_esign/models/account_billing_plan_response.rb +37 -10
- data/lib/docusign_esign/models/account_identity_verification_step.rb +1 -0
- data/lib/docusign_esign/models/account_identity_verification_workflow.rb +2 -0
- data/lib/docusign_esign/models/account_information.rb +11 -1
- data/lib/docusign_esign/models/account_notification.rb +3 -0
- data/lib/docusign_esign/models/account_password_questions_required.rb +1 -0
- data/lib/docusign_esign/models/account_password_rules.rb +7 -0
- data/lib/docusign_esign/models/account_role_settings.rb +81 -4
- data/lib/docusign_esign/models/account_settings_information.rb +1075 -13
- data/lib/docusign_esign/models/account_shared_access.rb +1 -0
- data/lib/docusign_esign/models/account_signature.rb +2 -0
- data/lib/docusign_esign/models/account_signature_definition.rb +1 -0
- data/lib/docusign_esign/models/account_signature_provider.rb +1 -0
- data/lib/docusign_esign/models/account_signature_provider_option.rb +1 -0
- data/lib/docusign_esign/models/account_ui_settings.rb +28 -13
- data/lib/docusign_esign/models/address_information_input.rb +1 -0
- data/lib/docusign_esign/models/agent.rb +45 -1
- data/lib/docusign_esign/models/app_store_receipt.rb +21 -1
- data/lib/docusign_esign/models/approve.rb +65 -1
- data/lib/docusign_esign/models/authentication_status.rb +19 -0
- data/lib/docusign_esign/models/bcc_email_archive.rb +3 -0
- data/lib/docusign_esign/models/bcc_email_archive_history.rb +2 -0
- data/lib/docusign_esign/models/bcc_email_archive_list.rb +1 -0
- data/lib/docusign_esign/models/billing_charge.rb +1 -1
- data/lib/docusign_esign/models/billing_entity_information_response.rb +214 -0
- data/lib/docusign_esign/models/billing_invoice_item.rb +21 -1
- data/lib/docusign_esign/models/billing_invoices_summary.rb +21 -1
- data/lib/docusign_esign/models/billing_plan_information.rb +52 -4
- data/lib/docusign_esign/models/billing_plan_preview.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_response.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_update_response.rb +1 -0
- data/lib/docusign_esign/models/brand.rb +4 -0
- data/lib/docusign_esign/models/brand_email_content.rb +1 -0
- data/lib/docusign_esign/models/brand_link.rb +1 -0
- data/lib/docusign_esign/models/brand_logos.rb +1 -0
- data/lib/docusign_esign/models/brand_request.rb +1 -0
- data/lib/docusign_esign/models/brand_resource_urls.rb +1 -0
- data/lib/docusign_esign/models/brand_resources.rb +3 -0
- data/lib/docusign_esign/models/brands_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_envelope.rb +1 -0
- data/lib/docusign_esign/models/bulk_process_request.rb +194 -0
- data/lib/docusign_esign/models/bulk_process_response.rb +248 -0
- data/lib/docusign_esign/models/bulk_process_result.rb +206 -0
- data/lib/docusign_esign/models/bulk_processing_list_summaries.rb +186 -0
- data/lib/docusign_esign/models/bulk_processing_list_summary.rb +214 -0
- data/lib/docusign_esign/models/bulk_processing_lists.rb +186 -0
- data/lib/docusign_esign/models/bulk_recipients_update_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_action_request.rb +204 -0
- data/lib/docusign_esign/models/bulk_send_batch_error.rb +194 -0
- data/lib/docusign_esign/models/bulk_send_batch_status.rb +42 -1
- data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +22 -1
- data/lib/docusign_esign/models/bulk_send_batch_summary.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_envelopes_info.rb +304 -0
- data/lib/docusign_esign/models/bulk_send_error_status.rb +12 -1
- data/lib/docusign_esign/models/bulk_send_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_test_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +5 -0
- data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list_summary.rb +1 -0
- data/lib/docusign_esign/models/captive_recipient.rb +2 -0
- data/lib/docusign_esign/models/captive_recipient_information.rb +1 -0
- data/lib/docusign_esign/models/carbon_copy.rb +48 -1
- data/lib/docusign_esign/models/certified_delivery.rb +47 -1
- data/lib/docusign_esign/models/checkbox.rb +109 -1
- data/lib/docusign_esign/models/chunked_upload_part.rb +1 -0
- data/lib/docusign_esign/models/chunked_upload_request.rb +1 -0
- data/lib/docusign_esign/models/chunked_upload_response.rb +1 -0
- data/lib/docusign_esign/models/cloud_storage_provider.rb +2 -0
- data/lib/docusign_esign/models/comment_thread.rb +63 -1
- data/lib/docusign_esign/models/commission_county.rb +72 -1
- data/lib/docusign_esign/models/commission_expiration.rb +72 -1
- data/lib/docusign_esign/models/commission_number.rb +72 -1
- data/lib/docusign_esign/models/commission_state.rb +72 -1
- data/lib/docusign_esign/models/company.rb +72 -1
- data/lib/docusign_esign/models/composite_template.rb +2 -0
- data/lib/docusign_esign/models/conditional_recipient_rule.rb +2 -0
- data/lib/docusign_esign/models/connect_config_results.rb +1 -0
- data/lib/docusign_esign/models/connect_custom_configuration.rb +60 -4
- data/lib/docusign_esign/models/connect_debug_log.rb +1 -0
- data/lib/docusign_esign/models/connect_delete_failure_result.rb +174 -0
- data/lib/docusign_esign/models/connect_event_data.rb +1 -0
- data/lib/docusign_esign/models/connect_failure_filter.rb +1 -0
- data/lib/docusign_esign/models/connect_failure_result.rb +1 -0
- data/lib/docusign_esign/models/connect_historical_envelope_republish.rb +195 -0
- data/lib/docusign_esign/models/connect_log.rb +1 -0
- data/lib/docusign_esign/models/connect_o_auth_config.rb +214 -0
- data/lib/docusign_esign/models/connect_salesforce_field.rb +1 -0
- data/lib/docusign_esign/models/connect_salesforce_object.rb +1 -0
- data/lib/docusign_esign/models/connect_user_info.rb +214 -0
- data/lib/docusign_esign/models/consent_details.rb +204 -0
- data/lib/docusign_esign/models/console_view_request.rb +1 -0
- data/lib/docusign_esign/models/consumer_disclosure.rb +3 -0
- data/lib/docusign_esign/models/contact.rb +12 -1
- data/lib/docusign_esign/models/contact_get_response.rb +1 -0
- data/lib/docusign_esign/models/contact_mod_request.rb +1 -0
- data/lib/docusign_esign/models/contact_phone_number.rb +1 -0
- data/lib/docusign_esign/models/contact_update_response.rb +1 -0
- data/lib/docusign_esign/models/correct_view_request.rb +12 -1
- data/lib/docusign_esign/models/credit_card_information.rb +2 -0
- data/lib/docusign_esign/models/currency.rb +95 -1
- data/lib/docusign_esign/models/currency_feature_set_price.rb +1 -0
- data/lib/docusign_esign/models/currency_plan_price.rb +1 -0
- data/lib/docusign_esign/models/custom_field.rb +2 -0
- data/lib/docusign_esign/models/date.rb +98 -1
- data/lib/docusign_esign/models/date_signed.rb +66 -1
- data/lib/docusign_esign/models/date_stamp_properties.rb +1 -0
- data/lib/docusign_esign/models/decline.rb +66 -1
- data/lib/docusign_esign/models/delayed_routing.rb +206 -0
- data/lib/docusign_esign/models/delayed_routing_api_model.rb +206 -0
- data/lib/docusign_esign/models/delegation_info.rb +214 -0
- data/lib/docusign_esign/models/direct_debit_processor_information.rb +1 -0
- data/lib/docusign_esign/models/document.rb +3 -0
- data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +1 -0
- data/lib/docusign_esign/models/document_html_definition.rb +1 -0
- data/lib/docusign_esign/models/document_html_definition_original.rb +1 -0
- data/lib/docusign_esign/models/document_html_display_anchor.rb +1 -0
- data/lib/docusign_esign/models/document_html_display_settings.rb +1 -0
- data/lib/docusign_esign/models/document_template.rb +1 -0
- data/lib/docusign_esign/models/document_visibility.rb +2 -0
- data/lib/docusign_esign/models/document_visibility_list.rb +1 -0
- data/lib/docusign_esign/models/downgrad_request_billing_info_response.rb +1 -0
- data/lib/docusign_esign/models/downgrade_billing_plan_information.rb +1 -0
- data/lib/docusign_esign/models/downgrade_plan_update_response.rb +11 -1
- data/lib/docusign_esign/models/downgrade_request_information.rb +204 -0
- data/lib/docusign_esign/models/draw.rb +60 -1
- data/lib/docusign_esign/models/e_note_configuration.rb +1 -0
- data/lib/docusign_esign/models/editor.rb +46 -1
- data/lib/docusign_esign/models/email.rb +98 -1
- data/lib/docusign_esign/models/email_address.rb +66 -1
- data/lib/docusign_esign/models/envelope.rb +20 -1
- data/lib/docusign_esign/models/envelope_attachment.rb +1 -0
- data/lib/docusign_esign/models/envelope_custom_metadata.rb +186 -0
- data/lib/docusign_esign/models/envelope_definition.rb +23 -1
- data/lib/docusign_esign/models/envelope_delay_rule.rb +194 -0
- data/lib/docusign_esign/models/envelope_delay_rule_api_model.rb +195 -0
- data/lib/docusign_esign/models/envelope_document.rb +7 -0
- data/lib/docusign_esign/models/envelope_event.rb +1 -0
- data/lib/docusign_esign/models/envelope_form_data.rb +2 -0
- data/lib/docusign_esign/models/envelope_id.rb +65 -1
- data/lib/docusign_esign/models/envelope_ids_request.rb +1 -0
- data/lib/docusign_esign/models/envelope_notification_request.rb +3 -0
- data/lib/docusign_esign/models/envelope_publish_transaction.rb +307 -0
- data/lib/docusign_esign/models/envelope_publish_transaction_error_rollup.rb +194 -0
- data/lib/docusign_esign/models/envelope_purge_configuration.rb +1 -0
- data/lib/docusign_esign/models/envelope_summary.rb +3 -0
- data/lib/docusign_esign/models/envelope_template.rb +22 -1
- data/lib/docusign_esign/models/envelope_template_results.rb +1 -0
- data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -0
- data/lib/docusign_esign/models/envelope_transfer_rule.rb +6 -0
- data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +4 -0
- data/lib/docusign_esign/models/envelope_update_summary.rb +4 -0
- data/lib/docusign_esign/models/envelopes_information.rb +1 -0
- data/lib/docusign_esign/models/event_notification.rb +24 -1
- data/lib/docusign_esign/models/event_result.rb +1 -0
- data/lib/docusign_esign/models/external_document_sources.rb +6 -0
- data/lib/docusign_esign/models/external_file.rb +1 -0
- data/lib/docusign_esign/models/external_folder.rb +1 -0
- data/lib/docusign_esign/models/external_primary_account_recipient_auth_requirements.rb +214 -0
- data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -0
- data/lib/docusign_esign/models/favorite_templates_info.rb +1 -0
- data/lib/docusign_esign/models/feature_set.rb +1 -0
- data/lib/docusign_esign/models/filter.rb +1 -0
- data/lib/docusign_esign/models/first_name.rb +66 -1
- data/lib/docusign_esign/models/folder.rb +4 -0
- data/lib/docusign_esign/models/folder_item_response.rb +1 -0
- data/lib/docusign_esign/models/folder_item_v2.rb +13 -1
- data/lib/docusign_esign/models/folder_shared_item.rb +3 -0
- data/lib/docusign_esign/models/folders_request.rb +1 -0
- data/lib/docusign_esign/models/form_data_item.rb +1 -0
- data/lib/docusign_esign/models/formula_tab.rb +103 -1
- data/lib/docusign_esign/models/full_name.rb +66 -1
- data/lib/docusign_esign/models/group.rb +13 -1
- data/lib/docusign_esign/models/id_check_configuration.rb +1 -0
- data/lib/docusign_esign/models/id_check_information_input.rb +4 -0
- data/lib/docusign_esign/models/id_evidence_resource_token.rb +194 -0
- data/lib/docusign_esign/models/id_evidence_view_link.rb +184 -0
- data/lib/docusign_esign/models/in_person_signer.rb +31 -0
- data/lib/docusign_esign/models/initial_here.rb +60 -1
- data/lib/docusign_esign/models/inline_template.rb +3 -0
- data/lib/docusign_esign/models/integrated_connect_user_info_list.rb +246 -0
- data/lib/docusign_esign/models/intermediary.rb +46 -1
- data/lib/docusign_esign/models/jurisdiction.rb +1 -0
- data/lib/docusign_esign/models/last_name.rb +66 -1
- data/lib/docusign_esign/models/linked_external_primary_account.rb +21 -1
- data/lib/docusign_esign/models/list.rb +112 -1
- data/lib/docusign_esign/models/list_custom_field.rb +2 -0
- data/lib/docusign_esign/models/list_item.rb +4 -0
- data/lib/docusign_esign/models/locale_policy.rb +13 -0
- data/lib/docusign_esign/models/lock_information.rb +2 -0
- data/lib/docusign_esign/models/lock_request.rb +1 -0
- data/lib/docusign_esign/models/member_group_shared_item.rb +3 -0
- data/lib/docusign_esign/models/member_shared_items.rb +3 -0
- data/lib/docusign_esign/models/merge_field.rb +6 -0
- data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -0
- data/lib/docusign_esign/models/money.rb +1 -0
- data/lib/docusign_esign/models/name_value.rb +2 -0
- data/lib/docusign_esign/models/new_account_definition.rb +53 -4
- data/lib/docusign_esign/models/new_account_summary.rb +1 -0
- data/lib/docusign_esign/models/new_user.rb +2 -0
- data/lib/docusign_esign/models/new_users_summary.rb +1 -0
- data/lib/docusign_esign/models/notarize.rb +58 -1
- data/lib/docusign_esign/models/notary.rb +1 -0
- data/lib/docusign_esign/models/notary_host.rb +20 -0
- data/lib/docusign_esign/models/notary_journal.rb +2 -0
- data/lib/docusign_esign/models/notary_jurisdiction.rb +3 -0
- data/lib/docusign_esign/models/notary_jurisdiction_list.rb +1 -0
- data/lib/docusign_esign/models/notary_recipient.rb +93 -1
- data/lib/docusign_esign/models/notary_result.rb +2 -0
- data/lib/docusign_esign/models/notary_seal.rb +59 -1
- data/lib/docusign_esign/models/note.rb +67 -1
- data/lib/docusign_esign/models/notification.rb +2 -0
- data/lib/docusign_esign/models/notification_default_settings.rb +3 -0
- data/lib/docusign_esign/models/notification_defaults.rb +2 -0
- data/lib/docusign_esign/models/number.rb +100 -1
- data/lib/docusign_esign/models/page.rb +1 -0
- data/lib/docusign_esign/models/participant.rb +908 -0
- data/lib/docusign_esign/models/payment_details.rb +16 -1
- data/lib/docusign_esign/models/payment_gateway_account.rb +3 -0
- data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +1 -0
- data/lib/docusign_esign/models/payment_line_item.rb +1 -0
- data/lib/docusign_esign/models/payment_method_with_options.rb +1 -0
- data/lib/docusign_esign/models/payment_processor_information.rb +1 -0
- data/lib/docusign_esign/models/permission_profile.rb +2 -0
- data/lib/docusign_esign/models/permission_profile_information.rb +1 -0
- data/lib/docusign_esign/models/phone_number.rb +72 -1
- data/lib/docusign_esign/models/poly_line_overlay.rb +60 -1
- data/lib/docusign_esign/models/power_form.rb +2 -0
- data/lib/docusign_esign/models/power_form_recipient.rb +1 -0
- data/lib/docusign_esign/models/power_form_senders_response.rb +1 -0
- data/lib/docusign_esign/models/power_forms_response.rb +1 -0
- data/lib/docusign_esign/models/prefill_tabs.rb +65 -4
- data/lib/docusign_esign/models/property_metadata.rb +1 -0
- data/lib/docusign_esign/models/radio.rb +48 -1
- data/lib/docusign_esign/models/radio_group.rb +78 -4
- data/lib/docusign_esign/models/recipient_additional_notification.rb +3 -0
- data/lib/docusign_esign/models/recipient_email_notification.rb +3 -0
- data/lib/docusign_esign/models/recipient_group.rb +1 -0
- data/lib/docusign_esign/models/recipient_identity_phone_number.rb +44 -4
- data/lib/docusign_esign/models/recipient_identity_verification.rb +15 -4
- data/lib/docusign_esign/models/recipient_names_response.rb +1 -0
- data/lib/docusign_esign/models/recipient_option.rb +1 -0
- data/lib/docusign_esign/models/recipient_phone_authentication.rb +4 -0
- data/lib/docusign_esign/models/recipient_phone_number.rb +3 -0
- data/lib/docusign_esign/models/recipient_preview_request.rb +2 -0
- data/lib/docusign_esign/models/recipient_proof_file.rb +1 -0
- data/lib/docusign_esign/models/recipient_routing.rb +2 -0
- data/lib/docusign_esign/models/recipient_signature_provider.rb +3 -0
- data/lib/docusign_esign/models/recipient_signature_provider_options.rb +5 -0
- data/lib/docusign_esign/models/recipient_sms_authentication.rb +1 -0
- data/lib/docusign_esign/models/recipient_token_client_ur_ls.rb +102 -2
- data/lib/docusign_esign/models/recipient_update_response.rb +3 -0
- data/lib/docusign_esign/models/recipient_view_request.rb +2 -0
- data/lib/docusign_esign/models/recipients.rb +14 -1
- data/lib/docusign_esign/models/recipients_update_summary.rb +1 -0
- data/lib/docusign_esign/models/reserved_domain_existence.rb +194 -0
- data/lib/docusign_esign/models/return_url_request.rb +1 -0
- data/lib/docusign_esign/models/scheduled_sending.rb +216 -0
- data/lib/docusign_esign/models/scheduled_sending_api_model.rb +206 -0
- data/lib/docusign_esign/models/seal_sign.rb +17 -0
- data/lib/docusign_esign/models/seat_discount.rb +1 -0
- data/lib/docusign_esign/models/sender_company.rb +65 -1
- data/lib/docusign_esign/models/sender_email_notifications.rb +12 -1
- data/lib/docusign_esign/models/sender_name.rb +65 -1
- data/lib/docusign_esign/models/settings_metadata.rb +1 -0
- data/lib/docusign_esign/models/shared_item.rb +3 -0
- data/lib/docusign_esign/models/sign_here.rb +62 -1
- data/lib/docusign_esign/models/signature_provider_required_option.rb +1 -0
- data/lib/docusign_esign/models/signature_type.rb +1 -0
- data/lib/docusign_esign/models/signer.rb +84 -1
- data/lib/docusign_esign/models/signer_attachment.rb +60 -1
- data/lib/docusign_esign/models/signing_group.rb +2 -0
- data/lib/docusign_esign/models/signing_group_user.rb +1 -0
- data/lib/docusign_esign/models/smart_section.rb +61 -1
- data/lib/docusign_esign/models/smart_section_display_settings.rb +2 -0
- data/lib/docusign_esign/models/social_account_information.rb +1 -0
- data/lib/docusign_esign/models/ssn.rb +98 -1
- data/lib/docusign_esign/models/stamp.rb +2 -0
- data/lib/docusign_esign/models/supported_languages.rb +1 -0
- data/lib/docusign_esign/models/tab_account_settings.rb +42 -1
- data/lib/docusign_esign/models/tab_group.rb +61 -1
- data/lib/docusign_esign/models/tab_metadata.rb +34 -1
- data/lib/docusign_esign/models/tabs.rb +2 -0
- data/lib/docusign_esign/models/template_document_visibility_list.rb +1 -0
- data/lib/docusign_esign/models/template_notification_request.rb +2 -0
- data/lib/docusign_esign/models/template_recipients.rb +14 -1
- data/lib/docusign_esign/models/template_role.rb +4 -0
- data/lib/docusign_esign/models/template_shared_item.rb +3 -0
- data/lib/docusign_esign/models/template_summary.rb +3 -0
- data/lib/docusign_esign/models/template_tabs.rb +1 -0
- data/lib/docusign_esign/models/template_update_summary.rb +4 -0
- data/lib/docusign_esign/models/text.rb +100 -1
- data/lib/docusign_esign/models/text_custom_field.rb +2 -0
- data/lib/docusign_esign/models/title.rb +72 -1
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +70 -1
- data/lib/docusign_esign/models/user_info.rb +1 -0
- data/lib/docusign_esign/models/user_information.rb +17 -1
- data/lib/docusign_esign/models/user_information_list.rb +1 -0
- data/lib/docusign_esign/models/user_password_information.rb +1 -0
- data/lib/docusign_esign/models/user_password_rules.rb +2 -0
- data/lib/docusign_esign/models/user_profile.rb +3 -0
- data/lib/docusign_esign/models/user_settings_information.rb +103 -4
- data/lib/docusign_esign/models/user_shared_item.rb +3 -0
- data/lib/docusign_esign/models/user_signature.rb +2 -0
- data/lib/docusign_esign/models/user_signature_definition.rb +1 -0
- data/lib/docusign_esign/models/view.rb +66 -1
- data/lib/docusign_esign/models/witness.rb +84 -1
- data/lib/docusign_esign/models/workflow.rb +32 -1
- data/lib/docusign_esign/models/workflow_step.rb +13 -1
- data/lib/docusign_esign/models/workspace.rb +4 -0
- data/lib/docusign_esign/models/workspace_folder_contents.rb +1 -0
- data/lib/docusign_esign/models/workspace_item.rb +5 -0
- data/lib/docusign_esign/models/workspace_settings.rb +1 -0
- data/lib/docusign_esign/models/workspace_user.rb +1 -0
- data/lib/docusign_esign/models/workspace_user_authorization.rb +2 -0
- data/lib/docusign_esign/models/zip.rb +99 -1
- data/lib/docusign_esign/version.rb +1 -1
- data/lib/docusign_esign.rb +30 -17
- data/tests/spec/unit_tests_using_jwt_spec.rb +605 -449
- metadata +70 -44
- data/Gemfile.lock +0 -73
- data/docusign_esign-2.12.0.rc1.gem +0 -0
- data/docusign_esign-3.12.0.rc1.gem +0 -0
- data/lib/docusign_esign/.DS_Store +0 -0
- data/lib/docusign_esign/api/.DS_Store +0 -0
- data/lib/docusign_esign/client/.DS_Store +0 -0
- data/tests/.DS_Store +0 -0
- data/tests/Gemfile.lock +0 -46
- data/tests/docs/private.pem +0 -27
@@ -20,6 +20,7 @@ module DocuSign_eSign
|
|
20
20
|
# The last position in the result set.
|
21
21
|
attr_accessor :end_position
|
22
22
|
|
23
|
+
# A complex type containing an errorCode and message identifying the error that occurred.
|
23
24
|
attr_accessor :error_details
|
24
25
|
|
25
26
|
# The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.
|
@@ -22,11 +22,13 @@ module DocuSign_eSign
|
|
22
22
|
#
|
23
23
|
attr_accessor :custom_field
|
24
24
|
|
25
|
+
# Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle.
|
25
26
|
attr_accessor :date_stamp_properties
|
26
27
|
|
27
28
|
#
|
28
29
|
attr_accessor :disallow_user_resize_stamp
|
29
30
|
|
31
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
30
32
|
attr_accessor :error_details
|
31
33
|
|
32
34
|
#
|
@@ -13,6 +13,7 @@ require 'date'
|
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
15
|
class AccountSignatureDefinition
|
16
|
+
# Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle.
|
16
17
|
attr_accessor :date_stamp_properties
|
17
18
|
|
18
19
|
#
|
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# Contains information abotu the signature provider associated with the Identity Verification workflow. If empty, then this specific workflow is not intended for signers.
|
15
16
|
class AccountSignatureProvider
|
16
17
|
#
|
17
18
|
attr_accessor :is_required
|
@@ -12,44 +12,53 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# An object that defines the options that are available to non-administrators in the UI.
|
15
16
|
class AccountUISettings
|
17
|
+
#
|
16
18
|
attr_accessor :admin_message
|
17
19
|
|
20
|
+
#
|
18
21
|
attr_accessor :ask_an_admin
|
19
22
|
|
20
23
|
#
|
21
24
|
attr_accessor :enable_admin_message
|
22
25
|
|
26
|
+
#
|
23
27
|
attr_accessor :enable_admin_message_metadata
|
24
28
|
|
25
29
|
#
|
26
30
|
attr_accessor :enable_easy_sign_can_use_multi_template_apply
|
27
31
|
|
32
|
+
#
|
28
33
|
attr_accessor :enable_easy_sign_can_use_multi_template_apply_metadata
|
29
34
|
|
30
35
|
#
|
31
36
|
attr_accessor :enable_easy_sign_template_upload
|
32
37
|
|
38
|
+
#
|
33
39
|
attr_accessor :enable_easy_sign_template_upload_metadata
|
34
40
|
|
35
41
|
#
|
36
42
|
attr_accessor :enable_envelope_copy_with_data
|
37
43
|
|
44
|
+
#
|
38
45
|
attr_accessor :enable_envelope_copy_with_data_metadata
|
39
46
|
|
40
47
|
#
|
41
|
-
attr_accessor :
|
48
|
+
attr_accessor :enable_legacy_sendflow_link
|
42
49
|
|
43
|
-
attr_accessor :
|
50
|
+
attr_accessor :enable_legacy_sendflow_link_metadata
|
44
51
|
|
45
52
|
#
|
46
53
|
attr_accessor :has_external_linked_accounts
|
47
54
|
|
55
|
+
#
|
48
56
|
attr_accessor :has_external_linked_accounts_metadata
|
49
57
|
|
50
58
|
#
|
51
59
|
attr_accessor :hide_send_an_envelope
|
52
60
|
|
61
|
+
#
|
53
62
|
attr_accessor :hide_send_an_envelope_metadata
|
54
63
|
|
55
64
|
#
|
@@ -58,28 +67,34 @@ module DocuSign_eSign
|
|
58
67
|
#
|
59
68
|
attr_accessor :hide_use_a_template_in_prepare
|
60
69
|
|
70
|
+
#
|
61
71
|
attr_accessor :hide_use_a_template_in_prepare_metadata
|
62
72
|
|
73
|
+
#
|
63
74
|
attr_accessor :hide_use_a_template_metadata
|
64
75
|
|
65
76
|
#
|
66
77
|
attr_accessor :order_based_recipient_id_generation
|
67
78
|
|
79
|
+
#
|
68
80
|
attr_accessor :order_based_recipient_id_generation_metadata
|
69
81
|
|
70
82
|
#
|
71
83
|
attr_accessor :remove_envelope_forwarding
|
72
84
|
|
85
|
+
#
|
73
86
|
attr_accessor :remove_envelope_forwarding_metadata
|
74
87
|
|
75
88
|
#
|
76
89
|
attr_accessor :should_redact_access_code
|
77
90
|
|
91
|
+
#
|
78
92
|
attr_accessor :should_redact_access_code_metadata
|
79
93
|
|
80
94
|
#
|
81
95
|
attr_accessor :upload_new_image_to_sign_or_initial
|
82
96
|
|
97
|
+
#
|
83
98
|
attr_accessor :upload_new_image_to_sign_or_initial_metadata
|
84
99
|
|
85
100
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -95,8 +110,8 @@ module DocuSign_eSign
|
|
95
110
|
:'enable_easy_sign_template_upload_metadata' => :'enableEasySignTemplateUploadMetadata',
|
96
111
|
:'enable_envelope_copy_with_data' => :'enableEnvelopeCopyWithData',
|
97
112
|
:'enable_envelope_copy_with_data_metadata' => :'enableEnvelopeCopyWithDataMetadata',
|
98
|
-
:'
|
99
|
-
:'
|
113
|
+
:'enable_legacy_sendflow_link' => :'enableLegacySendflowLink',
|
114
|
+
:'enable_legacy_sendflow_link_metadata' => :'enableLegacySendflowLinkMetadata',
|
100
115
|
:'has_external_linked_accounts' => :'hasExternalLinkedAccounts',
|
101
116
|
:'has_external_linked_accounts_metadata' => :'hasExternalLinkedAccountsMetadata',
|
102
117
|
:'hide_send_an_envelope' => :'hideSendAnEnvelope',
|
@@ -129,8 +144,8 @@ module DocuSign_eSign
|
|
129
144
|
:'enable_easy_sign_template_upload_metadata' => :'SettingsMetadata',
|
130
145
|
:'enable_envelope_copy_with_data' => :'String',
|
131
146
|
:'enable_envelope_copy_with_data_metadata' => :'SettingsMetadata',
|
132
|
-
:'
|
133
|
-
:'
|
147
|
+
:'enable_legacy_sendflow_link' => :'String',
|
148
|
+
:'enable_legacy_sendflow_link_metadata' => :'SettingsMetadata',
|
134
149
|
:'has_external_linked_accounts' => :'String',
|
135
150
|
:'has_external_linked_accounts_metadata' => :'SettingsMetadata',
|
136
151
|
:'hide_send_an_envelope' => :'String',
|
@@ -198,12 +213,12 @@ module DocuSign_eSign
|
|
198
213
|
self.enable_envelope_copy_with_data_metadata = attributes[:'enableEnvelopeCopyWithDataMetadata']
|
199
214
|
end
|
200
215
|
|
201
|
-
if attributes.has_key?(:'
|
202
|
-
self.
|
216
|
+
if attributes.has_key?(:'enableLegacySendflowLink')
|
217
|
+
self.enable_legacy_sendflow_link = attributes[:'enableLegacySendflowLink']
|
203
218
|
end
|
204
219
|
|
205
|
-
if attributes.has_key?(:'
|
206
|
-
self.
|
220
|
+
if attributes.has_key?(:'enableLegacySendflowLinkMetadata')
|
221
|
+
self.enable_legacy_sendflow_link_metadata = attributes[:'enableLegacySendflowLinkMetadata']
|
207
222
|
end
|
208
223
|
|
209
224
|
if attributes.has_key?(:'hasExternalLinkedAccounts')
|
@@ -299,8 +314,8 @@ module DocuSign_eSign
|
|
299
314
|
enable_easy_sign_template_upload_metadata == o.enable_easy_sign_template_upload_metadata &&
|
300
315
|
enable_envelope_copy_with_data == o.enable_envelope_copy_with_data &&
|
301
316
|
enable_envelope_copy_with_data_metadata == o.enable_envelope_copy_with_data_metadata &&
|
302
|
-
|
303
|
-
|
317
|
+
enable_legacy_sendflow_link == o.enable_legacy_sendflow_link &&
|
318
|
+
enable_legacy_sendflow_link_metadata == o.enable_legacy_sendflow_link_metadata &&
|
304
319
|
has_external_linked_accounts == o.has_external_linked_accounts &&
|
305
320
|
has_external_linked_accounts_metadata == o.has_external_linked_accounts_metadata &&
|
306
321
|
hide_send_an_envelope == o.hide_send_an_envelope &&
|
@@ -328,7 +343,7 @@ module DocuSign_eSign
|
|
328
343
|
# Calculates hash code according to all attributes.
|
329
344
|
# @return [Fixnum] Hash code
|
330
345
|
def hash
|
331
|
-
[admin_message, ask_an_admin, enable_admin_message, enable_admin_message_metadata, enable_easy_sign_can_use_multi_template_apply, enable_easy_sign_can_use_multi_template_apply_metadata, enable_easy_sign_template_upload, enable_easy_sign_template_upload_metadata, enable_envelope_copy_with_data, enable_envelope_copy_with_data_metadata,
|
346
|
+
[admin_message, ask_an_admin, enable_admin_message, enable_admin_message_metadata, enable_easy_sign_can_use_multi_template_apply, enable_easy_sign_can_use_multi_template_apply_metadata, enable_easy_sign_template_upload, enable_easy_sign_template_upload_metadata, enable_envelope_copy_with_data, enable_envelope_copy_with_data_metadata, enable_legacy_sendflow_link, enable_legacy_sendflow_link_metadata, has_external_linked_accounts, has_external_linked_accounts_metadata, hide_send_an_envelope, hide_send_an_envelope_metadata, hide_use_a_template, hide_use_a_template_in_prepare, hide_use_a_template_in_prepare_metadata, hide_use_a_template_metadata, order_based_recipient_id_generation, order_based_recipient_id_generation_metadata, remove_envelope_forwarding, remove_envelope_forwarding_metadata, should_redact_access_code, should_redact_access_code_metadata, upload_new_image_to_sign_or_initial, upload_new_image_to_sign_or_initial_metadata].hash
|
332
347
|
end
|
333
348
|
|
334
349
|
# Builds the object from hash
|
@@ -14,6 +14,7 @@ require 'date'
|
|
14
14
|
module DocuSign_eSign
|
15
15
|
# Contains address input information.
|
16
16
|
class AddressInformationInput
|
17
|
+
# A complex type that contains the following information for the new account: `address1`, `address2`, `city`, `country`, `fax`, `phone`, `postalCode` and `stateOrProvince`. The maximum characters for the strings are: * `address1`, `address2`, `city`, `country` and `stateOrProvince`: 100 characters * `postalCode`, `phone`, and `fax`: 20 characters **Note:** If country is US (United States), `stateOrProvince` codes are validated. Otherwise, `stateOrProvince` is treated as a non-validated string used to specify a state, province, or region.
|
17
18
|
attr_accessor :address_information
|
18
19
|
|
19
20
|
# Specifies the display level for the recipient. Valid values are: * ReadOnly * Editable * DoNotDisplay
|
@@ -17,6 +17,7 @@ module DocuSign_eSign
|
|
17
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.
|
18
18
|
attr_accessor :access_code
|
19
19
|
|
20
|
+
# Metadata that indicates whether the `accessCode` property is editable. This property is read-only.
|
20
21
|
attr_accessor :access_code_metadata
|
21
22
|
|
22
23
|
# This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
|
@@ -37,6 +38,9 @@ module DocuSign_eSign
|
|
37
38
|
#
|
38
39
|
attr_accessor :completed_count
|
39
40
|
|
41
|
+
#
|
42
|
+
attr_accessor :consent_details_list
|
43
|
+
|
40
44
|
# 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.
|
41
45
|
attr_accessor :custom_fields
|
42
46
|
|
@@ -52,6 +56,7 @@ module DocuSign_eSign
|
|
52
56
|
# Reserved: For DocuSign use only.
|
53
57
|
attr_accessor :delivery_method
|
54
58
|
|
59
|
+
# Reserved for DocuSign.
|
55
60
|
attr_accessor :delivery_method_metadata
|
56
61
|
|
57
62
|
#
|
@@ -66,13 +71,19 @@ module DocuSign_eSign
|
|
66
71
|
# Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters.
|
67
72
|
attr_accessor :email
|
68
73
|
|
74
|
+
# Metadata that indicates whether the `email` property is editable. This property is read-only.
|
69
75
|
attr_accessor :email_metadata
|
70
76
|
|
77
|
+
# An optional complex type that sets a specific email subject and body for this recipient's notification email. **Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`.
|
71
78
|
attr_accessor :email_notification
|
72
79
|
|
80
|
+
#
|
81
|
+
attr_accessor :email_recipient_post_signing_url
|
82
|
+
|
73
83
|
# 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]]`
|
74
84
|
attr_accessor :embedded_recipient_start_url
|
75
85
|
|
86
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
76
87
|
attr_accessor :error_details
|
77
88
|
|
78
89
|
# Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.
|
@@ -81,25 +92,31 @@ module DocuSign_eSign
|
|
81
92
|
# Reserved:
|
82
93
|
attr_accessor :fax_number
|
83
94
|
|
95
|
+
# Reserved for DocuSign.
|
84
96
|
attr_accessor :fax_number_metadata
|
85
97
|
|
86
98
|
# The user's first name. Maximum Length: 50 characters.
|
87
99
|
attr_accessor :first_name
|
88
100
|
|
101
|
+
# Metadata that indicates whether the `firstName` property is editable. This property is read-only.
|
89
102
|
attr_accessor :first_name_metadata
|
90
103
|
|
91
104
|
#
|
92
105
|
attr_accessor :full_name
|
93
106
|
|
107
|
+
# Reserved for DocuSign.
|
94
108
|
attr_accessor :full_name_metadata
|
95
109
|
|
96
110
|
# 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.
|
97
111
|
attr_accessor :id_check_configuration_name
|
98
112
|
|
113
|
+
# Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only.
|
99
114
|
attr_accessor :id_check_configuration_name_metadata
|
100
115
|
|
116
|
+
# An object that contains input information related to a recipient ID check.
|
101
117
|
attr_accessor :id_check_information_input
|
102
118
|
|
119
|
+
# Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).
|
103
120
|
attr_accessor :identity_verification
|
104
121
|
|
105
122
|
# 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.
|
@@ -108,6 +125,7 @@ module DocuSign_eSign
|
|
108
125
|
#
|
109
126
|
attr_accessor :last_name
|
110
127
|
|
128
|
+
# Metadata that indicates whether the `lastName` property is editable. This property is read-only.
|
111
129
|
attr_accessor :last_name_metadata
|
112
130
|
|
113
131
|
#
|
@@ -119,20 +137,25 @@ module DocuSign_eSign
|
|
119
137
|
#
|
120
138
|
attr_accessor :name
|
121
139
|
|
140
|
+
# Metadata that indicates whether the `name` property is editable. This property is read-only.
|
122
141
|
attr_accessor :name_metadata
|
123
142
|
|
124
143
|
# 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.
|
125
144
|
attr_accessor :note
|
126
145
|
|
146
|
+
# Metadata that indicates whether the `note` property is editable. This property is read-only.
|
127
147
|
attr_accessor :note_metadata
|
128
148
|
|
149
|
+
# When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign.
|
129
150
|
attr_accessor :phone_authentication
|
130
151
|
|
152
|
+
# Describes the recipient phone number.
|
131
153
|
attr_accessor :phone_number
|
132
154
|
|
133
155
|
# Reserved:
|
134
156
|
attr_accessor :recipient_attachments
|
135
157
|
|
158
|
+
# Information about the recipient's authentication status. This property is read-only.
|
136
159
|
attr_accessor :recipient_authentication_status
|
137
160
|
|
138
161
|
#
|
@@ -147,11 +170,13 @@ module DocuSign_eSign
|
|
147
170
|
#
|
148
171
|
attr_accessor :recipient_type
|
149
172
|
|
173
|
+
# Metadata that indicates whether the `recipientType` property is editable. This property is read-only.
|
150
174
|
attr_accessor :recipient_type_metadata
|
151
175
|
|
152
176
|
# When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
|
153
177
|
attr_accessor :require_id_lookup
|
154
178
|
|
179
|
+
# Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only.
|
155
180
|
attr_accessor :require_id_lookup_metadata
|
156
181
|
|
157
182
|
# Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.
|
@@ -160,6 +185,7 @@ module DocuSign_eSign
|
|
160
185
|
# Specifies the routing order of the recipient in the envelope.
|
161
186
|
attr_accessor :routing_order
|
162
187
|
|
188
|
+
# Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.
|
163
189
|
attr_accessor :routing_order_metadata
|
164
190
|
|
165
191
|
# The date and time the envelope was sent.
|
@@ -171,6 +197,7 @@ module DocuSign_eSign
|
|
171
197
|
# 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).
|
172
198
|
attr_accessor :signing_group_id
|
173
199
|
|
200
|
+
# Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only.
|
174
201
|
attr_accessor :signing_group_id_metadata
|
175
202
|
|
176
203
|
# The display name for the signing group. Maximum Length: 100 characters.
|
@@ -179,6 +206,7 @@ module DocuSign_eSign
|
|
179
206
|
# A complex type that contains information about users in the signing group.
|
180
207
|
attr_accessor :signing_group_users
|
181
208
|
|
209
|
+
# When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication.
|
182
210
|
attr_accessor :sms_authentication
|
183
211
|
|
184
212
|
# Lists the social ID type that can be used for recipient authentication.
|
@@ -216,6 +244,7 @@ module DocuSign_eSign
|
|
216
244
|
:'auto_responded_reason' => :'autoRespondedReason',
|
217
245
|
:'client_user_id' => :'clientUserId',
|
218
246
|
:'completed_count' => :'completedCount',
|
247
|
+
:'consent_details_list' => :'consentDetailsList',
|
219
248
|
:'custom_fields' => :'customFields',
|
220
249
|
:'declined_date_time' => :'declinedDateTime',
|
221
250
|
:'declined_reason' => :'declinedReason',
|
@@ -228,6 +257,7 @@ module DocuSign_eSign
|
|
228
257
|
:'email' => :'email',
|
229
258
|
:'email_metadata' => :'emailMetadata',
|
230
259
|
:'email_notification' => :'emailNotification',
|
260
|
+
:'email_recipient_post_signing_url' => :'emailRecipientPostSigningURL',
|
231
261
|
:'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
|
232
262
|
:'error_details' => :'errorDetails',
|
233
263
|
:'excluded_documents' => :'excludedDocuments',
|
@@ -293,6 +323,7 @@ module DocuSign_eSign
|
|
293
323
|
:'auto_responded_reason' => :'String',
|
294
324
|
:'client_user_id' => :'String',
|
295
325
|
:'completed_count' => :'String',
|
326
|
+
:'consent_details_list' => :'Array<ConsentDetails>',
|
296
327
|
:'custom_fields' => :'Array<String>',
|
297
328
|
:'declined_date_time' => :'String',
|
298
329
|
:'declined_reason' => :'String',
|
@@ -305,6 +336,7 @@ module DocuSign_eSign
|
|
305
336
|
:'email' => :'String',
|
306
337
|
:'email_metadata' => :'PropertyMetadata',
|
307
338
|
:'email_notification' => :'RecipientEmailNotification',
|
339
|
+
:'email_recipient_post_signing_url' => :'String',
|
308
340
|
:'embedded_recipient_start_url' => :'String',
|
309
341
|
:'error_details' => :'ErrorDetails',
|
310
342
|
:'excluded_documents' => :'Array<String>',
|
@@ -401,6 +433,12 @@ module DocuSign_eSign
|
|
401
433
|
self.completed_count = attributes[:'completedCount']
|
402
434
|
end
|
403
435
|
|
436
|
+
if attributes.has_key?(:'consentDetailsList')
|
437
|
+
if (value = attributes[:'consentDetailsList']).is_a?(Array)
|
438
|
+
self.consent_details_list = value
|
439
|
+
end
|
440
|
+
end
|
441
|
+
|
404
442
|
if attributes.has_key?(:'customFields')
|
405
443
|
if (value = attributes[:'customFields']).is_a?(Array)
|
406
444
|
self.custom_fields = value
|
@@ -453,6 +491,10 @@ module DocuSign_eSign
|
|
453
491
|
self.email_notification = attributes[:'emailNotification']
|
454
492
|
end
|
455
493
|
|
494
|
+
if attributes.has_key?(:'emailRecipientPostSigningURL')
|
495
|
+
self.email_recipient_post_signing_url = attributes[:'emailRecipientPostSigningURL']
|
496
|
+
end
|
497
|
+
|
456
498
|
if attributes.has_key?(:'embeddedRecipientStartURL')
|
457
499
|
self.embedded_recipient_start_url = attributes[:'embeddedRecipientStartURL']
|
458
500
|
end
|
@@ -694,6 +736,7 @@ module DocuSign_eSign
|
|
694
736
|
auto_responded_reason == o.auto_responded_reason &&
|
695
737
|
client_user_id == o.client_user_id &&
|
696
738
|
completed_count == o.completed_count &&
|
739
|
+
consent_details_list == o.consent_details_list &&
|
697
740
|
custom_fields == o.custom_fields &&
|
698
741
|
declined_date_time == o.declined_date_time &&
|
699
742
|
declined_reason == o.declined_reason &&
|
@@ -706,6 +749,7 @@ module DocuSign_eSign
|
|
706
749
|
email == o.email &&
|
707
750
|
email_metadata == o.email_metadata &&
|
708
751
|
email_notification == o.email_notification &&
|
752
|
+
email_recipient_post_signing_url == o.email_recipient_post_signing_url &&
|
709
753
|
embedded_recipient_start_url == o.embedded_recipient_start_url &&
|
710
754
|
error_details == o.error_details &&
|
711
755
|
excluded_documents == o.excluded_documents &&
|
@@ -768,7 +812,7 @@ module DocuSign_eSign
|
|
768
812
|
# Calculates hash code according to all attributes.
|
769
813
|
# @return [Fixnum] Hash code
|
770
814
|
def hash
|
771
|
-
[access_code, access_code_metadata, add_access_code_to_email, additional_notifications, allow_system_override_for_locked_recipient, auto_responded_reason, client_user_id, completed_count, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, 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
|
815
|
+
[access_code, access_code_metadata, add_access_code_to_email, additional_notifications, allow_system_override_for_locked_recipient, auto_responded_reason, client_user_id, completed_count, consent_details_list, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, 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
|
772
816
|
end
|
773
817
|
|
774
818
|
# Builds the object from hash
|
@@ -14,6 +14,12 @@ require 'date'
|
|
14
14
|
module DocuSign_eSign
|
15
15
|
# Contains information about an APP store receipt.
|
16
16
|
class AppStoreReceipt
|
17
|
+
#
|
18
|
+
attr_accessor :downgrade_product_id
|
19
|
+
|
20
|
+
#
|
21
|
+
attr_accessor :is_downgrade_cancellation
|
22
|
+
|
17
23
|
#
|
18
24
|
attr_accessor :product_id
|
19
25
|
|
@@ -23,6 +29,8 @@ module DocuSign_eSign
|
|
23
29
|
# Attribute mapping from ruby-style variable name to JSON key.
|
24
30
|
def self.attribute_map
|
25
31
|
{
|
32
|
+
:'downgrade_product_id' => :'downgradeProductId',
|
33
|
+
:'is_downgrade_cancellation' => :'isDowngradeCancellation',
|
26
34
|
:'product_id' => :'productId',
|
27
35
|
:'receipt_data' => :'receiptData'
|
28
36
|
}
|
@@ -31,6 +39,8 @@ module DocuSign_eSign
|
|
31
39
|
# Attribute type mapping.
|
32
40
|
def self.swagger_types
|
33
41
|
{
|
42
|
+
:'downgrade_product_id' => :'String',
|
43
|
+
:'is_downgrade_cancellation' => :'String',
|
34
44
|
:'product_id' => :'String',
|
35
45
|
:'receipt_data' => :'String'
|
36
46
|
}
|
@@ -44,6 +54,14 @@ module DocuSign_eSign
|
|
44
54
|
# convert string to symbol for hash key
|
45
55
|
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
46
56
|
|
57
|
+
if attributes.has_key?(:'downgradeProductId')
|
58
|
+
self.downgrade_product_id = attributes[:'downgradeProductId']
|
59
|
+
end
|
60
|
+
|
61
|
+
if attributes.has_key?(:'isDowngradeCancellation')
|
62
|
+
self.is_downgrade_cancellation = attributes[:'isDowngradeCancellation']
|
63
|
+
end
|
64
|
+
|
47
65
|
if attributes.has_key?(:'productId')
|
48
66
|
self.product_id = attributes[:'productId']
|
49
67
|
end
|
@@ -71,6 +89,8 @@ module DocuSign_eSign
|
|
71
89
|
def ==(o)
|
72
90
|
return true if self.equal?(o)
|
73
91
|
self.class == o.class &&
|
92
|
+
downgrade_product_id == o.downgrade_product_id &&
|
93
|
+
is_downgrade_cancellation == o.is_downgrade_cancellation &&
|
74
94
|
product_id == o.product_id &&
|
75
95
|
receipt_data == o.receipt_data
|
76
96
|
end
|
@@ -84,7 +104,7 @@ module DocuSign_eSign
|
|
84
104
|
# Calculates hash code according to all attributes.
|
85
105
|
# @return [Fixnum] Hash code
|
86
106
|
def hash
|
87
|
-
[product_id, receipt_data].hash
|
107
|
+
[downgrade_product_id, is_downgrade_cancellation, product_id, receipt_data].hash
|
88
108
|
end
|
89
109
|
|
90
110
|
# Builds the object from hash
|