Class: SurveyMonkeySwaggerClient::CollectorsAndInviteMessagesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CollectorsAndInviteMessagesApi

Returns a new instance of CollectorsAndInviteMessagesApi.



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

def api_client
  @api_client
end

Instance Method Details

#add_recipient_to_a_message(collector_id, message_id, opts = {}) ⇒ nil

Add recipient to a message Add a new recipient to a specified message

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


26
27
28
29
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 26

def add_recipient_to_a_message(collector_id, message_id, opts = {})
  add_recipient_to_a_message_with_http_info(collector_id, message_id, opts)
  nil
end

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

Add recipient to a message Add a new recipient to a specified message

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



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
79
80
81
82
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 38

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

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

Create a collector message Create a collector message

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


89
90
91
92
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 89

def create_a_collector_message(collector_id, opts = {})
  create_a_collector_message_with_http_info(collector_id, opts)
  nil
end

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

Create a collector message Create a collector message

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



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
137
138
139
140
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 100

def create_a_collector_message_with_http_info(collector_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CollectorsAndInviteMessagesApi.create_a_collector_message ...'
  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 CollectorsAndInviteMessagesApi.create_a_collector_message"
  end
  # resource path
  local_var_path = '/v3/collectors/{COLLECTOR_ID}/messages'.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: CollectorsAndInviteMessagesApi#create_a_collector_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_a_survey_collector(opts = {}) ⇒ nil

Create a survey collector Creates a webline or email collector for a given survey

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


146
147
148
149
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 146

def create_a_survey_collector(opts = {})
  create_a_survey_collector_with_http_info(opts)
  nil
end

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

Create a survey collector Creates a webline or email collector for a given survey

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



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
191
192
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 156

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

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

#create_multiple_recipients(collector_id, message_id, opts = {}) ⇒ nil

Create multiple recipients Create multiple recipients

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


200
201
202
203
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 200

def create_multiple_recipients(collector_id, message_id, opts = {})
  create_multiple_recipients_with_http_info(collector_id, message_id, opts)
  nil
end

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

Create multiple recipients Create multiple recipients

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



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
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 212

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

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

Delete a collector Delete a collector

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


262
263
264
265
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 262

def delete_a_collector(collector_id, opts = {})
  delete_a_collector_with_http_info(collector_id, opts)
  nil
end

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

Delete a collector Delete a collector

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 272

def delete_a_collector_with_http_info(collector_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CollectorsAndInviteMessagesApi.delete_a_collector ...'
  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 CollectorsAndInviteMessagesApi.delete_a_collector"
  end
  # resource path
  local_var_path = '/v3/collectors/{COLLECTOR_ID}'.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(: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: CollectorsAndInviteMessagesApi#delete_a_collector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_a_message(collector_id, message_id, opts = {}) ⇒ nil

Delete a message Delete a collector message

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


317
318
319
320
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 317

def delete_a_message(collector_id, message_id, opts = {})
  delete_a_message_with_http_info(collector_id, message_id, opts)
  nil
end

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

Delete a message Delete a collector message

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 328

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

#delete_a_recipient(collector_id, recipient_id, opts = {}) ⇒ nil

Delete a recipient Delete a recipient by id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


377
378
379
380
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 377

def delete_a_recipient(collector_id, recipient_id, opts = {})
  delete_a_recipient_with_http_info(collector_id, recipient_id, opts)
  nil
end

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

Delete a recipient Delete a recipient by id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 388

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

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

Get a collector by id Get a collector by id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


436
437
438
439
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 436

def get_a_collector_by_id(collector_id, opts = {})
  get_a_collector_by_id_with_http_info(collector_id, opts)
  nil
end

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

Get a collector by id Get a collector by id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 446

def get_a_collector_by_id_with_http_info(collector_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CollectorsAndInviteMessagesApi.get_a_collector_by_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 CollectorsAndInviteMessagesApi.get_a_collector_by_id"
  end
  # resource path
  local_var_path = '/v3/collectors/{COLLECTOR_ID}'.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: CollectorsAndInviteMessagesApi#get_a_collector_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_a_list_of_recipients(collector_id, message_id, opts = {}) ⇒ nil

Get a list of recipients Get a list of recipients

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


491
492
493
494
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 491

def get_a_list_of_recipients(collector_id, message_id, opts = {})
  get_a_list_of_recipients_with_http_info(collector_id, message_id, opts)
  nil
end

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

Get a list of recipients Get a list of recipients

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
531
532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 502

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

#get_a_message_by_id(collector_id, message_id, opts = {}) ⇒ nil

Get a message by id Get a collector message by id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


551
552
553
554
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 551

def get_a_message_by_id(collector_id, message_id, opts = {})
  get_a_message_by_id_with_http_info(collector_id, message_id, opts)
  nil
end

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

Get a message by id Get a collector message by id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
595
596
597
598
599
600
601
602
603
604
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 562

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

#get_a_recipient(collector_id, recipient_id, opts = {}) ⇒ nil

Get a recipient Get a recipient by id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


611
612
613
614
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 611

def get_a_recipient(collector_id, recipient_id, opts = {})
  get_a_recipient_with_http_info(collector_id, recipient_id, opts)
  nil
end

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

Get a recipient Get a recipient by id

Parameters:

  • collector_id
  • recipient_id
  • 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
657
658
659
660
661
662
663
664
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 622

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

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

Get collector messages Get collector messages

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


670
671
672
673
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 670

def get_collector_messages(collector_id, opts = {})
  get_collector_messages_with_http_info(collector_id, opts)
  nil
end

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

Get collector messages Get collector messages

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
705
706
707
708
709
710
711
712
713
714
715
716
717
718
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 680

def get_collector_messages_with_http_info(collector_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CollectorsAndInviteMessagesApi.get_collector_messages ...'
  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 CollectorsAndInviteMessagesApi.get_collector_messages"
  end
  # resource path
  local_var_path = '/v3/collectors/{COLLECTOR_ID}/messages'.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: CollectorsAndInviteMessagesApi#get_collector_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_survey_collectors(opts = {}) ⇒ nil

Get survey collectors Get a list of collectors for a given survey

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


723
724
725
726
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 723

def get_survey_collectors(opts = {})
  get_survey_collectors_with_http_info(opts)
  nil
end

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

Get survey collectors Get a list of collectors for a given survey

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 732

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

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

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

Modify a collector Modify a collector

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


773
774
775
776
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 773

def modify_a_collector(collector_id, opts = {})
  modify_a_collector_with_http_info(collector_id, opts)
  nil
end

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

Modify a collector Modify a collector

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



784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 784

def modify_a_collector_with_http_info(collector_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CollectorsAndInviteMessagesApi.modify_a_collector ...'
  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 CollectorsAndInviteMessagesApi.modify_a_collector"
  end
  # resource path
  local_var_path = '/v3/collectors/{COLLECTOR_ID}'.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(: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: CollectorsAndInviteMessagesApi#modify_a_collector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#modify_a_message_by_id(collector_id, message_id, opts = {}) ⇒ nil

Modify a message by id Mofiy a collector message by id

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


832
833
834
835
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 832

def modify_a_message_by_id(collector_id, message_id, opts = {})
  modify_a_message_by_id_with_http_info(collector_id, message_id, opts)
  nil
end

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

Modify a message by id Mofiy a collector message by id

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 844

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

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

Replace a collector Replace a collector

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


895
896
897
898
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 895

def replace_a_collector(collector_id, opts = {})
  replace_a_collector_with_http_info(collector_id, opts)
  nil
end

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

Replace a collector Replace a collector

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



906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 906

def replace_a_collector_with_http_info(collector_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CollectorsAndInviteMessagesApi.replace_a_collector ...'
  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 CollectorsAndInviteMessagesApi.replace_a_collector"
  end
  # resource path
  local_var_path = '/v3/collectors/{COLLECTOR_ID}'.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(: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: CollectorsAndInviteMessagesApi#replace_a_collector\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replace_a_message(collector_id, message_id, opts = {}) ⇒ nil

Replace a message Replace a collector message

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


954
955
956
957
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 954

def replace_a_message(collector_id, message_id, opts = {})
  replace_a_message_with_http_info(collector_id, message_id, opts)
  nil
end

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

Replace a message Replace a collector message

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 966

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

#send_and_existing_message(collector_id, message_id, opts = {}) ⇒ nil

Send and existing message Send or schedule to send an existing message to all recipients that have not received the message

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1018
1019
1020
1021
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 1018

def send_and_existing_message(collector_id, message_id, opts = {})
  send_and_existing_message_with_http_info(collector_id, message_id, opts)
  nil
end

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

Send and existing message Send or schedule to send an existing message to all recipients that have not received the message

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
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
 
# File 'lib/survey_monkey_swagger_client/api/collectors_and_invite_messages_api.rb', line 1030

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