Class: Io::Flow::V0::Models::ShippingLabel

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

Overview

Represents information about a carrier-generated shipping label used by a shipper to transport a package from a given origin to destination

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ ShippingLabel

Returns a new instance of ShippingLabel.



30532
30533
30534
30535
30536
30537
30538
30539
30540
30541
30542
30543
30544
30545
30546
30547
30548
30549
30550
30551
30552
30553
30554
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30532

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :carrier_tracking_number, :carrier_tracking_number_url, :cost, :destination, :flow_tracking_number, :flow_tracking_number_url, :origin, :service, :window, :shipment_recipient], 'ShippingLabel')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), 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)
  @carrier_tracking_number_url = HttpClient::Preconditions.assert_class('carrier_tracking_number_url', opts.delete(:carrier_tracking_number_url), String)
  @cost = (x = opts.delete(:cost); x.is_a?(::Io::Flow::V0::Models::Price) ? x : ::Io::Flow::V0::Models::Price.new(x))
  @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)
  @flow_tracking_number_url = HttpClient::Preconditions.assert_class('flow_tracking_number_url', opts.delete(:flow_tracking_number_url), String)
  @origin = (x = opts.delete(:origin); x.is_a?(::Io::Flow::V0::Models::ShippingAddress) ? x : ::Io::Flow::V0::Models::ShippingAddress.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))
  @label = (x = opts.delete(:label); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::ShippingLabelDocument) ? x : ::Io::Flow::V0::Models::ShippingLabelDocument.new(x)))
  @invoice = (x = opts.delete(:invoice); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::ShippingLabelDocument) ? x : ::Io::Flow::V0::Models::ShippingLabelDocument.new(x)))
  @return_ = (x = opts.delete(:return); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::ShippingLabelDocument) ? x : ::Io::Flow::V0::Models::ShippingLabelDocument.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)))
  @package = (x = opts.delete(:package); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::ShippingLabelPackage) ? x : ::Io::Flow::V0::Models::ShippingLabelPackage.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.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.



30530
30531
30532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30530

def attributes
  @attributes
end

#carrier_tracking_number ⇒ Object (readonly)

Returns the value of attribute carrier_tracking_number.



30530
30531
30532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30530

def carrier_tracking_number
  @carrier_tracking_number
end

#carrier_tracking_number_url ⇒ Object (readonly)

Returns the value of attribute carrier_tracking_number_url.



30530
30531
30532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30530

def carrier_tracking_number_url
  @carrier_tracking_number_url
end

#cost ⇒ Object (readonly)

Returns the value of attribute cost.



30530
30531
30532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30530

def cost
  @cost
end

#destination ⇒ Object (readonly)

Returns the value of attribute destination.



30530
30531
30532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30530

def destination
  @destination
end

#flow_tracking_number ⇒ Object (readonly)

Returns the value of attribute flow_tracking_number.



30530
30531
30532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30530

def flow_tracking_number
  @flow_tracking_number
end

#flow_tracking_number_url ⇒ Object (readonly)

Returns the value of attribute flow_tracking_number_url.



30530
30531
30532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30530

def flow_tracking_number_url
  @flow_tracking_number_url
end

#fulfillment_key ⇒ Object (readonly)

Returns the value of attribute fulfillment_key.



30530
30531
30532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30530

def fulfillment_key
  @fulfillment_key
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



30530
30531
30532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30530

def id
  @id
end

#invoice ⇒ Object (readonly)

Returns the value of attribute invoice.



30530
30531
30532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30530

def invoice
  @invoice
end

#label ⇒ Object (readonly)

Returns the value of attribute label.



30530
30531
30532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30530

def label
  @label
end

#order ⇒ Object (readonly)

Returns the value of attribute order.



30530
30531
30532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30530

def order
  @order
end

#order_identifier ⇒ Object (readonly)

Returns the value of attribute order_identifier.



30530
30531
30532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30530

def order_identifier
  @order_identifier
end

#origin ⇒ Object (readonly)

Returns the value of attribute origin.



30530
30531
30532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30530

def origin
  @origin
end

#package ⇒ Object (readonly)

Returns the value of attribute package.



30530
30531
30532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30530

def package
  @package
end

#return_ ⇒ Object (readonly)

Returns the value of attribute return_.



30530
30531
30532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30530

def return_
  @return_
end

#service ⇒ Object (readonly)

Returns the value of attribute service.



30530
30531
30532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30530

def service
  @service
end

#shipment_recipient ⇒ Object (readonly)

Returns the value of attribute shipment_recipient.



30530
30531
30532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30530

def shipment_recipient
  @shipment_recipient
end

#window ⇒ Object (readonly)

Returns the value of attribute window.



30530
30531
30532
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30530

def window
  @window
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



30560
30561
30562
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30560

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

#to_hash ⇒ Object 



30564
30565
30566
30567
30568
30569
30570
30571
30572
30573
30574
30575
30576
30577
30578
30579
30580
30581
30582
30583
30584
30585
30586
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30564

def to_hash
  {
    :id => id,
    :attributes => attributes,
    :carrier_tracking_number => carrier_tracking_number,
    :carrier_tracking_number_url => carrier_tracking_number_url,
    :cost => cost.to_hash,
    :destination => destination.to_hash,
    :flow_tracking_number => flow_tracking_number,
    :flow_tracking_number_url => flow_tracking_number_url,
    :origin => origin.to_hash,
    :service => service.to_hash,
    :window => window.to_hash,
    :label => label.nil? ? nil : label.to_hash,
    :invoice => invoice.nil? ? nil : invoice.to_hash,
    :return => return_.nil? ? nil : return_.to_hash,
    :order => order.nil? ? nil : order.to_hash,
    :package => package.nil? ? nil : package.to_hash,
    :order_identifier => order_identifier,
    :fulfillment_key => fulfillment_key,
    :shipment_recipient => shipment_recipient.value
  }
end

#to_json ⇒ Object 



30556
30557
30558
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 30556

def to_json
  JSON.dump(to_hash)
end