Class: Io::Flow::V0::Models::LabelUpserted

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

Instance Attribute Summary collapse

Attributes inherited from Event

#discriminator

Instance Method Summary collapse

Methods inherited from Event

from_json, #to_hash

Constructor Details

#initialize(incoming = {}) ⇒ LabelUpserted

Returns a new instance of LabelUpserted.



33116
33117
33118
33119
33120
33121
33122
33123
33124
33125
33126
33127
33128
33129
33130
33131
33132
33133
33134
33135
33136
33137
33138
33139
33140
33141
33142
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33116

def initialize(incoming={})
  super(:discriminator => Event::Types::LABEL_UPSERTED)
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:event_id, :timestamp, :organization, :label_id, :carrier_tracking_number, :commercial_invoice, :flow_tracking_number, :destination, :origin, :carrier, :service], 'LabelUpserted')
  @event_id = HttpClient::Preconditions.assert_class('event_id', opts.delete(:event_id), String)
  @timestamp = HttpClient::Preconditions.assert_class('timestamp', HttpClient::Helper.to_date_time_iso8601(opts.delete(:timestamp)), DateTime)
  @organization = HttpClient::Preconditions.assert_class('organization', opts.delete(:organization), String)
  @label_id = HttpClient::Preconditions.assert_class('label_id', opts.delete(:label_id), String)
  @carrier_tracking_number = HttpClient::Preconditions.assert_class('carrier_tracking_number', opts.delete(:carrier_tracking_number), String)
  @commercial_invoice = HttpClient::Preconditions.assert_class('commercial_invoice', opts.delete(:commercial_invoice), String)
  @flow_tracking_number = HttpClient::Preconditions.assert_class('flow_tracking_number', opts.delete(:flow_tracking_number), String)
  @destination = (x = opts.delete(:destination); x.is_a?(::Io::Flow::V0::Models::ShippingAddress) ? x : ::Io::Flow::V0::Models::ShippingAddress.new(x))
  @origin = (x = opts.delete(:origin); x.is_a?(::Io::Flow::V0::Models::ShippingAddress) ? x : ::Io::Flow::V0::Models::ShippingAddress.new(x))
  @carrier = HttpClient::Preconditions.assert_class('carrier', opts.delete(:carrier), String)
  @service = HttpClient::Preconditions.assert_class('service', opts.delete(:service), String)
  @zpl = (x = opts.delete(:zpl); x.nil? ? nil : HttpClient::Preconditions.assert_class('zpl', x, String))
  @pdf = (x = opts.delete(:pdf); x.nil? ? nil : HttpClient::Preconditions.assert_class('pdf', x, String))
  @png = (x = opts.delete(:png); x.nil? ? nil : HttpClient::Preconditions.assert_class('png', x, String))
  @order = (x = opts.delete(:order); x.nil? ? nil : HttpClient::Preconditions.assert_class('order', x, String))
  @carrier_tracking_number_url = (x = opts.delete(:carrier_tracking_number_url); x.nil? ? nil : HttpClient::Preconditions.assert_class('carrier_tracking_number_url', x, String))
  @flow_tracking_number_url = (x = opts.delete(:flow_tracking_number_url); x.nil? ? nil : HttpClient::Preconditions.assert_class('flow_tracking_number_url', x, String))
  @center_key = (x = opts.delete(:center_key); x.nil? ? nil : HttpClient::Preconditions.assert_class('center_key', x, String))
  @recipient = (x = opts.delete(:recipient); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::ShipmentRecipient) ? x : ::Io::Flow::V0::Models::ShipmentRecipient.apply(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))
end

Instance Attribute Details

#carrier ⇒ Object (readonly)

Returns the value of attribute carrier.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def carrier
  @carrier
end

#carrier_tracking_number ⇒ Object (readonly)

Returns the value of attribute carrier_tracking_number.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def carrier_tracking_number
  @carrier_tracking_number
end

#carrier_tracking_number_url ⇒ Object (readonly)

Returns the value of attribute carrier_tracking_number_url.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def carrier_tracking_number_url
  @carrier_tracking_number_url
end

#center_key ⇒ Object (readonly)

Returns the value of attribute center_key.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def center_key
  @center_key
end

#commercial_invoice ⇒ Object (readonly)

Returns the value of attribute commercial_invoice.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def commercial_invoice
  @commercial_invoice
end

#destination ⇒ Object (readonly)

Returns the value of attribute destination.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def destination
  @destination
end

#event_id ⇒ Object (readonly)

Returns the value of attribute event_id.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def event_id
  @event_id
end

#flow_tracking_number ⇒ Object (readonly)

Returns the value of attribute flow_tracking_number.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def flow_tracking_number
  @flow_tracking_number
end

#flow_tracking_number_url ⇒ Object (readonly)

Returns the value of attribute flow_tracking_number_url.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def flow_tracking_number_url
  @flow_tracking_number_url
end

#fulfillment_key ⇒ Object (readonly)

Returns the value of attribute fulfillment_key.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def fulfillment_key
  @fulfillment_key
end

#label_id ⇒ Object (readonly)

Returns the value of attribute label_id.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def label_id
  @label_id
end

#order ⇒ Object (readonly)

Returns the value of attribute order.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def order
  @order
end

#order_identifier ⇒ Object (readonly)

Returns the value of attribute order_identifier.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def order_identifier
  @order_identifier
end

#organization ⇒ Object (readonly)

Returns the value of attribute organization.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def organization
  @organization
end

#origin ⇒ Object (readonly)

Returns the value of attribute origin.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def origin
  @origin
end

#package ⇒ Object (readonly)

Returns the value of attribute package.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def package
  @package
end

#pdf ⇒ Object (readonly)

Returns the value of attribute pdf.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def pdf
  @pdf
end

#png ⇒ Object (readonly)

Returns the value of attribute png.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def png
  @png
end

#recipient ⇒ Object (readonly)

Returns the value of attribute recipient.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def recipient
  @recipient
end

#service ⇒ Object (readonly)

Returns the value of attribute service.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def service
  @service
end

#timestamp ⇒ Object (readonly)

Returns the value of attribute timestamp.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def timestamp
  @timestamp
end

#zpl ⇒ Object (readonly)

Returns the value of attribute zpl.



33114
33115
33116
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33114

def zpl
  @zpl
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



33148
33149
33150
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33148

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

#subtype_to_hash ⇒ Object 



33152
33153
33154
33155
33156
33157
33158
33159
33160
33161
33162
33163
33164
33165
33166
33167
33168
33169
33170
33171
33172
33173
33174
33175
33176
33177
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33152

def subtype_to_hash
  {
    :event_id => event_id,
    :timestamp => timestamp,
    :organization => organization,
    :label_id => label_id,
    :carrier_tracking_number => carrier_tracking_number,
    :commercial_invoice => commercial_invoice,
    :flow_tracking_number => flow_tracking_number,
    :destination => destination.to_hash,
    :origin => origin.to_hash,
    :carrier => carrier,
    :service => service,
    :zpl => zpl,
    :pdf => pdf,
    :png => png,
    :order => order,
    :carrier_tracking_number_url => carrier_tracking_number_url,
    :flow_tracking_number_url => flow_tracking_number_url,
    :center_key => center_key,
    :recipient => recipient.nil? ? nil : recipient.value,
    :package => package.nil? ? nil : package.to_hash,
    :order_identifier => order_identifier,
    :fulfillment_key => fulfillment_key
  }
end

#to_json ⇒ Object 



33144
33145
33146
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 33144

def to_json
  JSON.dump(to_hash)
end