Class: SurveyMonkeySwaggerClient::SurveysPagesAndQuestionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SurveysPagesAndQuestionsApi

Returns a new instance of SurveysPagesAndQuestionsApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Create a question Create a new question on a survey page

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


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

def create_a_question(page_id, opts = {})
  create_a_question_with_http_info(page_id, opts)
  nil
end

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

Create a question Create a new question on a survey page

Parameters:

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

    the optional parameters

Options Hash (opts):

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
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 36

def create_a_question_with_http_info(page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveysPagesAndQuestionsApi.create_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 SurveysPagesAndQuestionsApi.create_a_question"
  end
  # resource path
  local_var_path = '/v3/surveys/310099766/pages/{PAGE_ID}/questions'.sub('{' + 'PAGE_ID' + '}', page_id.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])

  return_type = opts[:return_type]

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, 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: SurveysPagesAndQuestionsApi#create_a_question\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_a_survey(opts = {}) ⇒ InlineResponse201

Create a survey Create a new empty survey, if a template id or an existing survey id is specified, a survey prepopulated with pages and questions

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



82
83
84
85
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 82

def create_a_survey(opts = {})
  data, _status_code, _headers = create_a_survey_with_http_info(opts)
  data
end

#create_a_survey_pages(opts = {}) ⇒ nil

Create a survey pages Create a new empty page

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


136
137
138
139
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 136

def create_a_survey_pages(opts = {})
  create_a_survey_pages_with_http_info(opts)
  nil
end

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

Create a survey pages Create a new empty page

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



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
181
182
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 146

def create_a_survey_pages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveysPagesAndQuestionsApi.create_a_survey_pages ...'
  end
  # resource path
  local_var_path = '/v3/surveys/310099766/pages'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])

  return_type = opts[:return_type]

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, 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: SurveysPagesAndQuestionsApi#create_a_survey_pages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_a_survey_with_http_info(opts = {}) ⇒ Array<(InlineResponse201, Integer, Hash)>

Create a survey Create a new empty survey, if a template id or an existing survey id is specified, a survey prepopulated with pages and questions

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    InlineResponse201 data, 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
127
128
129
130
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 92

def create_a_survey_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveysPagesAndQuestionsApi.create_a_survey ...'
  end
  # resource path
  local_var_path = '/v3/surveys'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])

  return_type = opts[:return_type] || 'InlineResponse201'

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, 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: SurveysPagesAndQuestionsApi#create_a_survey\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete a page Delete a page

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


188
189
190
191
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 188

def delete_a_page(page_id, opts = {})
  delete_a_page_with_http_info(page_id, opts)
  nil
end

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

Delete a page Delete a page

Parameters:

  • page_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
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 198

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

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

Delete a question Delete a question

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


243
244
245
246
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 243

def delete_a_question(page_id, question_id, opts = {})
  delete_a_question_with_http_info(page_id, question_id, opts)
  nil
end

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

Delete a question Delete 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



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
289
290
291
292
293
294
295
296
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 254

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

#delete_a_survey(opts = {}) ⇒ nil

Delete a survey Delete a survey

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


301
302
303
304
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 301

def delete_a_survey(opts = {})
  delete_a_survey_with_http_info(opts)
  nil
end

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

Delete a survey Delete a survey

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
343
344
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 310

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

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

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

Get a page detail Get a page’s details

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


350
351
352
353
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 350

def get_a_page_detail(page_id, opts = {})
  get_a_page_detail_with_http_info(page_id, opts)
  nil
end

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

Get a page detail Get a page&#x27;s details

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 360

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

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

Get a question detail Get a question’s details

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


405
406
407
408
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 405

def get_a_question_detail(page_id, question_id, opts = {})
  get_a_question_detail_with_http_info(page_id, question_id, opts)
  nil
end

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

Get a question detail Get a question&#x27;s details

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 416

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

#get_a_survey(opts = {}) ⇒ nil

Get a survey Returns a survey’s details. To get an expanded version showing all pages and questions use /surveys/survey_id/details

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


463
464
465
466
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 463

def get_a_survey(opts = {})
  get_a_survey_with_http_info(opts)
  nil
end

#get_a_survey_details(opts = {}) ⇒ nil

Get a survey details

Return an expanded survey resource with a pages element containing a list of all page objects, each containing a list of questions objects

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


511
512
513
514
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 511

def get_a_survey_details(opts = {})
  get_a_survey_details_with_http_info(opts)
  nil
end

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

Get a survey details

Return an expanded survey resource with a pages element containing a list of all page objects, each containing a list of questions objects

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 520

def get_a_survey_details_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveysPagesAndQuestionsApi.get_a_survey_details ...'
  end
  # resource path
  local_var_path = '/v3/surveys/310099766/details'

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

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

Get a survey Returns a survey&#x27;s details. To get an expanded version showing all pages and questions use /surveys/survey_id/details

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 472

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

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

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

Get list of questions Get a list of questions on a survey page

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


560
561
562
563
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 560

def get_list_of_questions(page_id, opts = {})
  get_list_of_questions_with_http_info(page_id, opts)
  nil
end

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

Get list of questions Get a list of questions on 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



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 570

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

#get_survey_categories(opts = {}) ⇒ nil

Get survey categories Get a list of survey categories that can be used to filter survey templates

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


613
614
615
616
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 613

def get_survey_categories(opts = {})
  get_survey_categories_with_http_info(opts)
  nil
end

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

Get survey categories Get a list of survey categories that can be used to filter survey templates

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 622

def get_survey_categories_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveysPagesAndQuestionsApi.get_survey_categories ...'
  end
  # resource path
  local_var_path = '/v3/survey_categories'

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

#get_survey_pages(opts = {}) ⇒ nil

Get survey pages Get a list of survey pages

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


661
662
663
664
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 661

def get_survey_pages(opts = {})
  get_survey_pages_with_http_info(opts)
  nil
end

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

Get survey pages Get a list of survey pages

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 670

def get_survey_pages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveysPagesAndQuestionsApi.get_survey_pages ...'
  end
  # resource path
  local_var_path = '/v3/surveys/310099766/pages'

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

#get_survey_template(opts = {}) ⇒ InlineResponse200

Get survey template Get a list of survey templates. Survey template ids can be used as an argument to POST a new survey

Parameters:

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

    the optional parameters

Returns:



709
710
711
712
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 709

def get_survey_template(opts = {})
  data, _status_code, _headers = get_survey_template_with_http_info(opts)
  data
end

#get_survey_template_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Get survey template Get a list of survey templates. Survey template ids can be used as an argument to POST a new survey

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse200 data, response status code and response headers



718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 718

def get_survey_template_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveysPagesAndQuestionsApi.get_survey_template ...'
  end
  # resource path
  local_var_path = '/v3/survey_templates'

  # 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'])

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

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

  return_type = opts[:return_type] || 'InlineResponse200'

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

#get_surveys(opts = {}) ⇒ nil

Get surveys Return a list of surveys owned or shared with the authenticated user

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


759
760
761
762
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 759

def get_surveys(opts = {})
  get_surveys_with_http_info(opts)
  nil
end

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

Get surveys Return a list of surveys owned or shared with the authenticated user

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 768

def get_surveys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveysPagesAndQuestionsApi.get_surveys ...'
  end
  # resource path
  local_var_path = '/v3/surveys'

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

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

Modify a page Modify a page

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


809
810
811
812
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 809

def modify_a_page(page_id, opts = {})
  modify_a_page_with_http_info(page_id, opts)
  nil
end

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

Modify a page Modify a page

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 820

def modify_a_page_with_http_info(page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveysPagesAndQuestionsApi.modify_a_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 SurveysPagesAndQuestionsApi.modify_a_page"
  end
  # resource path
  local_var_path = '/v3/surveys/310099766/pages/{PAGE_ID}'.sub('{' + 'PAGE_ID' + '}', page_id.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])

  return_type = opts[:return_type]

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PATCH, 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: SurveysPagesAndQuestionsApi#modify_a_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#modify_a_survey(opts = {}) ⇒ nil

Modify a survey Modifies a survey’s title or language

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


866
867
868
869
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 866

def modify_a_survey(opts = {})
  modify_a_survey_with_http_info(opts)
  nil
end

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

Modify a survey Modifies a survey’s title or language

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 876

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])

  return_type = opts[:return_type]

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PATCH, 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: SurveysPagesAndQuestionsApi#modify_a_survey\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Replace a page Replace a page

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


919
920
921
922
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 919

def replace_a_page(page_id, opts = {})
  replace_a_page_with_http_info(page_id, opts)
  nil
end

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

Replace a page Replace a page

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 930

def replace_a_page_with_http_info(page_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveysPagesAndQuestionsApi.replace_a_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 SurveysPagesAndQuestionsApi.replace_a_page"
  end
  # resource path
  local_var_path = '/v3/surveys/310099766/pages/{PAGE_ID}'.sub('{' + 'PAGE_ID' + '}', page_id.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])

  return_type = opts[:return_type]

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, 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: SurveysPagesAndQuestionsApi#replace_a_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Replace a question Replace a question

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


978
979
980
981
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 978

def replace_a_question(page_id, question_id, opts = {})
  replace_a_question_with_http_info(page_id, question_id, opts)
  nil
end

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

Replace a question Replace a question

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 990

def replace_a_question_with_http_info(page_id, question_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveysPagesAndQuestionsApi.replace_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 SurveysPagesAndQuestionsApi.replace_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 SurveysPagesAndQuestionsApi.replace_a_question"
  end
  # resource path
  local_var_path = '/v3/surveys/310099766/pages/{PAGE_ID}/questions/{QUESTION_ID}'.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] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])

  return_type = opts[:return_type]

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, 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: SurveysPagesAndQuestionsApi#replace_a_question\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replace_a_survey(opts = {}) ⇒ nil

Replace a survey Replace a survey

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1040
1041
1042
1043
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 1040

def replace_a_survey(opts = {})
  replace_a_survey_with_http_info(opts)
  nil
end

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

Replace a survey Replace a survey

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 1050

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])

  return_type = opts[:return_type]

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, 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: SurveysPagesAndQuestionsApi#replace_a_survey\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a question Updates a question

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1094
1095
1096
1097
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 1094

def update_a_question(page_id, question_id, opts = {})
  update_a_question_with_http_info(page_id, question_id, opts)
  nil
end

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

Update a question Updates a question

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
 
# File 'lib/survey_monkey_swagger_client/api/surveys_pages_and_questions_api.rb', line 1106

def update_a_question_with_http_info(page_id, question_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveysPagesAndQuestionsApi.update_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 SurveysPagesAndQuestionsApi.update_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 SurveysPagesAndQuestionsApi.update_a_question"
  end
  # resource path
  local_var_path = '/v3/surveys/310099766/pages/{PAGE_ID}/questions/{QUESTION_ID}'.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] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])

  return_type = opts[:return_type]

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PATCH, 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: SurveysPagesAndQuestionsApi#update_a_question\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end