Class: MailSlurpClient::GuestPortalControllerApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GuestPortalControllerApi

Returns a new instance of GuestPortalControllerApi.



19
20
21
 
# File 'lib/mailslurp_client/api/guest_portal_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/guest_portal_controller_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_guest_portal(create_portal_options, opts = {}) ⇒ GuestPortalDto

Create a portal page for your customers or clients to log into email accounts and view emails. Create a guest login page for customers or clients to access assigned email addresses

Parameters:

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

    the optional parameters

Returns:



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

def create_guest_portal(create_portal_options, opts = {})
  data, _status_code, _headers = create_guest_portal_with_http_info(create_portal_options, opts)
  data
end

#create_guest_portal_user(portal_id, create_portal_user_options, opts = {}) ⇒ GuestPortalUserCreateDto

Create a portal guest user Add customer to portal

Parameters:

  • portal_id (String)
  • create_portal_user_options (CreatePortalUserOptions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



92
93
94
95
 
# File 'lib/mailslurp_client/api/guest_portal_controller_api.rb', line 92

def create_guest_portal_user(portal_id, create_portal_user_options, opts = {})
  data, _status_code, _headers = create_guest_portal_user_with_http_info(portal_id, create_portal_user_options, opts)
  data
end

#create_guest_portal_user_with_http_info(portal_id, create_portal_user_options, opts = {}) ⇒ Array<(GuestPortalUserCreateDto, Integer, Hash)>

Create a portal guest user Add customer to portal

Parameters:

  • portal_id (String)
  • create_portal_user_options (CreatePortalUserOptions)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    GuestPortalUserCreateDto 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
151
152
153
154
 
# File 'lib/mailslurp_client/api/guest_portal_controller_api.rb', line 103

def create_guest_portal_user_with_http_info(portal_id, create_portal_user_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GuestPortalControllerApi.create_guest_portal_user ...'
  end
  # verify the required parameter 'portal_id' is set
  if @api_client.config.client_side_validation && portal_id.nil?
    fail ArgumentError, "Missing the required parameter 'portal_id' when calling GuestPortalControllerApi.create_guest_portal_user"
  end
  # verify the required parameter 'create_portal_user_options' is set
  if @api_client.config.client_side_validation && create_portal_user_options.nil?
    fail ArgumentError, "Missing the required parameter 'create_portal_user_options' when calling GuestPortalControllerApi.create_guest_portal_user"
  end
  # resource path
  local_var_path = '/guest-portal/{portalId}/user'.sub('{' + 'portalId' + '}', CGI.escape(portal_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(['*/*'])
  # 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_portal_user_options) 

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

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

#create_guest_portal_with_http_info(create_portal_options, opts = {}) ⇒ Array<(GuestPortalDto, Integer, Hash)>

Create a portal page for your customers or clients to log into email accounts and view emails. Create a guest login page for customers or clients to access assigned email addresses

Parameters:

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

    the optional parameters

Returns:

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

    GuestPortalDto 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
 
# File 'lib/mailslurp_client/api/guest_portal_controller_api.rb', line 37

def create_guest_portal_with_http_info(create_portal_options, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GuestPortalControllerApi.create_guest_portal ...'
  end
  # verify the required parameter 'create_portal_options' is set
  if @api_client.config.client_side_validation && create_portal_options.nil?
    fail ArgumentError, "Missing the required parameter 'create_portal_options' when calling GuestPortalControllerApi.create_guest_portal"
  end
  # resource path
  local_var_path = '/guest-portal'

  # 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(['*/*'])
  # 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_portal_options) 

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

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

#get_all_guest_portal_users(opts = {}) ⇒ PageGuestPortalUsers

Get all guest users for portal Get all customers for a portal

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :portal_id (String) —

    Optional portal ID

  • :search (String) —

    Optional search term

  • :page (Integer) —

    Optional page index in list pagination (default to 0)

  • :size (Integer) —

    Optional page size in list pagination (default to 20)

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC (default to 'ASC')

  • :since (DateTime) —

    Filter by created at after the given timestamp

  • :before (DateTime) —

    Filter by created at before the given timestamp

Returns:



167
168
169
170
 
# File 'lib/mailslurp_client/api/guest_portal_controller_api.rb', line 167

def get_all_guest_portal_users(opts = {})
  data, _status_code, _headers = get_all_guest_portal_users_with_http_info(opts)
  data
end

#get_all_guest_portal_users_with_http_info(opts = {}) ⇒ Array<(PageGuestPortalUsers, Integer, Hash)>

Get all guest users for portal Get all customers for a portal

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :portal_id (String) —

    Optional portal ID

  • :search (String) —

    Optional search term

  • :page (Integer) —

    Optional page index in list pagination

  • :size (Integer) —

    Optional page size in list pagination

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC

  • :since (DateTime) —

    Filter by created at after the given timestamp

  • :before (DateTime) —

    Filter by created at before the given timestamp

Returns:

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

    PageGuestPortalUsers data, response status code and response headers



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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/mailslurp_client/api/guest_portal_controller_api.rb', line 183

def get_all_guest_portal_users_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GuestPortalControllerApi.get_all_guest_portal_users ...'
  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 = '/guest-portal/user'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'portalId'] = opts[:'portal_id'] if !opts[:'portal_id'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  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?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?

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

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

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

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

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

#get_guest_portal(portal_id, opts = {}) ⇒ GuestPortalDto

Get a client email portal Fetch a customer guest portal

Parameters:

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

    the optional parameters

Returns:



242
243
244
245
 
# File 'lib/mailslurp_client/api/guest_portal_controller_api.rb', line 242

def get_guest_portal(portal_id, opts = {})
  data, _status_code, _headers = get_guest_portal_with_http_info(portal_id, opts)
  data
end

#get_guest_portal_user(portal_id, guest_id, opts = {}) ⇒ GuestPortalUserDto

Get guest user for portal Get customer for portal

Parameters:

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

    the optional parameters

Returns:



305
306
307
308
 
# File 'lib/mailslurp_client/api/guest_portal_controller_api.rb', line 305

def get_guest_portal_user(portal_id, guest_id, opts = {})
  data, _status_code, _headers = get_guest_portal_user_with_http_info(portal_id, guest_id, opts)
  data
end

#get_guest_portal_user_by_id(guest_id, opts = {}) ⇒ GuestPortalUserDto

Get guest user Get customer by ID

Parameters:

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

    the optional parameters

Returns:



372
373
374
375
 
# File 'lib/mailslurp_client/api/guest_portal_controller_api.rb', line 372

def get_guest_portal_user_by_id(guest_id, opts = {})
  data, _status_code, _headers = get_guest_portal_user_by_id_with_http_info(guest_id, opts)
  data
end

#get_guest_portal_user_by_id_with_http_info(guest_id, opts = {}) ⇒ Array<(GuestPortalUserDto, Integer, Hash)>

Get guest user Get customer by ID

Parameters:

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

    the optional parameters

Returns:

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

    GuestPortalUserDto data, response status code and response headers



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
423
424
425
426
427
 
# File 'lib/mailslurp_client/api/guest_portal_controller_api.rb', line 382

def get_guest_portal_user_by_id_with_http_info(guest_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GuestPortalControllerApi.get_guest_portal_user_by_id ...'
  end
  # verify the required parameter 'guest_id' is set
  if @api_client.config.client_side_validation && guest_id.nil?
    fail ArgumentError, "Missing the required parameter 'guest_id' when calling GuestPortalControllerApi.get_guest_portal_user_by_id"
  end
  # resource path
  local_var_path = '/guest-portal/user/{guestId}'.sub('{' + 'guestId' + '}', CGI.escape(guest_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(['*/*'])

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

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

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

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

#get_guest_portal_user_with_http_info(portal_id, guest_id, opts = {}) ⇒ Array<(GuestPortalUserDto, Integer, Hash)>

Get guest user for portal Get customer for portal

Parameters:

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

    the optional parameters

Returns:

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

    GuestPortalUserDto data, response status code and response headers



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
361
362
363
364
365
 
# File 'lib/mailslurp_client/api/guest_portal_controller_api.rb', line 316

def get_guest_portal_user_with_http_info(portal_id, guest_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GuestPortalControllerApi.get_guest_portal_user ...'
  end
  # verify the required parameter 'portal_id' is set
  if @api_client.config.client_side_validation && portal_id.nil?
    fail ArgumentError, "Missing the required parameter 'portal_id' when calling GuestPortalControllerApi.get_guest_portal_user"
  end
  # verify the required parameter 'guest_id' is set
  if @api_client.config.client_side_validation && guest_id.nil?
    fail ArgumentError, "Missing the required parameter 'guest_id' when calling GuestPortalControllerApi.get_guest_portal_user"
  end
  # resource path
  local_var_path = '/guest-portal/{portalId}/user/{guestId}'.sub('{' + 'portalId' + '}', CGI.escape(portal_id.to_s)).sub('{' + 'guestId' + '}', CGI.escape(guest_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(['*/*'])

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

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

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

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

#get_guest_portal_users(portal_id, opts = {}) ⇒ PageGuestPortalUsers

Get all guest users for portal Get customers for a portal

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Optional search term

  • :page (Integer) —

    Optional page index in list pagination (default to 0)

  • :size (Integer) —

    Optional page size in list pagination (default to 20)

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC (default to 'ASC')

  • :since (DateTime) —

    Filter by created at after the given timestamp

  • :before (DateTime) —

    Filter by created at before the given timestamp

Returns:



440
441
442
443
 
# File 'lib/mailslurp_client/api/guest_portal_controller_api.rb', line 440

def get_guest_portal_users(portal_id, opts = {})
  data, _status_code, _headers = get_guest_portal_users_with_http_info(portal_id, opts)
  data
end

#get_guest_portal_users_with_http_info(portal_id, opts = {}) ⇒ Array<(PageGuestPortalUsers, Integer, Hash)>

Get all guest users for portal Get customers for a portal

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Optional search term

  • :page (Integer) —

    Optional page index in list pagination

  • :size (Integer) —

    Optional page size in list pagination

  • :sort (String) —

    Optional createdAt sort direction ASC or DESC

  • :since (DateTime) —

    Filter by created at after the given timestamp

  • :before (DateTime) —

    Filter by created at before the given timestamp

Returns:

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

    PageGuestPortalUsers data, response status code and response headers



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
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/mailslurp_client/api/guest_portal_controller_api.rb', line 456

def get_guest_portal_users_with_http_info(portal_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GuestPortalControllerApi.get_guest_portal_users ...'
  end
  # verify the required parameter 'portal_id' is set
  if @api_client.config.client_side_validation && portal_id.nil?
    fail ArgumentError, "Missing the required parameter 'portal_id' when calling GuestPortalControllerApi.get_guest_portal_users"
  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 = '/guest-portal/{portalId}/user'.sub('{' + 'portalId' + '}', CGI.escape(portal_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  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?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?

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

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

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

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

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

#get_guest_portal_with_http_info(portal_id, opts = {}) ⇒ Array<(GuestPortalDto, Integer, Hash)>

Get a client email portal Fetch a customer guest portal

Parameters:

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

    the optional parameters

Returns:

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

    GuestPortalDto data, response status code and response headers



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
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/mailslurp_client/api/guest_portal_controller_api.rb', line 252

def get_guest_portal_with_http_info(portal_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GuestPortalControllerApi.get_guest_portal ...'
  end
  # verify the required parameter 'portal_id' is set
  if @api_client.config.client_side_validation && portal_id.nil?
    fail ArgumentError, "Missing the required parameter 'portal_id' when calling GuestPortalControllerApi.get_guest_portal"
  end
  # resource path
  local_var_path = '/guest-portal/{portalId}'.sub('{' + 'portalId' + '}', CGI.escape(portal_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(['*/*'])

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

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

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

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

#get_guest_portals(opts = {}) ⇒ Array<GuestPortalDto>

Get guest portals Get portals

Parameters:

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

    the optional parameters

Returns:



517
518
519
520
 
# File 'lib/mailslurp_client/api/guest_portal_controller_api.rb', line 517

def get_guest_portals(opts = {})
  data, _status_code, _headers = get_guest_portals_with_http_info(opts)
  data
end

#get_guest_portals_with_http_info(opts = {}) ⇒ Array<(Array<GuestPortalDto>, Integer, Hash)>

Get guest portals Get portals

Parameters:

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

    the optional parameters

Returns:

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

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



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
554
555
556
557
558
559
560
561
562
563
564
565
566
567
 
# File 'lib/mailslurp_client/api/guest_portal_controller_api.rb', line 526

def get_guest_portals_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GuestPortalControllerApi.get_guest_portals ...'
  end
  # resource path
  local_var_path = '/guest-portal'

  # 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(['*/*'])

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

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

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

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