Class: SnapTrade::APIStatusApi

Inherits:
Object
  • Object
show all
Defined in:
lib/snaptrade/api/api_status_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ APIStatusApi

Returns a new instance of APIStatusApi.



16
17
18
 
# File 'lib/snaptrade/api/api_status_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/snaptrade/api/api_status_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#check(extra: {}) ⇒ Object

Get API Status

Check whether the API is operational and verify timestamps.

Parameters:

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

    additional parameters to pass along through :header_params, :query_params, or parameter name



25
26
27
28
 
# File 'lib/snaptrade/api/api_status_api.rb', line 25

def check(extra: {})
  data, _status_code, _headers = check_with_http_info_impl(extra)
  data
end

#check_with_http_info(extra: {}) ⇒ Object

Get API Status

Check whether the API is operational and verify timestamps.

Parameters:

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

    additional parameters to pass along through :header_params, :query_params, or parameter name



35
36
37
 
# File 'lib/snaptrade/api/api_status_api.rb', line 35

def check_with_http_info(extra: {})
  check_with_http_info_impl(extra)
end