Class: MailchimpMarketing::PingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/MailchimpMarketing/api/ping_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client) ⇒ PingApi

Returns a new instance of PingApi.



19
20
21
 
# File 'lib/MailchimpMarketing/api/ping_api.rb', line 19

def initialize(api_client)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/MailchimpMarketing/api/ping_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get(opts = {}) ⇒ APIHealthStatus

Ping the API A health check for the API that won’t return any account-specific information.

Parameters:

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

    the optional parameters

Returns:

  • (APIHealthStatus) 


26
27
28
29
 
# File 'lib/MailchimpMarketing/api/ping_api.rb', line 26

def get(opts = {})
  data, _status_code, _headers = get_with_http_info(opts)
  data
end

#get_with_http_info(opts = {}) ⇒ Array<(APIHealthStatus, Fixnum, Hash)>

Ping the API A health check for the API that won&#39;t return any account-specific information.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(APIHealthStatus, Fixnum, Hash)>) —

    APIHealthStatus 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
 
# File 'lib/MailchimpMarketing/api/ping_api.rb', line 35

def get_with_http_info(opts = {})
  # resource path
  local_var_path = '/ping'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'APIHealthStatus')
  return data, status_code, headers
end