Class: Io::Flow::V0::Models::AddressVerification

Inherits:
Object
  • Object
show all
Defined in:
lib/flow_commerce/flow_api_v0_client.rb

Overview

Address verification returns information on whether or not an address is valid and deliverable - meaning carriers will accept this address. Also returns suggestions for address correction, including data to highlight specific fields to correct.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ AddressVerification

Returns a new instance of AddressVerification.



29798
29799
29800
29801
29802
29803
29804
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 29798

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:address, :valid], 'AddressVerification')
  @address = (x = opts.delete(:address); x.is_a?(::Io::Flow::V0::Models::Address) ? x : ::Io::Flow::V0::Models::Address.new(x))
  @valid = HttpClient::Preconditions.assert_boolean('valid', opts.delete(:valid))
  @suggestions = HttpClient::Preconditions.assert_class('suggestions', (x = opts.delete(:suggestions); x.nil? ? [] : x), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::AddressSuggestion) ? x : ::Io::Flow::V0::Models::AddressSuggestion.new(x)) }
end

Instance Attribute Details

#addressObject (readonly)

Returns the value of attribute address.



29796
29797
29798
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 29796

def address
  @address
end

#suggestionsObject (readonly)

Returns the value of attribute suggestions.



29796
29797
29798
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 29796

def suggestions
  @suggestions
end

#validObject (readonly)

Returns the value of attribute valid.



29796
29797
29798
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 29796

def valid
  @valid
end

Instance Method Details

#copy(incoming = {}) ⇒ Object



29810
29811
29812
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 29810

def copy(incoming={})
  AddressVerification.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
end

#to_hashObject



29814
29815
29816
29817
29818
29819
29820
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 29814

def to_hash
  {
    :address => address.to_hash,
    :valid => valid,
    :suggestions => suggestions.map { |o| o.to_hash }
  }
end

#to_jsonObject



29806
29807
29808
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 29806

def to_json
  JSON.dump(to_hash)
end