Class: Postio::AddressResource

Inherits:
Object
  • Object
show all
Defined in:
lib/postio/client.rb

Overview

Resource: /address/*

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ AddressResource

Returns a new instance of AddressResource.



167
 
# File 'lib/postio/client.rb', line 167

def initialize(client) = (@client = client)

Instance Method Details

#postcode(postcode, max_results: nil) ⇒ Object 



175
176
177
178
179
180
 
# File 'lib/postio/client.rb', line 175

def postcode(postcode, max_results: nil)
  Models::AddressPostcodeEnvelope.from_hash(
    @client.request("/address/postcode/#{URI.encode_www_form_component(postcode)}",
                    query: { "max_results" => max_results })
  )
end

#search(q, max_results: nil) ⇒ Object 



169
170
171
172
173
 
# File 'lib/postio/client.rb', line 169

def search(q, max_results: nil)
  Models::AddressSearchEnvelope.from_hash(
    @client.request("/address/search", query: { "q" => q, "max_results" => max_results })
  )
end

#udprn(udprn) ⇒ Object 



182
183
184
185
186
 
# File 'lib/postio/client.rb', line 182

def udprn(udprn)
  Models::AddressUdprnEnvelope.from_hash(
    @client.request("/address/udprn/#{URI.encode_www_form_component(udprn.to_s)}")
  )
end