Class: SurveyMonkeySwaggerClient::ErrorsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/survey_monkey_swagger_client/api/errors_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ErrorsApi

Returns a new instance of ErrorsApi.



16
17
18
 
# File 'lib/survey_monkey_swagger_client/api/errors_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/survey_monkey_swagger_client/api/errors_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get_error_by_id(opts = {}) ⇒ nil

Get error by id Returns the details of a known error

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


23
24
25
26
 
# File 'lib/survey_monkey_swagger_client/api/errors_api.rb', line 23

def get_error_by_id(opts = {})
  get_error_by_id_with_http_info(opts)
  nil
end

#get_error_by_id_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get error by id Returns the details of a known error

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/survey_monkey_swagger_client/api/errors_api.rb', line 32

def get_error_by_id_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ErrorsApi.get_error_by_id ...'
  end
  # resource path
  local_var_path = '/v3/errors/ERROR_ID'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type]

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ErrorsApi#get_error_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_list_of_known_errors(opts = {}) ⇒ nil

Get list of known errors Returns a list of known errors

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


71
72
73
74
 
# File 'lib/survey_monkey_swagger_client/api/errors_api.rb', line 71

def get_list_of_known_errors(opts = {})
  get_list_of_known_errors_with_http_info(opts)
  nil
end

#get_list_of_known_errors_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get list of known errors Returns a list of known errors

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/survey_monkey_swagger_client/api/errors_api.rb', line 80

def get_list_of_known_errors_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ErrorsApi.get_list_of_known_errors ...'
  end
  # resource path
  local_var_path = '/v3/errors'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body]

  return_type = opts[:return_type]

  auth_names = opts[: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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ErrorsApi#get_list_of_known_errors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end