Class: TalonOne::AddLoyaltyPoints

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

Overview

Points to add.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AddLoyaltyPoints

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/talon_one/models/add_loyalty_points.rb', line 78

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::AddLoyaltyPoints` 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::AddLoyaltyPoints`. 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?(:'points')
    self.points = attributes[:'points']
  end

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

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

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

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

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

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

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

Instance Attribute Details

#application_id ⇒ Object

ID of the Application that is connected to the loyalty program. It is displayed in your Talon.One deployment URL.



40
41
42
 
# File 'lib/talon_one/models/add_loyalty_points.rb', line 40

def application_id
  @application_id
end

#name ⇒ Object

Name / reason for the point addition.



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

def name
  @name
end

#pending_duration ⇒ Object

The amount of time before the points are considered valid. The time format is either: - ‘immediate` or, - an integer followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year.



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

def pending_duration
  @pending_duration
end

#pending_until ⇒ Object

Date and time after the points are considered valid. The value should be provided in RFC 3339 format. If passed, ‘pendingDuration` should be omitted.



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

def pending_until
  @pending_until
end

#points ⇒ Object

Amount of loyalty points.



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

def points
  @points
end

#subledger_id ⇒ Object

ID of the subledger the points are added to. If there is no existing subledger with this ID, the subledger is created automatically.



37
38
39
 
# File 'lib/talon_one/models/add_loyalty_points.rb', line 37

def subledger_id
  @subledger_id
end

#valid_until ⇒ Object

Date and time when points should expire. The value should be provided in RFC 3339 format. If passed, ‘validityDuration` should be omitted.



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

def valid_until
  @valid_until
end

#validity_duration ⇒ Object

The time format is either: - ‘immediate` or, - an integer followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. If passed, `validUntil` should be omitted.



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

def validity_duration
  @validity_duration
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/talon_one/models/add_loyalty_points.rb', line 43

def self.attribute_map
  {
    :'points' => :'points',
    :'name' => :'name',
    :'validity_duration' => :'validityDuration',
    :'valid_until' => :'validUntil',
    :'pending_duration' => :'pendingDuration',
    :'pending_until' => :'pendingUntil',
    :'subledger_id' => :'subledgerId',
    :'application_id' => :'applicationId'
  }
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



200
201
202
 
# File 'lib/talon_one/models/add_loyalty_points.rb', line 200

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



71
72
73
74
 
# File 'lib/talon_one/models/add_loyalty_points.rb', line 71

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

.openapi_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/talon_one/models/add_loyalty_points.rb', line 57

def self.openapi_types
  {
    :'points' => :'Float',
    :'name' => :'String',
    :'validity_duration' => :'String',
    :'valid_until' => :'DateTime',
    :'pending_duration' => :'String',
    :'pending_until' => :'DateTime',
    :'subledger_id' => :'String',
    :'application_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/talon_one/models/add_loyalty_points.rb', line 172

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      points == o.points &&
      name == o.name &&
      validity_duration == o.validity_duration &&
      valid_until == o.valid_until &&
      pending_duration == o.pending_duration &&
      pending_until == o.pending_until &&
      subledger_id == o.subledger_id &&
      application_id == o.application_id
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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/talon_one/models/add_loyalty_points.rb', line 228

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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/talon_one/models/add_loyalty_points.rb', line 297

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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/talon_one/models/add_loyalty_points.rb', line 207

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


187
188
189
 
# File 'lib/talon_one/models/add_loyalty_points.rb', line 187

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



193
194
195
 
# File 'lib/talon_one/models/add_loyalty_points.rb', line 193

def hash
  [points, name, validity_duration, valid_until, pending_duration, pending_until, subledger_id, application_id].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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/talon_one/models/add_loyalty_points.rb', line 126

def list_invalid_properties
  invalid_properties = Array.new
  if @points.nil?
    invalid_properties.push('invalid value for "points", points cannot be nil.')
  end

  if @points > 999999999999.99
    invalid_properties.push('invalid value for "points", must be smaller than or equal to 999999999999.99.')
  end

  if @points <= 0
    invalid_properties.push('invalid value for "points", must be greater than 0.')
  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



273
274
275
 
# File 'lib/talon_one/models/add_loyalty_points.rb', line 273

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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/talon_one/models/add_loyalty_points.rb', line 279

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



267
268
269
 
# File 'lib/talon_one/models/add_loyalty_points.rb', line 267

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
148
149
150
 
# File 'lib/talon_one/models/add_loyalty_points.rb', line 145

def valid?
  return false if @points.nil?
  return false if @points > 999999999999.99
  return false if @points <= 0
  true
end