docusign_esign 3.12.0 → 3.19.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +54 -0
- data/docusign_esign.gemspec +5 -5
- data/lib/docusign_esign/api/accounts_api.rb +83 -433
- data/lib/docusign_esign/api/billing_api.rb +12 -4
- data/lib/docusign_esign/api/bulk_envelopes_api.rb +93 -26
- data/lib/docusign_esign/api/bulk_process_data_api.rb +412 -0
- data/lib/docusign_esign/api/bulk_process_data_send_api.rb +252 -0
- data/lib/docusign_esign/api/connect_api.rb +239 -5
- data/lib/docusign_esign/api/email_archive_api.rb +8 -8
- data/lib/docusign_esign/api/envelopes_api.rb +1435 -207
- data/lib/docusign_esign/api/notary_api.rb +16 -16
- data/lib/docusign_esign/api/organizations_api.rb +8 -60
- data/lib/docusign_esign/api/power_forms_api.rb +24 -16
- data/lib/docusign_esign/api/templates_api.rb +20 -79
- data/lib/docusign_esign/api/users_api.rb +22 -14
- data/lib/docusign_esign/api/workspaces_api.rb +4 -4
- data/lib/docusign_esign/client/api_client.rb +16 -10
- data/lib/docusign_esign/client/api_error.rb +1 -1
- data/lib/docusign_esign/client/auth/oauth.rb +1 -1
- data/lib/docusign_esign/models/access_code_format.rb +6 -0
- data/lib/docusign_esign/models/account_billing_plan.rb +25 -4
- data/lib/docusign_esign/models/account_billing_plan_response.rb +37 -10
- data/lib/docusign_esign/models/account_identity_verification_step.rb +1 -0
- data/lib/docusign_esign/models/account_identity_verification_workflow.rb +2 -0
- data/lib/docusign_esign/models/account_information.rb +11 -1
- data/lib/docusign_esign/models/account_notification.rb +3 -0
- data/lib/docusign_esign/models/account_password_questions_required.rb +1 -0
- data/lib/docusign_esign/models/account_password_rules.rb +7 -0
- data/lib/docusign_esign/models/account_role_settings.rb +81 -4
- data/lib/docusign_esign/models/account_settings_information.rb +1075 -13
- data/lib/docusign_esign/models/account_shared_access.rb +1 -0
- data/lib/docusign_esign/models/account_signature.rb +2 -0
- data/lib/docusign_esign/models/account_signature_definition.rb +1 -0
- data/lib/docusign_esign/models/account_signature_provider.rb +1 -0
- data/lib/docusign_esign/models/account_signature_provider_option.rb +1 -0
- data/lib/docusign_esign/models/account_ui_settings.rb +28 -13
- data/lib/docusign_esign/models/address_information_input.rb +1 -0
- data/lib/docusign_esign/models/agent.rb +45 -1
- data/lib/docusign_esign/models/app_store_receipt.rb +21 -1
- data/lib/docusign_esign/models/approve.rb +65 -1
- data/lib/docusign_esign/models/authentication_status.rb +19 -0
- data/lib/docusign_esign/models/bcc_email_archive.rb +3 -0
- data/lib/docusign_esign/models/bcc_email_archive_history.rb +2 -0
- data/lib/docusign_esign/models/bcc_email_archive_list.rb +1 -0
- data/lib/docusign_esign/models/billing_charge.rb +1 -1
- data/lib/docusign_esign/models/billing_entity_information_response.rb +214 -0
- data/lib/docusign_esign/models/billing_invoice_item.rb +21 -1
- data/lib/docusign_esign/models/billing_invoices_summary.rb +21 -1
- data/lib/docusign_esign/models/billing_plan_information.rb +52 -4
- data/lib/docusign_esign/models/billing_plan_preview.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_response.rb +1 -0
- data/lib/docusign_esign/models/billing_plan_update_response.rb +1 -0
- data/lib/docusign_esign/models/brand.rb +4 -0
- data/lib/docusign_esign/models/brand_email_content.rb +1 -0
- data/lib/docusign_esign/models/brand_link.rb +1 -0
- data/lib/docusign_esign/models/brand_logos.rb +1 -0
- data/lib/docusign_esign/models/brand_request.rb +1 -0
- data/lib/docusign_esign/models/brand_resource_urls.rb +1 -0
- data/lib/docusign_esign/models/brand_resources.rb +3 -0
- data/lib/docusign_esign/models/brands_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_envelope.rb +1 -0
- data/lib/docusign_esign/models/bulk_process_request.rb +194 -0
- data/lib/docusign_esign/models/bulk_process_response.rb +248 -0
- data/lib/docusign_esign/models/bulk_process_result.rb +206 -0
- data/lib/docusign_esign/models/bulk_processing_list_summaries.rb +186 -0
- data/lib/docusign_esign/models/bulk_processing_list_summary.rb +214 -0
- data/lib/docusign_esign/models/bulk_processing_lists.rb +186 -0
- data/lib/docusign_esign/models/bulk_recipients_update_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_batch_action_request.rb +204 -0
- data/lib/docusign_esign/models/bulk_send_batch_error.rb +194 -0
- data/lib/docusign_esign/models/bulk_send_batch_status.rb +42 -1
- data/lib/docusign_esign/models/bulk_send_batch_summaries.rb +22 -1
- data/lib/docusign_esign/models/bulk_send_batch_summary.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_envelopes_info.rb +304 -0
- data/lib/docusign_esign/models/bulk_send_error_status.rb +12 -1
- data/lib/docusign_esign/models/bulk_send_request.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_send_test_response.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy_custom_field.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_copy_recipient.rb +5 -0
- data/lib/docusign_esign/models/bulk_sending_copy_tab.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list_summaries.rb +1 -0
- data/lib/docusign_esign/models/bulk_sending_list_summary.rb +1 -0
- data/lib/docusign_esign/models/captive_recipient.rb +2 -0
- data/lib/docusign_esign/models/captive_recipient_information.rb +1 -0
- data/lib/docusign_esign/models/carbon_copy.rb +48 -1
- data/lib/docusign_esign/models/certified_delivery.rb +47 -1
- data/lib/docusign_esign/models/checkbox.rb +109 -1
- data/lib/docusign_esign/models/chunked_upload_part.rb +1 -0
- data/lib/docusign_esign/models/chunked_upload_request.rb +1 -0
- data/lib/docusign_esign/models/chunked_upload_response.rb +1 -0
- data/lib/docusign_esign/models/cloud_storage_provider.rb +2 -0
- data/lib/docusign_esign/models/comment_thread.rb +63 -1
- data/lib/docusign_esign/models/commission_county.rb +72 -1
- data/lib/docusign_esign/models/commission_expiration.rb +72 -1
- data/lib/docusign_esign/models/commission_number.rb +72 -1
- data/lib/docusign_esign/models/commission_state.rb +72 -1
- data/lib/docusign_esign/models/company.rb +72 -1
- data/lib/docusign_esign/models/composite_template.rb +2 -0
- data/lib/docusign_esign/models/conditional_recipient_rule.rb +2 -0
- data/lib/docusign_esign/models/connect_config_results.rb +1 -0
- data/lib/docusign_esign/models/connect_custom_configuration.rb +60 -4
- data/lib/docusign_esign/models/connect_debug_log.rb +1 -0
- data/lib/docusign_esign/models/connect_delete_failure_result.rb +174 -0
- data/lib/docusign_esign/models/connect_event_data.rb +1 -0
- data/lib/docusign_esign/models/connect_failure_filter.rb +1 -0
- data/lib/docusign_esign/models/connect_failure_result.rb +1 -0
- data/lib/docusign_esign/models/connect_historical_envelope_republish.rb +195 -0
- data/lib/docusign_esign/models/connect_log.rb +1 -0
- data/lib/docusign_esign/models/connect_o_auth_config.rb +214 -0
- data/lib/docusign_esign/models/connect_salesforce_field.rb +1 -0
- data/lib/docusign_esign/models/connect_salesforce_object.rb +1 -0
- data/lib/docusign_esign/models/connect_user_info.rb +214 -0
- data/lib/docusign_esign/models/consent_details.rb +204 -0
- data/lib/docusign_esign/models/console_view_request.rb +1 -0
- data/lib/docusign_esign/models/consumer_disclosure.rb +3 -0
- data/lib/docusign_esign/models/contact.rb +12 -1
- data/lib/docusign_esign/models/contact_get_response.rb +1 -0
- data/lib/docusign_esign/models/contact_mod_request.rb +1 -0
- data/lib/docusign_esign/models/contact_phone_number.rb +1 -0
- data/lib/docusign_esign/models/contact_update_response.rb +1 -0
- data/lib/docusign_esign/models/correct_view_request.rb +12 -1
- data/lib/docusign_esign/models/credit_card_information.rb +2 -0
- data/lib/docusign_esign/models/currency.rb +95 -1
- data/lib/docusign_esign/models/currency_feature_set_price.rb +1 -0
- data/lib/docusign_esign/models/currency_plan_price.rb +1 -0
- data/lib/docusign_esign/models/custom_field.rb +2 -0
- data/lib/docusign_esign/models/date.rb +98 -1
- data/lib/docusign_esign/models/date_signed.rb +66 -1
- data/lib/docusign_esign/models/date_stamp_properties.rb +1 -0
- data/lib/docusign_esign/models/decline.rb +66 -1
- data/lib/docusign_esign/models/delayed_routing.rb +206 -0
- data/lib/docusign_esign/models/delayed_routing_api_model.rb +206 -0
- data/lib/docusign_esign/models/delegation_info.rb +214 -0
- data/lib/docusign_esign/models/direct_debit_processor_information.rb +1 -0
- data/lib/docusign_esign/models/document.rb +3 -0
- data/lib/docusign_esign/models/document_html_collapsible_display_settings.rb +1 -0
- data/lib/docusign_esign/models/document_html_definition.rb +1 -0
- data/lib/docusign_esign/models/document_html_definition_original.rb +1 -0
- data/lib/docusign_esign/models/document_html_display_anchor.rb +1 -0
- data/lib/docusign_esign/models/document_html_display_settings.rb +1 -0
- data/lib/docusign_esign/models/document_template.rb +1 -0
- data/lib/docusign_esign/models/document_visibility.rb +2 -0
- data/lib/docusign_esign/models/document_visibility_list.rb +1 -0
- data/lib/docusign_esign/models/downgrad_request_billing_info_response.rb +1 -0
- data/lib/docusign_esign/models/downgrade_billing_plan_information.rb +1 -0
- data/lib/docusign_esign/models/downgrade_plan_update_response.rb +11 -1
- data/lib/docusign_esign/models/downgrade_request_information.rb +204 -0
- data/lib/docusign_esign/models/draw.rb +60 -1
- data/lib/docusign_esign/models/e_note_configuration.rb +1 -0
- data/lib/docusign_esign/models/editor.rb +46 -1
- data/lib/docusign_esign/models/email.rb +98 -1
- data/lib/docusign_esign/models/email_address.rb +66 -1
- data/lib/docusign_esign/models/envelope.rb +20 -1
- data/lib/docusign_esign/models/envelope_attachment.rb +1 -0
- data/lib/docusign_esign/models/envelope_custom_metadata.rb +186 -0
- data/lib/docusign_esign/models/envelope_definition.rb +23 -1
- data/lib/docusign_esign/models/envelope_delay_rule.rb +194 -0
- data/lib/docusign_esign/models/envelope_delay_rule_api_model.rb +195 -0
- data/lib/docusign_esign/models/envelope_document.rb +7 -0
- data/lib/docusign_esign/models/envelope_event.rb +1 -0
- data/lib/docusign_esign/models/envelope_form_data.rb +2 -0
- data/lib/docusign_esign/models/envelope_id.rb +65 -1
- data/lib/docusign_esign/models/envelope_ids_request.rb +1 -0
- data/lib/docusign_esign/models/envelope_notification_request.rb +3 -0
- data/lib/docusign_esign/models/envelope_publish_transaction.rb +307 -0
- data/lib/docusign_esign/models/envelope_publish_transaction_error_rollup.rb +194 -0
- data/lib/docusign_esign/models/envelope_purge_configuration.rb +1 -0
- data/lib/docusign_esign/models/envelope_summary.rb +3 -0
- data/lib/docusign_esign/models/envelope_template.rb +22 -1
- data/lib/docusign_esign/models/envelope_template_results.rb +1 -0
- data/lib/docusign_esign/models/envelope_transaction_status.rb +1 -0
- data/lib/docusign_esign/models/envelope_transfer_rule.rb +6 -0
- data/lib/docusign_esign/models/envelope_transfer_rule_request.rb +4 -0
- data/lib/docusign_esign/models/envelope_update_summary.rb +4 -0
- data/lib/docusign_esign/models/envelopes_information.rb +1 -0
- data/lib/docusign_esign/models/event_notification.rb +24 -1
- data/lib/docusign_esign/models/event_result.rb +1 -0
- data/lib/docusign_esign/models/external_document_sources.rb +6 -0
- data/lib/docusign_esign/models/external_file.rb +1 -0
- data/lib/docusign_esign/models/external_folder.rb +1 -0
- data/lib/docusign_esign/models/external_primary_account_recipient_auth_requirements.rb +214 -0
- data/lib/docusign_esign/models/favorite_templates_content_item.rb +1 -0
- data/lib/docusign_esign/models/favorite_templates_info.rb +1 -0
- data/lib/docusign_esign/models/feature_set.rb +1 -0
- data/lib/docusign_esign/models/filter.rb +1 -0
- data/lib/docusign_esign/models/first_name.rb +66 -1
- data/lib/docusign_esign/models/folder.rb +4 -0
- data/lib/docusign_esign/models/folder_item_response.rb +1 -0
- data/lib/docusign_esign/models/folder_item_v2.rb +13 -1
- data/lib/docusign_esign/models/folder_shared_item.rb +3 -0
- data/lib/docusign_esign/models/folders_request.rb +1 -0
- data/lib/docusign_esign/models/form_data_item.rb +1 -0
- data/lib/docusign_esign/models/formula_tab.rb +103 -1
- data/lib/docusign_esign/models/full_name.rb +66 -1
- data/lib/docusign_esign/models/group.rb +13 -1
- data/lib/docusign_esign/models/id_check_configuration.rb +1 -0
- data/lib/docusign_esign/models/id_check_information_input.rb +4 -0
- data/lib/docusign_esign/models/id_evidence_resource_token.rb +194 -0
- data/lib/docusign_esign/models/id_evidence_view_link.rb +184 -0
- data/lib/docusign_esign/models/in_person_signer.rb +31 -0
- data/lib/docusign_esign/models/initial_here.rb +60 -1
- data/lib/docusign_esign/models/inline_template.rb +3 -0
- data/lib/docusign_esign/models/integrated_connect_user_info_list.rb +246 -0
- data/lib/docusign_esign/models/intermediary.rb +46 -1
- data/lib/docusign_esign/models/jurisdiction.rb +1 -0
- data/lib/docusign_esign/models/last_name.rb +66 -1
- data/lib/docusign_esign/models/linked_external_primary_account.rb +21 -1
- data/lib/docusign_esign/models/list.rb +112 -1
- data/lib/docusign_esign/models/list_custom_field.rb +2 -0
- data/lib/docusign_esign/models/list_item.rb +4 -0
- data/lib/docusign_esign/models/locale_policy.rb +13 -0
- data/lib/docusign_esign/models/lock_information.rb +2 -0
- data/lib/docusign_esign/models/lock_request.rb +1 -0
- data/lib/docusign_esign/models/member_group_shared_item.rb +3 -0
- data/lib/docusign_esign/models/member_shared_items.rb +3 -0
- data/lib/docusign_esign/models/merge_field.rb +6 -0
- data/lib/docusign_esign/models/mobile_notifier_configuration.rb +1 -0
- data/lib/docusign_esign/models/money.rb +1 -0
- data/lib/docusign_esign/models/name_value.rb +2 -0
- data/lib/docusign_esign/models/new_account_definition.rb +53 -4
- data/lib/docusign_esign/models/new_account_summary.rb +1 -0
- data/lib/docusign_esign/models/new_user.rb +2 -0
- data/lib/docusign_esign/models/new_users_summary.rb +1 -0
- data/lib/docusign_esign/models/notarize.rb +58 -1
- data/lib/docusign_esign/models/notary.rb +1 -0
- data/lib/docusign_esign/models/notary_host.rb +20 -0
- data/lib/docusign_esign/models/notary_journal.rb +2 -0
- data/lib/docusign_esign/models/notary_jurisdiction.rb +3 -0
- data/lib/docusign_esign/models/notary_jurisdiction_list.rb +1 -0
- data/lib/docusign_esign/models/notary_recipient.rb +93 -1
- data/lib/docusign_esign/models/notary_result.rb +2 -0
- data/lib/docusign_esign/models/notary_seal.rb +59 -1
- data/lib/docusign_esign/models/note.rb +67 -1
- data/lib/docusign_esign/models/notification.rb +2 -0
- data/lib/docusign_esign/models/notification_default_settings.rb +3 -0
- data/lib/docusign_esign/models/notification_defaults.rb +2 -0
- data/lib/docusign_esign/models/number.rb +100 -1
- data/lib/docusign_esign/models/page.rb +1 -0
- data/lib/docusign_esign/models/participant.rb +908 -0
- data/lib/docusign_esign/models/payment_details.rb +16 -1
- data/lib/docusign_esign/models/payment_gateway_account.rb +3 -0
- data/lib/docusign_esign/models/payment_gateway_accounts_info.rb +1 -0
- data/lib/docusign_esign/models/payment_line_item.rb +1 -0
- data/lib/docusign_esign/models/payment_method_with_options.rb +1 -0
- data/lib/docusign_esign/models/payment_processor_information.rb +1 -0
- data/lib/docusign_esign/models/permission_profile.rb +2 -0
- data/lib/docusign_esign/models/permission_profile_information.rb +1 -0
- data/lib/docusign_esign/models/phone_number.rb +72 -1
- data/lib/docusign_esign/models/poly_line_overlay.rb +60 -1
- data/lib/docusign_esign/models/power_form.rb +2 -0
- data/lib/docusign_esign/models/power_form_recipient.rb +1 -0
- data/lib/docusign_esign/models/power_form_senders_response.rb +1 -0
- data/lib/docusign_esign/models/power_forms_response.rb +1 -0
- data/lib/docusign_esign/models/prefill_tabs.rb +65 -4
- data/lib/docusign_esign/models/property_metadata.rb +1 -0
- data/lib/docusign_esign/models/radio.rb +48 -1
- data/lib/docusign_esign/models/radio_group.rb +78 -4
- data/lib/docusign_esign/models/recipient_additional_notification.rb +3 -0
- data/lib/docusign_esign/models/recipient_email_notification.rb +3 -0
- data/lib/docusign_esign/models/recipient_group.rb +1 -0
- data/lib/docusign_esign/models/recipient_identity_phone_number.rb +44 -4
- data/lib/docusign_esign/models/recipient_identity_verification.rb +15 -4
- data/lib/docusign_esign/models/recipient_names_response.rb +1 -0
- data/lib/docusign_esign/models/recipient_option.rb +1 -0
- data/lib/docusign_esign/models/recipient_phone_authentication.rb +4 -0
- data/lib/docusign_esign/models/recipient_phone_number.rb +3 -0
- data/lib/docusign_esign/models/recipient_preview_request.rb +2 -0
- data/lib/docusign_esign/models/recipient_proof_file.rb +1 -0
- data/lib/docusign_esign/models/recipient_routing.rb +2 -0
- data/lib/docusign_esign/models/recipient_signature_provider.rb +3 -0
- data/lib/docusign_esign/models/recipient_signature_provider_options.rb +5 -0
- data/lib/docusign_esign/models/recipient_sms_authentication.rb +1 -0
- data/lib/docusign_esign/models/recipient_token_client_ur_ls.rb +102 -2
- data/lib/docusign_esign/models/recipient_update_response.rb +3 -0
- data/lib/docusign_esign/models/recipient_view_request.rb +2 -0
- data/lib/docusign_esign/models/recipients.rb +14 -1
- data/lib/docusign_esign/models/recipients_update_summary.rb +1 -0
- data/lib/docusign_esign/models/reserved_domain_existence.rb +194 -0
- data/lib/docusign_esign/models/return_url_request.rb +1 -0
- data/lib/docusign_esign/models/scheduled_sending.rb +216 -0
- data/lib/docusign_esign/models/scheduled_sending_api_model.rb +206 -0
- data/lib/docusign_esign/models/seal_sign.rb +17 -0
- data/lib/docusign_esign/models/seat_discount.rb +1 -0
- data/lib/docusign_esign/models/sender_company.rb +65 -1
- data/lib/docusign_esign/models/sender_email_notifications.rb +12 -1
- data/lib/docusign_esign/models/sender_name.rb +65 -1
- data/lib/docusign_esign/models/settings_metadata.rb +1 -0
- data/lib/docusign_esign/models/shared_item.rb +3 -0
- data/lib/docusign_esign/models/sign_here.rb +62 -1
- data/lib/docusign_esign/models/signature_provider_required_option.rb +1 -0
- data/lib/docusign_esign/models/signature_type.rb +1 -0
- data/lib/docusign_esign/models/signer.rb +84 -1
- data/lib/docusign_esign/models/signer_attachment.rb +60 -1
- data/lib/docusign_esign/models/signing_group.rb +2 -0
- data/lib/docusign_esign/models/signing_group_user.rb +1 -0
- data/lib/docusign_esign/models/smart_section.rb +61 -1
- data/lib/docusign_esign/models/smart_section_display_settings.rb +2 -0
- data/lib/docusign_esign/models/social_account_information.rb +1 -0
- data/lib/docusign_esign/models/ssn.rb +98 -1
- data/lib/docusign_esign/models/stamp.rb +2 -0
- data/lib/docusign_esign/models/supported_languages.rb +1 -0
- data/lib/docusign_esign/models/tab_account_settings.rb +42 -1
- data/lib/docusign_esign/models/tab_group.rb +61 -1
- data/lib/docusign_esign/models/tab_metadata.rb +34 -1
- data/lib/docusign_esign/models/tabs.rb +2 -0
- data/lib/docusign_esign/models/template_document_visibility_list.rb +1 -0
- data/lib/docusign_esign/models/template_notification_request.rb +2 -0
- data/lib/docusign_esign/models/template_recipients.rb +14 -1
- data/lib/docusign_esign/models/template_role.rb +4 -0
- data/lib/docusign_esign/models/template_shared_item.rb +3 -0
- data/lib/docusign_esign/models/template_summary.rb +3 -0
- data/lib/docusign_esign/models/template_tabs.rb +1 -0
- data/lib/docusign_esign/models/template_update_summary.rb +4 -0
- data/lib/docusign_esign/models/text.rb +100 -1
- data/lib/docusign_esign/models/text_custom_field.rb +2 -0
- data/lib/docusign_esign/models/title.rb +72 -1
- data/lib/docusign_esign/models/user_account_management_granular_information.rb +70 -1
- data/lib/docusign_esign/models/user_info.rb +1 -0
- data/lib/docusign_esign/models/user_information.rb +17 -1
- data/lib/docusign_esign/models/user_information_list.rb +1 -0
- data/lib/docusign_esign/models/user_password_information.rb +1 -0
- data/lib/docusign_esign/models/user_password_rules.rb +2 -0
- data/lib/docusign_esign/models/user_profile.rb +3 -0
- data/lib/docusign_esign/models/user_settings_information.rb +103 -4
- data/lib/docusign_esign/models/user_shared_item.rb +3 -0
- data/lib/docusign_esign/models/user_signature.rb +2 -0
- data/lib/docusign_esign/models/user_signature_definition.rb +1 -0
- data/lib/docusign_esign/models/view.rb +66 -1
- data/lib/docusign_esign/models/witness.rb +84 -1
- data/lib/docusign_esign/models/workflow.rb +32 -1
- data/lib/docusign_esign/models/workflow_step.rb +13 -1
- data/lib/docusign_esign/models/workspace.rb +4 -0
- data/lib/docusign_esign/models/workspace_folder_contents.rb +1 -0
- data/lib/docusign_esign/models/workspace_item.rb +5 -0
- data/lib/docusign_esign/models/workspace_settings.rb +1 -0
- data/lib/docusign_esign/models/workspace_user.rb +1 -0
- data/lib/docusign_esign/models/workspace_user_authorization.rb +2 -0
- data/lib/docusign_esign/models/zip.rb +99 -1
- data/lib/docusign_esign/version.rb +1 -1
- data/lib/docusign_esign.rb +30 -17
- data/tests/spec/unit_tests_using_jwt_spec.rb +605 -449
- metadata +70 -44
- data/Gemfile.lock +0 -73
- data/docusign_esign-2.12.0.rc1.gem +0 -0
- data/docusign_esign-3.12.0.rc1.gem +0 -0
- data/lib/docusign_esign/.DS_Store +0 -0
- data/lib/docusign_esign/api/.DS_Store +0 -0
- data/lib/docusign_esign/client/.DS_Store +0 -0
- data/tests/.DS_Store +0 -0
- data/tests/Gemfile.lock +0 -46
- data/tests/docs/private.pem +0 -27
@@ -229,6 +229,15 @@ module DocuSign_eSign
|
|
229
229
|
end
|
230
230
|
end
|
231
231
|
|
232
|
+
class UpdateBrandOptions
|
233
|
+
#
|
234
|
+
attr_accessor :replace_brand
|
235
|
+
|
236
|
+
def self.default
|
237
|
+
@@default ||= UpdateBrandOptions.new
|
238
|
+
end
|
239
|
+
end
|
240
|
+
|
232
241
|
class UpdateConsumerDisclosureOptions
|
233
242
|
#
|
234
243
|
attr_accessor :include_metadata
|
@@ -435,7 +444,7 @@ module DocuSign_eSign
|
|
435
444
|
end
|
436
445
|
|
437
446
|
# Creates an acount custom field.
|
438
|
-
#
|
447
|
+
# This method creates a custom field and makes it available for all new envelopes associated with an account.
|
439
448
|
# @param account_id The external account number (int) or account ID Guid.
|
440
449
|
# @param custom_field (optional parameter)
|
441
450
|
# @param DocuSign_eSign::CreateCustomFieldOptions Options for modifying the behavior of the function.
|
@@ -446,7 +455,7 @@ module DocuSign_eSign
|
|
446
455
|
end
|
447
456
|
|
448
457
|
# Creates an acount custom field.
|
449
|
-
#
|
458
|
+
# This method creates a custom field and makes it available for all new envelopes associated with an account.
|
450
459
|
# @param account_id The external account number (int) or account ID Guid.
|
451
460
|
# @param custom_field (optional parameter)
|
452
461
|
# @param DocuSign_eSign::CreateCustomFieldOptions Options for modifying the behavior of the function.
|
@@ -489,7 +498,7 @@ module DocuSign_eSign
|
|
489
498
|
end
|
490
499
|
|
491
500
|
# Creates a new permission profile in the specified account.
|
492
|
-
#
|
501
|
+
# This method creates a new permission profile for an account. ### Related topics - [How to create a permission profile](/docs/esign-rest-api/how-to/permission-profile-creating/)
|
493
502
|
# @param account_id The external account number (int) or account ID Guid.
|
494
503
|
# @param permission_profile (optional parameter)
|
495
504
|
# @param DocuSign_eSign::CreatePermissionProfileOptions Options for modifying the behavior of the function.
|
@@ -500,7 +509,7 @@ module DocuSign_eSign
|
|
500
509
|
end
|
501
510
|
|
502
511
|
# Creates a new permission profile in the specified account.
|
503
|
-
#
|
512
|
+
# This method creates a new permission profile for an account. ### Related topics - [How to create a permission profile](/docs/esign-rest-api/how-to/permission-profile-creating/)
|
504
513
|
# @param account_id The external account number (int) or account ID Guid.
|
505
514
|
# @param permission_profile (optional parameter)
|
506
515
|
# @param DocuSign_eSign::CreatePermissionProfileOptions Options for modifying the behavior of the function.
|
@@ -542,57 +551,6 @@ module DocuSign_eSign
|
|
542
551
|
return data, status_code, headers
|
543
552
|
end
|
544
553
|
|
545
|
-
# Creates a customized report
|
546
|
-
#
|
547
|
-
# @param account_id The external account number (int) or account ID Guid.
|
548
|
-
# @param report_in_product_run_request (optional parameter)
|
549
|
-
# @return [ReportInProductSaveResponse]
|
550
|
-
def create_report_in_product_create(account_id, report_in_product_run_request)
|
551
|
-
data, _status_code, _headers = create_report_in_product_create_with_http_info(account_id, report_in_product_run_request)
|
552
|
-
return data
|
553
|
-
end
|
554
|
-
|
555
|
-
# Creates a customized report
|
556
|
-
#
|
557
|
-
# @param account_id The external account number (int) or account ID Guid.
|
558
|
-
# @param report_in_product_run_request (optional parameter)
|
559
|
-
# @return [Array<(ReportInProductSaveResponse, Fixnum, Hash)>] ReportInProductSaveResponse data, response status code and response headers
|
560
|
-
def create_report_in_product_create_with_http_info(account_id, report_in_product_run_request)
|
561
|
-
if @api_client.config.debugging
|
562
|
-
@api_client.config.logger.debug "Calling API: AccountsApi.create_report_in_product_create ..."
|
563
|
-
end
|
564
|
-
# verify the required parameter 'account_id' is set
|
565
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_report_in_product_create" if account_id.nil?
|
566
|
-
# resource path
|
567
|
-
local_var_path = "/v2.1/accounts/{accountId}/reports".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
568
|
-
|
569
|
-
# query parameters
|
570
|
-
query_params = {}
|
571
|
-
|
572
|
-
# header parameters
|
573
|
-
header_params = {}
|
574
|
-
# HTTP header 'Accept' (if needed)
|
575
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
576
|
-
|
577
|
-
# form parameters
|
578
|
-
form_params = {}
|
579
|
-
|
580
|
-
# http body (model)
|
581
|
-
post_body = @api_client.object_to_http_body(report_in_product_run_request)
|
582
|
-
auth_names = []
|
583
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
584
|
-
:header_params => header_params,
|
585
|
-
:query_params => query_params,
|
586
|
-
:form_params => form_params,
|
587
|
-
:body => post_body,
|
588
|
-
:auth_names => auth_names,
|
589
|
-
:return_type => 'ReportInProductSaveResponse')
|
590
|
-
if @api_client.config.debugging
|
591
|
-
@api_client.config.logger.debug "API called: AccountsApi#create_report_in_product_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
592
|
-
end
|
593
|
-
return data, status_code, headers
|
594
|
-
end
|
595
|
-
|
596
554
|
# Deletes the specified account.
|
597
555
|
# This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.
|
598
556
|
# @param account_id The external account number (int) or account ID Guid.
|
@@ -751,7 +709,7 @@ module DocuSign_eSign
|
|
751
709
|
end
|
752
710
|
|
753
711
|
# Removes a brand.
|
754
|
-
#
|
712
|
+
# This method deletes a brand from an account. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
|
755
713
|
# @param account_id The external account number (int) or account ID Guid.
|
756
714
|
# @param brand_id The unique identifier of a brand.
|
757
715
|
# @return [nil]
|
@@ -761,7 +719,7 @@ module DocuSign_eSign
|
|
761
719
|
end
|
762
720
|
|
763
721
|
# Removes a brand.
|
764
|
-
#
|
722
|
+
# This method deletes a brand from an account. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
|
765
723
|
# @param account_id The external account number (int) or account ID Guid.
|
766
724
|
# @param brand_id The unique identifier of a brand.
|
767
725
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
@@ -803,7 +761,7 @@ module DocuSign_eSign
|
|
803
761
|
end
|
804
762
|
|
805
763
|
# Delete one branding logo.
|
806
|
-
#
|
764
|
+
# This method deletes a single logo from an account brand. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
|
807
765
|
# @param account_id The external account number (int) or account ID Guid.
|
808
766
|
# @param brand_id The unique identifier of a brand.
|
809
767
|
# @param logo_type One of **Primary**, **Secondary** or **Email**.
|
@@ -814,7 +772,7 @@ module DocuSign_eSign
|
|
814
772
|
end
|
815
773
|
|
816
774
|
# Delete one branding logo.
|
817
|
-
#
|
775
|
+
# This method deletes a single logo from an account brand. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
|
818
776
|
# @param account_id The external account number (int) or account ID Guid.
|
819
777
|
# @param brand_id The unique identifier of a brand.
|
820
778
|
# @param logo_type One of **Primary**, **Secondary** or **Email**.
|
@@ -965,7 +923,7 @@ module DocuSign_eSign
|
|
965
923
|
end
|
966
924
|
|
967
925
|
# Delete an existing account custom field.
|
968
|
-
#
|
926
|
+
# This method deletes an existing account custom field.
|
969
927
|
# @param account_id The external account number (int) or account ID Guid.
|
970
928
|
# @param custom_field_id
|
971
929
|
# @param DocuSign_eSign::DeleteCustomFieldOptions Options for modifying the behavior of the function.
|
@@ -976,7 +934,7 @@ module DocuSign_eSign
|
|
976
934
|
end
|
977
935
|
|
978
936
|
# Delete an existing account custom field.
|
979
|
-
#
|
937
|
+
# This method deletes an existing account custom field.
|
980
938
|
# @param account_id The external account number (int) or account ID Guid.
|
981
939
|
# @param custom_field_id
|
982
940
|
# @param DocuSign_eSign::DeleteCustomFieldOptions Options for modifying the behavior of the function.
|
@@ -1068,7 +1026,7 @@ module DocuSign_eSign
|
|
1068
1026
|
end
|
1069
1027
|
|
1070
1028
|
# Deletes a permissions profile within the specified account.
|
1071
|
-
#
|
1029
|
+
# This method deletes a permission profile from an account. To delete a permission profile, it must not have any users associated with it. When you use this method to delete a permission profile, you can reassign the users associated with it to a new permission profile at the same time by using the `move_users_to` query parameter. ### Related topics - [How to delete a permission profile](/docs/esign-rest-api/how-to/permission-profile-deleting/)
|
1072
1030
|
# @param account_id The external account number (int) or account ID Guid.
|
1073
1031
|
# @param permission_profile_id
|
1074
1032
|
# @param DocuSign_eSign::DeletePermissionProfileOptions Options for modifying the behavior of the function.
|
@@ -1079,7 +1037,7 @@ module DocuSign_eSign
|
|
1079
1037
|
end
|
1080
1038
|
|
1081
1039
|
# Deletes a permissions profile within the specified account.
|
1082
|
-
#
|
1040
|
+
# This method deletes a permission profile from an account. To delete a permission profile, it must not have any users associated with it. When you use this method to delete a permission profile, you can reassign the users associated with it to a new permission profile at the same time by using the `move_users_to` query parameter. ### Related topics - [How to delete a permission profile](/docs/esign-rest-api/how-to/permission-profile-deleting/)
|
1083
1041
|
# @param account_id The external account number (int) or account ID Guid.
|
1084
1042
|
# @param permission_profile_id
|
1085
1043
|
# @param DocuSign_eSign::DeletePermissionProfileOptions Options for modifying the behavior of the function.
|
@@ -1122,61 +1080,8 @@ module DocuSign_eSign
|
|
1122
1080
|
return data, status_code, headers
|
1123
1081
|
end
|
1124
1082
|
|
1125
|
-
# Removes a customized report
|
1126
|
-
#
|
1127
|
-
# @param account_id The external account number (int) or account ID Guid.
|
1128
|
-
# @param id
|
1129
|
-
# @return [ReportInProductSaveResponse]
|
1130
|
-
def delete_report_in_product(account_id, id)
|
1131
|
-
data, _status_code, _headers = delete_report_in_product_with_http_info(account_id, id)
|
1132
|
-
return data
|
1133
|
-
end
|
1134
|
-
|
1135
|
-
# Removes a customized report
|
1136
|
-
#
|
1137
|
-
# @param account_id The external account number (int) or account ID Guid.
|
1138
|
-
# @param id
|
1139
|
-
# @return [Array<(ReportInProductSaveResponse, Fixnum, Hash)>] ReportInProductSaveResponse data, response status code and response headers
|
1140
|
-
def delete_report_in_product_with_http_info(account_id, id)
|
1141
|
-
if @api_client.config.debugging
|
1142
|
-
@api_client.config.logger.debug "Calling API: AccountsApi.delete_report_in_product ..."
|
1143
|
-
end
|
1144
|
-
# verify the required parameter 'account_id' is set
|
1145
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_report_in_product" if account_id.nil?
|
1146
|
-
# verify the required parameter 'id' is set
|
1147
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling AccountsApi.delete_report_in_product" if id.nil?
|
1148
|
-
# resource path
|
1149
|
-
local_var_path = "/v2.1/accounts/{accountId}/reports/{id}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'id' + '}', id.to_s)
|
1150
|
-
|
1151
|
-
# query parameters
|
1152
|
-
query_params = {}
|
1153
|
-
|
1154
|
-
# header parameters
|
1155
|
-
header_params = {}
|
1156
|
-
# HTTP header 'Accept' (if needed)
|
1157
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1158
|
-
|
1159
|
-
# form parameters
|
1160
|
-
form_params = {}
|
1161
|
-
|
1162
|
-
# http body (model)
|
1163
|
-
post_body = nil
|
1164
|
-
auth_names = []
|
1165
|
-
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
1166
|
-
:header_params => header_params,
|
1167
|
-
:query_params => query_params,
|
1168
|
-
:form_params => form_params,
|
1169
|
-
:body => post_body,
|
1170
|
-
:auth_names => auth_names,
|
1171
|
-
:return_type => 'ReportInProductSaveResponse')
|
1172
|
-
if @api_client.config.debugging
|
1173
|
-
@api_client.config.logger.debug "API called: AccountsApi#delete_report_in_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1174
|
-
end
|
1175
|
-
return data, status_code, headers
|
1176
|
-
end
|
1177
|
-
|
1178
1083
|
# Get the list of identity verification options for an account
|
1179
|
-
#
|
1084
|
+
# This method returns a list of Identity Verification workflows that are available to an account. **Note:** To use this method, you must either be an account administrator or a sender. ### Related topics - [How to require ID Verification (IDV) for a recipient](/docs/esign-rest-api/how-to/id-verification/)
|
1180
1085
|
# @param account_id The external account number (int) or account ID Guid.
|
1181
1086
|
# @return [AccountIdentityVerificationResponse]
|
1182
1087
|
def get_account_identity_verification(account_id)
|
@@ -1185,7 +1090,7 @@ module DocuSign_eSign
|
|
1185
1090
|
end
|
1186
1091
|
|
1187
1092
|
# Get the list of identity verification options for an account
|
1188
|
-
#
|
1093
|
+
# This method returns a list of Identity Verification workflows that are available to an account. **Note:** To use this method, you must either be an account administrator or a sender. ### Related topics - [How to require ID Verification (IDV) for a recipient](/docs/esign-rest-api/how-to/id-verification/)
|
1189
1094
|
# @param account_id The external account number (int) or account ID Guid.
|
1190
1095
|
# @return [Array<(AccountIdentityVerificationResponse, Fixnum, Hash)>] AccountIdentityVerificationResponse data, response status code and response headers
|
1191
1096
|
def get_account_identity_verification_with_http_info(account_id)
|
@@ -1444,7 +1349,7 @@ module DocuSign_eSign
|
|
1444
1349
|
end
|
1445
1350
|
|
1446
1351
|
# Returns tab settings list for specified account
|
1447
|
-
#
|
1352
|
+
# This method returns information about the tab types and tab functionality that is currently enabled for an account.
|
1448
1353
|
# @param account_id The external account number (int) or account ID Guid.
|
1449
1354
|
# @return [TabAccountSettings]
|
1450
1355
|
def get_account_tab_settings(account_id)
|
@@ -1453,7 +1358,7 @@ module DocuSign_eSign
|
|
1453
1358
|
end
|
1454
1359
|
|
1455
1360
|
# Returns tab settings list for specified account
|
1456
|
-
#
|
1361
|
+
# This method returns information about the tab types and tab functionality that is currently enabled for an account.
|
1457
1362
|
# @param account_id The external account number (int) or account ID Guid.
|
1458
1363
|
# @return [Array<(TabAccountSettings, Fixnum, Hash)>] TabAccountSettings data, response status code and response headers
|
1459
1364
|
def get_account_tab_settings_with_http_info(account_id)
|
@@ -1493,7 +1398,7 @@ module DocuSign_eSign
|
|
1493
1398
|
end
|
1494
1399
|
|
1495
1400
|
# Get all payment gateway account for the provided accountId
|
1496
|
-
#
|
1401
|
+
# This method returns a list of payment gateway accounts and basic information about them.
|
1497
1402
|
# @param account_id The external account number (int) or account ID Guid.
|
1498
1403
|
# @return [PaymentGatewayAccountsInfo]
|
1499
1404
|
def get_all_payment_gateway_accounts(account_id)
|
@@ -1502,7 +1407,7 @@ module DocuSign_eSign
|
|
1502
1407
|
end
|
1503
1408
|
|
1504
1409
|
# Get all payment gateway account for the provided accountId
|
1505
|
-
#
|
1410
|
+
# This method returns a list of payment gateway accounts and basic information about them.
|
1506
1411
|
# @param account_id The external account number (int) or account ID Guid.
|
1507
1412
|
# @return [Array<(PaymentGatewayAccountsInfo, Fixnum, Hash)>] PaymentGatewayAccountsInfo data, response status code and response headers
|
1508
1413
|
def get_all_payment_gateway_accounts_with_http_info(account_id)
|
@@ -1594,7 +1499,7 @@ module DocuSign_eSign
|
|
1594
1499
|
end
|
1595
1500
|
|
1596
1501
|
# Get information for a specific brand.
|
1597
|
-
#
|
1502
|
+
# This method returns details about an account brand. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
|
1598
1503
|
# @param account_id The external account number (int) or account ID Guid.
|
1599
1504
|
# @param brand_id The unique identifier of a brand.
|
1600
1505
|
# @param DocuSign_eSign::GetBrandOptions Options for modifying the behavior of the function.
|
@@ -1605,7 +1510,7 @@ module DocuSign_eSign
|
|
1605
1510
|
end
|
1606
1511
|
|
1607
1512
|
# Get information for a specific brand.
|
1608
|
-
#
|
1513
|
+
# This method returns details about an account brand. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
|
1609
1514
|
# @param account_id The external account number (int) or account ID Guid.
|
1610
1515
|
# @param brand_id The unique identifier of a brand.
|
1611
1516
|
# @param DocuSign_eSign::GetBrandOptions Options for modifying the behavior of the function.
|
@@ -1651,7 +1556,7 @@ module DocuSign_eSign
|
|
1651
1556
|
end
|
1652
1557
|
|
1653
1558
|
# Export a specific brand.
|
1654
|
-
#
|
1559
|
+
# This method exports information about a brand to an XML file. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
|
1655
1560
|
# @param account_id The external account number (int) or account ID Guid.
|
1656
1561
|
# @param brand_id The unique identifier of a brand.
|
1657
1562
|
# @return [nil]
|
@@ -1661,7 +1566,7 @@ module DocuSign_eSign
|
|
1661
1566
|
end
|
1662
1567
|
|
1663
1568
|
# Export a specific brand.
|
1664
|
-
#
|
1569
|
+
# This method exports information about a brand to an XML file. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
|
1665
1570
|
# @param account_id The external account number (int) or account ID Guid.
|
1666
1571
|
# @param brand_id The unique identifier of a brand.
|
1667
1572
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
@@ -1703,7 +1608,7 @@ module DocuSign_eSign
|
|
1703
1608
|
end
|
1704
1609
|
|
1705
1610
|
# Obtains the specified image for a brand.
|
1706
|
-
#
|
1611
|
+
# This method returns a specific logo that is used in a brand. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
|
1707
1612
|
# @param account_id The external account number (int) or account ID Guid.
|
1708
1613
|
# @param brand_id The unique identifier of a brand.
|
1709
1614
|
# @param logo_type One of **Primary**, **Secondary** or **Email**.
|
@@ -1714,7 +1619,7 @@ module DocuSign_eSign
|
|
1714
1619
|
end
|
1715
1620
|
|
1716
1621
|
# Obtains the specified image for a brand.
|
1717
|
-
#
|
1622
|
+
# This method returns a specific logo that is used in a brand. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
|
1718
1623
|
# @param account_id The external account number (int) or account ID Guid.
|
1719
1624
|
# @param brand_id The unique identifier of a brand.
|
1720
1625
|
# @param logo_type One of **Primary**, **Secondary** or **Email**.
|
@@ -1760,7 +1665,7 @@ module DocuSign_eSign
|
|
1760
1665
|
end
|
1761
1666
|
|
1762
1667
|
# Returns the specified account's list of branding resources (metadata).
|
1763
|
-
#
|
1668
|
+
# This method returns metadata about the branding resources that are associated with an account. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
|
1764
1669
|
# @param account_id The external account number (int) or account ID Guid.
|
1765
1670
|
# @param brand_id The unique identifier of a brand.
|
1766
1671
|
# @return [BrandResourcesList]
|
@@ -1770,7 +1675,7 @@ module DocuSign_eSign
|
|
1770
1675
|
end
|
1771
1676
|
|
1772
1677
|
# Returns the specified account's list of branding resources (metadata).
|
1773
|
-
#
|
1678
|
+
# This method returns metadata about the branding resources that are associated with an account. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
|
1774
1679
|
# @param account_id The external account number (int) or account ID Guid.
|
1775
1680
|
# @param brand_id The unique identifier of a brand.
|
1776
1681
|
# @return [Array<(BrandResourcesList, Fixnum, Hash)>] BrandResourcesList data, response status code and response headers
|
@@ -1813,7 +1718,7 @@ module DocuSign_eSign
|
|
1813
1718
|
end
|
1814
1719
|
|
1815
1720
|
# Returns the specified branding resource file.
|
1816
|
-
#
|
1721
|
+
# This method returns a specific branding resource file. A brand uses a set of brand resource files to control the sending, signing, email message, and captive (embedded) signing experiences. You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience. **Important:** When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
|
1817
1722
|
# @param account_id The external account number (int) or account ID Guid.
|
1818
1723
|
# @param brand_id The unique identifier of a brand.
|
1819
1724
|
# @param resource_content_type
|
@@ -1825,7 +1730,7 @@ module DocuSign_eSign
|
|
1825
1730
|
end
|
1826
1731
|
|
1827
1732
|
# Returns the specified branding resource file.
|
1828
|
-
#
|
1733
|
+
# This method returns a specific branding resource file. A brand uses a set of brand resource files to control the sending, signing, email message, and captive (embedded) signing experiences. You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience. **Important:** When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
|
1829
1734
|
# @param account_id The external account number (int) or account ID Guid.
|
1830
1735
|
# @param brand_id The unique identifier of a brand.
|
1831
1736
|
# @param resource_content_type
|
@@ -1875,7 +1780,7 @@ module DocuSign_eSign
|
|
1875
1780
|
# Gets the Electronic Record and Signature Disclosure.
|
1876
1781
|
# 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.
|
1877
1782
|
# @param account_id The external account number (int) or account ID Guid.
|
1878
|
-
# @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), Armenian (hy), 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
|
1783
|
+
# @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), Armenian (hy), 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.
|
1879
1784
|
# @return [ConsumerDisclosure]
|
1880
1785
|
def get_consumer_disclosure(account_id, lang_code)
|
1881
1786
|
data, _status_code, _headers = get_consumer_disclosure_with_http_info(account_id, lang_code)
|
@@ -1885,7 +1790,7 @@ module DocuSign_eSign
|
|
1885
1790
|
# Gets the Electronic Record and Signature Disclosure.
|
1886
1791
|
# 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.
|
1887
1792
|
# @param account_id The external account number (int) or account ID Guid.
|
1888
|
-
# @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), Armenian (hy), 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
|
1793
|
+
# @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), Armenian (hy), 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.
|
1889
1794
|
# @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
|
1890
1795
|
def get_consumer_disclosure_with_http_info(account_id, lang_code)
|
1891
1796
|
if @api_client.config.debugging
|
@@ -2027,7 +1932,7 @@ module DocuSign_eSign
|
|
2027
1932
|
end
|
2028
1933
|
|
2029
1934
|
# Select envelope purge configuration.
|
2030
|
-
#
|
1935
|
+
# An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (`retentionDays`). This method retrieves the current envelope purge configuration for your account. **Note:** To use this method, you must be an account administrator.
|
2031
1936
|
# @param account_id The external account number (int) or account ID Guid.
|
2032
1937
|
# @return [EnvelopePurgeConfiguration]
|
2033
1938
|
def get_envelope_purge_configuration(account_id)
|
@@ -2036,7 +1941,7 @@ module DocuSign_eSign
|
|
2036
1941
|
end
|
2037
1942
|
|
2038
1943
|
# Select envelope purge configuration.
|
2039
|
-
#
|
1944
|
+
# An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (`retentionDays`). This method retrieves the current envelope purge configuration for your account. **Note:** To use this method, you must be an account administrator.
|
2040
1945
|
# @param account_id The external account number (int) or account ID Guid.
|
2041
1946
|
# @return [Array<(EnvelopePurgeConfiguration, Fixnum, Hash)>] EnvelopePurgeConfiguration data, response status code and response headers
|
2042
1947
|
def get_envelope_purge_configuration_with_http_info(account_id)
|
@@ -2125,7 +2030,7 @@ module DocuSign_eSign
|
|
2125
2030
|
end
|
2126
2031
|
|
2127
2032
|
# Returns default user level settings for a specified account
|
2128
|
-
#
|
2033
|
+
# This method returns the default settings for the email notifications that signers and senders receive about envelopes.
|
2129
2034
|
# @param account_id The external account number (int) or account ID Guid.
|
2130
2035
|
# @return [NotificationDefaults]
|
2131
2036
|
def get_notification_defaults(account_id)
|
@@ -2134,7 +2039,7 @@ module DocuSign_eSign
|
|
2134
2039
|
end
|
2135
2040
|
|
2136
2041
|
# Returns default user level settings for a specified account
|
2137
|
-
#
|
2042
|
+
# This method returns the default settings for the email notifications that signers and senders receive about envelopes.
|
2138
2043
|
# @param account_id The external account number (int) or account ID Guid.
|
2139
2044
|
# @return [Array<(NotificationDefaults, Fixnum, Hash)>] NotificationDefaults data, response status code and response headers
|
2140
2045
|
def get_notification_defaults_with_http_info(account_id)
|
@@ -2174,7 +2079,7 @@ module DocuSign_eSign
|
|
2174
2079
|
end
|
2175
2080
|
|
2176
2081
|
# Get the password rules
|
2177
|
-
#
|
2082
|
+
# This method retrieves the password rules for an account.
|
2178
2083
|
# @param account_id The external account number (int) or account ID Guid.
|
2179
2084
|
# @return [AccountPasswordRules]
|
2180
2085
|
def get_password_rules(account_id)
|
@@ -2183,7 +2088,7 @@ module DocuSign_eSign
|
|
2183
2088
|
end
|
2184
2089
|
|
2185
2090
|
# Get the password rules
|
2186
|
-
#
|
2091
|
+
# This method retrieves the password rules for an account.
|
2187
2092
|
# @param account_id The external account number (int) or account ID Guid.
|
2188
2093
|
# @return [Array<(AccountPasswordRules, Fixnum, Hash)>] AccountPasswordRules data, response status code and response headers
|
2189
2094
|
def get_password_rules_with_http_info(account_id)
|
@@ -2268,7 +2173,7 @@ module DocuSign_eSign
|
|
2268
2173
|
end
|
2269
2174
|
|
2270
2175
|
# Returns a permissions profile in the specified account.
|
2271
|
-
#
|
2176
|
+
# This method returns information about a specific permission profile that is associated with an account. ### Related topics - [How to set a permission profile](/docs/esign-rest-api/how-to/permission-profile-setting/)
|
2272
2177
|
# @param account_id The external account number (int) or account ID Guid.
|
2273
2178
|
# @param permission_profile_id
|
2274
2179
|
# @param DocuSign_eSign::GetPermissionProfileOptions Options for modifying the behavior of the function.
|
@@ -2279,7 +2184,7 @@ module DocuSign_eSign
|
|
2279
2184
|
end
|
2280
2185
|
|
2281
2186
|
# Returns a permissions profile in the specified account.
|
2282
|
-
#
|
2187
|
+
# This method returns information about a specific permission profile that is associated with an account. ### Related topics - [How to set a permission profile](/docs/esign-rest-api/how-to/permission-profile-setting/)
|
2283
2188
|
# @param account_id The external account number (int) or account ID Guid.
|
2284
2189
|
# @param permission_profile_id
|
2285
2190
|
# @param DocuSign_eSign::GetPermissionProfileOptions Options for modifying the behavior of the function.
|
@@ -2368,110 +2273,8 @@ module DocuSign_eSign
|
|
2368
2273
|
return data, status_code, headers
|
2369
2274
|
end
|
2370
2275
|
|
2371
|
-
# Gets the specified report
|
2372
|
-
#
|
2373
|
-
# @param account_id The external account number (int) or account ID Guid.
|
2374
|
-
# @param id
|
2375
|
-
# @return [ReportInProductGet]
|
2376
|
-
def get_report_in_product(account_id, id)
|
2377
|
-
data, _status_code, _headers = get_report_in_product_with_http_info(account_id, id)
|
2378
|
-
return data
|
2379
|
-
end
|
2380
|
-
|
2381
|
-
# Gets the specified report
|
2382
|
-
#
|
2383
|
-
# @param account_id The external account number (int) or account ID Guid.
|
2384
|
-
# @param id
|
2385
|
-
# @return [Array<(ReportInProductGet, Fixnum, Hash)>] ReportInProductGet data, response status code and response headers
|
2386
|
-
def get_report_in_product_with_http_info(account_id, id)
|
2387
|
-
if @api_client.config.debugging
|
2388
|
-
@api_client.config.logger.debug "Calling API: AccountsApi.get_report_in_product ..."
|
2389
|
-
end
|
2390
|
-
# verify the required parameter 'account_id' is set
|
2391
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_report_in_product" if account_id.nil?
|
2392
|
-
# verify the required parameter 'id' is set
|
2393
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling AccountsApi.get_report_in_product" if id.nil?
|
2394
|
-
# resource path
|
2395
|
-
local_var_path = "/v2.1/accounts/{accountId}/reports/{id}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'id' + '}', id.to_s)
|
2396
|
-
|
2397
|
-
# query parameters
|
2398
|
-
query_params = {}
|
2399
|
-
|
2400
|
-
# header parameters
|
2401
|
-
header_params = {}
|
2402
|
-
# HTTP header 'Accept' (if needed)
|
2403
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2404
|
-
|
2405
|
-
# form parameters
|
2406
|
-
form_params = {}
|
2407
|
-
|
2408
|
-
# http body (model)
|
2409
|
-
post_body = nil
|
2410
|
-
auth_names = []
|
2411
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
2412
|
-
:header_params => header_params,
|
2413
|
-
:query_params => query_params,
|
2414
|
-
:form_params => form_params,
|
2415
|
-
:body => post_body,
|
2416
|
-
:auth_names => auth_names,
|
2417
|
-
:return_type => 'ReportInProductGet')
|
2418
|
-
if @api_client.config.debugging
|
2419
|
-
@api_client.config.logger.debug "API called: AccountsApi#get_report_in_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2420
|
-
end
|
2421
|
-
return data, status_code, headers
|
2422
|
-
end
|
2423
|
-
|
2424
|
-
# Gets the descriptors for all of an account's active reports (for listings)
|
2425
|
-
#
|
2426
|
-
# @param account_id The external account number (int) or account ID Guid.
|
2427
|
-
# @return [ReportInProductList]
|
2428
|
-
def get_report_in_product_list(account_id)
|
2429
|
-
data, _status_code, _headers = get_report_in_product_list_with_http_info(account_id)
|
2430
|
-
return data
|
2431
|
-
end
|
2432
|
-
|
2433
|
-
# Gets the descriptors for all of an account's active reports (for listings)
|
2434
|
-
#
|
2435
|
-
# @param account_id The external account number (int) or account ID Guid.
|
2436
|
-
# @return [Array<(ReportInProductList, Fixnum, Hash)>] ReportInProductList data, response status code and response headers
|
2437
|
-
def get_report_in_product_list_with_http_info(account_id)
|
2438
|
-
if @api_client.config.debugging
|
2439
|
-
@api_client.config.logger.debug "Calling API: AccountsApi.get_report_in_product_list ..."
|
2440
|
-
end
|
2441
|
-
# verify the required parameter 'account_id' is set
|
2442
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_report_in_product_list" if account_id.nil?
|
2443
|
-
# resource path
|
2444
|
-
local_var_path = "/v2.1/accounts/{accountId}/reports".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
2445
|
-
|
2446
|
-
# query parameters
|
2447
|
-
query_params = {}
|
2448
|
-
|
2449
|
-
# header parameters
|
2450
|
-
header_params = {}
|
2451
|
-
# HTTP header 'Accept' (if needed)
|
2452
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2453
|
-
|
2454
|
-
# form parameters
|
2455
|
-
form_params = {}
|
2456
|
-
|
2457
|
-
# http body (model)
|
2458
|
-
post_body = nil
|
2459
|
-
auth_names = []
|
2460
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
2461
|
-
:header_params => header_params,
|
2462
|
-
:query_params => query_params,
|
2463
|
-
:form_params => form_params,
|
2464
|
-
:body => post_body,
|
2465
|
-
:auth_names => auth_names,
|
2466
|
-
:return_type => 'ReportInProductList')
|
2467
|
-
if @api_client.config.debugging
|
2468
|
-
@api_client.config.logger.debug "API called: AccountsApi#get_report_in_product_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2469
|
-
end
|
2470
|
-
return data, status_code, headers
|
2471
|
-
end
|
2472
|
-
|
2473
2276
|
# Gets list of supported languages for recipient language setting.
|
2474
|
-
#
|
2277
|
+
# Retrieves a list of supported languages that you can set for an individual recipient when creating an envelope, as well as their simple type enumeration values. These are the languages that you can set for the standard email format and signing view for each recipient. For example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. **Note:** Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it. For more information, see [Set Recipient Language and Specify Custom Email Messages](https://support.docusign.com/en/guides/ndse-user-guide-recipient-language).
|
2475
2278
|
# @param account_id The external account number (int) or account ID Guid.
|
2476
2279
|
# @return [SupportedLanguages]
|
2477
2280
|
def get_supported_languages(account_id)
|
@@ -2480,7 +2283,7 @@ module DocuSign_eSign
|
|
2480
2283
|
end
|
2481
2284
|
|
2482
2285
|
# Gets list of supported languages for recipient language setting.
|
2483
|
-
#
|
2286
|
+
# Retrieves a list of supported languages that you can set for an individual recipient when creating an envelope, as well as their simple type enumeration values. These are the languages that you can set for the standard email format and signing view for each recipient. For example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. **Note:** Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it. For more information, see [Set Recipient Language and Specify Custom Email Messages](https://support.docusign.com/en/guides/ndse-user-guide-recipient-language).
|
2484
2287
|
# @param account_id The external account number (int) or account ID Guid.
|
2485
2288
|
# @return [Array<(SupportedLanguages, Fixnum, Hash)>] SupportedLanguages data, response status code and response headers
|
2486
2289
|
def get_supported_languages_with_http_info(account_id)
|
@@ -2934,7 +2737,7 @@ module DocuSign_eSign
|
|
2934
2737
|
end
|
2935
2738
|
|
2936
2739
|
# Returns Account available signature providers for specified account.
|
2937
|
-
#
|
2740
|
+
# Returns a list of signature providers that the specified account can use.
|
2938
2741
|
# @param account_id The external account number (int) or account ID Guid.
|
2939
2742
|
# @return [AccountSignatureProviders]
|
2940
2743
|
def list_signature_providers(account_id)
|
@@ -2943,7 +2746,7 @@ module DocuSign_eSign
|
|
2943
2746
|
end
|
2944
2747
|
|
2945
2748
|
# Returns Account available signature providers for specified account.
|
2946
|
-
#
|
2749
|
+
# Returns a list of signature providers that the specified account can use.
|
2947
2750
|
# @param account_id The external account number (int) or account ID Guid.
|
2948
2751
|
# @return [Array<(AccountSignatureProviders, Fixnum, Hash)>] AccountSignatureProviders data, response status code and response headers
|
2949
2752
|
def list_signature_providers_with_http_info(account_id)
|
@@ -3254,7 +3057,7 @@ module DocuSign_eSign
|
|
3254
3057
|
end
|
3255
3058
|
|
3256
3059
|
# Modifies tab settings for specified account
|
3257
|
-
#
|
3060
|
+
# This method modifies the tab types and tab functionality that is enabled for an account.
|
3258
3061
|
# @param account_id The external account number (int) or account ID Guid.
|
3259
3062
|
# @param tab_account_settings (optional parameter)
|
3260
3063
|
# @return [TabAccountSettings]
|
@@ -3264,7 +3067,7 @@ module DocuSign_eSign
|
|
3264
3067
|
end
|
3265
3068
|
|
3266
3069
|
# Modifies tab settings for specified account
|
3267
|
-
#
|
3070
|
+
# This method modifies the tab types and tab functionality that is enabled for an account.
|
3268
3071
|
# @param account_id The external account number (int) or account ID Guid.
|
3269
3072
|
# @param tab_account_settings (optional parameter)
|
3270
3073
|
# @return [Array<(TabAccountSettings, Fixnum, Hash)>] TabAccountSettings data, response status code and response headers
|
@@ -3305,23 +3108,25 @@ module DocuSign_eSign
|
|
3305
3108
|
end
|
3306
3109
|
|
3307
3110
|
# Updates an existing brand.
|
3308
|
-
#
|
3111
|
+
# This method updates an account brand. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
|
3309
3112
|
# @param account_id The external account number (int) or account ID Guid.
|
3310
3113
|
# @param brand_id The unique identifier of a brand.
|
3311
3114
|
# @param brand (optional parameter)
|
3115
|
+
# @param DocuSign_eSign::UpdateBrandOptions Options for modifying the behavior of the function.
|
3312
3116
|
# @return [Brand]
|
3313
|
-
def update_brand(account_id, brand_id, brand)
|
3314
|
-
data, _status_code, _headers = update_brand_with_http_info(account_id, brand_id, brand)
|
3117
|
+
def update_brand(account_id, brand_id, brand, options = DocuSign_eSign::UpdateBrandOptions.default)
|
3118
|
+
data, _status_code, _headers = update_brand_with_http_info(account_id, brand_id, brand, options)
|
3315
3119
|
return data
|
3316
3120
|
end
|
3317
3121
|
|
3318
3122
|
# Updates an existing brand.
|
3319
|
-
#
|
3123
|
+
# This method updates an account brand. **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
|
3320
3124
|
# @param account_id The external account number (int) or account ID Guid.
|
3321
3125
|
# @param brand_id The unique identifier of a brand.
|
3322
3126
|
# @param brand (optional parameter)
|
3127
|
+
# @param DocuSign_eSign::UpdateBrandOptions Options for modifying the behavior of the function.
|
3323
3128
|
# @return [Array<(Brand, Fixnum, Hash)>] Brand data, response status code and response headers
|
3324
|
-
def update_brand_with_http_info(account_id, brand_id, brand)
|
3129
|
+
def update_brand_with_http_info(account_id, brand_id, brand, options = DocuSign_eSign::UpdateBrandOptions.default)
|
3325
3130
|
if @api_client.config.debugging
|
3326
3131
|
@api_client.config.logger.debug "Calling API: AccountsApi.update_brand ..."
|
3327
3132
|
end
|
@@ -3334,6 +3139,7 @@ module DocuSign_eSign
|
|
3334
3139
|
|
3335
3140
|
# query parameters
|
3336
3141
|
query_params = {}
|
3142
|
+
query_params[:'replace_brand'] = options.replace_brand if !options.replace_brand.nil?
|
3337
3143
|
|
3338
3144
|
# header parameters
|
3339
3145
|
header_params = {}
|
@@ -3360,9 +3166,9 @@ module DocuSign_eSign
|
|
3360
3166
|
end
|
3361
3167
|
|
3362
3168
|
# Put one branding logo.
|
3363
|
-
#
|
3169
|
+
# This method updates a single brand logo. You pass in the new version of the resource in the `Content-Disposition` header. Example: `Content-Disposition: form-data; name=\"file\"; filename=\"logo.jpg\"` **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
|
3364
3170
|
# @param account_id The external account number (int) or account ID GUID.
|
3365
|
-
# @param brand_id The
|
3171
|
+
# @param brand_id The ID of the brand.
|
3366
3172
|
# @param logo_type The type of logo. Valid values are: - `primary` - `secondary` - `email`
|
3367
3173
|
# @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
|
3368
3174
|
# @return [nil]
|
@@ -3372,9 +3178,9 @@ module DocuSign_eSign
|
|
3372
3178
|
end
|
3373
3179
|
|
3374
3180
|
# Put one branding logo.
|
3375
|
-
#
|
3181
|
+
# This method updates a single brand logo. You pass in the new version of the resource in the `Content-Disposition` header. Example: `Content-Disposition: form-data; name=\"file\"; filename=\"logo.jpg\"` **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
|
3376
3182
|
# @param account_id The external account number (int) or account ID GUID.
|
3377
|
-
# @param brand_id The
|
3183
|
+
# @param brand_id The ID of the brand.
|
3378
3184
|
# @param logo_type The type of logo. Valid values are: - `primary` - `secondary` - `email`
|
3379
3185
|
# @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
|
3380
3186
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
@@ -3422,9 +3228,9 @@ module DocuSign_eSign
|
|
3422
3228
|
end
|
3423
3229
|
|
3424
3230
|
# Uploads a branding resource file.
|
3425
|
-
#
|
3231
|
+
# This method updates a branding resource file. You pass in the new version of the resource file in the `Content-Disposition` header. Example: `Content-Disposition: form-data; name=\"file\"; filename=\"DocuSign_SigningResource_4328673.xml\"` **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**). **Important:** Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed. When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file.
|
3426
3232
|
# @param account_id The external account number (int) or account ID GUID.
|
3427
|
-
# @param brand_id The
|
3233
|
+
# @param brand_id The ID of the brand.
|
3428
3234
|
# @param resource_content_type The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive`
|
3429
3235
|
# @return [BrandResources]
|
3430
3236
|
def update_brand_resources_by_content_type(account_id, brand_id, resource_content_type)
|
@@ -3433,9 +3239,9 @@ module DocuSign_eSign
|
|
3433
3239
|
end
|
3434
3240
|
|
3435
3241
|
# Uploads a branding resource file.
|
3436
|
-
#
|
3242
|
+
# This method updates a branding resource file. You pass in the new version of the resource file in the `Content-Disposition` header. Example: `Content-Disposition: form-data; name=\"file\"; filename=\"DocuSign_SigningResource_4328673.xml\"` **Note:** Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**). **Important:** Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed. When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file.
|
3437
3243
|
# @param account_id The external account number (int) or account ID GUID.
|
3438
|
-
# @param brand_id The
|
3244
|
+
# @param brand_id The ID of the brand.
|
3439
3245
|
# @param resource_content_type The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive`
|
3440
3246
|
# @return [Array<(BrandResources, Fixnum, Hash)>] BrandResources data, response status code and response headers
|
3441
3247
|
def update_brand_resources_by_content_type_with_http_info(account_id, brand_id, resource_content_type)
|
@@ -3484,9 +3290,9 @@ module DocuSign_eSign
|
|
3484
3290
|
end
|
3485
3291
|
|
3486
3292
|
# Update Consumer Disclosure.
|
3487
|
-
#
|
3293
|
+
# Account administrators can use this method to perform the following tasks: - Customize values in the default disclosure. - Switch to a custom disclosure that uses your own text and HTML formatting. - Change values in your existing consumer disclosure. To specify the signer language version of the disclosure that you are updating, use the optional `langCode` query parameter. **Note:** Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version. ## Updating the default disclosure When you update the default disclosure, you can edit all properties except for the following ones: - `accountEsignId`: This property is read-only. - `custom`: The default value is **false.** Editing this property causes the default disclosure to switch to a custom disclosure. - `esignAgreement`: This property is read-only. - `esignText`: You cannot edit this property when `custom` is set to **false.** The API returns a 200 OK HTTP response, but does not update the `esignText`. - Metadata properties: These properties are read-only. **Note:** The text of the default disclosure is always in English. ## Switching to a custom disclosure To switch to a custom disclosure, set the `custom` property to **true** and customize the value for the `eSignText` property. You can also edit all of the other properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. **Note:** When you use a custom disclosure, you can create versions of it in different signer languages and se the `langCode` parameter to specify the signer language version that you are updating. **Important:** When you switch from a default to a custom disclosure, note the following information: - You will not be able to return to using the default disclosure. - Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use. ## Updating a custom disclosure When you update a custom disclosure, you can update all of the properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. **Important:** Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.
|
3488
3294
|
# @param account_id The external account number (int) or account ID Guid.
|
3489
|
-
# @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), Armenian (hy), 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
|
3295
|
+
# @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), Armenian (hy), 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.
|
3490
3296
|
# @param consumer_disclosure (optional parameter)
|
3491
3297
|
# @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
|
3492
3298
|
# @return [ConsumerDisclosure]
|
@@ -3496,9 +3302,9 @@ module DocuSign_eSign
|
|
3496
3302
|
end
|
3497
3303
|
|
3498
3304
|
# Update Consumer Disclosure.
|
3499
|
-
#
|
3305
|
+
# Account administrators can use this method to perform the following tasks: - Customize values in the default disclosure. - Switch to a custom disclosure that uses your own text and HTML formatting. - Change values in your existing consumer disclosure. To specify the signer language version of the disclosure that you are updating, use the optional `langCode` query parameter. **Note:** Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version. ## Updating the default disclosure When you update the default disclosure, you can edit all properties except for the following ones: - `accountEsignId`: This property is read-only. - `custom`: The default value is **false.** Editing this property causes the default disclosure to switch to a custom disclosure. - `esignAgreement`: This property is read-only. - `esignText`: You cannot edit this property when `custom` is set to **false.** The API returns a 200 OK HTTP response, but does not update the `esignText`. - Metadata properties: These properties are read-only. **Note:** The text of the default disclosure is always in English. ## Switching to a custom disclosure To switch to a custom disclosure, set the `custom` property to **true** and customize the value for the `eSignText` property. You can also edit all of the other properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. **Note:** When you use a custom disclosure, you can create versions of it in different signer languages and se the `langCode` parameter to specify the signer language version that you are updating. **Important:** When you switch from a default to a custom disclosure, note the following information: - You will not be able to return to using the default disclosure. - Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use. ## Updating a custom disclosure When you update a custom disclosure, you can update all of the properties except for the following ones: - `accountEsignId`: This property is read-only. - `esignAgreement`: This property is read-only. - Metadata properties: These properties are read-only. **Important:** Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.
|
3500
3306
|
# @param account_id The external account number (int) or account ID Guid.
|
3501
|
-
# @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), Armenian (hy), 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
|
3307
|
+
# @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), Armenian (hy), 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.
|
3502
3308
|
# @param consumer_disclosure (optional parameter)
|
3503
3309
|
# @param DocuSign_eSign::UpdateConsumerDisclosureOptions Options for modifying the behavior of the function.
|
3504
3310
|
# @return [Array<(ConsumerDisclosure, Fixnum, Hash)>] ConsumerDisclosure data, response status code and response headers
|
@@ -3542,7 +3348,7 @@ module DocuSign_eSign
|
|
3542
3348
|
end
|
3543
3349
|
|
3544
3350
|
# Updates an existing account custom field.
|
3545
|
-
#
|
3351
|
+
# This method updates an existing account custom field.
|
3546
3352
|
# @param account_id The external account number (int) or account ID Guid.
|
3547
3353
|
# @param custom_field_id
|
3548
3354
|
# @param custom_field (optional parameter)
|
@@ -3554,7 +3360,7 @@ module DocuSign_eSign
|
|
3554
3360
|
end
|
3555
3361
|
|
3556
3362
|
# Updates an existing account custom field.
|
3557
|
-
#
|
3363
|
+
# This method updates an existing account custom field.
|
3558
3364
|
# @param account_id The external account number (int) or account ID Guid.
|
3559
3365
|
# @param custom_field_id
|
3560
3366
|
# @param custom_field (optional parameter)
|
@@ -3651,7 +3457,7 @@ module DocuSign_eSign
|
|
3651
3457
|
end
|
3652
3458
|
|
3653
3459
|
# Updates envelope purge configuration.
|
3654
|
-
#
|
3460
|
+
# An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (`retentionDays`). This method sets the envelope purge configuration for your account. **Note:** To use this method, you must be an account administrator. For more information, see [Purge Envelopes](https://support.docusign.com/en/guides/ndse-user-guide-purge-envelopes).
|
3655
3461
|
# @param account_id The external account number (int) or account ID Guid.
|
3656
3462
|
# @param envelope_purge_configuration (optional parameter)
|
3657
3463
|
# @return [EnvelopePurgeConfiguration]
|
@@ -3661,7 +3467,7 @@ module DocuSign_eSign
|
|
3661
3467
|
end
|
3662
3468
|
|
3663
3469
|
# Updates envelope purge configuration.
|
3664
|
-
#
|
3470
|
+
# An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (`retentionDays`). This method sets the envelope purge configuration for your account. **Note:** To use this method, you must be an account administrator. For more information, see [Purge Envelopes](https://support.docusign.com/en/guides/ndse-user-guide-purge-envelopes).
|
3665
3471
|
# @param account_id The external account number (int) or account ID Guid.
|
3666
3472
|
# @param envelope_purge_configuration (optional parameter)
|
3667
3473
|
# @return [Array<(EnvelopePurgeConfiguration, Fixnum, Hash)>] EnvelopePurgeConfiguration data, response status code and response headers
|
@@ -3753,7 +3559,7 @@ module DocuSign_eSign
|
|
3753
3559
|
end
|
3754
3560
|
|
3755
3561
|
# Updates default user level settings for a specified account
|
3756
|
-
#
|
3562
|
+
# This method changes the default settings for the email notifications that signers and senders receive about envelopes.
|
3757
3563
|
# @param account_id The external account number (int) or account ID Guid.
|
3758
3564
|
# @param notification_defaults (optional parameter)
|
3759
3565
|
# @return [NotificationDefaults]
|
@@ -3763,7 +3569,7 @@ module DocuSign_eSign
|
|
3763
3569
|
end
|
3764
3570
|
|
3765
3571
|
# Updates default user level settings for a specified account
|
3766
|
-
#
|
3572
|
+
# This method changes the default settings for the email notifications that signers and senders receive about envelopes.
|
3767
3573
|
# @param account_id The external account number (int) or account ID Guid.
|
3768
3574
|
# @param notification_defaults (optional parameter)
|
3769
3575
|
# @return [Array<(NotificationDefaults, Fixnum, Hash)>] NotificationDefaults data, response status code and response headers
|
@@ -3804,7 +3610,7 @@ module DocuSign_eSign
|
|
3804
3610
|
end
|
3805
3611
|
|
3806
3612
|
# Update the password rules
|
3807
|
-
#
|
3613
|
+
# This method updates the password rules for an account. **Note:** To update the password rules for an account, you must be an account administrator.
|
3808
3614
|
# @param account_id The external account number (int) or account ID Guid.
|
3809
3615
|
# @param account_password_rules (optional parameter)
|
3810
3616
|
# @return [AccountPasswordRules]
|
@@ -3814,7 +3620,7 @@ module DocuSign_eSign
|
|
3814
3620
|
end
|
3815
3621
|
|
3816
3622
|
# Update the password rules
|
3817
|
-
#
|
3623
|
+
# This method updates the password rules for an account. **Note:** To update the password rules for an account, you must be an account administrator.
|
3818
3624
|
# @param account_id The external account number (int) or account ID Guid.
|
3819
3625
|
# @param account_password_rules (optional parameter)
|
3820
3626
|
# @return [Array<(AccountPasswordRules, Fixnum, Hash)>] AccountPasswordRules data, response status code and response headers
|
@@ -3855,7 +3661,7 @@ module DocuSign_eSign
|
|
3855
3661
|
end
|
3856
3662
|
|
3857
3663
|
# Updates a permission profile within the specified account.
|
3858
|
-
#
|
3664
|
+
# This method updates an account permission profile. ### Related topics - [How to update individual permission settings](/docs/esign-rest-api/how-to/permission-profile-updating/)
|
3859
3665
|
# @param account_id The external account number (int) or account ID Guid.
|
3860
3666
|
# @param permission_profile_id
|
3861
3667
|
# @param permission_profile (optional parameter)
|
@@ -3867,7 +3673,7 @@ module DocuSign_eSign
|
|
3867
3673
|
end
|
3868
3674
|
|
3869
3675
|
# Updates a permission profile within the specified account.
|
3870
|
-
#
|
3676
|
+
# This method updates an account permission profile. ### Related topics - [How to update individual permission settings](/docs/esign-rest-api/how-to/permission-profile-updating/)
|
3871
3677
|
# @param account_id The external account number (int) or account ID Guid.
|
3872
3678
|
# @param permission_profile_id
|
3873
3679
|
# @param permission_profile (optional parameter)
|
@@ -3912,162 +3718,6 @@ module DocuSign_eSign
|
|
3912
3718
|
return data, status_code, headers
|
3913
3719
|
end
|
3914
3720
|
|
3915
|
-
# Returns the result set from running the specified report
|
3916
|
-
#
|
3917
|
-
# @param account_id The external account number (int) or account ID Guid.
|
3918
|
-
# @param report_in_product_run_request (optional parameter)
|
3919
|
-
# @return [ReportInProductRunResponse]
|
3920
|
-
def update_report_in_product_run_results(account_id, report_in_product_run_request)
|
3921
|
-
data, _status_code, _headers = update_report_in_product_run_results_with_http_info(account_id, report_in_product_run_request)
|
3922
|
-
return data
|
3923
|
-
end
|
3924
|
-
|
3925
|
-
# Returns the result set from running the specified report
|
3926
|
-
#
|
3927
|
-
# @param account_id The external account number (int) or account ID Guid.
|
3928
|
-
# @param report_in_product_run_request (optional parameter)
|
3929
|
-
# @return [Array<(ReportInProductRunResponse, Fixnum, Hash)>] ReportInProductRunResponse data, response status code and response headers
|
3930
|
-
def update_report_in_product_run_results_with_http_info(account_id, report_in_product_run_request)
|
3931
|
-
if @api_client.config.debugging
|
3932
|
-
@api_client.config.logger.debug "Calling API: AccountsApi.update_report_in_product_run_results ..."
|
3933
|
-
end
|
3934
|
-
# verify the required parameter 'account_id' is set
|
3935
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_report_in_product_run_results" if account_id.nil?
|
3936
|
-
# resource path
|
3937
|
-
local_var_path = "/v2.1/accounts/{accountId}/reports/report_results".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
3938
|
-
|
3939
|
-
# query parameters
|
3940
|
-
query_params = {}
|
3941
|
-
|
3942
|
-
# header parameters
|
3943
|
-
header_params = {}
|
3944
|
-
# HTTP header 'Accept' (if needed)
|
3945
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
3946
|
-
|
3947
|
-
# form parameters
|
3948
|
-
form_params = {}
|
3949
|
-
|
3950
|
-
# http body (model)
|
3951
|
-
post_body = @api_client.object_to_http_body(report_in_product_run_request)
|
3952
|
-
auth_names = []
|
3953
|
-
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
3954
|
-
:header_params => header_params,
|
3955
|
-
:query_params => query_params,
|
3956
|
-
:form_params => form_params,
|
3957
|
-
:body => post_body,
|
3958
|
-
:auth_names => auth_names,
|
3959
|
-
:return_type => 'ReportInProductRunResponse')
|
3960
|
-
if @api_client.config.debugging
|
3961
|
-
@api_client.config.logger.debug "API called: AccountsApi#update_report_in_product_run_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
3962
|
-
end
|
3963
|
-
return data, status_code, headers
|
3964
|
-
end
|
3965
|
-
|
3966
|
-
# Saves a customized report
|
3967
|
-
#
|
3968
|
-
# @param account_id The external account number (int) or account ID Guid.
|
3969
|
-
# @param id
|
3970
|
-
# @param report_in_product_run_request (optional parameter)
|
3971
|
-
# @return [ReportInProductSaveResponse]
|
3972
|
-
def update_report_in_product_save(account_id, id, report_in_product_run_request)
|
3973
|
-
data, _status_code, _headers = update_report_in_product_save_with_http_info(account_id, id, report_in_product_run_request)
|
3974
|
-
return data
|
3975
|
-
end
|
3976
|
-
|
3977
|
-
# Saves a customized report
|
3978
|
-
#
|
3979
|
-
# @param account_id The external account number (int) or account ID Guid.
|
3980
|
-
# @param id
|
3981
|
-
# @param report_in_product_run_request (optional parameter)
|
3982
|
-
# @return [Array<(ReportInProductSaveResponse, Fixnum, Hash)>] ReportInProductSaveResponse data, response status code and response headers
|
3983
|
-
def update_report_in_product_save_with_http_info(account_id, id, report_in_product_run_request)
|
3984
|
-
if @api_client.config.debugging
|
3985
|
-
@api_client.config.logger.debug "Calling API: AccountsApi.update_report_in_product_save ..."
|
3986
|
-
end
|
3987
|
-
# verify the required parameter 'account_id' is set
|
3988
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_report_in_product_save" if account_id.nil?
|
3989
|
-
# verify the required parameter 'id' is set
|
3990
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling AccountsApi.update_report_in_product_save" if id.nil?
|
3991
|
-
# resource path
|
3992
|
-
local_var_path = "/v2.1/accounts/{accountId}/reports/{id}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'id' + '}', id.to_s)
|
3993
|
-
|
3994
|
-
# query parameters
|
3995
|
-
query_params = {}
|
3996
|
-
|
3997
|
-
# header parameters
|
3998
|
-
header_params = {}
|
3999
|
-
# HTTP header 'Accept' (if needed)
|
4000
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4001
|
-
|
4002
|
-
# form parameters
|
4003
|
-
form_params = {}
|
4004
|
-
|
4005
|
-
# http body (model)
|
4006
|
-
post_body = @api_client.object_to_http_body(report_in_product_run_request)
|
4007
|
-
auth_names = []
|
4008
|
-
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
4009
|
-
:header_params => header_params,
|
4010
|
-
:query_params => query_params,
|
4011
|
-
:form_params => form_params,
|
4012
|
-
:body => post_body,
|
4013
|
-
:auth_names => auth_names,
|
4014
|
-
:return_type => 'ReportInProductSaveResponse')
|
4015
|
-
if @api_client.config.debugging
|
4016
|
-
@api_client.config.logger.debug "API called: AccountsApi#update_report_in_product_save\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4017
|
-
end
|
4018
|
-
return data, status_code, headers
|
4019
|
-
end
|
4020
|
-
|
4021
|
-
# Returns the specified report as a CSV string
|
4022
|
-
#
|
4023
|
-
# @param account_id The external account number (int) or account ID Guid.
|
4024
|
-
# @param report_in_product_csv_run_request (optional parameter)
|
4025
|
-
# @return [nil]
|
4026
|
-
def update_report_results_csv(account_id, report_in_product_csv_run_request)
|
4027
|
-
update_report_results_csv_with_http_info(account_id, report_in_product_csv_run_request)
|
4028
|
-
return nil
|
4029
|
-
end
|
4030
|
-
|
4031
|
-
# Returns the specified report as a CSV string
|
4032
|
-
#
|
4033
|
-
# @param account_id The external account number (int) or account ID Guid.
|
4034
|
-
# @param report_in_product_csv_run_request (optional parameter)
|
4035
|
-
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
4036
|
-
def update_report_results_csv_with_http_info(account_id, report_in_product_csv_run_request)
|
4037
|
-
if @api_client.config.debugging
|
4038
|
-
@api_client.config.logger.debug "Calling API: AccountsApi.update_report_results_csv ..."
|
4039
|
-
end
|
4040
|
-
# verify the required parameter 'account_id' is set
|
4041
|
-
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_report_results_csv" if account_id.nil?
|
4042
|
-
# resource path
|
4043
|
-
local_var_path = "/v2.1/accounts/{accountId}/reports/report_results_csv".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
|
4044
|
-
|
4045
|
-
# query parameters
|
4046
|
-
query_params = {}
|
4047
|
-
|
4048
|
-
# header parameters
|
4049
|
-
header_params = {}
|
4050
|
-
# HTTP header 'Accept' (if needed)
|
4051
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
4052
|
-
|
4053
|
-
# form parameters
|
4054
|
-
form_params = {}
|
4055
|
-
|
4056
|
-
# http body (model)
|
4057
|
-
post_body = @api_client.object_to_http_body(report_in_product_csv_run_request)
|
4058
|
-
auth_names = []
|
4059
|
-
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
4060
|
-
:header_params => header_params,
|
4061
|
-
:query_params => query_params,
|
4062
|
-
:form_params => form_params,
|
4063
|
-
:body => post_body,
|
4064
|
-
:auth_names => auth_names)
|
4065
|
-
if @api_client.config.debugging
|
4066
|
-
@api_client.config.logger.debug "API called: AccountsApi#update_report_results_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
4067
|
-
end
|
4068
|
-
return data, status_code, headers
|
4069
|
-
end
|
4070
|
-
|
4071
3721
|
# Updates the account settings for an account.
|
4072
3722
|
# Updates the account settings for the specified account.
|
4073
3723
|
# @param account_id The external account number (int) or account ID Guid.
|