Class: UltracartClient::OrderTrackingNumberDetail

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/order_tracking_number_detail.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderTrackingNumberDetail

Initializes the object

Parameters:

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

    Model attributes in the form of hash



81
82
83
84
85
86
87
88
89
90
91
92
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
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 81

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'city')
    self.city = attributes[:'city']
  end

  if attributes.has_key?(:'event_dts')
    self.event_dts = attributes[:'event_dts']
  end

  if attributes.has_key?(:'event_local_date')
    self.event_local_date = attributes[:'event_local_date']
  end

  if attributes.has_key?(:'event_local_time')
    self.event_local_time = attributes[:'event_local_time']
  end

  if attributes.has_key?(:'event_timezone_id')
    self.event_timezone_id = attributes[:'event_timezone_id']
  end

  if attributes.has_key?(:'state')
    self.state = attributes[:'state']
  end

  if attributes.has_key?(:'subtag')
    self.subtag = attributes[:'subtag']
  end

  if attributes.has_key?(:'subtag_message')
    self.subtag_message = attributes[:'subtag_message']
  end

  if attributes.has_key?(:'tag')
    self.tag = attributes[:'tag']
  end

  if attributes.has_key?(:'tag_description')
    self.tag_description = attributes[:'tag_description']
  end

  if attributes.has_key?(:'tag_icon')
    self.tag_icon = attributes[:'tag_icon']
  end

  if attributes.has_key?(:'zip')
    self.zip = attributes[:'zip']
  end
end

Instance Attribute Details

#city ⇒ Object

Returns the value of attribute city.



17
18
19
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 17

def city
  @city
end

#event_dts ⇒ Object

ISO 8601 timestamp that the event occurred



20
21
22
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 20

def event_dts
  @event_dts
end

#event_local_date ⇒ Object

Returns the value of attribute event_local_date.



22
23
24
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 22

def event_local_date
  @event_local_date
end

#event_local_time ⇒ Object

Returns the value of attribute event_local_time.



24
25
26
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 24

def event_local_time
  @event_local_time
end

#event_timezone_id ⇒ Object

Timezone the event occurred in. Use this in conjunction with event_dts to format a local date/time.



27
28
29
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 27

def event_timezone_id
  @event_timezone_id
end

#state ⇒ Object

Returns the value of attribute state.



29
30
31
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 29

def state
  @state
end

#subtag ⇒ Object

Returns the value of attribute subtag.



31
32
33
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 31

def subtag
  @subtag
end

#subtag_message ⇒ Object

Returns the value of attribute subtag_message.



33
34
35
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 33

def subtag_message
  @subtag_message
end

#tag ⇒ Object

Returns the value of attribute tag.



35
36
37
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 35

def tag
  @tag
end

#tag_description ⇒ Object

Returns the value of attribute tag_description.



37
38
39
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 37

def tag_description
  @tag_description
end

#tag_icon ⇒ Object

Returns the value of attribute tag_icon.



39
40
41
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 39

def tag_icon
  @tag_icon
end

#zip ⇒ Object

Returns the value of attribute zip.



41
42
43
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 41

def zip
  @zip
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 44

def self.attribute_map
  {
    :'city' => :'city',
    :'event_dts' => :'event_dts',
    :'event_local_date' => :'event_local_date',
    :'event_local_time' => :'event_local_time',
    :'event_timezone_id' => :'event_timezone_id',
    :'state' => :'state',
    :'subtag' => :'subtag',
    :'subtag_message' => :'subtag_message',
    :'tag' => :'tag',
    :'tag_description' => :'tag_description',
    :'tag_icon' => :'tag_icon',
    :'zip' => :'zip'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 62

def self.swagger_types
  {
    :'city' => :'String',
    :'event_dts' => :'String',
    :'event_local_date' => :'String',
    :'event_local_time' => :'String',
    :'event_timezone_id' => :'String',
    :'state' => :'String',
    :'subtag' => :'String',
    :'subtag_message' => :'String',
    :'tag' => :'String',
    :'tag_description' => :'String',
    :'tag_icon' => :'String',
    :'zip' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 151

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      city == o.city &&
      event_dts == o.event_dts &&
      event_local_date == o.event_local_date &&
      event_local_time == o.event_local_time &&
      event_timezone_id == o.event_timezone_id &&
      state == o.state &&
      subtag == o.subtag &&
      subtag_message == o.subtag_message &&
      tag == o.tag &&
      tag_description == o.tag_description &&
      tag_icon == o.tag_icon &&
      zip == o.zip
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 204

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = UltracartClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_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



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 270

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

#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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 183

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


170
171
172
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 170

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



176
177
178
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 176

def hash
  [city, event_dts, event_local_date, event_local_time, event_timezone_id, state, subtag, subtag_message, tag, tag_description, tag_icon, zip].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



138
139
140
141
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 138

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



250
251
252
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 250

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



256
257
258
259
260
261
262
263
264
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 256

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



244
245
246
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 244

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



145
146
147
 
# File 'lib/ultracart_api/models/order_tracking_number_detail.rb', line 145

def valid?
  true
end