docusign_esign 3.12.0 → 3.19.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +54 -0
- data/docusign_esign.gemspec +5 -5
- data/lib/docusign_esign/api/accounts_api.rb +83 -433
- data/lib/docusign_esign/api/billing_api.rb +12 -4
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +93 -26
- data/lib/docusign_esign/api/bulk_process_data_api.rb +412 -0
- data/lib/docusign_esign/api/bulk_process_data_send_api.rb +252 -0
- data/lib/docusign_esign/api/connect_api.rb +239 -5
- data/lib/docusign_esign/api/email_archive_api.rb +8 -8
- data/lib/docusign_esign/api/envelopes_api.rb +1435 -207
- data/lib/docusign_esign/api/notary_api.rb +16 -16
- data/lib/docusign_esign/api/organizations_api.rb +8 -60
- data/lib/docusign_esign/api/power_forms_api.rb +24 -16
- data/lib/docusign_esign/api/templates_api.rb +20 -79
- data/lib/docusign_esign/api/users_api.rb +22 -14
- data/lib/docusign_esign/api/workspaces_api.rb +4 -4
- data/lib/docusign_esign/client/api_client.rb +16 -10
- data/lib/docusign_esign/client/api_error.rb +1 -1
- data/lib/docusign_esign/client/auth/oauth.rb +1 -1
- data/lib/docusign_esign/models/access_code_format.rb +6 -0
- data/lib/docusign_esign/models/account_billing_plan.rb +25 -4
- data/lib/docusign_esign/models/account_billing_plan_response.rb +37 -10
- data/lib/docusign_esign/models/account_identity_verification_step.rb +1 -0
- data/lib/docusign_esign/models/account_identity_verification_workflow.rb +2 -0
- data/lib/docusign_esign/models/account_information.rb +11 -1
- data/lib/docusign_esign/models/account_notification.rb +3 -0
- data/lib/docusign_esign/models/account_password_questions_required.rb +1 -0
- data/lib/docusign_esign/models/account_password_rules.rb +7 -0
- data/lib/docusign_esign/models/account_role_settings.rb +81 -4
- data/lib/docusign_esign/models/account_settings_information.rb +1075 -13
- data/lib/docusign_esign/models/account_shared_access.rb +1 -0
- data/lib/docusign_esign/models/account_signature.rb +2 -0
- data/lib/docusign_esign/models/account_signature_definition.rb +1 -0
- data/lib/docusign_esign/models/account_signature_provider.rb +1 -0
- data/lib/docusign_esign/models/account_signature_provider_option.rb +1 -0
- data/lib/docusign_esign/models/account_ui_settings.rb +28 -13
- data/lib/docusign_esign/models/address_information_input.rb +1 -0
- data/lib/docusign_esign/models/agent.rb +45 -1
- data/lib/docusign_esign/models/app_store_receipt.rb +21 -1
- data/lib/docusign_esign/models/approve.rb +65 -1
- data/lib/docusign_esign/models/authentication_status.rb +19 -0
- data/lib/docusign_esign/models/bcc_email_archive.rb +3 -0
- data/lib/docusign_esign/models/bcc_email_archive_history.rb +2 -0
- data/lib/docusign_esign/models/bcc_email_archive_list.rb +1 -0
- data/lib/docusign_esign/models/billing_charge.rb +1 -1
- data/lib/docusign_esign/models/billing_entity_information_response.rb +214 -0
- data/lib/docusign_esign/models/billing_invoice_item.rb +21 -1
- data/lib/docusign_esign/models/billing_invoices_summary.rb +21 -1
- data/lib/docusign_esign/models/billing_plan_information.rb +52 -4
- data/lib/docusign_esign/models/billing_plan_preview.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_response.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_update_response.rb +1 -0
- data/lib/docusign_esign/models/brand.rb +4 -0
- data/lib/docusign_esign/models/brand_email_content.rb +1 -0
- data/lib/docusign_esign/models/brand_link.rb +1 -0
- data/lib/docusign_esign/models/brand_logos.rb +1 -0
- data/lib/docusign_esign/models/brand_request.rb +1 -0
- data/lib/docusign_esign/models/brand_resource_urls.rb +1 -0
- data/lib/docusign_esign/models/brand_resources.rb +3 -0
- data/lib/docusign_esign/models/brands_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_envelope.rb +1 -0
- data/lib/docusign_esign/models/bulk_process_request.rb +194 -0
- data/lib/docusign_esign/models/bulk_process_response.rb +248 -0
- data/lib/docusign_esign/models/bulk_process_result.rb +206 -0
- data/lib/docusign_esign/models/bulk_processing_list_summaries.rb +186 -0
- data/lib/docusign_esign/models/bulk_processing_list_summary.rb +214 -0
- data/lib/docusign_esign/models/bulk_processing_lists.rb +186 -0
- data/lib/docusign_esign/models/bulk_recipients_update_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_action_request.rb +204 -0
- data/lib/docusign_esign/models/bulk_send_batch_error.rb +194 -0
- data/lib/docusign_esign/models/bulk_send_batch_status.rb +42 -1
- data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +22 -1
- data/lib/docusign_esign/models/bulk_send_batch_summary.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_envelopes_info.rb +304 -0
- data/lib/docusign_esign/models/bulk_send_error_status.rb +12 -1
- data/lib/docusign_esign/models/bulk_send_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_test_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +5 -0
- data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list_summary.rb +1 -0
- data/lib/docusign_esign/models/captive_recipient.rb +2 -0
- data/lib/docusign_esign/models/captive_recipient_information.rb +1 -0
- data/lib/docusign_esign/models/carbon_copy.rb +48 -1
- data/lib/docusign_esign/models/certified_delivery.rb +47 -1
- data/lib/docusign_esign/models/checkbox.rb +109 -1
- data/lib/docusign_esign/models/chunked_upload_part.rb +1 -0
- data/lib/docusign_esign/models/chunked_upload_request.rb +1 -0
- data/lib/docusign_esign/models/chunked_upload_response.rb +1 -0
- data/lib/docusign_esign/models/cloud_storage_provider.rb +2 -0
- data/lib/docusign_esign/models/comment_thread.rb +63 -1
- data/lib/docusign_esign/models/commission_county.rb +72 -1
- data/lib/docusign_esign/models/commission_expiration.rb +72 -1
- data/lib/docusign_esign/models/commission_number.rb +72 -1
- data/lib/docusign_esign/models/commission_state.rb +72 -1
- data/lib/docusign_esign/models/company.rb +72 -1
- data/lib/docusign_esign/models/composite_template.rb +2 -0
- data/lib/docusign_esign/models/conditional_recipient_rule.rb +2 -0
- data/lib/docusign_esign/models/connect_config_results.rb +1 -0
- data/lib/docusign_esign/models/connect_custom_configuration.rb +60 -4
- data/lib/docusign_esign/models/connect_debug_log.rb +1 -0
- data/lib/docusign_esign/models/connect_delete_failure_result.rb +174 -0
- data/lib/docusign_esign/models/connect_event_data.rb +1 -0
- data/lib/docusign_esign/models/connect_failure_filter.rb +1 -0
- data/lib/docusign_esign/models/connect_failure_result.rb +1 -0
- data/lib/docusign_esign/models/connect_historical_envelope_republish.rb +195 -0
- data/lib/docusign_esign/models/connect_log.rb +1 -0
- data/lib/docusign_esign/models/connect_o_auth_config.rb +214 -0
- data/lib/docusign_esign/models/connect_salesforce_field.rb +1 -0
- data/lib/docusign_esign/models/connect_salesforce_object.rb +1 -0
- data/lib/docusign_esign/models/connect_user_info.rb +214 -0
- data/lib/docusign_esign/models/consent_details.rb +204 -0
- data/lib/docusign_esign/models/console_view_request.rb +1 -0
- data/lib/docusign_esign/models/consumer_disclosure.rb +3 -0
- data/lib/docusign_esign/models/contact.rb +12 -1
- data/lib/docusign_esign/models/contact_get_response.rb +1 -0
- data/lib/docusign_esign/models/contact_mod_request.rb +1 -0
- data/lib/docusign_esign/models/contact_phone_number.rb +1 -0
- data/lib/docusign_esign/models/contact_update_response.rb +1 -0
- data/lib/docusign_esign/models/correct_view_request.rb +12 -1
- data/lib/docusign_esign/models/credit_card_information.rb +2 -0
- data/lib/docusign_esign/models/currency.rb +95 -1
- data/lib/docusign_esign/models/currency_feature_set_price.rb +1 -0
- data/lib/docusign_esign/models/currency_plan_price.rb +1 -0
- data/lib/docusign_esign/models/custom_field.rb +2 -0
- data/lib/docusign_esign/models/date.rb +98 -1
- data/lib/docusign_esign/models/date_signed.rb +66 -1
- data/lib/docusign_esign/models/date_stamp_properties.rb +1 -0
- data/lib/docusign_esign/models/decline.rb +66 -1
- data/lib/docusign_esign/models/delayed_routing.rb +206 -0
- data/lib/docusign_esign/models/delayed_routing_api_model.rb +206 -0
- data/lib/docusign_esign/models/delegation_info.rb +214 -0
- data/lib/docusign_esign/models/direct_debit_processor_information.rb +1 -0
- data/lib/docusign_esign/models/document.rb +3 -0
- data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +1 -0
- data/lib/docusign_esign/models/document_html_definition.rb +1 -0
- data/lib/docusign_esign/models/document_html_definition_original.rb +1 -0
- data/lib/docusign_esign/models/document_html_display_anchor.rb +1 -0
- data/lib/docusign_esign/models/document_html_display_settings.rb +1 -0
- data/lib/docusign_esign/models/document_template.rb +1 -0
- data/lib/docusign_esign/models/document_visibility.rb +2 -0
- data/lib/docusign_esign/models/document_visibility_list.rb +1 -0
- data/lib/docusign_esign/models/downgrad_request_billing_info_response.rb +1 -0
- data/lib/docusign_esign/models/downgrade_billing_plan_information.rb +1 -0
- data/lib/docusign_esign/models/downgrade_plan_update_response.rb +11 -1
- data/lib/docusign_esign/models/downgrade_request_information.rb +204 -0
- data/lib/docusign_esign/models/draw.rb +60 -1
- data/lib/docusign_esign/models/e_note_configuration.rb +1 -0
- data/lib/docusign_esign/models/editor.rb +46 -1
- data/lib/docusign_esign/models/email.rb +98 -1
- data/lib/docusign_esign/models/email_address.rb +66 -1
- data/lib/docusign_esign/models/envelope.rb +20 -1
- data/lib/docusign_esign/models/envelope_attachment.rb +1 -0
- data/lib/docusign_esign/models/envelope_custom_metadata.rb +186 -0
- data/lib/docusign_esign/models/envelope_definition.rb +23 -1
- data/lib/docusign_esign/models/envelope_delay_rule.rb +194 -0
- data/lib/docusign_esign/models/envelope_delay_rule_api_model.rb +195 -0
- data/lib/docusign_esign/models/envelope_document.rb +7 -0
- data/lib/docusign_esign/models/envelope_event.rb +1 -0
- data/lib/docusign_esign/models/envelope_form_data.rb +2 -0
- data/lib/docusign_esign/models/envelope_id.rb +65 -1
- data/lib/docusign_esign/models/envelope_ids_request.rb +1 -0
- data/lib/docusign_esign/models/envelope_notification_request.rb +3 -0
- data/lib/docusign_esign/models/envelope_publish_transaction.rb +307 -0
- data/lib/docusign_esign/models/envelope_publish_transaction_error_rollup.rb +194 -0
- data/lib/docusign_esign/models/envelope_purge_configuration.rb +1 -0
- data/lib/docusign_esign/models/envelope_summary.rb +3 -0
- data/lib/docusign_esign/models/envelope_template.rb +22 -1
- data/lib/docusign_esign/models/envelope_template_results.rb +1 -0
- data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -0
- data/lib/docusign_esign/models/envelope_transfer_rule.rb +6 -0
- data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +4 -0
- data/lib/docusign_esign/models/envelope_update_summary.rb +4 -0
- data/lib/docusign_esign/models/envelopes_information.rb +1 -0
- data/lib/docusign_esign/models/event_notification.rb +24 -1
- data/lib/docusign_esign/models/event_result.rb +1 -0
- data/lib/docusign_esign/models/external_document_sources.rb +6 -0
- data/lib/docusign_esign/models/external_file.rb +1 -0
- data/lib/docusign_esign/models/external_folder.rb +1 -0
- data/lib/docusign_esign/models/external_primary_account_recipient_auth_requirements.rb +214 -0
- data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -0
- data/lib/docusign_esign/models/favorite_templates_info.rb +1 -0
- data/lib/docusign_esign/models/feature_set.rb +1 -0
- data/lib/docusign_esign/models/filter.rb +1 -0
- data/lib/docusign_esign/models/first_name.rb +66 -1
- data/lib/docusign_esign/models/folder.rb +4 -0
- data/lib/docusign_esign/models/folder_item_response.rb +1 -0
- data/lib/docusign_esign/models/folder_item_v2.rb +13 -1
- data/lib/docusign_esign/models/folder_shared_item.rb +3 -0
- data/lib/docusign_esign/models/folders_request.rb +1 -0
- data/lib/docusign_esign/models/form_data_item.rb +1 -0
- data/lib/docusign_esign/models/formula_tab.rb +103 -1
- data/lib/docusign_esign/models/full_name.rb +66 -1
- data/lib/docusign_esign/models/group.rb +13 -1
- data/lib/docusign_esign/models/id_check_configuration.rb +1 -0
- data/lib/docusign_esign/models/id_check_information_input.rb +4 -0
- data/lib/docusign_esign/models/id_evidence_resource_token.rb +194 -0
- data/lib/docusign_esign/models/id_evidence_view_link.rb +184 -0
- data/lib/docusign_esign/models/in_person_signer.rb +31 -0
- data/lib/docusign_esign/models/initial_here.rb +60 -1
- data/lib/docusign_esign/models/inline_template.rb +3 -0
- data/lib/docusign_esign/models/integrated_connect_user_info_list.rb +246 -0
- data/lib/docusign_esign/models/intermediary.rb +46 -1
- data/lib/docusign_esign/models/jurisdiction.rb +1 -0
- data/lib/docusign_esign/models/last_name.rb +66 -1
- data/lib/docusign_esign/models/linked_external_primary_account.rb +21 -1
- data/lib/docusign_esign/models/list.rb +112 -1
- data/lib/docusign_esign/models/list_custom_field.rb +2 -0
- data/lib/docusign_esign/models/list_item.rb +4 -0
- data/lib/docusign_esign/models/locale_policy.rb +13 -0
- data/lib/docusign_esign/models/lock_information.rb +2 -0
- data/lib/docusign_esign/models/lock_request.rb +1 -0
- data/lib/docusign_esign/models/member_group_shared_item.rb +3 -0
- data/lib/docusign_esign/models/member_shared_items.rb +3 -0
- data/lib/docusign_esign/models/merge_field.rb +6 -0
- data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -0
- data/lib/docusign_esign/models/money.rb +1 -0
- data/lib/docusign_esign/models/name_value.rb +2 -0
- data/lib/docusign_esign/models/new_account_definition.rb +53 -4
- data/lib/docusign_esign/models/new_account_summary.rb +1 -0
- data/lib/docusign_esign/models/new_user.rb +2 -0
- data/lib/docusign_esign/models/new_users_summary.rb +1 -0
- data/lib/docusign_esign/models/notarize.rb +58 -1
- data/lib/docusign_esign/models/notary.rb +1 -0
- data/lib/docusign_esign/models/notary_host.rb +20 -0
- data/lib/docusign_esign/models/notary_journal.rb +2 -0
- data/lib/docusign_esign/models/notary_jurisdiction.rb +3 -0
- data/lib/docusign_esign/models/notary_jurisdiction_list.rb +1 -0
- data/lib/docusign_esign/models/notary_recipient.rb +93 -1
- data/lib/docusign_esign/models/notary_result.rb +2 -0
- data/lib/docusign_esign/models/notary_seal.rb +59 -1
- data/lib/docusign_esign/models/note.rb +67 -1
- data/lib/docusign_esign/models/notification.rb +2 -0
- data/lib/docusign_esign/models/notification_default_settings.rb +3 -0
- data/lib/docusign_esign/models/notification_defaults.rb +2 -0
- data/lib/docusign_esign/models/number.rb +100 -1
- data/lib/docusign_esign/models/page.rb +1 -0
- data/lib/docusign_esign/models/participant.rb +908 -0
- data/lib/docusign_esign/models/payment_details.rb +16 -1
- data/lib/docusign_esign/models/payment_gateway_account.rb +3 -0
- data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +1 -0
- data/lib/docusign_esign/models/payment_line_item.rb +1 -0
- data/lib/docusign_esign/models/payment_method_with_options.rb +1 -0
- data/lib/docusign_esign/models/payment_processor_information.rb +1 -0
- data/lib/docusign_esign/models/permission_profile.rb +2 -0
- data/lib/docusign_esign/models/permission_profile_information.rb +1 -0
- data/lib/docusign_esign/models/phone_number.rb +72 -1
- data/lib/docusign_esign/models/poly_line_overlay.rb +60 -1
- data/lib/docusign_esign/models/power_form.rb +2 -0
- data/lib/docusign_esign/models/power_form_recipient.rb +1 -0
- data/lib/docusign_esign/models/power_form_senders_response.rb +1 -0
- data/lib/docusign_esign/models/power_forms_response.rb +1 -0
- data/lib/docusign_esign/models/prefill_tabs.rb +65 -4
- data/lib/docusign_esign/models/property_metadata.rb +1 -0
- data/lib/docusign_esign/models/radio.rb +48 -1
- data/lib/docusign_esign/models/radio_group.rb +78 -4
- data/lib/docusign_esign/models/recipient_additional_notification.rb +3 -0
- data/lib/docusign_esign/models/recipient_email_notification.rb +3 -0
- data/lib/docusign_esign/models/recipient_group.rb +1 -0
- data/lib/docusign_esign/models/recipient_identity_phone_number.rb +44 -4
- data/lib/docusign_esign/models/recipient_identity_verification.rb +15 -4
- data/lib/docusign_esign/models/recipient_names_response.rb +1 -0
- data/lib/docusign_esign/models/recipient_option.rb +1 -0
- data/lib/docusign_esign/models/recipient_phone_authentication.rb +4 -0
- data/lib/docusign_esign/models/recipient_phone_number.rb +3 -0
- data/lib/docusign_esign/models/recipient_preview_request.rb +2 -0
- data/lib/docusign_esign/models/recipient_proof_file.rb +1 -0
- data/lib/docusign_esign/models/recipient_routing.rb +2 -0
- data/lib/docusign_esign/models/recipient_signature_provider.rb +3 -0
- data/lib/docusign_esign/models/recipient_signature_provider_options.rb +5 -0
- data/lib/docusign_esign/models/recipient_sms_authentication.rb +1 -0
- data/lib/docusign_esign/models/recipient_token_client_ur_ls.rb +102 -2
- data/lib/docusign_esign/models/recipient_update_response.rb +3 -0
- data/lib/docusign_esign/models/recipient_view_request.rb +2 -0
- data/lib/docusign_esign/models/recipients.rb +14 -1
- data/lib/docusign_esign/models/recipients_update_summary.rb +1 -0
- data/lib/docusign_esign/models/reserved_domain_existence.rb +194 -0
- data/lib/docusign_esign/models/return_url_request.rb +1 -0
- data/lib/docusign_esign/models/scheduled_sending.rb +216 -0
- data/lib/docusign_esign/models/scheduled_sending_api_model.rb +206 -0
- data/lib/docusign_esign/models/seal_sign.rb +17 -0
- data/lib/docusign_esign/models/seat_discount.rb +1 -0
- data/lib/docusign_esign/models/sender_company.rb +65 -1
- data/lib/docusign_esign/models/sender_email_notifications.rb +12 -1
- data/lib/docusign_esign/models/sender_name.rb +65 -1
- data/lib/docusign_esign/models/settings_metadata.rb +1 -0
- data/lib/docusign_esign/models/shared_item.rb +3 -0
- data/lib/docusign_esign/models/sign_here.rb +62 -1
- data/lib/docusign_esign/models/signature_provider_required_option.rb +1 -0
- data/lib/docusign_esign/models/signature_type.rb +1 -0
- data/lib/docusign_esign/models/signer.rb +84 -1
- data/lib/docusign_esign/models/signer_attachment.rb +60 -1
- data/lib/docusign_esign/models/signing_group.rb +2 -0
- data/lib/docusign_esign/models/signing_group_user.rb +1 -0
- data/lib/docusign_esign/models/smart_section.rb +61 -1
- data/lib/docusign_esign/models/smart_section_display_settings.rb +2 -0
- data/lib/docusign_esign/models/social_account_information.rb +1 -0
- data/lib/docusign_esign/models/ssn.rb +98 -1
- data/lib/docusign_esign/models/stamp.rb +2 -0
- data/lib/docusign_esign/models/supported_languages.rb +1 -0
- data/lib/docusign_esign/models/tab_account_settings.rb +42 -1
- data/lib/docusign_esign/models/tab_group.rb +61 -1
- data/lib/docusign_esign/models/tab_metadata.rb +34 -1
- data/lib/docusign_esign/models/tabs.rb +2 -0
- data/lib/docusign_esign/models/template_document_visibility_list.rb +1 -0
- data/lib/docusign_esign/models/template_notification_request.rb +2 -0
- data/lib/docusign_esign/models/template_recipients.rb +14 -1
- data/lib/docusign_esign/models/template_role.rb +4 -0
- data/lib/docusign_esign/models/template_shared_item.rb +3 -0
- data/lib/docusign_esign/models/template_summary.rb +3 -0
- data/lib/docusign_esign/models/template_tabs.rb +1 -0
- data/lib/docusign_esign/models/template_update_summary.rb +4 -0
- data/lib/docusign_esign/models/text.rb +100 -1
- data/lib/docusign_esign/models/text_custom_field.rb +2 -0
- data/lib/docusign_esign/models/title.rb +72 -1
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +70 -1
- data/lib/docusign_esign/models/user_info.rb +1 -0
- data/lib/docusign_esign/models/user_information.rb +17 -1
- data/lib/docusign_esign/models/user_information_list.rb +1 -0
- data/lib/docusign_esign/models/user_password_information.rb +1 -0
- data/lib/docusign_esign/models/user_password_rules.rb +2 -0
- data/lib/docusign_esign/models/user_profile.rb +3 -0
- data/lib/docusign_esign/models/user_settings_information.rb +103 -4
- data/lib/docusign_esign/models/user_shared_item.rb +3 -0
- data/lib/docusign_esign/models/user_signature.rb +2 -0
- data/lib/docusign_esign/models/user_signature_definition.rb +1 -0
- data/lib/docusign_esign/models/view.rb +66 -1
- data/lib/docusign_esign/models/witness.rb +84 -1
- data/lib/docusign_esign/models/workflow.rb +32 -1
- data/lib/docusign_esign/models/workflow_step.rb +13 -1
- data/lib/docusign_esign/models/workspace.rb +4 -0
- data/lib/docusign_esign/models/workspace_folder_contents.rb +1 -0
- data/lib/docusign_esign/models/workspace_item.rb +5 -0
- data/lib/docusign_esign/models/workspace_settings.rb +1 -0
- data/lib/docusign_esign/models/workspace_user.rb +1 -0
- data/lib/docusign_esign/models/workspace_user_authorization.rb +2 -0
- data/lib/docusign_esign/models/zip.rb +99 -1
- data/lib/docusign_esign/version.rb +1 -1
- data/lib/docusign_esign.rb +30 -17
- data/tests/spec/unit_tests_using_jwt_spec.rb +605 -449
- metadata +70 -44
- data/Gemfile.lock +0 -73
- data/docusign_esign-2.12.0.rc1.gem +0 -0
- data/docusign_esign-3.12.0.rc1.gem +0 -0
- data/lib/docusign_esign/.DS_Store +0 -0
- data/lib/docusign_esign/api/.DS_Store +0 -0
- data/lib/docusign_esign/client/.DS_Store +0 -0
- data/tests/.DS_Store +0 -0
- data/tests/Gemfile.lock +0 -46
- data/tests/docs/private.pem +0 -27
@@ -12,92 +12,116 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# A tab that displays the recipient's company name.
|
15
16
|
class Company
|
16
17
|
#
|
17
18
|
attr_accessor :anchor_allow_white_space_in_characters
|
18
19
|
|
20
|
+
# Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.
|
19
21
|
attr_accessor :anchor_allow_white_space_in_characters_metadata
|
20
22
|
|
21
23
|
# When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
|
22
24
|
attr_accessor :anchor_case_sensitive
|
23
25
|
|
26
|
+
# Metadata that indicates whether the `anchorCaseSensitive` property is editable.
|
24
27
|
attr_accessor :anchor_case_sensitive_metadata
|
25
28
|
|
26
29
|
# Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
|
27
30
|
attr_accessor :anchor_horizontal_alignment
|
28
31
|
|
32
|
+
# Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
|
29
33
|
attr_accessor :anchor_horizontal_alignment_metadata
|
30
34
|
|
31
35
|
# When set to **true**, this tab is ignored if anchorString is not found in the document.
|
32
36
|
attr_accessor :anchor_ignore_if_not_present
|
33
37
|
|
38
|
+
# Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.
|
34
39
|
attr_accessor :anchor_ignore_if_not_present_metadata
|
35
40
|
|
36
41
|
# When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.
|
37
42
|
attr_accessor :anchor_match_whole_word
|
38
43
|
|
44
|
+
# Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
|
39
45
|
attr_accessor :anchor_match_whole_word_metadata
|
40
46
|
|
41
47
|
# Anchor text information for a radio button.
|
42
48
|
attr_accessor :anchor_string
|
43
49
|
|
50
|
+
# Metadata that indicates whether the `anchorString` property is editable.
|
44
51
|
attr_accessor :anchor_string_metadata
|
45
52
|
|
46
53
|
#
|
47
54
|
attr_accessor :anchor_tab_processor_version
|
48
55
|
|
56
|
+
# Reserved for DocuSign.
|
49
57
|
attr_accessor :anchor_tab_processor_version_metadata
|
50
58
|
|
51
59
|
# Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
|
52
60
|
attr_accessor :anchor_units
|
53
61
|
|
62
|
+
# Metadata that indicates whether the `anchorUnits` property is editable.
|
54
63
|
attr_accessor :anchor_units_metadata
|
55
64
|
|
56
65
|
# Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
|
57
66
|
attr_accessor :anchor_x_offset
|
58
67
|
|
68
|
+
# Metadata that indicates whether the `anchorXOffset` property is editable.
|
59
69
|
attr_accessor :anchor_x_offset_metadata
|
60
70
|
|
61
71
|
# Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
|
62
72
|
attr_accessor :anchor_y_offset
|
63
73
|
|
74
|
+
# Metadata that indicates whether the `anchorYOffset` property is editable.
|
64
75
|
attr_accessor :anchor_y_offset_metadata
|
65
76
|
|
66
77
|
# When set to **true**, the information in the tab is bold.
|
67
78
|
attr_accessor :bold
|
68
79
|
|
80
|
+
# Metadata that indicates whether the `bold` property is editable.
|
69
81
|
attr_accessor :bold_metadata
|
70
82
|
|
83
|
+
#
|
84
|
+
attr_accessor :caption
|
85
|
+
|
86
|
+
attr_accessor :caption_metadata
|
87
|
+
|
71
88
|
# When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
|
72
89
|
attr_accessor :conceal_value_on_document
|
73
90
|
|
91
|
+
# Metadata that indicates whether the `concealValueOnDocument` property is editable.
|
74
92
|
attr_accessor :conceal_value_on_document_metadata
|
75
93
|
|
76
94
|
# For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
|
77
95
|
attr_accessor :conditional_parent_label
|
78
96
|
|
97
|
+
# Metadata that indicates whether the `conditionalParentLabel` property is editable.
|
79
98
|
attr_accessor :conditional_parent_label_metadata
|
80
99
|
|
81
100
|
# 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.
|
82
101
|
attr_accessor :conditional_parent_value
|
83
102
|
|
103
|
+
# Metadata that indicates whether the `conditionalParentValue` property is editable.
|
84
104
|
attr_accessor :conditional_parent_value_metadata
|
85
105
|
|
86
106
|
# 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.
|
87
107
|
attr_accessor :custom_tab_id
|
88
108
|
|
109
|
+
# Metadata that indicates whether the `customTabId` property is editable.
|
89
110
|
attr_accessor :custom_tab_id_metadata
|
90
111
|
|
91
112
|
# When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.
|
92
113
|
attr_accessor :disable_auto_size
|
93
114
|
|
115
|
+
# Metadata that indicates whether the `disableAutoSize` property is editable.
|
94
116
|
attr_accessor :disable_auto_size_metadata
|
95
117
|
|
96
118
|
# Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
|
97
119
|
attr_accessor :document_id
|
98
120
|
|
121
|
+
# Metadata that indicates whether the `documentId` property is editable.
|
99
122
|
attr_accessor :document_id_metadata
|
100
123
|
|
124
|
+
# This object describes errors that occur. It is only valid for responses and ignored in requests.
|
101
125
|
attr_accessor :error_details
|
102
126
|
|
103
127
|
# The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
|
@@ -106,52 +130,64 @@ module DocuSign_eSign
|
|
106
130
|
# The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
|
107
131
|
attr_accessor :font_color
|
108
132
|
|
133
|
+
# Metadata that indicates whether the `fontColor` property is editable.
|
109
134
|
attr_accessor :font_color_metadata
|
110
135
|
|
136
|
+
# Metadata that indicates whether the `font` property is editable.
|
111
137
|
attr_accessor :font_metadata
|
112
138
|
|
113
139
|
# The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.
|
114
140
|
attr_accessor :font_size
|
115
141
|
|
142
|
+
# Metadata that indicates whether the `fontSize` property is editable.
|
116
143
|
attr_accessor :font_size_metadata
|
117
144
|
|
118
145
|
#
|
119
146
|
attr_accessor :form_order
|
120
147
|
|
148
|
+
# Metadata that indicates whether the `formOrder` property is editable.
|
121
149
|
attr_accessor :form_order_metadata
|
122
150
|
|
123
151
|
#
|
124
152
|
attr_accessor :form_page_label
|
125
153
|
|
154
|
+
# Metadata that indicates whether the `formPageLabel` property is editable.
|
126
155
|
attr_accessor :form_page_label_metadata
|
127
156
|
|
128
157
|
#
|
129
158
|
attr_accessor :form_page_number
|
130
159
|
|
160
|
+
# Metadata that indicates whether the `fromPageNumber` property is editable.
|
131
161
|
attr_accessor :form_page_number_metadata
|
132
162
|
|
133
163
|
# Height of the tab in pixels.
|
134
164
|
attr_accessor :height
|
135
165
|
|
166
|
+
# Metadata that indicates whether the `height` property is editable.
|
136
167
|
attr_accessor :height_metadata
|
137
168
|
|
138
169
|
# When set to **true**, the information in the tab is italic.
|
139
170
|
attr_accessor :italic
|
140
171
|
|
172
|
+
# Metadata that indicates whether the `italic` property is editable.
|
141
173
|
attr_accessor :italic_metadata
|
142
174
|
|
175
|
+
# Reserved for DocuSign.
|
143
176
|
attr_accessor :locale_policy
|
144
177
|
|
145
178
|
# When set to **true**, the signer cannot change the data of the custom tab.
|
146
179
|
attr_accessor :locked
|
147
180
|
|
181
|
+
# Metadata that indicates whether the `locked` property is editable.
|
148
182
|
attr_accessor :locked_metadata
|
149
183
|
|
150
184
|
# An optional value that describes the maximum length of the property when the property is a string.
|
151
185
|
attr_accessor :max_length
|
152
186
|
|
187
|
+
# Metadata that indicates whether the `maxLength` property is editable.
|
153
188
|
attr_accessor :max_length_metadata
|
154
189
|
|
190
|
+
# Contains the information necessary to map the tab to a field in SalesForce.
|
155
191
|
attr_accessor :merge_field
|
156
192
|
|
157
193
|
#
|
@@ -160,16 +196,19 @@ module DocuSign_eSign
|
|
160
196
|
# Specifies the tool tip text for the tab.
|
161
197
|
attr_accessor :name
|
162
198
|
|
199
|
+
# Metadata that indicates whether the `name` property is editable. This property is read-only.
|
163
200
|
attr_accessor :name_metadata
|
164
201
|
|
165
202
|
# The initial value of the tab when it was sent to the recipient.
|
166
203
|
attr_accessor :original_value
|
167
204
|
|
205
|
+
# Metadata that indicates whether the `originalValue` property is editable.
|
168
206
|
attr_accessor :original_value_metadata
|
169
207
|
|
170
208
|
# Specifies the page number on which the tab is located.
|
171
209
|
attr_accessor :page_number
|
172
210
|
|
211
|
+
# Metadata that indicates whether the `pageNumber` property is editable.
|
173
212
|
attr_accessor :page_number_metadata
|
174
213
|
|
175
214
|
# Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
|
@@ -178,15 +217,19 @@ module DocuSign_eSign
|
|
178
217
|
#
|
179
218
|
attr_accessor :recipient_id_guid
|
180
219
|
|
220
|
+
# Metadata that indicates whether the `recipientIdGuid` property is editable.
|
181
221
|
attr_accessor :recipient_id_guid_metadata
|
182
222
|
|
223
|
+
# Metadata that indicates whether the `recipientId` property is editable.
|
183
224
|
attr_accessor :recipient_id_metadata
|
184
225
|
|
185
226
|
# When set to **true**, the signer is required to fill out this tab
|
186
227
|
attr_accessor :required
|
187
228
|
|
229
|
+
# Metadata that indicates whether the `required` property is editable.
|
188
230
|
attr_accessor :required_metadata
|
189
231
|
|
232
|
+
# Reserved for DocuSign.
|
190
233
|
attr_accessor :smart_contract_information
|
191
234
|
|
192
235
|
#
|
@@ -195,71 +238,85 @@ module DocuSign_eSign
|
|
195
238
|
# 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.
|
196
239
|
attr_accessor :status
|
197
240
|
|
241
|
+
# Metadata that indicates whether the `status` property is editable.
|
198
242
|
attr_accessor :status_metadata
|
199
243
|
|
200
244
|
#
|
201
245
|
attr_accessor :tab_group_labels
|
202
246
|
|
247
|
+
# Metadata that indicates whether the `tabGroupLabels` property is editable.
|
203
248
|
attr_accessor :tab_group_labels_metadata
|
204
249
|
|
205
250
|
# The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
|
206
251
|
attr_accessor :tab_id
|
207
252
|
|
253
|
+
# Metadata that indicates whether the `tabId` property is editable.
|
208
254
|
attr_accessor :tab_id_metadata
|
209
255
|
|
210
256
|
# The label string associated with the tab.
|
211
257
|
attr_accessor :tab_label
|
212
258
|
|
259
|
+
# Metadata that indicates whether the `tabLabel` property is editable.
|
213
260
|
attr_accessor :tab_label_metadata
|
214
261
|
|
215
262
|
#
|
216
263
|
attr_accessor :tab_order
|
217
264
|
|
265
|
+
# Metadata that indicates whether the `tabOrder` property is editable.
|
218
266
|
attr_accessor :tab_order_metadata
|
219
267
|
|
220
268
|
#
|
221
269
|
attr_accessor :tab_type
|
222
270
|
|
271
|
+
# Metadata that indicates whether the `tabType` property is editable.
|
223
272
|
attr_accessor :tab_type_metadata
|
224
273
|
|
225
274
|
# When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
226
275
|
attr_accessor :template_locked
|
227
276
|
|
277
|
+
# Metadata that indicates whether the `templateLocked` property is editable.
|
228
278
|
attr_accessor :template_locked_metadata
|
229
279
|
|
230
280
|
# When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
|
231
281
|
attr_accessor :template_required
|
232
282
|
|
283
|
+
# Metadata that indicates whether the `templateRequired` property is editable.
|
233
284
|
attr_accessor :template_required_metadata
|
234
285
|
|
235
286
|
#
|
236
287
|
attr_accessor :tooltip
|
237
288
|
|
289
|
+
# Metadata that indicates whether the `toolTip` property is editable.
|
238
290
|
attr_accessor :tool_tip_metadata
|
239
291
|
|
240
292
|
# When set to **true**, the information in the tab is underlined.
|
241
293
|
attr_accessor :underline
|
242
294
|
|
295
|
+
# Metadata that indicates whether the `underline` property is editable.
|
243
296
|
attr_accessor :underline_metadata
|
244
297
|
|
245
298
|
# Specifies the value of the tab.
|
246
299
|
attr_accessor :value
|
247
300
|
|
301
|
+
# Metadata that indicates whether the `value` property is editable.
|
248
302
|
attr_accessor :value_metadata
|
249
303
|
|
250
304
|
# Width of the tab in pixels.
|
251
305
|
attr_accessor :width
|
252
306
|
|
307
|
+
# Metadata that indicates whether the `width` property is editable.
|
253
308
|
attr_accessor :width_metadata
|
254
309
|
|
255
310
|
# This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
256
311
|
attr_accessor :x_position
|
257
312
|
|
313
|
+
# Metadata that indicates whether the `xPosition` property is editable.
|
258
314
|
attr_accessor :x_position_metadata
|
259
315
|
|
260
316
|
# This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
|
261
317
|
attr_accessor :y_position
|
262
318
|
|
319
|
+
# Metadata that indicates whether the `yPosition` property is editable.
|
263
320
|
attr_accessor :y_position_metadata
|
264
321
|
|
265
322
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -287,6 +344,8 @@ module DocuSign_eSign
|
|
287
344
|
:'anchor_y_offset_metadata' => :'anchorYOffsetMetadata',
|
288
345
|
:'bold' => :'bold',
|
289
346
|
:'bold_metadata' => :'boldMetadata',
|
347
|
+
:'caption' => :'caption',
|
348
|
+
:'caption_metadata' => :'captionMetadata',
|
290
349
|
:'conceal_value_on_document' => :'concealValueOnDocument',
|
291
350
|
:'conceal_value_on_document_metadata' => :'concealValueOnDocumentMetadata',
|
292
351
|
:'conditional_parent_label' => :'conditionalParentLabel',
|
@@ -393,6 +452,8 @@ module DocuSign_eSign
|
|
393
452
|
:'anchor_y_offset_metadata' => :'PropertyMetadata',
|
394
453
|
:'bold' => :'String',
|
395
454
|
:'bold_metadata' => :'PropertyMetadata',
|
455
|
+
:'caption' => :'String',
|
456
|
+
:'caption_metadata' => :'PropertyMetadata',
|
396
457
|
:'conceal_value_on_document' => :'String',
|
397
458
|
:'conceal_value_on_document_metadata' => :'PropertyMetadata',
|
398
459
|
:'conditional_parent_label' => :'String',
|
@@ -570,6 +631,14 @@ module DocuSign_eSign
|
|
570
631
|
self.bold_metadata = attributes[:'boldMetadata']
|
571
632
|
end
|
572
633
|
|
634
|
+
if attributes.has_key?(:'caption')
|
635
|
+
self.caption = attributes[:'caption']
|
636
|
+
end
|
637
|
+
|
638
|
+
if attributes.has_key?(:'captionMetadata')
|
639
|
+
self.caption_metadata = attributes[:'captionMetadata']
|
640
|
+
end
|
641
|
+
|
573
642
|
if attributes.has_key?(:'concealValueOnDocument')
|
574
643
|
self.conceal_value_on_document = attributes[:'concealValueOnDocument']
|
575
644
|
end
|
@@ -925,6 +994,8 @@ module DocuSign_eSign
|
|
925
994
|
anchor_y_offset_metadata == o.anchor_y_offset_metadata &&
|
926
995
|
bold == o.bold &&
|
927
996
|
bold_metadata == o.bold_metadata &&
|
997
|
+
caption == o.caption &&
|
998
|
+
caption_metadata == o.caption_metadata &&
|
928
999
|
conceal_value_on_document == o.conceal_value_on_document &&
|
929
1000
|
conceal_value_on_document_metadata == o.conceal_value_on_document_metadata &&
|
930
1001
|
conditional_parent_label == o.conditional_parent_label &&
|
@@ -1014,7 +1085,7 @@ module DocuSign_eSign
|
|
1014
1085
|
# Calculates hash code according to all attributes.
|
1015
1086
|
# @return [Fixnum] Hash code
|
1016
1087
|
def hash
|
1017
|
-
[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, bold, bold_metadata, conceal_value_on_document, conceal_value_on_document_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, disable_auto_size, disable_auto_size_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locale_policy, locked, locked_metadata, max_length, max_length_metadata, merge_field, merge_field_xml, name, name_metadata, original_value, original_value_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, required, required_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
|
1088
|
+
[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, bold, bold_metadata, caption, caption_metadata, conceal_value_on_document, conceal_value_on_document_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, disable_auto_size, disable_auto_size_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locale_policy, locked, locked_metadata, max_length, max_length_metadata, merge_field, merge_field_xml, name, name_metadata, original_value, original_value_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, required, required_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
|
1018
1089
|
end
|
1019
1090
|
|
1020
1091
|
# Builds the object from hash
|
@@ -12,10 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
12
12
|
require 'date'
|
13
13
|
|
14
14
|
module DocuSign_eSign
|
15
|
+
# This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources. [composite]: /docs/esign-rest-api/esign101/concepts/templates/composite/
|
15
16
|
class CompositeTemplate
|
16
17
|
# The identify of this composite template. It is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document.
|
17
18
|
attr_accessor :composite_template_id
|
18
19
|
|
20
|
+
# An optional document object that will act as the primary document in the composite template object. If the document node is present, it will take precedence over any server template or inline template documents. It always comes first. Only use this when you want to supply the document dynamically.
|
19
21
|
attr_accessor :document
|
20
22
|
|
21
23
|
# Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value.
|
@@ -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 rule that defines a set of recipients and the conditions under which they will be used for the envelope.
|
15
16
|
class ConditionalRecipientRule
|
16
17
|
#
|
17
18
|
attr_accessor :conditions
|
@@ -19,6 +20,7 @@ module DocuSign_eSign
|
|
19
20
|
#
|
20
21
|
attr_accessor :order
|
21
22
|
|
23
|
+
# A set of recipients that may be used for the envelope, depending on the `conditions` defined.
|
22
24
|
attr_accessor :recipient_group
|
23
25
|
|
24
26
|
# Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the 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
|
+
# This object contains the results of a ConnectConfigurations::GET method.
|
15
16
|
class ConnectConfigResults
|
16
17
|
# Reserved: TBD
|
17
18
|
attr_accessor :configurations
|
@@ -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
|
+
# The `connectCustomConfiguration` object describes how Connect is configured for your account.
|
15
16
|
class ConnectCustomConfiguration
|
16
17
|
# When set to **true**, data is sent to the urlToPublishTo web address. This option can be set to false to stop sending data while maintaining the Connect configuration information.
|
17
18
|
attr_accessor :allow_envelope_publish
|
@@ -22,26 +23,42 @@ module DocuSign_eSign
|
|
22
23
|
# When set to **true**, the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect.
|
23
24
|
attr_accessor :all_users
|
24
25
|
|
26
|
+
#
|
27
|
+
attr_accessor :all_users_except
|
28
|
+
|
25
29
|
# If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**.
|
26
30
|
attr_accessor :configuration_type
|
27
31
|
|
28
32
|
# Specifies the DocuSign generated ID for the Connect configuration.
|
29
33
|
attr_accessor :connect_id
|
30
34
|
|
35
|
+
#
|
36
|
+
attr_accessor :delivery_mode
|
37
|
+
|
38
|
+
#
|
39
|
+
attr_accessor :disabled_by
|
40
|
+
|
31
41
|
# This turns Connect logging on or off. When set to **true**, logging is turned on.
|
32
42
|
attr_accessor :enable_log
|
33
43
|
|
34
|
-
# A comma separated list of
|
44
|
+
# A comma separated list of �Envelope� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, and Voided.
|
35
45
|
attr_accessor :envelope_events
|
36
46
|
|
47
|
+
# Allows you to specify the format of the information the Connect webhooks returns. For more information, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications)
|
37
48
|
attr_accessor :event_data
|
38
49
|
|
50
|
+
#
|
51
|
+
attr_accessor :events
|
52
|
+
|
39
53
|
#
|
40
54
|
attr_accessor :external_folder_id
|
41
55
|
|
42
56
|
#
|
43
57
|
attr_accessor :external_folder_label
|
44
58
|
|
59
|
+
#
|
60
|
+
attr_accessor :group_ids
|
61
|
+
|
45
62
|
# When set to **true**, the Connect Service includes the Certificate of Completion with completed envelopes.
|
46
63
|
attr_accessor :include_certificate_of_completion
|
47
64
|
|
@@ -72,7 +89,7 @@ module DocuSign_eSign
|
|
72
89
|
#
|
73
90
|
attr_accessor :password
|
74
91
|
|
75
|
-
# A comma separated list of
|
92
|
+
# A comma separated list of �Recipient� related events that are tracked through Connect. The possible event values are: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.
|
76
93
|
attr_accessor :recipient_events
|
77
94
|
|
78
95
|
#
|
@@ -111,7 +128,7 @@ module DocuSign_eSign
|
|
111
128
|
# This is the web address and name of your listener or Retrieving Service endpoint. You need to include HTTPS:// in the web address.
|
112
129
|
attr_accessor :url_to_publish_to
|
113
130
|
|
114
|
-
# A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. ###### Note: If allUsers is set to
|
131
|
+
# A comma separated list of userIds. This sets the users associated with the tracked envelope and recipient events. When one of the event occurs for a set user, the information is sent through Connect. ###### Note: If allUsers is set to �false� then you must provide a list of user id�s.
|
115
132
|
attr_accessor :user_ids
|
116
133
|
|
117
134
|
#
|
@@ -126,13 +143,18 @@ module DocuSign_eSign
|
|
126
143
|
:'allow_envelope_publish' => :'allowEnvelopePublish',
|
127
144
|
:'allow_salesforce_publish' => :'allowSalesforcePublish',
|
128
145
|
:'all_users' => :'allUsers',
|
146
|
+
:'all_users_except' => :'allUsersExcept',
|
129
147
|
:'configuration_type' => :'configurationType',
|
130
148
|
:'connect_id' => :'connectId',
|
149
|
+
:'delivery_mode' => :'deliveryMode',
|
150
|
+
:'disabled_by' => :'disabledBy',
|
131
151
|
:'enable_log' => :'enableLog',
|
132
152
|
:'envelope_events' => :'envelopeEvents',
|
133
153
|
:'event_data' => :'eventData',
|
154
|
+
:'events' => :'events',
|
134
155
|
:'external_folder_id' => :'externalFolderId',
|
135
156
|
:'external_folder_label' => :'externalFolderLabel',
|
157
|
+
:'group_ids' => :'groupIds',
|
136
158
|
:'include_certificate_of_completion' => :'includeCertificateOfCompletion',
|
137
159
|
:'include_cert_soap_header' => :'includeCertSoapHeader',
|
138
160
|
:'include_document_fields' => :'includeDocumentFields',
|
@@ -168,13 +190,18 @@ module DocuSign_eSign
|
|
168
190
|
:'allow_envelope_publish' => :'String',
|
169
191
|
:'allow_salesforce_publish' => :'String',
|
170
192
|
:'all_users' => :'String',
|
193
|
+
:'all_users_except' => :'String',
|
171
194
|
:'configuration_type' => :'String',
|
172
195
|
:'connect_id' => :'String',
|
196
|
+
:'delivery_mode' => :'String',
|
197
|
+
:'disabled_by' => :'String',
|
173
198
|
:'enable_log' => :'String',
|
174
199
|
:'envelope_events' => :'Array<String>',
|
175
200
|
:'event_data' => :'ConnectEventData',
|
201
|
+
:'events' => :'Array<String>',
|
176
202
|
:'external_folder_id' => :'String',
|
177
203
|
:'external_folder_label' => :'String',
|
204
|
+
:'group_ids' => :'Array<String>',
|
178
205
|
:'include_certificate_of_completion' => :'String',
|
179
206
|
:'include_cert_soap_header' => :'String',
|
180
207
|
:'include_document_fields' => :'String',
|
@@ -224,6 +251,10 @@ module DocuSign_eSign
|
|
224
251
|
self.all_users = attributes[:'allUsers']
|
225
252
|
end
|
226
253
|
|
254
|
+
if attributes.has_key?(:'allUsersExcept')
|
255
|
+
self.all_users_except = attributes[:'allUsersExcept']
|
256
|
+
end
|
257
|
+
|
227
258
|
if attributes.has_key?(:'configurationType')
|
228
259
|
self.configuration_type = attributes[:'configurationType']
|
229
260
|
end
|
@@ -232,6 +263,14 @@ module DocuSign_eSign
|
|
232
263
|
self.connect_id = attributes[:'connectId']
|
233
264
|
end
|
234
265
|
|
266
|
+
if attributes.has_key?(:'deliveryMode')
|
267
|
+
self.delivery_mode = attributes[:'deliveryMode']
|
268
|
+
end
|
269
|
+
|
270
|
+
if attributes.has_key?(:'disabledBy')
|
271
|
+
self.disabled_by = attributes[:'disabledBy']
|
272
|
+
end
|
273
|
+
|
235
274
|
if attributes.has_key?(:'enableLog')
|
236
275
|
self.enable_log = attributes[:'enableLog']
|
237
276
|
end
|
@@ -246,6 +285,12 @@ module DocuSign_eSign
|
|
246
285
|
self.event_data = attributes[:'eventData']
|
247
286
|
end
|
248
287
|
|
288
|
+
if attributes.has_key?(:'events')
|
289
|
+
if (value = attributes[:'events']).is_a?(Array)
|
290
|
+
self.events = value
|
291
|
+
end
|
292
|
+
end
|
293
|
+
|
249
294
|
if attributes.has_key?(:'externalFolderId')
|
250
295
|
self.external_folder_id = attributes[:'externalFolderId']
|
251
296
|
end
|
@@ -254,6 +299,12 @@ module DocuSign_eSign
|
|
254
299
|
self.external_folder_label = attributes[:'externalFolderLabel']
|
255
300
|
end
|
256
301
|
|
302
|
+
if attributes.has_key?(:'groupIds')
|
303
|
+
if (value = attributes[:'groupIds']).is_a?(Array)
|
304
|
+
self.group_ids = value
|
305
|
+
end
|
306
|
+
end
|
307
|
+
|
257
308
|
if attributes.has_key?(:'includeCertificateOfCompletion')
|
258
309
|
self.include_certificate_of_completion = attributes[:'includeCertificateOfCompletion']
|
259
310
|
end
|
@@ -388,13 +439,18 @@ module DocuSign_eSign
|
|
388
439
|
allow_envelope_publish == o.allow_envelope_publish &&
|
389
440
|
allow_salesforce_publish == o.allow_salesforce_publish &&
|
390
441
|
all_users == o.all_users &&
|
442
|
+
all_users_except == o.all_users_except &&
|
391
443
|
configuration_type == o.configuration_type &&
|
392
444
|
connect_id == o.connect_id &&
|
445
|
+
delivery_mode == o.delivery_mode &&
|
446
|
+
disabled_by == o.disabled_by &&
|
393
447
|
enable_log == o.enable_log &&
|
394
448
|
envelope_events == o.envelope_events &&
|
395
449
|
event_data == o.event_data &&
|
450
|
+
events == o.events &&
|
396
451
|
external_folder_id == o.external_folder_id &&
|
397
452
|
external_folder_label == o.external_folder_label &&
|
453
|
+
group_ids == o.group_ids &&
|
398
454
|
include_certificate_of_completion == o.include_certificate_of_completion &&
|
399
455
|
include_cert_soap_header == o.include_cert_soap_header &&
|
400
456
|
include_document_fields == o.include_document_fields &&
|
@@ -432,7 +488,7 @@ module DocuSign_eSign
|
|
432
488
|
# Calculates hash code according to all attributes.
|
433
489
|
# @return [Fixnum] Hash code
|
434
490
|
def hash
|
435
|
-
[allow_envelope_publish, allow_salesforce_publish, all_users, configuration_type, connect_id, enable_log, envelope_events, event_data, external_folder_id, external_folder_label, include_certificate_of_completion, include_cert_soap_header, include_document_fields, include_documents, include_envelope_void_reason, include_hmac, include_sender_accountas_custom_field, include_time_zone_information, name, password, recipient_events, require_mutual_tls, requires_acknowledgement, salesforce_api_version, salesforce_authcode, salesforce_call_back_url, salesforce_documents_as_content_files, sender_override, sender_selectable_items, sf_objects, sign_message_with_x509_certificate, soap_namespace, url_to_publish_to, user_ids, user_name, use_soap_interface].hash
|
491
|
+
[allow_envelope_publish, allow_salesforce_publish, all_users, all_users_except, configuration_type, connect_id, delivery_mode, disabled_by, enable_log, envelope_events, event_data, events, external_folder_id, external_folder_label, group_ids, include_certificate_of_completion, include_cert_soap_header, include_document_fields, include_documents, include_envelope_void_reason, include_hmac, include_sender_accountas_custom_field, include_time_zone_information, name, password, recipient_events, require_mutual_tls, requires_acknowledgement, salesforce_api_version, salesforce_authcode, salesforce_call_back_url, salesforce_documents_as_content_files, sender_override, sender_selectable_items, sf_objects, sign_message_with_x509_certificate, soap_namespace, url_to_publish_to, user_ids, user_name, use_soap_interface].hash
|
436
492
|
end
|
437
493
|
|
438
494
|
# Builds the object from hash
|