Class: InventoryManagementAndItemManagementAndOrderManagementAndPriceManagement::TrackingInfo

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/inventory_management_and_item_management_and_order_management_and_price_management/models/tracking_info.rb

Overview

TrackingInfo Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(carrier_name = nil, method_code = nil, ship_date_time = nil, tracking_number = nil, tracking_url = nil) ⇒ TrackingInfo

Returns a new instance of TrackingInfo.



54
55
56
57
58
59
60
61
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/tracking_info.rb', line 54

def initialize(carrier_name = nil, method_code = nil, ship_date_time = nil,
               tracking_number = nil, tracking_url = nil)
  @carrier_name = carrier_name
  @method_code = method_code
  @ship_date_time = ship_date_time
  @tracking_number = tracking_number
  @tracking_url = tracking_url
end

Instance Attribute Details

#carrier_name ⇒ CarrierName

TODO: Write general description for this method

Returns:



15
16
17
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/tracking_info.rb', line 15

def carrier_name
  @carrier_name
end

#method_code ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


19
20
21
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/tracking_info.rb', line 19

def method_code
  @method_code
end

#ship_date_time ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


23
24
25
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/tracking_info.rb', line 23

def ship_date_time
  @ship_date_time
end

#tracking_number ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


27
28
29
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/tracking_info.rb', line 27

def tracking_number
  @tracking_number
end

#tracking_url ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


31
32
33
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/tracking_info.rb', line 31

def tracking_url
  @tracking_url
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/tracking_info.rb', line 64

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  carrier_name = CarrierName.from_hash(hash['carrierName']) if hash['carrierName']
  method_code = hash.key?('methodCode') ? hash['methodCode'] : nil
  ship_date_time = hash.key?('shipDateTime') ? hash['shipDateTime'] : nil
  tracking_number =
    hash.key?('trackingNumber') ? hash['trackingNumber'] : nil
  tracking_url = hash.key?('trackingURL') ? hash['trackingURL'] : nil

  # Create object from extracted values.
  TrackingInfo.new(carrier_name,
                   method_code,
                   ship_date_time,
                   tracking_number,
                   tracking_url)
end

.names ⇒ Object

A mapping from model property names to API property names.



34
35
36
37
38
39
40
41
42
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/tracking_info.rb', line 34

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['carrier_name'] = 'carrierName'
  @_hash['method_code'] = 'methodCode'
  @_hash['ship_date_time'] = 'shipDateTime'
  @_hash['tracking_number'] = 'trackingNumber'
  @_hash['tracking_url'] = 'trackingURL'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



50
51
52
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/tracking_info.rb', line 50

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



45
46
47
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/tracking_info.rb', line 45

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



92
93
94
95
96
97
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/tracking_info.rb', line 92

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} carrier_name: #{@carrier_name.inspect}, method_code:"\
  " #{@method_code.inspect}, ship_date_time: #{@ship_date_time.inspect}, tracking_number:"\
  " #{@tracking_number.inspect}, tracking_url: #{@tracking_url.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



84
85
86
87
88
89
 
# File 'lib/inventory_management_and_item_management_and_order_management_and_price_management/models/tracking_info.rb', line 84

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} carrier_name: #{@carrier_name}, method_code: #{@method_code},"\
  " ship_date_time: #{@ship_date_time}, tracking_number: #{@tracking_number}, tracking_url:"\
  " #{@tracking_url}>"
end