Class: Io::Flow::V0::Models::Delivery

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

Overview

A delivery represents a group of items that will be delivered together - presenting a single price and delivery time frame, where applicable, to the user. Deliveries commonly are created based on the type of item and, for physical goods, their center of origin

Defined Under Namespace

Modules: Types

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ Delivery

Returns a new instance of Delivery.



4900
4901
4902
4903
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4900

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

Instance Attribute Details

#discriminatorObject (readonly)

Returns the value of attribute discriminator.



4898
4899
4900
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4898

def discriminator
  @discriminator
end

Class Method Details

.from_json(hash) ⇒ Object



4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4913

def Delivery.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[delivery] requires a field named 'discriminator'"
  end
  case discriminator
    when Types::DIGITAL_DELIVERY; DigitalDelivery.new(hash)
    when Types::PHYSICAL_DELIVERY; PhysicalDelivery.new(hash)
    else DeliveryUndefinedType.new(:discriminator => discriminator)
  end
end

Instance Method Details

#subtype_to_hashObject



4905
4906
4907
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4905

def subtype_to_hash
  raise 'Cannot serialize an instance of delivery directly - must use one of the specific types: digital_delivery, physical_delivery'
end

#to_hashObject



4909
4910
4911
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4909

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