Class: Io::Flow::V0::Models::HopEstimate

Inherits:

Object

• Object
• Io::Flow::V0::Models::HopEstimate

Defined in:

lib/flow_commerce/flow_api_v0_client.rb

Instance Attribute Summary

• #amount ⇒ Object readonly

  Returns the value of attribute amount.

• #currency ⇒ Object readonly

  Returns the value of attribute currency.

• #destination_address ⇒ Object readonly

  Returns the value of attribute destination_address.

• #fees ⇒ Object readonly

  Returns the value of attribute fees.

• #origin_address ⇒ Object readonly

  Returns the value of attribute origin_address.

• #service ⇒ Object readonly

  Returns the value of attribute service.

• #shipment_window ⇒ Object readonly

  Returns the value of attribute shipment_window.

• #total ⇒ Object readonly

  Returns the value of attribute total.

Instance Method Summary

• #copy(incoming = {}) ⇒ Object
• #initialize(incoming = {}) ⇒ HopEstimate constructor

  A new instance of HopEstimate.

• #to_hash ⇒ Object
• #to_json ⇒ Object

Constructor Details

#initialize(incoming = {}) ⇒ HopEstimate

Returns a new instance of HopEstimate.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 32085

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:origin_address, :destination_address, :service, :shipment_window, :currency, :amount, :fees, :total], 'HopEstimate')
  @origin_address = (x = opts.delete(:origin_address); x.is_a?(::Io::Flow::V0::Models::ShippingAddress) ? x : ::Io::Flow::V0::Models::ShippingAddress.new(x))
  @destination_address = (x = opts.delete(:destination_address); x.is_a?(::Io::Flow::V0::Models::ShippingAddress) ? x : ::Io::Flow::V0::Models::ShippingAddress.new(x))
  @service = (x = opts.delete(:service); x.is_a?(::Io::Flow::V0::Models::RatecardServiceSummary) ? x : ::Io::Flow::V0::Models::RatecardServiceSummary.new(x))
  @shipment_window = (x = opts.delete(:shipment_window); x.is_a?(::Io::Flow::V0::Models::ShipmentWindow) ? x : ::Io::Flow::V0::Models::ShipmentWindow.new(x))
  @currency = HttpClient::Preconditions.assert_class('currency', opts.delete(:currency), String)
  @amount = HttpClient::Preconditions.assert_class('amount', opts.delete(:amount), Numeric)
  @fees = HttpClient::Preconditions.assert_class('fees', opts.delete(:fees), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::RatecardFee) ? x : ::Io::Flow::V0::Models::RatecardFee.from_json(x)) }
  @total = HttpClient::Preconditions.assert_class('total', opts.delete(:total), Numeric)
end

Instance Attribute Details

#amount ⇒ Object (readonly)

Returns the value of attribute amount.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 32083

def amount
  @amount
end

#currency ⇒ Object (readonly)

Returns the value of attribute currency.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 32083

def currency
  @currency
end

#destination_address ⇒ Object (readonly)

Returns the value of attribute destination_address.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 32083

def destination_address
  @destination_address
end

#fees ⇒ Object (readonly)

Returns the value of attribute fees.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 32083

def fees
  @fees
end

#origin_address ⇒ Object (readonly)

Returns the value of attribute origin_address.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 32083

def origin_address
  @origin_address
end

#service ⇒ Object (readonly)

Returns the value of attribute service.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 32083

def service
  @service
end

#shipment_window ⇒ Object (readonly)

Returns the value of attribute shipment_window.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 32083

def shipment_window
  @shipment_window
end

#total ⇒ Object (readonly)

Returns the value of attribute total.

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 32083

def total
  @total
end

Instance Method Details

#copy(incoming = {}) ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 32102

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

#to_hash ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 32106

def to_hash
  {
    :origin_address => origin_address.to_hash,
    :destination_address => destination_address.to_hash,
    :service => service.to_hash,
    :shipment_window => shipment_window.to_hash,
    :currency => currency,
    :amount => amount,
    :fees => fees.map { |o| o.to_hash },
    :total => total
  }
end

#to_json ⇒ Object

# File 'lib/flow_commerce/flow_api_v0_client.rb', line 32098

def to_json
  JSON.dump(to_hash)
end