Class: SurveyMonkeySwaggerClient::ResponseCountsAndTrendsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ResponseCountsAndTrendsApi

Returns a new instance of ResponseCountsAndTrendsApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Get rollups for a question Get rollups for a question

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


25
26
27
28
 
# File 'lib/survey_monkey_swagger_client/api/response_counts_and_trends_api.rb', line 25

def get_rollups_for_a_question(page_id, question_id, opts = {})
  get_rollups_for_a_question_with_http_info(page_id, question_id, opts)
  nil
end

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

Get rollups for a question Get rollups for a question

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/survey_monkey_swagger_client/api/response_counts_and_trends_api.rb', line 36

def get_rollups_for_a_question_with_http_info(page_id, question_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResponseCountsAndTrendsApi.get_rollups_for_a_question ...'
  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 ResponseCountsAndTrendsApi.get_rollups_for_a_question"
  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 ResponseCountsAndTrendsApi.get_rollups_for_a_question"
  end
  # resource path
  local_var_path = '/v3/surveys/310099766/pages/{PAGE_ID}/questions/{QUESTION_ID}/rollups'.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: ResponseCountsAndTrendsApi#get_rollups_for_a_question\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_rollups_for_a_survey(opts = {}) ⇒ nil

Get rollups for a survey Get rollups for a survey

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


83
84
85
86
 
# File 'lib/survey_monkey_swagger_client/api/response_counts_and_trends_api.rb', line 83

def get_rollups_for_a_survey(opts = {})
  get_rollups_for_a_survey_with_http_info(opts)
  nil
end

#get_rollups_for_a_survey_page(page_id, opts = {}) ⇒ nil

Get rollups for a survey page Get rollups for a survey page

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


132
133
134
135
 
# File 'lib/survey_monkey_swagger_client/api/response_counts_and_trends_api.rb', line 132

def get_rollups_for_a_survey_page(page_id, opts = {})
  get_rollups_for_a_survey_page_with_http_info(page_id, opts)
  nil
end

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

Get rollups for a survey page Get rollups for a survey page

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
175
176
177
178
179
180
 
# File 'lib/survey_monkey_swagger_client/api/response_counts_and_trends_api.rb', line 142

def get_rollups_for_a_survey_page_with_http_info(page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResponseCountsAndTrendsApi.get_rollups_for_a_survey_page ...'
  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 ResponseCountsAndTrendsApi.get_rollups_for_a_survey_page"
  end
  # resource path
  local_var_path = '/v3/surveys/310099766/pages/{PAGE_ID}/rollups'.sub('{' + 'PAGE_ID' + '}', page_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: ResponseCountsAndTrendsApi#get_rollups_for_a_survey_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get rollups for a survey Get rollups for a survey

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
121
122
123
124
125
126
 
# File 'lib/survey_monkey_swagger_client/api/response_counts_and_trends_api.rb', line 92

def get_rollups_for_a_survey_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResponseCountsAndTrendsApi.get_rollups_for_a_survey ...'
  end
  # resource path
  local_var_path = '/v3/surveys/310099766/rollups'

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

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

Get trends for a question Get trends for a question

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


187
188
189
190
 
# File 'lib/survey_monkey_swagger_client/api/response_counts_and_trends_api.rb', line 187

def get_trends_for_a_question(page_id, question_id, opts = {})
  get_trends_for_a_question_with_http_info(page_id, question_id, opts)
  nil
end

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

Get trends for a question Get trends for a question

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
235
236
237
238
239
240
 
# File 'lib/survey_monkey_swagger_client/api/response_counts_and_trends_api.rb', line 198

def get_trends_for_a_question_with_http_info(page_id, question_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResponseCountsAndTrendsApi.get_trends_for_a_question ...'
  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 ResponseCountsAndTrendsApi.get_trends_for_a_question"
  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 ResponseCountsAndTrendsApi.get_trends_for_a_question"
  end
  # resource path
  local_var_path = '/v3/surveys/310099766/pages/{PAGE_ID}/questions/{QUESTION_ID}/trends'.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: ResponseCountsAndTrendsApi#get_trends_for_a_question\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_trends_for_a_survey(opts = {}) ⇒ nil

Get trends for a survey Get trends for a survey

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


245
246
247
248
 
# File 'lib/survey_monkey_swagger_client/api/response_counts_and_trends_api.rb', line 245

def get_trends_for_a_survey(opts = {})
  get_trends_for_a_survey_with_http_info(opts)
  nil
end

#get_trends_for_a_survey_page(page_id, opts = {}) ⇒ nil

Get trends for a survey page Get trends for a survey page

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


294
295
296
297
 
# File 'lib/survey_monkey_swagger_client/api/response_counts_and_trends_api.rb', line 294

def get_trends_for_a_survey_page(page_id, opts = {})
  get_trends_for_a_survey_page_with_http_info(page_id, opts)
  nil
end

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

Get trends for a survey page Get trends for a survey page

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/survey_monkey_swagger_client/api/response_counts_and_trends_api.rb', line 304

def get_trends_for_a_survey_page_with_http_info(page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResponseCountsAndTrendsApi.get_trends_for_a_survey_page ...'
  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 ResponseCountsAndTrendsApi.get_trends_for_a_survey_page"
  end
  # resource path
  local_var_path = '/v3/surveys/310099766/pages/{PAGE_ID}/trends'.sub('{' + 'PAGE_ID' + '}', page_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: ResponseCountsAndTrendsApi#get_trends_for_a_survey_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get trends for a survey Get trends for a survey

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/survey_monkey_swagger_client/api/response_counts_and_trends_api.rb', line 254

def get_trends_for_a_survey_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResponseCountsAndTrendsApi.get_trends_for_a_survey ...'
  end
  # resource path
  local_var_path = '/v3/surveys/310099766/trends'

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