Class: WhoisFreaks::DatabasesExpiringDroppedApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DatabasesExpiringDroppedApi

Returns a new instance of DatabasesExpiringDroppedApi.



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

def api_client
  @api_client
end

Instance Method Details

#db_dropped(whois, opts = {}) ⇒ File

Dropped Domains Dropped Domains. Returns the file/snapshot described by this operation.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    yyyy-MM-dd; omit for latest

Returns:

  • (File) 


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

def db_dropped(whois, opts = {})
  data, _status_code, _headers = db_dropped_with_http_info(whois, opts)
  data
end

#db_dropped_backlinks(opts = {}) ⇒ File

Dropped With Backlinks Dropped With Backlinks. Returns the file/snapshot described by this operation.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :whois (Boolean)
  • :date (Date) —

    yyyy-MM-dd; omit for latest

Returns:

  • (File) 


95
96
97
98
 
# File 'lib/whoisfreaks/api/databases_expiring_dropped_api.rb', line 95

def db_dropped_backlinks(opts = {})
  data, _status_code, _headers = db_dropped_backlinks_with_http_info(opts)
  data
end

#db_dropped_backlinks_with_http_info(opts = {}) ⇒ Array<(File, Integer, Hash)>

Dropped With Backlinks Dropped With Backlinks. Returns the file/snapshot described by this operation.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :whois (Boolean)
  • :date (Date) —

    yyyy-MM-dd; omit for latest

Returns:

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

    File data, response status code and response headers



106
107
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
 
# File 'lib/whoisfreaks/api/databases_expiring_dropped_api.rb', line 106

def db_dropped_backlinks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesExpiringDroppedApi.db_dropped_backlinks ...'
  end
  # resource path
  local_var_path = '/v3.3/download/domainer/dropped/backlinks'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'whois'] = opts[:'whois'] if !opts[:'whois'].nil?
  query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', '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 => :"DatabasesExpiringDroppedApi.db_dropped_backlinks",
    :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: DatabasesExpiringDroppedApi#db_dropped_backlinks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#db_dropped_json(opts = {}) ⇒ Array<String>

Dropped Domains (JSON) Dropped Domains (JSON). Returns the file/snapshot described by this operation.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    yyyy-MM-dd; omit for latest

  • :tlds (String)

Returns:

  • (Array<String>) 


158
159
160
161
 
# File 'lib/whoisfreaks/api/databases_expiring_dropped_api.rb', line 158

def db_dropped_json(opts = {})
  data, _status_code, _headers = db_dropped_json_with_http_info(opts)
  data
end

#db_dropped_json_with_http_info(opts = {}) ⇒ Array<(Array<String>, Integer, Hash)>

Dropped Domains (JSON) Dropped Domains (JSON). Returns the file/snapshot described by this operation.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    yyyy-MM-dd; omit for latest

  • :tlds (String)

Returns:

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

    Array data, response status code and response headers



169
170
171
172
173
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
 
# File 'lib/whoisfreaks/api/databases_expiring_dropped_api.rb', line 169

def db_dropped_json_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesExpiringDroppedApi.db_dropped_json ...'
  end
  # resource path
  local_var_path = '/v3.1/domains/dropped'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?
  query_params[:'tlds'] = opts[:'tlds'] if !opts[:'tlds'].nil?

  # 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] || 'Array<String>'

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

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

#db_dropped_with_http_info(whois, opts = {}) ⇒ Array<(File, Integer, Hash)>

Dropped Domains Dropped Domains. Returns the file/snapshot described by this operation.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    yyyy-MM-dd; omit for latest

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

def db_dropped_with_http_info(whois, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesExpiringDroppedApi.db_dropped ...'
  end
  # verify the required parameter 'whois' is set
  if @api_client.config.client_side_validation && whois.nil?
    fail ArgumentError, "Missing the required parameter 'whois' when calling DatabasesExpiringDroppedApi.db_dropped"
  end
  # resource path
  local_var_path = '/v3.1/download/domainer/dropped'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'whois'] = whois
  query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', '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 => :"DatabasesExpiringDroppedApi.db_dropped",
    :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: DatabasesExpiringDroppedApi#db_dropped\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#db_expired(whois, opts = {}) ⇒ File

Expiring Domains Expiring Domains. Returns the file/snapshot described by this operation.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    yyyy-MM-dd; omit for latest

Returns:

  • (File) 


221
222
223
224
 
# File 'lib/whoisfreaks/api/databases_expiring_dropped_api.rb', line 221

def db_expired(whois, opts = {})
  data, _status_code, _headers = db_expired_with_http_info(whois, opts)
  data
end

#db_expired_cleaned(opts = {}) ⇒ File

Expiring Cleaned WHOIS Expiring Cleaned WHOIS. Returns the file/snapshot described by this operation.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    yyyy-MM-dd; omit for latest

Returns:

  • (File) 


287
288
289
290
 
# File 'lib/whoisfreaks/api/databases_expiring_dropped_api.rb', line 287

def db_expired_cleaned(opts = {})
  data, _status_code, _headers = db_expired_cleaned_with_http_info(opts)
  data
end

#db_expired_cleaned_with_http_info(opts = {}) ⇒ Array<(File, Integer, Hash)>

Expiring Cleaned WHOIS Expiring Cleaned WHOIS. Returns the file/snapshot described by this operation.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    yyyy-MM-dd; omit for latest

Returns:

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

    File data, response status code and response headers



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/whoisfreaks/api/databases_expiring_dropped_api.rb', line 297

def db_expired_cleaned_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesExpiringDroppedApi.db_expired_cleaned ...'
  end
  # resource path
  local_var_path = '/v3.1/download/domainer/expired/cleaned'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', '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 => :"DatabasesExpiringDroppedApi.db_expired_cleaned",
    :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: DatabasesExpiringDroppedApi#db_expired_cleaned\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#db_expired_with_http_info(whois, opts = {}) ⇒ Array<(File, Integer, Hash)>

Expiring Domains Expiring Domains. Returns the file/snapshot described by this operation.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :date (Date) —

    yyyy-MM-dd; omit for latest

Returns:

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

    File data, response status code and response headers



232
233
234
235
236
237
238
239
240
241
242
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
 
# File 'lib/whoisfreaks/api/databases_expiring_dropped_api.rb', line 232

def db_expired_with_http_info(whois, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatabasesExpiringDroppedApi.db_expired ...'
  end
  # verify the required parameter 'whois' is set
  if @api_client.config.client_side_validation && whois.nil?
    fail ArgumentError, "Missing the required parameter 'whois' when calling DatabasesExpiringDroppedApi.db_expired"
  end
  # resource path
  local_var_path = '/v3.1/download/domainer/expired'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'whois'] = whois
  query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', '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 => :"DatabasesExpiringDroppedApi.db_expired",
    :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: DatabasesExpiringDroppedApi#db_expired\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end