Class: Tomba::Status

Inherits:
Service show all
Defined in:
lib/tomba/services/status.rb

Overview

Status service for domain status and autocomplete.

Provides methods to check domain status and get domain suggestions.

See Also:

Instance Method Summary collapse

Methods inherited from Service

#initialize

Constructor Details

This class inherits a constructor from Tomba::Service

Instance Method Details

#auto_complete(query:) ⇒ Hash

Autocomplete

Returns domain suggestions based on a search query.

Parameters:

  • query (String) —

    the search query for domain suggestions

Returns:

  • (Hash) —

    API response containing domain suggestions

Raises:

See Also:



39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/tomba/services/status.rb', line 39

def auto_complete(query:)
  raise Tomba::Exception, 'Missing required parameter: "query"' if query.nil?

  path = '/domain-suggestions'

  params = {}
  params[:query] = query unless query.nil?

  @client.call('get', path, {
                 'content-type' => 'application/json'
               }, params)
end

#domain_status(domain:) ⇒ Hash

Domain Status

Returns the status of a domain, including whether it is webmail or disposable.

Parameters:

  • domain (String) —

    the domain name to check

Returns:

  • (Hash) —

    API response containing domain status

Raises:

See Also:



18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/tomba/services/status.rb', line 18

def domain_status(domain:)
  raise Tomba::Exception, 'Missing required parameter: "domain"' if domain.nil?

  path = '/domain-status'

  params = {}
  params[:domain] = domain unless domain.nil?

  @client.call('get', path, {
                 'content-type' => 'application/json'
               }, params)
end