Class: ConnectWise::BoardItemAssociationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BoardItemAssociationsApi

Returns a new instance of BoardItemAssociationsApi.



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

def api_client
  @api_client
end

Instance Method Details

#service_boards_board_id_items_item_id_associations_association_id_get(board_id, item_id, association_id, opts = {}) ⇒ BoardItemAssociation

Get Board Item Association By Id

Parameters:

  • board_id
  • item_id
  • association_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



19
20
21
22
 
# File 'lib/connectwise-ruby-sdk/api/board_item_associations_api.rb', line 19

def service_boards_board_id_items_item_id_associations_association_id_get(board_id, item_id, association_id, opts = {})
  data, _status_code, _headers = service_boards_board_id_items_item_id_associations_association_id_get_with_http_info(board_id, item_id, association_id, opts)
  return data
end

#service_boards_board_id_items_item_id_associations_association_id_get_with_http_info(board_id, item_id, association_id, opts = {}) ⇒ Array<(BoardItemAssociation, Fixnum, Hash)>

Get Board Item Association By Id

Parameters:

  • board_id
  • item_id
  • association_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    BoardItemAssociation data, response status code and response headers



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
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/connectwise-ruby-sdk/api/board_item_associations_api.rb', line 31

def service_boards_board_id_items_item_id_associations_association_id_get_with_http_info(board_id, item_id, association_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_association_id_get ..."
  end
  # verify the required parameter 'board_id' is set
  if @api_client.config.client_side_validation && board_id.nil?
    fail ArgumentError, "Missing the required parameter 'board_id' when calling BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_association_id_get"
  end
  # verify the required parameter 'item_id' is set
  if @api_client.config.client_side_validation && item_id.nil?
    fail ArgumentError, "Missing the required parameter 'item_id' when calling BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_association_id_get"
  end
  # verify the required parameter 'association_id' is set
  if @api_client.config.client_side_validation && association_id.nil?
    fail ArgumentError, "Missing the required parameter 'association_id' when calling BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_association_id_get"
  end
  # resource path
  local_var_path = "/service/boards/{boardId}/items/{itemId}/associations/{associationId}".sub('{' + 'boardId' + '}', board_id.to_s).sub('{' + 'itemId' + '}', item_id.to_s).sub('{' + 'associationId' + '}', association_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 => 'BoardItemAssociation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BoardItemAssociationsApi#service_boards_board_id_items_item_id_associations_association_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_boards_board_id_items_item_id_associations_count_get(board_id, item_id, opts = {}) ⇒ Count

Get Board Item Association Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:



84
85
86
87
 
# File 'lib/connectwise-ruby-sdk/api/board_item_associations_api.rb', line 84

def service_boards_board_id_items_item_id_associations_count_get(board_id, item_id, opts = {})
  data, _status_code, _headers = service_boards_board_id_items_item_id_associations_count_get_with_http_info(board_id, item_id, opts)
  return data
end

#service_boards_board_id_items_item_id_associations_count_get_with_http_info(board_id, item_id, opts = {}) ⇒ Array<(Count, Fixnum, Hash)>

Get Board Item Association Count

Parameters:

  • board_id
  • item_id
  • 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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/connectwise-ruby-sdk/api/board_item_associations_api.rb', line 96

def service_boards_board_id_items_item_id_associations_count_get_with_http_info(board_id, item_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_count_get ..."
  end
  # verify the required parameter 'board_id' is set
  if @api_client.config.client_side_validation && board_id.nil?
    fail ArgumentError, "Missing the required parameter 'board_id' when calling BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_count_get"
  end
  # verify the required parameter 'item_id' is set
  if @api_client.config.client_side_validation && item_id.nil?
    fail ArgumentError, "Missing the required parameter 'item_id' when calling BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_count_get"
  end
  # resource path
  local_var_path = "/service/boards/{boardId}/items/{itemId}/associations/count".sub('{' + 'boardId' + '}', board_id.to_s).sub('{' + 'itemId' + '}', item_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: BoardItemAssociationsApi#service_boards_board_id_items_item_id_associations_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_boards_board_id_items_item_id_associations_get(board_id, item_id, opts = {}) ⇒ Array<BoardItemAssociation>

Get Board Item Association

Parameters:

  • board_id
  • item_id
  • 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:



151
152
153
154
 
# File 'lib/connectwise-ruby-sdk/api/board_item_associations_api.rb', line 151

def service_boards_board_id_items_item_id_associations_get(board_id, item_id, opts = {})
  data, _status_code, _headers = service_boards_board_id_items_item_id_associations_get_with_http_info(board_id, item_id, opts)
  return data
end

#service_boards_board_id_items_item_id_associations_get_with_http_info(board_id, item_id, opts = {}) ⇒ Array<(Array<BoardItemAssociation>, Fixnum, Hash)>

Get Board Item Association

Parameters:

  • board_id
  • item_id
  • 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<BoardItemAssociation>, Fixnum, Hash)>) —

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



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
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/connectwise-ruby-sdk/api/board_item_associations_api.rb', line 168

def service_boards_board_id_items_item_id_associations_get_with_http_info(board_id, item_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_get ..."
  end
  # verify the required parameter 'board_id' is set
  if @api_client.config.client_side_validation && board_id.nil?
    fail ArgumentError, "Missing the required parameter 'board_id' when calling BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_get"
  end
  # verify the required parameter 'item_id' is set
  if @api_client.config.client_side_validation && item_id.nil?
    fail ArgumentError, "Missing the required parameter 'item_id' when calling BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_get"
  end
  # resource path
  local_var_path = "/service/boards/{boardId}/items/{itemId}/associations".sub('{' + 'boardId' + '}', board_id.to_s).sub('{' + 'itemId' + '}', item_id.to_s)

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

#service_boards_board_id_items_item_id_associations_id_put(board_id, item_id, id, item_association, opts = {}) ⇒ BoardItemAssociation

Replace Board Item Association

Parameters:

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

    the optional parameters

Returns:



224
225
226
227
 
# File 'lib/connectwise-ruby-sdk/api/board_item_associations_api.rb', line 224

def service_boards_board_id_items_item_id_associations_id_put(board_id, item_id, id, item_association, opts = {})
  data, _status_code, _headers = service_boards_board_id_items_item_id_associations_id_put_with_http_info(board_id, item_id, id, item_association, opts)
  return data
end

#service_boards_board_id_items_item_id_associations_id_put_with_http_info(board_id, item_id, id, item_association, opts = {}) ⇒ Array<(BoardItemAssociation, Fixnum, Hash)>

Replace Board Item Association

Parameters:

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

    the optional parameters

Returns:

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

    BoardItemAssociation data, response status code and response headers



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

def service_boards_board_id_items_item_id_associations_id_put_with_http_info(board_id, item_id, id, item_association, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_id_put ..."
  end
  # verify the required parameter 'board_id' is set
  if @api_client.config.client_side_validation && board_id.nil?
    fail ArgumentError, "Missing the required parameter 'board_id' when calling BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_id_put"
  end
  # verify the required parameter 'item_id' is set
  if @api_client.config.client_side_validation && item_id.nil?
    fail ArgumentError, "Missing the required parameter 'item_id' when calling BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_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 BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_id_put"
  end
  # verify the required parameter 'item_association' is set
  if @api_client.config.client_side_validation && item_association.nil?
    fail ArgumentError, "Missing the required parameter 'item_association' when calling BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_id_put"
  end
  # resource path
  local_var_path = "/service/boards/{boardId}/items/{itemId}/associations/{id}".sub('{' + 'boardId' + '}', board_id.to_s).sub('{' + 'itemId' + '}', item_id.to_s).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(item_association)
  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 => 'BoardItemAssociation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BoardItemAssociationsApi#service_boards_board_id_items_item_id_associations_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_boards_board_id_items_item_id_associations_type_id_patch(board_id, item_id, type_id, operations, opts = {}) ⇒ BoardItemAssociation

Update Board Item Association

Parameters:

  • board_id —

    The recid of the Service/Project Board

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

    the optional parameters

Returns:



297
298
299
300
 
# File 'lib/connectwise-ruby-sdk/api/board_item_associations_api.rb', line 297

def service_boards_board_id_items_item_id_associations_type_id_patch(board_id, item_id, type_id, operations, opts = {})
  data, _status_code, _headers = service_boards_board_id_items_item_id_associations_type_id_patch_with_http_info(board_id, item_id, type_id, operations, opts)
  return data
end

#service_boards_board_id_items_item_id_associations_type_id_patch_with_http_info(board_id, item_id, type_id, operations, opts = {}) ⇒ Array<(BoardItemAssociation, Fixnum, Hash)>

Update Board Item Association

Parameters:

  • board_id —

    The recid of the Service/Project Board

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

    the optional parameters

Returns:

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

    BoardItemAssociation data, response status code and response headers



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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/connectwise-ruby-sdk/api/board_item_associations_api.rb', line 310

def service_boards_board_id_items_item_id_associations_type_id_patch_with_http_info(board_id, item_id, type_id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_type_id_patch ..."
  end
  # verify the required parameter 'board_id' is set
  if @api_client.config.client_side_validation && board_id.nil?
    fail ArgumentError, "Missing the required parameter 'board_id' when calling BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_type_id_patch"
  end
  # verify the required parameter 'item_id' is set
  if @api_client.config.client_side_validation && item_id.nil?
    fail ArgumentError, "Missing the required parameter 'item_id' when calling BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_type_id_patch"
  end
  # verify the required parameter 'type_id' is set
  if @api_client.config.client_side_validation && type_id.nil?
    fail ArgumentError, "Missing the required parameter 'type_id' when calling BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_type_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 BoardItemAssociationsApi.service_boards_board_id_items_item_id_associations_type_id_patch"
  end
  # resource path
  local_var_path = "/service/boards/{boardId}/items/{itemId}/associations/{typeId}".sub('{' + 'boardId' + '}', board_id.to_s).sub('{' + 'itemId' + '}', item_id.to_s).sub('{' + 'typeId' + '}', type_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 => 'BoardItemAssociation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BoardItemAssociationsApi#service_boards_board_id_items_item_id_associations_type_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end