Module: Nzbn

Defined in:
lib/nzbn.rb,
lib/nzbn/error.rb,
lib/nzbn/client.rb,
lib/nzbn/version.rb,
lib/nzbn/api/roles.rb,
lib/nzbn/api/history.rb,
lib/nzbn/models/base.rb,
lib/nzbn/models/role.rb,
lib/nzbn/api/entities.rb,
lib/nzbn/api/websites.rb,
lib/nzbn/api/addresses.rb,
lib/nzbn/configuration.rb,
lib/nzbn/models/entity.rb,
lib/nzbn/api/watchlists.rb,
lib/nzbn/models/address.rb,
lib/nzbn/models/company.rb,
lib/nzbn/models/website.rb,
lib/nzbn/models/watchlist.rb,
lib/nzbn/api/phone_numbers.rb,
lib/nzbn/api/trading_names.rb,
lib/nzbn/models/full_entity.rb,
lib/nzbn/api/company_details.rb,
lib/nzbn/api/email_addresses.rb,
lib/nzbn/models/phone_number.rb,
lib/nzbn/models/trading_name.rb,
lib/nzbn/api/privacy_settings.rb,
lib/nzbn/models/email_address.rb,
lib/nzbn/models/search_entity.rb,
lib/nzbn/models/error_response.rb,
lib/nzbn/api/organisation_parts.rb,
lib/nzbn/models/search_response.rb,
lib/nzbn/models/privacy_settings.rb,
lib/nzbn/models/organisation_part.rb,
lib/nzbn/api/industry_classifications.rb,
lib/nzbn/models/industry_classification.rb

Overview

NZBN Ruby Client - New Zealand Business Number API

Examples:

Basic usage

Nzbn.configure do |config|
  config.api_key = 'your-api-key'
end

client = Nzbn::Client.new
entities = client.entities.search(search_term: 'Company Name')

Defined Under Namespace

Modules: Api, Models Classes: ApiError, AuthenticationError, AuthorizationError, Client, Configuration, ConfigurationError, ConnectionError, Error, NotFoundError, PreconditionFailedError, ServerError, TimeoutError, ValidationError

Constant Summary collapse

DEFAULT_BASE_URL = 
'https://api.business.govt.nz/gateway/nzbn/v5'
VERSION = 
'0.1.2'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Object

Returns the value of attribute configuration.



56
57
58
 
# File 'lib/nzbn.rb', line 56

def configuration
  @configuration
end

Class Method Details

.configure {|configuration| ... } ⇒ Object

Yields:



58
59
60
61
 
# File 'lib/nzbn.rb', line 58

def configure
  self.configuration ||= Configuration.new
  yield(configuration)
end

.reset_configuration! ⇒ Object 



63
64
65
 
# File 'lib/nzbn.rb', line 63

def reset_configuration!
  self.configuration = Configuration.new
end