docusign_esign 3.4.0 → 3.5.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3de5916dc1403551ae02d000baaecc629a6ffd2a4a0738b68fecd334c2c70c81
-  data.tar.gz: 68660f9ecbbce7766bdaa0ee779a925d8cadca29481e3e2a81c556b20ce09615
+  metadata.gz: ddbae822f40e17387d8672234c4d997a3280ed87d90c8049f30792475c6f171e
+  data.tar.gz: 6464a41ee85cf611ee616cbabbd5ddd9a10f9eb7a6e2bb59b54d34d5dea99351
 SHA512:
-  metadata.gz: 7b1cbc46d63905d59e8b3caf46a50f43bfbf6a6c74bacbbf4b999de1a93cdfcbfbd1407beb2be862d36f54b911a425a206ce67fdc26d9e40301d742101fdaaaa
-  data.tar.gz: 32ee23469e4608d864b113b74f3eea417322eaee48bae022acc7ec9c4693850832c139e34e3f04ed1ce86539a8d20e143102432247d5be5c1038b3e075a1cee3
+  metadata.gz: 3cb2c5391b4ddc2cb0966dfa80d21c3c0700e72558aeb1b3dc490f3d5b90c46fe4c5a0cbaa060de9daf7d09f95c39c2f523cf4ed970605cc0518643dcd0b9a26
+  data.tar.gz: 3f5896d144c56442f4dd1fca3104787c1b685b1a00d82c04730c574ae32f87703a3a907dc8c44b3d5ea75a57c970da19446ee37c1fd545489e63a431d8637308

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    docusign_esign (3.4.0)
+      json (~> 2.1, >= 2.1.0)
+      jwt (~> 2.2, >= 2.2.1)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.12.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.17)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.4.4)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.13.1)
+    hashdiff (1.0.1)
+    json (2.3.1)
+    jwt (2.2.1)
+    public_suffix (4.0.5)
+    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.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    safe_yaml (1.0.5)
+    sys-uname (1.2.1)
+      ffi (>= 1.0.0)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.11)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  docusign_esign!
+  rake (~> 12.3.3)
+  rspec (~> 3.4, >= 3.4.0)
+  rspec-expectations (~> 3.8, >= 3.8.0)
+  rspec-mocks (~> 3.8, >= 3.8.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.17.2

data/lib/docusign_esign.rb

@@ -105,6 +105,10 @@ require 'docusign_esign/models/bulk_recipients_request'
 require 'docusign_esign/models/bulk_recipients_response'
 require 'docusign_esign/models/bulk_recipients_summary_response'
 require 'docusign_esign/models/bulk_recipients_update_response'
+require 'docusign_esign/models/bulk_send_batch_status'
+require 'docusign_esign/models/bulk_send_batch_summaries'
+require 'docusign_esign/models/bulk_send_batch_summary'
+require 'docusign_esign/models/bulk_send_error_status'
 require 'docusign_esign/models/bulk_send_request'
 require 'docusign_esign/models/bulk_send_response'
 require 'docusign_esign/models/bulk_send_test_response'
@@ -132,6 +136,9 @@ require 'docusign_esign/models/comment_thread'
 require 'docusign_esign/models/comments_publish'
 require 'docusign_esign/models/company'
 require 'docusign_esign/models/composite_template'
+require 'docusign_esign/models/conditional_recipient_rule'
+require 'docusign_esign/models/conditional_recipient_rule_condition'
+require 'docusign_esign/models/conditional_recipient_rule_filter'
 require 'docusign_esign/models/connect_config_results'
 require 'docusign_esign/models/connect_custom_configuration'
 require 'docusign_esign/models/connect_debug_log'
@@ -333,14 +340,18 @@ require 'docusign_esign/models/recipient_domain'
 require 'docusign_esign/models/recipient_email_notification'
 require 'docusign_esign/models/recipient_event'
 require 'docusign_esign/models/recipient_form_data'
+require 'docusign_esign/models/recipient_group'
 require 'docusign_esign/models/recipient_identity_input_option'
 require 'docusign_esign/models/recipient_identity_phone_number'
 require 'docusign_esign/models/recipient_identity_verification'
 require 'docusign_esign/models/recipient_names_response'
+require 'docusign_esign/models/recipient_option'
 require 'docusign_esign/models/recipient_phone_authentication'
 require 'docusign_esign/models/recipient_phone_number'
 require 'docusign_esign/models/recipient_preview_request'
 require 'docusign_esign/models/recipient_proof_file'
+require 'docusign_esign/models/recipient_routing'
+require 'docusign_esign/models/recipient_rules'
 require 'docusign_esign/models/recipient_sms_authentication'
 require 'docusign_esign/models/recipient_signature_information'
 require 'docusign_esign/models/recipient_signature_provider'
@@ -351,6 +362,17 @@ require 'docusign_esign/models/recipients'
 require 'docusign_esign/models/recipients_update_summary'
 require 'docusign_esign/models/referral_information'
 require 'docusign_esign/models/reminders'
+require 'docusign_esign/models/report_in_product_csv_run_request'
+require 'docusign_esign/models/report_in_product_field'
+require 'docusign_esign/models/report_in_product_get'
+require 'docusign_esign/models/report_in_product_list'
+require 'docusign_esign/models/report_in_product_list_item'
+require 'docusign_esign/models/report_in_product_run_request'
+require 'docusign_esign/models/report_in_product_run_response'
+require 'docusign_esign/models/report_in_product_run_response_row'
+require 'docusign_esign/models/report_in_product_run_response_row_fields'
+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/seal_identifier'
@@ -424,6 +446,8 @@ require 'docusign_esign/models/view'
 require 'docusign_esign/models/view_url'
 require 'docusign_esign/models/watermark'
 require 'docusign_esign/models/witness'
+require 'docusign_esign/models/workflow'
+require 'docusign_esign/models/workflow_step'
 require 'docusign_esign/models/workspace'
 require 'docusign_esign/models/workspace_folder_contents'
 require 'docusign_esign/models/workspace_item'

data/lib/docusign_esign/api/accounts_api.rb

@@ -438,6 +438,57 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
+    # Creates a customized report
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param report_in_product_run_request  (optional parameter)
+    # @return [ReportInProductSaveResponse]
+    def create_report_in_product_create(account_id, report_in_product_run_request)
+      data, _status_code, _headers = create_report_in_product_create_with_http_info(account_id,  report_in_product_run_request)
+      return data
+    end
+
+    # Creates a customized report
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param report_in_product_run_request  (optional parameter)
+    # @return [Array<(ReportInProductSaveResponse, Fixnum, Hash)>] ReportInProductSaveResponse data, response status code and response headers
+    def create_report_in_product_create_with_http_info(account_id, report_in_product_run_request)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AccountsApi.create_report_in_product_create ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.create_report_in_product_create" if account_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/reports".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 = @api_client.object_to_http_body(report_in_product_run_request)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ReportInProductSaveResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountsApi#create_report_in_product_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Deletes the specified account.
     # This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.
     # @param account_id The external account number (int) or account ID Guid.
@@ -858,6 +909,59 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
+    # Removes a customized report
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param id 
+    # @return [ReportInProductSaveResponse]
+    def delete_report_in_product(account_id, id)
+      data, _status_code, _headers = delete_report_in_product_with_http_info(account_id, id)
+      return data
+    end
+
+    # Removes a customized report
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param id 
+    # @return [Array<(ReportInProductSaveResponse, Fixnum, Hash)>] ReportInProductSaveResponse data, response status code and response headers
+    def delete_report_in_product_with_http_info(account_id, id)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AccountsApi.delete_report_in_product ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_report_in_product" if account_id.nil?
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling AccountsApi.delete_report_in_product" if id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/reports/{id}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'id' + '}', 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(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ReportInProductSaveResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountsApi#delete_report_in_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get the list of identity verification options for an account
     # 
     # @param account_id The external account number (int) or account ID Guid.
@@ -1884,6 +1988,108 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
+    # Gets the specified report
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param id 
+    # @return [ReportInProductGet]
+    def get_report_in_product(account_id, id)
+      data, _status_code, _headers = get_report_in_product_with_http_info(account_id, id)
+      return data
+    end
+
+    # Gets the specified report
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param id 
+    # @return [Array<(ReportInProductGet, Fixnum, Hash)>] ReportInProductGet data, response status code and response headers
+    def get_report_in_product_with_http_info(account_id, id)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AccountsApi.get_report_in_product ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_report_in_product" if account_id.nil?
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling AccountsApi.get_report_in_product" if id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/reports/{id}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'id' + '}', 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 => 'ReportInProductGet')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountsApi#get_report_in_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Gets the descriptors for all of an account's active reports (for listings)
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @return [ReportInProductList]
+    def get_report_in_product_list(account_id)
+      data, _status_code, _headers = get_report_in_product_list_with_http_info(account_id)
+      return data
+    end
+
+    # Gets the descriptors for all of an account&#39;s active reports (for listings)
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @return [Array<(ReportInProductList, Fixnum, Hash)>] ReportInProductList data, response status code and response headers
+    def get_report_in_product_list_with_http_info(account_id)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AccountsApi.get_report_in_product_list ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_report_in_product_list" if account_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/reports".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 => 'ReportInProductList')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountsApi#get_report_in_product_list\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.
@@ -3150,6 +3356,162 @@ module DocuSign_eSign
       return data, status_code, headers
     end
 
+    # Returns the result set from running the specified report
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param report_in_product_run_request  (optional parameter)
+    # @return [ReportInProductRunResponse]
+    def update_report_in_product_run_results(account_id, report_in_product_run_request)
+      data, _status_code, _headers = update_report_in_product_run_results_with_http_info(account_id,  report_in_product_run_request)
+      return data
+    end
+
+    # Returns the result set from running the specified report
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param report_in_product_run_request  (optional parameter)
+    # @return [Array<(ReportInProductRunResponse, Fixnum, Hash)>] ReportInProductRunResponse data, response status code and response headers
+    def update_report_in_product_run_results_with_http_info(account_id, report_in_product_run_request)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AccountsApi.update_report_in_product_run_results ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_report_in_product_run_results" if account_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/reports/report_results".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 = @api_client.object_to_http_body(report_in_product_run_request)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ReportInProductRunResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountsApi#update_report_in_product_run_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Saves a customized report
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param id 
+    # @param report_in_product_run_request  (optional parameter)
+    # @return [ReportInProductSaveResponse]
+    def update_report_in_product_save(account_id, id, report_in_product_run_request)
+      data, _status_code, _headers = update_report_in_product_save_with_http_info(account_id, id,  report_in_product_run_request)
+      return data
+    end
+
+    # Saves a customized report
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param id 
+    # @param report_in_product_run_request  (optional parameter)
+    # @return [Array<(ReportInProductSaveResponse, Fixnum, Hash)>] ReportInProductSaveResponse data, response status code and response headers
+    def update_report_in_product_save_with_http_info(account_id, id, report_in_product_run_request)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AccountsApi.update_report_in_product_save ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_report_in_product_save" if account_id.nil?
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling AccountsApi.update_report_in_product_save" if id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/reports/{id}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'id' + '}', 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 = @api_client.object_to_http_body(report_in_product_run_request)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ReportInProductSaveResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountsApi#update_report_in_product_save\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns the specified report as a CSV string
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param report_in_product_csv_run_request  (optional parameter)
+    # @return [nil]
+    def update_report_results_csv(account_id, report_in_product_csv_run_request)
+      update_report_results_csv_with_http_info(account_id,  report_in_product_csv_run_request)
+      return nil
+    end
+
+    # Returns the specified report as a CSV string
+    # 
+    # @param account_id The external account number (int) or account ID Guid.
+    # @param report_in_product_csv_run_request  (optional parameter)
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def update_report_results_csv_with_http_info(account_id, report_in_product_csv_run_request)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AccountsApi.update_report_results_csv ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_report_results_csv" if account_id.nil?
+      # resource path
+      local_var_path = "/v2.1/accounts/{accountId}/reports/report_results_csv".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 = @api_client.object_to_http_body(report_in_product_csv_run_request)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:PUT, 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#update_report_results_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Updates the account settings for an account.
     # Updates the account settings for the specified account.
     # @param account_id The external account number (int) or account ID Guid.