relentless_identity 1.0.0

data/lib/relentless_identity/api/jobs_api.rb

@@ -0,0 +1,535 @@
+=begin
+#Relentless Identity API
+
+#Public client API for Finder and Probe workflows. This spec is generated from the FastAPI app, then narrowed to the supported bearer-authenticated routes used by SDKs and the API reference.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'cgi'
+
+module RelentlessIdentity
+  class JobsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get background job
+    # Return the current status and paginated results for one background job.
+    # @param job_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :page_size  (default to 50)
+    # @return [ClientBackgroundJobDetailResponse]
+    def get_job(job_id, opts = {})
+      data, _status_code, _headers = get_job_with_http_info(job_id, opts)
+      data
+    end
+
+    # Get background job
+    # Return the current status and paginated results for one background job.
+    # @param job_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :page_size  (default to 50)
+    # @return [Array<(ClientBackgroundJobDetailResponse, Integer, Hash)>] ClientBackgroundJobDetailResponse data, response status code and response headers
+    def get_job_with_http_info(job_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: JobsApi.get_job ...'
+      end
+      # verify the required parameter 'job_id' is set
+      if @api_client.config.client_side_validation && job_id.nil?
+        fail ArgumentError, "Missing the required parameter 'job_id' when calling JobsApi.get_job"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling JobsApi.get_job, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling JobsApi.get_job, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling JobsApi.get_job, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/client/jobs/{job_id}'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ClientBackgroundJobDetailResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"JobsApi.get_job",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: JobsApi#get_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Download job inputs
+    # Return the original background job inputs as plain text when the payload is still retained.
+    # @param job_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_none_match 
+    # @option opts [String] :if_modified_since 
+    # @return [String]
+    def get_job_inputs_text(job_id, opts = {})
+      data, _status_code, _headers = get_job_inputs_text_with_http_info(job_id, opts)
+      data
+    end
+
+    # Download job inputs
+    # Return the original background job inputs as plain text when the payload is still retained.
+    # @param job_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_none_match 
+    # @option opts [String] :if_modified_since 
+    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
+    def get_job_inputs_text_with_http_info(job_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: JobsApi.get_job_inputs_text ...'
+      end
+      # verify the required parameter 'job_id' is set
+      if @api_client.config.client_side_validation && job_id.nil?
+        fail ArgumentError, "Missing the required parameter 'job_id' when calling JobsApi.get_job_inputs_text"
+      end
+      # resource path
+      local_var_path = '/client/jobs/{job_id}/inputs.txt'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json']) unless header_params['Accept']
+      header_params[:'if-none-match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?
+      header_params[:'if-modified-since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'String'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"JobsApi.get_job_inputs_text",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: JobsApi#get_job_inputs_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Download job results as JSON
+    # Return the canonical immutable background job results artifact as JSON.
+    # @param job_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_none_match 
+    # @option opts [String] :if_modified_since 
+    # @return [Object]
+    def get_job_results_json(job_id, opts = {})
+      data, _status_code, _headers = get_job_results_json_with_http_info(job_id, opts)
+      data
+    end
+
+    # Download job results as JSON
+    # Return the canonical immutable background job results artifact as JSON.
+    # @param job_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_none_match 
+    # @option opts [String] :if_modified_since 
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def get_job_results_json_with_http_info(job_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: JobsApi.get_job_results_json ...'
+      end
+      # verify the required parameter 'job_id' is set
+      if @api_client.config.client_side_validation && job_id.nil?
+        fail ArgumentError, "Missing the required parameter 'job_id' when calling JobsApi.get_job_results_json"
+      end
+      # resource path
+      local_var_path = '/client/jobs/{job_id}/results.json'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      header_params[:'if-none-match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?
+      header_params[:'if-modified-since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"JobsApi.get_job_results_json",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: JobsApi#get_job_results_json\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Download job results as text
+    # Return the canonical background job results in a readable plain-text format.
+    # @param job_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_none_match 
+    # @option opts [String] :if_modified_since 
+    # @return [String]
+    def get_job_results_text(job_id, opts = {})
+      data, _status_code, _headers = get_job_results_text_with_http_info(job_id, opts)
+      data
+    end
+
+    # Download job results as text
+    # Return the canonical background job results in a readable plain-text format.
+    # @param job_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :if_none_match 
+    # @option opts [String] :if_modified_since 
+    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
+    def get_job_results_text_with_http_info(job_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: JobsApi.get_job_results_text ...'
+      end
+      # verify the required parameter 'job_id' is set
+      if @api_client.config.client_side_validation && job_id.nil?
+        fail ArgumentError, "Missing the required parameter 'job_id' when calling JobsApi.get_job_results_text"
+      end
+      # resource path
+      local_var_path = '/client/jobs/{job_id}/results.txt'.sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json']) unless header_params['Accept']
+      header_params[:'if-none-match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?
+      header_params[:'if-modified-since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'String'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"JobsApi.get_job_results_text",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: JobsApi#get_job_results_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List background jobs
+    # Return the authenticated user's paginated background job history.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :page_size  (default to 25)
+    # @option opts [String] :job_type 
+    # @option opts [String] :status 
+    # @return [ClientBackgroundJobPageResponse]
+    def list_jobs(opts = {})
+      data, _status_code, _headers = list_jobs_with_http_info(opts)
+      data
+    end
+
+    # List background jobs
+    # Return the authenticated user&#39;s paginated background job history.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :page_size  (default to 25)
+    # @option opts [String] :job_type 
+    # @option opts [String] :status 
+    # @return [Array<(ClientBackgroundJobPageResponse, Integer, Hash)>] ClientBackgroundJobPageResponse data, response status code and response headers
+    def list_jobs_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: JobsApi.list_jobs ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling JobsApi.list_jobs, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling JobsApi.list_jobs, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling JobsApi.list_jobs, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["finder_batch", "probe_batch"]
+      if @api_client.config.client_side_validation && opts[:'job_type'] && !allowable_values.include?(opts[:'job_type'])
+        fail ArgumentError, "invalid value for \"job_type\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["queued", "processing", "completed", "failed", "canceled"]
+      if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
+        fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/client/jobs'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'job_type'] = opts[:'job_type'] if !opts[:'job_type'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ClientBackgroundJobPageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"JobsApi.list_jobs",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: JobsApi#list_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Schedule a finder batch
+    # Queue a background finder batch job with an optional deadline and callback URL.
+    # @param finder_batch_job_request [FinderBatchJobRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [ClientBackgroundJobResponse]
+    def schedule_finder_batch(finder_batch_job_request, opts = {})
+      data, _status_code, _headers = schedule_finder_batch_with_http_info(finder_batch_job_request, opts)
+      data
+    end
+
+    # Schedule a finder batch
+    # Queue a background finder batch job with an optional deadline and callback URL.
+    # @param finder_batch_job_request [FinderBatchJobRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ClientBackgroundJobResponse, Integer, Hash)>] ClientBackgroundJobResponse data, response status code and response headers
+    def schedule_finder_batch_with_http_info(finder_batch_job_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: JobsApi.schedule_finder_batch ...'
+      end
+      # verify the required parameter 'finder_batch_job_request' is set
+      if @api_client.config.client_side_validation && finder_batch_job_request.nil?
+        fail ArgumentError, "Missing the required parameter 'finder_batch_job_request' when calling JobsApi.schedule_finder_batch"
+      end
+      # resource path
+      local_var_path = '/client/jobs/finder'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(finder_batch_job_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ClientBackgroundJobResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"JobsApi.schedule_finder_batch",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: JobsApi#schedule_finder_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Schedule a probe batch
+    # Queue a background probe batch job with an optional deadline and callback URL.
+    # @param probe_batch_job_background_request [ProbeBatchJobBackgroundRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [ClientBackgroundJobResponse]
+    def schedule_probe_batch(probe_batch_job_background_request, opts = {})
+      data, _status_code, _headers = schedule_probe_batch_with_http_info(probe_batch_job_background_request, opts)
+      data
+    end
+
+    # Schedule a probe batch
+    # Queue a background probe batch job with an optional deadline and callback URL.
+    # @param probe_batch_job_background_request [ProbeBatchJobBackgroundRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ClientBackgroundJobResponse, Integer, Hash)>] ClientBackgroundJobResponse data, response status code and response headers
+    def schedule_probe_batch_with_http_info(probe_batch_job_background_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: JobsApi.schedule_probe_batch ...'
+      end
+      # verify the required parameter 'probe_batch_job_background_request' is set
+      if @api_client.config.client_side_validation && probe_batch_job_background_request.nil?
+        fail ArgumentError, "Missing the required parameter 'probe_batch_job_background_request' when calling JobsApi.schedule_probe_batch"
+      end
+      # resource path
+      local_var_path = '/client/jobs/probe-batch'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(probe_batch_job_background_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ClientBackgroundJobResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"JobsApi.schedule_probe_batch",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: JobsApi#schedule_probe_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/relentless_identity/api/probe_api.rb

@@ -0,0 +1,158 @@
+=begin
+#Relentless Identity API
+
+#Public client API for Finder and Probe workflows. This spec is generated from the FastAPI app, then narrowed to the supported bearer-authenticated routes used by SDKs and the API reference.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'cgi'
+
+module RelentlessIdentity
+  class ProbeApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Verify many email addresses
+    # Send many known email addresses and receive compact per-item identity results plus a batch summary.
+    # @param probe_batch_request [ProbeBatchRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [ClientBatchIdentityResponse]
+    def probe_batch(probe_batch_request, opts = {})
+      data, _status_code, _headers = probe_batch_with_http_info(probe_batch_request, opts)
+      data
+    end
+
+    # Verify many email addresses
+    # Send many known email addresses and receive compact per-item identity results plus a batch summary.
+    # @param probe_batch_request [ProbeBatchRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ClientBatchIdentityResponse, Integer, Hash)>] ClientBatchIdentityResponse data, response status code and response headers
+    def probe_batch_with_http_info(probe_batch_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProbeApi.probe_batch ...'
+      end
+      # verify the required parameter 'probe_batch_request' is set
+      if @api_client.config.client_side_validation && probe_batch_request.nil?
+        fail ArgumentError, "Missing the required parameter 'probe_batch_request' when calling ProbeApi.probe_batch"
+      end
+      # resource path
+      local_var_path = '/client/probe/batch'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(probe_batch_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ClientBatchIdentityResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProbeApi.probe_batch",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProbeApi#probe_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Verify an email address
+    # Send a single email address to verify it directly.
+    # @param probe_request [ProbeRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [ClientIdentityResponse]
+    def probe_email(probe_request, opts = {})
+      data, _status_code, _headers = probe_email_with_http_info(probe_request, opts)
+      data
+    end
+
+    # Verify an email address
+    # Send a single email address to verify it directly.
+    # @param probe_request [ProbeRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ClientIdentityResponse, Integer, Hash)>] ClientIdentityResponse data, response status code and response headers
+    def probe_email_with_http_info(probe_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProbeApi.probe_email ...'
+      end
+      # verify the required parameter 'probe_request' is set
+      if @api_client.config.client_side_validation && probe_request.nil?
+        fail ArgumentError, "Missing the required parameter 'probe_request' when calling ProbeApi.probe_email"
+      end
+      # resource path
+      local_var_path = '/client/probe'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(probe_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ClientIdentityResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProbeApi.probe_email",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProbeApi#probe_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end