Class: Io::Flow::V0::Models::Manifest

Inherits:

Object

• Object
• Io::Flow::V0::Models::Manifest

Defined in:

lib/flow_commerce/flow_api_v0_client.rb

Overview

Represents closeout of a group of labels that have been transfered to the carrier for shipping

Instance Attribute Summary

• #id ⇒ Object readonly

  Returns the value of attribute id.

• #pdf ⇒ Object readonly

  Returns the value of attribute pdf.

• #service ⇒ Object readonly

  Returns the value of attribute service.

• #shipping_labels ⇒ Object readonly

  Returns the value of attribute shipping_labels.

• #timestamp ⇒ Object readonly

  Returns the value of attribute timestamp.

• #type ⇒ Object readonly

  Returns the value of attribute type.

Instance Method Summary

• #copy(incoming = {}) ⇒ Object
• #initialize(incoming = {}) ⇒ Manifest constructor

  A new instance of Manifest.

• #to_hash ⇒ Object
• #to_json ⇒ Object

Constructor Details

#initialize(incoming = {}) ⇒ Manifest

Returns a new instance of Manifest.

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

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :type, :timestamp, :shipping_labels], 'Manifest')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @type = (x = opts.delete(:type); x.is_a?(::Io::Flow::V0::Models::ManifestType) ? x : ::Io::Flow::V0::Models::ManifestType.apply(x))
  @timestamp = HttpClient::Preconditions.assert_class('timestamp', HttpClient::Helper.to_date_time_iso8601(opts.delete(:timestamp)), DateTime)
  @shipping_labels = HttpClient::Preconditions.assert_class('shipping_labels', opts.delete(:shipping_labels), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::ShippingLabelSummary) ? x : ::Io::Flow::V0::Models::ShippingLabelSummary.new(x)) }
  @pdf = (x = opts.delete(:pdf); x.nil? ? nil : HttpClient::Preconditions.assert_class('pdf', x, String))
  @service = (x = opts.delete(:service); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::ServiceSummary) ? x : ::Io::Flow::V0::Models::ServiceSummary.new(x)))
end

Instance Attribute Details

#id ⇒ Object (readonly)

Returns the value of attribute id.

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

def id
  @id
end

#pdf ⇒ Object (readonly)

Returns the value of attribute pdf.

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

def pdf
  @pdf
end

#service ⇒ Object (readonly)

Returns the value of attribute service.

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

def service
  @service
end

#shipping_labels ⇒ Object (readonly)

Returns the value of attribute shipping_labels.

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

def shipping_labels
  @shipping_labels
end

#timestamp ⇒ Object (readonly)

Returns the value of attribute timestamp.

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

def timestamp
  @timestamp
end

#type ⇒ Object (readonly)

Returns the value of attribute type.

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

def type
  @type
end

Instance Method Details

#copy(incoming = {}) ⇒ Object

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

def copy(incoming={})
  Manifest.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
end

#to_hash ⇒ Object

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

def to_hash
  {
    :id => id,
    :type => type.value,
    :timestamp => timestamp,
    :shipping_labels => shipping_labels.map { |o| o.to_hash },
    :pdf => pdf,
    :service => service.nil? ? nil : service.to_hash
  }
end

#to_json ⇒ Object

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

def to_json
  JSON.dump(to_hash)
end