class ConnectWise::SurveyQuestionsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/connectwise-ruby-sdk/api/survey_questions_api.rb, line 8
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

system_surveys_id_questions_get(id, opts = {}) click to toggle source

Get Survey Questions Count @param id @param [Hash] opts the optional parameters @option opts [String] :conditions @return [Count]

# 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 = {}) click to toggle source

Get Survey Questions Count @param id @param [Hash] opts the optional parameters @option opts [String] :conditions @return [Array<(Count, Fixnum, Hash)>] Count data, response status code and response headers

# 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 = {}) click to toggle source

Create Survey Question @param id @param survey_question @param [Hash] opts the optional parameters @return [SurveyQuestion]

# 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 = {}) click to toggle source

Create Survey Question @param id @param survey_question @param [Hash] opts the optional parameters @return [Array<(SurveyQuestion, Fixnum, Hash)>] SurveyQuestion data, response status code and response headers

# 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 = {}) click to toggle source

Delete Survey Question By Id @param id @param survey_question_id @param [Hash] opts the optional parameters @return [nil]

# 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 = {}) click to toggle source

Delete Survey Question By Id @param id @param survey_question_id @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# 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 = {}) click to toggle source

Get Survey Question By Id @param id @param survey_question_id @param [Hash] opts the optional parameters @return [SurveyQuestion]

# 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 = {}) click to toggle source

Get Survey Question By Id @param id @param survey_question_id @param [Hash] opts the optional parameters @return [Array<(SurveyQuestion, Fixnum, Hash)>] SurveyQuestion data, response status code and response headers

# 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 = {}) click to toggle source

Update Survey Question @param id @param survey_question_id @param operations @param [Hash] opts the optional parameters @return [SurveyQuestion]

# 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 = {}) click to toggle source

Update Survey Question @param id @param survey_question_id @param operations @param [Hash] opts the optional parameters @return [Array<(SurveyQuestion, Fixnum, Hash)>] SurveyQuestion data, response status code and response headers

# 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 = {}) click to toggle source

Replace Survey Question @param id @param survey_question_id @param survey_question @param [Hash] opts the optional parameters @return [SurveyQuestion]

# 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 = {}) click to toggle source

Replace Survey Question @param id @param survey_question_id @param survey_question @param [Hash] opts the optional parameters @return [Array<(SurveyQuestion, Fixnum, Hash)>] SurveyQuestion data, response status code and response headers

# 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