class SamplifyAPIClient::RespondentApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/samplify_api_client/api/respondent_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

respondent_entry(opts = {}) click to toggle source

entry respondent @param [Hash] opts the optional parameters @return [nil]

# File lib/samplify_api_client/api/respondent_api.rb, line 25
def respondent_entry(opts = {})
  respondent_entry_with_http_info(opts)
  nil
end
respondent_entry_with_http_info(opts = {}) click to toggle source

entry respondent @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/samplify_api_client/api/respondent_api.rb, line 33
def respondent_entry_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RespondentApi.respondent_entry ...'
  end
  # resource path
  local_var_path = '/respondent/entry'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/html', 'text/plain'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/xml', 'application/gob', 'application/x-gob'])

  # 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: RespondentApi#respondent_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
respondent_exit(opts = {}) click to toggle source

exit respondent @param [Hash] opts the optional parameters @return [nil]

# File lib/samplify_api_client/api/respondent_api.rb, line 70
def respondent_exit(opts = {})
  respondent_exit_with_http_info(opts)
  nil
end
respondent_exit_with_http_info(opts = {}) click to toggle source

exit respondent @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/samplify_api_client/api/respondent_api.rb, line 78
def respondent_exit_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RespondentApi.respondent_exit ...'
  end
  # resource path
  local_var_path = '/respondent/exit'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/html', 'text/plain'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/xml', 'application/gob', 'application/x-gob'])

  # 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: RespondentApi#respondent_exit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end