Class: TqlOtrFactoringDataExchange::LoadDetail

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/tql_otr_factoring_data_exchange/models/load_detail.rb

Overview

Basic details of a TQL load.

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(load_number: SKIP, pro_number: SKIP, bol_number: SKIP, status: SKIP, carrier: SKIP, ship_date: SKIP, delivery_date: SKIP, additional_properties: nil) ⇒ LoadDetail

Returns a new instance of LoadDetail.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/tql_otr_factoring_data_exchange/models/load_detail.rb', line 76

def initialize(load_number: SKIP, pro_number: SKIP, bol_number: SKIP,
               status: SKIP, carrier: SKIP, ship_date: SKIP,
               delivery_date: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @load_number = load_number unless load_number == SKIP
  @pro_number = pro_number unless pro_number == SKIP
  @bol_number = bol_number unless bol_number == SKIP
  @status = status unless status == SKIP
  @carrier = carrier unless carrier == SKIP
  @ship_date = ship_date unless ship_date == SKIP
  @delivery_date = delivery_date unless delivery_date == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#bol_number ⇒ String

Bill of Lading number, if available.

Returns:

  • (String) 


22
23
24
 
# File 'lib/tql_otr_factoring_data_exchange/models/load_detail.rb', line 22

def bol_number
  @bol_number
end

#carrier ⇒ Carrier2

Carrier assigned to this load.

Returns:



30
31
32
 
# File 'lib/tql_otr_factoring_data_exchange/models/load_detail.rb', line 30

def carrier
  @carrier
end

#delivery_date ⇒ Date

Date the load was (or is scheduled to be) delivered.

Returns:

  • (Date) 


38
39
40
 
# File 'lib/tql_otr_factoring_data_exchange/models/load_detail.rb', line 38

def delivery_date
  @delivery_date
end

#load_number ⇒ String

The TQL load number.

Returns:

  • (String) 


14
15
16
 
# File 'lib/tql_otr_factoring_data_exchange/models/load_detail.rb', line 14

def load_number
  @load_number
end

#pro_number ⇒ String

Carrier’s PRO (progressive) number, if available.

Returns:

  • (String) 


18
19
20
 
# File 'lib/tql_otr_factoring_data_exchange/models/load_detail.rb', line 18

def pro_number
  @pro_number
end

#ship_date ⇒ Date

Date the load was (or is scheduled to be) picked up.

Returns:

  • (Date) 


34
35
36
 
# File 'lib/tql_otr_factoring_data_exchange/models/load_detail.rb', line 34

def ship_date
  @ship_date
end

#status ⇒ LoadStatus

Current status of a TQL load.

Returns:



26
27
28
 
# File 'lib/tql_otr_factoring_data_exchange/models/load_detail.rb', line 26

def status
  @status
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/tql_otr_factoring_data_exchange/models/load_detail.rb', line 93

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  load_number = hash.key?('loadNumber') ? hash['loadNumber'] : SKIP
  pro_number = hash.key?('proNumber') ? hash['proNumber'] : SKIP
  bol_number = hash.key?('bolNumber') ? hash['bolNumber'] : SKIP
  status = hash.key?('status') ? hash['status'] : SKIP
  carrier = Carrier2.from_hash(hash['carrier']) if hash['carrier']
  ship_date = hash.key?('shipDate') ? hash['shipDate'] : SKIP
  delivery_date = hash.key?('deliveryDate') ? hash['deliveryDate'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  LoadDetail.new(load_number: load_number,
                 pro_number: pro_number,
                 bol_number: bol_number,
                 status: status,
                 carrier: carrier,
                 ship_date: ship_date,
                 delivery_date: delivery_date,
                 additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/tql_otr_factoring_data_exchange/models/load_detail.rb', line 41

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['load_number'] = 'loadNumber'
  @_hash['pro_number'] = 'proNumber'
  @_hash['bol_number'] = 'bolNumber'
  @_hash['status'] = 'status'
  @_hash['carrier'] = 'carrier'
  @_hash['ship_date'] = 'shipDate'
  @_hash['delivery_date'] = 'deliveryDate'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



67
68
69
70
71
72
73
74
 
# File 'lib/tql_otr_factoring_data_exchange/models/load_detail.rb', line 67

def self.nullables
  %w[
    pro_number
    bol_number
    ship_date
    delivery_date
  ]
end

.optionals ⇒ Object

An array for optional fields



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/tql_otr_factoring_data_exchange/models/load_detail.rb', line 54

def self.optionals
  %w[
    load_number
    pro_number
    bol_number
    status
    carrier
    ship_date
    delivery_date
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



132
133
134
135
136
137
138
 
# File 'lib/tql_otr_factoring_data_exchange/models/load_detail.rb', line 132

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} load_number: #{@load_number.inspect}, pro_number: #{@pro_number.inspect},"\
  " bol_number: #{@bol_number.inspect}, status: #{@status.inspect}, carrier:"\
  " #{@carrier.inspect}, ship_date: #{@ship_date.inspect}, delivery_date:"\
  " #{@delivery_date.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



124
125
126
127
128
129
 
# File 'lib/tql_otr_factoring_data_exchange/models/load_detail.rb', line 124

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} load_number: #{@load_number}, pro_number: #{@pro_number}, bol_number:"\
  " #{@bol_number}, status: #{@status}, carrier: #{@carrier}, ship_date: #{@ship_date},"\
  " delivery_date: #{@delivery_date}, additional_properties: #{@additional_properties}>"
end