Class: UpBankingClient::UtilityEndpointsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/up_banking/api/utility_endpoints_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UtilityEndpointsApi

Returns a new instance of UtilityEndpointsApi.



19
20
21
 
# File 'lib/up_banking/api/utility_endpoints_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/up_banking/api/utility_endpoints_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#util_ping_get(opts = {}) ⇒ PingResponse

Ping Make a basic ping request to the API. This is useful to verify that authentication is functioning correctly. On authentication success an HTTP ‘200` status is returned. On failure an HTTP `401` error response is returned.

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/up_banking/api/utility_endpoints_api.rb', line 26

def util_ping_get(opts = {})
  data, _status_code, _headers = util_ping_get_with_http_info(opts)
  data
end

#util_ping_get_with_http_info(opts = {}) ⇒ Array<(PingResponse, Integer, Hash)>

Ping Make a basic ping request to the API. This is useful to verify that authentication is functioning correctly. On authentication success an HTTP &#x60;200&#x60; status is returned. On failure an HTTP &#x60;401&#x60; error response is returned.

Parameters:

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

    the optional parameters

Returns:

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

    PingResponse data, response status code and response headers



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
76
77
 
# File 'lib/up_banking/api/utility_endpoints_api.rb', line 35

def util_ping_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UtilityEndpointsApi.util_ping_get ...'
  end
  # resource path
  local_var_path = '/util/ping'

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

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

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

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