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.



11927
11928
11929
11930
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11927

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.



11925
11926
11927
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11925

def discriminator
  @discriminator
end

Class Method Details

.from_json(hash) ⇒ Object 



11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11940

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 



11932
11933
11934
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11932

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 



11936
11937
11938
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 11936

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