Class: NucleusApi::QuestionnaireApi

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/api/questionnaire_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ QuestionnaireApi

Returns a new instance of QuestionnaireApi.



19
20
21
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_answer_using_post(answer, opts = {}) ⇒ Answer

Create an answer Create a new answer for question.

Parameters:

  • answer —

    answer

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 27

def create_answer_using_post(answer, opts = {})
  data, _status_code, _headers = create_answer_using_post_with_http_info(answer, opts)
  data
end

#create_answer_using_post_with_http_info(answer, opts = {}) ⇒ Array<(Answer, Fixnum, Hash)>

Create an answer Create a new answer for question.

Parameters:

  • answer —

    answer

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

    the optional parameters

Returns:

  • (Array<(Answer, Fixnum, Hash)>) —

    Answer data, response status code and response headers



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
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 37

def create_answer_using_post_with_http_info(answer, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuestionnaireApi.create_answer_using_post ...'
  end
  # verify the required parameter 'answer' is set
  if @api_client.config.client_side_validation && answer.nil?
    fail ArgumentError, "Missing the required parameter 'answer' when calling QuestionnaireApi.create_answer_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/answer'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(answer)
  auth_names = ['oauth2']
  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 => 'Answer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuestionnaireApi#create_answer_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_question_using_post(question, opts = {}) ⇒ Question

Create a question Create a new question for questionnaire.

Parameters:

  • question —

    question

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

    the optional parameters

Returns:



81
82
83
84
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 81

def create_question_using_post(question, opts = {})
  data, _status_code, _headers = create_question_using_post_with_http_info(question, opts)
  data
end

#create_question_using_post_with_http_info(question, opts = {}) ⇒ Array<(Question, Fixnum, Hash)>

Create a question Create a new question for questionnaire.

Parameters:

  • question —

    question

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

    the optional parameters

Returns:

  • (Array<(Question, Fixnum, Hash)>) —

    Question data, response status code and response headers



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 91

def create_question_using_post_with_http_info(question, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuestionnaireApi.create_question_using_post ...'
  end
  # verify the required parameter 'question' is set
  if @api_client.config.client_side_validation && question.nil?
    fail ArgumentError, "Missing the required parameter 'question' when calling QuestionnaireApi.create_question_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/question'

  # query parameters
  query_params = {}

  # header parameters
  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 = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(question)
  auth_names = ['oauth2']
  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 => 'Question')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuestionnaireApi#create_question_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_questionnaire_using_post(questionnaire, opts = {}) ⇒ Questionnaire

Create a questionnaire Create a new questionnaire for your firm.

Parameters:

  • questionnaire —

    questionnaire

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

    the optional parameters

Returns:



135
136
137
138
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 135

def create_questionnaire_using_post(questionnaire, opts = {})
  data, _status_code, _headers = create_questionnaire_using_post_with_http_info(questionnaire, opts)
  data
end

#create_questionnaire_using_post_with_http_info(questionnaire, opts = {}) ⇒ Array<(Questionnaire, Fixnum, Hash)>

Create a questionnaire Create a new questionnaire for your firm.

Parameters:

  • questionnaire —

    questionnaire

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

    the optional parameters

Returns:

  • (Array<(Questionnaire, Fixnum, Hash)>) —

    Questionnaire data, response status code and response headers



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 145

def create_questionnaire_using_post_with_http_info(questionnaire, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuestionnaireApi.create_questionnaire_using_post ...'
  end
  # verify the required parameter 'questionnaire' is set
  if @api_client.config.client_side_validation && questionnaire.nil?
    fail ArgumentError, "Missing the required parameter 'questionnaire' when calling QuestionnaireApi.create_questionnaire_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/questionnaire'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(questionnaire)
  auth_names = ['oauth2']
  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 => 'Questionnaire')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuestionnaireApi#create_questionnaire_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_answer_using_delete(answer_id, opts = {}) ⇒ nil

Delete an answer Delete an answer for the question

Parameters:

  • answer_id —

    UUID answer_id

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

    the optional parameters

Returns:

  • (nil) 


189
190
191
192
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 189

def delete_answer_using_delete(answer_id, opts = {})
  delete_answer_using_delete_with_http_info(answer_id, opts)
  nil
end

#delete_answer_using_delete_with_http_info(answer_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an answer Delete an answer for the question

Parameters:

  • answer_id —

    UUID answer_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_answer_using_delete_with_http_info(answer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuestionnaireApi.delete_answer_using_delete ...'
  end
  # verify the required parameter 'answer_id' is set
  if @api_client.config.client_side_validation && answer_id.nil?
    fail ArgumentError, "Missing the required parameter 'answer_id' when calling QuestionnaireApi.delete_answer_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/answer/{answer_id}'.sub('{' + 'answer_id' + '}', answer_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuestionnaireApi#delete_answer_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_question_using_delete(question_id, opts = {}) ⇒ nil

Delete a question Delete an answer for the question

Parameters:

  • question_id —

    UUID question_id

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

    the optional parameters

Returns:

  • (nil) 


240
241
242
243
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 240

def delete_question_using_delete(question_id, opts = {})
  delete_question_using_delete_with_http_info(question_id, opts)
  nil
end

#delete_question_using_delete_with_http_info(question_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a question Delete an answer for the question

Parameters:

  • question_id —

    UUID question_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



250
251
252
253
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
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 250

def delete_question_using_delete_with_http_info(question_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuestionnaireApi.delete_question_using_delete ...'
  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 QuestionnaireApi.delete_question_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/question/{question_id}'.sub('{' + 'question_id' + '}', question_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuestionnaireApi#delete_question_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_questionnaire_using_delete(questionnaire_id, opts = {}) ⇒ nil

Delete a questionnaire Permanently delete a questionnaire for your firm.

Parameters:

  • questionnaire_id —

    UUID questionnaire_id

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

    the optional parameters

Returns:

  • (nil) 


291
292
293
294
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 291

def delete_questionnaire_using_delete(questionnaire_id, opts = {})
  delete_questionnaire_using_delete_with_http_info(questionnaire_id, opts)
  nil
end

#delete_questionnaire_using_delete_with_http_info(questionnaire_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a questionnaire Permanently delete a questionnaire for your firm.

Parameters:

  • questionnaire_id —

    UUID questionnaire_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 301

def delete_questionnaire_using_delete_with_http_info(questionnaire_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuestionnaireApi.delete_questionnaire_using_delete ...'
  end
  # verify the required parameter 'questionnaire_id' is set
  if @api_client.config.client_side_validation && questionnaire_id.nil?
    fail ArgumentError, "Missing the required parameter 'questionnaire_id' when calling QuestionnaireApi.delete_questionnaire_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/questionnaire/{questionnaire_id}'.sub('{' + 'questionnaire_id' + '}', questionnaire_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuestionnaireApi#delete_questionnaire_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_answer_all_using_get(opts = {}) ⇒ PageAnswer

List all Answers Get information for all Answers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to label)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



346
347
348
349
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 346

def get_answer_all_using_get(opts = {})
  data, _status_code, _headers = get_answer_all_using_get_with_http_info(opts)
  data
end

#get_answer_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageAnswer, Fixnum, Hash)>

List all Answers Get information for all Answers

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

  • (Array<(PageAnswer, Fixnum, Hash)>) —

    PageAnswer data, 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
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 360

def get_answer_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuestionnaireApi.get_answer_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/answer'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'PageAnswer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuestionnaireApi#get_answer_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_answer_using_get(answer_id, opts = {}) ⇒ Answer

Retrieve an answer Retrieve the information for an answer for question

Parameters:

  • answer_id —

    UUID answer_id

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

    the optional parameters

Returns:



403
404
405
406
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 403

def get_answer_using_get(answer_id, opts = {})
  data, _status_code, _headers = get_answer_using_get_with_http_info(answer_id, opts)
  data
end

#get_answer_using_get_with_http_info(answer_id, opts = {}) ⇒ Array<(Answer, Fixnum, Hash)>

Retrieve an answer Retrieve the information for an answer for question

Parameters:

  • answer_id —

    UUID answer_id

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

    the optional parameters

Returns:

  • (Array<(Answer, Fixnum, Hash)>) —

    Answer data, response status code and response headers



413
414
415
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
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 413

def get_answer_using_get_with_http_info(answer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuestionnaireApi.get_answer_using_get ...'
  end
  # verify the required parameter 'answer_id' is set
  if @api_client.config.client_side_validation && answer_id.nil?
    fail ArgumentError, "Missing the required parameter 'answer_id' when calling QuestionnaireApi.get_answer_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/answer/{answer_id}'.sub('{' + 'answer_id' + '}', answer_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'Answer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuestionnaireApi#get_answer_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_question_all_using_get(opts = {}) ⇒ PageQuestion

List all Questions Get information for all Questions

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to order_index)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



459
460
461
462
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 459

def get_question_all_using_get(opts = {})
  data, _status_code, _headers = get_question_all_using_get_with_http_info(opts)
  data
end

#get_question_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageQuestion, Fixnum, Hash)>

List all Questions Get information for all Questions

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

  • (Array<(PageQuestion, Fixnum, Hash)>) —

    PageQuestion data, response status code and response headers



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
507
508
509
510
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 473

def get_question_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuestionnaireApi.get_question_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/question'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'PageQuestion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuestionnaireApi#get_question_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_question_using_get(question_id, opts = {}) ⇒ Question

Retrieve a question Retrieve the information for a question for questionnaire

Parameters:

  • question_id —

    UUID question_id

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

    the optional parameters

Returns:



516
517
518
519
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 516

def get_question_using_get(question_id, opts = {})
  data, _status_code, _headers = get_question_using_get_with_http_info(question_id, opts)
  data
end

#get_question_using_get_with_http_info(question_id, opts = {}) ⇒ Array<(Question, Fixnum, Hash)>

Retrieve a question Retrieve the information for a question for questionnaire

Parameters:

  • question_id —

    UUID question_id

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

    the optional parameters

Returns:

  • (Array<(Question, Fixnum, Hash)>) —

    Question data, response status code and response headers



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
555
556
557
558
559
560
561
562
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 526

def get_question_using_get_with_http_info(question_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuestionnaireApi.get_question_using_get ...'
  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 QuestionnaireApi.get_question_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/question/{question_id}'.sub('{' + 'question_id' + '}', question_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'Question')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuestionnaireApi#get_question_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_questionnaire_all_using_get(opts = {}) ⇒ PageQuestionnaire

List all questionnaires Get the information for all questionnaires defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



572
573
574
575
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 572

def get_questionnaire_all_using_get(opts = {})
  data, _status_code, _headers = get_questionnaire_all_using_get_with_http_info(opts)
  data
end

#get_questionnaire_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageQuestionnaire, Fixnum, Hash)>

List all questionnaires Get the information for all questionnaires defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

  • (Array<(PageQuestionnaire, Fixnum, Hash)>) —

    PageQuestionnaire data, response status code and response headers



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 586

def get_questionnaire_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuestionnaireApi.get_questionnaire_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/questionnaire'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'PageQuestionnaire')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuestionnaireApi#get_questionnaire_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_questionnaire_using_get(questionnaire_id, opts = {}) ⇒ Questionnaire

Retrieve a questionnaire Retrieve the information for a questionnaire for your firm.

Parameters:

  • questionnaire_id —

    UUID questionnaire_id

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

    the optional parameters

Returns:



629
630
631
632
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 629

def get_questionnaire_using_get(questionnaire_id, opts = {})
  data, _status_code, _headers = get_questionnaire_using_get_with_http_info(questionnaire_id, opts)
  data
end

#get_questionnaire_using_get_with_http_info(questionnaire_id, opts = {}) ⇒ Array<(Questionnaire, Fixnum, Hash)>

Retrieve a questionnaire Retrieve the information for a questionnaire for your firm.

Parameters:

  • questionnaire_id —

    UUID questionnaire_id

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

    the optional parameters

Returns:

  • (Array<(Questionnaire, Fixnum, Hash)>) —

    Questionnaire data, response status code and response headers



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
665
666
667
668
669
670
671
672
673
674
675
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 639

def get_questionnaire_using_get_with_http_info(questionnaire_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuestionnaireApi.get_questionnaire_using_get ...'
  end
  # verify the required parameter 'questionnaire_id' is set
  if @api_client.config.client_side_validation && questionnaire_id.nil?
    fail ArgumentError, "Missing the required parameter 'questionnaire_id' when calling QuestionnaireApi.get_questionnaire_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/questionnaire/{questionnaire_id}'.sub('{' + 'questionnaire_id' + '}', questionnaire_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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 => 'Questionnaire')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuestionnaireApi#get_questionnaire_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_answer_using_put(answer, answer_id, opts = {}) ⇒ Answer

Update an answer Update a answer for question.

Parameters:

  • answer —

    answer

  • answer_id —

    UUID answer_id

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

    the optional parameters

Returns:



682
683
684
685
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 682

def update_answer_using_put(answer, answer_id, opts = {})
  data, _status_code, _headers = update_answer_using_put_with_http_info(answer, answer_id, opts)
  data
end

#update_answer_using_put_with_http_info(answer, answer_id, opts = {}) ⇒ Array<(Answer, Fixnum, Hash)>

Update an answer Update a answer for question.

Parameters:

  • answer —

    answer

  • answer_id —

    UUID answer_id

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

    the optional parameters

Returns:

  • (Array<(Answer, Fixnum, Hash)>) —

    Answer data, response status code and response headers



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
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 693

def update_answer_using_put_with_http_info(answer, answer_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuestionnaireApi.update_answer_using_put ...'
  end
  # verify the required parameter 'answer' is set
  if @api_client.config.client_side_validation && answer.nil?
    fail ArgumentError, "Missing the required parameter 'answer' when calling QuestionnaireApi.update_answer_using_put"
  end
  # verify the required parameter 'answer_id' is set
  if @api_client.config.client_side_validation && answer_id.nil?
    fail ArgumentError, "Missing the required parameter 'answer_id' when calling QuestionnaireApi.update_answer_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/answer/{answer_id}'.sub('{' + 'answer_id' + '}', answer_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(answer)
  auth_names = ['oauth2']
  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 => 'Answer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuestionnaireApi#update_answer_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_question_using_put(question, question_id, opts = {}) ⇒ Question

Update a question. Update a question for questionnaire.

Parameters:

  • question —

    question

  • question_id —

    UUID question_id

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

    the optional parameters

Returns:



742
743
744
745
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 742

def update_question_using_put(question, question_id, opts = {})
  data, _status_code, _headers = update_question_using_put_with_http_info(question, question_id, opts)
  data
end

#update_question_using_put_with_http_info(question, question_id, opts = {}) ⇒ Array<(Question, Fixnum, Hash)>

Update a question. Update a question for questionnaire.

Parameters:

  • question —

    question

  • question_id —

    UUID question_id

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

    the optional parameters

Returns:

  • (Array<(Question, Fixnum, Hash)>) —

    Question data, response status code and response headers



753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
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
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 753

def update_question_using_put_with_http_info(question, question_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuestionnaireApi.update_question_using_put ...'
  end
  # verify the required parameter 'question' is set
  if @api_client.config.client_side_validation && question.nil?
    fail ArgumentError, "Missing the required parameter 'question' when calling QuestionnaireApi.update_question_using_put"
  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 QuestionnaireApi.update_question_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/question/{question_id}'.sub('{' + 'question_id' + '}', question_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(question)
  auth_names = ['oauth2']
  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 => 'Question')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuestionnaireApi#update_question_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_questionnaire_using_put(questionnaire, questionnaire_id, opts = {}) ⇒ Questionnaire

Update a questionnaire Update a questionnaire for your firm.

Parameters:

  • questionnaire —

    questionnaire

  • questionnaire_id —

    UUID questionnaire_id

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

    the optional parameters

Returns:



802
803
804
805
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 802

def update_questionnaire_using_put(questionnaire, questionnaire_id, opts = {})
  data, _status_code, _headers = update_questionnaire_using_put_with_http_info(questionnaire, questionnaire_id, opts)
  data
end

#update_questionnaire_using_put_with_http_info(questionnaire, questionnaire_id, opts = {}) ⇒ Array<(Questionnaire, Fixnum, Hash)>

Update a questionnaire Update a questionnaire for your firm.

Parameters:

  • questionnaire —

    questionnaire

  • questionnaire_id —

    UUID questionnaire_id

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

    the optional parameters

Returns:

  • (Array<(Questionnaire, Fixnum, Hash)>) —

    Questionnaire data, response status code and response headers



813
814
815
816
817
818
819
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
 
# File 'lib/nucleus_api/api/questionnaire_api.rb', line 813

def update_questionnaire_using_put_with_http_info(questionnaire, questionnaire_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: QuestionnaireApi.update_questionnaire_using_put ...'
  end
  # verify the required parameter 'questionnaire' is set
  if @api_client.config.client_side_validation && questionnaire.nil?
    fail ArgumentError, "Missing the required parameter 'questionnaire' when calling QuestionnaireApi.update_questionnaire_using_put"
  end
  # verify the required parameter 'questionnaire_id' is set
  if @api_client.config.client_side_validation && questionnaire_id.nil?
    fail ArgumentError, "Missing the required parameter 'questionnaire_id' when calling QuestionnaireApi.update_questionnaire_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/questionnaire/{questionnaire_id}'.sub('{' + 'questionnaire_id' + '}', questionnaire_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(questionnaire)
  auth_names = ['oauth2']
  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 => 'Questionnaire')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuestionnaireApi#update_questionnaire_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end