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
@@ -16,110 +16,138 @@ module DocuSign_eSign
|
|
16
16
|
#
|
17
17
|
attr_accessor :anchor_allow_white_space_in_characters
|
18
18
|
|
19
|
+
# Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.
|
19
20
|
attr_accessor :anchor_allow_white_space_in_characters_metadata
|
20
21
|
|
21
22
|
# When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
|
22
23
|
attr_accessor :anchor_case_sensitive
|
23
24
|
|
25
|
+
# Metadata that indicates whether the `anchorCaseSensitive` property is editable.
|
24
26
|
attr_accessor :anchor_case_sensitive_metadata
|
25
27
|
|
26
28
|
# Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
|
27
29
|
attr_accessor :anchor_horizontal_alignment
|
28
30
|
|
31
|
+
# Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
|
29
32
|
attr_accessor :anchor_horizontal_alignment_metadata
|
30
33
|
|
31
34
|
# When set to **true**, this tab is ignored if anchorString is not found in the document.
|
32
35
|
attr_accessor :anchor_ignore_if_not_present
|
33
36
|
|
37
|
+
# Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.
|
34
38
|
attr_accessor :anchor_ignore_if_not_present_metadata
|
35
39
|
|
36
40
|
# When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.
|
37
41
|
attr_accessor :anchor_match_whole_word
|
38
42
|
|
43
|
+
# Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
|
39
44
|
attr_accessor :anchor_match_whole_word_metadata
|
40
45
|
|
41
46
|
# Anchor text information for a radio button.
|
42
47
|
attr_accessor :anchor_string
|
43
48
|
|
49
|
+
# Metadata that indicates whether the `anchorString` property is editable.
|
44
50
|
attr_accessor :anchor_string_metadata
|
45
51
|
|
46
52
|
#
|
47
53
|
attr_accessor :anchor_tab_processor_version
|
48
54
|
|
55
|
+
# Reserved for DocuSign.
|
49
56
|
attr_accessor :anchor_tab_processor_version_metadata
|
50
57
|
|
51
58
|
# Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
|
52
59
|
attr_accessor :anchor_units
|
53
60
|
|
61
|
+
# Metadata that indicates whether the `anchorUnits` property is editable.
|
54
62
|
attr_accessor :anchor_units_metadata
|
55
63
|
|
56
64
|
# Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
|
57
65
|
attr_accessor :anchor_x_offset
|
58
66
|
|
67
|
+
# Metadata that indicates whether the `anchorXOffset` property is editable.
|
59
68
|
attr_accessor :anchor_x_offset_metadata
|
60
69
|
|
61
70
|
# Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
|
62
71
|
attr_accessor :anchor_y_offset
|
63
72
|
|
73
|
+
# Metadata that indicates whether the `anchorYOffset` property is editable.
|
64
74
|
attr_accessor :anchor_y_offset_metadata
|
65
75
|
|
76
|
+
#
|
77
|
+
attr_accessor :caption
|
78
|
+
|
79
|
+
attr_accessor :caption_metadata
|
80
|
+
|
66
81
|
# For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
|
67
82
|
attr_accessor :conditional_parent_label
|
68
83
|
|
84
|
+
# Metadata that indicates whether the `conditionalParentLabel` property is editable.
|
69
85
|
attr_accessor :conditional_parent_label_metadata
|
70
86
|
|
71
87
|
# For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.
|
72
88
|
attr_accessor :conditional_parent_value
|
73
89
|
|
90
|
+
# Metadata that indicates whether the `conditionalParentValue` property is editable.
|
74
91
|
attr_accessor :conditional_parent_value_metadata
|
75
92
|
|
76
93
|
# The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
|
77
94
|
attr_accessor :custom_tab_id
|
78
95
|
|
96
|
+
# Metadata that indicates whether the `customTabId` property is editable.
|
79
97
|
attr_accessor :custom_tab_id_metadata
|
80
98
|
|
81
99
|
# Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
|
82
100
|
attr_accessor :document_id
|
83
101
|
|
102
|
+
# Metadata that indicates whether the `documentId` property is editable.
|
84
103
|
attr_accessor :document_id_metadata
|
85
104
|
|
105
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
86
106
|
attr_accessor :error_details
|
87
107
|
|
88
108
|
#
|
89
109
|
attr_accessor :form_order
|
90
110
|
|
111
|
+
# Metadata that indicates whether the `formOrder` property is editable.
|
91
112
|
attr_accessor :form_order_metadata
|
92
113
|
|
93
114
|
#
|
94
115
|
attr_accessor :form_page_label
|
95
116
|
|
117
|
+
# Metadata that indicates whether the `formPageLabel` property is editable.
|
96
118
|
attr_accessor :form_page_label_metadata
|
97
119
|
|
98
120
|
#
|
99
121
|
attr_accessor :form_page_number
|
100
122
|
|
123
|
+
# Metadata that indicates whether the `fromPageNumber` property is editable.
|
101
124
|
attr_accessor :form_page_number_metadata
|
102
125
|
|
103
126
|
#
|
104
127
|
attr_accessor :group_label
|
105
128
|
|
129
|
+
# Metadata that indicates whether the `groupLabel` property is editable.
|
106
130
|
attr_accessor :group_label_metadata
|
107
131
|
|
108
132
|
#
|
109
133
|
attr_accessor :group_rule
|
110
134
|
|
135
|
+
# Metadata that indicates whether the `groupRule` property is editable.
|
111
136
|
attr_accessor :group_rule_metadata
|
112
137
|
|
113
138
|
# Height of the tab in pixels.
|
114
139
|
attr_accessor :height
|
115
140
|
|
141
|
+
# Metadata that indicates whether the `height` property is editable.
|
116
142
|
attr_accessor :height_metadata
|
117
143
|
|
118
144
|
#
|
119
145
|
attr_accessor :maximum_allowed
|
120
146
|
|
147
|
+
# Metadata that indicates whether the `maximumAllowed` property is editable.
|
121
148
|
attr_accessor :maximum_allowed_metadata
|
122
149
|
|
150
|
+
# Contains the information necessary to map the tab to a field in SalesForce.
|
123
151
|
attr_accessor :merge_field
|
124
152
|
|
125
153
|
#
|
@@ -128,11 +156,13 @@ module DocuSign_eSign
|
|
128
156
|
#
|
129
157
|
attr_accessor :minimum_required
|
130
158
|
|
159
|
+
# Metadata that indicates whether the `minimumRequired` property is editable.
|
131
160
|
attr_accessor :minimum_required_metadata
|
132
161
|
|
133
162
|
# Specifies the page number on which the tab is located.
|
134
163
|
attr_accessor :page_number
|
135
164
|
|
165
|
+
# Metadata that indicates whether the `pageNumber` property is editable.
|
136
166
|
attr_accessor :page_number_metadata
|
137
167
|
|
138
168
|
# Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
|
@@ -141,10 +171,13 @@ module DocuSign_eSign
|
|
141
171
|
#
|
142
172
|
attr_accessor :recipient_id_guid
|
143
173
|
|
174
|
+
# Metadata that indicates whether the `recipientIdGuid` property is editable.
|
144
175
|
attr_accessor :recipient_id_guid_metadata
|
145
176
|
|
177
|
+
# Metadata that indicates whether the `recipientId` property is editable.
|
146
178
|
attr_accessor :recipient_id_metadata
|
147
179
|
|
180
|
+
# Reserved for DocuSign.
|
148
181
|
attr_accessor :smart_contract_information
|
149
182
|
|
150
183
|
#
|
@@ -153,66 +186,79 @@ module DocuSign_eSign
|
|
153
186
|
# 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.
|
154
187
|
attr_accessor :status
|
155
188
|
|
189
|
+
# Metadata that indicates whether the `status` property is editable.
|
156
190
|
attr_accessor :status_metadata
|
157
191
|
|
158
192
|
#
|
159
193
|
attr_accessor :tab_group_labels
|
160
194
|
|
195
|
+
# Metadata that indicates whether the `tabGroupLabels` property is editable.
|
161
196
|
attr_accessor :tab_group_labels_metadata
|
162
197
|
|
163
198
|
# The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
|
164
199
|
attr_accessor :tab_id
|
165
200
|
|
201
|
+
# Metadata that indicates whether the `tabId` property is editable.
|
166
202
|
attr_accessor :tab_id_metadata
|
167
203
|
|
168
204
|
#
|
169
205
|
attr_accessor :tab_order
|
170
206
|
|
207
|
+
# Metadata that indicates whether the `tabOrder` property is editable.
|
171
208
|
attr_accessor :tab_order_metadata
|
172
209
|
|
173
210
|
#
|
174
211
|
attr_accessor :tab_scope
|
175
212
|
|
213
|
+
# Metadata that indicates whether the `tabScope` property is editable.
|
176
214
|
attr_accessor :tab_scope_metadata
|
177
215
|
|
178
216
|
#
|
179
217
|
attr_accessor :tab_type
|
180
218
|
|
219
|
+
# Metadata that indicates whether the `tabType` property is editable.
|
181
220
|
attr_accessor :tab_type_metadata
|
182
221
|
|
183
222
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
184
223
|
attr_accessor :template_locked
|
185
224
|
|
225
|
+
# Metadata that indicates whether the `templateLocked` property is editable.
|
186
226
|
attr_accessor :template_locked_metadata
|
187
227
|
|
188
228
|
# When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
|
189
229
|
attr_accessor :template_required
|
190
230
|
|
231
|
+
# Metadata that indicates whether the `templateRequired` property is editable.
|
191
232
|
attr_accessor :template_required_metadata
|
192
233
|
|
193
234
|
#
|
194
235
|
attr_accessor :tooltip
|
195
236
|
|
237
|
+
# Metadata that indicates whether the `toolTip` property is editable.
|
196
238
|
attr_accessor :tool_tip_metadata
|
197
239
|
|
198
240
|
# The message displayed if the custom tab fails input validation (either custom of embedded).
|
199
241
|
attr_accessor :validation_message
|
200
242
|
|
243
|
+
# Metadata that indicates whether the `validationMessage` property is editable.
|
201
244
|
attr_accessor :validation_message_metadata
|
202
245
|
|
203
246
|
# Width of the tab in pixels.
|
204
247
|
attr_accessor :width
|
205
248
|
|
249
|
+
# Metadata that indicates whether the `width` property is editable.
|
206
250
|
attr_accessor :width_metadata
|
207
251
|
|
208
252
|
# This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
209
253
|
attr_accessor :x_position
|
210
254
|
|
255
|
+
# Metadata that indicates whether the `xPosition` property is editable.
|
211
256
|
attr_accessor :x_position_metadata
|
212
257
|
|
213
258
|
# This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
214
259
|
attr_accessor :y_position
|
215
260
|
|
261
|
+
# Metadata that indicates whether the `yPosition` property is editable.
|
216
262
|
attr_accessor :y_position_metadata
|
217
263
|
|
218
264
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -238,6 +284,8 @@ module DocuSign_eSign
|
|
238
284
|
:'anchor_x_offset_metadata' => :'anchorXOffsetMetadata',
|
239
285
|
:'anchor_y_offset' => :'anchorYOffset',
|
240
286
|
:'anchor_y_offset_metadata' => :'anchorYOffsetMetadata',
|
287
|
+
:'caption' => :'caption',
|
288
|
+
:'caption_metadata' => :'captionMetadata',
|
241
289
|
:'conditional_parent_label' => :'conditionalParentLabel',
|
242
290
|
:'conditional_parent_label_metadata' => :'conditionalParentLabelMetadata',
|
243
291
|
:'conditional_parent_value' => :'conditionalParentValue',
|
@@ -325,6 +373,8 @@ module DocuSign_eSign
|
|
325
373
|
:'anchor_x_offset_metadata' => :'PropertyMetadata',
|
326
374
|
:'anchor_y_offset' => :'String',
|
327
375
|
:'anchor_y_offset_metadata' => :'PropertyMetadata',
|
376
|
+
:'caption' => :'String',
|
377
|
+
:'caption_metadata' => :'PropertyMetadata',
|
328
378
|
:'conditional_parent_label' => :'String',
|
329
379
|
:'conditional_parent_label_metadata' => :'PropertyMetadata',
|
330
380
|
:'conditional_parent_value' => :'String',
|
@@ -477,6 +527,14 @@ module DocuSign_eSign
|
|
477
527
|
self.anchor_y_offset_metadata = attributes[:'anchorYOffsetMetadata']
|
478
528
|
end
|
479
529
|
|
530
|
+
if attributes.has_key?(:'caption')
|
531
|
+
self.caption = attributes[:'caption']
|
532
|
+
end
|
533
|
+
|
534
|
+
if attributes.has_key?(:'captionMetadata')
|
535
|
+
self.caption_metadata = attributes[:'captionMetadata']
|
536
|
+
end
|
537
|
+
|
480
538
|
if attributes.has_key?(:'conditionalParentLabel')
|
481
539
|
self.conditional_parent_label = attributes[:'conditionalParentLabel']
|
482
540
|
end
|
@@ -762,6 +820,8 @@ module DocuSign_eSign
|
|
762
820
|
anchor_x_offset_metadata == o.anchor_x_offset_metadata &&
|
763
821
|
anchor_y_offset == o.anchor_y_offset &&
|
764
822
|
anchor_y_offset_metadata == o.anchor_y_offset_metadata &&
|
823
|
+
caption == o.caption &&
|
824
|
+
caption_metadata == o.caption_metadata &&
|
765
825
|
conditional_parent_label == o.conditional_parent_label &&
|
766
826
|
conditional_parent_label_metadata == o.conditional_parent_label_metadata &&
|
767
827
|
conditional_parent_value == o.conditional_parent_value &&
|
@@ -834,7 +894,7 @@ module DocuSign_eSign
|
|
834
894
|
# Calculates hash code according to all attributes.
|
835
895
|
# @return [Fixnum] Hash code
|
836
896
|
def hash
|
837
|
-
[anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, document_id, document_id_metadata, error_details, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, group_label, group_label_metadata, group_rule, group_rule_metadata, height, height_metadata, maximum_allowed, maximum_allowed_metadata, merge_field, merge_field_xml, minimum_required, minimum_required_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_order, tab_order_metadata, tab_scope, tab_scope_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, validation_message, validation_message_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
|
897
|
+
[anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, caption, caption_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, document_id, document_id_metadata, error_details, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, group_label, group_label_metadata, group_rule, group_rule_metadata, height, height_metadata, maximum_allowed, maximum_allowed_metadata, merge_field, merge_field_xml, minimum_required, minimum_required_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_order, tab_order_metadata, tab_scope, tab_scope_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, validation_message, validation_message_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
|
838
898
|
end
|
839
899
|
|
840
900
|
# Builds the object from hash
|
@@ -94,6 +94,7 @@ module DocuSign_eSign
|
|
94
94
|
# The userId of the DocuSign user who last modified this object.
|
95
95
|
attr_accessor :last_modified_by_user_id
|
96
96
|
|
97
|
+
# Reserved for DocuSign.
|
97
98
|
attr_accessor :locale_policy
|
98
99
|
|
99
100
|
# When set to **true**, the signer cannot change the data of the custom tab.
|
@@ -102,8 +103,15 @@ module DocuSign_eSign
|
|
102
103
|
# The maximum number of entry characters supported by the custom tab.
|
103
104
|
attr_accessor :maximum_length
|
104
105
|
|
106
|
+
#
|
107
|
+
attr_accessor :max_numerical_value
|
108
|
+
|
109
|
+
# Contains the information necessary to map the tab to a field in SalesForce.
|
105
110
|
attr_accessor :merge_field
|
106
111
|
|
112
|
+
#
|
113
|
+
attr_accessor :min_numerical_value
|
114
|
+
|
107
115
|
#
|
108
116
|
attr_accessor :name
|
109
117
|
|
@@ -137,9 +145,13 @@ module DocuSign_eSign
|
|
137
145
|
# When set to **true**, this custom tab is shared.
|
138
146
|
attr_accessor :shared
|
139
147
|
|
148
|
+
#
|
149
|
+
attr_accessor :signature_provider_id
|
150
|
+
|
140
151
|
#
|
141
152
|
attr_accessor :stamp_type
|
142
153
|
|
154
|
+
# Metadata that indicates whether the `stampType` property is editable.
|
143
155
|
attr_accessor :stamp_type_metadata
|
144
156
|
|
145
157
|
# The label string associated with the tab.
|
@@ -193,7 +205,9 @@ module DocuSign_eSign
|
|
193
205
|
:'locale_policy' => :'localePolicy',
|
194
206
|
:'locked' => :'locked',
|
195
207
|
:'maximum_length' => :'maximumLength',
|
208
|
+
:'max_numerical_value' => :'maxNumericalValue',
|
196
209
|
:'merge_field' => :'mergeField',
|
210
|
+
:'min_numerical_value' => :'minNumericalValue',
|
197
211
|
:'name' => :'name',
|
198
212
|
:'numerical_value' => :'numericalValue',
|
199
213
|
:'payment_item_code' => :'paymentItemCode',
|
@@ -205,6 +219,7 @@ module DocuSign_eSign
|
|
205
219
|
:'scale_value' => :'scaleValue',
|
206
220
|
:'selected' => :'selected',
|
207
221
|
:'shared' => :'shared',
|
222
|
+
:'signature_provider_id' => :'signatureProviderId',
|
208
223
|
:'stamp_type' => :'stampType',
|
209
224
|
:'stamp_type_metadata' => :'stampTypeMetadata',
|
210
225
|
:'tab_label' => :'tabLabel',
|
@@ -249,7 +264,9 @@ module DocuSign_eSign
|
|
249
264
|
:'locale_policy' => :'LocalePolicyTab',
|
250
265
|
:'locked' => :'String',
|
251
266
|
:'maximum_length' => :'String',
|
267
|
+
:'max_numerical_value' => :'String',
|
252
268
|
:'merge_field' => :'MergeField',
|
269
|
+
:'min_numerical_value' => :'String',
|
253
270
|
:'name' => :'String',
|
254
271
|
:'numerical_value' => :'String',
|
255
272
|
:'payment_item_code' => :'String',
|
@@ -261,6 +278,7 @@ module DocuSign_eSign
|
|
261
278
|
:'scale_value' => :'String',
|
262
279
|
:'selected' => :'String',
|
263
280
|
:'shared' => :'String',
|
281
|
+
:'signature_provider_id' => :'String',
|
264
282
|
:'stamp_type' => :'String',
|
265
283
|
:'stamp_type_metadata' => :'PropertyMetadata',
|
266
284
|
:'tab_label' => :'String',
|
@@ -402,10 +420,18 @@ module DocuSign_eSign
|
|
402
420
|
self.maximum_length = attributes[:'maximumLength']
|
403
421
|
end
|
404
422
|
|
423
|
+
if attributes.has_key?(:'maxNumericalValue')
|
424
|
+
self.max_numerical_value = attributes[:'maxNumericalValue']
|
425
|
+
end
|
426
|
+
|
405
427
|
if attributes.has_key?(:'mergeField')
|
406
428
|
self.merge_field = attributes[:'mergeField']
|
407
429
|
end
|
408
430
|
|
431
|
+
if attributes.has_key?(:'minNumericalValue')
|
432
|
+
self.min_numerical_value = attributes[:'minNumericalValue']
|
433
|
+
end
|
434
|
+
|
409
435
|
if attributes.has_key?(:'name')
|
410
436
|
self.name = attributes[:'name']
|
411
437
|
end
|
@@ -450,6 +476,10 @@ module DocuSign_eSign
|
|
450
476
|
self.shared = attributes[:'shared']
|
451
477
|
end
|
452
478
|
|
479
|
+
if attributes.has_key?(:'signatureProviderId')
|
480
|
+
self.signature_provider_id = attributes[:'signatureProviderId']
|
481
|
+
end
|
482
|
+
|
453
483
|
if attributes.has_key?(:'stampType')
|
454
484
|
self.stamp_type = attributes[:'stampType']
|
455
485
|
end
|
@@ -531,7 +561,9 @@ module DocuSign_eSign
|
|
531
561
|
locale_policy == o.locale_policy &&
|
532
562
|
locked == o.locked &&
|
533
563
|
maximum_length == o.maximum_length &&
|
564
|
+
max_numerical_value == o.max_numerical_value &&
|
534
565
|
merge_field == o.merge_field &&
|
566
|
+
min_numerical_value == o.min_numerical_value &&
|
535
567
|
name == o.name &&
|
536
568
|
numerical_value == o.numerical_value &&
|
537
569
|
payment_item_code == o.payment_item_code &&
|
@@ -543,6 +575,7 @@ module DocuSign_eSign
|
|
543
575
|
scale_value == o.scale_value &&
|
544
576
|
selected == o.selected &&
|
545
577
|
shared == o.shared &&
|
578
|
+
signature_provider_id == o.signature_provider_id &&
|
546
579
|
stamp_type == o.stamp_type &&
|
547
580
|
stamp_type_metadata == o.stamp_type_metadata &&
|
548
581
|
tab_label == o.tab_label &&
|
@@ -562,7 +595,7 @@ module DocuSign_eSign
|
|
562
595
|
# Calculates hash code according to all attributes.
|
563
596
|
# @return [Fixnum] Hash code
|
564
597
|
def hash
|
565
|
-
[anchor, anchor_case_sensitive, anchor_horizontal_alignment, anchor_ignore_if_not_present, anchor_match_whole_word, anchor_units, anchor_x_offset, anchor_y_offset, bold, collaborative, conceal_value_on_document, created_by_display_name, created_by_user_id, custom_tab_id, disable_auto_size, editable, font, font_color, font_size, height, included_in_email, initial_value, italic, items, last_modified, last_modified_by_display_name, last_modified_by_user_id, locale_policy, locked, maximum_length, merge_field, name, numerical_value, payment_item_code, payment_item_description, payment_item_name, require_all, required, require_initial_on_shared_change, scale_value, selected, shared, stamp_type, stamp_type_metadata, tab_label, type, underline, validation_message, validation_pattern, width].hash
|
598
|
+
[anchor, anchor_case_sensitive, anchor_horizontal_alignment, anchor_ignore_if_not_present, anchor_match_whole_word, anchor_units, anchor_x_offset, anchor_y_offset, bold, collaborative, conceal_value_on_document, created_by_display_name, created_by_user_id, custom_tab_id, disable_auto_size, editable, font, font_color, font_size, height, included_in_email, initial_value, italic, items, last_modified, last_modified_by_display_name, last_modified_by_user_id, locale_policy, locked, maximum_length, max_numerical_value, merge_field, min_numerical_value, name, numerical_value, payment_item_code, payment_item_description, payment_item_name, require_all, required, require_initial_on_shared_change, scale_value, selected, shared, signature_provider_id, stamp_type, stamp_type_metadata, tab_label, type, underline, validation_message, validation_pattern, width].hash
|
566
599
|
end
|
567
600
|
|
568
601
|
# Builds the object from hash
|
@@ -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
|
+
# Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients.
|
15
16
|
class Tabs
|
16
17
|
# Specifies a tag on the document where you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tag during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history.
|
17
18
|
attr_accessor :approve_tabs
|
@@ -97,6 +98,7 @@ module DocuSign_eSign
|
|
97
98
|
#
|
98
99
|
attr_accessor :poly_line_overlay_tabs
|
99
100
|
|
101
|
+
# Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields
|
100
102
|
attr_accessor :prefill_tabs
|
101
103
|
|
102
104
|
# Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document.
|
@@ -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
|
+
# A list of `documentVisibility` objects that specify whether the documents associated with a template are visible to recipients.
|
15
16
|
class TemplateDocumentVisibilityList
|
16
17
|
#
|
17
18
|
attr_accessor :document_visibility
|
@@ -13,11 +13,13 @@ require 'date'
|
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
15
|
class TemplateNotificationRequest
|
16
|
+
# A complex element that specifies the expiration settings for the envelope.
|
16
17
|
attr_accessor :expirations
|
17
18
|
|
18
19
|
#
|
19
20
|
attr_accessor :password
|
20
21
|
|
22
|
+
# A complex element that specifies reminder settings for the envelope.
|
21
23
|
attr_accessor :reminders
|
22
24
|
|
23
25
|
# When set to **true**, the account default notification settings are used for the envelope.
|
@@ -28,6 +28,7 @@ module DocuSign_eSign
|
|
28
28
|
#
|
29
29
|
attr_accessor :editors
|
30
30
|
|
31
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
31
32
|
attr_accessor :error_details
|
32
33
|
|
33
34
|
# Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.
|
@@ -39,6 +40,9 @@ module DocuSign_eSign
|
|
39
40
|
#
|
40
41
|
attr_accessor :notaries
|
41
42
|
|
43
|
+
#
|
44
|
+
attr_accessor :participants
|
45
|
+
|
42
46
|
# The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with: * recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded. * includeDocuments - When set to **true**, the envelope time zone information is included in the message.
|
43
47
|
attr_accessor :recipient_count
|
44
48
|
|
@@ -63,6 +67,7 @@ module DocuSign_eSign
|
|
63
67
|
:'in_person_signers' => :'inPersonSigners',
|
64
68
|
:'intermediaries' => :'intermediaries',
|
65
69
|
:'notaries' => :'notaries',
|
70
|
+
:'participants' => :'participants',
|
66
71
|
:'recipient_count' => :'recipientCount',
|
67
72
|
:'seals' => :'seals',
|
68
73
|
:'signers' => :'signers',
|
@@ -82,6 +87,7 @@ module DocuSign_eSign
|
|
82
87
|
:'in_person_signers' => :'Array<InPersonSigner>',
|
83
88
|
:'intermediaries' => :'Array<Intermediary>',
|
84
89
|
:'notaries' => :'Array<NotaryRecipient>',
|
90
|
+
:'participants' => :'Array<Participant>',
|
85
91
|
:'recipient_count' => :'String',
|
86
92
|
:'seals' => :'Array<SealSign>',
|
87
93
|
:'signers' => :'Array<Signer>',
|
@@ -147,6 +153,12 @@ module DocuSign_eSign
|
|
147
153
|
end
|
148
154
|
end
|
149
155
|
|
156
|
+
if attributes.has_key?(:'participants')
|
157
|
+
if (value = attributes[:'participants']).is_a?(Array)
|
158
|
+
self.participants = value
|
159
|
+
end
|
160
|
+
end
|
161
|
+
|
150
162
|
if attributes.has_key?(:'recipientCount')
|
151
163
|
self.recipient_count = attributes[:'recipientCount']
|
152
164
|
end
|
@@ -197,6 +209,7 @@ module DocuSign_eSign
|
|
197
209
|
in_person_signers == o.in_person_signers &&
|
198
210
|
intermediaries == o.intermediaries &&
|
199
211
|
notaries == o.notaries &&
|
212
|
+
participants == o.participants &&
|
200
213
|
recipient_count == o.recipient_count &&
|
201
214
|
seals == o.seals &&
|
202
215
|
signers == o.signers &&
|
@@ -212,7 +225,7 @@ module DocuSign_eSign
|
|
212
225
|
# Calculates hash code according to all attributes.
|
213
226
|
# @return [Fixnum] Hash code
|
214
227
|
def hash
|
215
|
-
[agents, carbon_copies, certified_deliveries, current_routing_order, editors, error_details, in_person_signers, intermediaries, notaries, recipient_count, seals, signers, witnesses].hash
|
228
|
+
[agents, carbon_copies, certified_deliveries, current_routing_order, editors, error_details, in_person_signers, intermediaries, notaries, participants, recipient_count, seals, signers, witnesses].hash
|
216
229
|
end
|
217
230
|
|
218
231
|
# Builds the object from hash
|
@@ -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
|
+
# Information about a specific role.
|
15
16
|
class TemplateRole
|
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
|
@@ -28,6 +29,7 @@ module DocuSign_eSign
|
|
28
29
|
# Specifies the email associated with a role name.
|
29
30
|
attr_accessor :email
|
30
31
|
|
32
|
+
# 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`.
|
31
33
|
attr_accessor :email_notification
|
32
34
|
|
33
35
|
# 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]]`
|
@@ -39,6 +41,7 @@ module DocuSign_eSign
|
|
39
41
|
# Specifies the recipient's name.
|
40
42
|
attr_accessor :name
|
41
43
|
|
44
|
+
# Describes the recipient phone number.
|
42
45
|
attr_accessor :phone_number
|
43
46
|
|
44
47
|
#
|
@@ -53,6 +56,7 @@ module DocuSign_eSign
|
|
53
56
|
# 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).
|
54
57
|
attr_accessor :signing_group_id
|
55
58
|
|
59
|
+
# A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.
|
56
60
|
attr_accessor :tabs
|
57
61
|
|
58
62
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -12,9 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# Information about shared templates.
|
15
16
|
class TemplateSharedItem
|
17
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
16
18
|
attr_accessor :error_details
|
17
19
|
|
20
|
+
# Information about the user who owns the template.
|
18
21
|
attr_accessor :owner
|
19
22
|
|
20
23
|
#
|
@@ -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
|
+
# Summary of a template request.
|
15
16
|
class TemplateSummary
|
16
17
|
# Reserved: TBD
|
17
18
|
attr_accessor :applied
|
@@ -22,6 +23,7 @@ module DocuSign_eSign
|
|
22
23
|
#
|
23
24
|
attr_accessor :document_name
|
24
25
|
|
26
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
25
27
|
attr_accessor :error_details
|
26
28
|
|
27
29
|
#
|
@@ -30,6 +32,7 @@ module DocuSign_eSign
|
|
30
32
|
# The unique identifier of the template. If this is not provided, DocuSign will generate a value.
|
31
33
|
attr_accessor :template_id
|
32
34
|
|
35
|
+
#
|
33
36
|
attr_accessor :template_match
|
34
37
|
|
35
38
|
#
|
@@ -97,6 +97,7 @@ module DocuSign_eSign
|
|
97
97
|
#
|
98
98
|
attr_accessor :poly_line_overlay_tabs
|
99
99
|
|
100
|
+
# Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields
|
100
101
|
attr_accessor :prefill_tabs
|
101
102
|
|
102
103
|
# Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document.
|
@@ -13,16 +13,19 @@ require 'date'
|
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
15
|
class TemplateUpdateSummary
|
16
|
+
# An object that describes the status of the bulk send envelopes.
|
16
17
|
attr_accessor :bulk_envelope_status
|
17
18
|
|
18
19
|
# The envelope ID of the envelope status that failed to post.
|
19
20
|
attr_accessor :envelope_id
|
20
21
|
|
22
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
21
23
|
attr_accessor :error_details
|
22
24
|
|
23
25
|
#
|
24
26
|
attr_accessor :list_custom_field_update_results
|
25
27
|
|
28
|
+
# Provides lock information about an envelope that a user has locked.
|
26
29
|
attr_accessor :lock_information
|
27
30
|
|
28
31
|
#
|
@@ -31,6 +34,7 @@ module DocuSign_eSign
|
|
31
34
|
#
|
32
35
|
attr_accessor :recipient_update_results
|
33
36
|
|
37
|
+
#
|
34
38
|
attr_accessor :tab_update_results
|
35
39
|
|
36
40
|
#
|