Class: ConnectWise::BoardsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BoardsApi

Returns a new instance of BoardsApi.



8
9
10
 
# File 'lib/connectwise-ruby-sdk/api/boards_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/boards_api.rb', line 6

def api_client
  @api_client
end

Instance Method Details

#service_boards_copy_post(copy, opts = {}) ⇒ Board

Copy Board

Parameters:

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

    the optional parameters

Returns:



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

def service_boards_copy_post(copy, opts = {})
  data, _status_code, _headers = service_boards_copy_post_with_http_info(copy, opts)
  return data
end

#service_boards_copy_post_with_http_info(copy, opts = {}) ⇒ Array<(Board, Fixnum, Hash)>

Copy Board

Parameters:

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

    the optional parameters

Returns:

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

    Board data, response status code and response headers



27
28
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
 
# File 'lib/connectwise-ruby-sdk/api/boards_api.rb', line 27

def service_boards_copy_post_with_http_info(copy, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardsApi.service_boards_copy_post ..."
  end
  # verify the required parameter 'copy' is set
  if @api_client.config.client_side_validation && copy.nil?
    fail ArgumentError, "Missing the required parameter 'copy' when calling BoardsApi.service_boards_copy_post"
  end
  # resource path
  local_var_path = "/service/boards/copy"

  # 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(copy)
  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 => 'Board')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BoardsApi#service_boards_copy_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_boards_count_get(opts = {}) ⇒ Count

Get Boards Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:



72
73
74
75
 
# File 'lib/connectwise-ruby-sdk/api/boards_api.rb', line 72

def service_boards_count_get(opts = {})
  data, _status_code, _headers = service_boards_count_get_with_http_info(opts)
  return data
end

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

Get Boards Count

Parameters:

  • 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



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
113
114
115
 
# File 'lib/connectwise-ruby-sdk/api/boards_api.rb', line 82

def service_boards_count_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardsApi.service_boards_count_get ..."
  end
  # resource path
  local_var_path = "/service/boards/count"

  # 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: BoardsApi#service_boards_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_boards_get(opts = {}) ⇒ Array<Board>

Get Boards

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)

Returns:



127
128
129
130
 
# File 'lib/connectwise-ruby-sdk/api/boards_api.rb', line 127

def service_boards_get(opts = {})
  data, _status_code, _headers = service_boards_get_with_http_info(opts)
  return data
end

#service_boards_get_with_http_info(opts = {}) ⇒ Array<(Array<Board>, Fixnum, Hash)>

Get Boards

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)

Returns:

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

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



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
 
# File 'lib/connectwise-ruby-sdk/api/boards_api.rb', line 142

def service_boards_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardsApi.service_boards_get ..."
  end
  # resource path
  local_var_path = "/service/boards"

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'childconditions'] = opts[:'childconditions'] if !opts[:'childconditions'].nil?
  query_params[:'customfieldconditions'] = opts[:'customfieldconditions'] if !opts[:'customfieldconditions'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].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 => 'Array<Board>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BoardsApi#service_boards_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_boards_id_delete(id, opts = {}) ⇒ nil

Delete Board By Id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


187
188
189
190
 
# File 'lib/connectwise-ruby-sdk/api/boards_api.rb', line 187

def service_boards_id_delete(id, opts = {})
  service_boards_id_delete_with_http_info(id, opts)
  return nil
end

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

Delete Board By Id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



197
198
199
200
201
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
 
# File 'lib/connectwise-ruby-sdk/api/boards_api.rb', line 197

def service_boards_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardsApi.service_boards_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 BoardsApi.service_boards_id_delete"
  end
  # resource path
  local_var_path = "/service/boards/{id}".sub('{' + 'id' + '}', 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: BoardsApi#service_boards_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_boards_id_get(id, opts = {}) ⇒ Board

Get Board By Id

Parameters:

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

    the optional parameters

Returns:



237
238
239
240
 
# File 'lib/connectwise-ruby-sdk/api/boards_api.rb', line 237

def service_boards_id_get(id, opts = {})
  data, _status_code, _headers = service_boards_id_get_with_http_info(id, opts)
  return data
end

#service_boards_id_get_with_http_info(id, opts = {}) ⇒ Array<(Board, Fixnum, Hash)>

Get Board By Id

Parameters:

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

    the optional parameters

Returns:

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

    Board data, response status code and response headers



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
 
# File 'lib/connectwise-ruby-sdk/api/boards_api.rb', line 247

def service_boards_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardsApi.service_boards_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 BoardsApi.service_boards_id_get"
  end
  # resource path
  local_var_path = "/service/boards/{id}".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'])

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

#service_boards_id_patch(id, operations, opts = {}) ⇒ Board

Update Board

Parameters:

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

    the optional parameters

Returns:



291
292
293
294
 
# File 'lib/connectwise-ruby-sdk/api/boards_api.rb', line 291

def service_boards_id_patch(id, operations, opts = {})
  data, _status_code, _headers = service_boards_id_patch_with_http_info(id, operations, opts)
  return data
end

#service_boards_id_patch_with_http_info(id, operations, opts = {}) ⇒ Array<(Board, Fixnum, Hash)>

Update Board

Parameters:

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

    the optional parameters

Returns:

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

    Board data, response status code and response headers



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
 
# File 'lib/connectwise-ruby-sdk/api/boards_api.rb', line 302

def service_boards_id_patch_with_http_info(id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardsApi.service_boards_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 BoardsApi.service_boards_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 BoardsApi.service_boards_id_patch"
  end
  # resource path
  local_var_path = "/service/boards/{id}".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(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 => 'Board')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BoardsApi#service_boards_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_boards_id_put(id, board, opts = {}) ⇒ Board

Replace Board

Parameters:

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

    the optional parameters

Returns:



352
353
354
355
 
# File 'lib/connectwise-ruby-sdk/api/boards_api.rb', line 352

def service_boards_id_put(id, board, opts = {})
  data, _status_code, _headers = service_boards_id_put_with_http_info(id, board, opts)
  return data
end

#service_boards_id_put_with_http_info(id, board, opts = {}) ⇒ Array<(Board, Fixnum, Hash)>

Replace Board

Parameters:

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

    the optional parameters

Returns:

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

    Board data, response status code and response headers



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
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
 
# File 'lib/connectwise-ruby-sdk/api/boards_api.rb', line 363

def service_boards_id_put_with_http_info(id, board, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardsApi.service_boards_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 BoardsApi.service_boards_id_put"
  end
  # verify the required parameter 'board' is set
  if @api_client.config.client_side_validation && board.nil?
    fail ArgumentError, "Missing the required parameter 'board' when calling BoardsApi.service_boards_id_put"
  end
  # resource path
  local_var_path = "/service/boards/{id}".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(board)
  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 => 'Board')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BoardsApi#service_boards_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_boards_post(board, opts = {}) ⇒ Board

Create Board

Parameters:

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

    the optional parameters

Returns:



412
413
414
415
 
# File 'lib/connectwise-ruby-sdk/api/boards_api.rb', line 412

def service_boards_post(board, opts = {})
  data, _status_code, _headers = service_boards_post_with_http_info(board, opts)
  return data
end

#service_boards_post_with_http_info(board, opts = {}) ⇒ Array<(Board, Fixnum, Hash)>

Create Board

Parameters:

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

    the optional parameters

Returns:

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

    Board data, response status code and response headers



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/connectwise-ruby-sdk/api/boards_api.rb', line 422

def service_boards_post_with_http_info(board, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardsApi.service_boards_post ..."
  end
  # verify the required parameter 'board' is set
  if @api_client.config.client_side_validation && board.nil?
    fail ArgumentError, "Missing the required parameter 'board' when calling BoardsApi.service_boards_post"
  end
  # resource path
  local_var_path = "/service/boards"

  # 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(board)
  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 => 'Board')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BoardsApi#service_boards_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end