docusign_esign 3.9.0.rc1 → 3.11.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '084cff2f571312d0f898545746a130b74ec93773dcb7a95c384d9f9956e7c1aa'
-  data.tar.gz: 8b5f4cdbb48ed66e085f27876ae3e90cf03246abc98928fecfeb7b3147c7cdc5
+  metadata.gz: 35c0d589a71f989a64001ab9fc4b93c278dcd26bffe5871dc64912fafb306578
+  data.tar.gz: f0e85fbaf9b98586a8c7c8488c6a1f47e3796b6510ef9fee82ab72f6b76bfa78
 SHA512:
-  metadata.gz: b01b33f4617f95e88ae471af0bbf1a940b30f12b7b4a6723726804d3c3f2fc86e66d138c4b02eca816b510cf0103e3157938079be98e6487b7480c89aca07130
-  data.tar.gz: c9d496714a622ff8ce87ebc596781d75ea8ae647e44f9d083bc6b2a85f883afdeb31f540f438953cfd0084ea870cccc1c40f204b56ec3aba8ebb1d93e8920e2d
+  metadata.gz: e930c67224f1f265ef166da4c23e85b5f913e24b66585cf65a93b0bf05e5ce3988964b59079b8900a0c383d8a1e03b99294b5cb36ea69e55b25848a24ffb2c9f
+  data.tar.gz: 1aad8291b1ab0ee7f3e9239b084de21da578732156b70d380a116e14d75f4f73be5191156c13ab71ba091fa3f39604fe925634a40577fadef730b058271e1084

data/CHANGELOG.md

@@ -3,6 +3,34 @@ All notable changes to this project will be documented in this file.
 
 See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
 
+## [v3.11.0-rc1] - eSignature API v2.1-21.2.00.00 - 2021-07-13
+### Added
+- Added new models and properties.
+### Changed
+- Added support for version v2.1-21.2.00.00 of the DocuSign eSignature API.
+- Updated the SDK release version.
+
+## [v3.10.0] - eSignature API v2.1-21.1.02.00 - 2021-06-04
+### Breaking
+- Removed methods `get_account_settings_export`,`get_seal_providers` from Accounts.
+- Removed methods `create_connect_secret`,`delete_connect_secret`,`generate_connect_secret`,`get_connect_secrets` from Connect.
+- Removed methods `create_page_info`, `create_pdf_blob`, `delete_custom_fields_0`, `delete_custom_fields_v2`, `delete_document`, `delete_page_info`, `delete_recipient_denied_document_copy`, `delete_signer_attachment`, `get_account`, `get_appliance_info`, `get_custom_fields`, `get_document_pages`, `get_dynamic_system_settings`, `get_image`, `get_locale_policy`, `get_pdf`, `get_pdf_blob`, `get_signer_attachment`, `get_tabs_blob`, `update_document`, `update_document_0`, `update_page_info`, `update_pdf`, `update_pdf_blob`, `update_recipient_denied_document_copy` from Envelopes.
+- Removed methods `complete_sign_hash`,`get_user_info`,`health_check`,`sign_hash_session_info`,`update_transaction` from TrustServiceProviders.
+- Removed methods `get_user_list_export` from Users.
+### Added
+- Added new methods `get_bulk_send_batch_envelopes` to BulkEnvelopes.
+### Changed
+- Added support for version v2.1-21.1.02.00 of the DocuSign eSignature API.
+- Updated the SDK release version.
+
+## [v3.9.0] - eSignature API v2.1-21.1.01.03 - 2021-04-25
+### Added
+- Added new methods `delete_custom_fields_v2`, `delete_page_info_v2`, `get_appliance_envelope_info`, `get_template_info` to envelopes.
+- Added new method `delete_connect_secret` to connect.
+### Changed
+- Added support for version v2.1-21.1.01.03 of the DocuSign eSignature API.
+- Updated the SDK release version.
+
 ## [v3.3.0] - eSignature API v2.1-20.1.02 - 2020-05-31
 ### Changed
 - Added support for version v2.1-20.1.02 of the DocuSign eSignature API.

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    docusign_esign (3.7.0.rc1)
-      addressable (~> 2.7, >= 2.7.0)
+    docusign_esign (3.10.0)
       json (~> 2.1, >= 2.1.0)
       jwt (~> 2.2, >= 2.2.1)
       typhoeus (~> 1.0, >= 1.0.1)
@@ -15,35 +14,37 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
-    autotest-fsevent (0.2.17)
+    autotest-fsevent (0.2.18)
       sys-uname
     autotest-growl (0.2.16)
     autotest-rails-pure (4.1.2)
-    crack (0.4.4)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.4.4)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
-    ffi (1.13.1)
+    ethon (0.14.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.1)
     hashdiff (1.0.1)
-    json (2.3.1)
-    jwt (2.2.2)
+    json (2.5.1)
+    jwt (2.2.3)
     public_suffix (4.0.6)
     rake (12.3.3)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.3)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.3)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.4)
-    sys-uname (1.2.1)
-      ffi (>= 1.0.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
     vcr (3.0.3)

data/lib/docusign_esign.rb

@@ -141,8 +141,6 @@ require 'docusign_esign/models/commission_expiration'
 require 'docusign_esign/models/commission_number'
 require 'docusign_esign/models/commission_state'
 require 'docusign_esign/models/company'
-require 'docusign_esign/models/complete_sign_hash_response'
-require 'docusign_esign/models/complete_sign_request'
 require 'docusign_esign/models/composite_template'
 require 'docusign_esign/models/conditional_recipient_rule'
 require 'docusign_esign/models/conditional_recipient_rule_condition'
@@ -168,7 +166,6 @@ require 'docusign_esign/models/contact_phone_number'
 require 'docusign_esign/models/contact_update_response'
 require 'docusign_esign/models/correct_view_request'
 require 'docusign_esign/models/country'
-require 'docusign_esign/models/credential'
 require 'docusign_esign/models/credit_card_information'
 require 'docusign_esign/models/credit_card_types'
 require 'docusign_esign/models/currency'
@@ -184,10 +181,6 @@ require 'docusign_esign/models/date_stamp_properties'
 require 'docusign_esign/models/decline'
 require 'docusign_esign/models/diagnostics_settings_information'
 require 'docusign_esign/models/direct_debit_processor_information'
-require 'docusign_esign/models/display_appliance_account'
-require 'docusign_esign/models/display_appliance_info'
-require 'docusign_esign/models/display_appliance_pdf'
-require 'docusign_esign/models/display_appliance_signer_attachment'
 require 'docusign_esign/models/dob_information_input'
 require 'docusign_esign/models/document'
 require 'docusign_esign/models/document_fields_information'
@@ -198,10 +191,8 @@ require 'docusign_esign/models/document_html_definition_originals'
 require 'docusign_esign/models/document_html_definitions'
 require 'docusign_esign/models/document_html_display_anchor'
 require 'docusign_esign/models/document_html_display_settings'
-require 'docusign_esign/models/document_security_store'
 require 'docusign_esign/models/document_template'
 require 'docusign_esign/models/document_template_list'
-require 'docusign_esign/models/document_update_info'
 require 'docusign_esign/models/document_visibility'
 require 'docusign_esign/models/document_visibility_list'
 require 'docusign_esign/models/downgrad_request_billing_info_response'
@@ -242,7 +233,6 @@ require 'docusign_esign/models/error_details'
 require 'docusign_esign/models/event_notification'
 require 'docusign_esign/models/event_result'
 require 'docusign_esign/models/expirations'
-require 'docusign_esign/models/external_claim'
 require 'docusign_esign/models/external_doc_service_error_details'
 require 'docusign_esign/models/external_document_sources'
 require 'docusign_esign/models/external_file'
@@ -349,6 +339,7 @@ require 'docusign_esign/models/power_form_senders_response'
 require 'docusign_esign/models/power_forms_form_data_response'
 require 'docusign_esign/models/power_forms_request'
 require 'docusign_esign/models/power_forms_response'
+require 'docusign_esign/models/prefill_form_data'
 require 'docusign_esign/models/prefill_tabs'
 require 'docusign_esign/models/proof_service_resource_token'
 require 'docusign_esign/models/proof_service_view_link'
@@ -380,6 +371,7 @@ require 'docusign_esign/models/recipient_sms_authentication'
 require 'docusign_esign/models/recipient_signature_information'
 require 'docusign_esign/models/recipient_signature_provider'
 require 'docusign_esign/models/recipient_signature_provider_options'
+require 'docusign_esign/models/recipient_token_client_ur_ls'
 require 'docusign_esign/models/recipient_update_response'
 require 'docusign_esign/models/recipient_view_request'
 require 'docusign_esign/models/recipients'
@@ -399,26 +391,20 @@ require 'docusign_esign/models/report_in_product_save_response'
 require 'docusign_esign/models/report_in_product_sent_by_details'
 require 'docusign_esign/models/resource_information'
 require 'docusign_esign/models/return_url_request'
-require 'docusign_esign/models/revision'
-require 'docusign_esign/models/seal'
 require 'docusign_esign/models/seal_identifier'
 require 'docusign_esign/models/seal_sign'
 require 'docusign_esign/models/seat_discount'
-require 'docusign_esign/models/sender'
+require 'docusign_esign/models/sender_company'
 require 'docusign_esign/models/sender_email_notifications'
+require 'docusign_esign/models/sender_name'
 require 'docusign_esign/models/server_template'
 require 'docusign_esign/models/service_information'
 require 'docusign_esign/models/service_version'
 require 'docusign_esign/models/settings_metadata'
 require 'docusign_esign/models/shared_item'
-require 'docusign_esign/models/sign_hash_document'
-require 'docusign_esign/models/sign_hash_session_info_response'
 require 'docusign_esign/models/sign_here'
-require 'docusign_esign/models/sign_session_info_request'
-require 'docusign_esign/models/signature_data_info'
 require 'docusign_esign/models/signature_group'
 require 'docusign_esign/models/signature_group_def'
-require 'docusign_esign/models/signature_properties'
 require 'docusign_esign/models/signature_provider_required_option'
 require 'docusign_esign/models/signature_type'
 require 'docusign_esign/models/signature_user'
@@ -461,18 +447,11 @@ require 'docusign_esign/models/template_tabs'
 require 'docusign_esign/models/template_update_summary'
 require 'docusign_esign/models/text'
 require 'docusign_esign/models/text_custom_field'
-require 'docusign_esign/models/time_stamp_field'
 require 'docusign_esign/models/title'
-require 'docusign_esign/models/tsp_health_check_request'
-require 'docusign_esign/models/tsp_health_check_status_description'
-require 'docusign_esign/models/update_transaction_request'
-require 'docusign_esign/models/update_transaction_response'
 require 'docusign_esign/models/usage_history'
-require 'docusign_esign/models/user'
 require 'docusign_esign/models/user_account_management_granular_information'
 require 'docusign_esign/models/user_info'
 require 'docusign_esign/models/user_info_list'
-require 'docusign_esign/models/user_info_response'
 require 'docusign_esign/models/user_information'
 require 'docusign_esign/models/user_information_list'
 require 'docusign_esign/models/user_password_information'
@@ -518,9 +497,9 @@ require 'docusign_esign/api/groups_api'
 require 'docusign_esign/api/notary_api'
 require 'docusign_esign/api/organizations_api'
 require 'docusign_esign/api/power_forms_api'
-require 'docusign_esign/api/signature_api'
 require 'docusign_esign/api/signing_groups_api'
 require 'docusign_esign/api/templates_api'
+require 'docusign_esign/api/trust_service_providers_api'
 require 'docusign_esign/api/users_api'
 require 'docusign_esign/api/workspaces_api'
 

data/lib/docusign_esign/api/accounts_api.rb

@@ -1276,58 +1276,6 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
-    # Retrieves an account settings comparison.
-    # 
-    # @param organization_id 
-    # @param result_id 
-    # @return [nil]
-    def get_account_settings_export(organization_id, result_id)
-      get_account_settings_export_with_http_info(organization_id, result_id)
-      return nil
-    end
-
-    # Retrieves an account settings comparison.
-    # 
-    # @param organization_id 
-    # @param result_id 
-    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def get_account_settings_export_with_http_info(organization_id, result_id)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: AccountsApi.get_account_settings_export ..."
-      end
-      # verify the required parameter 'organization_id' is set
-      fail ArgumentError, "Missing the required parameter 'organization_id' when calling AccountsApi.get_account_settings_export" if organization_id.nil?
-      # verify the required parameter 'result_id' is set
-      fail ArgumentError, "Missing the required parameter 'result_id' when calling AccountsApi.get_account_settings_export" if result_id.nil?
-      # resource path
-      local_var_path = "/v2.1/organization_exports/{organizationId}/account_settings/{resultId}".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s).sub('{' + 'resultId' + '}', result_id.to_s)
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = []
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AccountsApi#get_account_settings_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Returns information about a single signature by specifed signatureId.
     # 
     # @param account_id The external account number (int) or account ID Guid.
@@ -2522,55 +2470,6 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
-    # Returns Account available seals for specified account.
-    # 
-    # @param account_id The external account number (int) or account ID Guid.
-    # @return [AccountSeals]
-    def get_seal_providers(account_id)
-      data, _status_code, _headers = get_seal_providers_with_http_info(account_id)
-      return data
-    end
-
-    # Returns Account available seals for specified account.
-    # 
-    # @param account_id The external account number (int) or account ID Guid.
-    # @return [Array<(AccountSeals, Fixnum, Hash)>] AccountSeals data, response status code and response headers
-    def get_seal_providers_with_http_info(account_id)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: AccountsApi.get_seal_providers ..."
-      end
-      # verify the required parameter 'account_id' is set
-      fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_seal_providers" if account_id.nil?
-      # resource path
-      local_var_path = "/v2.1/accounts/{accountId}/seals".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = []
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'AccountSeals')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AccountsApi#get_seal_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Gets list of supported languages for recipient language setting.
     # 
     # @param account_id The external account number (int) or account ID Guid.

data/lib/docusign_esign/api/bulk_envelopes_api.rb

@@ -13,6 +13,36 @@ require "uri"
 
 module DocuSign_eSign
 
+  class GetBulkSendBatchEnvelopesOptions
+    # 
+    attr_accessor :count
+
+    # 
+    attr_accessor :include
+
+    # 
+    attr_accessor :order
+
+    # 
+    attr_accessor :order_by
+
+    # 
+    attr_accessor :search_text
+
+    # 
+    attr_accessor :start_position
+
+    # 
+    attr_accessor :status
+
+    # 
+    attr_accessor :user_id
+
+    def self.default
+      @@default ||= GetBulkSendBatchEnvelopesOptions.new
+    end
+  end
+
   class GetBulkSendBatchesOptions
     # 
     attr_accessor :batch_ids
@@ -256,6 +286,69 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
+    # Gets envelopes from a specific bulk send batch
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param bulk_send_batch_id 
+    # @param DocuSign_eSign::GetBulkSendBatchEnvelopesOptions Options for modifying the behavior of the function.
+    # @return [EnvelopesInformation]
+    def get_bulk_send_batch_envelopes(account_id, bulk_send_batch_id, options = DocuSign_eSign::GetBulkSendBatchEnvelopesOptions.default)
+      data, _status_code, _headers = get_bulk_send_batch_envelopes_with_http_info(account_id, bulk_send_batch_id, options)
+      return data
+    end
+
+    # Gets envelopes from a specific bulk send batch
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param bulk_send_batch_id 
+    # @param DocuSign_eSign::GetBulkSendBatchEnvelopesOptions Options for modifying the behavior of the function.
+    # @return [Array<(EnvelopesInformation, Fixnum, Hash)>] EnvelopesInformation data, response status code and response headers
+    def get_bulk_send_batch_envelopes_with_http_info(account_id, bulk_send_batch_id, options = DocuSign_eSign::GetBulkSendBatchEnvelopesOptions.default)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: BulkEnvelopesApi.get_bulk_send_batch_envelopes ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling BulkEnvelopesApi.get_bulk_send_batch_envelopes" if account_id.nil?
+      # verify the required parameter 'bulk_send_batch_id' is set
+      fail ArgumentError, "Missing the required parameter 'bulk_send_batch_id' when calling BulkEnvelopesApi.get_bulk_send_batch_envelopes" if bulk_send_batch_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/envelopes".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'bulkSendBatchId' + '}', bulk_send_batch_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'count'] = options.count if !options.count.nil?
+      query_params[:'include'] = options.include if !options.include.nil?
+      query_params[:'order'] = options.order if !options.order.nil?
+      query_params[:'order_by'] = options.order_by if !options.order_by.nil?
+      query_params[:'search_text'] = options.search_text if !options.search_text.nil?
+      query_params[:'start_position'] = options.start_position if !options.start_position.nil?
+      query_params[:'status'] = options.status if !options.status.nil?
+      query_params[:'user_id'] = options.user_id if !options.user_id.nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'EnvelopesInformation')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BulkEnvelopesApi#get_bulk_send_batch_envelopes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Gets a specific bulk send batch status
     # 
     # @param account_id The external account number (int) or account ID Guid.