Class: SurveyMonkeySwaggerClient::SurveyResponsesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SurveyResponsesApi

Returns a new instance of SurveyResponsesApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_a_response(collector_id, opts = {}) ⇒ nil

Create a response Create a list of responses

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


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

def create_a_response(collector_id, opts = {})
  create_a_response_with_http_info(collector_id, opts)
  nil
end

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

Create a response Create a list of responses

Parameters:

  • collector_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/survey_responses_api.rb', line 36

def create_a_response_with_http_info(collector_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveyResponsesApi.create_a_response ...'
  end
  # verify the required parameter 'collector_id' is set
  if @api_client.config.client_side_validation && collector_id.nil?
    fail ArgumentError, "Missing the required parameter 'collector_id' when calling SurveyResponsesApi.create_a_response"
  end
  # resource path
  local_var_path = '/v3/collectors/{COLLECTOR_ID}/responses'.sub('{' + 'COLLECTOR_ID' + '}', collector_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: SurveyResponsesApi#create_a_response\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_a_response_by_response_id(collector_id, response_id, opts = {}) ⇒ nil

Delete a response by response id Delete a response by response id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_a_response_by_response_id(collector_id, response_id, opts = {})
  delete_a_response_by_response_id_with_http_info(collector_id, response_id, opts)
  nil
end

#delete_a_response_by_response_id_with_http_info(collector_id, response_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a response by response id Delete a response by response id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
131
132
133
134
135
136
 
# File 'lib/survey_monkey_swagger_client/api/survey_responses_api.rb', line 94

def delete_a_response_by_response_id_with_http_info(collector_id, response_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveyResponsesApi.delete_a_response_by_response_id ...'
  end
  # verify the required parameter 'collector_id' is set
  if @api_client.config.client_side_validation && collector_id.nil?
    fail ArgumentError, "Missing the required parameter 'collector_id' when calling SurveyResponsesApi.delete_a_response_by_response_id"
  end
  # verify the required parameter 'response_id' is set
  if @api_client.config.client_side_validation && response_id.nil?
    fail ArgumentError, "Missing the required parameter 'response_id' when calling SurveyResponsesApi.delete_a_response_by_response_id"
  end
  # resource path
  local_var_path = '/v3/collectors/{COLLECTOR_ID}/responses/{RESPONSE_ID}'.sub('{' + 'COLLECTOR_ID' + '}', collector_id.to_s).sub('{' + 'RESPONSE_ID' + '}', response_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: SurveyResponsesApi#delete_a_response_by_response_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_a_list_of_responses_by_collector_id(collector_id, opts = {}) ⇒ nil

Get a list of responses by collector id Get a list of responses by collector id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


142
143
144
145
 
# File 'lib/survey_monkey_swagger_client/api/survey_responses_api.rb', line 142

def get_a_list_of_responses_by_collector_id(collector_id, opts = {})
  get_a_list_of_responses_by_collector_id_with_http_info(collector_id, opts)
  nil
end

#get_a_list_of_responses_by_collector_id1(collector_id, opts = {}) ⇒ nil

Get a list of responses by collector id Get a list of responses by collector id, retrieves a list of full expanded responses, including answers to all questions.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


196
197
198
199
 
# File 'lib/survey_monkey_swagger_client/api/survey_responses_api.rb', line 196

def get_a_list_of_responses_by_collector_id1(collector_id, opts = {})
  get_a_list_of_responses_by_collector_id1_with_http_info(collector_id, opts)
  nil
end

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

Get a list of responses by collector id Get a list of responses by collector id, retrieves a list of full expanded responses, including answers to all questions.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
241
242
243
244
 
# File 'lib/survey_monkey_swagger_client/api/survey_responses_api.rb', line 206

def get_a_list_of_responses_by_collector_id1_with_http_info(collector_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveyResponsesApi.get_a_list_of_responses_by_collector_id1 ...'
  end
  # verify the required parameter 'collector_id' is set
  if @api_client.config.client_side_validation && collector_id.nil?
    fail ArgumentError, "Missing the required parameter 'collector_id' when calling SurveyResponsesApi.get_a_list_of_responses_by_collector_id1"
  end
  # resource path
  local_var_path = '/v3/collectors/{COLLECTOR_ID}/responses/bulk'.sub('{' + 'COLLECTOR_ID' + '}', collector_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: SurveyResponsesApi#get_a_list_of_responses_by_collector_id1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a list of responses by collector id Get a list of responses by collector id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
183
184
185
186
187
188
189
190
 
# File 'lib/survey_monkey_swagger_client/api/survey_responses_api.rb', line 152

def get_a_list_of_responses_by_collector_id_with_http_info(collector_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveyResponsesApi.get_a_list_of_responses_by_collector_id ...'
  end
  # verify the required parameter 'collector_id' is set
  if @api_client.config.client_side_validation && collector_id.nil?
    fail ArgumentError, "Missing the required parameter 'collector_id' when calling SurveyResponsesApi.get_a_list_of_responses_by_collector_id"
  end
  # resource path
  local_var_path = '/v3/collectors/{COLLECTOR_ID}/responses'.sub('{' + 'COLLECTOR_ID' + '}', collector_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: SurveyResponsesApi#get_a_list_of_responses_by_collector_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_a_list_of_responses_by_survey_id(opts = {}) ⇒ nil

Get a list of responses by survey id Get a list of responses by survey id, retrieves a list of full expanded responses, including answers to all questions

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


249
250
251
252
 
# File 'lib/survey_monkey_swagger_client/api/survey_responses_api.rb', line 249

def get_a_list_of_responses_by_survey_id(opts = {})
  get_a_list_of_responses_by_survey_id_with_http_info(opts)
  nil
end

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

Get a list of responses by survey id Get a list of responses by survey id, retrieves a list of full expanded responses, including answers to all questions

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def get_a_list_of_responses_by_survey_id_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveyResponsesApi.get_a_list_of_responses_by_survey_id ...'
  end
  # resource path
  local_var_path = '/v3/surveys/310099766/responses/bulk'

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

#get_response_by_collector_and_response_id(collector_id, response_id, opts = {}) ⇒ nil

Get response by collector and response id Get a response resource by response id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


299
300
301
302
 
# File 'lib/survey_monkey_swagger_client/api/survey_responses_api.rb', line 299

def get_response_by_collector_and_response_id(collector_id, response_id, opts = {})
  get_response_by_collector_and_response_id_with_http_info(collector_id, response_id, opts)
  nil
end

#get_response_by_collector_and_response_id_with_http_info(collector_id, response_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get response by collector and response id Get a response resource by response id

Parameters:

  • collector_id
  • response_id
  • 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
345
346
347
348
349
350
351
352
 
# File 'lib/survey_monkey_swagger_client/api/survey_responses_api.rb', line 310

def get_response_by_collector_and_response_id_with_http_info(collector_id, response_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveyResponsesApi.get_response_by_collector_and_response_id ...'
  end
  # verify the required parameter 'collector_id' is set
  if @api_client.config.client_side_validation && collector_id.nil?
    fail ArgumentError, "Missing the required parameter 'collector_id' when calling SurveyResponsesApi.get_response_by_collector_and_response_id"
  end
  # verify the required parameter 'response_id' is set
  if @api_client.config.client_side_validation && response_id.nil?
    fail ArgumentError, "Missing the required parameter 'response_id' when calling SurveyResponsesApi.get_response_by_collector_and_response_id"
  end
  # resource path
  local_var_path = '/v3/collectors/{COLLECTOR_ID}/responses/{RESPONSE_ID}'.sub('{' + 'COLLECTOR_ID' + '}', collector_id.to_s).sub('{' + 'RESPONSE_ID' + '}', response_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: SurveyResponsesApi#get_response_by_collector_and_response_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_response_by_survey_and_response_id(response_id, opts = {}) ⇒ nil

Get response by survey and response id Get a response resource by response id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


358
359
360
361
 
# File 'lib/survey_monkey_swagger_client/api/survey_responses_api.rb', line 358

def get_response_by_survey_and_response_id(response_id, opts = {})
  get_response_by_survey_and_response_id_with_http_info(response_id, opts)
  nil
end

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

Get response by survey and response id Get a response resource by response id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
399
400
401
402
403
404
405
406
 
# File 'lib/survey_monkey_swagger_client/api/survey_responses_api.rb', line 368

def get_response_by_survey_and_response_id_with_http_info(response_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveyResponsesApi.get_response_by_survey_and_response_id ...'
  end
  # verify the required parameter 'response_id' is set
  if @api_client.config.client_side_validation && response_id.nil?
    fail ArgumentError, "Missing the required parameter 'response_id' when calling SurveyResponsesApi.get_response_by_survey_and_response_id"
  end
  # resource path
  local_var_path = '/v3/survey/310099766/responses/{RESPONSE_ID}'.sub('{' + 'RESPONSE_ID' + '}', response_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: SurveyResponsesApi#get_response_by_survey_and_response_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_response_details(collector_id, response_id, opts = {}) ⇒ nil

Get response details Get a response details by response id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


413
414
415
416
 
# File 'lib/survey_monkey_swagger_client/api/survey_responses_api.rb', line 413

def get_response_details(collector_id, response_id, opts = {})
  get_response_details_with_http_info(collector_id, response_id, opts)
  nil
end

#get_response_details_with_http_info(collector_id, response_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get response details Get a response details by response id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
459
460
461
462
463
464
465
466
 
# File 'lib/survey_monkey_swagger_client/api/survey_responses_api.rb', line 424

def get_response_details_with_http_info(collector_id, response_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveyResponsesApi.get_response_details ...'
  end
  # verify the required parameter 'collector_id' is set
  if @api_client.config.client_side_validation && collector_id.nil?
    fail ArgumentError, "Missing the required parameter 'collector_id' when calling SurveyResponsesApi.get_response_details"
  end
  # verify the required parameter 'response_id' is set
  if @api_client.config.client_side_validation && response_id.nil?
    fail ArgumentError, "Missing the required parameter 'response_id' when calling SurveyResponsesApi.get_response_details"
  end
  # resource path
  local_var_path = '/v3/collectors/{COLLECTOR_ID}/responses/{RESPONSE_ID}/details'.sub('{' + 'COLLECTOR_ID' + '}', collector_id.to_s).sub('{' + 'RESPONSE_ID' + '}', response_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: SurveyResponsesApi#get_response_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#modify_a_response_by_response_id(collector_id, response_id, opts = {}) ⇒ nil

Modify a response by response id Modify a response by response id

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


474
475
476
477
 
# File 'lib/survey_monkey_swagger_client/api/survey_responses_api.rb', line 474

def modify_a_response_by_response_id(collector_id, response_id, opts = {})
  modify_a_response_by_response_id_with_http_info(collector_id, response_id, opts)
  nil
end

#modify_a_response_by_response_id_with_http_info(collector_id, response_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Modify a response by response id Modify a response by response id

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/survey_monkey_swagger_client/api/survey_responses_api.rb', line 486

def modify_a_response_by_response_id_with_http_info(collector_id, response_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveyResponsesApi.modify_a_response_by_response_id ...'
  end
  # verify the required parameter 'collector_id' is set
  if @api_client.config.client_side_validation && collector_id.nil?
    fail ArgumentError, "Missing the required parameter 'collector_id' when calling SurveyResponsesApi.modify_a_response_by_response_id"
  end
  # verify the required parameter 'response_id' is set
  if @api_client.config.client_side_validation && response_id.nil?
    fail ArgumentError, "Missing the required parameter 'response_id' when calling SurveyResponsesApi.modify_a_response_by_response_id"
  end
  # resource path
  local_var_path = '/v3/collectors/{COLLECTOR_ID}/responses/{RESPONSE_ID}'.sub('{' + 'COLLECTOR_ID' + '}', collector_id.to_s).sub('{' + 'RESPONSE_ID' + '}', response_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: SurveyResponsesApi#modify_a_response_by_response_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replace_a_response_by_response_id(collector_id, response_id, opts = {}) ⇒ nil

Replace a response by response id Replace a response by response id

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


538
539
540
541
 
# File 'lib/survey_monkey_swagger_client/api/survey_responses_api.rb', line 538

def replace_a_response_by_response_id(collector_id, response_id, opts = {})
  replace_a_response_by_response_id_with_http_info(collector_id, response_id, opts)
  nil
end

#replace_a_response_by_response_id_with_http_info(collector_id, response_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Replace a response by response id Replace a response by response id

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
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
 
# File 'lib/survey_monkey_swagger_client/api/survey_responses_api.rb', line 550

def replace_a_response_by_response_id_with_http_info(collector_id, response_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SurveyResponsesApi.replace_a_response_by_response_id ...'
  end
  # verify the required parameter 'collector_id' is set
  if @api_client.config.client_side_validation && collector_id.nil?
    fail ArgumentError, "Missing the required parameter 'collector_id' when calling SurveyResponsesApi.replace_a_response_by_response_id"
  end
  # verify the required parameter 'response_id' is set
  if @api_client.config.client_side_validation && response_id.nil?
    fail ArgumentError, "Missing the required parameter 'response_id' when calling SurveyResponsesApi.replace_a_response_by_response_id"
  end
  # resource path
  local_var_path = '/v3/collectors/{COLLECTOR_ID}/responses/{RESPONSE_ID}'.sub('{' + 'COLLECTOR_ID' + '}', collector_id.to_s).sub('{' + 'RESPONSE_ID' + '}', response_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: SurveyResponsesApi#replace_a_response_by_response_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end