Class: TalonOne::ExtendLoyaltyPointsExpiryDateEffectProps

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

Overview

The properties specific to the "extendLoyaltyPointsExpiryDate" effect. This gets triggered when a validated rule contains the "extend expiry date" effect. The current expiry date gets extended by the time frame given in the effect.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExtendLoyaltyPointsExpiryDateEffectProps

Initializes the object

Parameters:

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

    Model attributes in the form of hash



63
64
65
66
67
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
 
# File 'lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb', line 63

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

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

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

  if attributes.key?(:'transaction_uui_ds')
    if (value = attributes[:'transaction_uui_ds']).is_a?(Array)
      self.transaction_uui_ds = value
    end
  end

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

Instance Attribute Details

#extension_duration ⇒ Object

Time frame by which the expiry date extends. The time format is either: - immediate, or - an integer followed by a 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.



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

def extension_duration
  @extension_duration
end

#previous_expiration_date ⇒ Object

Expiry date before applying the extension.



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

def previous_expiration_date
  @previous_expiration_date
end

#program_id ⇒ Object

ID of the loyalty program that contains these points.



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

def program_id
  @program_id
end

#sub_ledger_id ⇒ Object

API name of the loyalty program subledger that contains these points. added.



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

def sub_ledger_id
  @sub_ledger_id
end

#transaction_uui_ds ⇒ Object

The list of identifiers of transactions affected affected by the extension.



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

def transaction_uui_ds
  @transaction_uui_ds
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb', line 34

def self.attribute_map
  {
    :'program_id' => :'programId',
    :'sub_ledger_id' => :'subLedgerId',
    :'extension_duration' => :'extensionDuration',
    :'transaction_uui_ds' => :'transactionUUIDs',
    :'previous_expiration_date' => :'previousExpirationDate'
  }
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



159
160
161
 
# File 'lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb', line 159

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



56
57
58
59
 
# File 'lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb', line 56

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'program_id' => :'Integer',
    :'sub_ledger_id' => :'String',
    :'extension_duration' => :'String',
    :'transaction_uui_ds' => :'Array<String>',
    :'previous_expiration_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



134
135
136
137
138
139
140
141
142
 
# File 'lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb', line 134

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      program_id == o.program_id &&
      sub_ledger_id == o.sub_ledger_id &&
      extension_duration == o.extension_duration &&
      transaction_uui_ds == o.transaction_uui_ds &&
      previous_expiration_date == o.previous_expiration_date
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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb', line 187

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



256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb', line 256

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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb', line 166

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


146
147
148
 
# File 'lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb', line 146

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



152
153
154
 
# File 'lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb', line 152

def hash
  [program_id, sub_ledger_id, extension_duration, transaction_uui_ds, previous_expiration_date].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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb', line 101

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

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

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

  if @previous_expiration_date.nil?
    invalid_properties.push('invalid value for "previous_expiration_date", previous_expiration_date 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



232
233
234
 
# File 'lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb', line 232

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



238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb', line 238

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



226
227
228
 
# File 'lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb', line 226

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



124
125
126
127
128
129
130
 
# File 'lib/talon_one/models/extend_loyalty_points_expiry_date_effect_props.rb', line 124

def valid?
  return false if @program_id.nil?
  return false if @sub_ledger_id.nil?
  return false if @extension_duration.nil?
  return false if @previous_expiration_date.nil?
  true
end