Class: ConnectWise::BoardStatusNotificationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BoardStatusNotificationsApi

Returns a new instance of BoardStatusNotificationsApi.



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

def api_client
  @api_client
end

Instance Method Details

#service_boards_board_id_statuses_status_id_notifications_count_get(board_id, status_id, opts = {}) ⇒ Count

Get Board Status Notifications Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:



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

def service_boards_board_id_statuses_status_id_notifications_count_get(board_id, status_id, opts = {})
  data, _status_code, _headers = service_boards_board_id_statuses_status_id_notifications_count_get_with_http_info(board_id, status_id, opts)
  return data
end

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

Get Board Status Notifications Count

Parameters:

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



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

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

#service_boards_board_id_statuses_status_id_notifications_get(board_id, status_id, opts = {}) ⇒ Array<BoardStatusNotification>

Get Board Status Notifications

Parameters:

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



86
87
88
89
 
# File 'lib/connectwise-ruby-sdk/api/board_status_notifications_api.rb', line 86

def service_boards_board_id_statuses_status_id_notifications_get(board_id, status_id, opts = {})
  data, _status_code, _headers = service_boards_board_id_statuses_status_id_notifications_get_with_http_info(board_id, status_id, opts)
  return data
end

#service_boards_board_id_statuses_status_id_notifications_get_with_http_info(board_id, status_id, opts = {}) ⇒ Array<(Array<BoardStatusNotification>, Fixnum, Hash)>

Get Board Status Notifications

Parameters:

  • board_id
  • status_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<BoardStatusNotification>, Fixnum, Hash)>) —

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



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
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/connectwise-ruby-sdk/api/board_status_notifications_api.rb', line 103

def service_boards_board_id_statuses_status_id_notifications_get_with_http_info(board_id, status_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_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 BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_get"
  end
  # verify the required parameter 'status_id' is set
  if @api_client.config.client_side_validation && status_id.nil?
    fail ArgumentError, "Missing the required parameter 'status_id' when calling BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_get"
  end
  # resource path
  local_var_path = "/service/boards/{boardId}/statuses/{statusId}/notifications".sub('{' + 'boardId' + '}', board_id.to_s).sub('{' + 'statusId' + '}', status_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<BoardStatusNotification>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BoardStatusNotificationsApi#service_boards_board_id_statuses_status_id_notifications_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_boards_board_id_statuses_status_id_notifications_id_delete(board_id, status_id, id, opts = {}) ⇒ nil

Delete Board Status Notification By Id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


158
159
160
161
 
# File 'lib/connectwise-ruby-sdk/api/board_status_notifications_api.rb', line 158

def service_boards_board_id_statuses_status_id_notifications_id_delete(board_id, status_id, id, opts = {})
  service_boards_board_id_statuses_status_id_notifications_id_delete_with_http_info(board_id, status_id, id, opts)
  return nil
end

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

Delete Board Status Notification By Id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def service_boards_board_id_statuses_status_id_notifications_id_delete_with_http_info(board_id, status_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_id_delete ..."
  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 BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_id_delete"
  end
  # verify the required parameter 'status_id' is set
  if @api_client.config.client_side_validation && status_id.nil?
    fail ArgumentError, "Missing the required parameter 'status_id' when calling BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_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 BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_id_delete"
  end
  # resource path
  local_var_path = "/service/boards/{boardId}/statuses/{statusId}/notifications/{id}".sub('{' + 'boardId' + '}', board_id.to_s).sub('{' + 'statusId' + '}', status_id.to_s).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: BoardStatusNotificationsApi#service_boards_board_id_statuses_status_id_notifications_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_boards_board_id_statuses_status_id_notifications_id_get(board_id, status_id, id, opts = {}) ⇒ BoardStatusNotification

Get Board Status Notification By Id

Parameters:

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

    the optional parameters

Returns:



220
221
222
223
 
# File 'lib/connectwise-ruby-sdk/api/board_status_notifications_api.rb', line 220

def service_boards_board_id_statuses_status_id_notifications_id_get(board_id, status_id, id, opts = {})
  data, _status_code, _headers = service_boards_board_id_statuses_status_id_notifications_id_get_with_http_info(board_id, status_id, id, opts)
  return data
end

#service_boards_board_id_statuses_status_id_notifications_id_get_with_http_info(board_id, status_id, id, opts = {}) ⇒ Array<(BoardStatusNotification, Fixnum, Hash)>

Get Board Status Notification By Id

Parameters:

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

    the optional parameters

Returns:

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

    BoardStatusNotification data, response status code and response headers



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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/connectwise-ruby-sdk/api/board_status_notifications_api.rb', line 232

def service_boards_board_id_statuses_status_id_notifications_id_get_with_http_info(board_id, status_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_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 BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_id_get"
  end
  # verify the required parameter 'status_id' is set
  if @api_client.config.client_side_validation && status_id.nil?
    fail ArgumentError, "Missing the required parameter 'status_id' when calling BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_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 BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_id_get"
  end
  # resource path
  local_var_path = "/service/boards/{boardId}/statuses/{statusId}/notifications/{id}".sub('{' + 'boardId' + '}', board_id.to_s).sub('{' + 'statusId' + '}', status_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'])

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

#service_boards_board_id_statuses_status_id_notifications_id_patch(board_id, status_id, id, operations, opts = {}) ⇒ BoardStatusNotification

Update Board Status Notification

Parameters:

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

    the optional parameters

Returns:



286
287
288
289
 
# File 'lib/connectwise-ruby-sdk/api/board_status_notifications_api.rb', line 286

def service_boards_board_id_statuses_status_id_notifications_id_patch(board_id, status_id, id, operations, opts = {})
  data, _status_code, _headers = service_boards_board_id_statuses_status_id_notifications_id_patch_with_http_info(board_id, status_id, id, operations, opts)
  return data
end

#service_boards_board_id_statuses_status_id_notifications_id_patch_with_http_info(board_id, status_id, id, operations, opts = {}) ⇒ Array<(BoardStatusNotification, Fixnum, Hash)>

Update Board Status Notification

Parameters:

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

    the optional parameters

Returns:

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

    BoardStatusNotification data, response status code and response headers



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
346
347
348
349
 
# File 'lib/connectwise-ruby-sdk/api/board_status_notifications_api.rb', line 299

def service_boards_board_id_statuses_status_id_notifications_id_patch_with_http_info(board_id, status_id, id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_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 BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_id_patch"
  end
  # verify the required parameter 'status_id' is set
  if @api_client.config.client_side_validation && status_id.nil?
    fail ArgumentError, "Missing the required parameter 'status_id' when calling BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_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 BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_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 BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_id_patch"
  end
  # resource path
  local_var_path = "/service/boards/{boardId}/statuses/{statusId}/notifications/{id}".sub('{' + 'boardId' + '}', board_id.to_s).sub('{' + 'statusId' + '}', status_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(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 => 'BoardStatusNotification')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BoardStatusNotificationsApi#service_boards_board_id_statuses_status_id_notifications_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_boards_board_id_statuses_status_id_notifications_id_put(board_id, status_id, id, board_status_notification, opts = {}) ⇒ BoardStatusNotification

Replace Board Status Notification

Parameters:

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

    the optional parameters

Returns:



359
360
361
362
 
# File 'lib/connectwise-ruby-sdk/api/board_status_notifications_api.rb', line 359

def service_boards_board_id_statuses_status_id_notifications_id_put(board_id, status_id, id, board_status_notification, opts = {})
  data, _status_code, _headers = service_boards_board_id_statuses_status_id_notifications_id_put_with_http_info(board_id, status_id, id, board_status_notification, opts)
  return data
end

#service_boards_board_id_statuses_status_id_notifications_id_put_with_http_info(board_id, status_id, id, board_status_notification, opts = {}) ⇒ Array<(BoardStatusNotification, Fixnum, Hash)>

Replace Board Status Notification

Parameters:

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

    the optional parameters

Returns:

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

    BoardStatusNotification data, response status code and response headers



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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/connectwise-ruby-sdk/api/board_status_notifications_api.rb', line 372

def service_boards_board_id_statuses_status_id_notifications_id_put_with_http_info(board_id, status_id, id, board_status_notification, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_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 BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_id_put"
  end
  # verify the required parameter 'status_id' is set
  if @api_client.config.client_side_validation && status_id.nil?
    fail ArgumentError, "Missing the required parameter 'status_id' when calling BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_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 BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_id_put"
  end
  # verify the required parameter 'board_status_notification' is set
  if @api_client.config.client_side_validation && board_status_notification.nil?
    fail ArgumentError, "Missing the required parameter 'board_status_notification' when calling BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_id_put"
  end
  # resource path
  local_var_path = "/service/boards/{boardId}/statuses/{statusId}/notifications/{id}".sub('{' + 'boardId' + '}', board_id.to_s).sub('{' + 'statusId' + '}', status_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(board_status_notification)
  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 => 'BoardStatusNotification')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BoardStatusNotificationsApi#service_boards_board_id_statuses_status_id_notifications_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#service_boards_board_id_statuses_status_id_notifications_post(board_id, status_id, board_status_notification, opts = {}) ⇒ BoardStatusNotification

Create Board Status Notification

Parameters:

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

    the optional parameters

Returns:



431
432
433
434
 
# File 'lib/connectwise-ruby-sdk/api/board_status_notifications_api.rb', line 431

def service_boards_board_id_statuses_status_id_notifications_post(board_id, status_id, board_status_notification, opts = {})
  data, _status_code, _headers = service_boards_board_id_statuses_status_id_notifications_post_with_http_info(board_id, status_id, board_status_notification, opts)
  return data
end

#service_boards_board_id_statuses_status_id_notifications_post_with_http_info(board_id, status_id, board_status_notification, opts = {}) ⇒ Array<(BoardStatusNotification, Fixnum, Hash)>

Create Board Status Notification

Parameters:

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

    the optional parameters

Returns:

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

    BoardStatusNotification data, response status code and response headers



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/connectwise-ruby-sdk/api/board_status_notifications_api.rb', line 443

def service_boards_board_id_statuses_status_id_notifications_post_with_http_info(board_id, status_id, board_status_notification, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_post ..."
  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 BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_post"
  end
  # verify the required parameter 'status_id' is set
  if @api_client.config.client_side_validation && status_id.nil?
    fail ArgumentError, "Missing the required parameter 'status_id' when calling BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_post"
  end
  # verify the required parameter 'board_status_notification' is set
  if @api_client.config.client_side_validation && board_status_notification.nil?
    fail ArgumentError, "Missing the required parameter 'board_status_notification' when calling BoardStatusNotificationsApi.service_boards_board_id_statuses_status_id_notifications_post"
  end
  # resource path
  local_var_path = "/service/boards/{boardId}/statuses/{statusId}/notifications".sub('{' + 'boardId' + '}', board_id.to_s).sub('{' + 'statusId' + '}', status_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_status_notification)
  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 => 'BoardStatusNotification')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BoardStatusNotificationsApi#service_boards_board_id_statuses_status_id_notifications_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end