Class: ConnectWise::MemberNotificationSettingsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MemberNotificationSettingsApi

Returns a new instance of MemberNotificationSettingsApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Delete MemberNotificationSetting

Parameters:

  • id (Integer) —

    notificationSettingId

  • parent_id (Integer) —

    memberId

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_system_members_by_parent_id_notification_settings_by_id(id, parent_id, client_id, opts = {})
  delete_system_members_by_parent_id_notification_settings_by_id_with_http_info(id, parent_id, client_id, opts)
  nil
end

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

Delete MemberNotificationSetting

Parameters:

  • id (Integer) —

    notificationSettingId

  • parent_id (Integer) —

    memberId

  • 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/member_notification_settings_api.rb', line 38

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

  # resource path
  local_var_path = '/system/members/{parentId}/notificationSettings/{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: :'MemberNotificationSettingsApi.delete_system_members_by_parent_id_notification_settings_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: MemberNotificationSettingsApi#delete_system_members_by_parent_id_notification_settings_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#get_system_members_by_parent_id_notification_settings(parent_id, client_id, opts = {}) ⇒ Array<MemberNotificationSetting>

Get List of MemberNotificationSetting

Parameters:

  • parent_id (Integer) —

    memberId

  • 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/member_notification_settings_api.rb', line 97

def get_system_members_by_parent_id_notification_settings(parent_id, client_id, opts = {})
  data, _status_code, _headers = get_system_members_by_parent_id_notification_settings_with_http_info(parent_id, client_id, opts)
  data
end

#get_system_members_by_parent_id_notification_settings_by_id(id, parent_id, client_id, opts = {}) ⇒ MemberNotificationSetting

Get MemberNotificationSetting

Parameters:

  • id (Integer) —

    notificationSettingId

  • parent_id (Integer) —

    memberId

  • 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/member_notification_settings_api.rb', line 183

def get_system_members_by_parent_id_notification_settings_by_id(id, parent_id, client_id, opts = {})
  data, _status_code, _headers = get_system_members_by_parent_id_notification_settings_by_id_with_http_info(id, parent_id, client_id, opts)
  data
end

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

Get MemberNotificationSetting

Parameters:

  • id (Integer) —

    notificationSettingId

  • parent_id (Integer) —

    memberId

  • 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<(MemberNotificationSetting, Integer, Hash)>) —

    MemberNotificationSetting 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/member_notification_settings_api.rb', line 202

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

  # resource path
  local_var_path = '/system/members/{parentId}/notificationSettings/{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] || 'MemberNotificationSetting'

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

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

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

Get Count of MemberNotificationSetting

Parameters:

  • parent_id (Integer) —

    memberId

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



271
272
273
274
 
# File 'lib/connect_wise/api/member_notification_settings_api.rb', line 271

def get_system_members_by_parent_id_notification_settings_count(parent_id, client_id, opts = {})
  data, _status_code, _headers = get_system_members_by_parent_id_notification_settings_count_with_http_info(parent_id, client_id, opts)
  data
end

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

Get Count of MemberNotificationSetting

Parameters:

  • parent_id (Integer) —

    memberId

  • 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) 


289
290
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
 
# File 'lib/connect_wise/api/member_notification_settings_api.rb', line 289

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

  # resource path
  local_var_path = '/system/members/{parentId}/notificationSettings/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: :'MemberNotificationSettingsApi.get_system_members_by_parent_id_notification_settings_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: MemberNotificationSettingsApi#get_system_members_by_parent_id_notification_settings_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

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

Get List of MemberNotificationSetting

Parameters:

  • parent_id (Integer) —

    memberId

  • 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<MemberNotificationSetting>, Integer, Hash)>) —

    Array<MemberNotificationSetting> 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/member_notification_settings_api.rb', line 115

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

  # resource path
  local_var_path = '/system/members/{parentId}/notificationSettings'.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<MemberNotificationSetting>'

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

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

#patch_system_members_by_parent_id_notification_settings_by_id(id, parent_id, client_id, patch_operation, opts = {}) ⇒ MemberNotificationSetting

Patch MemberNotificationSetting

Parameters:

  • id (Integer) —

    notificationSettingId

  • parent_id (Integer) —

    memberId

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

    List of PatchOperation

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

    the optional parameters

Returns:



350
351
352
353
 
# File 'lib/connect_wise/api/member_notification_settings_api.rb', line 350

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

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

Patch MemberNotificationSetting

Parameters:

  • id (Integer) —

    notificationSettingId

  • parent_id (Integer) —

    memberId

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

    List of PatchOperation

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

    the optional parameters

Returns:

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

    MemberNotificationSetting data, response status code and response headers

Raises:

  • (ArgumentError) 


362
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
406
407
408
409
410
411
412
413
 
# File 'lib/connect_wise/api/member_notification_settings_api.rb', line 362

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

  # resource path
  local_var_path = '/system/members/{parentId}/notificationSettings/{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] || 'MemberNotificationSetting'

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

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

#post_system_members_by_parent_id_notification_settings(parent_id, client_id, member_notification_setting, opts = {}) ⇒ MemberNotificationSetting

Post MemberNotificationSetting

Parameters:

  • parent_id (Integer) —

    memberId

  • client_id (String)
  • member_notification_setting (MemberNotificationSetting) —

    memberNotificationSetting

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

    the optional parameters

Returns:



421
422
423
424
 
# File 'lib/connect_wise/api/member_notification_settings_api.rb', line 421

def post_system_members_by_parent_id_notification_settings(parent_id, client_id, member_notification_setting, opts = {})
  data, _status_code, _headers = post_system_members_by_parent_id_notification_settings_with_http_info(parent_id, client_id, member_notification_setting, opts)
  data
end

#post_system_members_by_parent_id_notification_settings_with_http_info(parent_id, client_id, member_notification_setting, opts = {}) ⇒ Array<(MemberNotificationSetting, Integer, Hash)>

Post MemberNotificationSetting

Parameters:

  • parent_id (Integer) —

    memberId

  • client_id (String)
  • member_notification_setting (MemberNotificationSetting) —

    memberNotificationSetting

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

    the optional parameters

Returns:

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

    MemberNotificationSetting data, response status code and response headers

Raises:

  • (ArgumentError) 


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
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/connect_wise/api/member_notification_settings_api.rb', line 432

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

  # resource path
  local_var_path = '/system/members/{parentId}/notificationSettings'.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(member_notification_setting)

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

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

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

#put_system_members_by_parent_id_notification_settings_by_id(id, parent_id, client_id, member_notification_setting, opts = {}) ⇒ MemberNotificationSetting

Put MemberNotificationSetting

Parameters:

  • id (Integer) —

    notificationSettingId

  • parent_id (Integer) —

    memberId

  • client_id (String)
  • member_notification_setting (MemberNotificationSetting) —

    memberNotificationSetting

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

    the optional parameters

Returns:



490
491
492
493
 
# File 'lib/connect_wise/api/member_notification_settings_api.rb', line 490

def put_system_members_by_parent_id_notification_settings_by_id(id, parent_id, client_id, member_notification_setting, opts = {})
  data, _status_code, _headers = put_system_members_by_parent_id_notification_settings_by_id_with_http_info(id, parent_id, client_id, member_notification_setting, opts)
  data
end

#put_system_members_by_parent_id_notification_settings_by_id_with_http_info(id, parent_id, client_id, member_notification_setting, opts = {}) ⇒ Array<(MemberNotificationSetting, Integer, Hash)>

Put MemberNotificationSetting

Parameters:

  • id (Integer) —

    notificationSettingId

  • parent_id (Integer) —

    memberId

  • client_id (String)
  • member_notification_setting (MemberNotificationSetting) —

    memberNotificationSetting

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

    the optional parameters

Returns:

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

    MemberNotificationSetting data, response status code and response headers

Raises:

  • (ArgumentError) 


502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/connect_wise/api/member_notification_settings_api.rb', line 502

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

  # resource path
  local_var_path = '/system/members/{parentId}/notificationSettings/{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(member_notification_setting)

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

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

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