Class: Io::Flow::V0::Models::Tier

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

Overview

Service shipping tier available in this tier group. e.g. Standard tier, Express tier, Economy tier

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ Tier

Returns a new instance of Tier.



70613
70614
70615
70616
70617
70618
70619
70620
70621
70622
70623
70624
70625
70626
70627
70628
70629
70630
70631
70632
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70613

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :integration, :name, :rules, :services, :strategy, :visibility, :currency], 'Tier')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @direction = (x = (x = opts.delete(:direction); x.nil? ? "outbound" : x); x.is_a?(::Io::Flow::V0::Models::LaneDirection) ? x : ::Io::Flow::V0::Models::LaneDirection.apply(x))
  @integration = (x = opts.delete(:integration); x.is_a?(::Io::Flow::V0::Models::ShipmentIntegrationType) ? x : ::Io::Flow::V0::Models::ShipmentIntegrationType.apply(x))
  @name = HttpClient::Preconditions.assert_class('name', opts.delete(:name), String)
  @message = (x = opts.delete(:message); x.nil? ? nil : HttpClient::Preconditions.assert_class('message', x, String))
  @rules = HttpClient::Preconditions.assert_class('rules', opts.delete(:rules), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::TierRule) ? x : ::Io::Flow::V0::Models::TierRule.new(x)) }
  @services = HttpClient::Preconditions.assert_class('services', opts.delete(:services), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::CarrierService) ? x : ::Io::Flow::V0::Models::CarrierService.new(x)) }
  @strategy = (x = opts.delete(:strategy); x.is_a?(::Io::Flow::V0::Models::TierStrategy) ? x : ::Io::Flow::V0::Models::TierStrategy.apply(x))
  @visibility = (x = opts.delete(:visibility); x.is_a?(::Io::Flow::V0::Models::Visibility) ? x : ::Io::Flow::V0::Models::Visibility.apply(x))
  @currency = HttpClient::Preconditions.assert_class('currency', opts.delete(:currency), String)
  @description = (x = opts.delete(:description); x.nil? ? nil : HttpClient::Preconditions.assert_class('description', x, String))
  @display = (x = opts.delete(:display); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::TierDisplay) ? x : ::Io::Flow::V0::Models::TierDisplay.new(x)))
  @shipping_lane = (x = opts.delete(:shipping_lane); x.nil? ? nil : HttpClient::Preconditions.assert_class('shipping_lane', x, String))
  @surcharge_settings = (x = opts.delete(:surcharge_settings); x.nil? ? nil : HttpClient::Preconditions.assert_class('surcharge_settings', x, Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::SurchargeSetting) ? x : ::Io::Flow::V0::Models::SurchargeSetting.new(x)) })
  @lane = (x = opts.delete(:lane); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::ShippingLaneSummary) ? x : ::Io::Flow::V0::Models::ShippingLaneSummary.new(x)))
  @settings = (x = opts.delete(:settings); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::TierSettings) ? x : ::Io::Flow::V0::Models::TierSettings.new(x)))
end

Instance Attribute Details

#currency ⇒ Object (readonly)

Returns the value of attribute currency.



70611
70612
70613
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70611

def currency
  @currency
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



70611
70612
70613
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70611

def description
  @description
end

#direction ⇒ Object (readonly)

Returns the value of attribute direction.



70611
70612
70613
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70611

def direction
  @direction
end

#display ⇒ Object (readonly)

Returns the value of attribute display.



70611
70612
70613
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70611

def display
  @display
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



70611
70612
70613
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70611

def id
  @id
end

#integration ⇒ Object (readonly)

Returns the value of attribute integration.



70611
70612
70613
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70611

def integration
  @integration
end

#lane ⇒ Object (readonly)

Returns the value of attribute lane.



70611
70612
70613
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70611

def lane
  @lane
end

#message ⇒ Object (readonly)

Returns the value of attribute message.



70611
70612
70613
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70611

def message
  @message
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



70611
70612
70613
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70611

def name
  @name
end

#rules ⇒ Object (readonly)

Returns the value of attribute rules.



70611
70612
70613
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70611

def rules
  @rules
end

#services ⇒ Object (readonly)

Returns the value of attribute services.



70611
70612
70613
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70611

def services
  @services
end

#settings ⇒ Object (readonly)

Returns the value of attribute settings.



70611
70612
70613
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70611

def settings
  @settings
end

#shipping_lane ⇒ Object (readonly)

Returns the value of attribute shipping_lane.



70611
70612
70613
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70611

def shipping_lane
  @shipping_lane
end

#strategy ⇒ Object (readonly)

Returns the value of attribute strategy.



70611
70612
70613
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70611

def strategy
  @strategy
end

#surcharge_settings ⇒ Object (readonly)

Returns the value of attribute surcharge_settings.



70611
70612
70613
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70611

def surcharge_settings
  @surcharge_settings
end

#visibility ⇒ Object (readonly)

Returns the value of attribute visibility.



70611
70612
70613
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70611

def visibility
  @visibility
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



70638
70639
70640
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70638

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

#to_hash ⇒ Object 



70642
70643
70644
70645
70646
70647
70648
70649
70650
70651
70652
70653
70654
70655
70656
70657
70658
70659
70660
70661
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70642

def to_hash
  {
    :id => id,
    :direction => direction.value,
    :integration => integration.value,
    :name => name,
    :message => message,
    :rules => rules.map { |o| o.to_hash },
    :services => services.map { |o| o.to_hash },
    :strategy => strategy.value,
    :visibility => visibility.value,
    :currency => currency,
    :description => description,
    :display => display.nil? ? nil : display.to_hash,
    :shipping_lane => shipping_lane,
    :surcharge_settings => surcharge_settings.nil? ? nil : surcharge_settings.map { |o| o.to_hash },
    :lane => lane.nil? ? nil : lane.to_hash,
    :settings => settings.nil? ? nil : settings.to_hash
  }
end

#to_json ⇒ Object 



70634
70635
70636
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 70634

def to_json
  JSON.dump(to_hash)
end