class ParcelApi::Address

This module provides API requests to Search Domestic(NZ) Addresses, Get Specific Domestic Address Detail, Search International Addresses and Get Specifc International Address Detail.

Constants

AUSTRALIAN_URL
DOMESTIC_URL
INTERNATIONAL_URL

Public Class Methods

new(connection=nil) click to toggle source

Creates a new ParcelApi::Address instance.

# File lib/parcel_api/address.rb, line 13
def initialize(connection=nil)
  @connection ||= connection || ParcelApi::Client.connection
end

Public Instance Methods

australian_details(address_id) click to toggle source

Return australian address details for a specific international address id @param address_id [String] @return australian address detail

# File lib/parcel_api/address.rb, line 55
def australian_details(address_id)
  details_url = File.join(AUSTRALIAN_URL, address_id.to_s)
  response = @connection.get details_url
  RecursiveOpenStruct.new(response.parsed['address'], recurse_over_arrays: true)
end
details(address_id) click to toggle source

Return domestic address details for a domestic address id @param address_id [String] @return address detail object

# File lib/parcel_api/address.rb, line 36
def details(address_id)
  details_url = File.join(DOMESTIC_URL, address_id.to_s)
  response = @connection.get details_url
  OpenStruct.new(response.parsed['address'])
end
international_details(address_id) click to toggle source

Return international address details for a specific international address id @param address_id [String] @return international address detail

# File lib/parcel_api/address.rb, line 78
def international_details(address_id)
  details_url = File.join(INTERNATIONAL_URL, address_id.to_s)
  response = @connection.get details_url
  RecursiveOpenStruct.new(response.parsed['result'], recurse_over_arrays: true)
end