Class: MailSlurpClient::GroupControllerApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/api/group_controller_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GroupControllerApi

Returns a new instance of GroupControllerApi.



19
20
21
 
# File 'lib/mailslurp_client/api/group_controller_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/mailslurp_client/api/group_controller_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_contacts_to_group(group_id, update_group_contacts_option, opts = {}) ⇒ GroupContactsDto

Add contacts to a group

Parameters:

  • group_id (String) —

    groupId

  • update_group_contacts_option (UpdateGroupContacts) —

    updateGroupContactsOption

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/mailslurp_client/api/group_controller_api.rb', line 27

def add_contacts_to_group(group_id, update_group_contacts_option, opts = {})
  data, _status_code, _headers = add_contacts_to_group_with_http_info(group_id, update_group_contacts_option, opts)
  data
end

#add_contacts_to_group_with_http_info(group_id, update_group_contacts_option, opts = {}) ⇒ Array<(GroupContactsDto, Integer, Hash)>

Add contacts to a group

Parameters:

  • group_id (String) —

    groupId

  • update_group_contacts_option (UpdateGroupContacts) —

    updateGroupContactsOption

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

    the optional parameters

Returns:

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

    GroupContactsDto data, response status code and response headers



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
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/mailslurp_client/api/group_controller_api.rb', line 37

def add_contacts_to_group_with_http_info(group_id, update_group_contacts_option, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupControllerApi.add_contacts_to_group ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupControllerApi.add_contacts_to_group"
  end
  # verify the required parameter 'update_group_contacts_option' is set
  if @api_client.config.client_side_validation && update_group_contacts_option.nil?
    fail ArgumentError, "Missing the required parameter 'update_group_contacts_option' when calling GroupControllerApi.add_contacts_to_group"
  end
  # resource path
  local_var_path = '/groups/{groupId}/contacts'.sub('{' + 'groupId' + '}', CGI.escape(group_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/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'GroupContactsDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupControllerApi#add_contacts_to_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_group(create_group_options, opts = {}) ⇒ GroupDto

Create a group

Parameters:

  • create_group_options (CreateGroupOptions) —

    createGroupOptions

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

    the optional parameters

Returns:



94
95
96
97
 
# File 'lib/mailslurp_client/api/group_controller_api.rb', line 94

def create_group(create_group_options, opts = {})
  data, _status_code, _headers = create_group_with_http_info(create_group_options, opts)
  data
end

#create_group_with_http_info(create_group_options, opts = {}) ⇒ Array<(GroupDto, Integer, Hash)>

Create a group

Parameters:

  • create_group_options (CreateGroupOptions) —

    createGroupOptions

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

    the optional parameters

Returns:

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

    GroupDto 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
150
 
# File 'lib/mailslurp_client/api/group_controller_api.rb', line 103

def create_group_with_http_info(create_group_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupControllerApi.create_group ...'
  end
  # verify the required parameter 'create_group_options' is set
  if @api_client.config.client_side_validation && create_group_options.nil?
    fail ArgumentError, "Missing the required parameter 'create_group_options' when calling GroupControllerApi.create_group"
  end
  # resource path
  local_var_path = '/groups'

  # 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/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'GroupDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupControllerApi#create_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_group(group_id, opts = {}) ⇒ nil

Delete group

Parameters:

  • group_id (String) —

    groupId

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

    the optional parameters

Returns:

  • (nil) 


156
157
158
159
 
# File 'lib/mailslurp_client/api/group_controller_api.rb', line 156

def delete_group(group_id, opts = {})
  delete_group_with_http_info(group_id, opts)
  nil
end

#delete_group_with_http_info(group_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete group

Parameters:

  • group_id (String) —

    groupId

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



165
166
167
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
 
# File 'lib/mailslurp_client/api/group_controller_api.rb', line 165

def delete_group_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupControllerApi.delete_group ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupControllerApi.delete_group"
  end
  # resource path
  local_var_path = '/groups/{groupId}'.sub('{' + 'groupId' + '}', CGI.escape(group_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupControllerApi#delete_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_groups(opts = {}) ⇒ PageGroupProjection

Get all Contact Groups in paginated format

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Optional page index in inbox list pagination (default to 0)

  • :size (Integer) —

    Optional page size in inbox list pagination (default to 20)

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC (default to ‘ASC’)

Returns:



216
217
218
219
 
# File 'lib/mailslurp_client/api/group_controller_api.rb', line 216

def get_all_groups(opts = {})
  data, _status_code, _headers = get_all_groups_with_http_info(opts)
  data
end

#get_all_groups_with_http_info(opts = {}) ⇒ Array<(PageGroupProjection, Integer, Hash)>

Get all Contact Groups in paginated format

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Optional page index in inbox list pagination

  • :size (Integer) —

    Optional page size in inbox list pagination

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC

Returns:

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

    PageGroupProjection data, response status code and response headers



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

def get_all_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupControllerApi.get_all_groups ...'
  end
  allowable_values = ["ASC", "DESC"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/groups/paginated'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'PageGroupProjection' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupControllerApi#get_all_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_group(group_id, opts = {}) ⇒ GroupDto

Get group

Parameters:

  • group_id (String) —

    groupId

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

    the optional parameters

Returns:



281
282
283
284
 
# File 'lib/mailslurp_client/api/group_controller_api.rb', line 281

def get_group(group_id, opts = {})
  data, _status_code, _headers = get_group_with_http_info(group_id, opts)
  data
end

#get_group_with_contacts(group_id, opts = {}) ⇒ GroupContactsDto

Get group and contacts belonging to it

Parameters:

  • group_id (String) —

    groupId

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

    the optional parameters

Returns:



341
342
343
344
 
# File 'lib/mailslurp_client/api/group_controller_api.rb', line 341

def get_group_with_contacts(group_id, opts = {})
  data, _status_code, _headers = get_group_with_contacts_with_http_info(group_id, opts)
  data
end

#get_group_with_contacts_with_http_info(group_id, opts = {}) ⇒ Array<(GroupContactsDto, Integer, Hash)>

Get group and contacts belonging to it

Parameters:

  • group_id (String) —

    groupId

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

    the optional parameters

Returns:

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

    GroupContactsDto data, response status code and response headers



350
351
352
353
354
355
356
357
358
359
360
361
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
 
# File 'lib/mailslurp_client/api/group_controller_api.rb', line 350

def get_group_with_contacts_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupControllerApi.get_group_with_contacts ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupControllerApi.get_group_with_contacts"
  end
  # resource path
  local_var_path = '/groups/{groupId}/contacts'.sub('{' + 'groupId' + '}', CGI.escape(group_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/json'])

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

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'GroupContactsDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupControllerApi#get_group_with_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_group_with_http_info(group_id, opts = {}) ⇒ Array<(GroupDto, Integer, Hash)>

Get group

Parameters:

  • group_id (String) —

    groupId

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

    the optional parameters

Returns:

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

    GroupDto data, response status code and response headers



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
 
# File 'lib/mailslurp_client/api/group_controller_api.rb', line 290

def get_group_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupControllerApi.get_group ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupControllerApi.get_group"
  end
  # resource path
  local_var_path = '/groups/{groupId}'.sub('{' + 'groupId' + '}', CGI.escape(group_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/json'])

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

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'GroupDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupControllerApi#get_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_groups(opts = {}) ⇒ Array<GroupProjection>

Get all groups

Parameters:

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

    the optional parameters

Returns:



400
401
402
403
 
# File 'lib/mailslurp_client/api/group_controller_api.rb', line 400

def get_groups(opts = {})
  data, _status_code, _headers = get_groups_with_http_info(opts)
  data
end

#get_groups_with_http_info(opts = {}) ⇒ Array<(Array<GroupProjection>, Integer, Hash)>

Get all groups

Parameters:

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

    the optional parameters

Returns:

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

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



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/mailslurp_client/api/group_controller_api.rb', line 408

def get_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupControllerApi.get_groups ...'
  end
  # resource path
  local_var_path = '/groups'

  # 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/json'])

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

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Array<GroupProjection>' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupControllerApi#get_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_contacts_from_group(group_id, update_group_contacts_option, opts = {}) ⇒ GroupContactsDto

Remove contacts from a group

Parameters:

  • group_id (String) —

    groupId

  • update_group_contacts_option (UpdateGroupContacts) —

    updateGroupContactsOption

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

    the optional parameters

Returns:



456
457
458
459
 
# File 'lib/mailslurp_client/api/group_controller_api.rb', line 456

def remove_contacts_from_group(group_id, update_group_contacts_option, opts = {})
  data, _status_code, _headers = remove_contacts_from_group_with_http_info(group_id, update_group_contacts_option, opts)
  data
end

#remove_contacts_from_group_with_http_info(group_id, update_group_contacts_option, opts = {}) ⇒ Array<(GroupContactsDto, Integer, Hash)>

Remove contacts from a group

Parameters:

  • group_id (String) —

    groupId

  • update_group_contacts_option (UpdateGroupContacts) —

    updateGroupContactsOption

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

    the optional parameters

Returns:

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

    GroupContactsDto data, response status code and response headers



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/mailslurp_client/api/group_controller_api.rb', line 466

def remove_contacts_from_group_with_http_info(group_id, update_group_contacts_option, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupControllerApi.remove_contacts_from_group ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupControllerApi.remove_contacts_from_group"
  end
  # verify the required parameter 'update_group_contacts_option' is set
  if @api_client.config.client_side_validation && update_group_contacts_option.nil?
    fail ArgumentError, "Missing the required parameter 'update_group_contacts_option' when calling GroupControllerApi.remove_contacts_from_group"
  end
  # resource path
  local_var_path = '/groups/{groupId}/contacts'.sub('{' + 'groupId' + '}', CGI.escape(group_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/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:return_type] || 'GroupContactsDto' 

  # auth_names
  auth_names = opts[:auth_names] || ['API_KEY']

  new_options = opts.merge(
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GroupControllerApi#remove_contacts_from_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end