Class: Zyphr::WaaSPortalApi

Inherits:
Object
  • Object
show all
Defined in:
lib/zyphr/api/waa_s_portal_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WaaSPortalApi

Returns a new instance of WaaSPortalApi.



19
20
21
 
# File 'lib/zyphr/api/waa_s_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/zyphr/api/waa_s_portal_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#generate_waa_s_portal_token(app_id, waa_s_portal_token_request, opts = {}) ⇒ GenerateWaaSPortalToken201Response

Generate portal token Generate a time-limited token for the embeddable webhook management portal. Requires Starter plan or higher.

Parameters:

  • app_id (String)
  • waa_s_portal_token_request (WaaSPortalTokenRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/zyphr/api/waa_s_portal_api.rb', line 28

def generate_waa_s_portal_token(app_id, waa_s_portal_token_request, opts = {})
  data, _status_code, _headers = generate_waa_s_portal_token_with_http_info(app_id, waa_s_portal_token_request, opts)
  data
end

#generate_waa_s_portal_token_with_http_info(app_id, waa_s_portal_token_request, opts = {}) ⇒ Array<(GenerateWaaSPortalToken201Response, Integer, Hash)>

Generate portal token Generate a time-limited token for the embeddable webhook management portal. Requires Starter plan or higher.

Parameters:

  • app_id (String)
  • waa_s_portal_token_request (WaaSPortalTokenRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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
89
90
91
92
93
94
 
# File 'lib/zyphr/api/waa_s_portal_api.rb', line 39

def generate_waa_s_portal_token_with_http_info(app_id, waa_s_portal_token_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WaaSPortalApi.generate_waa_s_portal_token ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling WaaSPortalApi.generate_waa_s_portal_token"
  end
  # verify the required parameter 'waa_s_portal_token_request' is set
  if @api_client.config.client_side_validation && waa_s_portal_token_request.nil?
    fail ArgumentError, "Missing the required parameter 'waa_s_portal_token_request' when calling WaaSPortalApi.generate_waa_s_portal_token"
  end
  # resource path
  local_var_path = '/v1/waas/applications/{appId}/portal/token'.sub('{' + 'appId' + '}', CGI.escape(app_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']) 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(waa_s_portal_token_request)

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

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

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