Class: Io::Flow::V0::Models::ShippingLabelForm

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

Overview

Different models for forms to create shipping labels

Defined Under Namespace

Modules: Types

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ ShippingLabelForm

Returns a new instance of ShippingLabelForm.



12018
12019
12020
12021
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12018

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  @discriminator = HttpClient::Preconditions.assert_class('discriminator', opts.delete(:discriminator) || 'detailed_shipping_label_form', String)
end

Instance Attribute Details

#discriminator ⇒ Object (readonly)

Returns the value of attribute discriminator.



12016
12017
12018
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12016

def discriminator
  @discriminator
end

Class Method Details

.from_json(hash) ⇒ Object 



12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12031

def ShippingLabelForm.from_json(hash)
  HttpClient::Preconditions.assert_class('hash', hash, Hash)
  discriminator = HttpClient::Helper.symbolize_keys(hash)[:discriminator].to_s.strip
  if discriminator.empty?
    raise "Union type[shipping_label_form] requires a field named 'discriminator'"
  end
  case discriminator
    when Types::DETAILED_SHIPPING_LABEL_FORM; DetailedShippingLabelForm.new(hash)
    when Types::SUMMARY_SHIPPING_LABEL_FORM; SummaryShippingLabelForm.new(hash)
    else ShippingLabelFormUndefinedType.new(:discriminator => discriminator)
  end
end

Instance Method Details

#subtype_to_hash ⇒ Object 



12023
12024
12025
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12023

def subtype_to_hash
  raise 'Cannot serialize an instance of shipping_label_form directly - must use one of the specific types: detailed_shipping_label_form, summary_shipping_label_form'
end

#to_hash ⇒ Object 



12027
12028
12029
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 12027

def to_hash
  subtype_to_hash.merge(:discriminator => @discriminator)
end