Class: Io::Flow::V0::Models::ShippingNotificationForm

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

Overview

Form for information about a client-facilitated shipment where the shipping label and fulfillment was not handled by Flow. For merchant-of-record and tracking purposes, clients doing their own shipping will need to notify Flow of shipped packages.

Defined Under Namespace

Modules: Types

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ ShippingNotificationForm

Returns a new instance of ShippingNotificationForm.



11582
11583
11584
11585
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11582

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

Instance Attribute Details

#discriminator ⇒ Object (readonly)

Returns the value of attribute discriminator.



11580
11581
11582
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11580

def discriminator
  @discriminator
end

Class Method Details

.from_json(hash) ⇒ Object 



11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11595

def ShippingNotificationForm.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_notification_form] requires a field named 'discriminator'"
  end
  case discriminator
    when Types::DETAILED_SHIPPING_NOTIFICATION_FORM; DetailedShippingNotificationForm.new(hash)
    when Types::SINGLE_PACKAGE_SHIPPING_NOTIFICATION_FORM; SinglePackageShippingNotificationForm.new(hash)
    else ShippingNotificationFormUndefinedType.new(:discriminator => discriminator)
  end
end

Instance Method Details

#subtype_to_hash ⇒ Object 



11587
11588
11589
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11587

def subtype_to_hash
  raise 'Cannot serialize an instance of shipping_notification_form directly - must use one of the specific types: detailed_shipping_notification_form, single_package_shipping_notification_form'
end

#to_hash ⇒ Object 



11591
11592
11593
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11591

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