Class: SurveyMonkeySwaggerClient::BenchmarksApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BenchmarksApi

Returns a new instance of BenchmarksApi.



16
17
18
 
# File 'lib/survey_monkey_swagger_client/api/benchmarks_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/benchmarks_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get_a_list_of_benchmark_bundles(opts = {}) ⇒ nil

Get a list of benchmark bundles Get a list of benchmark bundles that you have access to

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


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

def get_a_list_of_benchmark_bundles(opts = {})
  get_a_list_of_benchmark_bundles_with_http_info(opts)
  nil
end

#get_a_list_of_benchmark_bundles_details(bundle_id, opts = {}) ⇒ nil

Get a list of benchmark bundles details Returns the questions and details included in a given bundle

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


72
73
74
75
 
# File 'lib/survey_monkey_swagger_client/api/benchmarks_api.rb', line 72

def get_a_list_of_benchmark_bundles_details(bundle_id, opts = {})
  get_a_list_of_benchmark_bundles_details_with_http_info(bundle_id, opts)
  nil
end

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

Get a list of benchmark bundles details Returns the questions and details included in a given bundle

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
115
116
117
118
119
120
 
# File 'lib/survey_monkey_swagger_client/api/benchmarks_api.rb', line 82

def get_a_list_of_benchmark_bundles_details_with_http_info(bundle_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BenchmarksApi.get_a_list_of_benchmark_bundles_details ...'
  end
  # verify the required parameter 'bundle_id' is set
  if @api_client.config.client_side_validation && bundle_id.nil?
    fail ArgumentError, "Missing the required parameter 'bundle_id' when calling BenchmarksApi.get_a_list_of_benchmark_bundles_details"
  end
  # resource path
  local_var_path = '/v3/benchmark_bundles/{BUNDLE_ID}'.sub('{' + 'BUNDLE_ID' + '}', bundle_id.to_s)

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

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

Get a list of benchmark bundles Get a list of benchmark bundles that you have access to

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/benchmarks_api.rb', line 32

def get_a_list_of_benchmark_bundles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BenchmarksApi.get_a_list_of_benchmark_bundles ...'
  end
  # resource path
  local_var_path = '/v3/benchmark_bundles'

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

#get_bundle_benchmark(bundle_id, opts = {}) ⇒ nil

Get bundle benchmark Returns the benchmark for the given bundle

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


126
127
128
129
 
# File 'lib/survey_monkey_swagger_client/api/benchmarks_api.rb', line 126

def get_bundle_benchmark(bundle_id, opts = {})
  get_bundle_benchmark_with_http_info(bundle_id, opts)
  nil
end

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

Get bundle benchmark Returns the benchmark for the given bundle

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/survey_monkey_swagger_client/api/benchmarks_api.rb', line 136

def get_bundle_benchmark_with_http_info(bundle_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BenchmarksApi.get_bundle_benchmark ...'
  end
  # verify the required parameter 'bundle_id' is set
  if @api_client.config.client_side_validation && bundle_id.nil?
    fail ArgumentError, "Missing the required parameter 'bundle_id' when calling BenchmarksApi.get_bundle_benchmark"
  end
  # resource path
  local_var_path = '/v3/benchmark_bundles/{BUNDLE_ID}/analyze'.sub('{' + 'BUNDLE_ID' + '}', bundle_id.to_s)

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

#get_question_benchmark(page_id, question_id, opts = {}) ⇒ nil

Get question benchmark Get question benchmark

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


181
182
183
184
 
# File 'lib/survey_monkey_swagger_client/api/benchmarks_api.rb', line 181

def get_question_benchmark(page_id, question_id, opts = {})
  get_question_benchmark_with_http_info(page_id, question_id, opts)
  nil
end

#get_question_benchmark_with_http_info(page_id, question_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get question benchmark Get question benchmark

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/survey_monkey_swagger_client/api/benchmarks_api.rb', line 192

def get_question_benchmark_with_http_info(page_id, question_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BenchmarksApi.get_question_benchmark ...'
  end
  # verify the required parameter 'page_id' is set
  if @api_client.config.client_side_validation && page_id.nil?
    fail ArgumentError, "Missing the required parameter 'page_id' when calling BenchmarksApi.get_question_benchmark"
  end
  # verify the required parameter 'question_id' is set
  if @api_client.config.client_side_validation && question_id.nil?
    fail ArgumentError, "Missing the required parameter 'question_id' when calling BenchmarksApi.get_question_benchmark"
  end
  # resource path
  local_var_path = '/v3/surveys/310099766/pages/{PAGE_ID}/questions/{QUESTION_ID}/benchmark'.sub('{' + 'PAGE_ID' + '}', page_id.to_s).sub('{' + 'QUESTION_ID' + '}', question_id.to_s)

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