Class: OpenApiIplocationClient::DefaultApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_iplocation/api/default_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DefaultApi 



19
20
21
 
# File 'lib/openapi_iplocation/api/default_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/openapi_iplocation/api/default_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#root_get(ip, opts = {}) ⇒ Get200Response

Get geolocation of an IP address Retrieve geolocation of an IP address.

Options Hash (opts):

  • :format (String) —

    Output format, the following formats are supported: plain xml json jsonp php csv serialized

  • :delimiter (String) —

    Delimiter between proxies. Can be used only with format plain. The following types are supported: 1 for "\n", 2 for "<br>".



29
30
31
32
 
# File 'lib/openapi_iplocation/api/default_api.rb', line 29

def root_get(ip, opts = {})
  data, _status_code, _headers = root_get_with_http_info(ip, opts)
  data
end

#root_get_with_http_info(ip, opts = {}) ⇒ Array<(Get200Response, Integer, Hash)>

Get geolocation of an IP address Retrieve geolocation of an IP address.

Options Hash (opts):

  • :format (String) —

    Output format, the following formats are supported: plain xml json jsonp php csv serialized

  • :delimiter (String) —

    Delimiter between proxies. Can be used only with format plain. The following types are supported: 1 for &quot;\n&quot;, 2 for &quot;&lt;br&gt;&quot;.



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
 
# File 'lib/openapi_iplocation/api/default_api.rb', line 41

def root_get_with_http_info(ip, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.root_get ...'
  end
  # verify the required parameter 'ip' is set
  if @api_client.config.client_side_validation && ip.nil?
    fail ArgumentError, "Missing the required parameter 'ip' when calling DefaultApi.root_get"
  end
  # resource path
  local_var_path = '/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ip'] = ip
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
  query_params[:'delimiter'] = opts[:'delimiter'] if !opts[:'delimiter'].nil?

  # 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] || 'Get200Response'

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

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