docusign_esign 2.11.0 → 3.0.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/CHANGELOG.md +0 -55
- data/Gemfile +1 -1
- data/Gemfile.lock +31 -31
- data/README.md +40 -22
- data/docusign_esign-3.0.0.gem +0 -0
- data/docusign_esign.gemspec +1 -2
- data/lib/docusign_esign/api/accounts_api.rb +427 -89
- data/lib/docusign_esign/api/authentication_api.rb +1 -1
- data/lib/docusign_esign/api/billing_api.rb +14 -14
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +195 -155
- data/lib/docusign_esign/api/cloud_storage_api.rb +13 -9
- data/lib/docusign_esign/api/connect_api.rb +16 -167
- data/lib/docusign_esign/api/custom_tabs_api.rb +7 -7
- data/lib/docusign_esign/api/data_feed_api.rb +76 -0
- data/lib/docusign_esign/api/diagnostics_api.rb +8 -8
- data/lib/docusign_esign/api/email_archive_api.rb +261 -0
- data/lib/docusign_esign/api/envelopes_api.rb +1692 -375
- data/lib/docusign_esign/api/folders_api.rb +20 -11
- data/lib/docusign_esign/api/groups_api.rb +25 -21
- data/lib/docusign_esign/api/notary_api.rb +3 -3
- data/lib/docusign_esign/api/power_forms_api.rb +10 -10
- data/lib/docusign_esign/api/signing_groups_api.rb +11 -11
- data/lib/docusign_esign/api/templates_api.rb +323 -79
- data/lib/docusign_esign/api/trust_service_providers_api.rb +3 -3
- data/lib/docusign_esign/api/users_api.rb +66 -38
- data/lib/docusign_esign/api/workspaces_api.rb +13 -13
- data/lib/docusign_esign/client/api_client.rb +2 -3
- data/lib/docusign_esign/configuration.rb +3 -4
- data/lib/docusign_esign/models/access_code_format.rb +273 -0
- data/lib/docusign_esign/models/account_address.rb +11 -8
- data/lib/docusign_esign/models/account_billing_plan.rb +12 -59
- data/lib/docusign_esign/models/account_billing_plan_response.rb +31 -9
- data/lib/docusign_esign/models/account_identity_verification_response.rb +12 -8
- data/lib/docusign_esign/models/account_identity_verification_step.rb +12 -8
- data/lib/docusign_esign/models/account_identity_verification_workflow.rb +45 -12
- data/lib/docusign_esign/models/account_information.rb +45 -19
- data/lib/docusign_esign/models/account_minimum_password_length.rb +12 -8
- data/lib/docusign_esign/models/account_notification.rb +206 -0
- data/lib/docusign_esign/models/account_password_expire_password_days.rb +12 -8
- data/lib/docusign_esign/models/account_password_lockout_duration_minutes.rb +12 -8
- data/lib/docusign_esign/models/account_password_lockout_duration_type.rb +12 -8
- data/lib/docusign_esign/models/account_password_minimum_password_age_days.rb +12 -8
- data/lib/docusign_esign/models/account_password_questions_required.rb +12 -8
- data/lib/docusign_esign/models/account_password_rules.rb +12 -8
- data/lib/docusign_esign/models/account_password_strength_type.rb +12 -8
- data/lib/docusign_esign/models/account_password_strength_type_option.rb +12 -8
- data/lib/docusign_esign/models/account_role_settings.rb +41 -9
- data/lib/docusign_esign/models/account_seals.rb +12 -8
- data/lib/docusign_esign/models/account_settings_information.rb +4700 -27
- data/lib/docusign_esign/models/account_shared_access.rb +11 -8
- data/lib/docusign_esign/models/account_signature_provider.rb +12 -8
- data/lib/docusign_esign/models/account_signature_provider_option.rb +12 -8
- data/lib/docusign_esign/models/account_signature_providers.rb +12 -8
- data/lib/docusign_esign/models/account_ui_settings.rb +330 -0
- data/lib/docusign_esign/models/add_on.rb +11 -8
- data/lib/docusign_esign/models/address_information.rb +44 -51
- data/lib/docusign_esign/models/address_information_input.rb +11 -8
- data/lib/docusign_esign/models/address_information_v2.rb +11 -7
- data/lib/docusign_esign/models/agent.rb +207 -34
- data/lib/docusign_esign/models/api_request_log.rb +11 -8
- data/lib/docusign_esign/models/api_request_logs_result.rb +11 -8
- data/lib/docusign_esign/models/app_store_product.rb +11 -8
- data/lib/docusign_esign/models/app_store_receipt.rb +11 -8
- data/lib/docusign_esign/models/approve.rb +448 -14
- data/lib/docusign_esign/models/attachment.rb +11 -8
- data/lib/docusign_esign/models/authentication_method.rb +12 -9
- data/lib/docusign_esign/models/authentication_status.rb +11 -8
- data/lib/docusign_esign/models/bcc_email_address.rb +11 -8
- data/lib/docusign_esign/models/bcc_email_archive.rb +276 -0
- data/lib/docusign_esign/models/bcc_email_archive_history.rb +237 -0
- data/lib/docusign_esign/models/bcc_email_archive_history_list.rb +250 -0
- data/lib/docusign_esign/models/bcc_email_archive_list.rb +250 -0
- data/lib/docusign_esign/models/billing_charge.rb +11 -8
- data/lib/docusign_esign/models/billing_charge_response.rb +11 -8
- data/lib/docusign_esign/models/billing_discount.rb +12 -8
- data/lib/docusign_esign/models/billing_invoice.rb +11 -8
- data/lib/docusign_esign/models/billing_invoice_item.rb +11 -8
- data/lib/docusign_esign/models/billing_invoices_response.rb +11 -8
- data/lib/docusign_esign/models/billing_invoices_summary.rb +12 -8
- data/lib/docusign_esign/models/billing_payment.rb +11 -8
- data/lib/docusign_esign/models/billing_payment_item.rb +11 -8
- data/lib/docusign_esign/models/billing_payment_request.rb +12 -8
- data/lib/docusign_esign/models/billing_payment_response.rb +11 -8
- data/lib/docusign_esign/models/billing_payments_response.rb +11 -8
- data/lib/docusign_esign/models/billing_plan.rb +11 -8
- data/lib/docusign_esign/models/billing_plan_information.rb +32 -9
- data/lib/docusign_esign/models/billing_plan_preview.rb +11 -8
- data/lib/docusign_esign/models/billing_plan_response.rb +11 -8
- data/lib/docusign_esign/models/billing_plan_update_response.rb +11 -8
- data/lib/docusign_esign/models/billing_plans_response.rb +11 -8
- data/lib/docusign_esign/models/billing_price.rb +12 -8
- data/lib/docusign_esign/models/brand.rb +38 -12
- data/lib/docusign_esign/models/brand_email_content.rb +12 -8
- data/lib/docusign_esign/models/brand_link.rb +12 -8
- data/lib/docusign_esign/models/brand_logos.rb +12 -8
- data/lib/docusign_esign/models/brand_request.rb +12 -8
- data/lib/docusign_esign/models/brand_resource_urls.rb +12 -8
- data/lib/docusign_esign/models/brand_resources.rb +25 -9
- data/lib/docusign_esign/models/brand_resources_list.rb +12 -8
- data/lib/docusign_esign/models/brands_request.rb +12 -8
- data/lib/docusign_esign/models/brands_response.rb +12 -8
- data/lib/docusign_esign/models/bulk_envelope.rb +12 -8
- data/lib/docusign_esign/models/bulk_envelope_status.rb +12 -8
- data/lib/docusign_esign/models/bulk_envelopes_response.rb +12 -8
- data/lib/docusign_esign/models/bulk_recipient.rb +12 -8
- data/lib/docusign_esign/models/bulk_recipient_signature_provider.rb +12 -8
- data/lib/docusign_esign/models/bulk_recipient_tab_label.rb +12 -8
- data/lib/docusign_esign/models/bulk_recipients_request.rb +12 -8
- data/lib/docusign_esign/models/bulk_recipients_response.rb +12 -8
- data/lib/docusign_esign/models/bulk_recipients_summary_response.rb +12 -8
- data/lib/docusign_esign/models/bulk_recipients_update_response.rb +12 -8
- data/lib/docusign_esign/models/{envelope_form_data_prefill_form_data.rb → bulk_send_request.rb} +20 -18
- data/lib/docusign_esign/models/{group_brands.rb → bulk_send_response.rb} +48 -33
- data/lib/docusign_esign/models/bulk_send_test_response.rb +212 -0
- data/lib/docusign_esign/models/bulk_sending_copy.rb +222 -0
- data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +198 -0
- data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +382 -0
- data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +198 -0
- data/lib/docusign_esign/models/bulk_sending_list.rb +210 -0
- data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +190 -0
- data/lib/docusign_esign/models/bulk_sending_list_summary.rb +218 -0
- data/lib/docusign_esign/models/captive_recipient.rb +12 -8
- data/lib/docusign_esign/models/captive_recipient_information.rb +12 -8
- data/lib/docusign_esign/models/carbon_copy.rb +217 -43
- data/lib/docusign_esign/models/certified_delivery.rb +208 -43
- data/lib/docusign_esign/models/checkbox.rb +562 -12
- data/lib/docusign_esign/models/chunked_upload_part.rb +12 -8
- data/lib/docusign_esign/models/chunked_upload_request.rb +12 -8
- data/lib/docusign_esign/models/chunked_upload_response.rb +12 -8
- data/lib/docusign_esign/models/cloud_storage_provider.rb +12 -8
- data/lib/docusign_esign/models/cloud_storage_providers.rb +12 -8
- data/lib/docusign_esign/models/comment.rb +392 -0
- data/lib/docusign_esign/models/{prefill_form_data.rb → comment_history_result.rb} +39 -35
- data/lib/docusign_esign/models/comment_publish.rb +244 -0
- data/lib/docusign_esign/models/comment_thread.rb +961 -0
- data/lib/docusign_esign/models/comments_publish.rb +190 -0
- data/lib/docusign_esign/models/company.rb +521 -14
- data/lib/docusign_esign/models/complete_sign_hash_response.rb +12 -8
- data/lib/docusign_esign/models/complete_sign_request.rb +11 -7
- data/lib/docusign_esign/models/composite_template.rb +12 -8
- data/lib/docusign_esign/models/connect_config_results.rb +12 -8
- data/lib/docusign_esign/models/connect_custom_configuration.rb +159 -15
- data/lib/docusign_esign/models/connect_debug_log.rb +12 -8
- data/lib/docusign_esign/models/connect_failure_filter.rb +12 -8
- data/lib/docusign_esign/models/connect_failure_result.rb +12 -8
- data/lib/docusign_esign/models/connect_failure_results.rb +12 -8
- data/lib/docusign_esign/models/connect_log.rb +12 -8
- data/lib/docusign_esign/models/connect_logs.rb +12 -8
- data/lib/docusign_esign/models/connect_salesforce_field.rb +258 -0
- data/lib/docusign_esign/models/connect_salesforce_object.rb +272 -0
- data/lib/docusign_esign/models/connect_user_object.rb +230 -0
- data/lib/docusign_esign/models/console_view_request.rb +12 -8
- data/lib/docusign_esign/models/consumer_disclosure.rb +12 -8
- data/lib/docusign_esign/models/contact.rb +43 -9
- data/lib/docusign_esign/models/contact_get_response.rb +12 -8
- data/lib/docusign_esign/models/contact_mod_request.rb +20 -16
- data/lib/docusign_esign/models/contact_phone_number.rb +12 -8
- data/lib/docusign_esign/models/contact_update_response.rb +12 -8
- data/lib/docusign_esign/models/correct_view_request.rb +14 -20
- data/lib/docusign_esign/models/country.rb +12 -8
- data/lib/docusign_esign/models/credential.rb +11 -7
- data/lib/docusign_esign/models/credit_card_information.rb +23 -9
- data/lib/docusign_esign/models/credit_card_types.rb +12 -8
- data/lib/docusign_esign/models/currency_feature_set_price.rb +12 -8
- data/lib/docusign_esign/models/currency_plan_price.rb +12 -8
- data/lib/docusign_esign/models/custom_field.rb +12 -8
- data/lib/docusign_esign/models/custom_field_v2.rb +11 -7
- data/lib/docusign_esign/models/custom_fields.rb +11 -8
- data/lib/docusign_esign/models/custom_fields_envelope.rb +12 -8
- data/lib/docusign_esign/models/custom_settings_information.rb +12 -8
- data/lib/docusign_esign/models/date.rb +575 -14
- data/lib/docusign_esign/models/date_signed.rb +475 -12
- data/lib/docusign_esign/models/date_stamp_properties.rb +12 -8
- data/lib/docusign_esign/models/decline.rb +457 -14
- data/lib/docusign_esign/models/diagnostics_settings_information.rb +12 -8
- data/lib/docusign_esign/models/direct_debit_processor_information.rb +298 -0
- data/lib/docusign_esign/models/display_appliance_document.rb +258 -0
- data/lib/docusign_esign/models/display_appliance_document_page.rb +278 -0
- data/lib/docusign_esign/models/display_appliance_envelope.rb +328 -0
- data/lib/docusign_esign/models/display_appliance_info.rb +235 -0
- data/lib/docusign_esign/models/display_appliance_page.rb +278 -0
- data/lib/docusign_esign/models/display_appliance_pdf.rb +267 -0
- data/lib/docusign_esign/models/display_appliance_recipient.rb +388 -0
- data/lib/docusign_esign/models/{offline_attributes.rb → display_appliance_signer_attachment.rb} +65 -52
- data/lib/docusign_esign/models/dob_information_input.rb +11 -8
- data/lib/docusign_esign/models/document.rb +64 -19
- data/lib/docusign_esign/models/document_fields_information.rb +12 -8
- data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +12 -8
- data/lib/docusign_esign/models/document_html_definition.rb +12 -8
- data/lib/docusign_esign/models/document_html_definition_original.rb +12 -8
- data/lib/docusign_esign/models/document_html_definition_originals.rb +12 -8
- data/lib/docusign_esign/models/document_html_definitions.rb +12 -8
- data/lib/docusign_esign/models/document_html_display_anchor.rb +12 -8
- data/lib/docusign_esign/models/document_html_display_settings.rb +13 -19
- data/lib/docusign_esign/models/document_security_store.rb +11 -7
- data/lib/docusign_esign/models/document_template.rb +12 -8
- data/lib/docusign_esign/models/document_template_list.rb +12 -8
- data/lib/docusign_esign/models/document_update_info.rb +11 -7
- data/lib/docusign_esign/models/document_visibility.rb +12 -8
- data/lib/docusign_esign/models/document_visibility_list.rb +12 -8
- data/lib/docusign_esign/models/e_note_configuration.rb +12 -8
- data/lib/docusign_esign/models/editor.rb +208 -34
- data/lib/docusign_esign/models/email.rb +575 -14
- data/lib/docusign_esign/models/email_address.rb +475 -12
- data/lib/docusign_esign/models/email_settings.rb +11 -8
- data/lib/docusign_esign/models/envelope.rb +246 -19
- data/lib/docusign_esign/models/envelope_attachment.rb +12 -8
- data/lib/docusign_esign/models/envelope_attachments_request.rb +12 -8
- data/lib/docusign_esign/models/envelope_attachments_result.rb +12 -8
- data/lib/docusign_esign/models/envelope_audit_event.rb +12 -8
- data/lib/docusign_esign/models/envelope_audit_event_response.rb +12 -8
- data/lib/docusign_esign/models/envelope_definition.rb +258 -19
- data/lib/docusign_esign/models/envelope_document.rb +111 -18
- data/lib/docusign_esign/models/envelope_documents_result.rb +12 -8
- data/lib/docusign_esign/models/envelope_event.rb +12 -8
- data/lib/docusign_esign/models/envelope_form_data.rb +14 -19
- data/lib/docusign_esign/models/envelope_id.rb +466 -12
- data/lib/docusign_esign/models/envelope_ids_request.rb +12 -8
- data/lib/docusign_esign/models/envelope_metadata.rb +208 -0
- data/lib/docusign_esign/models/envelope_notification_request.rb +12 -8
- data/lib/docusign_esign/models/envelope_purge_configuration.rb +218 -0
- data/lib/docusign_esign/models/envelope_summary.rb +31 -9
- data/lib/docusign_esign/models/envelope_template.rb +461 -21
- data/lib/docusign_esign/models/envelope_template_definition.rb +10 -7
- data/lib/docusign_esign/models/envelope_template_result.rb +12 -28
- data/lib/docusign_esign/models/envelope_template_results.rb +13 -9
- data/lib/docusign_esign/models/envelope_transaction_status.rb +12 -8
- data/lib/docusign_esign/models/envelope_transfer_rule.rb +273 -0
- data/lib/docusign_esign/models/envelope_transfer_rule_information.rb +250 -0
- data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +279 -0
- data/lib/docusign_esign/models/envelope_update_summary.rb +23 -9
- data/lib/docusign_esign/models/envelopes_information.rb +25 -9
- data/lib/docusign_esign/models/error_details.rb +11 -8
- data/lib/docusign_esign/models/event_notification.rb +11 -8
- data/lib/docusign_esign/models/event_result.rb +12 -8
- data/lib/docusign_esign/models/expirations.rb +11 -8
- data/lib/docusign_esign/models/external_claim.rb +218 -0
- data/lib/docusign_esign/models/external_doc_service_error_details.rb +12 -8
- data/lib/docusign_esign/models/external_document_sources.rb +273 -0
- data/lib/docusign_esign/models/external_file.rb +12 -8
- data/lib/docusign_esign/models/external_folder.rb +12 -8
- data/lib/docusign_esign/models/favorite_templates_content_item.rb +207 -0
- data/lib/docusign_esign/models/favorite_templates_info.rb +209 -0
- data/lib/docusign_esign/models/feature_available_metadata.rb +198 -0
- data/lib/docusign_esign/models/feature_set.rb +12 -8
- data/lib/docusign_esign/models/file_type.rb +12 -8
- data/lib/docusign_esign/models/file_type_list.rb +12 -8
- data/lib/docusign_esign/models/filter.rb +12 -8
- data/lib/docusign_esign/models/first_name.rb +475 -12
- data/lib/docusign_esign/models/folder.rb +65 -30
- data/lib/docusign_esign/models/folder_item.rb +11 -7
- data/lib/docusign_esign/models/folder_item_response.rb +12 -8
- data/lib/docusign_esign/models/folder_item_v2.rb +36 -32
- data/lib/docusign_esign/models/folder_items_response.rb +33 -17
- data/lib/docusign_esign/models/folder_shared_item.rb +289 -0
- data/lib/docusign_esign/models/folders_request.rb +25 -9
- data/lib/docusign_esign/models/folders_response.rb +88 -12
- data/lib/docusign_esign/models/forgotten_password_information.rb +11 -8
- data/lib/docusign_esign/models/form_data_item.rb +227 -0
- data/lib/docusign_esign/models/formula_tab.rb +611 -14
- data/lib/docusign_esign/models/full_name.rb +475 -12
- data/lib/docusign_esign/models/graphics_context.rb +208 -0
- data/lib/docusign_esign/models/group.rb +26 -12
- data/lib/docusign_esign/models/group_information.rb +12 -8
- data/lib/docusign_esign/models/id_check_configuration.rb +210 -0
- data/lib/docusign_esign/models/id_check_information_input.rb +11 -8
- data/lib/docusign_esign/models/{payment_signer_values.rb → id_check_security_step.rb} +20 -16
- data/lib/docusign_esign/models/in_person_signer.rb +283 -24
- data/lib/docusign_esign/models/initial_here.rb +422 -13
- data/lib/docusign_esign/models/inline_template.rb +12 -8
- data/lib/docusign_esign/models/integrated_user_info_list.rb +12 -8
- data/lib/docusign_esign/models/intermediary.rb +208 -34
- data/lib/docusign_esign/models/jurisdiction.rb +12 -8
- data/lib/docusign_esign/models/last_name.rb +475 -12
- data/lib/docusign_esign/models/list.rb +530 -13
- data/lib/docusign_esign/models/list_custom_field.rb +12 -8
- data/lib/docusign_esign/models/list_item.rb +43 -12
- data/lib/docusign_esign/models/locale_policy.rb +595 -0
- data/lib/docusign_esign/models/locale_policy_tab.rb +298 -0
- data/lib/docusign_esign/models/lock_information.rb +12 -8
- data/lib/docusign_esign/models/lock_request.rb +12 -8
- data/lib/docusign_esign/models/login_account.rb +12 -8
- data/lib/docusign_esign/models/login_information.rb +12 -8
- data/lib/docusign_esign/models/match_box.rb +17 -13
- data/lib/docusign_esign/models/member_group_shared_item.rb +12 -8
- data/lib/docusign_esign/models/member_shared_items.rb +25 -9
- data/lib/docusign_esign/models/merge_field.rb +81 -12
- data/lib/docusign_esign/models/mobile_notifier_configuration.rb +12 -8
- data/lib/docusign_esign/models/mobile_notifier_configuration_information.rb +12 -8
- data/lib/docusign_esign/models/money.rb +12 -8
- data/lib/docusign_esign/models/name_value.rb +12 -8
- data/lib/docusign_esign/models/new_account_definition.rb +37 -17
- data/lib/docusign_esign/models/new_account_summary.rb +12 -8
- data/lib/docusign_esign/models/new_user.rb +13 -19
- data/lib/docusign_esign/models/new_users_definition.rb +12 -8
- data/lib/docusign_esign/models/new_users_summary.rb +12 -8
- data/lib/docusign_esign/models/notarize.rb +403 -12
- data/lib/docusign_esign/models/notary_host.rb +213 -24
- data/lib/docusign_esign/models/notary_journal.rb +12 -8
- data/lib/docusign_esign/models/notary_journal_credible_witness.rb +12 -8
- data/lib/docusign_esign/models/notary_journal_list.rb +12 -8
- data/lib/docusign_esign/models/notary_journal_meta_data.rb +12 -8
- data/lib/docusign_esign/models/note.rb +466 -14
- data/lib/docusign_esign/models/notification.rb +11 -8
- data/lib/docusign_esign/models/notification_default_settings.rb +196 -0
- data/lib/docusign_esign/models/notification_defaults.rb +196 -0
- data/lib/docusign_esign/models/number.rb +593 -14
- data/lib/docusign_esign/models/oauth_access.rb +12 -8
- data/lib/docusign_esign/models/page.rb +11 -8
- data/lib/docusign_esign/models/page_images.rb +12 -8
- data/lib/docusign_esign/models/page_request.rb +12 -8
- data/lib/docusign_esign/models/page_size.rb +198 -0
- data/lib/docusign_esign/models/{recipient_identity_input_option.rb → path_extended_element.rb} +26 -24
- data/lib/docusign_esign/models/pay_pal_legacy_settings.rb +228 -0
- data/lib/docusign_esign/models/payment_details.rb +31 -18
- data/lib/docusign_esign/models/payment_gateway_account.rb +110 -12
- data/lib/docusign_esign/models/payment_gateway_account_setting.rb +218 -0
- data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +12 -8
- data/lib/docusign_esign/models/payment_line_item.rb +12 -8
- data/lib/docusign_esign/models/payment_method_with_options.rb +200 -0
- data/lib/docusign_esign/models/payment_processor_information.rb +12 -8
- data/lib/docusign_esign/models/permission_profile.rb +12 -8
- data/lib/docusign_esign/models/permission_profile_information.rb +12 -8
- data/lib/docusign_esign/models/plan_information.rb +11 -8
- data/lib/docusign_esign/models/{recipient_identity_phone_number.rb → poly_line.rb} +42 -28
- data/lib/docusign_esign/models/poly_line_overlay.rb +885 -0
- data/lib/docusign_esign/models/power_form.rb +12 -8
- data/lib/docusign_esign/models/power_form_form_data_envelope.rb +12 -8
- data/lib/docusign_esign/models/power_form_form_data_recipient.rb +12 -8
- data/lib/docusign_esign/models/power_form_recipient.rb +12 -8
- data/lib/docusign_esign/models/power_form_senders_response.rb +16 -12
- data/lib/docusign_esign/models/power_forms_form_data_response.rb +12 -8
- data/lib/docusign_esign/models/power_forms_request.rb +12 -8
- data/lib/docusign_esign/models/power_forms_response.rb +16 -12
- data/lib/docusign_esign/models/property_metadata.rb +12 -8
- data/lib/docusign_esign/models/province.rb +12 -8
- data/lib/docusign_esign/models/provisioning_information.rb +12 -8
- data/lib/docusign_esign/models/purchased_envelopes_information.rb +12 -8
- data/lib/docusign_esign/models/radio.rb +321 -12
- data/lib/docusign_esign/models/radio_group.rb +153 -12
- data/lib/docusign_esign/models/recipient_attachment.rb +12 -8
- data/lib/docusign_esign/models/recipient_domain.rb +12 -8
- data/lib/docusign_esign/models/recipient_email_notification.rb +44 -13
- data/lib/docusign_esign/models/recipient_event.rb +12 -8
- data/lib/docusign_esign/models/recipient_form_data.rb +25 -21
- data/lib/docusign_esign/models/recipient_identity_verification.rb +13 -21
- data/lib/docusign_esign/models/recipient_names_response.rb +12 -8
- data/lib/docusign_esign/models/recipient_phone_authentication.rb +51 -12
- data/lib/docusign_esign/models/recipient_preview_request.rb +278 -0
- data/lib/docusign_esign/models/recipient_saml_authentication.rb +10 -7
- data/lib/docusign_esign/models/recipient_signature_information.rb +11 -8
- data/lib/docusign_esign/models/recipient_signature_provider.rb +22 -9
- data/lib/docusign_esign/models/recipient_signature_provider_options.rb +52 -12
- data/lib/docusign_esign/models/recipient_sms_authentication.rb +24 -12
- data/lib/docusign_esign/models/recipient_update_response.rb +33 -9
- data/lib/docusign_esign/models/recipient_view_request.rb +13 -33
- data/lib/docusign_esign/models/recipients.rb +11 -8
- data/lib/docusign_esign/models/recipients_update_summary.rb +12 -8
- data/lib/docusign_esign/models/referral_information.rb +11 -8
- data/lib/docusign_esign/models/reminders.rb +11 -8
- data/lib/docusign_esign/models/resource_information.rb +12 -8
- data/lib/docusign_esign/models/return_url_request.rb +12 -8
- data/lib/docusign_esign/models/revision.rb +11 -7
- data/lib/docusign_esign/models/saml_assertion_attribute.rb +11 -7
- data/lib/docusign_esign/models/seal.rb +13 -9
- data/lib/docusign_esign/models/seal_identifier.rb +12 -8
- data/lib/docusign_esign/models/seal_sign.rb +154 -24
- data/lib/docusign_esign/models/seat_discount.rb +12 -8
- data/lib/docusign_esign/models/sender.rb +11 -7
- data/lib/docusign_esign/models/sender_email_notifications.rb +19 -15
- data/lib/docusign_esign/models/server_template.rb +12 -8
- data/lib/docusign_esign/models/service_information.rb +12 -8
- data/lib/docusign_esign/models/service_version.rb +12 -8
- data/lib/docusign_esign/models/settings_metadata.rb +12 -8
- data/lib/docusign_esign/models/shared_item.rb +12 -8
- data/lib/docusign_esign/models/sign_hash_document.rb +11 -7
- data/lib/docusign_esign/models/sign_hash_session_info_response.rb +11 -7
- data/lib/docusign_esign/models/sign_here.rb +432 -13
- data/lib/docusign_esign/models/sign_session_info_request.rb +11 -7
- data/lib/docusign_esign/models/signature_data_info.rb +11 -7
- data/lib/docusign_esign/models/signature_properties.rb +198 -0
- data/lib/docusign_esign/models/signature_provider_required_option.rb +12 -8
- data/lib/docusign_esign/models/signature_type.rb +12 -8
- data/lib/docusign_esign/models/signer.rb +236 -34
- data/lib/docusign_esign/models/signer_attachment.rb +422 -13
- data/lib/docusign_esign/models/signer_email_notifications.rb +11 -8
- data/lib/docusign_esign/models/signing_group.rb +12 -8
- data/lib/docusign_esign/models/signing_group_information.rb +12 -8
- data/lib/docusign_esign/models/signing_group_user.rb +12 -8
- data/lib/docusign_esign/models/signing_group_users.rb +12 -8
- data/lib/docusign_esign/models/smart_section.rb +452 -12
- data/lib/docusign_esign/models/smart_section_anchor_position.rb +12 -8
- data/lib/docusign_esign/models/smart_section_collapsible_display_settings.rb +12 -8
- data/lib/docusign_esign/models/smart_section_display_settings.rb +13 -19
- data/lib/docusign_esign/models/social_account_information.rb +12 -8
- data/lib/docusign_esign/models/social_authentication.rb +12 -8
- data/lib/docusign_esign/models/ssn.rb +575 -14
- data/lib/docusign_esign/models/ssn4_information_input.rb +12 -8
- data/lib/docusign_esign/models/ssn9_information_input.rb +12 -8
- data/lib/docusign_esign/models/supported_languages.rb +12 -8
- data/lib/docusign_esign/models/tab_account_settings.rb +19 -15
- data/lib/docusign_esign/models/tab_group.rb +911 -0
- data/lib/docusign_esign/models/tab_metadata.rb +13 -39
- data/lib/docusign_esign/models/tab_metadata_list.rb +12 -8
- data/lib/docusign_esign/models/tabs.rb +50 -10
- data/lib/docusign_esign/models/template_custom_fields.rb +12 -8
- data/lib/docusign_esign/models/template_document_visibility_list.rb +12 -8
- data/lib/docusign_esign/models/template_documents_result.rb +12 -8
- data/lib/docusign_esign/models/template_information.rb +12 -8
- data/lib/docusign_esign/models/template_match.rb +12 -8
- data/lib/docusign_esign/models/template_notification_request.rb +12 -8
- data/lib/docusign_esign/models/template_recipients.rb +12 -8
- data/lib/docusign_esign/models/template_role.rb +12 -8
- data/lib/docusign_esign/models/template_shared_item.rb +23 -9
- data/lib/docusign_esign/models/template_summary.rb +22 -9
- data/lib/docusign_esign/models/template_tabs.rb +50 -10
- data/lib/docusign_esign/models/template_update_summary.rb +23 -9
- data/lib/docusign_esign/models/text.rb +584 -15
- data/lib/docusign_esign/models/text_custom_field.rb +12 -8
- data/lib/docusign_esign/models/time_stamp_field.rb +11 -7
- data/lib/docusign_esign/models/title.rb +521 -14
- data/lib/docusign_esign/models/tsp_health_check_request.rb +11 -7
- data/lib/docusign_esign/models/tsp_health_check_status_description.rb +11 -7
- data/lib/docusign_esign/models/update_transaction_request.rb +11 -7
- data/lib/docusign_esign/models/update_transaction_response.rb +11 -7
- data/lib/docusign_esign/models/usage_history.rb +13 -10
- data/lib/docusign_esign/models/user.rb +11 -7
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +14 -67
- data/lib/docusign_esign/models/user_info.rb +43 -9
- data/lib/docusign_esign/models/user_info_list.rb +12 -8
- data/lib/docusign_esign/models/user_info_response.rb +11 -7
- data/lib/docusign_esign/models/user_information.rb +69 -25
- data/lib/docusign_esign/models/user_information_list.rb +12 -8
- data/lib/docusign_esign/models/user_password_information.rb +12 -8
- data/lib/docusign_esign/models/user_password_rules.rb +12 -8
- data/lib/docusign_esign/models/user_profile.rb +13 -9
- data/lib/docusign_esign/models/user_settings_information.rb +1115 -17
- data/lib/docusign_esign/models/user_shared_item.rb +12 -8
- data/lib/docusign_esign/models/user_signature.rb +93 -9
- data/lib/docusign_esign/models/user_signature_definition.rb +115 -12
- data/lib/docusign_esign/models/user_signatures_information.rb +12 -8
- data/lib/docusign_esign/models/user_social_id_result.rb +12 -8
- data/lib/docusign_esign/models/users_response.rb +12 -8
- data/lib/docusign_esign/models/view.rb +457 -14
- data/lib/docusign_esign/models/view_url.rb +12 -8
- data/lib/docusign_esign/models/watermark.rb +12 -8
- data/lib/docusign_esign/models/witness.rb +236 -34
- data/lib/docusign_esign/models/workspace.rb +30 -9
- data/lib/docusign_esign/models/workspace_folder_contents.rb +11 -8
- data/lib/docusign_esign/models/workspace_item.rb +63 -12
- data/lib/docusign_esign/models/workspace_item_list.rb +11 -8
- data/lib/docusign_esign/models/workspace_list.rb +11 -8
- data/lib/docusign_esign/models/{recipient_proof_file.rb → workspace_settings.rb} +20 -16
- data/lib/docusign_esign/models/workspace_user.rb +45 -12
- data/lib/docusign_esign/models/workspace_user_authorization.rb +11 -8
- data/lib/docusign_esign/models/zip.rb +584 -14
- data/lib/docusign_esign/version.rb +1 -1
- data/lib/docusign_esign.rb +138 -60
- data/tests/.DS_Store +0 -0
- data/tests/Gemfile.lock +21 -21
- data/{lib/docusign_esign/api → tests/spec}/.DS_Store +0 -0
- data/tests/spec/unit_tests_using_jwt_spec.rb +2 -61
- metadata +102 -69
- data/docusign_esign-3.11.0.gem +0 -0
- data/lib/docusign_esign/.DS_Store +0 -0
- data/lib/docusign_esign/api/organizations_api.rb +0 -128
- data/lib/docusign_esign/api/signature_api.rb +0 -256
- data/lib/docusign_esign/api/tsps_api.rb +0 -256
- data/lib/docusign_esign/client/.DS_Store +0 -0
- data/tests/docs/private.pem +0 -27
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 9c79cb4b9643ac27c520c21e0912c26f10e0cb4e
|
4
|
+
data.tar.gz: 40ec401fef696d524d3e68e0292dcb5af2a8a5de
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5c9e8154ceba4233580619f78ecc45f68ed2d6fc973fc667ed4f101964dea26665370a804b7158f722f35fbb2579efb54344e3f3d92b3143fe33a3550ccaaff3
|
7
|
+
data.tar.gz: 5e6b267f071d2a47df36326a1ef6ff906762fb2085ac9e5425b1b19448faef56df58e2077c8088831fdbed2cd4a25c81a932e13739e2f049c0575d29a0dce0f4
|
data/CHANGELOG.md
CHANGED
@@ -3,61 +3,6 @@ All notable changes to this project will be documented in this file.
|
|
3
3
|
|
4
4
|
See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
|
5
5
|
|
6
|
-
## [v2.11.0-rc1] - eSignature API v2-21.2.00.00 - 2021-07-13
|
7
|
-
### Added
|
8
|
-
- Added new models and properties.
|
9
|
-
### Changed
|
10
|
-
- Added support for version v2-21.2.00.00 of the DocuSign eSignature API.
|
11
|
-
- Updated the SDK release version.
|
12
|
-
|
13
|
-
## [v2.10.0] - eSignature API v2-21.1.02.00 - 2021-06-04
|
14
|
-
### Breaking
|
15
|
-
- Removed methods `get_account_settings_export`,`get_seal_providers` from Accounts.
|
16
|
-
- Removed methods `create_connect_secret`,`delete_connect_secret`,`generate_connect_secret`,`get_connect_secrets` from Connect.
|
17
|
-
- Removed methods `complete_sign_hash`,`get_user_info`,`health_check`,`sign_hash_session_info`,`update_transaction` from TrustServiceProviders.
|
18
|
-
- Removed method `get_user_list_export` from Users.
|
19
|
-
### Changed
|
20
|
-
- Added support for version v2-21.1.02.00 of the DocuSign eSignature API.
|
21
|
-
- Updated the SDK release version.
|
22
|
-
|
23
|
-
## [v2.9.0] - eSignature API v2-21.1.01.03 - 2021-04-25
|
24
|
-
### Added
|
25
|
-
- Added new method `delete_connect_secret` to connect.
|
26
|
-
### Changed
|
27
|
-
- Added support for version v2-21.1.01.03 of the DocuSign eSignature API.
|
28
|
-
- Updated the SDK release version.
|
29
|
-
|
30
|
-
## [v2.4.0] - eSignature API v2-20.1.02 - 2020-05-31
|
31
|
-
### Changed
|
32
|
-
- Added support for version v2-20.1.02 of the DocuSign eSignature API.
|
33
|
-
- Updated the SDK release version.
|
34
|
-
|
35
|
-
## [v2.3.1] - eSignature API v2-20.1.00 - 2020-04-15
|
36
|
-
### Changed
|
37
|
-
- Updated jwt to version 2.2.1.
|
38
|
-
|
39
|
-
## [v2.3.0] - eSignature API v2-20.1.00 - 2020-03-13
|
40
|
-
### Changed
|
41
|
-
- Added support for version v2-20.1.00 of the DocuSign eSignature API.
|
42
|
-
- Updated rake to version 12.3.3.
|
43
|
-
- Updated the SDK release version.
|
44
|
-
### Added
|
45
|
-
- Added the new property `copy_recipient_data` to envelopes. When set to **true**, the information that recipients enter is retained when you clone an envelope. For example, if you resend an envelope that was declined or voided after one or more recipients entered data, that data is retained. Note that the account setting `enable_envelope_copy_with_data` must be set to **true**.
|
46
|
-
- Added a new object, `RecipientIdentityInputOption`: Reserved for DocuSign.
|
47
|
-
- Added a new parameter, `input_options`, to `AccountIdentityVerificationWorkflow`: Reserved for DocuSign.
|
48
|
-
|
49
|
-
## [v2.1.0] - eSignature API v2-19.2.02 - 2019-10-08
|
50
|
-
### Changed
|
51
|
-
- The SDK now supports version 19.2.02 of the DocuSign eSignature v2 API.
|
52
|
-
- SDK Release Version updated.
|
53
|
-
## Fixed
|
54
|
-
- Issue [`#23`](https://github.com/docusign/docusign-ruby-client/issues/23): Support for DocuSign API 2.1. (DCM-3546)
|
55
|
-
- Issue [`#22`](https://github.com/docusign/docusign-ruby-client/issues/22): JSON version of version 2.0. (DCM-3375)
|
56
|
-
- Issue [`#17`](https://github.com/docusign/docusign-ruby-client/issues/17): Client doesn't properly handle Dropdown. (DCM-3192)
|
57
|
-
- Issue [`#16`](https://github.com/docusign/docusign-ruby-client/issues/16): Client doesn't properly handle Text tabs with Date Validation. (DCM-3193)
|
58
|
-
- Issue [`#15`](https://github.com/docusign/docusign-ruby-client/issues/15): ListStatus not accepting envelope_ids. (DCM-3123)
|
59
|
-
- Issue [`#7`](https://github.com/docusign/docusign-ruby-client/issues/7): Allow passing in JWT. (DCM-2312)
|
60
|
-
|
61
6
|
## [2.0.0] - eSignature API v19.1.02 - 2019-06-08
|
62
7
|
### BREAKING
|
63
8
|
* Moved ApiClient and ApiException under Client folder
|
data/Gemfile
CHANGED
data/Gemfile.lock
CHANGED
@@ -1,9 +1,9 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
docusign_esign (3.
|
4
|
+
docusign_esign (3.0.0)
|
5
5
|
json (~> 2.1, >= 2.1.0)
|
6
|
-
jwt (~>
|
6
|
+
jwt (~> 1.0, >= 1.5.2)
|
7
7
|
typhoeus (~> 1.0, >= 1.0.1)
|
8
8
|
|
9
9
|
GEM
|
@@ -14,38 +14,38 @@ GEM
|
|
14
14
|
public_suffix (>= 2.0.2, < 5.0)
|
15
15
|
autotest (4.4.6)
|
16
16
|
ZenTest (>= 4.4.1)
|
17
|
-
autotest-fsevent (0.2.
|
17
|
+
autotest-fsevent (0.2.14)
|
18
18
|
sys-uname
|
19
19
|
autotest-growl (0.2.16)
|
20
20
|
autotest-rails-pure (4.1.2)
|
21
|
-
crack (0.4.
|
22
|
-
|
23
|
-
diff-lcs (1.
|
24
|
-
ethon (0.
|
25
|
-
ffi (>= 1.
|
26
|
-
ffi (1.
|
27
|
-
hashdiff (1.0.
|
28
|
-
json (2.
|
29
|
-
jwt (
|
30
|
-
public_suffix (4.0.
|
31
|
-
rake (12.
|
32
|
-
|
33
|
-
|
34
|
-
rspec-
|
35
|
-
rspec-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
rspec-expectations (3.10.1)
|
21
|
+
crack (0.4.3)
|
22
|
+
safe_yaml (~> 1.0.0)
|
23
|
+
diff-lcs (1.3)
|
24
|
+
ethon (0.12.0)
|
25
|
+
ffi (>= 1.3.0)
|
26
|
+
ffi (1.11.1)
|
27
|
+
hashdiff (1.0.0)
|
28
|
+
json (2.2.0)
|
29
|
+
jwt (1.5.6)
|
30
|
+
public_suffix (4.0.1)
|
31
|
+
rake (12.0.0)
|
32
|
+
rspec (3.8.0)
|
33
|
+
rspec-core (~> 3.8.0)
|
34
|
+
rspec-expectations (~> 3.8.0)
|
35
|
+
rspec-mocks (~> 3.8.0)
|
36
|
+
rspec-core (3.8.2)
|
37
|
+
rspec-support (~> 3.8.0)
|
38
|
+
rspec-expectations (3.8.4)
|
40
39
|
diff-lcs (>= 1.2.0, < 2.0)
|
41
|
-
rspec-support (~> 3.
|
42
|
-
rspec-mocks (3.
|
40
|
+
rspec-support (~> 3.8.0)
|
41
|
+
rspec-mocks (3.8.1)
|
43
42
|
diff-lcs (>= 1.2.0, < 2.0)
|
44
|
-
rspec-support (~> 3.
|
45
|
-
rspec-support (3.
|
46
|
-
|
47
|
-
|
48
|
-
|
43
|
+
rspec-support (~> 3.8.0)
|
44
|
+
rspec-support (3.8.2)
|
45
|
+
safe_yaml (1.0.5)
|
46
|
+
sys-uname (1.1.0)
|
47
|
+
ffi (>= 1.0.0)
|
48
|
+
typhoeus (1.3.1)
|
49
49
|
ethon (>= 0.9.0)
|
50
50
|
vcr (3.0.3)
|
51
51
|
webmock (1.24.6)
|
@@ -62,7 +62,7 @@ DEPENDENCIES
|
|
62
62
|
autotest-growl (~> 0.2, >= 0.2.16)
|
63
63
|
autotest-rails-pure (~> 4.1, >= 4.1.2)
|
64
64
|
docusign_esign!
|
65
|
-
rake (~> 12.
|
65
|
+
rake (~> 12.0.0)
|
66
66
|
rspec (~> 3.4, >= 3.4.0)
|
67
67
|
rspec-expectations (~> 3.8, >= 3.8.0)
|
68
68
|
rspec-mocks (~> 3.8, >= 3.8.0)
|
@@ -70,4 +70,4 @@ DEPENDENCIES
|
|
70
70
|
webmock (~> 1.24, >= 1.24.3)
|
71
71
|
|
72
72
|
BUNDLED WITH
|
73
|
-
|
73
|
+
2.0.2
|
data/README.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
# The Official DocuSign
|
1
|
+
# The Official DocuSign Ruby Client
|
2
2
|
|
3
3
|
[![RubyGems version][rubygems-image]][rubygems-url]
|
4
4
|
[![RubyGems downloads][downloads-image]][downloads-url]
|
@@ -13,48 +13,66 @@
|
|
13
13
|
|
14
14
|
- Ruby 1.9+
|
15
15
|
|
16
|
+
## Note
|
17
|
+
|
18
|
+
This open-source SDK is provided for cases where you would like to make additional changes that the SDK does not provide out-of-the-box. If you simply want to use the SDK with any of the examples shown in the [Developer Center](https://developers.docusign.com/esign-rest-api/code-examples), follow the installation instructions below.
|
19
|
+
|
16
20
|
## Installation
|
17
|
-
This SDK is provided as open source, which enables you to customize its functionality to suit your particular use case. To do so, download or clone the repository. If the SDK’s given functionality meets your integration needs, or if you’re working through our [code examples](https://developers.docusign.com/docs/esign-rest-api/how-to/) from the [DocuSign Developer Center](https://developers.docusign.com/), you merely need to install it by following the instructions below.
|
18
21
|
|
19
|
-
###
|
20
|
-
|
21
|
-
|
22
|
+
### Install via your application's **Gemfile**:
|
23
|
+
|
24
|
+
1. In your application's **Gemfile**, add:
|
25
|
+
**gem 'docusign_esign'**
|
22
26
|
2. Open your preferred console.
|
23
|
-
3. In your project directory, execute the installer by typing:
|
27
|
+
3. In your project directory, execute the installer by typing:
|
28
|
+
**bundle install**
|
29
|
+
|
30
|
+
### Manual install:
|
24
31
|
|
25
|
-
### Manual installation:
|
26
32
|
1. Open your preferred console.
|
27
|
-
2. In the console, type:
|
33
|
+
2. In the console, type:
|
34
|
+
**gem install docusign_esign**
|
28
35
|
|
29
36
|
### Dependencies
|
37
|
+
|
30
38
|
This client has the following external dependencies:
|
31
|
-
* Jwt>=1.5.2
|
32
|
-
* Json>=2.1.0
|
33
|
-
* Typhoeus>=1.0.1
|
34
39
|
|
35
|
-
|
36
|
-
|
40
|
+
- Jwt>=1.5.2
|
41
|
+
- Json>=1.8.3
|
42
|
+
- Typhoeus>=1.0.1
|
43
|
+
|
44
|
+
## Code Examples
|
45
|
+
|
46
|
+
### Launchers
|
37
47
|
|
38
|
-
|
39
|
-
|
48
|
+
DocuSign provides a sample application referred to as a [Launcher](https://github.com/docusign/eg-03-ruby-auth-code-grant). The Launcher contains a set of 14 common use cases and associated source files. These examples use DocuSign's [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
|
49
|
+
|
50
|
+
### Proof-of-concept applications
|
51
|
+
|
52
|
+
If your goal is to create a proof-of-concept application, DocuSign provides a set of [Quick Start](https://github.com/docusign/qs-ruby) examples. The Quick Start examples are meant to be used with DocuSign's [OAuth Token Generator](https://developers.docusign.com/oauth-token-generator), which will allow you to generate tokens for the Demo/Sandbox environment only. These tokens last for eight hours and will enable you to build your proof-of-concept application without the need to fully implement an OAuth solution.
|
53
|
+
|
54
|
+
## OAuth Implementations
|
55
|
+
|
56
|
+
For details regarding which type of OAuth grant will work best for your DocuSign integration, see the [REST API Authentication Overview](https://developers.docusign.com/esign-rest-api/guides/authentication) guide located on the [DocuSign Developer Center](https://developers.docusign.com/esign-rest-api/guides/authentication).
|
40
57
|
|
41
58
|
For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
|
42
59
|
|
60
|
+
There are other use-case scenarios, such as **single-page applications** (SPA) that use **Cross-Origin Resource Sharing** (CORS), or where there may not be a user to interact with your Service Account. For these use cases, DocuSign also supports [JWT](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-jsonwebtoken) and [Implicit](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-implicit) grants. For code examples, see the links below:
|
61
|
+
|
62
|
+
- [JWT (JSON Web Token)](https://github.com/docusign/eg-03-ruby-auth-code-grant)
|
63
|
+
- Implicit Grant (coming soon)
|
64
|
+
|
43
65
|
## Support
|
66
|
+
|
44
67
|
Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
|
45
68
|
|
46
69
|
## License
|
47
|
-
The DocuSign eSignature Ruby Client SDK is licensed under the [MIT License](https://github.com/docusign/docusign-ruby-client/blob/master/LICENSE).
|
48
70
|
|
49
|
-
|
50
|
-
* [DocuSign Developer Center](https://developers.docusign.com/)
|
51
|
-
* [DocuSign API on Twitter](https://twitter.com/docusignapi)
|
52
|
-
* [DocuSign For Developers on LinkedIn](https://www.linkedin.com/showcase/docusign-for-developers/)
|
53
|
-
* [DocuSign For Developers on YouTube](https://www.youtube.com/channel/UCJSJ2kMs_qeQotmw4-lX2NQ)
|
71
|
+
The DocuSign Ruby Client is licensed under the [MIT License](https://github.com/docusign/docusign-ruby-client/blob/master/LICENSE).
|
54
72
|
|
55
73
|
[rubygems-image]: https://img.shields.io/gem/v/docusign_esign.svg?style=flat
|
56
74
|
[rubygems-url]: https://rubygems.org/gems/docusign_esign
|
57
75
|
[downloads-image]: https://img.shields.io/gem/dt/docusign_esign.svg?style=flat
|
58
76
|
[downloads-url]: https://rubygems.org/gems/docusign_esign
|
59
77
|
[travis-image]: https://img.shields.io/travis/docusign/docusign-ruby-client.svg?style=flat
|
60
|
-
[travis-url]: https://travis-ci.org/docusign/docusign-ruby-client
|
78
|
+
[travis-url]: https://travis-ci.org/docusign/docusign-ruby-client
|
Binary file
|
data/docusign_esign.gemspec
CHANGED
@@ -26,8 +26,7 @@ Gem::Specification.new do |s|
|
|
26
26
|
s.license = "MIT"
|
27
27
|
s.required_ruby_version = ">= 1.9"
|
28
28
|
|
29
|
-
s.add_runtime_dependency 'jwt', '~>
|
30
|
-
s.add_runtime_dependency 'addressable', '~> 2.7', '>= 2.7.0'
|
29
|
+
s.add_runtime_dependency 'jwt', '~> 1.0', '>= 1.5.2'
|
31
30
|
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
32
31
|
s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
|
33
32
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
|
5
5
|
|
6
|
-
OpenAPI spec version: v2
|
6
|
+
OpenAPI spec version: v2.1
|
7
7
|
Contact: devcenter@docusign.com
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
9
|
|
@@ -49,15 +49,6 @@ module DocuSign_eSign
|
|
49
49
|
end
|
50
50
|
end
|
51
51
|
|
52
|
-
class DeletePermissionProfileOptions
|
53
|
-
#
|
54
|
-
attr_accessor :move_users_to
|
55
|
-
|
56
|
-
def self.default
|
57
|
-
@@default ||= DeletePermissionProfileOptions.new
|
58
|
-
end
|
59
|
-
end
|
60
|
-
|
61
52
|
class GetAccountInformationOptions
|
62
53
|
# When set to **true**, includes the account settings for the account in the response.
|
63
54
|
attr_accessor :include_account_settings
|
@@ -101,7 +92,7 @@ module DocuSign_eSign
|
|
101
92
|
end
|
102
93
|
|
103
94
|
class GetConsumerDisclosureDefaultOptions
|
104
|
-
# Specifies the language used in the response. The supported languages, with the language value shown in parenthesis, are: Arabic (ar),
|
95
|
+
# Specifies the language used in the response. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk), and Vietnamese (vi). Additionally, the value can be set to `browser` to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
105
96
|
attr_accessor :lang_code
|
106
97
|
|
107
98
|
def self.default
|
@@ -209,6 +200,9 @@ module DocuSign_eSign
|
|
209
200
|
#
|
210
201
|
attr_accessor :item_type
|
211
202
|
|
203
|
+
#
|
204
|
+
attr_accessor :preserve_existing_shared_access
|
205
|
+
|
212
206
|
#
|
213
207
|
attr_accessor :user_ids
|
214
208
|
|
@@ -245,7 +239,7 @@ module DocuSign_eSign
|
|
245
239
|
@api_client.config.logger.debug "Calling API: AccountsApi.create ..."
|
246
240
|
end
|
247
241
|
# resource path
|
248
|
-
local_var_path = "/v2/accounts".sub('{format}','json')
|
242
|
+
local_var_path = "/v2.1/accounts".sub('{format}','json')
|
249
243
|
|
250
244
|
# query parameters
|
251
245
|
query_params = {}
|
@@ -277,7 +271,7 @@ module DocuSign_eSign
|
|
277
271
|
|
278
272
|
# Creates one or more brand profile files for the account.
|
279
273
|
# Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSig`) must be set to **true** for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`.
|
280
|
-
# @param account_id The external account number (int) or account
|
274
|
+
# @param account_id The external account number (int) or account ID Guid.
|
281
275
|
# @param brand (optional parameter)
|
282
276
|
# @return [BrandsResponse]
|
283
277
|
def create_brand(account_id, brand)
|
@@ -287,7 +281,7 @@ module DocuSign_eSign
|
|
287
281
|
|
288
282
|
# Creates one or more brand profile files for the account.
|
289
283
|
# Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSig`) must be set to **true** for the account to use this call. An error is returned if `brandId` property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When brand profile files are being uploaded, they must be combined into one zip file and the `Content-Type` must be `application/zip`.
|
290
|
-
# @param account_id The external account number (int) or account
|
284
|
+
# @param account_id The external account number (int) or account ID Guid.
|
291
285
|
# @param brand (optional parameter)
|
292
286
|
# @return [Array<(BrandsResponse, Fixnum, Hash)>] BrandsResponse data, response status code and response headers
|
293
287
|
def create_brand_with_http_info(account_id, brand)
|
@@ -297,7 +291,7 @@ module DocuSign_eSign
|
|
297
291
|
# verify the required parameter 'account_id' is set
|
298
292
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_brand" if account_id.nil?
|
299
293
|
# resource path
|
300
|
-
local_var_path = "/v2/accounts/{accountId}/brands".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
294
|
+
local_var_path = "/v2.1/accounts/{accountId}/brands".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
301
295
|
|
302
296
|
# query parameters
|
303
297
|
query_params = {}
|
@@ -350,7 +344,7 @@ module DocuSign_eSign
|
|
350
344
|
# verify the required parameter 'account_id' is set
|
351
345
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_custom_field" if account_id.nil?
|
352
346
|
# resource path
|
353
|
-
local_var_path = "/v2/accounts/{accountId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
347
|
+
local_var_path = "/v2.1/accounts/{accountId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
354
348
|
|
355
349
|
# query parameters
|
356
350
|
query_params = {}
|
@@ -404,7 +398,7 @@ module DocuSign_eSign
|
|
404
398
|
# verify the required parameter 'account_id' is set
|
405
399
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_permission_profile" if account_id.nil?
|
406
400
|
# resource path
|
407
|
-
local_var_path = "/v2/accounts/{accountId}/permission_profiles".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
401
|
+
local_var_path = "/v2.1/accounts/{accountId}/permission_profiles".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
408
402
|
|
409
403
|
# query parameters
|
410
404
|
query_params = {}
|
@@ -454,7 +448,7 @@ module DocuSign_eSign
|
|
454
448
|
# verify the required parameter 'account_id' is set
|
455
449
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete" if account_id.nil?
|
456
450
|
# resource path
|
457
|
-
local_var_path = "/v2/accounts/{accountId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
451
|
+
local_var_path = "/v2.1/accounts/{accountId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
458
452
|
|
459
453
|
# query parameters
|
460
454
|
query_params = {}
|
@@ -506,7 +500,7 @@ module DocuSign_eSign
|
|
506
500
|
# verify the required parameter 'brand_id' is set
|
507
501
|
fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.delete_brand" if brand_id.nil?
|
508
502
|
# resource path
|
509
|
-
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s)
|
503
|
+
local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s)
|
510
504
|
|
511
505
|
# query parameters
|
512
506
|
query_params = {}
|
@@ -562,7 +556,7 @@ module DocuSign_eSign
|
|
562
556
|
# verify the required parameter 'logo_type' is set
|
563
557
|
fail ArgumentError, "Missing the required parameter 'logo_type' when calling AccountsApi.delete_brand_logo_by_type" if logo_type.nil?
|
564
558
|
# resource path
|
565
|
-
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'logoType' + '}', logo_type.to_s)
|
559
|
+
local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'logoType' + '}', logo_type.to_s)
|
566
560
|
|
567
561
|
# query parameters
|
568
562
|
query_params = {}
|
@@ -612,7 +606,7 @@ module DocuSign_eSign
|
|
612
606
|
# verify the required parameter 'account_id' is set
|
613
607
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_brands" if account_id.nil?
|
614
608
|
# resource path
|
615
|
-
local_var_path = "/v2/accounts/{accountId}/brands".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
609
|
+
local_var_path = "/v2.1/accounts/{accountId}/brands".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
616
610
|
|
617
611
|
# query parameters
|
618
612
|
query_params = {}
|
@@ -667,7 +661,7 @@ module DocuSign_eSign
|
|
667
661
|
# verify the required parameter 'recipient_part' is set
|
668
662
|
fail ArgumentError, "Missing the required parameter 'recipient_part' when calling AccountsApi.delete_captive_recipient" if recipient_part.nil?
|
669
663
|
# resource path
|
670
|
-
local_var_path = "/v2/accounts/{accountId}/captive_recipients/{recipientPart}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientPart' + '}', recipient_part.to_s)
|
664
|
+
local_var_path = "/v2.1/accounts/{accountId}/captive_recipients/{recipientPart}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'recipientPart' + '}', recipient_part.to_s)
|
671
665
|
|
672
666
|
# query parameters
|
673
667
|
query_params = {}
|
@@ -722,7 +716,7 @@ module DocuSign_eSign
|
|
722
716
|
# verify the required parameter 'custom_field_id' is set
|
723
717
|
fail ArgumentError, "Missing the required parameter 'custom_field_id' when calling AccountsApi.delete_custom_field" if custom_field_id.nil?
|
724
718
|
# resource path
|
725
|
-
local_var_path = "/v2/accounts/{accountId}/custom_fields/{customFieldId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'customFieldId' + '}', custom_field_id.to_s)
|
719
|
+
local_var_path = "/v2.1/accounts/{accountId}/custom_fields/{customFieldId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'customFieldId' + '}', custom_field_id.to_s)
|
726
720
|
|
727
721
|
# query parameters
|
728
722
|
query_params = {}
|
@@ -771,7 +765,7 @@ module DocuSign_eSign
|
|
771
765
|
# verify the required parameter 'account_id' is set
|
772
766
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_e_note_configuration" if account_id.nil?
|
773
767
|
# resource path
|
774
|
-
local_var_path = "/v2/accounts/{accountId}/settings/enote_configuration".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
768
|
+
local_var_path = "/v2.1/accounts/{accountId}/settings/enote_configuration".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
775
769
|
|
776
770
|
# query parameters
|
777
771
|
query_params = {}
|
@@ -803,10 +797,9 @@ module DocuSign_eSign
|
|
803
797
|
#
|
804
798
|
# @param account_id The external account number (int) or account ID Guid.
|
805
799
|
# @param permission_profile_id
|
806
|
-
# @param DocuSign_eSign::DeletePermissionProfileOptions Options for modifying the behavior of the function.
|
807
800
|
# @return [nil]
|
808
|
-
def delete_permission_profile(account_id, permission_profile_id
|
809
|
-
delete_permission_profile_with_http_info(account_id, permission_profile_id
|
801
|
+
def delete_permission_profile(account_id, permission_profile_id)
|
802
|
+
delete_permission_profile_with_http_info(account_id, permission_profile_id)
|
810
803
|
return nil
|
811
804
|
end
|
812
805
|
|
@@ -814,9 +807,8 @@ module DocuSign_eSign
|
|
814
807
|
#
|
815
808
|
# @param account_id The external account number (int) or account ID Guid.
|
816
809
|
# @param permission_profile_id
|
817
|
-
# @param DocuSign_eSign::DeletePermissionProfileOptions Options for modifying the behavior of the function.
|
818
810
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
819
|
-
def delete_permission_profile_with_http_info(account_id, permission_profile_id
|
811
|
+
def delete_permission_profile_with_http_info(account_id, permission_profile_id)
|
820
812
|
if @api_client.config.debugging
|
821
813
|
@api_client.config.logger.debug "Calling API: AccountsApi.delete_permission_profile ..."
|
822
814
|
end
|
@@ -825,11 +817,10 @@ module DocuSign_eSign
|
|
825
817
|
# verify the required parameter 'permission_profile_id' is set
|
826
818
|
fail ArgumentError, "Missing the required parameter 'permission_profile_id' when calling AccountsApi.delete_permission_profile" if permission_profile_id.nil?
|
827
819
|
# resource path
|
828
|
-
local_var_path = "/v2/accounts/{accountId}/permission_profiles/{permissionProfileId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'permissionProfileId' + '}', permission_profile_id.to_s)
|
820
|
+
local_var_path = "/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'permissionProfileId' + '}', permission_profile_id.to_s)
|
829
821
|
|
830
822
|
# query parameters
|
831
823
|
query_params = {}
|
832
|
-
query_params[:'move_users_to'] = options.move_users_to if !options.move_users_to.nil?
|
833
824
|
|
834
825
|
# header parameters
|
835
826
|
header_params = {}
|
@@ -874,7 +865,7 @@ module DocuSign_eSign
|
|
874
865
|
# verify the required parameter 'account_id' is set
|
875
866
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_identity_verification" if account_id.nil?
|
876
867
|
# resource path
|
877
|
-
local_var_path = "/v2/accounts/{accountId}/identity_verification".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
868
|
+
local_var_path = "/v2.1/accounts/{accountId}/identity_verification".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
878
869
|
|
879
870
|
# query parameters
|
880
871
|
query_params = {}
|
@@ -925,7 +916,7 @@ module DocuSign_eSign
|
|
925
916
|
# verify the required parameter 'account_id' is set
|
926
917
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_information" if account_id.nil?
|
927
918
|
# resource path
|
928
|
-
local_var_path = "/v2/accounts/{accountId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
919
|
+
local_var_path = "/v2.1/accounts/{accountId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
929
920
|
|
930
921
|
# query parameters
|
931
922
|
query_params = {}
|
@@ -975,7 +966,7 @@ module DocuSign_eSign
|
|
975
966
|
# verify the required parameter 'account_id' is set
|
976
967
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_tab_settings" if account_id.nil?
|
977
968
|
# resource path
|
978
|
-
local_var_path = "/v2/accounts/{accountId}/settings/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
969
|
+
local_var_path = "/v2.1/accounts/{accountId}/settings/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
979
970
|
|
980
971
|
# query parameters
|
981
972
|
query_params = {}
|
@@ -1024,7 +1015,7 @@ module DocuSign_eSign
|
|
1024
1015
|
# verify the required parameter 'account_id' is set
|
1025
1016
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_all_payment_gateway_accounts" if account_id.nil?
|
1026
1017
|
# resource path
|
1027
|
-
local_var_path = "/v2/accounts/{accountId}/payment_gateway_accounts".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1018
|
+
local_var_path = "/v2.1/accounts/{accountId}/payment_gateway_accounts".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1028
1019
|
|
1029
1020
|
# query parameters
|
1030
1021
|
query_params = {}
|
@@ -1075,7 +1066,7 @@ module DocuSign_eSign
|
|
1075
1066
|
# verify the required parameter 'account_id' is set
|
1076
1067
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_billing_charges" if account_id.nil?
|
1077
1068
|
# resource path
|
1078
|
-
local_var_path = "/v2/accounts/{accountId}/billing_charges".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1069
|
+
local_var_path = "/v2.1/accounts/{accountId}/billing_charges".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1079
1070
|
|
1080
1071
|
# query parameters
|
1081
1072
|
query_params = {}
|
@@ -1131,7 +1122,7 @@ module DocuSign_eSign
|
|
1131
1122
|
# verify the required parameter 'brand_id' is set
|
1132
1123
|
fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.get_brand" if brand_id.nil?
|
1133
1124
|
# resource path
|
1134
|
-
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s)
|
1125
|
+
local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s)
|
1135
1126
|
|
1136
1127
|
# query parameters
|
1137
1128
|
query_params = {}
|
@@ -1186,7 +1177,7 @@ module DocuSign_eSign
|
|
1186
1177
|
# verify the required parameter 'brand_id' is set
|
1187
1178
|
fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.get_brand_export_file" if brand_id.nil?
|
1188
1179
|
# resource path
|
1189
|
-
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}/file".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s)
|
1180
|
+
local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/file".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s)
|
1190
1181
|
|
1191
1182
|
# query parameters
|
1192
1183
|
query_params = {}
|
@@ -1242,7 +1233,7 @@ module DocuSign_eSign
|
|
1242
1233
|
# verify the required parameter 'logo_type' is set
|
1243
1234
|
fail ArgumentError, "Missing the required parameter 'logo_type' when calling AccountsApi.get_brand_logo_by_type" if logo_type.nil?
|
1244
1235
|
# resource path
|
1245
|
-
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'logoType' + '}', logo_type.to_s)
|
1236
|
+
local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'logoType' + '}', logo_type.to_s)
|
1246
1237
|
|
1247
1238
|
# query parameters
|
1248
1239
|
query_params = {}
|
@@ -1295,7 +1286,7 @@ module DocuSign_eSign
|
|
1295
1286
|
# verify the required parameter 'brand_id' is set
|
1296
1287
|
fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.get_brand_resources" if brand_id.nil?
|
1297
1288
|
# resource path
|
1298
|
-
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}/resources".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s)
|
1289
|
+
local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/resources".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s)
|
1299
1290
|
|
1300
1291
|
# query parameters
|
1301
1292
|
query_params = {}
|
@@ -1354,7 +1345,7 @@ module DocuSign_eSign
|
|
1354
1345
|
# verify the required parameter 'resource_content_type' is set
|
1355
1346
|
fail ArgumentError, "Missing the required parameter 'resource_content_type' when calling AccountsApi.get_brand_resources_by_content_type" if resource_content_type.nil?
|
1356
1347
|
# resource path
|
1357
|
-
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'resourceContentType' + '}', resource_content_type.to_s)
|
1348
|
+
local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'resourceContentType' + '}', resource_content_type.to_s)
|
1358
1349
|
|
1359
1350
|
# query parameters
|
1360
1351
|
query_params = {}
|
@@ -1387,7 +1378,7 @@ module DocuSign_eSign
|
|
1387
1378
|
# Gets the Electronic Record and Signature Disclosure.
|
1388
1379
|
# Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.
|
1389
1380
|
# @param account_id The external account number (int) or account ID Guid.
|
1390
|
-
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar),
|
1381
|
+
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
1391
1382
|
# @return [ConsumerDisclosure]
|
1392
1383
|
def get_consumer_disclosure(account_id, lang_code)
|
1393
1384
|
data, _status_code, _headers = get_consumer_disclosure_with_http_info(account_id, lang_code)
|
@@ -1397,7 +1388,7 @@ module DocuSign_eSign
|
|
1397
1388
|
# Gets the Electronic Record and Signature Disclosure.
|
1398
1389
|
# Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.
|
1399
1390
|
# @param account_id The external account number (int) or account ID Guid.
|
1400
|
-
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar),
|
1391
|
+
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
1401
1392
|
# @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
|
1402
1393
|
def get_consumer_disclosure_with_http_info(account_id, lang_code)
|
1403
1394
|
if @api_client.config.debugging
|
@@ -1408,7 +1399,7 @@ module DocuSign_eSign
|
|
1408
1399
|
# verify the required parameter 'lang_code' is set
|
1409
1400
|
fail ArgumentError, "Missing the required parameter 'lang_code' when calling AccountsApi.get_consumer_disclosure" if lang_code.nil?
|
1410
1401
|
# resource path
|
1411
|
-
local_var_path = "/v2/accounts/{accountId}/consumer_disclosure/{langCode}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'langCode' + '}', lang_code.to_s)
|
1402
|
+
local_var_path = "/v2.1/accounts/{accountId}/consumer_disclosure/{langCode}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'langCode' + '}', lang_code.to_s)
|
1412
1403
|
|
1413
1404
|
# query parameters
|
1414
1405
|
query_params = {}
|
@@ -1459,7 +1450,7 @@ module DocuSign_eSign
|
|
1459
1450
|
# verify the required parameter 'account_id' is set
|
1460
1451
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_consumer_disclosure_default" if account_id.nil?
|
1461
1452
|
# resource path
|
1462
|
-
local_var_path = "/v2/accounts/{accountId}/consumer_disclosure".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1453
|
+
local_var_path = "/v2.1/accounts/{accountId}/consumer_disclosure".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1463
1454
|
|
1464
1455
|
# query parameters
|
1465
1456
|
query_params = {}
|
@@ -1509,7 +1500,7 @@ module DocuSign_eSign
|
|
1509
1500
|
# verify the required parameter 'account_id' is set
|
1510
1501
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_e_note_configuration" if account_id.nil?
|
1511
1502
|
# resource path
|
1512
|
-
local_var_path = "/v2/accounts/{accountId}/settings/enote_configuration".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1503
|
+
local_var_path = "/v2.1/accounts/{accountId}/settings/enote_configuration".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1513
1504
|
|
1514
1505
|
# query parameters
|
1515
1506
|
query_params = {}
|
@@ -1538,6 +1529,153 @@ module DocuSign_eSign
|
|
1538
1529
|
return data, status_code, headers
|
1539
1530
|
end
|
1540
1531
|
|
1532
|
+
# Select envelope purge configuration.
|
1533
|
+
#
|
1534
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1535
|
+
# @return [EnvelopePurgeConfiguration]
|
1536
|
+
def get_envelope_purge_configuration(account_id)
|
1537
|
+
data, _status_code, _headers = get_envelope_purge_configuration_with_http_info(account_id)
|
1538
|
+
return data
|
1539
|
+
end
|
1540
|
+
|
1541
|
+
# Select envelope purge configuration.
|
1542
|
+
#
|
1543
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1544
|
+
# @return [Array<(EnvelopePurgeConfiguration, Fixnum, Hash)>] EnvelopePurgeConfiguration data, response status code and response headers
|
1545
|
+
def get_envelope_purge_configuration_with_http_info(account_id)
|
1546
|
+
if @api_client.config.debugging
|
1547
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_envelope_purge_configuration ..."
|
1548
|
+
end
|
1549
|
+
# verify the required parameter 'account_id' is set
|
1550
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_envelope_purge_configuration" if account_id.nil?
|
1551
|
+
# resource path
|
1552
|
+
local_var_path = "/v2.1/accounts/{accountId}/settings/envelope_purge_configuration".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1553
|
+
|
1554
|
+
# query parameters
|
1555
|
+
query_params = {}
|
1556
|
+
|
1557
|
+
# header parameters
|
1558
|
+
header_params = {}
|
1559
|
+
# HTTP header 'Accept' (if needed)
|
1560
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1561
|
+
|
1562
|
+
# form parameters
|
1563
|
+
form_params = {}
|
1564
|
+
|
1565
|
+
# http body (model)
|
1566
|
+
post_body = nil
|
1567
|
+
auth_names = []
|
1568
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1569
|
+
:header_params => header_params,
|
1570
|
+
:query_params => query_params,
|
1571
|
+
:form_params => form_params,
|
1572
|
+
:body => post_body,
|
1573
|
+
:auth_names => auth_names,
|
1574
|
+
:return_type => 'EnvelopePurgeConfiguration')
|
1575
|
+
if @api_client.config.debugging
|
1576
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_envelope_purge_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1577
|
+
end
|
1578
|
+
return data, status_code, headers
|
1579
|
+
end
|
1580
|
+
|
1581
|
+
# Retrieves the list of favorited templates for this caller
|
1582
|
+
#
|
1583
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1584
|
+
# @return [FavoriteTemplatesInfo]
|
1585
|
+
def get_favorite_templates(account_id)
|
1586
|
+
data, _status_code, _headers = get_favorite_templates_with_http_info(account_id)
|
1587
|
+
return data
|
1588
|
+
end
|
1589
|
+
|
1590
|
+
# Retrieves the list of favorited templates for this caller
|
1591
|
+
#
|
1592
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1593
|
+
# @return [Array<(FavoriteTemplatesInfo, Fixnum, Hash)>] FavoriteTemplatesInfo data, response status code and response headers
|
1594
|
+
def get_favorite_templates_with_http_info(account_id)
|
1595
|
+
if @api_client.config.debugging
|
1596
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_favorite_templates ..."
|
1597
|
+
end
|
1598
|
+
# verify the required parameter 'account_id' is set
|
1599
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_favorite_templates" if account_id.nil?
|
1600
|
+
# resource path
|
1601
|
+
local_var_path = "/v2.1/accounts/{accountId}/favorite_templates".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1602
|
+
|
1603
|
+
# query parameters
|
1604
|
+
query_params = {}
|
1605
|
+
|
1606
|
+
# header parameters
|
1607
|
+
header_params = {}
|
1608
|
+
# HTTP header 'Accept' (if needed)
|
1609
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1610
|
+
|
1611
|
+
# form parameters
|
1612
|
+
form_params = {}
|
1613
|
+
|
1614
|
+
# http body (model)
|
1615
|
+
post_body = nil
|
1616
|
+
auth_names = []
|
1617
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1618
|
+
:header_params => header_params,
|
1619
|
+
:query_params => query_params,
|
1620
|
+
:form_params => form_params,
|
1621
|
+
:body => post_body,
|
1622
|
+
:auth_names => auth_names,
|
1623
|
+
:return_type => 'FavoriteTemplatesInfo')
|
1624
|
+
if @api_client.config.debugging
|
1625
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_favorite_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1626
|
+
end
|
1627
|
+
return data, status_code, headers
|
1628
|
+
end
|
1629
|
+
|
1630
|
+
# Returns default user level settings for a specified account
|
1631
|
+
#
|
1632
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1633
|
+
# @return [NotificationDefaults]
|
1634
|
+
def get_notification_defaults(account_id)
|
1635
|
+
data, _status_code, _headers = get_notification_defaults_with_http_info(account_id)
|
1636
|
+
return data
|
1637
|
+
end
|
1638
|
+
|
1639
|
+
# Returns default user level settings for a specified account
|
1640
|
+
#
|
1641
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1642
|
+
# @return [Array<(NotificationDefaults, Fixnum, Hash)>] NotificationDefaults data, response status code and response headers
|
1643
|
+
def get_notification_defaults_with_http_info(account_id)
|
1644
|
+
if @api_client.config.debugging
|
1645
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_notification_defaults ..."
|
1646
|
+
end
|
1647
|
+
# verify the required parameter 'account_id' is set
|
1648
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_notification_defaults" if account_id.nil?
|
1649
|
+
# resource path
|
1650
|
+
local_var_path = "/v2.1/accounts/{accountId}/settings/notification_defaults".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1651
|
+
|
1652
|
+
# query parameters
|
1653
|
+
query_params = {}
|
1654
|
+
|
1655
|
+
# header parameters
|
1656
|
+
header_params = {}
|
1657
|
+
# HTTP header 'Accept' (if needed)
|
1658
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1659
|
+
|
1660
|
+
# form parameters
|
1661
|
+
form_params = {}
|
1662
|
+
|
1663
|
+
# http body (model)
|
1664
|
+
post_body = nil
|
1665
|
+
auth_names = []
|
1666
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1667
|
+
:header_params => header_params,
|
1668
|
+
:query_params => query_params,
|
1669
|
+
:form_params => form_params,
|
1670
|
+
:body => post_body,
|
1671
|
+
:auth_names => auth_names,
|
1672
|
+
:return_type => 'NotificationDefaults')
|
1673
|
+
if @api_client.config.debugging
|
1674
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_notification_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1675
|
+
end
|
1676
|
+
return data, status_code, headers
|
1677
|
+
end
|
1678
|
+
|
1541
1679
|
# Get the password rules
|
1542
1680
|
#
|
1543
1681
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -1558,7 +1696,7 @@ module DocuSign_eSign
|
|
1558
1696
|
# verify the required parameter 'account_id' is set
|
1559
1697
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_password_rules" if account_id.nil?
|
1560
1698
|
# resource path
|
1561
|
-
local_var_path = "/v2/accounts/{accountId}/settings/password_rules".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1699
|
+
local_var_path = "/v2.1/accounts/{accountId}/settings/password_rules".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1562
1700
|
|
1563
1701
|
# query parameters
|
1564
1702
|
query_params = {}
|
@@ -1603,7 +1741,7 @@ module DocuSign_eSign
|
|
1603
1741
|
@api_client.config.logger.debug "Calling API: AccountsApi.get_password_rules_0 ..."
|
1604
1742
|
end
|
1605
1743
|
# resource path
|
1606
|
-
local_var_path = "/v2/current_user/password_rules".sub('{format}','json')
|
1744
|
+
local_var_path = "/v2.1/current_user/password_rules".sub('{format}','json')
|
1607
1745
|
|
1608
1746
|
# query parameters
|
1609
1747
|
query_params = {}
|
@@ -1658,7 +1796,7 @@ module DocuSign_eSign
|
|
1658
1796
|
# verify the required parameter 'permission_profile_id' is set
|
1659
1797
|
fail ArgumentError, "Missing the required parameter 'permission_profile_id' when calling AccountsApi.get_permission_profile" if permission_profile_id.nil?
|
1660
1798
|
# resource path
|
1661
|
-
local_var_path = "/v2/accounts/{accountId}/permission_profiles/{permissionProfileId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'permissionProfileId' + '}', permission_profile_id.to_s)
|
1799
|
+
local_var_path = "/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'permissionProfileId' + '}', permission_profile_id.to_s)
|
1662
1800
|
|
1663
1801
|
# query parameters
|
1664
1802
|
query_params = {}
|
@@ -1704,7 +1842,7 @@ module DocuSign_eSign
|
|
1704
1842
|
@api_client.config.logger.debug "Calling API: AccountsApi.get_provisioning ..."
|
1705
1843
|
end
|
1706
1844
|
# resource path
|
1707
|
-
local_var_path = "/v2/accounts/provisioning".sub('{format}','json')
|
1845
|
+
local_var_path = "/v2.1/accounts/provisioning".sub('{format}','json')
|
1708
1846
|
|
1709
1847
|
# query parameters
|
1710
1848
|
query_params = {}
|
@@ -1753,7 +1891,7 @@ module DocuSign_eSign
|
|
1753
1891
|
# verify the required parameter 'account_id' is set
|
1754
1892
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_supported_languages" if account_id.nil?
|
1755
1893
|
# resource path
|
1756
|
-
local_var_path = "/v2/accounts/{accountId}/supported_languages".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1894
|
+
local_var_path = "/v2.1/accounts/{accountId}/supported_languages".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1757
1895
|
|
1758
1896
|
# query parameters
|
1759
1897
|
query_params = {}
|
@@ -1802,7 +1940,7 @@ module DocuSign_eSign
|
|
1802
1940
|
# verify the required parameter 'account_id' is set
|
1803
1941
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_watermark" if account_id.nil?
|
1804
1942
|
# resource path
|
1805
|
-
local_var_path = "/v2/accounts/{accountId}/watermark".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1943
|
+
local_var_path = "/v2.1/accounts/{accountId}/watermark".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1806
1944
|
|
1807
1945
|
# query parameters
|
1808
1946
|
query_params = {}
|
@@ -1853,7 +1991,7 @@ module DocuSign_eSign
|
|
1853
1991
|
# verify the required parameter 'account_id' is set
|
1854
1992
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_watermark_preview" if account_id.nil?
|
1855
1993
|
# resource path
|
1856
|
-
local_var_path = "/v2/accounts/{accountId}/watermark/preview".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1994
|
+
local_var_path = "/v2.1/accounts/{accountId}/watermark/preview".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1857
1995
|
|
1858
1996
|
# query parameters
|
1859
1997
|
query_params = {}
|
@@ -1904,7 +2042,7 @@ module DocuSign_eSign
|
|
1904
2042
|
# verify the required parameter 'account_id' is set
|
1905
2043
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_brands" if account_id.nil?
|
1906
2044
|
# resource path
|
1907
|
-
local_var_path = "/v2/accounts/{accountId}/brands".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2045
|
+
local_var_path = "/v2.1/accounts/{accountId}/brands".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1908
2046
|
|
1909
2047
|
# query parameters
|
1910
2048
|
query_params = {}
|
@@ -1955,7 +2093,7 @@ module DocuSign_eSign
|
|
1955
2093
|
# verify the required parameter 'account_id' is set
|
1956
2094
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_custom_fields" if account_id.nil?
|
1957
2095
|
# resource path
|
1958
|
-
local_var_path = "/v2/accounts/{accountId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2096
|
+
local_var_path = "/v2.1/accounts/{accountId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1959
2097
|
|
1960
2098
|
# query parameters
|
1961
2099
|
query_params = {}
|
@@ -2006,7 +2144,7 @@ module DocuSign_eSign
|
|
2006
2144
|
# verify the required parameter 'account_id' is set
|
2007
2145
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_permissions" if account_id.nil?
|
2008
2146
|
# resource path
|
2009
|
-
local_var_path = "/v2/accounts/{accountId}/permission_profiles".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2147
|
+
local_var_path = "/v2.1/accounts/{accountId}/permission_profiles".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2010
2148
|
|
2011
2149
|
# query parameters
|
2012
2150
|
query_params = {}
|
@@ -2058,7 +2196,7 @@ module DocuSign_eSign
|
|
2058
2196
|
# verify the required parameter 'account_id' is set
|
2059
2197
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_recipient_names_by_email" if account_id.nil?
|
2060
2198
|
# resource path
|
2061
|
-
local_var_path = "/v2/accounts/{accountId}/recipient_names".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2199
|
+
local_var_path = "/v2.1/accounts/{accountId}/recipient_names".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2062
2200
|
|
2063
2201
|
# query parameters
|
2064
2202
|
query_params = {}
|
@@ -2108,7 +2246,7 @@ module DocuSign_eSign
|
|
2108
2246
|
# verify the required parameter 'account_id' is set
|
2109
2247
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_settings" if account_id.nil?
|
2110
2248
|
# resource path
|
2111
|
-
local_var_path = "/v2/accounts/{accountId}/settings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2249
|
+
local_var_path = "/v2.1/accounts/{accountId}/settings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2112
2250
|
|
2113
2251
|
# query parameters
|
2114
2252
|
query_params = {}
|
@@ -2159,7 +2297,7 @@ module DocuSign_eSign
|
|
2159
2297
|
# verify the required parameter 'account_id' is set
|
2160
2298
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_shared_access" if account_id.nil?
|
2161
2299
|
# resource path
|
2162
|
-
local_var_path = "/v2/accounts/{accountId}/shared_access".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2300
|
+
local_var_path = "/v2.1/accounts/{accountId}/shared_access".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2163
2301
|
|
2164
2302
|
# query parameters
|
2165
2303
|
query_params = {}
|
@@ -2216,7 +2354,7 @@ module DocuSign_eSign
|
|
2216
2354
|
# verify the required parameter 'account_id' is set
|
2217
2355
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_signature_providers" if account_id.nil?
|
2218
2356
|
# resource path
|
2219
|
-
local_var_path = "/v2/accounts/{accountId}/signatureProviders".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2357
|
+
local_var_path = "/v2.1/accounts/{accountId}/signatureProviders".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2220
2358
|
|
2221
2359
|
# query parameters
|
2222
2360
|
query_params = {}
|
@@ -2265,7 +2403,7 @@ module DocuSign_eSign
|
|
2265
2403
|
# verify the required parameter 'account_id' is set
|
2266
2404
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_unsupported_file_types" if account_id.nil?
|
2267
2405
|
# resource path
|
2268
|
-
local_var_path = "/v2/accounts/{accountId}/unsupported_file_types".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2406
|
+
local_var_path = "/v2.1/accounts/{accountId}/unsupported_file_types".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2269
2407
|
|
2270
2408
|
# query parameters
|
2271
2409
|
query_params = {}
|
@@ -2294,6 +2432,57 @@ module DocuSign_eSign
|
|
2294
2432
|
return data, status_code, headers
|
2295
2433
|
end
|
2296
2434
|
|
2435
|
+
# Unfavorite a template
|
2436
|
+
#
|
2437
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2438
|
+
# @param favorite_templates_info (optional parameter)
|
2439
|
+
# @return [FavoriteTemplatesInfo]
|
2440
|
+
def un_favorite_template(account_id, favorite_templates_info)
|
2441
|
+
data, _status_code, _headers = un_favorite_template_with_http_info(account_id, favorite_templates_info)
|
2442
|
+
return data
|
2443
|
+
end
|
2444
|
+
|
2445
|
+
# Unfavorite a template
|
2446
|
+
#
|
2447
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2448
|
+
# @param favorite_templates_info (optional parameter)
|
2449
|
+
# @return [Array<(FavoriteTemplatesInfo, Fixnum, Hash)>] FavoriteTemplatesInfo data, response status code and response headers
|
2450
|
+
def un_favorite_template_with_http_info(account_id, favorite_templates_info)
|
2451
|
+
if @api_client.config.debugging
|
2452
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.un_favorite_template ..."
|
2453
|
+
end
|
2454
|
+
# verify the required parameter 'account_id' is set
|
2455
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.un_favorite_template" if account_id.nil?
|
2456
|
+
# resource path
|
2457
|
+
local_var_path = "/v2.1/accounts/{accountId}/favorite_templates".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2458
|
+
|
2459
|
+
# query parameters
|
2460
|
+
query_params = {}
|
2461
|
+
|
2462
|
+
# header parameters
|
2463
|
+
header_params = {}
|
2464
|
+
# HTTP header 'Accept' (if needed)
|
2465
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2466
|
+
|
2467
|
+
# form parameters
|
2468
|
+
form_params = {}
|
2469
|
+
|
2470
|
+
# http body (model)
|
2471
|
+
post_body = @api_client.object_to_http_body(favorite_templates_info)
|
2472
|
+
auth_names = []
|
2473
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
2474
|
+
:header_params => header_params,
|
2475
|
+
:query_params => query_params,
|
2476
|
+
:form_params => form_params,
|
2477
|
+
:body => post_body,
|
2478
|
+
:auth_names => auth_names,
|
2479
|
+
:return_type => 'FavoriteTemplatesInfo')
|
2480
|
+
if @api_client.config.debugging
|
2481
|
+
@api_client.config.logger.debug "API called: AccountsApi#un_favorite_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2482
|
+
end
|
2483
|
+
return data, status_code, headers
|
2484
|
+
end
|
2485
|
+
|
2297
2486
|
# Modifies tab settings for specified account
|
2298
2487
|
#
|
2299
2488
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -2316,7 +2505,7 @@ module DocuSign_eSign
|
|
2316
2505
|
# verify the required parameter 'account_id' is set
|
2317
2506
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_account_tab_settings" if account_id.nil?
|
2318
2507
|
# resource path
|
2319
|
-
local_var_path = "/v2/accounts/{accountId}/settings/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2508
|
+
local_var_path = "/v2.1/accounts/{accountId}/settings/tabs".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2320
2509
|
|
2321
2510
|
# query parameters
|
2322
2511
|
query_params = {}
|
@@ -2371,7 +2560,7 @@ module DocuSign_eSign
|
|
2371
2560
|
# verify the required parameter 'brand_id' is set
|
2372
2561
|
fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.update_brand" if brand_id.nil?
|
2373
2562
|
# resource path
|
2374
|
-
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s)
|
2563
|
+
local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s)
|
2375
2564
|
|
2376
2565
|
# query parameters
|
2377
2566
|
query_params = {}
|
@@ -2402,9 +2591,9 @@ module DocuSign_eSign
|
|
2402
2591
|
|
2403
2592
|
# Put one branding logo.
|
2404
2593
|
#
|
2405
|
-
# @param account_id The external account number (int) or account
|
2406
|
-
# @param brand_id The
|
2407
|
-
# @param logo_type
|
2594
|
+
# @param account_id The external account number (int) or account ID GUID.
|
2595
|
+
# @param brand_id The id of the brand.
|
2596
|
+
# @param logo_type The type of logo. Valid values are: - `primary` - `secondary` - `email`
|
2408
2597
|
# @param logo_file_bytes Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places
|
2409
2598
|
# @return [nil]
|
2410
2599
|
def update_brand_logo_by_type(account_id, brand_id, logo_type, logo_file_bytes)
|
@@ -2414,9 +2603,9 @@ module DocuSign_eSign
|
|
2414
2603
|
|
2415
2604
|
# Put one branding logo.
|
2416
2605
|
#
|
2417
|
-
# @param account_id The external account number (int) or account
|
2418
|
-
# @param brand_id The
|
2419
|
-
# @param logo_type
|
2606
|
+
# @param account_id The external account number (int) or account ID GUID.
|
2607
|
+
# @param brand_id The id of the brand.
|
2608
|
+
# @param logo_type The type of logo. Valid values are: - `primary` - `secondary` - `email`
|
2420
2609
|
# @param logo_file_bytes Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places
|
2421
2610
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
2422
2611
|
def update_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type, logo_file_bytes)
|
@@ -2432,7 +2621,7 @@ module DocuSign_eSign
|
|
2432
2621
|
# verify the required parameter 'logo_file_bytes' is set
|
2433
2622
|
fail ArgumentError, "Missing the required parameter 'logo_file_bytes' when calling AccountsApi.update_brand_logo_by_type" if logo_file_bytes.nil?
|
2434
2623
|
# resource path
|
2435
|
-
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}/logos/{logoType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'logoType' + '}', logo_type.to_s)
|
2624
|
+
local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'logoType' + '}', logo_type.to_s)
|
2436
2625
|
|
2437
2626
|
# query parameters
|
2438
2627
|
query_params = {}
|
@@ -2464,7 +2653,7 @@ module DocuSign_eSign
|
|
2464
2653
|
|
2465
2654
|
# Uploads a branding resource file.
|
2466
2655
|
#
|
2467
|
-
# @param account_id The external account number (int) or account
|
2656
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2468
2657
|
# @param brand_id The unique identifier of a brand.
|
2469
2658
|
# @param resource_content_type
|
2470
2659
|
# @return [BrandResources]
|
@@ -2475,7 +2664,7 @@ module DocuSign_eSign
|
|
2475
2664
|
|
2476
2665
|
# Uploads a branding resource file.
|
2477
2666
|
#
|
2478
|
-
# @param account_id The external account number (int) or account
|
2667
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2479
2668
|
# @param brand_id The unique identifier of a brand.
|
2480
2669
|
# @param resource_content_type
|
2481
2670
|
# @return [Array<(BrandResources, Fixnum, Hash)>] BrandResources data, response status code and response headers
|
@@ -2489,10 +2678,8 @@ module DocuSign_eSign
|
|
2489
2678
|
fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.update_brand_resources_by_content_type" if brand_id.nil?
|
2490
2679
|
# verify the required parameter 'resource_content_type' is set
|
2491
2680
|
fail ArgumentError, "Missing the required parameter 'resource_content_type' when calling AccountsApi.update_brand_resources_by_content_type" if resource_content_type.nil?
|
2492
|
-
# verify the required parameter 'file_xml' is set
|
2493
|
-
fail ArgumentError, "Missing the required parameter 'file_xml' when calling AccountsApi.update_brand_resources_by_content_type" if file_xml.nil?
|
2494
2681
|
# resource path
|
2495
|
-
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'resourceContentType' + '}', resource_content_type.to_s)
|
2682
|
+
local_var_path = "/v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s).sub('{' + 'resourceContentType' + '}', resource_content_type.to_s)
|
2496
2683
|
|
2497
2684
|
# query parameters
|
2498
2685
|
query_params = {}
|
@@ -2501,12 +2688,9 @@ module DocuSign_eSign
|
|
2501
2688
|
header_params = {}
|
2502
2689
|
# HTTP header 'Accept' (if needed)
|
2503
2690
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2504
|
-
# HTTP header 'Content-Type'
|
2505
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
2506
2691
|
|
2507
2692
|
# form parameters
|
2508
2693
|
form_params = {}
|
2509
|
-
form_params["file.xml"] = file_xml
|
2510
2694
|
|
2511
2695
|
# http body (model)
|
2512
2696
|
post_body = nil
|
@@ -2527,7 +2711,7 @@ module DocuSign_eSign
|
|
2527
2711
|
# Update Consumer Disclosure.
|
2528
2712
|
#
|
2529
2713
|
# @param account_id The external account number (int) or account ID Guid.
|
2530
|
-
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar),
|
2714
|
+
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
2531
2715
|
# @param consumer_disclosure (optional parameter)
|
2532
2716
|
# @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
|
2533
2717
|
# @return [ConsumerDisclosure]
|
@@ -2539,7 +2723,7 @@ module DocuSign_eSign
|
|
2539
2723
|
# Update Consumer Disclosure.
|
2540
2724
|
#
|
2541
2725
|
# @param account_id The external account number (int) or account ID Guid.
|
2542
|
-
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar),
|
2726
|
+
# @param lang_code The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
|
2543
2727
|
# @param consumer_disclosure (optional parameter)
|
2544
2728
|
# @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
|
2545
2729
|
# @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
|
@@ -2552,7 +2736,7 @@ module DocuSign_eSign
|
|
2552
2736
|
# verify the required parameter 'lang_code' is set
|
2553
2737
|
fail ArgumentError, "Missing the required parameter 'lang_code' when calling AccountsApi.update_consumer_disclosure" if lang_code.nil?
|
2554
2738
|
# resource path
|
2555
|
-
local_var_path = "/v2/accounts/{accountId}/consumer_disclosure/{langCode}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'langCode' + '}', lang_code.to_s)
|
2739
|
+
local_var_path = "/v2.1/accounts/{accountId}/consumer_disclosure/{langCode}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'langCode' + '}', lang_code.to_s)
|
2556
2740
|
|
2557
2741
|
# query parameters
|
2558
2742
|
query_params = {}
|
@@ -2610,7 +2794,7 @@ module DocuSign_eSign
|
|
2610
2794
|
# verify the required parameter 'custom_field_id' is set
|
2611
2795
|
fail ArgumentError, "Missing the required parameter 'custom_field_id' when calling AccountsApi.update_custom_field" if custom_field_id.nil?
|
2612
2796
|
# resource path
|
2613
|
-
local_var_path = "/v2/accounts/{accountId}/custom_fields/{customFieldId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'customFieldId' + '}', custom_field_id.to_s)
|
2797
|
+
local_var_path = "/v2.1/accounts/{accountId}/custom_fields/{customFieldId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'customFieldId' + '}', custom_field_id.to_s)
|
2614
2798
|
|
2615
2799
|
# query parameters
|
2616
2800
|
query_params = {}
|
@@ -2662,7 +2846,7 @@ module DocuSign_eSign
|
|
2662
2846
|
# verify the required parameter 'account_id' is set
|
2663
2847
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_e_note_configuration" if account_id.nil?
|
2664
2848
|
# resource path
|
2665
|
-
local_var_path = "/v2/accounts/{accountId}/settings/enote_configuration".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2849
|
+
local_var_path = "/v2.1/accounts/{accountId}/settings/enote_configuration".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2666
2850
|
|
2667
2851
|
# query parameters
|
2668
2852
|
query_params = {}
|
@@ -2691,6 +2875,159 @@ module DocuSign_eSign
|
|
2691
2875
|
return data, status_code, headers
|
2692
2876
|
end
|
2693
2877
|
|
2878
|
+
# Updates envelope purge configuration.
|
2879
|
+
#
|
2880
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2881
|
+
# @param envelope_purge_configuration (optional parameter)
|
2882
|
+
# @return [EnvelopePurgeConfiguration]
|
2883
|
+
def update_envelope_purge_configuration(account_id, envelope_purge_configuration)
|
2884
|
+
data, _status_code, _headers = update_envelope_purge_configuration_with_http_info(account_id, envelope_purge_configuration)
|
2885
|
+
return data
|
2886
|
+
end
|
2887
|
+
|
2888
|
+
# Updates envelope purge configuration.
|
2889
|
+
#
|
2890
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2891
|
+
# @param envelope_purge_configuration (optional parameter)
|
2892
|
+
# @return [Array<(EnvelopePurgeConfiguration, Fixnum, Hash)>] EnvelopePurgeConfiguration data, response status code and response headers
|
2893
|
+
def update_envelope_purge_configuration_with_http_info(account_id, envelope_purge_configuration)
|
2894
|
+
if @api_client.config.debugging
|
2895
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.update_envelope_purge_configuration ..."
|
2896
|
+
end
|
2897
|
+
# verify the required parameter 'account_id' is set
|
2898
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_envelope_purge_configuration" if account_id.nil?
|
2899
|
+
# resource path
|
2900
|
+
local_var_path = "/v2.1/accounts/{accountId}/settings/envelope_purge_configuration".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2901
|
+
|
2902
|
+
# query parameters
|
2903
|
+
query_params = {}
|
2904
|
+
|
2905
|
+
# header parameters
|
2906
|
+
header_params = {}
|
2907
|
+
# HTTP header 'Accept' (if needed)
|
2908
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2909
|
+
|
2910
|
+
# form parameters
|
2911
|
+
form_params = {}
|
2912
|
+
|
2913
|
+
# http body (model)
|
2914
|
+
post_body = @api_client.object_to_http_body(envelope_purge_configuration)
|
2915
|
+
auth_names = []
|
2916
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2917
|
+
:header_params => header_params,
|
2918
|
+
:query_params => query_params,
|
2919
|
+
:form_params => form_params,
|
2920
|
+
:body => post_body,
|
2921
|
+
:auth_names => auth_names,
|
2922
|
+
:return_type => 'EnvelopePurgeConfiguration')
|
2923
|
+
if @api_client.config.debugging
|
2924
|
+
@api_client.config.logger.debug "API called: AccountsApi#update_envelope_purge_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2925
|
+
end
|
2926
|
+
return data, status_code, headers
|
2927
|
+
end
|
2928
|
+
|
2929
|
+
# Favorites a template
|
2930
|
+
#
|
2931
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2932
|
+
# @param favorite_templates_info (optional parameter)
|
2933
|
+
# @return [FavoriteTemplatesInfo]
|
2934
|
+
def update_favorite_template(account_id, favorite_templates_info)
|
2935
|
+
data, _status_code, _headers = update_favorite_template_with_http_info(account_id, favorite_templates_info)
|
2936
|
+
return data
|
2937
|
+
end
|
2938
|
+
|
2939
|
+
# Favorites a template
|
2940
|
+
#
|
2941
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2942
|
+
# @param favorite_templates_info (optional parameter)
|
2943
|
+
# @return [Array<(FavoriteTemplatesInfo, Fixnum, Hash)>] FavoriteTemplatesInfo data, response status code and response headers
|
2944
|
+
def update_favorite_template_with_http_info(account_id, favorite_templates_info)
|
2945
|
+
if @api_client.config.debugging
|
2946
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.update_favorite_template ..."
|
2947
|
+
end
|
2948
|
+
# verify the required parameter 'account_id' is set
|
2949
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_favorite_template" if account_id.nil?
|
2950
|
+
# resource path
|
2951
|
+
local_var_path = "/v2.1/accounts/{accountId}/favorite_templates".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2952
|
+
|
2953
|
+
# query parameters
|
2954
|
+
query_params = {}
|
2955
|
+
|
2956
|
+
# header parameters
|
2957
|
+
header_params = {}
|
2958
|
+
# HTTP header 'Accept' (if needed)
|
2959
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2960
|
+
|
2961
|
+
# form parameters
|
2962
|
+
form_params = {}
|
2963
|
+
|
2964
|
+
# http body (model)
|
2965
|
+
post_body = @api_client.object_to_http_body(favorite_templates_info)
|
2966
|
+
auth_names = []
|
2967
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2968
|
+
:header_params => header_params,
|
2969
|
+
:query_params => query_params,
|
2970
|
+
:form_params => form_params,
|
2971
|
+
:body => post_body,
|
2972
|
+
:auth_names => auth_names,
|
2973
|
+
:return_type => 'FavoriteTemplatesInfo')
|
2974
|
+
if @api_client.config.debugging
|
2975
|
+
@api_client.config.logger.debug "API called: AccountsApi#update_favorite_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2976
|
+
end
|
2977
|
+
return data, status_code, headers
|
2978
|
+
end
|
2979
|
+
|
2980
|
+
# Updates default user level settings for a specified account
|
2981
|
+
#
|
2982
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2983
|
+
# @param notification_defaults (optional parameter)
|
2984
|
+
# @return [NotificationDefaults]
|
2985
|
+
def update_notification_defaults(account_id, notification_defaults)
|
2986
|
+
data, _status_code, _headers = update_notification_defaults_with_http_info(account_id, notification_defaults)
|
2987
|
+
return data
|
2988
|
+
end
|
2989
|
+
|
2990
|
+
# Updates default user level settings for a specified account
|
2991
|
+
#
|
2992
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2993
|
+
# @param notification_defaults (optional parameter)
|
2994
|
+
# @return [Array<(NotificationDefaults, Fixnum, Hash)>] NotificationDefaults data, response status code and response headers
|
2995
|
+
def update_notification_defaults_with_http_info(account_id, notification_defaults)
|
2996
|
+
if @api_client.config.debugging
|
2997
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.update_notification_defaults ..."
|
2998
|
+
end
|
2999
|
+
# verify the required parameter 'account_id' is set
|
3000
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_notification_defaults" if account_id.nil?
|
3001
|
+
# resource path
|
3002
|
+
local_var_path = "/v2.1/accounts/{accountId}/settings/notification_defaults".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
3003
|
+
|
3004
|
+
# query parameters
|
3005
|
+
query_params = {}
|
3006
|
+
|
3007
|
+
# header parameters
|
3008
|
+
header_params = {}
|
3009
|
+
# HTTP header 'Accept' (if needed)
|
3010
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3011
|
+
|
3012
|
+
# form parameters
|
3013
|
+
form_params = {}
|
3014
|
+
|
3015
|
+
# http body (model)
|
3016
|
+
post_body = @api_client.object_to_http_body(notification_defaults)
|
3017
|
+
auth_names = []
|
3018
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
3019
|
+
:header_params => header_params,
|
3020
|
+
:query_params => query_params,
|
3021
|
+
:form_params => form_params,
|
3022
|
+
:body => post_body,
|
3023
|
+
:auth_names => auth_names,
|
3024
|
+
:return_type => 'NotificationDefaults')
|
3025
|
+
if @api_client.config.debugging
|
3026
|
+
@api_client.config.logger.debug "API called: AccountsApi#update_notification_defaults\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3027
|
+
end
|
3028
|
+
return data, status_code, headers
|
3029
|
+
end
|
3030
|
+
|
2694
3031
|
# Update the password rules
|
2695
3032
|
#
|
2696
3033
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -2713,7 +3050,7 @@ module DocuSign_eSign
|
|
2713
3050
|
# verify the required parameter 'account_id' is set
|
2714
3051
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_password_rules" if account_id.nil?
|
2715
3052
|
# resource path
|
2716
|
-
local_var_path = "/v2/accounts/{accountId}/settings/password_rules".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
3053
|
+
local_var_path = "/v2.1/accounts/{accountId}/settings/password_rules".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2717
3054
|
|
2718
3055
|
# query parameters
|
2719
3056
|
query_params = {}
|
@@ -2770,7 +3107,7 @@ module DocuSign_eSign
|
|
2770
3107
|
# verify the required parameter 'permission_profile_id' is set
|
2771
3108
|
fail ArgumentError, "Missing the required parameter 'permission_profile_id' when calling AccountsApi.update_permission_profile" if permission_profile_id.nil?
|
2772
3109
|
# resource path
|
2773
|
-
local_var_path = "/v2/accounts/{accountId}/permission_profiles/{permissionProfileId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'permissionProfileId' + '}', permission_profile_id.to_s)
|
3110
|
+
local_var_path = "/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'permissionProfileId' + '}', permission_profile_id.to_s)
|
2774
3111
|
|
2775
3112
|
# query parameters
|
2776
3113
|
query_params = {}
|
@@ -2822,7 +3159,7 @@ module DocuSign_eSign
|
|
2822
3159
|
# verify the required parameter 'account_id' is set
|
2823
3160
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_settings" if account_id.nil?
|
2824
3161
|
# resource path
|
2825
|
-
local_var_path = "/v2/accounts/{accountId}/settings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
3162
|
+
local_var_path = "/v2.1/accounts/{accountId}/settings".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2826
3163
|
|
2827
3164
|
# query parameters
|
2828
3165
|
query_params = {}
|
@@ -2874,11 +3211,12 @@ module DocuSign_eSign
|
|
2874
3211
|
# verify the required parameter 'account_id' is set
|
2875
3212
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_shared_access" if account_id.nil?
|
2876
3213
|
# resource path
|
2877
|
-
local_var_path = "/v2/accounts/{accountId}/shared_access".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
3214
|
+
local_var_path = "/v2.1/accounts/{accountId}/shared_access".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2878
3215
|
|
2879
3216
|
# query parameters
|
2880
3217
|
query_params = {}
|
2881
3218
|
query_params[:'item_type'] = options.item_type if !options.item_type.nil?
|
3219
|
+
query_params[:'preserve_existing_shared_access'] = options.preserve_existing_shared_access if !options.preserve_existing_shared_access.nil?
|
2882
3220
|
query_params[:'user_ids'] = options.user_ids if !options.user_ids.nil?
|
2883
3221
|
|
2884
3222
|
# header parameters
|
@@ -2927,7 +3265,7 @@ module DocuSign_eSign
|
|
2927
3265
|
# verify the required parameter 'account_id' is set
|
2928
3266
|
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_watermark" if account_id.nil?
|
2929
3267
|
# resource path
|
2930
|
-
local_var_path = "/v2/accounts/{accountId}/watermark".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
3268
|
+
local_var_path = "/v2.1/accounts/{accountId}/watermark".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2931
3269
|
|
2932
3270
|
# query parameters
|
2933
3271
|
query_params = {}
|
@@ -2956,4 +3294,4 @@ module DocuSign_eSign
|
|
2956
3294
|
return data, status_code, headers
|
2957
3295
|
end
|
2958
3296
|
end
|
2959
|
-
end
|
3297
|
+
end
|