Class: Io::Flow::V0::Models::ShippingLabelPackage

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

Overview

Describes a package to be shipped, including dimensions and items included

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ ShippingLabelPackage

Returns a new instance of ShippingLabelPackage.



44790
44791
44792
44793
44794
44795
44796
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 44790

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:dimensions, :items], 'ShippingLabelPackage')
  @dimensions = (x = opts.delete(:dimensions); x.is_a?(::Io::Flow::V0::Models::Dimension) ? x : ::Io::Flow::V0::Models::Dimension.new(x))
  @items = HttpClient::Preconditions.assert_class('items', opts.delete(:items), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::LineItemForm) ? x : ::Io::Flow::V0::Models::LineItemForm.new(x)) }
  @reference_number = (x = opts.delete(:reference_number); x.nil? ? nil : HttpClient::Preconditions.assert_class('reference_number', x, String))
end

Instance Attribute Details

#dimensions ⇒ Object (readonly)

Returns the value of attribute dimensions.



44788
44789
44790
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 44788

def dimensions
  @dimensions
end

#items ⇒ Object (readonly)

Returns the value of attribute items.



44788
44789
44790
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 44788

def items
  @items
end

#reference_number ⇒ Object (readonly)

Returns the value of attribute reference_number.



44788
44789
44790
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 44788

def reference_number
  @reference_number
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



44802
44803
44804
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 44802

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

#to_hash ⇒ Object 



44806
44807
44808
44809
44810
44811
44812
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 44806

def to_hash
  {
    :dimensions => dimensions.to_hash,
    :items => items.map { |o| o.to_hash },
    :reference_number => reference_number
  }
end

#to_json ⇒ Object 



44798
44799
44800
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 44798

def to_json
  JSON.dump(to_hash)
end