Class: Io::Flow::V0::Models::SummaryShippingLabelForm
- Inherits:
-
ShippingLabelForm
- Object
- ShippingLabelForm
- Io::Flow::V0::Models::SummaryShippingLabelForm
- Defined in:
- lib/flow_commerce/flow_api_v0_client.rb
Overview
Minimal form to create a shipping label. Origin and destination are assumed based on a given order’s center and final shipping destination, if no center key is provided
Instance Attribute Summary collapse
-
#center_key ⇒ Object
readonly
Returns the value of attribute center_key.
-
#items ⇒ Object
readonly
Returns the value of attribute items.
-
#order_number ⇒ Object
readonly
Returns the value of attribute order_number.
Attributes inherited from ShippingLabelForm
Instance Method Summary collapse
- #copy(incoming = {}) ⇒ Object
-
#initialize(incoming = {}) ⇒ SummaryShippingLabelForm
constructor
A new instance of SummaryShippingLabelForm.
- #subtype_to_hash ⇒ Object
- #to_json ⇒ Object
Methods inherited from ShippingLabelForm
Constructor Details
#initialize(incoming = {}) ⇒ SummaryShippingLabelForm
Returns a new instance of SummaryShippingLabelForm.
64282 64283 64284 64285 64286 64287 64288 64289 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 64282 def initialize(incoming={}) super(:discriminator => ShippingLabelForm::Types::SUMMARY_SHIPPING_LABEL_FORM) opts = HttpClient::Helper.symbolize_keys(incoming) HttpClient::Preconditions.require_keys(opts, [:order_number, :items], 'SummaryShippingLabelForm') @order_number = HttpClient::Preconditions.assert_class('order_number', opts.delete(:order_number), String) @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)) } @center_key = (x = opts.delete(:center_key); x.nil? ? nil : HttpClient::Preconditions.assert_class('center_key', x, String)) end |
Instance Attribute Details
#center_key ⇒ Object (readonly)
Returns the value of attribute center_key.
64280 64281 64282 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 64280 def center_key @center_key end |
#items ⇒ Object (readonly)
Returns the value of attribute items.
64280 64281 64282 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 64280 def items @items end |
#order_number ⇒ Object (readonly)
Returns the value of attribute order_number.
64280 64281 64282 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 64280 def order_number @order_number end |
Instance Method Details
#copy(incoming = {}) ⇒ Object
64295 64296 64297 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 64295 def copy(incoming={}) SummaryShippingLabelForm.new(subtype_to_hash.merge(HttpClient::Helper.symbolize_keys(incoming))) end |
#subtype_to_hash ⇒ Object
64299 64300 64301 64302 64303 64304 64305 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 64299 def subtype_to_hash { :order_number => order_number, :items => items.map { |o| o.to_hash }, :center_key => center_key } end |
#to_json ⇒ Object
64291 64292 64293 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 64291 def to_json JSON.dump(to_hash) end |