Class: PostalCodesRubyClient::Resources::PostalCodes

Inherits:
Object
  • Object
show all
Defined in:
lib/postal_codes_ruby_client/resources/postal_codes.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ PostalCodes

Returns a new instance of PostalCodes.



6
7
8
 
# File 'lib/postal_codes_ruby_client/resources/postal_codes.rb', line 6

def initialize(client)
  @client = client
end

Instance Method Details

#countries ⇒ Hash

List all available country codes.

Returns:

  • (Hash) —

    { countries: ["AT", "CH", "DE", ...] }



26
27
28
 
# File 'lib/postal_codes_ruby_client/resources/postal_codes.rb', line 26

def countries
  @client.get("/api/v1/postal_codes/countries")
end

#search(q:, country: nil, limit: nil) ⇒ Hash

Search for postal codes.

Parameters:

  • q (String) —

    Full or partial postal code (required)

  • country (String, nil) (defaults to: nil) —

    ISO country code, e.g. "DE", "AT", "CH"

  • limit (Integer, nil) (defaults to: nil) —

    Max results (default 50, max 200)

Returns:

  • (Hash) —

    { query:, country:, count:, results: [...] }



16
17
18
19
20
21
 
# File 'lib/postal_codes_ruby_client/resources/postal_codes.rb', line 16

def search(q:, country: nil, limit: nil)
  params = { q: q }
  params[:country] = country if country
  params[:limit] = limit if limit
  @client.get("/api/v1/postal_codes", params)
end