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

• #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

#discriminator

Instance Method Summary

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

  A new instance of SummaryShippingLabelForm.

• #subtype_to_hash ⇒ Object
• #to_json ⇒ Object

Methods inherited from ShippingLabelForm

from_json, #to_hash

Constructor Details

#initialize(incoming = {}) ⇒ SummaryShippingLabelForm

Returns a new instance of SummaryShippingLabelForm.

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

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.

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

def center_key
  @center_key
end

#items ⇒ Object (readonly)

Returns the value of attribute items.

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

def items
  @items
end

#order_number ⇒ Object (readonly)

Returns the value of attribute order_number.

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

def order_number
  @order_number
end

Instance Method Details

#copy(incoming = {}) ⇒ Object

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

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

#subtype_to_hash ⇒ Object

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

def subtype_to_hash
  {
    :order_number => order_number,
    :items => items.map { |o| o.to_hash },
    :center_key => center_key
  }
end

#to_json ⇒ Object

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

def to_json
  JSON.dump(to_hash)
end