Class: ConnectWise::ConfigurationTypeQuestionInfosApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/api/configuration_type_question_infos_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConfigurationTypeQuestionInfosApi

Returns a new instance of ConfigurationTypeQuestionInfosApi.



17
18
19
 
# File 'lib/connect_wise/api/configuration_type_question_infos_api.rb', line 17

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/connect_wise/api/configuration_type_question_infos_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#get_configurations_types_by_parent_id_questions_info(parent_id, client_id, opts = {}) ⇒ Array<ConfigurationTypeQuestionInfo>

Get List of ConfigurationTypeQuestionInfos

Parameters:

  • typeId

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:



34
35
36
37
 
# File 'lib/connect_wise/api/configuration_type_question_infos_api.rb', line 34

def get_configurations_types_by_parent_id_questions_info(parent_id, client_id, opts = {})
  data, _status_code, _headers = get_configurations_types_by_parent_id_questions_info_with_http_info(parent_id, client_id, opts)
  data
end

#get_configurations_types_by_parent_id_questions_info_count(parent_id, client_id, opts = {}) ⇒ Count

Get Count of ConfigurationTypeQuestionInfos

Parameters:

  • typeId

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:



119
120
121
122
 
# File 'lib/connect_wise/api/configuration_type_question_infos_api.rb', line 119

def get_configurations_types_by_parent_id_questions_info_count(parent_id, client_id, opts = {})
  data, _status_code, _headers = get_configurations_types_by_parent_id_questions_info_count_with_http_info(parent_id, client_id, opts)
  data
end

#get_configurations_types_by_parent_id_questions_info_count_with_http_info(parent_id, client_id, opts = {}) ⇒ Array<(Count, Integer, Hash)>

Get Count of ConfigurationTypeQuestionInfos

Parameters:

  • typeId

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:

  • Count data, response status code and response headers

Raises:



137
138
139
140
141
142
143
144
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
184
185
186
187
188
189
 
# File 'lib/connect_wise/api/configuration_type_question_infos_api.rb', line 137

def get_configurations_types_by_parent_id_questions_info_count_with_http_info(parent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: ConfigurationTypeQuestionInfosApi.get_configurations_types_by_parent_id_questions_info_count ...' if @api_client.config.debugging
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling ConfigurationTypeQuestionInfosApi.get_configurations_types_by_parent_id_questions_info_count" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling ConfigurationTypeQuestionInfosApi.get_configurations_types_by_parent_id_questions_info_count" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/configurations/types/{parentId}/questions/info/count'.sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:conditions] = opts[:conditions] unless opts[:conditions].nil?
  query_params[:childConditions] = opts[:child_conditions] unless opts[:child_conditions].nil?
  query_params[:customFieldConditions] = opts[:custom_field_conditions] unless opts[:custom_field_conditions].nil?
  query_params[:orderBy] = opts[:order_by] unless opts[:order_by].nil?
  query_params[:fields] = opts[:fields] unless opts[:fields].nil?
  query_params[:page] = opts[:page] unless opts[:page].nil?
  query_params[:pageSize] = opts[:page_size] unless opts[:page_size].nil?
  query_params[:pageId] = opts[:page_id] unless opts[:page_id].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Count'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'ConfigurationTypeQuestionInfosApi.get_configurations_types_by_parent_id_questions_info_count',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  @api_client.config.logger.debug "API called: ConfigurationTypeQuestionInfosApi#get_configurations_types_by_parent_id_questions_info_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_configurations_types_by_parent_id_questions_info_with_http_info(parent_id, client_id, opts = {}) ⇒ Array<(Array<ConfigurationTypeQuestionInfo>, Integer, Hash)>

Get List of ConfigurationTypeQuestionInfos

Parameters:

  • typeId

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:

  • Array<ConfigurationTypeQuestionInfo> data, response status code and response headers

Raises:



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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/connect_wise/api/configuration_type_question_infos_api.rb', line 52

def get_configurations_types_by_parent_id_questions_info_with_http_info(parent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: ConfigurationTypeQuestionInfosApi.get_configurations_types_by_parent_id_questions_info ...' if @api_client.config.debugging
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling ConfigurationTypeQuestionInfosApi.get_configurations_types_by_parent_id_questions_info" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling ConfigurationTypeQuestionInfosApi.get_configurations_types_by_parent_id_questions_info" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/configurations/types/{parentId}/questions/info'.sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:conditions] = opts[:conditions] unless opts[:conditions].nil?
  query_params[:childConditions] = opts[:child_conditions] unless opts[:child_conditions].nil?
  query_params[:customFieldConditions] = opts[:custom_field_conditions] unless opts[:custom_field_conditions].nil?
  query_params[:orderBy] = opts[:order_by] unless opts[:order_by].nil?
  query_params[:fields] = opts[:fields] unless opts[:fields].nil?
  query_params[:page] = opts[:page] unless opts[:page].nil?
  query_params[:pageSize] = opts[:page_size] unless opts[:page_size].nil?
  query_params[:pageId] = opts[:page_id] unless opts[:page_id].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<ConfigurationTypeQuestionInfo>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'ConfigurationTypeQuestionInfosApi.get_configurations_types_by_parent_id_questions_info',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  @api_client.config.logger.debug "API called: ConfigurationTypeQuestionInfosApi#get_configurations_types_by_parent_id_questions_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end