Class: WhoisFreaks::DatabasesIPGeolocationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/whoisfreaks/api/databases_ip_geolocation_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DatabasesIPGeolocationApi

Returns a new instance of DatabasesIPGeolocationApi.



19
20
21
 
# File 'lib/whoisfreaks/api/databases_ip_geolocation_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/whoisfreaks/api/databases_ip_geolocation_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#db_ip_city(api_key, date, opts = {}) ⇒ File

IP to City Snapshot IP to City Snapshot. Returns the file/snapshot described by this operation.

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

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

    the optional parameters

Returns:

  • (File) 


28
29
30
31
 
# File 'lib/whoisfreaks/api/databases_ip_geolocation_api.rb', line 28

def db_ip_city(api_key, date, opts = {})
  data, _status_code, _headers = db_ip_city_with_http_info(api_key, date, opts)
  data
end

#db_ip_city_status(api_key, opts = {}) ⇒ SnapshotStatus

IP to City Snapshot Status IP to City Snapshot Status. Returns the file/snapshot described by this operation.

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

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

    the optional parameters

Returns:



98
99
100
101
 
# File 'lib/whoisfreaks/api/databases_ip_geolocation_api.rb', line 98

def db_ip_city_status(api_key, opts = {})
  data, _status_code, _headers = db_ip_city_status_with_http_info(api_key, opts)
  data
end

#db_ip_city_status_with_http_info(api_key, opts = {}) ⇒ Array<(SnapshotStatus, Integer, Hash)>

IP to City Snapshot Status IP to City Snapshot Status. Returns the file/snapshot described by this operation.

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

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

    the optional parameters

Returns:

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

    SnapshotStatus data, response status code and response headers



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/whoisfreaks/api/databases_ip_geolocation_api.rb', line 108

def db_ip_city_status_with_http_info(api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesIPGeolocationApi.db_ip_city_status ...'
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling DatabasesIPGeolocationApi.db_ip_city_status"
  end
  # resource path
  local_var_path = '/v3.3/status/snapshot/ip/city'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'apiKey'] = api_key

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

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

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

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

#db_ip_city_with_http_info(api_key, date, opts = {}) ⇒ Array<(File, Integer, Hash)>

IP to City Snapshot IP to City Snapshot. Returns the file/snapshot described by this operation.

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

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

    the optional parameters

Returns:

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

    File 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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/whoisfreaks/api/databases_ip_geolocation_api.rb', line 39

def db_ip_city_with_http_info(api_key, date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesIPGeolocationApi.db_ip_city ...'
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling DatabasesIPGeolocationApi.db_ip_city"
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling DatabasesIPGeolocationApi.db_ip_city"
  end
  # resource path
  local_var_path = '/v3.3/download/snapshot/ip/city'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'apiKey'] = api_key
  query_params[:'date'] = date

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/zip', 'application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

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

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

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

#db_ip_country(api_key, date, opts = {}) ⇒ File

IP to Country Snapshot IP to Country Snapshot. Returns the file/snapshot described by this operation.

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

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

    the optional parameters

Returns:

  • (File) 


163
164
165
166
 
# File 'lib/whoisfreaks/api/databases_ip_geolocation_api.rb', line 163

def db_ip_country(api_key, date, opts = {})
  data, _status_code, _headers = db_ip_country_with_http_info(api_key, date, opts)
  data
end

#db_ip_country_status(api_key, opts = {}) ⇒ SnapshotStatus

IP to Country Snapshot Status IP to Country Snapshot Status. Returns the file/snapshot described by this operation.

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

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

    the optional parameters

Returns:



233
234
235
236
 
# File 'lib/whoisfreaks/api/databases_ip_geolocation_api.rb', line 233

def db_ip_country_status(api_key, opts = {})
  data, _status_code, _headers = db_ip_country_status_with_http_info(api_key, opts)
  data
end

#db_ip_country_status_with_http_info(api_key, opts = {}) ⇒ Array<(SnapshotStatus, Integer, Hash)>

IP to Country Snapshot Status IP to Country Snapshot Status. Returns the file/snapshot described by this operation.

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

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

    the optional parameters

Returns:

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

    SnapshotStatus data, response status code and response headers



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/whoisfreaks/api/databases_ip_geolocation_api.rb', line 243

def db_ip_country_status_with_http_info(api_key, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesIPGeolocationApi.db_ip_country_status ...'
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling DatabasesIPGeolocationApi.db_ip_country_status"
  end
  # resource path
  local_var_path = '/v3.3/status/snapshot/ip/country'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'apiKey'] = api_key

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

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

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

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

#db_ip_country_with_http_info(api_key, date, opts = {}) ⇒ Array<(File, Integer, Hash)>

IP to Country Snapshot IP to Country Snapshot. Returns the file/snapshot described by this operation.

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/whoisfreaks/api/databases_ip_geolocation_api.rb', line 174

def db_ip_country_with_http_info(api_key, date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesIPGeolocationApi.db_ip_country ...'
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling DatabasesIPGeolocationApi.db_ip_country"
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling DatabasesIPGeolocationApi.db_ip_country"
  end
  # resource path
  local_var_path = '/v3.3/download/snapshot/ip/country'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'apiKey'] = api_key
  query_params[:'date'] = date

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/zip', 'application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

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

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

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