docusign_esign 1.0.2 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/Gemfile.lock +16 -14
- data/README.md +44 -19
- data/docusign_esign.gemspec +5 -5
- data/lib/.DS_Store +0 -0
- data/lib/docusign_esign.rb +69 -6
- data/lib/docusign_esign/.DS_Store +0 -0
- data/lib/docusign_esign/api/accounts_api.rb +786 -74
- data/lib/docusign_esign/api/billing_api.rb +51 -2
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +3 -1
- data/lib/docusign_esign/api/comments_api.rb +89 -0
- data/lib/docusign_esign/api/connect_api.rb +0 -151
- data/lib/docusign_esign/api/envelopes_api.rb +578 -195
- data/lib/docusign_esign/api/folders_api.rb +5 -14
- data/lib/docusign_esign/api/groups_api.rb +0 -4
- data/lib/docusign_esign/api/notary_api.rb +89 -0
- data/lib/docusign_esign/api/power_forms_api.rb +4 -0
- data/lib/docusign_esign/api/templates_api.rb +465 -6
- data/lib/docusign_esign/api/trust_service_providers_api.rb +73 -0
- data/lib/docusign_esign/api/users_api.rb +89 -10
- data/{tests → lib/docusign_esign/client}/.DS_Store +0 -0
- data/lib/docusign_esign/{api_client.rb → client/api_client.rb} +187 -34
- data/lib/docusign_esign/{api_error.rb → client/api_error.rb} +0 -0
- data/lib/docusign_esign/client/auth/oauth.rb +1061 -0
- data/lib/docusign_esign/configuration.rb +7 -0
- data/lib/docusign_esign/models/account_address.rb +1 -1
- data/lib/docusign_esign/models/account_billing_plan_response.rb +10 -1
- data/lib/docusign_esign/models/account_identity_verification_response.rb +190 -0
- data/lib/docusign_esign/models/{view_link_request.rb → account_identity_verification_step.rb} +14 -14
- data/lib/docusign_esign/models/account_identity_verification_workflow.rb +210 -0
- data/lib/docusign_esign/models/account_information.rb +11 -1
- data/lib/docusign_esign/models/account_minimum_password_length.rb +198 -0
- data/lib/docusign_esign/models/{post_transactions_response.rb → account_password_expire_password_days.rb} +14 -14
- data/lib/docusign_esign/models/account_password_lockout_duration_minutes.rb +198 -0
- data/lib/docusign_esign/models/account_password_lockout_duration_type.rb +190 -0
- data/lib/docusign_esign/models/account_password_minimum_password_age_days.rb +198 -0
- data/lib/docusign_esign/models/account_password_questions_required.rb +198 -0
- data/lib/docusign_esign/models/account_password_rules.rb +371 -0
- data/lib/docusign_esign/models/account_password_strength_type.rb +190 -0
- data/lib/docusign_esign/models/account_password_strength_type_option.rb +248 -0
- data/lib/docusign_esign/models/account_role_settings.rb +39 -1
- data/lib/docusign_esign/models/account_seals.rb +190 -0
- data/lib/docusign_esign/models/agent.rb +33 -3
- data/lib/docusign_esign/models/approve.rb +25 -3
- data/lib/docusign_esign/models/authentication_status.rb +10 -1
- data/lib/docusign_esign/models/billing_charge.rb +1 -1
- data/lib/docusign_esign/models/billing_plan_information.rb +10 -1
- data/lib/docusign_esign/models/billing_plan_update_response.rb +11 -1
- data/lib/docusign_esign/models/bulk_recipient.rb +1 -1
- data/lib/docusign_esign/models/carbon_copy.rb +53 -3
- data/lib/docusign_esign/models/certified_delivery.rb +53 -3
- data/lib/docusign_esign/models/checkbox.rb +25 -3
- data/lib/docusign_esign/models/chunked_upload_response.rb +21 -1
- data/lib/docusign_esign/models/company.rb +25 -3
- data/lib/docusign_esign/models/complete_sign_hash_response.rb +210 -0
- data/lib/docusign_esign/models/complete_sign_request.rb +220 -0
- data/lib/docusign_esign/models/composite_template.rb +1 -1
- data/lib/docusign_esign/models/connect_custom_configuration.rb +14 -4
- data/lib/docusign_esign/models/consumer_disclosure.rb +19 -1
- data/lib/docusign_esign/models/contact.rb +13 -1
- data/lib/docusign_esign/models/contact_phone_number.rb +198 -0
- data/lib/docusign_esign/models/credential.rb +198 -0
- data/lib/docusign_esign/models/{offline_attributes.rb → custom_field.rb} +65 -44
- data/lib/docusign_esign/models/date.rb +26 -4
- data/lib/docusign_esign/models/date_signed.rb +25 -3
- data/lib/docusign_esign/models/{post_transactions_request.rb → date_stamp_properties.rb} +26 -26
- data/lib/docusign_esign/models/decline.rb +25 -3
- data/lib/docusign_esign/models/dob_information_input.rb +1 -1
- data/lib/docusign_esign/models/document.rb +31 -2
- data/lib/docusign_esign/models/document_fields_information.rb +1 -1
- data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +278 -0
- data/lib/docusign_esign/models/document_html_definition.rb +290 -0
- data/lib/docusign_esign/models/document_html_definition_original.rb +207 -0
- data/lib/docusign_esign/models/document_html_definition_originals.rb +190 -0
- data/lib/docusign_esign/models/document_html_definitions.rb +190 -0
- data/lib/docusign_esign/models/document_html_display_anchor.rb +237 -0
- data/lib/docusign_esign/models/document_html_display_settings.rb +287 -0
- data/lib/docusign_esign/models/document_security_store.rb +214 -0
- data/lib/docusign_esign/models/document_update_info.rb +248 -0
- data/lib/docusign_esign/models/editor.rb +33 -3
- data/lib/docusign_esign/models/email.rb +26 -4
- data/lib/docusign_esign/models/email_address.rb +35 -3
- data/lib/docusign_esign/models/email_settings.rb +1 -1
- data/lib/docusign_esign/models/envelope.rb +32 -2
- data/lib/docusign_esign/models/envelope_definition.rb +33 -3
- data/lib/docusign_esign/models/envelope_document.rb +11 -21
- data/lib/docusign_esign/models/envelope_id.rb +25 -3
- data/lib/docusign_esign/models/envelope_template.rb +32 -2
- data/lib/docusign_esign/models/envelope_template_definition.rb +11 -1
- data/lib/docusign_esign/models/envelope_template_result.rb +42 -2
- data/lib/docusign_esign/models/envelopes_information.rb +21 -1
- data/lib/docusign_esign/models/first_name.rb +35 -3
- data/lib/docusign_esign/models/formula_tab.rb +36 -4
- data/lib/docusign_esign/models/full_name.rb +35 -3
- data/lib/docusign_esign/models/id_check_information_input.rb +1 -1
- data/lib/docusign_esign/models/in_person_signer.rb +45 -3
- data/lib/docusign_esign/models/initial_here.rb +26 -4
- data/lib/docusign_esign/models/intermediary.rb +33 -3
- data/lib/docusign_esign/models/jurisdiction.rb +278 -0
- data/lib/docusign_esign/models/last_name.rb +35 -3
- data/lib/docusign_esign/models/list.rb +25 -3
- data/lib/docusign_esign/models/new_account_definition.rb +10 -1
- data/lib/docusign_esign/models/notarize.rb +448 -0
- data/lib/docusign_esign/models/notary_host.rb +12 -21
- data/lib/docusign_esign/models/notary_journal.rb +236 -0
- data/lib/docusign_esign/models/notary_journal_credible_witness.rb +208 -0
- data/lib/docusign_esign/models/notary_journal_list.rb +250 -0
- data/lib/docusign_esign/models/notary_journal_meta_data.rb +220 -0
- data/lib/docusign_esign/models/note.rb +25 -3
- data/lib/docusign_esign/models/number.rb +26 -4
- data/lib/docusign_esign/models/payment_details.rb +53 -1
- data/lib/docusign_esign/models/payment_gateway_account.rb +218 -0
- data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +190 -0
- data/lib/docusign_esign/models/payment_processor_information.rb +207 -0
- data/lib/docusign_esign/models/power_form.rb +11 -1
- data/lib/docusign_esign/models/power_form_recipient.rb +1 -1
- data/lib/docusign_esign/models/radio.rb +2 -2
- data/lib/docusign_esign/models/radio_group.rb +34 -4
- data/lib/docusign_esign/models/recipient_signature_provider.rb +21 -1
- data/lib/docusign_esign/models/recipients.rb +28 -4
- data/lib/docusign_esign/models/revision.rb +228 -0
- data/lib/docusign_esign/models/seal.rb +200 -0
- data/lib/docusign_esign/models/seal_identifier.rb +198 -0
- data/lib/docusign_esign/models/seal_sign.rb +560 -0
- data/lib/docusign_esign/models/sender.rb +198 -0
- data/lib/docusign_esign/models/sender_email_notifications.rb +21 -1
- data/lib/docusign_esign/models/sign_hash_document.rb +250 -0
- data/lib/docusign_esign/models/sign_hash_session_info_response.rb +248 -0
- data/lib/docusign_esign/models/sign_here.rb +45 -4
- data/lib/docusign_esign/models/sign_session_info_request.rb +208 -0
- data/lib/docusign_esign/models/signature_data_info.rb +207 -0
- data/lib/docusign_esign/models/signer.rb +54 -4
- data/lib/docusign_esign/models/signer_attachment.rb +26 -4
- data/lib/docusign_esign/models/signer_email_notifications.rb +21 -1
- data/lib/docusign_esign/models/smart_section.rb +505 -0
- data/lib/docusign_esign/models/smart_section_anchor_position.rb +208 -0
- data/lib/docusign_esign/models/smart_section_collapsible_display_settings.rb +278 -0
- data/lib/docusign_esign/models/smart_section_display_settings.rb +287 -0
- data/lib/docusign_esign/models/ssn.rb +26 -4
- data/lib/docusign_esign/models/supported_languages.rb +190 -0
- data/lib/docusign_esign/models/tab_metadata.rb +63 -4
- data/lib/docusign_esign/models/tabs.rb +27 -3
- data/lib/docusign_esign/models/template_recipients.rb +28 -4
- data/lib/docusign_esign/models/template_role.rb +15 -3
- data/lib/docusign_esign/models/template_tabs.rb +27 -3
- data/lib/docusign_esign/models/text.rb +26 -4
- data/lib/docusign_esign/models/time_stamp_field.rb +207 -0
- data/lib/docusign_esign/models/title.rb +25 -3
- data/lib/docusign_esign/models/tsp_health_check_request.rb +230 -0
- data/lib/docusign_esign/models/tsp_health_check_status_description.rb +238 -0
- data/lib/docusign_esign/models/update_transaction_request.rb +208 -0
- data/lib/docusign_esign/models/update_transaction_response.rb +188 -0
- data/lib/docusign_esign/models/usage_history.rb +1 -1
- data/lib/docusign_esign/models/user.rb +220 -0
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +77 -1
- data/lib/docusign_esign/models/user_info_response.rb +225 -0
- data/lib/docusign_esign/models/user_information.rb +46 -6
- data/lib/docusign_esign/models/user_password_rules.rb +197 -0
- data/lib/docusign_esign/models/user_signature.rb +83 -4
- data/lib/docusign_esign/models/view.rb +25 -3
- data/lib/docusign_esign/models/watermark.rb +268 -0
- data/lib/docusign_esign/models/witness.rb +812 -0
- data/lib/docusign_esign/models/zip.rb +26 -4
- data/lib/docusign_esign/version.rb +1 -1
- data/tests/Gemfile +1 -1
- data/tests/Gemfile.lock +24 -20
- data/tests/{rsa_keys → docs}/private.pem +0 -0
- data/tests/spec/unit_tests_spec.rb +6 -8
- data/tests/spec/unit_tests_using_jwt_spec.rb +37 -35
- metadata +122 -672
- data/spec/api/accounts_api_spec.rb +0 -556
- data/spec/api/authentication_api_spec.rb +0 -125
- data/spec/api/billing_api_spec.rb +0 -178
- data/spec/api/bulk_envelopes_api_spec.rb +0 -110
- data/spec/api/cloud_storage_api_spec.rb +0 -146
- data/spec/api/connect_api_spec.rb +0 -261
- data/spec/api/custom_tabs_api_spec.rb +0 -100
- data/spec/api/diagnostics_api_spec.rb +0 -114
- data/spec/api/envelopes_api_spec.rb +0 -1171
- data/spec/api/folders_api_spec.rb +0 -107
- data/spec/api/groups_api_spec.rb +0 -174
- data/spec/api/power_forms_api_spec.rb +0 -144
- data/spec/api/signing_groups_api_spec.rb +0 -155
- data/spec/api/templates_api_spec.rb +0 -649
- data/spec/api/users_api_spec.rb +0 -442
- data/spec/api/workspaces_api_spec.rb +0 -201
- data/spec/api_client_spec.rb +0 -225
- data/spec/configuration_spec.rb +0 -41
- data/spec/models/account_address_spec.rb +0 -107
- data/spec/models/account_billing_plan_response_spec.rb +0 -71
- data/spec/models/account_billing_plan_spec.rb +0 -155
- data/spec/models/account_information_spec.rb +0 -221
- data/spec/models/account_role_settings_spec.rb +0 -419
- data/spec/models/account_settings_information_spec.rb +0 -41
- data/spec/models/account_shared_access_spec.rb +0 -89
- data/spec/models/account_signature_provider_option_spec.rb +0 -53
- data/spec/models/account_signature_provider_spec.rb +0 -77
- data/spec/models/account_signature_providers_spec.rb +0 -41
- data/spec/models/add_on_spec.rb +0 -59
- data/spec/models/address_information_input_spec.rb +0 -53
- data/spec/models/address_information_spec.rb +0 -83
- data/spec/models/address_information_v2_spec.rb +0 -83
- data/spec/models/agent_spec.rb +0 -287
- data/spec/models/api_request_log_spec.rb +0 -59
- data/spec/models/api_request_logs_result_spec.rb +0 -41
- data/spec/models/app_store_product_spec.rb +0 -47
- data/spec/models/app_store_receipt_spec.rb +0 -47
- data/spec/models/approve_spec.rb +0 -233
- data/spec/models/attachment_spec.rb +0 -77
- data/spec/models/authentication_method_spec.rb +0 -59
- data/spec/models/authentication_status_spec.rb +0 -137
- data/spec/models/bcc_email_address_spec.rb +0 -47
- data/spec/models/billing_charge_response_spec.rb +0 -41
- data/spec/models/billing_charge_spec.rb +0 -113
- data/spec/models/billing_discount_spec.rb +0 -53
- data/spec/models/billing_invoice_item_spec.rb +0 -65
- data/spec/models/billing_invoice_spec.rb +0 -95
- data/spec/models/billing_invoices_response_spec.rb +0 -53
- data/spec/models/billing_invoices_summary_spec.rb +0 -53
- data/spec/models/billing_payment_item_spec.rb +0 -65
- data/spec/models/billing_payment_request_spec.rb +0 -41
- data/spec/models/billing_payment_response_spec.rb +0 -41
- data/spec/models/billing_payment_spec.rb +0 -53
- data/spec/models/billing_payments_response_spec.rb +0 -53
- data/spec/models/billing_plan_information_spec.rb +0 -125
- data/spec/models/billing_plan_preview_spec.rb +0 -71
- data/spec/models/billing_plan_response_spec.rb +0 -47
- data/spec/models/billing_plan_spec.rb +0 -125
- data/spec/models/billing_plan_update_response_spec.rb +0 -77
- data/spec/models/billing_plans_response_spec.rb +0 -41
- data/spec/models/billing_price_spec.rb +0 -53
- data/spec/models/brand_email_content_spec.rb +0 -59
- data/spec/models/brand_link_spec.rb +0 -59
- data/spec/models/brand_logos_spec.rb +0 -53
- data/spec/models/brand_request_spec.rb +0 -41
- data/spec/models/brand_resource_urls_spec.rb +0 -59
- data/spec/models/brand_resources_list_spec.rb +0 -41
- data/spec/models/brand_resources_spec.rb +0 -77
- data/spec/models/brand_spec.rb +0 -113
- data/spec/models/brands_request_spec.rb +0 -41
- data/spec/models/brands_response_spec.rb +0 -53
- data/spec/models/bulk_envelope_spec.rb +0 -89
- data/spec/models/bulk_envelope_status_spec.rb +0 -119
- data/spec/models/bulk_envelopes_response_spec.rb +0 -77
- data/spec/models/bulk_recipient_signature_provider_spec.rb +0 -47
- data/spec/models/bulk_recipient_spec.rb +0 -95
- data/spec/models/bulk_recipient_tab_label_spec.rb +0 -47
- data/spec/models/bulk_recipients_request_spec.rb +0 -41
- data/spec/models/bulk_recipients_response_spec.rb +0 -77
- data/spec/models/bulk_recipients_summary_response_spec.rb +0 -59
- data/spec/models/bulk_recipients_update_response_spec.rb +0 -41
- data/spec/models/captive_recipient_information_spec.rb +0 -41
- data/spec/models/captive_recipient_spec.rb +0 -59
- data/spec/models/carbon_copy_spec.rb +0 -287
- data/spec/models/certified_delivery_spec.rb +0 -287
- data/spec/models/checkbox_spec.rb +0 -215
- data/spec/models/chunked_upload_part_spec.rb +0 -47
- data/spec/models/chunked_upload_request_spec.rb +0 -47
- data/spec/models/chunked_upload_response_spec.rb +0 -77
- data/spec/models/cloud_storage_provider_spec.rb +0 -65
- data/spec/models/cloud_storage_providers_spec.rb +0 -41
- data/spec/models/company_spec.rb +0 -269
- data/spec/models/composite_template_spec.rb +0 -65
- data/spec/models/connect_config_results_spec.rb +0 -47
- data/spec/models/connect_custom_configuration_spec.rb +0 -161
- data/spec/models/connect_debug_log_spec.rb +0 -65
- data/spec/models/connect_failure_filter_spec.rb +0 -47
- data/spec/models/connect_failure_result_spec.rb +0 -65
- data/spec/models/connect_failure_results_spec.rb +0 -41
- data/spec/models/connect_log_spec.rb +0 -143
- data/spec/models/connect_logs_spec.rb +0 -59
- data/spec/models/console_view_request_spec.rb +0 -47
- data/spec/models/consumer_disclosure_spec.rb +0 -215
- data/spec/models/contact_get_response_spec.rb +0 -77
- data/spec/models/contact_mod_request_spec.rb +0 -41
- data/spec/models/contact_spec.rb +0 -89
- data/spec/models/contact_update_response_spec.rb +0 -41
- data/spec/models/correct_view_request_spec.rb +0 -47
- data/spec/models/country_spec.rb +0 -59
- data/spec/models/credit_card_information_spec.rb +0 -71
- data/spec/models/credit_card_types_spec.rb +0 -41
- data/spec/models/currency_feature_set_price_spec.rb +0 -65
- data/spec/models/currency_plan_price_spec.rb +0 -71
- data/spec/models/custom_field_v2_spec.rb +0 -77
- data/spec/models/custom_fields_envelope_spec.rb +0 -47
- data/spec/models/custom_fields_spec.rb +0 -47
- data/spec/models/custom_settings_information_spec.rb +0 -41
- data/spec/models/date_signed_spec.rb +0 -227
- data/spec/models/date_spec.rb +0 -305
- data/spec/models/decline_spec.rb +0 -239
- data/spec/models/diagnostics_settings_information_spec.rb +0 -53
- data/spec/models/dob_information_input_spec.rb +0 -53
- data/spec/models/document_fields_information_spec.rb +0 -41
- data/spec/models/document_spec.rb +0 -155
- data/spec/models/document_template_list_spec.rb +0 -41
- data/spec/models/document_template_spec.rb +0 -65
- data/spec/models/document_visibility_list_spec.rb +0 -41
- data/spec/models/document_visibility_spec.rb +0 -65
- data/spec/models/e_note_configuration_spec.rb +0 -65
- data/spec/models/editor_spec.rb +0 -281
- data/spec/models/email_address_spec.rb +0 -221
- data/spec/models/email_settings_spec.rb +0 -53
- data/spec/models/email_spec.rb +0 -305
- data/spec/models/envelope_attachment_spec.rb +0 -71
- data/spec/models/envelope_attachments_request_spec.rb +0 -41
- data/spec/models/envelope_attachments_result_spec.rb +0 -41
- data/spec/models/envelope_audit_event_response_spec.rb +0 -41
- data/spec/models/envelope_audit_event_spec.rb +0 -41
- data/spec/models/envelope_definition_spec.rb +0 -371
- data/spec/models/envelope_document_spec.rb +0 -137
- data/spec/models/envelope_documents_result_spec.rb +0 -47
- data/spec/models/envelope_event_spec.rb +0 -47
- data/spec/models/envelope_form_data_spec.rb +0 -71
- data/spec/models/envelope_id_spec.rb +0 -221
- data/spec/models/envelope_ids_request_spec.rb +0 -47
- data/spec/models/envelope_notification_request_spec.rb +0 -53
- data/spec/models/envelope_spec.rb +0 -317
- data/spec/models/envelope_summary_spec.rb +0 -59
- data/spec/models/envelope_template_definition_spec.rb +0 -125
- data/spec/models/envelope_template_result_spec.rb +0 -401
- data/spec/models/envelope_template_results_spec.rb +0 -83
- data/spec/models/envelope_template_spec.rb +0 -329
- data/spec/models/envelope_transaction_status_spec.rb +0 -59
- data/spec/models/envelope_update_summary_spec.rb +0 -83
- data/spec/models/envelopes_information_spec.rb +0 -83
- data/spec/models/error_details_spec.rb +0 -47
- data/spec/models/event_notification_spec.rb +0 -125
- data/spec/models/event_result_spec.rb +0 -59
- data/spec/models/expirations_spec.rb +0 -53
- data/spec/models/external_doc_service_error_details_spec.rb +0 -53
- data/spec/models/external_file_spec.rb +0 -83
- data/spec/models/external_folder_spec.rb +0 -95
- data/spec/models/feature_set_spec.rb +0 -89
- data/spec/models/file_type_list_spec.rb +0 -41
- data/spec/models/file_type_spec.rb +0 -47
- data/spec/models/filter_spec.rb +0 -101
- data/spec/models/first_name_spec.rb +0 -221
- data/spec/models/folder_item_response_spec.rb +0 -77
- data/spec/models/folder_item_spec.rb +0 -161
- data/spec/models/folder_item_v2_spec.rb +0 -155
- data/spec/models/folder_items_response_spec.rb +0 -77
- data/spec/models/folder_spec.rb +0 -107
- data/spec/models/folders_request_spec.rb +0 -47
- data/spec/models/folders_response_spec.rb +0 -41
- data/spec/models/forgotten_password_information_spec.rb +0 -83
- data/spec/models/formula_tab_spec.rb +0 -329
- data/spec/models/full_name_spec.rb +0 -221
- data/spec/models/group_information_spec.rb +0 -77
- data/spec/models/group_spec.rb +0 -71
- data/spec/models/id_check_information_input_spec.rb +0 -59
- data/spec/models/in_person_signer_spec.rb +0 -365
- data/spec/models/initial_here_spec.rb +0 -197
- data/spec/models/inline_template_spec.rb +0 -65
- data/spec/models/integrated_user_info_list_spec.rb +0 -83
- data/spec/models/intermediary_spec.rb +0 -287
- data/spec/models/last_name_spec.rb +0 -221
- data/spec/models/list_custom_field_spec.rb +0 -83
- data/spec/models/list_item_spec.rb +0 -53
- data/spec/models/list_spec.rb +0 -269
- data/spec/models/lock_information_spec.rb +0 -83
- data/spec/models/lock_request_spec.rb +0 -65
- data/spec/models/login_account_spec.rb +0 -101
- data/spec/models/login_information_spec.rb +0 -47
- data/spec/models/match_box_spec.rb +0 -65
- data/spec/models/member_group_shared_item_spec.rb +0 -53
- data/spec/models/member_shared_items_spec.rb +0 -59
- data/spec/models/merge_field_spec.rb +0 -65
- data/spec/models/mobile_notifier_configuration_information_spec.rb +0 -41
- data/spec/models/mobile_notifier_configuration_spec.rb +0 -53
- data/spec/models/money_spec.rb +0 -53
- data/spec/models/name_value_spec.rb +0 -59
- data/spec/models/new_account_definition_spec.rb +0 -95
- data/spec/models/new_account_summary_spec.rb +0 -77
- data/spec/models/new_user_spec.rb +0 -95
- data/spec/models/new_users_definition_spec.rb +0 -41
- data/spec/models/new_users_summary_spec.rb +0 -41
- data/spec/models/notary_host_spec.rb +0 -275
- data/spec/models/note_spec.rb +0 -245
- data/spec/models/notification_spec.rb +0 -53
- data/spec/models/number_spec.rb +0 -317
- data/spec/models/oauth_access_spec.rb +0 -71
- data/spec/models/offline_attributes_spec.rb +0 -71
- data/spec/models/page_images_spec.rb +0 -77
- data/spec/models/page_request_spec.rb +0 -47
- data/spec/models/page_spec.rb +0 -83
- data/spec/models/payment_details_spec.rb +0 -65
- data/spec/models/payment_line_item_spec.rb +0 -59
- data/spec/models/permission_profile_information_spec.rb +0 -41
- data/spec/models/permission_profile_spec.rb +0 -77
- data/spec/models/plan_information_spec.rb +0 -71
- data/spec/models/post_transactions_request_spec.rb +0 -59
- data/spec/models/post_transactions_response_spec.rb +0 -47
- data/spec/models/power_form_form_data_envelope_spec.rb +0 -47
- data/spec/models/power_form_form_data_recipient_spec.rb +0 -59
- data/spec/models/power_form_recipient_spec.rb +0 -113
- data/spec/models/power_form_senders_response_spec.rb +0 -77
- data/spec/models/power_form_spec.rb +0 -179
- data/spec/models/power_forms_form_data_response_spec.rb +0 -41
- data/spec/models/power_forms_request_spec.rb +0 -41
- data/spec/models/power_forms_response_spec.rb +0 -77
- data/spec/models/property_metadata_spec.rb +0 -47
- data/spec/models/province_spec.rb +0 -47
- data/spec/models/provisioning_information_spec.rb +0 -77
- data/spec/models/purchased_envelopes_information_spec.rb +0 -89
- data/spec/models/radio_group_spec.rb +0 -89
- data/spec/models/radio_spec.rb +0 -143
- data/spec/models/recipient_attachment_spec.rb +0 -71
- data/spec/models/recipient_domain_spec.rb +0 -59
- data/spec/models/recipient_email_notification_spec.rb +0 -53
- data/spec/models/recipient_event_spec.rb +0 -47
- data/spec/models/recipient_form_data_spec.rb +0 -83
- data/spec/models/recipient_names_response_spec.rb +0 -53
- data/spec/models/recipient_phone_authentication_spec.rb +0 -59
- data/spec/models/recipient_saml_authentication_spec.rb +0 -41
- data/spec/models/recipient_signature_information_spec.rb +0 -53
- data/spec/models/recipient_signature_provider_options_spec.rb +0 -59
- data/spec/models/recipient_signature_provider_spec.rb +0 -47
- data/spec/models/recipient_sms_authentication_spec.rb +0 -41
- data/spec/models/recipient_update_response_spec.rb +0 -53
- data/spec/models/recipient_view_request_spec.rb +0 -119
- data/spec/models/recipients_spec.rb +0 -95
- data/spec/models/recipients_update_summary_spec.rb +0 -41
- data/spec/models/referral_information_spec.rb +0 -143
- data/spec/models/reminders_spec.rb +0 -53
- data/spec/models/resource_information_spec.rb +0 -41
- data/spec/models/return_url_request_spec.rb +0 -41
- data/spec/models/saml_assertion_attribute_spec.rb +0 -59
- data/spec/models/seat_discount_spec.rb +0 -53
- data/spec/models/sender_email_notifications_spec.rb +0 -77
- data/spec/models/server_template_spec.rb +0 -47
- data/spec/models/service_information_spec.rb +0 -71
- data/spec/models/service_version_spec.rb +0 -47
- data/spec/models/settings_metadata_spec.rb +0 -71
- data/spec/models/shared_item_spec.rb +0 -53
- data/spec/models/sign_here_spec.rb +0 -197
- data/spec/models/signature_provider_required_option_spec.rb +0 -47
- data/spec/models/signature_type_spec.rb +0 -47
- data/spec/models/signer_attachment_spec.rb +0 -197
- data/spec/models/signer_email_notifications_spec.rb +0 -119
- data/spec/models/signer_spec.rb +0 -371
- data/spec/models/signing_group_information_spec.rb +0 -41
- data/spec/models/signing_group_spec.rb +0 -95
- data/spec/models/signing_group_user_spec.rb +0 -53
- data/spec/models/signing_group_users_spec.rb +0 -41
- data/spec/models/social_account_information_spec.rb +0 -65
- data/spec/models/social_authentication_spec.rb +0 -41
- data/spec/models/ssn4_information_input_spec.rb +0 -53
- data/spec/models/ssn9_information_input_spec.rb +0 -47
- data/spec/models/ssn_spec.rb +0 -305
- data/spec/models/tab_account_settings_spec.rb +0 -263
- data/spec/models/tab_metadata_list_spec.rb +0 -41
- data/spec/models/tab_metadata_spec.rb +0 -269
- data/spec/models/tabs_spec.rb +0 -185
- data/spec/models/template_custom_fields_spec.rb +0 -47
- data/spec/models/template_document_visibility_list_spec.rb +0 -41
- data/spec/models/template_documents_result_spec.rb +0 -47
- data/spec/models/template_information_spec.rb +0 -41
- data/spec/models/template_match_spec.rb +0 -53
- data/spec/models/template_notification_request_spec.rb +0 -59
- data/spec/models/template_recipients_spec.rb +0 -95
- data/spec/models/template_role_spec.rb +0 -107
- data/spec/models/template_shared_item_spec.rb +0 -77
- data/spec/models/template_summary_spec.rb +0 -77
- data/spec/models/template_tabs_spec.rb +0 -185
- data/spec/models/template_update_summary_spec.rb +0 -83
- data/spec/models/text_custom_field_spec.rb +0 -77
- data/spec/models/text_spec.rb +0 -323
- data/spec/models/title_spec.rb +0 -269
- data/spec/models/usage_history_spec.rb +0 -59
- data/spec/models/user_account_management_granular_information_spec.rb +0 -83
- data/spec/models/user_info_list_spec.rb +0 -41
- data/spec/models/user_info_spec.rb +0 -95
- data/spec/models/user_information_list_spec.rb +0 -77
- data/spec/models/user_information_spec.rb +0 -239
- data/spec/models/user_password_information_spec.rb +0 -59
- data/spec/models/user_profile_spec.rb +0 -107
- data/spec/models/user_settings_information_spec.rb +0 -59
- data/spec/models/user_shared_item_spec.rb +0 -53
- data/spec/models/user_signature_definition_spec.rb +0 -59
- data/spec/models/user_signature_spec.rb +0 -113
- data/spec/models/user_signatures_information_spec.rb +0 -41
- data/spec/models/user_social_id_result_spec.rb +0 -47
- data/spec/models/users_response_spec.rb +0 -77
- data/spec/models/view_link_request_spec.rb +0 -47
- data/spec/models/view_spec.rb +0 -245
- data/spec/models/view_url_spec.rb +0 -41
- data/spec/models/workspace_folder_contents_spec.rb +0 -83
- data/spec/models/workspace_item_list_spec.rb +0 -41
- data/spec/models/workspace_item_spec.rb +0 -149
- data/spec/models/workspace_list_spec.rb +0 -65
- data/spec/models/workspace_spec.rb +0 -101
- data/spec/models/workspace_user_authorization_spec.rb +0 -101
- data/spec/models/workspace_user_spec.rb +0 -131
- data/spec/models/zip_spec.rb +0 -311
- data/spec/spec_helper.rb +0 -110
- data/tests/keys/docusign_private_key.txt.enc +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: e4d150ad0ffb13dd7cb0e6a50d193c45bfea596cc34f9e80bbe296b974b1bce1
|
4
|
+
data.tar.gz: fc028a49448d1b029e55b5a38a07d230176208d62b2c80531486301a82825ca1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8ace656561fc23bac87dfaffaba564223ffbe13c0e45c51146398f14f9e10e56d402394f4607db6392d156be7816d597eaf7e49735414bfc0a1516bd336bcc9f
|
7
|
+
data.tar.gz: bf7dd89162f8d6776621c9c2bb9a4e1bdf90fad646cb669368e89e8160e91ed6af60fee48c2d990055c6838c421a5fcade4f99b6ec0566fe4290c0bc8aed6ca6
|
data/Gemfile.lock
CHANGED
@@ -1,16 +1,16 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
docusign_esign (
|
5
|
-
json (~>
|
4
|
+
docusign_esign (2.0.0)
|
5
|
+
json (~> 1.8, >= 1.8.3)
|
6
6
|
jwt (~> 1.0, >= 1.5.2)
|
7
7
|
typhoeus (~> 1.0, >= 1.0.1)
|
8
8
|
|
9
9
|
GEM
|
10
10
|
remote: https://rubygems.org/
|
11
11
|
specs:
|
12
|
-
ZenTest (4.11.
|
13
|
-
addressable (2.
|
12
|
+
ZenTest (4.11.2)
|
13
|
+
addressable (2.6.0)
|
14
14
|
public_suffix (>= 2.0.2, < 4.0)
|
15
15
|
autotest (4.4.6)
|
16
16
|
ZenTest (>= 4.4.1)
|
@@ -21,13 +21,13 @@ GEM
|
|
21
21
|
crack (0.4.3)
|
22
22
|
safe_yaml (~> 1.0.0)
|
23
23
|
diff-lcs (1.3)
|
24
|
-
ethon (0.
|
24
|
+
ethon (0.12.0)
|
25
25
|
ffi (>= 1.3.0)
|
26
|
-
ffi (1.
|
27
|
-
hashdiff (0.
|
28
|
-
json (
|
26
|
+
ffi (1.11.1)
|
27
|
+
hashdiff (0.4.0)
|
28
|
+
json (1.8.6)
|
29
29
|
jwt (1.5.6)
|
30
|
-
public_suffix (3.0
|
30
|
+
public_suffix (3.1.0)
|
31
31
|
rake (12.0.0)
|
32
32
|
rspec (3.8.0)
|
33
33
|
rspec-core (~> 3.8.0)
|
@@ -35,17 +35,17 @@ GEM
|
|
35
35
|
rspec-mocks (~> 3.8.0)
|
36
36
|
rspec-core (3.8.0)
|
37
37
|
rspec-support (~> 3.8.0)
|
38
|
-
rspec-expectations (3.8.
|
38
|
+
rspec-expectations (3.8.3)
|
39
39
|
diff-lcs (>= 1.2.0, < 2.0)
|
40
40
|
rspec-support (~> 3.8.0)
|
41
41
|
rspec-mocks (3.8.0)
|
42
42
|
diff-lcs (>= 1.2.0, < 2.0)
|
43
43
|
rspec-support (~> 3.8.0)
|
44
44
|
rspec-support (3.8.0)
|
45
|
-
safe_yaml (1.0.
|
46
|
-
sys-uname (1.0.
|
45
|
+
safe_yaml (1.0.5)
|
46
|
+
sys-uname (1.0.4)
|
47
47
|
ffi (>= 1.0.0)
|
48
|
-
typhoeus (1.3.
|
48
|
+
typhoeus (1.3.1)
|
49
49
|
ethon (>= 0.9.0)
|
50
50
|
vcr (3.0.3)
|
51
51
|
webmock (1.24.6)
|
@@ -64,8 +64,10 @@ DEPENDENCIES
|
|
64
64
|
docusign_esign!
|
65
65
|
rake (~> 12.0.0)
|
66
66
|
rspec (~> 3.4, >= 3.4.0)
|
67
|
+
rspec-expectations (~> 3.8, >= 3.8.0)
|
68
|
+
rspec-mocks (~> 3.8, >= 3.8.0)
|
67
69
|
vcr (~> 3.0, >= 3.0.1)
|
68
70
|
webmock (~> 1.24, >= 1.24.3)
|
69
71
|
|
70
72
|
BUNDLED WITH
|
71
|
-
1.
|
73
|
+
1.17.3
|
data/README.md
CHANGED
@@ -4,46 +4,71 @@
|
|
4
4
|
[![RubyGems downloads][downloads-image]][downloads-url]
|
5
5
|
[![Build status][travis-image]][travis-url]
|
6
6
|
|
7
|
-
You can sign up for a free [developer sandbox](https://www.docusign.com/developer-center).
|
8
|
-
|
9
7
|
## Requirements
|
10
|
-
|
8
|
+
|
9
|
+
- Ruby 1.9+
|
10
|
+
- Free [Developer Sandbox](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
|
11
|
+
|
12
|
+
## Compatibility
|
13
|
+
|
14
|
+
- Ruby 1.9+
|
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.
|
11
19
|
|
12
20
|
## Installation
|
13
|
-
Add this line to your application's Gemfile:
|
14
21
|
|
15
|
-
|
22
|
+
### Install via your application's **Gemfile**:
|
23
|
+
|
24
|
+
1. In your application's **Gemfile**, add:
|
25
|
+
**gem 'docusign_esign'**
|
26
|
+
2. Open your preferred console.
|
27
|
+
3. In your project directory, execute the installer by typing:
|
28
|
+
**bundle install**
|
29
|
+
|
30
|
+
### Manual install:
|
31
|
+
|
32
|
+
1. Open your preferred console.
|
33
|
+
2. In the console, type:
|
34
|
+
**gem install docusign_esign**
|
35
|
+
|
36
|
+
### Dependencies
|
37
|
+
|
38
|
+
This client has the following external dependencies:
|
16
39
|
|
17
|
-
|
40
|
+
- Jwt>=1.5.2
|
41
|
+
- Json>=1.8.3
|
42
|
+
- Typhoeus>=1.0.1
|
18
43
|
|
19
|
-
|
44
|
+
## Code Examples
|
20
45
|
|
21
|
-
|
46
|
+
### Launchers
|
22
47
|
|
23
|
-
|
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.
|
24
49
|
|
25
|
-
|
50
|
+
### Proof-of-concept applications
|
26
51
|
|
27
|
-
|
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.
|
28
53
|
|
29
|
-
##
|
54
|
+
## OAuth Implementations
|
30
55
|
|
31
|
-
|
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).
|
32
57
|
|
33
|
-
|
58
|
+
For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/esign-rest-api/guides/authentication/oauth2-code-grant) flow.
|
34
59
|
|
35
|
-
|
36
|
-
* Run the following command from the [tests/spec](./tests/spec) folder
|
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:
|
37
61
|
|
38
|
-
|
62
|
+
- [JWT (JSON Web Token)](https://github.com/docusign/eg-03-ruby-auth-code-grant)
|
63
|
+
- Implicit Grant (coming soon)
|
39
64
|
|
40
65
|
## Support
|
41
66
|
|
42
|
-
|
67
|
+
Log issues against this client through GitHub. We also have an [active developer community on Stack Overflow](https://stackoverflow.com/questions/tagged/docusignapi).
|
43
68
|
|
44
69
|
## License
|
45
70
|
|
46
|
-
The DocuSign Ruby Client is licensed under the
|
71
|
+
The DocuSign Ruby Client is licensed under the [MIT License](https://github.com/docusign/docusign-ruby-client/blob/master/LICENSE).
|
47
72
|
|
48
73
|
[rubygems-image]: https://img.shields.io/gem/v/docusign_esign.svg?style=flat
|
49
74
|
[rubygems-url]: https://rubygems.org/gems/docusign_esign
|
data/docusign_esign.gemspec
CHANGED
@@ -23,15 +23,15 @@ Gem::Specification.new do |s|
|
|
23
23
|
s.homepage = "https://github.com/docusign/docusign-ruby-client"
|
24
24
|
s.summary = "DocuSign REST API Ruby Gem"
|
25
25
|
s.description = "The DocuSign package makes integrating DocuSign into your apps and websites a super fast and painless process. The library is open sourced on GitHub, look for the docusign-ruby-client repository. Join the eSign revolution!"
|
26
|
-
# TODO uncommnet and update below with a proper license
|
27
26
|
s.license = "MIT"
|
28
|
-
s.required_ruby_version = ">=
|
29
|
-
|
30
|
-
s.add_dependency 'jwt', '~> 1.0', '>= 1.5.2'
|
27
|
+
s.required_ruby_version = ">= 1.9"
|
31
28
|
|
29
|
+
s.add_runtime_dependency 'jwt', '~> 1.0', '>= 1.5.2'
|
32
30
|
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
33
|
-
s.add_runtime_dependency 'json', '~>
|
31
|
+
s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
|
34
32
|
|
33
|
+
s.add_development_dependency 'rspec-mocks', '~> 3.8', '>= 3.8.0'
|
34
|
+
s.add_development_dependency 'rspec-expectations', '~> 3.8', '>= 3.8.0'
|
35
35
|
s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
|
36
36
|
s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
|
37
37
|
s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
|
data/lib/.DS_Store
ADDED
Binary file
|
data/lib/docusign_esign.rb
CHANGED
@@ -10,17 +10,33 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
10
10
|
=end
|
11
11
|
|
12
12
|
# Common files
|
13
|
-
require 'docusign_esign/api_client'
|
14
|
-
require 'docusign_esign/api_error'
|
13
|
+
require 'docusign_esign/client/api_client'
|
14
|
+
require 'docusign_esign/client/api_error'
|
15
15
|
require 'docusign_esign/version'
|
16
16
|
require 'docusign_esign/configuration'
|
17
17
|
|
18
|
+
# Client Files
|
19
|
+
require 'docusign_esign/client/auth/oauth'
|
20
|
+
|
18
21
|
# Models
|
19
22
|
require 'docusign_esign/models/account_address'
|
20
23
|
require 'docusign_esign/models/account_billing_plan'
|
21
24
|
require 'docusign_esign/models/account_billing_plan_response'
|
25
|
+
require 'docusign_esign/models/account_identity_verification_response'
|
26
|
+
require 'docusign_esign/models/account_identity_verification_step'
|
27
|
+
require 'docusign_esign/models/account_identity_verification_workflow'
|
22
28
|
require 'docusign_esign/models/account_information'
|
29
|
+
require 'docusign_esign/models/account_minimum_password_length'
|
30
|
+
require 'docusign_esign/models/account_password_expire_password_days'
|
31
|
+
require 'docusign_esign/models/account_password_lockout_duration_minutes'
|
32
|
+
require 'docusign_esign/models/account_password_lockout_duration_type'
|
33
|
+
require 'docusign_esign/models/account_password_minimum_password_age_days'
|
34
|
+
require 'docusign_esign/models/account_password_questions_required'
|
35
|
+
require 'docusign_esign/models/account_password_rules'
|
36
|
+
require 'docusign_esign/models/account_password_strength_type'
|
37
|
+
require 'docusign_esign/models/account_password_strength_type_option'
|
23
38
|
require 'docusign_esign/models/account_role_settings'
|
39
|
+
require 'docusign_esign/models/account_seals'
|
24
40
|
require 'docusign_esign/models/account_settings_information'
|
25
41
|
require 'docusign_esign/models/account_shared_access'
|
26
42
|
require 'docusign_esign/models/account_signature_provider'
|
@@ -90,6 +106,8 @@ require 'docusign_esign/models/chunked_upload_response'
|
|
90
106
|
require 'docusign_esign/models/cloud_storage_provider'
|
91
107
|
require 'docusign_esign/models/cloud_storage_providers'
|
92
108
|
require 'docusign_esign/models/company'
|
109
|
+
require 'docusign_esign/models/complete_sign_hash_response'
|
110
|
+
require 'docusign_esign/models/complete_sign_request'
|
93
111
|
require 'docusign_esign/models/composite_template'
|
94
112
|
require 'docusign_esign/models/connect_config_results'
|
95
113
|
require 'docusign_esign/models/connect_custom_configuration'
|
@@ -104,26 +122,39 @@ require 'docusign_esign/models/consumer_disclosure'
|
|
104
122
|
require 'docusign_esign/models/contact'
|
105
123
|
require 'docusign_esign/models/contact_get_response'
|
106
124
|
require 'docusign_esign/models/contact_mod_request'
|
125
|
+
require 'docusign_esign/models/contact_phone_number'
|
107
126
|
require 'docusign_esign/models/contact_update_response'
|
108
127
|
require 'docusign_esign/models/correct_view_request'
|
109
128
|
require 'docusign_esign/models/country'
|
129
|
+
require 'docusign_esign/models/credential'
|
110
130
|
require 'docusign_esign/models/credit_card_information'
|
111
131
|
require 'docusign_esign/models/credit_card_types'
|
112
132
|
require 'docusign_esign/models/currency_feature_set_price'
|
113
133
|
require 'docusign_esign/models/currency_plan_price'
|
134
|
+
require 'docusign_esign/models/custom_field'
|
114
135
|
require 'docusign_esign/models/custom_field_v2'
|
115
136
|
require 'docusign_esign/models/custom_fields'
|
116
137
|
require 'docusign_esign/models/custom_fields_envelope'
|
117
138
|
require 'docusign_esign/models/custom_settings_information'
|
118
139
|
require 'docusign_esign/models/date'
|
119
140
|
require 'docusign_esign/models/date_signed'
|
141
|
+
require 'docusign_esign/models/date_stamp_properties'
|
120
142
|
require 'docusign_esign/models/decline'
|
121
143
|
require 'docusign_esign/models/diagnostics_settings_information'
|
122
144
|
require 'docusign_esign/models/dob_information_input'
|
123
145
|
require 'docusign_esign/models/document'
|
124
146
|
require 'docusign_esign/models/document_fields_information'
|
147
|
+
require 'docusign_esign/models/document_html_collapsible_display_settings'
|
148
|
+
require 'docusign_esign/models/document_html_definition'
|
149
|
+
require 'docusign_esign/models/document_html_definition_original'
|
150
|
+
require 'docusign_esign/models/document_html_definition_originals'
|
151
|
+
require 'docusign_esign/models/document_html_definitions'
|
152
|
+
require 'docusign_esign/models/document_html_display_anchor'
|
153
|
+
require 'docusign_esign/models/document_html_display_settings'
|
154
|
+
require 'docusign_esign/models/document_security_store'
|
125
155
|
require 'docusign_esign/models/document_template'
|
126
156
|
require 'docusign_esign/models/document_template_list'
|
157
|
+
require 'docusign_esign/models/document_update_info'
|
127
158
|
require 'docusign_esign/models/document_visibility'
|
128
159
|
require 'docusign_esign/models/document_visibility_list'
|
129
160
|
require 'docusign_esign/models/e_note_configuration'
|
@@ -183,6 +214,7 @@ require 'docusign_esign/models/initial_here'
|
|
183
214
|
require 'docusign_esign/models/inline_template'
|
184
215
|
require 'docusign_esign/models/integrated_user_info_list'
|
185
216
|
require 'docusign_esign/models/intermediary'
|
217
|
+
require 'docusign_esign/models/jurisdiction'
|
186
218
|
require 'docusign_esign/models/last_name'
|
187
219
|
require 'docusign_esign/models/list'
|
188
220
|
require 'docusign_esign/models/list_custom_field'
|
@@ -204,22 +236,27 @@ require 'docusign_esign/models/new_account_summary'
|
|
204
236
|
require 'docusign_esign/models/new_user'
|
205
237
|
require 'docusign_esign/models/new_users_definition'
|
206
238
|
require 'docusign_esign/models/new_users_summary'
|
239
|
+
require 'docusign_esign/models/notarize'
|
207
240
|
require 'docusign_esign/models/notary_host'
|
241
|
+
require 'docusign_esign/models/notary_journal'
|
242
|
+
require 'docusign_esign/models/notary_journal_credible_witness'
|
243
|
+
require 'docusign_esign/models/notary_journal_list'
|
244
|
+
require 'docusign_esign/models/notary_journal_meta_data'
|
208
245
|
require 'docusign_esign/models/note'
|
209
246
|
require 'docusign_esign/models/notification'
|
210
247
|
require 'docusign_esign/models/number'
|
211
248
|
require 'docusign_esign/models/oauth_access'
|
212
|
-
require 'docusign_esign/models/offline_attributes'
|
213
249
|
require 'docusign_esign/models/page'
|
214
250
|
require 'docusign_esign/models/page_images'
|
215
251
|
require 'docusign_esign/models/page_request'
|
216
252
|
require 'docusign_esign/models/payment_details'
|
253
|
+
require 'docusign_esign/models/payment_gateway_account'
|
254
|
+
require 'docusign_esign/models/payment_gateway_accounts_info'
|
217
255
|
require 'docusign_esign/models/payment_line_item'
|
256
|
+
require 'docusign_esign/models/payment_processor_information'
|
218
257
|
require 'docusign_esign/models/permission_profile'
|
219
258
|
require 'docusign_esign/models/permission_profile_information'
|
220
259
|
require 'docusign_esign/models/plan_information'
|
221
|
-
require 'docusign_esign/models/post_transactions_request'
|
222
|
-
require 'docusign_esign/models/post_transactions_response'
|
223
260
|
require 'docusign_esign/models/power_form'
|
224
261
|
require 'docusign_esign/models/power_form_form_data_envelope'
|
225
262
|
require 'docusign_esign/models/power_form_form_data_recipient'
|
@@ -254,15 +291,24 @@ require 'docusign_esign/models/referral_information'
|
|
254
291
|
require 'docusign_esign/models/reminders'
|
255
292
|
require 'docusign_esign/models/resource_information'
|
256
293
|
require 'docusign_esign/models/return_url_request'
|
294
|
+
require 'docusign_esign/models/revision'
|
257
295
|
require 'docusign_esign/models/saml_assertion_attribute'
|
296
|
+
require 'docusign_esign/models/seal'
|
297
|
+
require 'docusign_esign/models/seal_identifier'
|
298
|
+
require 'docusign_esign/models/seal_sign'
|
258
299
|
require 'docusign_esign/models/seat_discount'
|
300
|
+
require 'docusign_esign/models/sender'
|
259
301
|
require 'docusign_esign/models/sender_email_notifications'
|
260
302
|
require 'docusign_esign/models/server_template'
|
261
303
|
require 'docusign_esign/models/service_information'
|
262
304
|
require 'docusign_esign/models/service_version'
|
263
305
|
require 'docusign_esign/models/settings_metadata'
|
264
306
|
require 'docusign_esign/models/shared_item'
|
307
|
+
require 'docusign_esign/models/sign_hash_document'
|
308
|
+
require 'docusign_esign/models/sign_hash_session_info_response'
|
265
309
|
require 'docusign_esign/models/sign_here'
|
310
|
+
require 'docusign_esign/models/sign_session_info_request'
|
311
|
+
require 'docusign_esign/models/signature_data_info'
|
266
312
|
require 'docusign_esign/models/signature_provider_required_option'
|
267
313
|
require 'docusign_esign/models/signature_type'
|
268
314
|
require 'docusign_esign/models/signer'
|
@@ -272,11 +318,16 @@ require 'docusign_esign/models/signing_group'
|
|
272
318
|
require 'docusign_esign/models/signing_group_information'
|
273
319
|
require 'docusign_esign/models/signing_group_user'
|
274
320
|
require 'docusign_esign/models/signing_group_users'
|
321
|
+
require 'docusign_esign/models/smart_section'
|
322
|
+
require 'docusign_esign/models/smart_section_anchor_position'
|
323
|
+
require 'docusign_esign/models/smart_section_collapsible_display_settings'
|
324
|
+
require 'docusign_esign/models/smart_section_display_settings'
|
275
325
|
require 'docusign_esign/models/social_account_information'
|
276
326
|
require 'docusign_esign/models/social_authentication'
|
277
327
|
require 'docusign_esign/models/ssn'
|
278
328
|
require 'docusign_esign/models/ssn4_information_input'
|
279
329
|
require 'docusign_esign/models/ssn9_information_input'
|
330
|
+
require 'docusign_esign/models/supported_languages'
|
280
331
|
require 'docusign_esign/models/tab_account_settings'
|
281
332
|
require 'docusign_esign/models/tab_metadata'
|
282
333
|
require 'docusign_esign/models/tab_metadata_list'
|
@@ -295,14 +346,22 @@ require 'docusign_esign/models/template_tabs'
|
|
295
346
|
require 'docusign_esign/models/template_update_summary'
|
296
347
|
require 'docusign_esign/models/text'
|
297
348
|
require 'docusign_esign/models/text_custom_field'
|
349
|
+
require 'docusign_esign/models/time_stamp_field'
|
298
350
|
require 'docusign_esign/models/title'
|
351
|
+
require 'docusign_esign/models/tsp_health_check_request'
|
352
|
+
require 'docusign_esign/models/tsp_health_check_status_description'
|
353
|
+
require 'docusign_esign/models/update_transaction_request'
|
354
|
+
require 'docusign_esign/models/update_transaction_response'
|
299
355
|
require 'docusign_esign/models/usage_history'
|
356
|
+
require 'docusign_esign/models/user'
|
300
357
|
require 'docusign_esign/models/user_account_management_granular_information'
|
301
358
|
require 'docusign_esign/models/user_info'
|
302
359
|
require 'docusign_esign/models/user_info_list'
|
360
|
+
require 'docusign_esign/models/user_info_response'
|
303
361
|
require 'docusign_esign/models/user_information'
|
304
362
|
require 'docusign_esign/models/user_information_list'
|
305
363
|
require 'docusign_esign/models/user_password_information'
|
364
|
+
require 'docusign_esign/models/user_password_rules'
|
306
365
|
require 'docusign_esign/models/user_profile'
|
307
366
|
require 'docusign_esign/models/user_settings_information'
|
308
367
|
require 'docusign_esign/models/user_shared_item'
|
@@ -312,8 +371,9 @@ require 'docusign_esign/models/user_signatures_information'
|
|
312
371
|
require 'docusign_esign/models/user_social_id_result'
|
313
372
|
require 'docusign_esign/models/users_response'
|
314
373
|
require 'docusign_esign/models/view'
|
315
|
-
require 'docusign_esign/models/view_link_request'
|
316
374
|
require 'docusign_esign/models/view_url'
|
375
|
+
require 'docusign_esign/models/watermark'
|
376
|
+
require 'docusign_esign/models/witness'
|
317
377
|
require 'docusign_esign/models/workspace'
|
318
378
|
require 'docusign_esign/models/workspace_folder_contents'
|
319
379
|
require 'docusign_esign/models/workspace_item'
|
@@ -329,15 +389,18 @@ require 'docusign_esign/api/authentication_api'
|
|
329
389
|
require 'docusign_esign/api/billing_api'
|
330
390
|
require 'docusign_esign/api/bulk_envelopes_api'
|
331
391
|
require 'docusign_esign/api/cloud_storage_api'
|
392
|
+
require 'docusign_esign/api/comments_api'
|
332
393
|
require 'docusign_esign/api/connect_api'
|
333
394
|
require 'docusign_esign/api/custom_tabs_api'
|
334
395
|
require 'docusign_esign/api/diagnostics_api'
|
335
396
|
require 'docusign_esign/api/envelopes_api'
|
336
397
|
require 'docusign_esign/api/folders_api'
|
337
398
|
require 'docusign_esign/api/groups_api'
|
399
|
+
require 'docusign_esign/api/notary_api'
|
338
400
|
require 'docusign_esign/api/power_forms_api'
|
339
401
|
require 'docusign_esign/api/signing_groups_api'
|
340
402
|
require 'docusign_esign/api/templates_api'
|
403
|
+
require 'docusign_esign/api/trust_service_providers_api'
|
341
404
|
require 'docusign_esign/api/users_api'
|
342
405
|
require 'docusign_esign/api/workspaces_api'
|
343
406
|
|
Binary file
|
@@ -22,6 +22,15 @@ module DocuSign_eSign
|
|
22
22
|
end
|
23
23
|
end
|
24
24
|
|
25
|
+
class CreateCustomFieldOptions
|
26
|
+
#
|
27
|
+
attr_accessor :apply_to_templates
|
28
|
+
|
29
|
+
def self.default
|
30
|
+
@@default ||= CreateCustomFieldOptions.new
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
25
34
|
class CreatePermissionProfileOptions
|
26
35
|
#
|
27
36
|
attr_accessor :include
|
@@ -31,6 +40,15 @@ module DocuSign_eSign
|
|
31
40
|
end
|
32
41
|
end
|
33
42
|
|
43
|
+
class DeleteCustomFieldOptions
|
44
|
+
#
|
45
|
+
attr_accessor :apply_to_templates
|
46
|
+
|
47
|
+
def self.default
|
48
|
+
@@default ||= DeleteCustomFieldOptions.new
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
34
52
|
class GetAccountInformationOptions
|
35
53
|
# When set to **true**, includes the account settings for the account in the response.
|
36
54
|
attr_accessor :include_account_settings
|
@@ -134,7 +152,7 @@ module DocuSign_eSign
|
|
134
152
|
# Specifies the type of shared item being requested. The accepted values are: -envelopes: returns information about envelope sharing between users.
|
135
153
|
attr_accessor :item_type
|
136
154
|
|
137
|
-
# This can be used to filter user names in the response. The wild-card
|
155
|
+
# This can be used to filter user names in the response. The wild-card '*' (asterisk) can be used around the string.
|
138
156
|
attr_accessor :search_text
|
139
157
|
|
140
158
|
# Specifies which users should be included in the response. Multiple values can be used in the query by using a comma separated list of shared values. If the requestor does not have account administrator privileges, the shared_to value is used. Requestors that do not have account administrator privileges can only use the shared_to, any other setting will result in an error. The accepted values are: -not_shared: Returns account users that the specified item type is not being shared with and that are not sharing the specified item type with the user. User X (Share) X Account user -shared_to: Returns account users that the specified item type is not being shared with and who are sharing the specified item type with the user (only shared to the user). User X (Share) Account user -shared_from: Returns account users that the specified item type is being shared with and who are not sharing the specified item type with the user (only shared from the user). User (Share) >> Account user -shared_to_and_from: Returns account users that the specified item type is being shared with and who are sharing the specified item type with the user. User << (Share) >> Account user
|
@@ -151,6 +169,24 @@ module DocuSign_eSign
|
|
151
169
|
end
|
152
170
|
end
|
153
171
|
|
172
|
+
class UpdateConsumerDisclosureOptions
|
173
|
+
#
|
174
|
+
attr_accessor :include_metadata
|
175
|
+
|
176
|
+
def self.default
|
177
|
+
@@default ||= UpdateConsumerDisclosureOptions.new
|
178
|
+
end
|
179
|
+
end
|
180
|
+
|
181
|
+
class UpdateCustomFieldOptions
|
182
|
+
#
|
183
|
+
attr_accessor :apply_to_templates
|
184
|
+
|
185
|
+
def self.default
|
186
|
+
@@default ||= UpdateCustomFieldOptions.new
|
187
|
+
end
|
188
|
+
end
|
189
|
+
|
154
190
|
class UpdatePermissionProfileOptions
|
155
191
|
#
|
156
192
|
attr_accessor :include
|
@@ -281,32 +317,35 @@ module DocuSign_eSign
|
|
281
317
|
return data, status_code, headers
|
282
318
|
end
|
283
319
|
|
284
|
-
#
|
320
|
+
# Creates an acount custom field.
|
285
321
|
#
|
286
322
|
# @param account_id The external account number (int) or account ID Guid.
|
287
|
-
# @param
|
288
|
-
# @
|
289
|
-
|
290
|
-
|
323
|
+
# @param custom_field (optional parameter)
|
324
|
+
# @param DocuSign_eSign::CreateCustomFieldOptions Options for modifying the behavior of the function.
|
325
|
+
# @return [CustomFields]
|
326
|
+
def create_custom_field(account_id, custom_field, options = DocuSign_eSign::CreateCustomFieldOptions.default)
|
327
|
+
data, _status_code, _headers = create_custom_field_with_http_info(account_id, custom_field, options)
|
291
328
|
return data
|
292
329
|
end
|
293
330
|
|
294
|
-
#
|
331
|
+
# Creates an acount custom field.
|
295
332
|
#
|
296
333
|
# @param account_id The external account number (int) or account ID Guid.
|
297
|
-
# @param
|
298
|
-
# @
|
299
|
-
|
334
|
+
# @param custom_field (optional parameter)
|
335
|
+
# @param DocuSign_eSign::CreateCustomFieldOptions Options for modifying the behavior of the function.
|
336
|
+
# @return [Array<(CustomFields, Fixnum, Hash)>] CustomFields data, response status code and response headers
|
337
|
+
def create_custom_field_with_http_info(account_id, custom_field, options = DocuSign_eSign::CreateCustomFieldOptions.default)
|
300
338
|
if @api_client.config.debugging
|
301
|
-
@api_client.config.logger.debug "Calling API: AccountsApi.
|
339
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.create_custom_field ..."
|
302
340
|
end
|
303
341
|
# verify the required parameter 'account_id' is set
|
304
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.
|
342
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_custom_field" if account_id.nil?
|
305
343
|
# resource path
|
306
|
-
local_var_path = "/v2/accounts/{accountId}/
|
344
|
+
local_var_path = "/v2/accounts/{accountId}/custom_fields".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
307
345
|
|
308
346
|
# query parameters
|
309
347
|
query_params = {}
|
348
|
+
query_params[:'apply_to_templates'] = options.apply_to_templates if !options.apply_to_templates.nil?
|
310
349
|
|
311
350
|
# header parameters
|
312
351
|
header_params = {}
|
@@ -317,7 +356,7 @@ module DocuSign_eSign
|
|
317
356
|
form_params = {}
|
318
357
|
|
319
358
|
# http body (model)
|
320
|
-
post_body = @api_client.object_to_http_body(
|
359
|
+
post_body = @api_client.object_to_http_body(custom_field)
|
321
360
|
auth_names = []
|
322
361
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
323
362
|
:header_params => header_params,
|
@@ -325,9 +364,9 @@ module DocuSign_eSign
|
|
325
364
|
:form_params => form_params,
|
326
365
|
:body => post_body,
|
327
366
|
:auth_names => auth_names,
|
328
|
-
:return_type => '
|
367
|
+
:return_type => 'CustomFields')
|
329
368
|
if @api_client.config.debugging
|
330
|
-
@api_client.config.logger.debug "API called: AccountsApi#
|
369
|
+
@api_client.config.logger.debug "API called: AccountsApi#create_custom_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
331
370
|
end
|
332
371
|
return data, status_code, headers
|
333
372
|
end
|
@@ -648,6 +687,61 @@ module DocuSign_eSign
|
|
648
687
|
return data, status_code, headers
|
649
688
|
end
|
650
689
|
|
690
|
+
# Delete an existing account custom field.
|
691
|
+
#
|
692
|
+
# @param account_id The external account number (int) or account ID Guid.
|
693
|
+
# @param custom_field_id
|
694
|
+
# @param DocuSign_eSign::DeleteCustomFieldOptions Options for modifying the behavior of the function.
|
695
|
+
# @return [nil]
|
696
|
+
def delete_custom_field(account_id, custom_field_id, options = DocuSign_eSign::DeleteCustomFieldOptions.default)
|
697
|
+
delete_custom_field_with_http_info(account_id, custom_field_id, options)
|
698
|
+
return nil
|
699
|
+
end
|
700
|
+
|
701
|
+
# Delete an existing account custom field.
|
702
|
+
#
|
703
|
+
# @param account_id The external account number (int) or account ID Guid.
|
704
|
+
# @param custom_field_id
|
705
|
+
# @param DocuSign_eSign::DeleteCustomFieldOptions Options for modifying the behavior of the function.
|
706
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
707
|
+
def delete_custom_field_with_http_info(account_id, custom_field_id, options = DocuSign_eSign::DeleteCustomFieldOptions.default)
|
708
|
+
if @api_client.config.debugging
|
709
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.delete_custom_field ..."
|
710
|
+
end
|
711
|
+
# verify the required parameter 'account_id' is set
|
712
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_custom_field" if account_id.nil?
|
713
|
+
# verify the required parameter 'custom_field_id' is set
|
714
|
+
fail ArgumentError, "Missing the required parameter 'custom_field_id' when calling AccountsApi.delete_custom_field" if custom_field_id.nil?
|
715
|
+
# resource path
|
716
|
+
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)
|
717
|
+
|
718
|
+
# query parameters
|
719
|
+
query_params = {}
|
720
|
+
query_params[:'apply_to_templates'] = options.apply_to_templates if !options.apply_to_templates.nil?
|
721
|
+
|
722
|
+
# header parameters
|
723
|
+
header_params = {}
|
724
|
+
# HTTP header 'Accept' (if needed)
|
725
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
726
|
+
|
727
|
+
# form parameters
|
728
|
+
form_params = {}
|
729
|
+
|
730
|
+
# http body (model)
|
731
|
+
post_body = nil
|
732
|
+
auth_names = []
|
733
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
734
|
+
:header_params => header_params,
|
735
|
+
:query_params => query_params,
|
736
|
+
:form_params => form_params,
|
737
|
+
:body => post_body,
|
738
|
+
:auth_names => auth_names)
|
739
|
+
if @api_client.config.debugging
|
740
|
+
@api_client.config.logger.debug "API called: AccountsApi#delete_custom_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
741
|
+
end
|
742
|
+
return data, status_code, headers
|
743
|
+
end
|
744
|
+
|
651
745
|
# Deletes configuration information for the eNote eOriginal integration.
|
652
746
|
#
|
653
747
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -748,6 +842,55 @@ module DocuSign_eSign
|
|
748
842
|
return data, status_code, headers
|
749
843
|
end
|
750
844
|
|
845
|
+
# Get the list of identity verification options for an account
|
846
|
+
#
|
847
|
+
# @param account_id The external account number (int) or account ID Guid.
|
848
|
+
# @return [AccountIdentityVerificationResponse]
|
849
|
+
def get_account_identity_verification(account_id)
|
850
|
+
data, _status_code, _headers = get_account_identity_verification_with_http_info(account_id)
|
851
|
+
return data
|
852
|
+
end
|
853
|
+
|
854
|
+
# Get the list of identity verification options for an account
|
855
|
+
#
|
856
|
+
# @param account_id The external account number (int) or account ID Guid.
|
857
|
+
# @return [Array<(AccountIdentityVerificationResponse, Fixnum, Hash)>] AccountIdentityVerificationResponse data, response status code and response headers
|
858
|
+
def get_account_identity_verification_with_http_info(account_id)
|
859
|
+
if @api_client.config.debugging
|
860
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_account_identity_verification ..."
|
861
|
+
end
|
862
|
+
# verify the required parameter 'account_id' is set
|
863
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_identity_verification" if account_id.nil?
|
864
|
+
# resource path
|
865
|
+
local_var_path = "/v2/accounts/{accountId}/identity_verification".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
866
|
+
|
867
|
+
# query parameters
|
868
|
+
query_params = {}
|
869
|
+
|
870
|
+
# header parameters
|
871
|
+
header_params = {}
|
872
|
+
# HTTP header 'Accept' (if needed)
|
873
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
874
|
+
|
875
|
+
# form parameters
|
876
|
+
form_params = {}
|
877
|
+
|
878
|
+
# http body (model)
|
879
|
+
post_body = nil
|
880
|
+
auth_names = []
|
881
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
882
|
+
:header_params => header_params,
|
883
|
+
:query_params => query_params,
|
884
|
+
:form_params => form_params,
|
885
|
+
:body => post_body,
|
886
|
+
:auth_names => auth_names,
|
887
|
+
:return_type => 'AccountIdentityVerificationResponse')
|
888
|
+
if @api_client.config.debugging
|
889
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_account_identity_verification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
890
|
+
end
|
891
|
+
return data, status_code, headers
|
892
|
+
end
|
893
|
+
|
751
894
|
# Retrieves the account information for the specified account.
|
752
895
|
# Retrieves the account information for the specified account. **Response** The `canUpgrade` property contains is a Boolean that indicates whether the account can be upgraded through the API.
|
753
896
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -849,6 +992,55 @@ module DocuSign_eSign
|
|
849
992
|
return data, status_code, headers
|
850
993
|
end
|
851
994
|
|
995
|
+
# Get all payment gateway account for the provided accountId
|
996
|
+
#
|
997
|
+
# @param account_id The external account number (int) or account ID Guid.
|
998
|
+
# @return [PaymentGatewayAccountsInfo]
|
999
|
+
def get_all_payment_gateway_accounts(account_id)
|
1000
|
+
data, _status_code, _headers = get_all_payment_gateway_accounts_with_http_info(account_id)
|
1001
|
+
return data
|
1002
|
+
end
|
1003
|
+
|
1004
|
+
# Get all payment gateway account for the provided accountId
|
1005
|
+
#
|
1006
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1007
|
+
# @return [Array<(PaymentGatewayAccountsInfo, Fixnum, Hash)>] PaymentGatewayAccountsInfo data, response status code and response headers
|
1008
|
+
def get_all_payment_gateway_accounts_with_http_info(account_id)
|
1009
|
+
if @api_client.config.debugging
|
1010
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_all_payment_gateway_accounts ..."
|
1011
|
+
end
|
1012
|
+
# verify the required parameter 'account_id' is set
|
1013
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_all_payment_gateway_accounts" if account_id.nil?
|
1014
|
+
# resource path
|
1015
|
+
local_var_path = "/v2/accounts/{accountId}/payment_gateway_accounts".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1016
|
+
|
1017
|
+
# query parameters
|
1018
|
+
query_params = {}
|
1019
|
+
|
1020
|
+
# header parameters
|
1021
|
+
header_params = {}
|
1022
|
+
# HTTP header 'Accept' (if needed)
|
1023
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1024
|
+
|
1025
|
+
# form parameters
|
1026
|
+
form_params = {}
|
1027
|
+
|
1028
|
+
# http body (model)
|
1029
|
+
post_body = nil
|
1030
|
+
auth_names = []
|
1031
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1032
|
+
:header_params => header_params,
|
1033
|
+
:query_params => query_params,
|
1034
|
+
:form_params => form_params,
|
1035
|
+
:body => post_body,
|
1036
|
+
:auth_names => auth_names,
|
1037
|
+
:return_type => 'PaymentGatewayAccountsInfo')
|
1038
|
+
if @api_client.config.debugging
|
1039
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_all_payment_gateway_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1040
|
+
end
|
1041
|
+
return data, status_code, headers
|
1042
|
+
end
|
1043
|
+
|
852
1044
|
# Gets list of recurring and usage charges for the account.
|
853
1045
|
# Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. Privileges required: account administrator
|
854
1046
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -958,15 +1150,67 @@ module DocuSign_eSign
|
|
958
1150
|
return data, status_code, headers
|
959
1151
|
end
|
960
1152
|
|
1153
|
+
# Export a specific brand.
|
1154
|
+
#
|
1155
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1156
|
+
# @param brand_id The unique identifier of a brand.
|
1157
|
+
# @return [nil]
|
1158
|
+
def get_brand_export_file(account_id, brand_id)
|
1159
|
+
get_brand_export_file_with_http_info(account_id, brand_id)
|
1160
|
+
return nil
|
1161
|
+
end
|
1162
|
+
|
1163
|
+
# Export a specific brand.
|
1164
|
+
#
|
1165
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1166
|
+
# @param brand_id The unique identifier of a brand.
|
1167
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1168
|
+
def get_brand_export_file_with_http_info(account_id, brand_id)
|
1169
|
+
if @api_client.config.debugging
|
1170
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_brand_export_file ..."
|
1171
|
+
end
|
1172
|
+
# verify the required parameter 'account_id' is set
|
1173
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_brand_export_file" if account_id.nil?
|
1174
|
+
# verify the required parameter 'brand_id' is set
|
1175
|
+
fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.get_brand_export_file" if brand_id.nil?
|
1176
|
+
# resource path
|
1177
|
+
local_var_path = "/v2/accounts/{accountId}/brands/{brandId}/file".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'brandId' + '}', brand_id.to_s)
|
1178
|
+
|
1179
|
+
# query parameters
|
1180
|
+
query_params = {}
|
1181
|
+
|
1182
|
+
# header parameters
|
1183
|
+
header_params = {}
|
1184
|
+
# HTTP header 'Accept' (if needed)
|
1185
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1186
|
+
|
1187
|
+
# form parameters
|
1188
|
+
form_params = {}
|
1189
|
+
|
1190
|
+
# http body (model)
|
1191
|
+
post_body = nil
|
1192
|
+
auth_names = []
|
1193
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1194
|
+
:header_params => header_params,
|
1195
|
+
:query_params => query_params,
|
1196
|
+
:form_params => form_params,
|
1197
|
+
:body => post_body,
|
1198
|
+
:auth_names => auth_names)
|
1199
|
+
if @api_client.config.debugging
|
1200
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_brand_export_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1201
|
+
end
|
1202
|
+
return data, status_code, headers
|
1203
|
+
end
|
1204
|
+
|
961
1205
|
# Obtains the specified image for a brand.
|
962
1206
|
#
|
963
1207
|
# @param account_id The external account number (int) or account ID Guid.
|
964
1208
|
# @param brand_id The unique identifier of a brand.
|
965
1209
|
# @param logo_type One of **Primary**, **Secondary** or **Email**.
|
966
|
-
# @return [
|
1210
|
+
# @return [File]
|
967
1211
|
def get_brand_logo_by_type(account_id, brand_id, logo_type)
|
968
|
-
get_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type)
|
969
|
-
return
|
1212
|
+
data, _status_code, _headers = get_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type)
|
1213
|
+
return data
|
970
1214
|
end
|
971
1215
|
|
972
1216
|
# Obtains the specified image for a brand.
|
@@ -974,7 +1218,7 @@ module DocuSign_eSign
|
|
974
1218
|
# @param account_id The external account number (int) or account ID Guid.
|
975
1219
|
# @param brand_id The unique identifier of a brand.
|
976
1220
|
# @param logo_type One of **Primary**, **Secondary** or **Email**.
|
977
|
-
# @return [Array<(
|
1221
|
+
# @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
|
978
1222
|
def get_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type)
|
979
1223
|
if @api_client.config.debugging
|
980
1224
|
@api_client.config.logger.debug "Calling API: AccountsApi.get_brand_logo_by_type ..."
|
@@ -994,7 +1238,7 @@ module DocuSign_eSign
|
|
994
1238
|
# header parameters
|
995
1239
|
header_params = {}
|
996
1240
|
# HTTP header 'Accept' (if needed)
|
997
|
-
header_params['Accept'] = @api_client.select_header_accept(['
|
1241
|
+
header_params['Accept'] = @api_client.select_header_accept(['image/png'])
|
998
1242
|
|
999
1243
|
# form parameters
|
1000
1244
|
form_params = {}
|
@@ -1007,7 +1251,8 @@ module DocuSign_eSign
|
|
1007
1251
|
:query_params => query_params,
|
1008
1252
|
:form_params => form_params,
|
1009
1253
|
:body => post_body,
|
1010
|
-
:auth_names => auth_names
|
1254
|
+
:auth_names => auth_names,
|
1255
|
+
:return_type => 'File')
|
1011
1256
|
if @api_client.config.debugging
|
1012
1257
|
@api_client.config.logger.debug "API called: AccountsApi#get_brand_logo_by_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1013
1258
|
end
|
@@ -1130,7 +1375,7 @@ module DocuSign_eSign
|
|
1130
1375
|
# Gets the Electronic Record and Signature Disclosure.
|
1131
1376
|
# 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.
|
1132
1377
|
# @param account_id The external account number (int) or account ID Guid.
|
1133
|
-
# @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
|
1378
|
+
# @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.
|
1134
1379
|
# @return [ConsumerDisclosure]
|
1135
1380
|
def get_consumer_disclosure(account_id, lang_code)
|
1136
1381
|
data, _status_code, _headers = get_consumer_disclosure_with_http_info(account_id, lang_code)
|
@@ -1140,7 +1385,7 @@ module DocuSign_eSign
|
|
1140
1385
|
# Gets the Electronic Record and Signature Disclosure.
|
1141
1386
|
# 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.
|
1142
1387
|
# @param account_id The external account number (int) or account ID Guid.
|
1143
|
-
# @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
|
1388
|
+
# @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.
|
1144
1389
|
# @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
|
1145
1390
|
def get_consumer_disclosure_with_http_info(account_id, lang_code)
|
1146
1391
|
if @api_client.config.debugging
|
@@ -1281,37 +1526,30 @@ module DocuSign_eSign
|
|
1281
1526
|
return data, status_code, headers
|
1282
1527
|
end
|
1283
1528
|
|
1284
|
-
#
|
1529
|
+
# Get the password rules
|
1285
1530
|
#
|
1286
1531
|
# @param account_id The external account number (int) or account ID Guid.
|
1287
|
-
# @
|
1288
|
-
|
1289
|
-
|
1290
|
-
def get_permission_profile(account_id, permission_profile_id, options = DocuSign_eSign::GetPermissionProfileOptions.default)
|
1291
|
-
data, _status_code, _headers = get_permission_profile_with_http_info(account_id, permission_profile_id, options)
|
1532
|
+
# @return [AccountPasswordRules]
|
1533
|
+
def get_password_rules(account_id)
|
1534
|
+
data, _status_code, _headers = get_password_rules_with_http_info(account_id)
|
1292
1535
|
return data
|
1293
1536
|
end
|
1294
1537
|
|
1295
|
-
#
|
1538
|
+
# Get the password rules
|
1296
1539
|
#
|
1297
1540
|
# @param account_id The external account number (int) or account ID Guid.
|
1298
|
-
# @
|
1299
|
-
|
1300
|
-
# @return [Array<(PermissionProfile, Fixnum, Hash)>] PermissionProfile data, response status code and response headers
|
1301
|
-
def get_permission_profile_with_http_info(account_id, permission_profile_id, options = DocuSign_eSign::GetPermissionProfileOptions.default)
|
1541
|
+
# @return [Array<(AccountPasswordRules, Fixnum, Hash)>] AccountPasswordRules data, response status code and response headers
|
1542
|
+
def get_password_rules_with_http_info(account_id)
|
1302
1543
|
if @api_client.config.debugging
|
1303
|
-
@api_client.config.logger.debug "Calling API: AccountsApi.
|
1544
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_password_rules ..."
|
1304
1545
|
end
|
1305
1546
|
# verify the required parameter 'account_id' is set
|
1306
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.
|
1307
|
-
# verify the required parameter 'permission_profile_id' is set
|
1308
|
-
fail ArgumentError, "Missing the required parameter 'permission_profile_id' when calling AccountsApi.get_permission_profile" if permission_profile_id.nil?
|
1547
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_password_rules" if account_id.nil?
|
1309
1548
|
# resource path
|
1310
|
-
local_var_path = "/v2/accounts/{accountId}/
|
1549
|
+
local_var_path = "/v2/accounts/{accountId}/settings/password_rules".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1311
1550
|
|
1312
1551
|
# query parameters
|
1313
1552
|
query_params = {}
|
1314
|
-
query_params[:'include'] = options.include if !options.include.nil?
|
1315
1553
|
|
1316
1554
|
# header parameters
|
1317
1555
|
header_params = {}
|
@@ -1330,30 +1568,30 @@ module DocuSign_eSign
|
|
1330
1568
|
:form_params => form_params,
|
1331
1569
|
:body => post_body,
|
1332
1570
|
:auth_names => auth_names,
|
1333
|
-
:return_type => '
|
1571
|
+
:return_type => 'AccountPasswordRules')
|
1334
1572
|
if @api_client.config.debugging
|
1335
|
-
@api_client.config.logger.debug "API called: AccountsApi#
|
1573
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_password_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1336
1574
|
end
|
1337
1575
|
return data, status_code, headers
|
1338
1576
|
end
|
1339
1577
|
|
1340
|
-
#
|
1341
|
-
#
|
1342
|
-
# @return [
|
1343
|
-
def
|
1344
|
-
data, _status_code, _headers =
|
1578
|
+
# Get membership account password rules
|
1579
|
+
#
|
1580
|
+
# @return [UserPasswordRules]
|
1581
|
+
def get_password_rules_0()
|
1582
|
+
data, _status_code, _headers = get_password_rules_0_with_http_info()
|
1345
1583
|
return data
|
1346
1584
|
end
|
1347
1585
|
|
1348
|
-
#
|
1349
|
-
#
|
1350
|
-
# @return [Array<(
|
1351
|
-
def
|
1586
|
+
# Get membership account password rules
|
1587
|
+
#
|
1588
|
+
# @return [Array<(UserPasswordRules, Fixnum, Hash)>] UserPasswordRules data, response status code and response headers
|
1589
|
+
def get_password_rules_0_with_http_info()
|
1352
1590
|
if @api_client.config.debugging
|
1353
|
-
@api_client.config.logger.debug "Calling API: AccountsApi.
|
1591
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_password_rules_0 ..."
|
1354
1592
|
end
|
1355
1593
|
# resource path
|
1356
|
-
local_var_path = "/v2/
|
1594
|
+
local_var_path = "/v2/current_user/password_rules".sub('{format}','json')
|
1357
1595
|
|
1358
1596
|
# query parameters
|
1359
1597
|
query_params = {}
|
@@ -1375,36 +1613,286 @@ module DocuSign_eSign
|
|
1375
1613
|
:form_params => form_params,
|
1376
1614
|
:body => post_body,
|
1377
1615
|
:auth_names => auth_names,
|
1378
|
-
:return_type => '
|
1616
|
+
:return_type => 'UserPasswordRules')
|
1379
1617
|
if @api_client.config.debugging
|
1380
|
-
@api_client.config.logger.debug "API called: AccountsApi#
|
1618
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_password_rules_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1381
1619
|
end
|
1382
1620
|
return data, status_code, headers
|
1383
1621
|
end
|
1384
1622
|
|
1385
|
-
#
|
1386
|
-
#
|
1623
|
+
# Returns a permissions profile in the specified account.
|
1624
|
+
#
|
1387
1625
|
# @param account_id The external account number (int) or account ID Guid.
|
1388
|
-
# @param
|
1389
|
-
# @
|
1390
|
-
|
1391
|
-
|
1626
|
+
# @param permission_profile_id
|
1627
|
+
# @param DocuSign_eSign::GetPermissionProfileOptions Options for modifying the behavior of the function.
|
1628
|
+
# @return [PermissionProfile]
|
1629
|
+
def get_permission_profile(account_id, permission_profile_id, options = DocuSign_eSign::GetPermissionProfileOptions.default)
|
1630
|
+
data, _status_code, _headers = get_permission_profile_with_http_info(account_id, permission_profile_id, options)
|
1392
1631
|
return data
|
1393
1632
|
end
|
1394
1633
|
|
1395
|
-
#
|
1396
|
-
#
|
1634
|
+
# Returns a permissions profile in the specified account.
|
1635
|
+
#
|
1397
1636
|
# @param account_id The external account number (int) or account ID Guid.
|
1398
|
-
# @param
|
1399
|
-
# @
|
1400
|
-
|
1637
|
+
# @param permission_profile_id
|
1638
|
+
# @param DocuSign_eSign::GetPermissionProfileOptions Options for modifying the behavior of the function.
|
1639
|
+
# @return [Array<(PermissionProfile, Fixnum, Hash)>] PermissionProfile data, response status code and response headers
|
1640
|
+
def get_permission_profile_with_http_info(account_id, permission_profile_id, options = DocuSign_eSign::GetPermissionProfileOptions.default)
|
1401
1641
|
if @api_client.config.debugging
|
1402
|
-
@api_client.config.logger.debug "Calling API: AccountsApi.
|
1642
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_permission_profile ..."
|
1403
1643
|
end
|
1404
1644
|
# verify the required parameter 'account_id' is set
|
1405
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.
|
1645
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_permission_profile" if account_id.nil?
|
1646
|
+
# verify the required parameter 'permission_profile_id' is set
|
1647
|
+
fail ArgumentError, "Missing the required parameter 'permission_profile_id' when calling AccountsApi.get_permission_profile" if permission_profile_id.nil?
|
1406
1648
|
# resource path
|
1407
|
-
local_var_path = "/v2/accounts/{accountId}/
|
1649
|
+
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)
|
1650
|
+
|
1651
|
+
# query parameters
|
1652
|
+
query_params = {}
|
1653
|
+
query_params[:'include'] = options.include if !options.include.nil?
|
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 => 'PermissionProfile')
|
1673
|
+
if @api_client.config.debugging
|
1674
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_permission_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1675
|
+
end
|
1676
|
+
return data, status_code, headers
|
1677
|
+
end
|
1678
|
+
|
1679
|
+
# Retrieves the account provisioning information for the account.
|
1680
|
+
# Retrieves the account provisioning information for the account.
|
1681
|
+
# @return [ProvisioningInformation]
|
1682
|
+
def get_provisioning()
|
1683
|
+
data, _status_code, _headers = get_provisioning_with_http_info()
|
1684
|
+
return data
|
1685
|
+
end
|
1686
|
+
|
1687
|
+
# Retrieves the account provisioning information for the account.
|
1688
|
+
# Retrieves the account provisioning information for the account.
|
1689
|
+
# @return [Array<(ProvisioningInformation, Fixnum, Hash)>] ProvisioningInformation data, response status code and response headers
|
1690
|
+
def get_provisioning_with_http_info()
|
1691
|
+
if @api_client.config.debugging
|
1692
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_provisioning ..."
|
1693
|
+
end
|
1694
|
+
# resource path
|
1695
|
+
local_var_path = "/v2/accounts/provisioning".sub('{format}','json')
|
1696
|
+
|
1697
|
+
# query parameters
|
1698
|
+
query_params = {}
|
1699
|
+
|
1700
|
+
# header parameters
|
1701
|
+
header_params = {}
|
1702
|
+
# HTTP header 'Accept' (if needed)
|
1703
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1704
|
+
|
1705
|
+
# form parameters
|
1706
|
+
form_params = {}
|
1707
|
+
|
1708
|
+
# http body (model)
|
1709
|
+
post_body = nil
|
1710
|
+
auth_names = []
|
1711
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1712
|
+
:header_params => header_params,
|
1713
|
+
:query_params => query_params,
|
1714
|
+
:form_params => form_params,
|
1715
|
+
:body => post_body,
|
1716
|
+
:auth_names => auth_names,
|
1717
|
+
:return_type => 'ProvisioningInformation')
|
1718
|
+
if @api_client.config.debugging
|
1719
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_provisioning\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1720
|
+
end
|
1721
|
+
return data, status_code, headers
|
1722
|
+
end
|
1723
|
+
|
1724
|
+
# Gets list of supported languages for recipient language setting.
|
1725
|
+
#
|
1726
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1727
|
+
# @return [SupportedLanguages]
|
1728
|
+
def get_supported_languages(account_id)
|
1729
|
+
data, _status_code, _headers = get_supported_languages_with_http_info(account_id)
|
1730
|
+
return data
|
1731
|
+
end
|
1732
|
+
|
1733
|
+
# Gets list of supported languages for recipient language setting.
|
1734
|
+
#
|
1735
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1736
|
+
# @return [Array<(SupportedLanguages, Fixnum, Hash)>] SupportedLanguages data, response status code and response headers
|
1737
|
+
def get_supported_languages_with_http_info(account_id)
|
1738
|
+
if @api_client.config.debugging
|
1739
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_supported_languages ..."
|
1740
|
+
end
|
1741
|
+
# verify the required parameter 'account_id' is set
|
1742
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_supported_languages" if account_id.nil?
|
1743
|
+
# resource path
|
1744
|
+
local_var_path = "/v2/accounts/{accountId}/supported_languages".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1745
|
+
|
1746
|
+
# query parameters
|
1747
|
+
query_params = {}
|
1748
|
+
|
1749
|
+
# header parameters
|
1750
|
+
header_params = {}
|
1751
|
+
# HTTP header 'Accept' (if needed)
|
1752
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1753
|
+
|
1754
|
+
# form parameters
|
1755
|
+
form_params = {}
|
1756
|
+
|
1757
|
+
# http body (model)
|
1758
|
+
post_body = nil
|
1759
|
+
auth_names = []
|
1760
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1761
|
+
:header_params => header_params,
|
1762
|
+
:query_params => query_params,
|
1763
|
+
:form_params => form_params,
|
1764
|
+
:body => post_body,
|
1765
|
+
:auth_names => auth_names,
|
1766
|
+
:return_type => 'SupportedLanguages')
|
1767
|
+
if @api_client.config.debugging
|
1768
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_supported_languages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1769
|
+
end
|
1770
|
+
return data, status_code, headers
|
1771
|
+
end
|
1772
|
+
|
1773
|
+
# Get watermark information.
|
1774
|
+
#
|
1775
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1776
|
+
# @return [Watermark]
|
1777
|
+
def get_watermark(account_id)
|
1778
|
+
data, _status_code, _headers = get_watermark_with_http_info(account_id)
|
1779
|
+
return data
|
1780
|
+
end
|
1781
|
+
|
1782
|
+
# Get watermark information.
|
1783
|
+
#
|
1784
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1785
|
+
# @return [Array<(Watermark, Fixnum, Hash)>] Watermark data, response status code and response headers
|
1786
|
+
def get_watermark_with_http_info(account_id)
|
1787
|
+
if @api_client.config.debugging
|
1788
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_watermark ..."
|
1789
|
+
end
|
1790
|
+
# verify the required parameter 'account_id' is set
|
1791
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_watermark" if account_id.nil?
|
1792
|
+
# resource path
|
1793
|
+
local_var_path = "/v2/accounts/{accountId}/watermark".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1794
|
+
|
1795
|
+
# query parameters
|
1796
|
+
query_params = {}
|
1797
|
+
|
1798
|
+
# header parameters
|
1799
|
+
header_params = {}
|
1800
|
+
# HTTP header 'Accept' (if needed)
|
1801
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1802
|
+
|
1803
|
+
# form parameters
|
1804
|
+
form_params = {}
|
1805
|
+
|
1806
|
+
# http body (model)
|
1807
|
+
post_body = nil
|
1808
|
+
auth_names = []
|
1809
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1810
|
+
:header_params => header_params,
|
1811
|
+
:query_params => query_params,
|
1812
|
+
:form_params => form_params,
|
1813
|
+
:body => post_body,
|
1814
|
+
:auth_names => auth_names,
|
1815
|
+
:return_type => 'Watermark')
|
1816
|
+
if @api_client.config.debugging
|
1817
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_watermark\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1818
|
+
end
|
1819
|
+
return data, status_code, headers
|
1820
|
+
end
|
1821
|
+
|
1822
|
+
# Get watermark preview.
|
1823
|
+
#
|
1824
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1825
|
+
# @param watermark (optional parameter)
|
1826
|
+
# @return [Watermark]
|
1827
|
+
def get_watermark_preview(account_id, watermark)
|
1828
|
+
data, _status_code, _headers = get_watermark_preview_with_http_info(account_id, watermark)
|
1829
|
+
return data
|
1830
|
+
end
|
1831
|
+
|
1832
|
+
# Get watermark preview.
|
1833
|
+
#
|
1834
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1835
|
+
# @param watermark (optional parameter)
|
1836
|
+
# @return [Array<(Watermark, Fixnum, Hash)>] Watermark data, response status code and response headers
|
1837
|
+
def get_watermark_preview_with_http_info(account_id, watermark)
|
1838
|
+
if @api_client.config.debugging
|
1839
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_watermark_preview ..."
|
1840
|
+
end
|
1841
|
+
# verify the required parameter 'account_id' is set
|
1842
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_watermark_preview" if account_id.nil?
|
1843
|
+
# resource path
|
1844
|
+
local_var_path = "/v2/accounts/{accountId}/watermark/preview".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1845
|
+
|
1846
|
+
# query parameters
|
1847
|
+
query_params = {}
|
1848
|
+
|
1849
|
+
# header parameters
|
1850
|
+
header_params = {}
|
1851
|
+
# HTTP header 'Accept' (if needed)
|
1852
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1853
|
+
|
1854
|
+
# form parameters
|
1855
|
+
form_params = {}
|
1856
|
+
|
1857
|
+
# http body (model)
|
1858
|
+
post_body = @api_client.object_to_http_body(watermark)
|
1859
|
+
auth_names = []
|
1860
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1861
|
+
:header_params => header_params,
|
1862
|
+
:query_params => query_params,
|
1863
|
+
:form_params => form_params,
|
1864
|
+
:body => post_body,
|
1865
|
+
:auth_names => auth_names,
|
1866
|
+
:return_type => 'Watermark')
|
1867
|
+
if @api_client.config.debugging
|
1868
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_watermark_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1869
|
+
end
|
1870
|
+
return data, status_code, headers
|
1871
|
+
end
|
1872
|
+
|
1873
|
+
# Gets a list of brand profiles.
|
1874
|
+
# Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** for the account to use this call.
|
1875
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1876
|
+
# @param DocuSign_eSign::ListBrandsOptions Options for modifying the behavior of the function.
|
1877
|
+
# @return [BrandsResponse]
|
1878
|
+
def list_brands(account_id, options = DocuSign_eSign::ListBrandsOptions.default)
|
1879
|
+
data, _status_code, _headers = list_brands_with_http_info(account_id, options)
|
1880
|
+
return data
|
1881
|
+
end
|
1882
|
+
|
1883
|
+
# Gets a list of brand profiles.
|
1884
|
+
# Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties `canSelfBrandSend` and `canSelfBrandSend`) must be set to **true** for the account to use this call.
|
1885
|
+
# @param account_id The external account number (int) or account ID Guid.
|
1886
|
+
# @param DocuSign_eSign::ListBrandsOptions Options for modifying the behavior of the function.
|
1887
|
+
# @return [Array<(BrandsResponse, Fixnum, Hash)>] BrandsResponse data, response status code and response headers
|
1888
|
+
def list_brands_with_http_info(account_id, options = DocuSign_eSign::ListBrandsOptions.default)
|
1889
|
+
if @api_client.config.debugging
|
1890
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.list_brands ..."
|
1891
|
+
end
|
1892
|
+
# verify the required parameter 'account_id' is set
|
1893
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.list_brands" if account_id.nil?
|
1894
|
+
# resource path
|
1895
|
+
local_var_path = "/v2/accounts/{accountId}/brands".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
1408
1896
|
|
1409
1897
|
# query parameters
|
1410
1898
|
query_params = {}
|
@@ -1905,9 +2393,10 @@ module DocuSign_eSign
|
|
1905
2393
|
# @param account_id The external account number (int) or account ID Guid.
|
1906
2394
|
# @param brand_id The unique identifier of a brand.
|
1907
2395
|
# @param logo_type One of **Primary**, **Secondary** or **Email**.
|
2396
|
+
# @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
|
1908
2397
|
# @return [nil]
|
1909
|
-
def update_brand_logo_by_type(account_id, brand_id, logo_type)
|
1910
|
-
update_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type)
|
2398
|
+
def update_brand_logo_by_type(account_id, brand_id, logo_type, logo_file_bytes)
|
2399
|
+
update_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type, logo_file_bytes)
|
1911
2400
|
return nil
|
1912
2401
|
end
|
1913
2402
|
|
@@ -1916,8 +2405,9 @@ module DocuSign_eSign
|
|
1916
2405
|
# @param account_id The external account number (int) or account ID Guid.
|
1917
2406
|
# @param brand_id The unique identifier of a brand.
|
1918
2407
|
# @param logo_type One of **Primary**, **Secondary** or **Email**.
|
2408
|
+
# @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
|
1919
2409
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1920
|
-
def update_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type)
|
2410
|
+
def update_brand_logo_by_type_with_http_info(account_id, brand_id, logo_type, logo_file_bytes)
|
1921
2411
|
if @api_client.config.debugging
|
1922
2412
|
@api_client.config.logger.debug "Calling API: AccountsApi.update_brand_logo_by_type ..."
|
1923
2413
|
end
|
@@ -1927,6 +2417,8 @@ module DocuSign_eSign
|
|
1927
2417
|
fail ArgumentError, "Missing the required parameter 'brand_id' when calling AccountsApi.update_brand_logo_by_type" if brand_id.nil?
|
1928
2418
|
# verify the required parameter 'logo_type' is set
|
1929
2419
|
fail ArgumentError, "Missing the required parameter 'logo_type' when calling AccountsApi.update_brand_logo_by_type" if logo_type.nil?
|
2420
|
+
# verify the required parameter 'logo_file_bytes' is set
|
2421
|
+
fail ArgumentError, "Missing the required parameter 'logo_file_bytes' when calling AccountsApi.update_brand_logo_by_type" if logo_file_bytes.nil?
|
1930
2422
|
# resource path
|
1931
2423
|
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)
|
1932
2424
|
|
@@ -1937,12 +2429,14 @@ module DocuSign_eSign
|
|
1937
2429
|
header_params = {}
|
1938
2430
|
# HTTP header 'Accept' (if needed)
|
1939
2431
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2432
|
+
# HTTP header 'Content-Type'
|
2433
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['image/png'])
|
1940
2434
|
|
1941
2435
|
# form parameters
|
1942
2436
|
form_params = {}
|
1943
2437
|
|
1944
2438
|
# http body (model)
|
1945
|
-
post_body =
|
2439
|
+
post_body = @api_client.object_to_http_body(logo_file_bytes)
|
1946
2440
|
auth_names = []
|
1947
2441
|
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1948
2442
|
:header_params => header_params,
|
@@ -2013,6 +2507,122 @@ module DocuSign_eSign
|
|
2013
2507
|
return data, status_code, headers
|
2014
2508
|
end
|
2015
2509
|
|
2510
|
+
# Update Consumer Disclosure.
|
2511
|
+
#
|
2512
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2513
|
+
# @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.
|
2514
|
+
# @param consumer_disclosure (optional parameter)
|
2515
|
+
# @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
|
2516
|
+
# @return [ConsumerDisclosure]
|
2517
|
+
def update_consumer_disclosure(account_id, lang_code, consumer_disclosure, options = DocuSign_eSign::UpdateConsumerDisclosureOptions.default)
|
2518
|
+
data, _status_code, _headers = update_consumer_disclosure_with_http_info(account_id, lang_code, consumer_disclosure, options)
|
2519
|
+
return data
|
2520
|
+
end
|
2521
|
+
|
2522
|
+
# Update Consumer Disclosure.
|
2523
|
+
#
|
2524
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2525
|
+
# @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.
|
2526
|
+
# @param consumer_disclosure (optional parameter)
|
2527
|
+
# @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
|
2528
|
+
# @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
|
2529
|
+
def update_consumer_disclosure_with_http_info(account_id, lang_code, consumer_disclosure, options = DocuSign_eSign::UpdateConsumerDisclosureOptions.default)
|
2530
|
+
if @api_client.config.debugging
|
2531
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.update_consumer_disclosure ..."
|
2532
|
+
end
|
2533
|
+
# verify the required parameter 'account_id' is set
|
2534
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_consumer_disclosure" if account_id.nil?
|
2535
|
+
# verify the required parameter 'lang_code' is set
|
2536
|
+
fail ArgumentError, "Missing the required parameter 'lang_code' when calling AccountsApi.update_consumer_disclosure" if lang_code.nil?
|
2537
|
+
# resource path
|
2538
|
+
local_var_path = "/v2/accounts/{accountId}/consumer_disclosure/{langCode}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'langCode' + '}', lang_code.to_s)
|
2539
|
+
|
2540
|
+
# query parameters
|
2541
|
+
query_params = {}
|
2542
|
+
query_params[:'include_metadata'] = options.include_metadata if !options.include_metadata.nil?
|
2543
|
+
|
2544
|
+
# header parameters
|
2545
|
+
header_params = {}
|
2546
|
+
# HTTP header 'Accept' (if needed)
|
2547
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2548
|
+
|
2549
|
+
# form parameters
|
2550
|
+
form_params = {}
|
2551
|
+
|
2552
|
+
# http body (model)
|
2553
|
+
post_body = @api_client.object_to_http_body(consumer_disclosure)
|
2554
|
+
auth_names = []
|
2555
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2556
|
+
:header_params => header_params,
|
2557
|
+
:query_params => query_params,
|
2558
|
+
:form_params => form_params,
|
2559
|
+
:body => post_body,
|
2560
|
+
:auth_names => auth_names,
|
2561
|
+
:return_type => 'ConsumerDisclosure')
|
2562
|
+
if @api_client.config.debugging
|
2563
|
+
@api_client.config.logger.debug "API called: AccountsApi#update_consumer_disclosure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2564
|
+
end
|
2565
|
+
return data, status_code, headers
|
2566
|
+
end
|
2567
|
+
|
2568
|
+
# Updates an existing account custom field.
|
2569
|
+
#
|
2570
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2571
|
+
# @param custom_field_id
|
2572
|
+
# @param custom_field (optional parameter)
|
2573
|
+
# @param DocuSign_eSign::UpdateCustomFieldOptions Options for modifying the behavior of the function.
|
2574
|
+
# @return [CustomFields]
|
2575
|
+
def update_custom_field(account_id, custom_field_id, custom_field, options = DocuSign_eSign::UpdateCustomFieldOptions.default)
|
2576
|
+
data, _status_code, _headers = update_custom_field_with_http_info(account_id, custom_field_id, custom_field, options)
|
2577
|
+
return data
|
2578
|
+
end
|
2579
|
+
|
2580
|
+
# Updates an existing account custom field.
|
2581
|
+
#
|
2582
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2583
|
+
# @param custom_field_id
|
2584
|
+
# @param custom_field (optional parameter)
|
2585
|
+
# @param DocuSign_eSign::UpdateCustomFieldOptions Options for modifying the behavior of the function.
|
2586
|
+
# @return [Array<(CustomFields, Fixnum, Hash)>] CustomFields data, response status code and response headers
|
2587
|
+
def update_custom_field_with_http_info(account_id, custom_field_id, custom_field, options = DocuSign_eSign::UpdateCustomFieldOptions.default)
|
2588
|
+
if @api_client.config.debugging
|
2589
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.update_custom_field ..."
|
2590
|
+
end
|
2591
|
+
# verify the required parameter 'account_id' is set
|
2592
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_custom_field" if account_id.nil?
|
2593
|
+
# verify the required parameter 'custom_field_id' is set
|
2594
|
+
fail ArgumentError, "Missing the required parameter 'custom_field_id' when calling AccountsApi.update_custom_field" if custom_field_id.nil?
|
2595
|
+
# resource path
|
2596
|
+
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)
|
2597
|
+
|
2598
|
+
# query parameters
|
2599
|
+
query_params = {}
|
2600
|
+
query_params[:'apply_to_templates'] = options.apply_to_templates if !options.apply_to_templates.nil?
|
2601
|
+
|
2602
|
+
# header parameters
|
2603
|
+
header_params = {}
|
2604
|
+
# HTTP header 'Accept' (if needed)
|
2605
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2606
|
+
|
2607
|
+
# form parameters
|
2608
|
+
form_params = {}
|
2609
|
+
|
2610
|
+
# http body (model)
|
2611
|
+
post_body = @api_client.object_to_http_body(custom_field)
|
2612
|
+
auth_names = []
|
2613
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2614
|
+
:header_params => header_params,
|
2615
|
+
:query_params => query_params,
|
2616
|
+
:form_params => form_params,
|
2617
|
+
:body => post_body,
|
2618
|
+
:auth_names => auth_names,
|
2619
|
+
:return_type => 'CustomFields')
|
2620
|
+
if @api_client.config.debugging
|
2621
|
+
@api_client.config.logger.debug "API called: AccountsApi#update_custom_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2622
|
+
end
|
2623
|
+
return data, status_code, headers
|
2624
|
+
end
|
2625
|
+
|
2016
2626
|
# Updates configuration information for the eNote eOriginal integration.
|
2017
2627
|
#
|
2018
2628
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -2064,6 +2674,57 @@ module DocuSign_eSign
|
|
2064
2674
|
return data, status_code, headers
|
2065
2675
|
end
|
2066
2676
|
|
2677
|
+
# Update the password rules
|
2678
|
+
#
|
2679
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2680
|
+
# @param account_password_rules (optional parameter)
|
2681
|
+
# @return [AccountPasswordRules]
|
2682
|
+
def update_password_rules(account_id, account_password_rules)
|
2683
|
+
data, _status_code, _headers = update_password_rules_with_http_info(account_id, account_password_rules)
|
2684
|
+
return data
|
2685
|
+
end
|
2686
|
+
|
2687
|
+
# Update the password rules
|
2688
|
+
#
|
2689
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2690
|
+
# @param account_password_rules (optional parameter)
|
2691
|
+
# @return [Array<(AccountPasswordRules, Fixnum, Hash)>] AccountPasswordRules data, response status code and response headers
|
2692
|
+
def update_password_rules_with_http_info(account_id, account_password_rules)
|
2693
|
+
if @api_client.config.debugging
|
2694
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.update_password_rules ..."
|
2695
|
+
end
|
2696
|
+
# verify the required parameter 'account_id' is set
|
2697
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_password_rules" if account_id.nil?
|
2698
|
+
# resource path
|
2699
|
+
local_var_path = "/v2/accounts/{accountId}/settings/password_rules".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2700
|
+
|
2701
|
+
# query parameters
|
2702
|
+
query_params = {}
|
2703
|
+
|
2704
|
+
# header parameters
|
2705
|
+
header_params = {}
|
2706
|
+
# HTTP header 'Accept' (if needed)
|
2707
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2708
|
+
|
2709
|
+
# form parameters
|
2710
|
+
form_params = {}
|
2711
|
+
|
2712
|
+
# http body (model)
|
2713
|
+
post_body = @api_client.object_to_http_body(account_password_rules)
|
2714
|
+
auth_names = []
|
2715
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2716
|
+
:header_params => header_params,
|
2717
|
+
:query_params => query_params,
|
2718
|
+
:form_params => form_params,
|
2719
|
+
:body => post_body,
|
2720
|
+
:auth_names => auth_names,
|
2721
|
+
:return_type => 'AccountPasswordRules')
|
2722
|
+
if @api_client.config.debugging
|
2723
|
+
@api_client.config.logger.debug "API called: AccountsApi#update_password_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2724
|
+
end
|
2725
|
+
return data, status_code, headers
|
2726
|
+
end
|
2727
|
+
|
2067
2728
|
# Updates a permission profile within the specified account.
|
2068
2729
|
#
|
2069
2730
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -2226,5 +2887,56 @@ module DocuSign_eSign
|
|
2226
2887
|
end
|
2227
2888
|
return data, status_code, headers
|
2228
2889
|
end
|
2890
|
+
|
2891
|
+
# Update watermark information.
|
2892
|
+
#
|
2893
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2894
|
+
# @param watermark (optional parameter)
|
2895
|
+
# @return [Watermark]
|
2896
|
+
def update_watermark(account_id, watermark)
|
2897
|
+
data, _status_code, _headers = update_watermark_with_http_info(account_id, watermark)
|
2898
|
+
return data
|
2899
|
+
end
|
2900
|
+
|
2901
|
+
# Update watermark information.
|
2902
|
+
#
|
2903
|
+
# @param account_id The external account number (int) or account ID Guid.
|
2904
|
+
# @param watermark (optional parameter)
|
2905
|
+
# @return [Array<(Watermark, Fixnum, Hash)>] Watermark data, response status code and response headers
|
2906
|
+
def update_watermark_with_http_info(account_id, watermark)
|
2907
|
+
if @api_client.config.debugging
|
2908
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.update_watermark ..."
|
2909
|
+
end
|
2910
|
+
# verify the required parameter 'account_id' is set
|
2911
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_watermark" if account_id.nil?
|
2912
|
+
# resource path
|
2913
|
+
local_var_path = "/v2/accounts/{accountId}/watermark".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2914
|
+
|
2915
|
+
# query parameters
|
2916
|
+
query_params = {}
|
2917
|
+
|
2918
|
+
# header parameters
|
2919
|
+
header_params = {}
|
2920
|
+
# HTTP header 'Accept' (if needed)
|
2921
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2922
|
+
|
2923
|
+
# form parameters
|
2924
|
+
form_params = {}
|
2925
|
+
|
2926
|
+
# http body (model)
|
2927
|
+
post_body = @api_client.object_to_http_body(watermark)
|
2928
|
+
auth_names = []
|
2929
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
2930
|
+
:header_params => header_params,
|
2931
|
+
:query_params => query_params,
|
2932
|
+
:form_params => form_params,
|
2933
|
+
:body => post_body,
|
2934
|
+
:auth_names => auth_names,
|
2935
|
+
:return_type => 'Watermark')
|
2936
|
+
if @api_client.config.debugging
|
2937
|
+
@api_client.config.logger.debug "API called: AccountsApi#update_watermark\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2938
|
+
end
|
2939
|
+
return data, status_code, headers
|
2940
|
+
end
|
2229
2941
|
end
|
2230
2942
|
end
|