Class: AftershipAPI::Model::TrackingAftershipEstimatedDeliveryDate

Inherits:
Object
  • Object
show all
Defined in:
lib/aftership-tracking-sdk/models/tracking_aftership_estimated_delivery_date.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TrackingAftershipEstimatedDeliveryDate

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/aftership-tracking-sdk/models/tracking_aftership_estimated_delivery_date.rb', line 23

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AftershipAPI::TrackingAftershipEstimatedDeliveryDate` initialize method"
  end

  attributes = attributes.each_with_object({}) { |(k, v), h|
    h[k.to_sym] = v
  }

  if attributes.key?(:'estimated_delivery_date')
    self.estimated_delivery_date = attributes[:'estimated_delivery_date']
  end

  if attributes.key?(:'confidence_code')
    self.confidence_code = attributes[:'confidence_code']
  end

  if attributes.key?(:'estimated_delivery_date_min')
    self.estimated_delivery_date_min = attributes[:'estimated_delivery_date_min']
  end

  if attributes.key?(:'estimated_delivery_date_max')
    self.estimated_delivery_date_max = attributes[:'estimated_delivery_date_max']
  end
end

Instance Attribute Details

#confidence_code ⇒ Object

Indicates the confidence level and associated reason for an AI EDD prediction request. For a comprehensive list of confidence codes, refer to . confidence_code?: Float;



11
12
13
 
# File 'lib/aftership-tracking-sdk/models/tracking_aftership_estimated_delivery_date.rb', line 11

def confidence_code
  @confidence_code
end

#estimated_delivery_date ⇒ Object

The estimated arrival date of the shipment. estimated_delivery_date?: String;



7
8
9
 
# File 'lib/aftership-tracking-sdk/models/tracking_aftership_estimated_delivery_date.rb', line 7

def estimated_delivery_date
  @estimated_delivery_date
end

#estimated_delivery_date_max ⇒ Object

Latest estimated delivery date of the shipment. estimated_delivery_date_max?: String;



19
20
21
 
# File 'lib/aftership-tracking-sdk/models/tracking_aftership_estimated_delivery_date.rb', line 19

def estimated_delivery_date_max
  @estimated_delivery_date_max
end

#estimated_delivery_date_min ⇒ Object

Earliest estimated delivery date of the shipment. estimated_delivery_date_min?: String;



15
16
17
 
# File 'lib/aftership-tracking-sdk/models/tracking_aftership_estimated_delivery_date.rb', line 15

def estimated_delivery_date_min
  @estimated_delivery_date_min
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type (String) —

    Data type

  • value (String) —

    Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/aftership-tracking-sdk/models/tracking_aftership_estimated_delivery_date.rb', line 96

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    klass = AftershipAPI::Model.const_get(type)
    klass.build_from_hash(value)
  end
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



60
61
62
63
64
65
66
67
 
# File 'lib/aftership-tracking-sdk/models/tracking_aftership_estimated_delivery_date.rb', line 60

def self.attribute_map
  {
    :'estimated_delivery_date' => :'estimated_delivery_date',
    :'confidence_code' => :'confidence_code',
    :'estimated_delivery_date_min' => :'estimated_delivery_date_min',
    :'estimated_delivery_date_max' => :'estimated_delivery_date_max',
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/aftership-tracking-sdk/models/tracking_aftership_estimated_delivery_date.rb', line 72

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(key) && attributes[key].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[key].is_a?(Array)
        transformed_hash["#{key}"] = attributes[key].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[key].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[key])
    end
  end
  new(transformed_hash)
end

.openapi_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
 
# File 'lib/aftership-tracking-sdk/models/tracking_aftership_estimated_delivery_date.rb', line 50

def self.openapi_types
  {
    :'estimated_delivery_date' => :'String',
    :'confidence_code' => :'Float',
    :'estimated_delivery_date_min' => :'String',
    :'estimated_delivery_date_max' => :'String',
  }
end

Instance Method Details

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/aftership-tracking-sdk/models/tracking_aftership_estimated_delivery_date.rb', line 163

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



142
143
144
 
# File 'lib/aftership-tracking-sdk/models/tracking_aftership_estimated_delivery_date.rb', line 142

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



148
149
150
151
152
153
154
155
156
157
 
# File 'lib/aftership-tracking-sdk/models/tracking_aftership_estimated_delivery_date.rb', line 148

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?

    hash[param] = _to_hash(value)
  end
  hash
end

#to_json(*a) ⇒ Object 



177
178
179
 
# File 'lib/aftership-tracking-sdk/models/tracking_aftership_estimated_delivery_date.rb', line 177

def to_json(*a)
  to_hash.to_json(*a)
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



136
137
138
 
# File 'lib/aftership-tracking-sdk/models/tracking_aftership_estimated_delivery_date.rb', line 136

def to_s
  to_hash.to_s
end