Module: VerifIP

Defined in:

lib/verifip.rb,
lib/verifip/client.rb,
lib/verifip/errors.rb,
lib/verifip/models.rb,
lib/verifip/version.rb

Defined Under Namespace

Classes: AssessResponse, AuthenticationError, BatchResponse, CheckResponse, Client, EmailResponse, HealthResponse, InvalidRequestError, PhoneResponse, RateLimitError, RateLimitInfo, ReportResponse, ServerError, URLResponse, VerifIPError, WHOISResponse

Constant Summary

VERSION =

"0.2.0"

Class Method Summary

• .client(api_key:, **kwargs) ⇒ Client

  Convenience method to create a new client.

Class Method Details

.client(api_key:, **kwargs) ⇒ Client

Convenience method to create a new client.

Parameters:

• api_key (String) —

  your VerifIP API key

• kwargs (Hash) —

  additional options passed to VerifIP::Client#initialize

Returns:

• (Client)

# File 'lib/verifip.rb', line 14

def self.client(api_key:, **kwargs)
  Client.new(api_key: api_key, **kwargs)
end