Class: Io::Flow::V0::Models::ExportDelivery

Inherits:

Object

• Object
• Io::Flow::V0::Models::ExportDelivery

Defined in:

lib/flow_commerce/flow_api_v0_client.rb

Overview

Export deliveries represent actions to take once a requested export has completed. A common pattern would be to request delivery of the export via email - you will then receive an email notification once the requested export is ready

Direct Known Subclasses

ExportDeliveryEmail, ExportDeliveryUndefinedType

Defined Under Namespace

Modules: Types

Instance Attribute Summary

• #discriminator ⇒ Object readonly

  Returns the value of attribute discriminator.

Class Method Summary

• .from_json(hash) ⇒ Object

Instance Method Summary

• #initialize(incoming = {}) ⇒ ExportDelivery constructor

  A new instance of ExportDelivery.

• #subtype_to_hash ⇒ Object
• #to_hash ⇒ Object

Constructor Details

#initialize(incoming = {}) ⇒ ExportDelivery

Returns a new instance of ExportDelivery.

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

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:discriminator], 'ExportDelivery')
  @discriminator = HttpClient::Preconditions.assert_class('discriminator', opts.delete(:discriminator), String)
end

Instance Attribute Details

#discriminator ⇒ Object (readonly)

Returns the value of attribute discriminator.

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

def discriminator
  @discriminator
end

Class Method Details

.from_json(hash) ⇒ Object

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

def ExportDelivery.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[export_delivery] requires a field named 'discriminator'"
  end
  case discriminator
    when Types::EXPORT_DELIVERY_EMAIL; ExportDeliveryEmail.new(hash)
    else ExportDeliveryUndefinedType.new(:discriminator => discriminator)
  end
end

Instance Method Details

#subtype_to_hash ⇒ Object

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

def subtype_to_hash
  raise 'Cannot serialize an instance of export_delivery directly - must use one of the specific types: export_delivery_email'
end

#to_hash ⇒ Object

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

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