Class: Io::Flow::V0::Models::ShippingNotification

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

Overview

Represents 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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ ShippingNotification

Returns a new instance of ShippingNotification.



51092
51093
51094
51095
51096
51097
51098
51099
51100
51101
51102
51103
51104
51105
51106
51107
51108
51109
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 51092

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :key, :carrier_tracking_number, :destination, :flow_tracking_number, :origin, :package, :service, :window], 'ShippingNotification')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @key = HttpClient::Preconditions.assert_class('key', opts.delete(:key), String)
  @attributes = HttpClient::Preconditions.assert_class('attributes', (x = opts.delete(:attributes); x.nil? ? {} : x), Hash).inject({}) { |h, d| h[d[0]] = HttpClient::Preconditions.assert_class('attributes', d[1], String); h }
  @carrier_tracking_number = HttpClient::Preconditions.assert_class('carrier_tracking_number', opts.delete(:carrier_tracking_number), String)
  @destination = (x = opts.delete(:destination); x.is_a?(::Io::Flow::V0::Models::ShippingAddress) ? x : ::Io::Flow::V0::Models::ShippingAddress.new(x))
  @flow_tracking_number = HttpClient::Preconditions.assert_class('flow_tracking_number', opts.delete(:flow_tracking_number), String)
  @origin = (x = opts.delete(:origin); x.is_a?(::Io::Flow::V0::Models::ShippingAddress) ? x : ::Io::Flow::V0::Models::ShippingAddress.new(x))
  @package = (x = opts.delete(:package); x.is_a?(::Io::Flow::V0::Models::ShippingLabelPackage) ? x : ::Io::Flow::V0::Models::ShippingLabelPackage.new(x))
  @service = (x = opts.delete(:service); x.is_a?(::Io::Flow::V0::Models::ServiceSummary) ? x : ::Io::Flow::V0::Models::ServiceSummary.new(x))
  @window = (x = opts.delete(:window); x.is_a?(::Io::Flow::V0::Models::DatetimeRange) ? x : ::Io::Flow::V0::Models::DatetimeRange.new(x))
  @order = (x = opts.delete(:order); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::LabelOrderSummary) ? x : ::Io::Flow::V0::Models::LabelOrderSummary.new(x)))
  @order_identifier = (x = opts.delete(:order_identifier); x.nil? ? nil : HttpClient::Preconditions.assert_class('order_identifier', x, String))
  @fulfillment_key = (x = opts.delete(:fulfillment_key); x.nil? ? nil : HttpClient::Preconditions.assert_class('fulfillment_key', x, String))
  @shipment_recipient = (x = opts.delete(:shipment_recipient); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::ShipmentRecipient) ? x : ::Io::Flow::V0::Models::ShipmentRecipient.apply(x)))
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



51090
51091
51092
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 51090

def attributes
  @attributes
end

#carrier_tracking_number ⇒ Object (readonly)

Returns the value of attribute carrier_tracking_number.



51090
51091
51092
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 51090

def carrier_tracking_number
  @carrier_tracking_number
end

#destination ⇒ Object (readonly)

Returns the value of attribute destination.



51090
51091
51092
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 51090

def destination
  @destination
end

#flow_tracking_number ⇒ Object (readonly)

Returns the value of attribute flow_tracking_number.



51090
51091
51092
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 51090

def flow_tracking_number
  @flow_tracking_number
end

#fulfillment_key ⇒ Object (readonly)

Returns the value of attribute fulfillment_key.



51090
51091
51092
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 51090

def fulfillment_key
  @fulfillment_key
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



51090
51091
51092
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 51090

def id
  @id
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



51090
51091
51092
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 51090

def key
  @key
end

#order ⇒ Object (readonly)

Returns the value of attribute order.



51090
51091
51092
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 51090

def order
  @order
end

#order_identifier ⇒ Object (readonly)

Returns the value of attribute order_identifier.



51090
51091
51092
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 51090

def order_identifier
  @order_identifier
end

#origin ⇒ Object (readonly)

Returns the value of attribute origin.



51090
51091
51092
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 51090

def origin
  @origin
end

#package ⇒ Object (readonly)

Returns the value of attribute package.



51090
51091
51092
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 51090

def package
  @package
end

#service ⇒ Object (readonly)

Returns the value of attribute service.



51090
51091
51092
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 51090

def service
  @service
end

#shipment_recipient ⇒ Object (readonly)

Returns the value of attribute shipment_recipient.



51090
51091
51092
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 51090

def shipment_recipient
  @shipment_recipient
end

#window ⇒ Object (readonly)

Returns the value of attribute window.



51090
51091
51092
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 51090

def window
  @window
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



51115
51116
51117
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 51115

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

#to_hash ⇒ Object 



51119
51120
51121
51122
51123
51124
51125
51126
51127
51128
51129
51130
51131
51132
51133
51134
51135
51136
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 51119

def to_hash
  {
    :id => id,
    :key => key,
    :attributes => attributes,
    :carrier_tracking_number => carrier_tracking_number,
    :destination => destination.to_hash,
    :flow_tracking_number => flow_tracking_number,
    :origin => origin.to_hash,
    :package => package.to_hash,
    :service => service.to_hash,
    :window => window.to_hash,
    :order => order.nil? ? nil : order.to_hash,
    :order_identifier => order_identifier,
    :fulfillment_key => fulfillment_key,
    :shipment_recipient => shipment_recipient.nil? ? nil : shipment_recipient.value
  }
end

#to_json ⇒ Object 



51111
51112
51113
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 51111

def to_json
  JSON.dump(to_hash)
end