Class: ConnectWise::BoardItemsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BoardItemsApi

Returns a new instance of BoardItemsApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_service_boards_by_parent_id_items_by_id(id, parent_id, client_id, opts = {}) ⇒ nil

Delete BoardItem

Parameters:

  • id (Integer) —

    itemId

  • parent_id (Integer) —

    boardId

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/connect_wise/api/board_items_api.rb', line 27

def delete_service_boards_by_parent_id_items_by_id(id, parent_id, client_id, opts = {})
  delete_service_boards_by_parent_id_items_by_id_with_http_info(id, parent_id, client_id, opts)
  nil
end

#delete_service_boards_by_parent_id_items_by_id_with_http_info(id, parent_id, client_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete BoardItem

Parameters:

  • id (Integer) —

    itemId

  • parent_id (Integer) —

    boardId

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

    the optional parameters

Returns:

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

    nil, response status code and response headers

Raises:

  • (ArgumentError) 


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
76
77
78
79
80
81
82
 
# File 'lib/connect_wise/api/board_items_api.rb', line 38

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

  # resource path
  local_var_path = '/service/boards/{parentId}/items/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  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]

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

  new_options = opts.merge(
    operation: :'BoardItemsApi.delete_service_boards_by_parent_id_items_by_id',
    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(:DELETE, local_var_path, new_options)
  @api_client.config.logger.debug "API called: BoardItemsApi#delete_service_boards_by_parent_id_items_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_service_boards_by_parent_id_items(parent_id, client_id, opts = {}) ⇒ Array<BoardItem>

Get List of BoardItem

Parameters:

  • parent_id (Integer) —

    boardId

  • client_id (String)
  • opts (Hash) (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:



97
98
99
100
 
# File 'lib/connect_wise/api/board_items_api.rb', line 97

def get_service_boards_by_parent_id_items(parent_id, client_id, opts = {})
  data, _status_code, _headers = get_service_boards_by_parent_id_items_with_http_info(parent_id, client_id, opts)
  data
end

#get_service_boards_by_parent_id_items_by_id(id, parent_id, client_id, opts = {}) ⇒ BoardItem

Get BoardItem

Parameters:

  • id (Integer) —

    itemId

  • parent_id (Integer) —

    boardId

  • client_id (String)
  • opts (Hash) (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:



183
184
185
186
 
# File 'lib/connect_wise/api/board_items_api.rb', line 183

def get_service_boards_by_parent_id_items_by_id(id, parent_id, client_id, opts = {})
  data, _status_code, _headers = get_service_boards_by_parent_id_items_by_id_with_http_info(id, parent_id, client_id, opts)
  data
end

#get_service_boards_by_parent_id_items_by_id_usages(id, parent_id, client_id, opts = {}) ⇒ Array<Usage>

Get List of Usage Count

Parameters:

  • id (Integer) —

    itemId

  • parent_id (Integer) —

    boardId

  • client_id (String)
  • opts (Hash) (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:



272
273
274
275
 
# File 'lib/connect_wise/api/board_items_api.rb', line 272

def get_service_boards_by_parent_id_items_by_id_usages(id, parent_id, client_id, opts = {})
  data, _status_code, _headers = get_service_boards_by_parent_id_items_by_id_usages_with_http_info(id, parent_id, client_id, opts)
  data
end

#get_service_boards_by_parent_id_items_by_id_usages_list(id, parent_id, client_id, opts = {}) ⇒ Array<Usage>

Get List of Usage

Parameters:

  • id (Integer) —

    itemId

  • parent_id (Integer) —

    boardId

  • client_id (String)
  • opts (Hash) (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:



361
362
363
364
 
# File 'lib/connect_wise/api/board_items_api.rb', line 361

def get_service_boards_by_parent_id_items_by_id_usages_list(id, parent_id, client_id, opts = {})
  data, _status_code, _headers = get_service_boards_by_parent_id_items_by_id_usages_list_with_http_info(id, parent_id, client_id, opts)
  data
end

#get_service_boards_by_parent_id_items_by_id_usages_list_with_http_info(id, parent_id, client_id, opts = {}) ⇒ Array<(Array<Usage>, Integer, Hash)>

Get List of Usage

Parameters:

  • id (Integer) —

    itemId

  • parent_id (Integer) —

    boardId

  • client_id (String)
  • opts (Hash) (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<(Array<Usage>, Integer, Hash)>) —

    Array<Usage> data, response status code and response headers

Raises:

  • (ArgumentError) 


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/connect_wise/api/board_items_api.rb', line 380

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

  # resource path
  local_var_path = '/service/boards/{parentId}/items/{id}/usages/list'.sub('{' + 'id' + '}', CGI.escape(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<Usage>'

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

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

#get_service_boards_by_parent_id_items_by_id_usages_with_http_info(id, parent_id, client_id, opts = {}) ⇒ Array<(Array<Usage>, Integer, Hash)>

Get List of Usage Count

Parameters:

  • id (Integer) —

    itemId

  • parent_id (Integer) —

    boardId

  • client_id (String)
  • opts (Hash) (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<(Array<Usage>, Integer, Hash)>) —

    Array<Usage> data, response status code and response headers

Raises:

  • (ArgumentError) 


291
292
293
294
295
296
297
298
299
300
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
337
338
339
340
341
342
343
344
345
 
# File 'lib/connect_wise/api/board_items_api.rb', line 291

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

  # resource path
  local_var_path = '/service/boards/{parentId}/items/{id}/usages'.sub('{' + 'id' + '}', CGI.escape(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<Usage>'

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

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

#get_service_boards_by_parent_id_items_by_id_with_http_info(id, parent_id, client_id, opts = {}) ⇒ Array<(BoardItem, Integer, Hash)>

Get BoardItem

Parameters:

  • id (Integer) —

    itemId

  • parent_id (Integer) —

    boardId

  • client_id (String)
  • opts (Hash) (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<(BoardItem, Integer, Hash)>) —

    BoardItem data, response status code and response headers

Raises:

  • (ArgumentError) 


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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/connect_wise/api/board_items_api.rb', line 202

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

  # resource path
  local_var_path = '/service/boards/{parentId}/items/{id}'.sub('{' + 'id' + '}', CGI.escape(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] || 'BoardItem'

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

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

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

Get Count of Usage

Parameters:

  • parent_id (Integer) —

    boardId

  • client_id (String)
  • opts (Hash) (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:



449
450
451
452
 
# File 'lib/connect_wise/api/board_items_api.rb', line 449

def get_service_boards_by_parent_id_items_count(parent_id, client_id, opts = {})
  data, _status_code, _headers = get_service_boards_by_parent_id_items_count_with_http_info(parent_id, client_id, opts)
  data
end

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

Get Count of Usage

Parameters:

  • parent_id (Integer) —

    boardId

  • client_id (String)
  • opts (Hash) (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<(Count, Integer, Hash)>) —

    Count data, response status code and response headers

Raises:

  • (ArgumentError) 


467
468
469
470
471
472
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
511
512
513
514
515
516
517
518
519
 
# File 'lib/connect_wise/api/board_items_api.rb', line 467

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

  # resource path
  local_var_path = '/service/boards/{parentId}/items/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: :'BoardItemsApi.get_service_boards_by_parent_id_items_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: BoardItemsApi#get_service_boards_by_parent_id_items_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

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

Get List of BoardItem

Parameters:

  • parent_id (Integer) —

    boardId

  • client_id (String)
  • opts (Hash) (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<(Array<BoardItem>, Integer, Hash)>) —

    Array<BoardItem> data, response status code and response headers

Raises:

  • (ArgumentError) 


115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
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
 
# File 'lib/connect_wise/api/board_items_api.rb', line 115

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

  # resource path
  local_var_path = '/service/boards/{parentId}/items'.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<BoardItem>'

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

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

#patch_service_boards_by_parent_id_items_by_id(id, parent_id, client_id, patch_operation, opts = {}) ⇒ BoardItem

Patch BoardItem

Parameters:

  • id (Integer) —

    itemId

  • parent_id (Integer) —

    boardId

  • client_id (String)
  • patch_operation (Array<PatchOperation>) —

    List of PatchOperation

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

    the optional parameters

Returns:



528
529
530
531
 
# File 'lib/connect_wise/api/board_items_api.rb', line 528

def patch_service_boards_by_parent_id_items_by_id(id, parent_id, client_id, patch_operation, opts = {})
  data, _status_code, _headers = patch_service_boards_by_parent_id_items_by_id_with_http_info(id, parent_id, client_id, patch_operation, opts)
  data
end

#patch_service_boards_by_parent_id_items_by_id_with_http_info(id, parent_id, client_id, patch_operation, opts = {}) ⇒ Array<(BoardItem, Integer, Hash)>

Patch BoardItem

Parameters:

  • id (Integer) —

    itemId

  • parent_id (Integer) —

    boardId

  • client_id (String)
  • patch_operation (Array<PatchOperation>) —

    List of PatchOperation

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

    the optional parameters

Returns:

  • (Array<(BoardItem, Integer, Hash)>) —

    BoardItem data, response status code and response headers

Raises:

  • (ArgumentError) 


540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
 
# File 'lib/connect_wise/api/board_items_api.rb', line 540

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

  # resource path
  local_var_path = '/service/boards/{parentId}/items/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_operation)

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

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

  new_options = opts.merge(
    operation: :'BoardItemsApi.patch_service_boards_by_parent_id_items_by_id',
    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(:PATCH, local_var_path, new_options)
  @api_client.config.logger.debug "API called: BoardItemsApi#patch_service_boards_by_parent_id_items_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#post_service_boards_by_parent_id_items(parent_id, client_id, board_item, opts = {}) ⇒ BoardItem

Post BoardItem

Parameters:

  • parent_id (Integer) —

    boardId

  • client_id (String)
  • board_item (BoardItem) —

    boardItem

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

    the optional parameters

Returns:



599
600
601
602
 
# File 'lib/connect_wise/api/board_items_api.rb', line 599

def post_service_boards_by_parent_id_items(parent_id, client_id, board_item, opts = {})
  data, _status_code, _headers = post_service_boards_by_parent_id_items_with_http_info(parent_id, client_id, board_item, opts)
  data
end

#post_service_boards_by_parent_id_items_with_http_info(parent_id, client_id, board_item, opts = {}) ⇒ Array<(BoardItem, Integer, Hash)>

Post BoardItem

Parameters:

  • parent_id (Integer) —

    boardId

  • client_id (String)
  • board_item (BoardItem) —

    boardItem

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

    the optional parameters

Returns:

  • (Array<(BoardItem, Integer, Hash)>) —

    BoardItem data, response status code and response headers

Raises:

  • (ArgumentError) 


610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
 
# File 'lib/connect_wise/api/board_items_api.rb', line 610

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

  # resource path
  local_var_path = '/service/boards/{parentId}/items'.sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(board_item)

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

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

  new_options = opts.merge(
    operation: :'BoardItemsApi.post_service_boards_by_parent_id_items',
    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(:POST, local_var_path, new_options)
  @api_client.config.logger.debug "API called: BoardItemsApi#post_service_boards_by_parent_id_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#put_service_boards_by_parent_id_items_by_id(id, parent_id, client_id, board_item, opts = {}) ⇒ BoardItem

Put BoardItem

Parameters:

  • id (Integer) —

    itemId

  • parent_id (Integer) —

    boardId

  • client_id (String)
  • board_item (BoardItem) —

    boardItem

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

    the optional parameters

Returns:



668
669
670
671
 
# File 'lib/connect_wise/api/board_items_api.rb', line 668

def put_service_boards_by_parent_id_items_by_id(id, parent_id, client_id, board_item, opts = {})
  data, _status_code, _headers = put_service_boards_by_parent_id_items_by_id_with_http_info(id, parent_id, client_id, board_item, opts)
  data
end

#put_service_boards_by_parent_id_items_by_id_with_http_info(id, parent_id, client_id, board_item, opts = {}) ⇒ Array<(BoardItem, Integer, Hash)>

Put BoardItem

Parameters:

  • id (Integer) —

    itemId

  • parent_id (Integer) —

    boardId

  • client_id (String)
  • board_item (BoardItem) —

    boardItem

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

    the optional parameters

Returns:

  • (Array<(BoardItem, Integer, Hash)>) —

    BoardItem data, response status code and response headers

Raises:

  • (ArgumentError) 


680
681
682
683
684
685
686
687
688
689
690
691
692
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
 
# File 'lib/connect_wise/api/board_items_api.rb', line 680

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

  # resource path
  local_var_path = '/service/boards/{parentId}/items/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # 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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(board_item)

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

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

  new_options = opts.merge(
    operation: :'BoardItemsApi.put_service_boards_by_parent_id_items_by_id',
    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(:PUT, local_var_path, new_options)
  @api_client.config.logger.debug "API called: BoardItemsApi#put_service_boards_by_parent_id_items_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end