Class: TalonOne::TimePoint

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/time_point.rb

Overview

The absolute duration after which the achievement ends and resets for a particular customer profile. Note: The duration follows the time zone of the Application this achievement belongs to.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TimePoint

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/talon_one/models/time_point.rb', line 68

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

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::TimePoint`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

Instance Attribute Details

#day_of_month ⇒ Object

The achievement ends and resets on this day of the month. Note: Only applicable if the period is set to ‘Y` or `M`.



22
23
24
 
# File 'lib/talon_one/models/time_point.rb', line 22

def day_of_month
  @day_of_month
end

#day_of_week ⇒ Object

The achievement ends and resets on this day of the week. ‘1` represents `Monday` and `7` represents `Sunday`. Note: Only applicable if the period is set to `W`.



25
26
27
 
# File 'lib/talon_one/models/time_point.rb', line 25

def day_of_week
  @day_of_week
end

#hour ⇒ Object

The achievement ends and resets at this hour.



28
29
30
 
# File 'lib/talon_one/models/time_point.rb', line 28

def hour
  @hour
end

#minute ⇒ Object

The achievement ends and resets at this minute.



31
32
33
 
# File 'lib/talon_one/models/time_point.rb', line 31

def minute
  @minute
end

#month ⇒ Object

The achievement ends and resets in this month. Note: Only applicable if the period is set to ‘Y`.



19
20
21
 
# File 'lib/talon_one/models/time_point.rb', line 19

def month
  @month
end

#second ⇒ Object

The achievement ends and resets at this second.



34
35
36
 
# File 'lib/talon_one/models/time_point.rb', line 34

def second
  @second
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/talon_one/models/time_point.rb', line 37

def self.attribute_map
  {
    :'month' => :'month',
    :'day_of_month' => :'dayOfMonth',
    :'day_of_week' => :'dayOfWeek',
    :'hour' => :'hour',
    :'minute' => :'minute',
    :'second' => :'second'
  }
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



234
235
236
 
# File 'lib/talon_one/models/time_point.rb', line 234

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



61
62
63
64
 
# File 'lib/talon_one/models/time_point.rb', line 61

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/talon_one/models/time_point.rb', line 49

def self.openapi_types
  {
    :'month' => :'Integer',
    :'day_of_month' => :'Integer',
    :'day_of_week' => :'Integer',
    :'hour' => :'Integer',
    :'minute' => :'Integer',
    :'second' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



208
209
210
211
212
213
214
215
216
217
 
# File 'lib/talon_one/models/time_point.rb', line 208

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      month == o.month &&
      day_of_month == o.day_of_month &&
      day_of_week == o.day_of_week &&
      hour == o.hour &&
      minute == o.minute &&
      second == o.second
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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/talon_one/models/time_point.rb', line 262

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
    TalonOne.const_get(type).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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/talon_one/models/time_point.rb', line 331

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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/talon_one/models/time_point.rb', line 241

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


221
222
223
 
# File 'lib/talon_one/models/time_point.rb', line 221

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



227
228
229
 
# File 'lib/talon_one/models/time_point.rb', line 227

def hash
  [month, day_of_month, day_of_week, hour, minute, second].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



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
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/talon_one/models/time_point.rb', line 108

def list_invalid_properties
  invalid_properties = Array.new
  if !@month.nil? && @month > 12
    invalid_properties.push('invalid value for "month", must be smaller than or equal to 12.')
  end

  if !@month.nil? && @month < 1
    invalid_properties.push('invalid value for "month", must be greater than or equal to 1.')
  end

  if !@day_of_month.nil? && @day_of_month > 31
    invalid_properties.push('invalid value for "day_of_month", must be smaller than or equal to 31.')
  end

  if !@day_of_month.nil? && @day_of_month < 1
    invalid_properties.push('invalid value for "day_of_month", must be greater than or equal to 1.')
  end

  if !@day_of_week.nil? && @day_of_week > 7
    invalid_properties.push('invalid value for "day_of_week", must be smaller than or equal to 7.')
  end

  if !@day_of_week.nil? && @day_of_week < 1
    invalid_properties.push('invalid value for "day_of_week", must be greater than or equal to 1.')
  end

  if @hour.nil?
    invalid_properties.push('invalid value for "hour", hour cannot be nil.')
  end

  if @minute.nil?
    invalid_properties.push('invalid value for "minute", minute cannot be nil.')
  end

  if @second.nil?
    invalid_properties.push('invalid value for "second", second cannot be nil.')
  end

  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



307
308
309
 
# File 'lib/talon_one/models/time_point.rb', line 307

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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/talon_one/models/time_point.rb', line 313

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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



301
302
303
 
# File 'lib/talon_one/models/time_point.rb', line 301

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



151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/talon_one/models/time_point.rb', line 151

def valid?
  return false if !@month.nil? && @month > 12
  return false if !@month.nil? && @month < 1
  return false if !@day_of_month.nil? && @day_of_month > 31
  return false if !@day_of_month.nil? && @day_of_month < 1
  return false if !@day_of_week.nil? && @day_of_week > 7
  return false if !@day_of_week.nil? && @day_of_week < 1
  return false if @hour.nil?
  return false if @minute.nil?
  return false if @second.nil?
  true
end