Class: ConnectWise::SurveyQuestionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/api/survey_questions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SurveyQuestionsApi

Returns a new instance of SurveyQuestionsApi.



8
9
10
 
# File 'lib/connectwise-ruby-sdk/api/survey_questions_api.rb', line 8

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



6
7
8
 
# File 'lib/connectwise-ruby-sdk/api/survey_questions_api.rb', line 6

def api_client
  @api_client
end

Instance Method Details

#system_surveys_id_questions_get(id, opts = {}) ⇒ Count

Get Survey Questions Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:



18
19
20
21
 
# File 'lib/connectwise-ruby-sdk/api/survey_questions_api.rb', line 18

def system_surveys_id_questions_get(id, opts = {})
  data, _status_code, _headers = system_surveys_id_questions_get_with_http_info(id, opts)
  return data
end

#system_surveys_id_questions_get_with_http_info(id, opts = {}) ⇒ Array<(Count, Fixnum, Hash)>

Get Survey Questions Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:

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

    Count data, response status code and response headers



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/connectwise-ruby-sdk/api/survey_questions_api.rb', line 29

def system_surveys_id_questions_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SurveyQuestionsApi.system_surveys_id_questions_get ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SurveyQuestionsApi.system_surveys_id_questions_get"
  end
  # resource path
  local_var_path = "/system/surveys/{id}/questions".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil?

  # 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 = ['BasicAuth']
  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 => 'Count')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SurveyQuestionsApi#system_surveys_id_questions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_surveys_id_questions_post(id, survey_question, opts = {}) ⇒ SurveyQuestion

Create Survey Question

Parameters:

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

    the optional parameters

Returns:



74
75
76
77
 
# File 'lib/connectwise-ruby-sdk/api/survey_questions_api.rb', line 74

def system_surveys_id_questions_post(id, survey_question, opts = {})
  data, _status_code, _headers = system_surveys_id_questions_post_with_http_info(id, survey_question, opts)
  return data
end

#system_surveys_id_questions_post_with_http_info(id, survey_question, opts = {}) ⇒ Array<(SurveyQuestion, Fixnum, Hash)>

Create Survey Question

Parameters:

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

    the optional parameters

Returns:

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

    SurveyQuestion data, response status code and response headers



85
86
87
88
89
90
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
 
# File 'lib/connectwise-ruby-sdk/api/survey_questions_api.rb', line 85

def system_surveys_id_questions_post_with_http_info(id, survey_question, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SurveyQuestionsApi.system_surveys_id_questions_post ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SurveyQuestionsApi.system_surveys_id_questions_post"
  end
  # verify the required parameter 'survey_question' is set
  if @api_client.config.client_side_validation && survey_question.nil?
    fail ArgumentError, "Missing the required parameter 'survey_question' when calling SurveyQuestionsApi.system_surveys_id_questions_post"
  end
  # resource path
  local_var_path = "/system/surveys/{id}/questions".sub('{' + 'id' + '}', 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'])
  # 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(survey_question)
  auth_names = ['BasicAuth']
  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 => 'SurveyQuestion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SurveyQuestionsApi#system_surveys_id_questions_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_surveys_id_questions_survey_question_id_delete(id, survey_question_id, opts = {}) ⇒ nil

Delete Survey Question By Id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


135
136
137
138
 
# File 'lib/connectwise-ruby-sdk/api/survey_questions_api.rb', line 135

def system_surveys_id_questions_survey_question_id_delete(id, survey_question_id, opts = {})
  system_surveys_id_questions_survey_question_id_delete_with_http_info(id, survey_question_id, opts)
  return nil
end

#system_surveys_id_questions_survey_question_id_delete_with_http_info(id, survey_question_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Survey Question By Id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def system_surveys_id_questions_survey_question_id_delete_with_http_info(id, survey_question_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SurveyQuestionsApi.system_surveys_id_questions_survey_question_id_delete ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SurveyQuestionsApi.system_surveys_id_questions_survey_question_id_delete"
  end
  # verify the required parameter 'survey_question_id' is set
  if @api_client.config.client_side_validation && survey_question_id.nil?
    fail ArgumentError, "Missing the required parameter 'survey_question_id' when calling SurveyQuestionsApi.system_surveys_id_questions_survey_question_id_delete"
  end
  # resource path
  local_var_path = "/system/surveys/{id}/questions/{surveyQuestionId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'surveyQuestionId' + '}', survey_question_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  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: SurveyQuestionsApi#system_surveys_id_questions_survey_question_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_surveys_id_questions_survey_question_id_get(id, survey_question_id, opts = {}) ⇒ SurveyQuestion

Get Survey Question By Id

Parameters:

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

    the optional parameters

Returns:



191
192
193
194
 
# File 'lib/connectwise-ruby-sdk/api/survey_questions_api.rb', line 191

def system_surveys_id_questions_survey_question_id_get(id, survey_question_id, opts = {})
  data, _status_code, _headers = system_surveys_id_questions_survey_question_id_get_with_http_info(id, survey_question_id, opts)
  return data
end

#system_surveys_id_questions_survey_question_id_get_with_http_info(id, survey_question_id, opts = {}) ⇒ Array<(SurveyQuestion, Fixnum, Hash)>

Get Survey Question By Id

Parameters:

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

    the optional parameters

Returns:

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

    SurveyQuestion data, response status code and response headers



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/connectwise-ruby-sdk/api/survey_questions_api.rb', line 202

def system_surveys_id_questions_survey_question_id_get_with_http_info(id, survey_question_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SurveyQuestionsApi.system_surveys_id_questions_survey_question_id_get ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SurveyQuestionsApi.system_surveys_id_questions_survey_question_id_get"
  end
  # verify the required parameter 'survey_question_id' is set
  if @api_client.config.client_side_validation && survey_question_id.nil?
    fail ArgumentError, "Missing the required parameter 'survey_question_id' when calling SurveyQuestionsApi.system_surveys_id_questions_survey_question_id_get"
  end
  # resource path
  local_var_path = "/system/surveys/{id}/questions/{surveyQuestionId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'surveyQuestionId' + '}', survey_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 = ['BasicAuth']
  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 => 'SurveyQuestion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SurveyQuestionsApi#system_surveys_id_questions_survey_question_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_surveys_id_questions_survey_question_id_patch(id, survey_question_id, operations, opts = {}) ⇒ SurveyQuestion

Update Survey Question

Parameters:

  • id
  • survey_question_id
  • operations
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



251
252
253
254
 
# File 'lib/connectwise-ruby-sdk/api/survey_questions_api.rb', line 251

def system_surveys_id_questions_survey_question_id_patch(id, survey_question_id, operations, opts = {})
  data, _status_code, _headers = system_surveys_id_questions_survey_question_id_patch_with_http_info(id, survey_question_id, operations, opts)
  return data
end

#system_surveys_id_questions_survey_question_id_patch_with_http_info(id, survey_question_id, operations, opts = {}) ⇒ Array<(SurveyQuestion, Fixnum, Hash)>

Update Survey Question

Parameters:

  • id
  • survey_question_id
  • operations
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    SurveyQuestion data, response status code and response headers



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/connectwise-ruby-sdk/api/survey_questions_api.rb', line 263

def system_surveys_id_questions_survey_question_id_patch_with_http_info(id, survey_question_id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SurveyQuestionsApi.system_surveys_id_questions_survey_question_id_patch ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SurveyQuestionsApi.system_surveys_id_questions_survey_question_id_patch"
  end
  # verify the required parameter 'survey_question_id' is set
  if @api_client.config.client_side_validation && survey_question_id.nil?
    fail ArgumentError, "Missing the required parameter 'survey_question_id' when calling SurveyQuestionsApi.system_surveys_id_questions_survey_question_id_patch"
  end
  # verify the required parameter 'operations' is set
  if @api_client.config.client_side_validation && operations.nil?
    fail ArgumentError, "Missing the required parameter 'operations' when calling SurveyQuestionsApi.system_surveys_id_questions_survey_question_id_patch"
  end
  # resource path
  local_var_path = "/system/surveys/{id}/questions/{surveyQuestionId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'surveyQuestionId' + '}', survey_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'])
  # 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(operations)
  auth_names = ['BasicAuth']
  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 => 'SurveyQuestion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SurveyQuestionsApi#system_surveys_id_questions_survey_question_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_surveys_id_questions_survey_question_id_put(id, survey_question_id, survey_question, opts = {}) ⇒ SurveyQuestion

Replace Survey Question

Parameters:

  • id
  • survey_question_id
  • survey_question
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



318
319
320
321
 
# File 'lib/connectwise-ruby-sdk/api/survey_questions_api.rb', line 318

def system_surveys_id_questions_survey_question_id_put(id, survey_question_id, survey_question, opts = {})
  data, _status_code, _headers = system_surveys_id_questions_survey_question_id_put_with_http_info(id, survey_question_id, survey_question, opts)
  return data
end

#system_surveys_id_questions_survey_question_id_put_with_http_info(id, survey_question_id, survey_question, opts = {}) ⇒ Array<(SurveyQuestion, Fixnum, Hash)>

Replace Survey Question

Parameters:

  • id
  • survey_question_id
  • survey_question
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    SurveyQuestion data, response status code and response headers



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
371
372
373
374
375
376
 
# File 'lib/connectwise-ruby-sdk/api/survey_questions_api.rb', line 330

def system_surveys_id_questions_survey_question_id_put_with_http_info(id, survey_question_id, survey_question, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SurveyQuestionsApi.system_surveys_id_questions_survey_question_id_put ..."
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SurveyQuestionsApi.system_surveys_id_questions_survey_question_id_put"
  end
  # verify the required parameter 'survey_question_id' is set
  if @api_client.config.client_side_validation && survey_question_id.nil?
    fail ArgumentError, "Missing the required parameter 'survey_question_id' when calling SurveyQuestionsApi.system_surveys_id_questions_survey_question_id_put"
  end
  # verify the required parameter 'survey_question' is set
  if @api_client.config.client_side_validation && survey_question.nil?
    fail ArgumentError, "Missing the required parameter 'survey_question' when calling SurveyQuestionsApi.system_surveys_id_questions_survey_question_id_put"
  end
  # resource path
  local_var_path = "/system/surveys/{id}/questions/{surveyQuestionId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'surveyQuestionId' + '}', survey_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'])
  # 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(survey_question)
  auth_names = ['BasicAuth']
  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 => 'SurveyQuestion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SurveyQuestionsApi#system_surveys_id_questions_survey_question_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end