Class: Io::Flow::V0::Models::RatecardLane

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

Overview

Describe list of rates applicable for a lane on the ratecard - defined by origin and destination zone

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ RatecardLane

Returns a new instance of RatecardLane.



62184
62185
62186
62187
62188
62189
62190
62191
62192
62193
62194
62195
62196
62197
62198
62199
62200
62201
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62184

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :ratecard, :currency, :delivered_duty, :shipment_window, :destination, :dim_factor, :fees, :origin, :service, :rates, :rounding, :weight_unit, :distance_unit], 'RatecardLane')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @ratecard = (x = opts.delete(:ratecard); x.is_a?(::Io::Flow::V0::Models::RatecardSummary) ? x : ::Io::Flow::V0::Models::RatecardSummary.new(x))
  @currency = HttpClient::Preconditions.assert_class('currency', opts.delete(:currency), String)
  @delivered_duty = (x = opts.delete(:delivered_duty); x.is_a?(::Io::Flow::V0::Models::DeliveredDuty) ? x : ::Io::Flow::V0::Models::DeliveredDuty.apply(x))
  @shipment_window = (x = opts.delete(:shipment_window); x.is_a?(::Io::Flow::V0::Models::ShipmentWindow) ? x : ::Io::Flow::V0::Models::ShipmentWindow.new(x))
  @destination = (x = opts.delete(:destination); x.is_a?(::Io::Flow::V0::Models::Zone) ? x : ::Io::Flow::V0::Models::Zone.new(x))
  @dim_factor = HttpClient::Preconditions.assert_class('dim_factor', opts.delete(:dim_factor), 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)) }
  @origin = (x = opts.delete(:origin); x.is_a?(::Io::Flow::V0::Models::Zone) ? x : ::Io::Flow::V0::Models::Zone.new(x))
  @service = (x = opts.delete(:service); x.is_a?(::Io::Flow::V0::Models::RatecardServiceSummary) ? x : ::Io::Flow::V0::Models::RatecardServiceSummary.new(x))
  @rates = HttpClient::Preconditions.assert_class('rates', opts.delete(:rates), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::RatecardRate) ? x : ::Io::Flow::V0::Models::RatecardRate.new(x)) }
  @rounding = (x = opts.delete(:rounding); x.is_a?(::Io::Flow::V0::Models::Rounding) ? x : ::Io::Flow::V0::Models::Rounding.new(x))
  @weight_unit = (x = opts.delete(:weight_unit); x.is_a?(::Io::Flow::V0::Models::UnitOfMeasurement) ? x : ::Io::Flow::V0::Models::UnitOfMeasurement.apply(x))
  @distance_unit = (x = opts.delete(:distance_unit); x.is_a?(::Io::Flow::V0::Models::UnitOfMeasurement) ? x : ::Io::Flow::V0::Models::UnitOfMeasurement.apply(x))
end

Instance Attribute Details

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



62182
62183
62184
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62182

def currency
  @currency
end

#delivered_duty ⇒ Object (readonly)

Returns the value of attribute delivered_duty.



62182
62183
62184
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62182

def delivered_duty
  @delivered_duty
end

#destination ⇒ Object (readonly)

Returns the value of attribute destination.



62182
62183
62184
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62182

def destination
  @destination
end

#dim_factor ⇒ Object (readonly)

Returns the value of attribute dim_factor.



62182
62183
62184
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62182

def dim_factor
  @dim_factor
end

#distance_unit ⇒ Object (readonly)

Returns the value of attribute distance_unit.



62182
62183
62184
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62182

def distance_unit
  @distance_unit
end

#fees ⇒ Object (readonly)

Returns the value of attribute fees.



62182
62183
62184
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62182

def fees
  @fees
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



62182
62183
62184
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62182

def id
  @id
end

#origin ⇒ Object (readonly)

Returns the value of attribute origin.



62182
62183
62184
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62182

def origin
  @origin
end

#ratecard ⇒ Object (readonly)

Returns the value of attribute ratecard.



62182
62183
62184
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62182

def ratecard
  @ratecard
end

#rates ⇒ Object (readonly)

Returns the value of attribute rates.



62182
62183
62184
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62182

def rates
  @rates
end

#rounding ⇒ Object (readonly)

Returns the value of attribute rounding.



62182
62183
62184
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62182

def rounding
  @rounding
end

#service ⇒ Object (readonly)

Returns the value of attribute service.



62182
62183
62184
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62182

def service
  @service
end

#shipment_window ⇒ Object (readonly)

Returns the value of attribute shipment_window.



62182
62183
62184
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62182

def shipment_window
  @shipment_window
end

#weight_unit ⇒ Object (readonly)

Returns the value of attribute weight_unit.



62182
62183
62184
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62182

def weight_unit
  @weight_unit
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



62207
62208
62209
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62207

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

#to_hash ⇒ Object 



62211
62212
62213
62214
62215
62216
62217
62218
62219
62220
62221
62222
62223
62224
62225
62226
62227
62228
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62211

def to_hash
  {
    :id => id,
    :ratecard => ratecard.to_hash,
    :currency => currency,
    :delivered_duty => delivered_duty.value,
    :shipment_window => shipment_window.to_hash,
    :destination => destination.to_hash,
    :dim_factor => dim_factor,
    :fees => fees.map { |o| o.to_hash },
    :origin => origin.to_hash,
    :service => service.to_hash,
    :rates => rates.map { |o| o.to_hash },
    :rounding => rounding.to_hash,
    :weight_unit => weight_unit.value,
    :distance_unit => distance_unit.value
  }
end

#to_json ⇒ Object 



62203
62204
62205
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 62203

def to_json
  JSON.dump(to_hash)
end