Class: ConnectWise::ConfigurationTypeQuestionValueInfosApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConfigurationTypeQuestionValueInfosApi

Returns a new instance of ConfigurationTypeQuestionValueInfosApi.



17
18
19
 
# File 'lib/connect_wise/api/configuration_type_question_value_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_value_infos_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#get_configurations_types_by_grandparent_id_questions_by_parent_id_values_by_id_info(grandparent_id, parent_id, id, client_id, opts = {}) ⇒ ConfigurationTypeQuestionInfo

Get ConfigurationTypeQuestionValueInfo

Parameters:

  • ConfigurationTypeQuestionInfo

  • ConfigurationTypeQuestionInfo

  • ConfigurationTypeQuestionInfo

  • (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:



36
37
38
39
 
# File 'lib/connect_wise/api/configuration_type_question_value_infos_api.rb', line 36

def get_configurations_types_by_grandparent_id_questions_by_parent_id_values_by_id_info(grandparent_id, parent_id, id, client_id, opts = {})
  data, _status_code, _headers = get_configurations_types_by_grandparent_id_questions_by_parent_id_values_by_id_info_with_http_info(grandparent_id, parent_id, id, client_id, opts)
  data
end

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

Get ConfigurationTypeQuestionValueInfo

Parameters:

  • ConfigurationTypeQuestionInfo

  • ConfigurationTypeQuestionInfo

  • ConfigurationTypeQuestionInfo

  • (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:

  • ConfigurationTypeQuestionInfo data, response status code and response headers

Raises:



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
105
106
107
108
109
110
111
112
 
# File 'lib/connect_wise/api/configuration_type_question_value_infos_api.rb', line 56

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

  # resource path
  local_var_path = '/configurations/types/{grandparentId}/questions/{parentId}/values/{id}/info'.sub('{' + 'grandparentId' + '}', CGI.escape(grandparent_id.to_s)).sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s)).sub('{' + 'id' + '}', CGI.escape(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] || 'ConfigurationTypeQuestionInfo'

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

  new_options = opts.merge(
    operation: :'ConfigurationTypeQuestionValueInfosApi.get_configurations_types_by_grandparent_id_questions_by_parent_id_values_by_id_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: ConfigurationTypeQuestionValueInfosApi#get_configurations_types_by_grandparent_id_questions_by_parent_id_values_by_id_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_configurations_types_by_grandparent_id_questions_by_parent_id_values_info(grandparent_id, parent_id, client_id, opts = {}) ⇒ Array<ConfigurationTypeQuestionValueInfo>

Get ConfigurationTypeQuestionValueInfo

Parameters:

  • ConfigurationTypeQuestionValueInfo

  • ConfigurationTypeQuestionValueInfo

  • (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:



128
129
130
131
 
# File 'lib/connect_wise/api/configuration_type_question_value_infos_api.rb', line 128

def get_configurations_types_by_grandparent_id_questions_by_parent_id_values_info(grandparent_id, parent_id, client_id, opts = {})
  data, _status_code, _headers = get_configurations_types_by_grandparent_id_questions_by_parent_id_values_info_with_http_info(grandparent_id, parent_id, client_id, opts)
  data
end

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

Get Count of ConfigurationTypeQuestionValueInfos

Parameters:

  • ConfigurationTypeQuestionValueInfo

  • ConfigurationTypeQuestionValueInfo

  • (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:



217
218
219
220
 
# File 'lib/connect_wise/api/configuration_type_question_value_infos_api.rb', line 217

def get_configurations_types_by_grandparent_id_questions_by_parent_id_values_info_count(grandparent_id, parent_id, client_id, opts = {})
  data, _status_code, _headers = get_configurations_types_by_grandparent_id_questions_by_parent_id_values_info_count_with_http_info(grandparent_id, parent_id, client_id, opts)
  data
end

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

Get Count of ConfigurationTypeQuestionValueInfos

Parameters:

  • ConfigurationTypeQuestionValueInfo

  • ConfigurationTypeQuestionValueInfo

  • (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:



236
237
238
239
240
241
242
243
244
245
246
247
248
249
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
286
287
288
289
290
 
# File 'lib/connect_wise/api/configuration_type_question_value_infos_api.rb', line 236

def get_configurations_types_by_grandparent_id_questions_by_parent_id_values_info_count_with_http_info(grandparent_id, parent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: ConfigurationTypeQuestionValueInfosApi.get_configurations_types_by_grandparent_id_questions_by_parent_id_values_info_count ...' if @api_client.config.debugging
  # verify the required parameter 'grandparent_id' is set
  raise ArgumentError, "Missing the required parameter 'grandparent_id' when calling ConfigurationTypeQuestionValueInfosApi.get_configurations_types_by_grandparent_id_questions_by_parent_id_values_info_count" if @api_client.config.client_side_validation && grandparent_id.nil?
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling ConfigurationTypeQuestionValueInfosApi.get_configurations_types_by_grandparent_id_questions_by_parent_id_values_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 ConfigurationTypeQuestionValueInfosApi.get_configurations_types_by_grandparent_id_questions_by_parent_id_values_info_count" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/configurations/types/{grandparentId}/questions/{parentId}/values/info/count'.sub('{' + 'grandparentId' + '}', CGI.escape(grandparent_id.to_s)).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: :'ConfigurationTypeQuestionValueInfosApi.get_configurations_types_by_grandparent_id_questions_by_parent_id_values_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: ConfigurationTypeQuestionValueInfosApi#get_configurations_types_by_grandparent_id_questions_by_parent_id_values_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_grandparent_id_questions_by_parent_id_values_info_with_http_info(grandparent_id, parent_id, client_id, opts = {}) ⇒ Array<(Array<ConfigurationTypeQuestionValueInfo>, Integer, Hash)>

Get ConfigurationTypeQuestionValueInfo

Parameters:

  • ConfigurationTypeQuestionValueInfo

  • ConfigurationTypeQuestionValueInfo

  • (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<ConfigurationTypeQuestionValueInfo> data, response status code and response headers

Raises:



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
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/connect_wise/api/configuration_type_question_value_infos_api.rb', line 147

def get_configurations_types_by_grandparent_id_questions_by_parent_id_values_info_with_http_info(grandparent_id, parent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: ConfigurationTypeQuestionValueInfosApi.get_configurations_types_by_grandparent_id_questions_by_parent_id_values_info ...' if @api_client.config.debugging
  # verify the required parameter 'grandparent_id' is set
  raise ArgumentError, "Missing the required parameter 'grandparent_id' when calling ConfigurationTypeQuestionValueInfosApi.get_configurations_types_by_grandparent_id_questions_by_parent_id_values_info" if @api_client.config.client_side_validation && grandparent_id.nil?
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling ConfigurationTypeQuestionValueInfosApi.get_configurations_types_by_grandparent_id_questions_by_parent_id_values_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 ConfigurationTypeQuestionValueInfosApi.get_configurations_types_by_grandparent_id_questions_by_parent_id_values_info" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/configurations/types/{grandparentId}/questions/{parentId}/values/info'.sub('{' + 'grandparentId' + '}', CGI.escape(grandparent_id.to_s)).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<ConfigurationTypeQuestionValueInfo>'

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

  new_options = opts.merge(
    operation: :'ConfigurationTypeQuestionValueInfosApi.get_configurations_types_by_grandparent_id_questions_by_parent_id_values_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: ConfigurationTypeQuestionValueInfosApi#get_configurations_types_by_grandparent_id_questions_by_parent_id_values_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end