Class: MailchimpMarketing::RootApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client) ⇒ RootApi

Returns a new instance of RootApi.



19
20
21
 
# File 'lib/MailchimpMarketing/api/root_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/root_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_root(opts = {}) ⇒ APIRoot

API Root Get links to all other resources available in the API.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

  • :exclude_fields (Array<String>) —

    A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Returns:

  • (APIRoot) 


28
29
30
31
 
# File 'lib/MailchimpMarketing/api/root_api.rb', line 28

def get_root(opts = {})
  data, _status_code, _headers = get_root_with_http_info(opts)
  data
end

#get_root_with_http_info(opts = {}) ⇒ Array<(APIRoot, Fixnum, Hash)>

API Root Get links to all other resources available in the API.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

  • :exclude_fields (Array<String>) —

    A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

Returns:

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

    APIRoot data, response status code and response headers



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
 
# File 'lib/MailchimpMarketing/api/root_api.rb', line 39

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

  # query parameters
  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?

  # 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 => 'APIRoot')
  return data, status_code, headers
end