Class: OpenapiClient::CustomerPortalApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/customer_portal_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CustomerPortalApi

Returns a new instance of CustomerPortalApi.



19
20
21
 
# File 'lib/openapi_client/api/customer_portal_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/openapi_client/api/customer_portal_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#portal_api_keys_get(opts = {}) ⇒ Array<ApiKeyInfo>

List API keys (portal)

Parameters:

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 25

def portal_api_keys_get(opts = {})
  data, _status_code, _headers = portal_api_keys_get_with_http_info(opts)
  data
end

#portal_api_keys_get_with_http_info(opts = {}) ⇒ Array<(Array<ApiKeyInfo>, Integer, Hash)>

List API keys (portal)

Parameters:

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

    the optional parameters

Returns:

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

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



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 33

def portal_api_keys_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerPortalApi.portal_api_keys_get ...'
  end
  # resource path
  local_var_path = '/portal/api-keys'

  # 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']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"CustomerPortalApi.portal_api_keys_get",
    :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: CustomerPortalApi#portal_api_keys_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#portal_api_keys_key_id_delete(key_id, opts = {}) ⇒ nil

Revoke API key (portal)

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


81
82
83
84
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 81

def portal_api_keys_key_id_delete(key_id, opts = {})
  portal_api_keys_key_id_delete_with_http_info(key_id, opts)
  nil
end

#portal_api_keys_key_id_delete_with_http_info(key_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Revoke API key (portal)

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 90

def portal_api_keys_key_id_delete_with_http_info(key_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerPortalApi.portal_api_keys_key_id_delete ...'
  end
  # verify the required parameter 'key_id' is set
  if @api_client.config.client_side_validation && key_id.nil?
    fail ArgumentError, "Missing the required parameter 'key_id' when calling CustomerPortalApi.portal_api_keys_key_id_delete"
  end
  # resource path
  local_var_path = '/portal/api-keys/{key_id}'.sub('{key_id}', CGI.escape(key_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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"CustomerPortalApi.portal_api_keys_key_id_delete",
    :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: CustomerPortalApi#portal_api_keys_key_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#portal_api_keys_post(opts = {}) ⇒ CreateApiKeyResponse

Create API key (portal)

Parameters:

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

    the optional parameters

Returns:



139
140
141
142
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 139

def portal_api_keys_post(opts = {})
  data, _status_code, _headers = portal_api_keys_post_with_http_info(opts)
  data
end

#portal_api_keys_post_with_http_info(opts = {}) ⇒ Array<(CreateApiKeyResponse, Integer, Hash)>

Create API key (portal)

Parameters:

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

    the optional parameters

Returns:

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

    CreateApiKeyResponse data, response status code and response headers



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
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
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 147

def portal_api_keys_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerPortalApi.portal_api_keys_post ...'
  end
  # resource path
  local_var_path = '/portal/api-keys'

  # 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']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"CustomerPortalApi.portal_api_keys_post",
    :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: CustomerPortalApi#portal_api_keys_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#portal_config_get(opts = {}) ⇒ nil

Get portal configuration

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


194
195
196
197
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 194

def portal_config_get(opts = {})
  portal_config_get_with_http_info(opts)
  nil
end

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

Get portal configuration

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 202

def portal_config_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerPortalApi.portal_config_get ...'
  end
  # resource path
  local_var_path = '/portal/config'

  # 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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"CustomerPortalApi.portal_config_get",
    :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: CustomerPortalApi#portal_config_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#portal_config_post(opts = {}) ⇒ nil

Update portal configuration

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


247
248
249
250
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 247

def portal_config_post(opts = {})
  portal_config_post_with_http_info(opts)
  nil
end

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

Update portal configuration

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 255

def portal_config_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerPortalApi.portal_config_post ...'
  end
  # resource path
  local_var_path = '/portal/config'

  # 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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"CustomerPortalApi.portal_config_post",
    :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: CustomerPortalApi#portal_config_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#portal_embed_code_get(opts = {}) ⇒ nil

Get portal embed code

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


300
301
302
303
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 300

def portal_embed_code_get(opts = {})
  portal_embed_code_get_with_http_info(opts)
  nil
end

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

Get portal embed code

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 308

def portal_embed_code_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerPortalApi.portal_embed_code_get ...'
  end
  # resource path
  local_var_path = '/portal/embed-code'

  # 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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"CustomerPortalApi.portal_embed_code_get",
    :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: CustomerPortalApi#portal_embed_code_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#portal_me_get(opts = {}) ⇒ PortalProfile

Get portal profile

Parameters:

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

    the optional parameters

Returns:



353
354
355
356
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 353

def portal_me_get(opts = {})
  data, _status_code, _headers = portal_me_get_with_http_info(opts)
  data
end

#portal_me_get_with_http_info(opts = {}) ⇒ Array<(PortalProfile, Integer, Hash)>

Get portal profile

Parameters:

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

    the optional parameters

Returns:

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

    PortalProfile data, response status code and response headers



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
396
397
398
399
400
401
402
403
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 361

def portal_me_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerPortalApi.portal_me_get ...'
  end
  # resource path
  local_var_path = '/portal/me'

  # 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']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"CustomerPortalApi.portal_me_get",
    :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: CustomerPortalApi#portal_me_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#portal_me_put(update_profile_request, opts = {}) ⇒ nil

Update portal profile

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


409
410
411
412
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 409

def portal_me_put(update_profile_request, opts = {})
  portal_me_put_with_http_info(update_profile_request, opts)
  nil
end

#portal_me_put_with_http_info(update_profile_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update portal profile

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 418

def portal_me_put_with_http_info(update_profile_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerPortalApi.portal_me_put ...'
  end
  # verify the required parameter 'update_profile_request' is set
  if @api_client.config.client_side_validation && update_profile_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_profile_request' when calling CustomerPortalApi.portal_me_put"
  end
  # resource path
  local_var_path = '/portal/me'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"CustomerPortalApi.portal_me_put",
    :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: CustomerPortalApi#portal_me_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#portal_notifications_get(opts = {}) ⇒ NotificationPreferences

Get notification preferences (portal)

Parameters:

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

    the optional parameters

Returns:



472
473
474
475
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 472

def portal_notifications_get(opts = {})
  data, _status_code, _headers = portal_notifications_get_with_http_info(opts)
  data
end

#portal_notifications_get_with_http_info(opts = {}) ⇒ Array<(NotificationPreferences, Integer, Hash)>

Get notification preferences (portal)

Parameters:

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

    the optional parameters

Returns:

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

    NotificationPreferences data, response status code and response headers



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
518
519
520
521
522
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 480

def portal_notifications_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerPortalApi.portal_notifications_get ...'
  end
  # resource path
  local_var_path = '/portal/notifications'

  # 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']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"CustomerPortalApi.portal_notifications_get",
    :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: CustomerPortalApi#portal_notifications_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#portal_notifications_put(update_notification_preferences, opts = {}) ⇒ PortalNotificationsPut200Response

Update notification preferences (portal)

Parameters:

Returns:



528
529
530
531
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 528

def portal_notifications_put(update_notification_preferences, opts = {})
  data, _status_code, _headers = portal_notifications_put_with_http_info(update_notification_preferences, opts)
  data
end

#portal_notifications_put_with_http_info(update_notification_preferences, opts = {}) ⇒ Array<(PortalNotificationsPut200Response, Integer, Hash)>

Update notification preferences (portal)

Parameters:

Returns:



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
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 537

def portal_notifications_put_with_http_info(update_notification_preferences, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerPortalApi.portal_notifications_put ...'
  end
  # verify the required parameter 'update_notification_preferences' is set
  if @api_client.config.client_side_validation && update_notification_preferences.nil?
    fail ArgumentError, "Missing the required parameter 'update_notification_preferences' when calling CustomerPortalApi.portal_notifications_put"
  end
  # resource path
  local_var_path = '/portal/notifications'

  # 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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

  new_options = opts.merge(
    :operation => :"CustomerPortalApi.portal_notifications_put",
    :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: CustomerPortalApi#portal_notifications_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#portal_plan_get(opts = {}) ⇒ SubscriptionResponse

Get plan info (portal)

Parameters:

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

    the optional parameters

Returns:



593
594
595
596
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 593

def portal_plan_get(opts = {})
  data, _status_code, _headers = portal_plan_get_with_http_info(opts)
  data
end

#portal_plan_get_with_http_info(opts = {}) ⇒ Array<(SubscriptionResponse, Integer, Hash)>

Get plan info (portal)

Parameters:

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

    the optional parameters

Returns:

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

    SubscriptionResponse data, response status code and response headers



601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 601

def portal_plan_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerPortalApi.portal_plan_get ...'
  end
  # resource path
  local_var_path = '/portal/plan'

  # 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']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"CustomerPortalApi.portal_plan_get",
    :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: CustomerPortalApi#portal_plan_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#portal_usage_get(opts = {}) ⇒ UsageResponse

Get usage (portal)

Parameters:

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

    the optional parameters

Returns:



648
649
650
651
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 648

def portal_usage_get(opts = {})
  data, _status_code, _headers = portal_usage_get_with_http_info(opts)
  data
end

#portal_usage_get_with_http_info(opts = {}) ⇒ Array<(UsageResponse, Integer, Hash)>

Get usage (portal)

Parameters:

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

    the optional parameters

Returns:

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

    UsageResponse data, response status code and response headers



656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
 
# File 'lib/openapi_client/api/customer_portal_api.rb', line 656

def portal_usage_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomerPortalApi.portal_usage_get ...'
  end
  # resource path
  local_var_path = '/portal/usage'

  # 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']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"CustomerPortalApi.portal_usage_get",
    :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: CustomerPortalApi#portal_usage_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end