Class: TalonOne::LedgerTransactionLogEntryIntegrationAPI
- Inherits:
-
Object
- Object
- TalonOne::LedgerTransactionLogEntryIntegrationAPI
- Defined in:
- lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb
Overview
Log entry for a given loyalty card transaction.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#amount ⇒ Object
Amount of loyalty points added or deducted in the transaction.
-
#created ⇒ Object
Date and time the loyalty transaction occurred.
-
#customer_session_id ⇒ Object
ID of the customer session where the transaction occurred.
-
#expiry_date ⇒ Object
Date when points expire.
-
#flags ⇒ Object
Returns the value of attribute flags.
-
#id ⇒ Object
ID of the loyalty ledger transaction.
-
#name ⇒ Object
Name or reason of the loyalty ledger transaction.
-
#program_id ⇒ Object
ID of the loyalty program.
-
#rule_name ⇒ Object
The name of the rule that triggered this effect.
-
#ruleset_id ⇒ Object
The ID of the ruleset containing the rule that triggered this effect.
-
#start_date ⇒ Object
When points become active.
-
#subledger_id ⇒ Object
ID of the subledger.
-
#type ⇒ Object
Type of transaction.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ LedgerTransactionLogEntryIntegrationAPI
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ LedgerTransactionLogEntryIntegrationAPI
Initializes the object
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 124 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::LedgerTransactionLogEntryIntegrationAPI` 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::LedgerTransactionLogEntryIntegrationAPI`. 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?(:'created') self.created = attributes[:'created'] end if attributes.key?(:'program_id') self.program_id = attributes[:'program_id'] end if attributes.key?(:'customer_session_id') self.customer_session_id = attributes[:'customer_session_id'] end if attributes.key?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'start_date') self.start_date = attributes[:'start_date'] end if attributes.key?(:'expiry_date') self.expiry_date = attributes[:'expiry_date'] end if attributes.key?(:'subledger_id') self.subledger_id = attributes[:'subledger_id'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] end if attributes.key?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'ruleset_id') self.ruleset_id = attributes[:'ruleset_id'] end if attributes.key?(:'rule_name') self.rule_name = attributes[:'rule_name'] end if attributes.key?(:'flags') self.flags = attributes[:'flags'] end end |
Instance Attribute Details
#amount ⇒ Object
Amount of loyalty points added or deducted in the transaction.
43 44 45 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 43 def amount @amount end |
#created ⇒ Object
Date and time the loyalty transaction occurred.
19 20 21 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 19 def created @created end |
#customer_session_id ⇒ Object
ID of the customer session where the transaction occurred.
25 26 27 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 25 def customer_session_id @customer_session_id end |
#expiry_date ⇒ Object
Date when points expire. Possible values are: - ‘unlimited`: Points have no expiration date. - `timestamp value`: Points expire on the given date.
37 38 39 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 37 def expiry_date @expiry_date end |
#flags ⇒ Object
Returns the value of attribute flags.
54 55 56 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 54 def flags @flags end |
#id ⇒ Object
ID of the loyalty ledger transaction.
46 47 48 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 46 def id @id end |
#name ⇒ Object
Name or reason of the loyalty ledger transaction.
31 32 33 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 31 def name @name end |
#program_id ⇒ Object
ID of the loyalty program.
22 23 24 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 22 def program_id @program_id end |
#rule_name ⇒ Object
The name of the rule that triggered this effect.
52 53 54 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 52 def rule_name @rule_name end |
#ruleset_id ⇒ Object
The ID of the ruleset containing the rule that triggered this effect.
49 50 51 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 49 def ruleset_id @ruleset_id end |
#start_date ⇒ Object
When points become active. Possible values: - ‘immediate`: Points are immediately active. - a timestamp value: Points become active at a given date and time.
34 35 36 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 34 def start_date @start_date end |
#subledger_id ⇒ Object
ID of the subledger.
40 41 42 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 40 def subledger_id @subledger_id end |
#type ⇒ Object
Type of transaction. Possible values: - ‘addition`: Signifies added points. - `subtraction`: Signifies deducted points.
28 29 30 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 28 def type @type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 79 def self.attribute_map { :'created' => :'created', :'program_id' => :'programId', :'customer_session_id' => :'customerSessionId', :'type' => :'type', :'name' => :'name', :'start_date' => :'startDate', :'expiry_date' => :'expiryDate', :'subledger_id' => :'subledgerId', :'amount' => :'amount', :'id' => :'id', :'ruleset_id' => :'rulesetId', :'rule_name' => :'ruleName', :'flags' => :'flags' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
372 373 374 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 372 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
117 118 119 120 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 117 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 98 def self.openapi_types { :'created' => :'DateTime', :'program_id' => :'Integer', :'customer_session_id' => :'String', :'type' => :'String', :'name' => :'String', :'start_date' => :'String', :'expiry_date' => :'String', :'subledger_id' => :'String', :'amount' => :'Float', :'id' => :'Integer', :'ruleset_id' => :'Integer', :'rule_name' => :'String', :'flags' => :'LoyaltyLedgerEntryFlags' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 339 def ==(o) return true if self.equal?(o) self.class == o.class && created == o.created && program_id == o.program_id && customer_session_id == o.customer_session_id && type == o.type && name == o.name && start_date == o.start_date && expiry_date == o.expiry_date && subledger_id == o.subledger_id && amount == o.amount && id == o.id && ruleset_id == o.ruleset_id && rule_name == o.rule_name && flags == o.flags end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 400 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
469 470 471 472 473 474 475 476 477 478 479 480 481 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 469 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
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 379 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
359 360 361 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 359 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
365 366 367 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 365 def hash [created, program_id, customer_session_id, type, name, start_date, expiry_date, subledger_id, amount, id, ruleset_id, rule_name, flags].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 192 def list_invalid_properties invalid_properties = Array.new if @created.nil? invalid_properties.push('invalid value for "created", created cannot be nil.') end if @program_id.nil? invalid_properties.push('invalid value for "program_id", program_id cannot be nil.') end if !@customer_session_id.nil? && @customer_session_id.to_s.length > 255 invalid_properties.push('invalid value for "customer_session_id", the character length must be smaller than or equal to 255.') end if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @type.to_s.length > 255 invalid_properties.push('invalid value for "type", the character length must be smaller than or equal to 255.') end if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @name.to_s.length > 255 invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.') end if @start_date.nil? invalid_properties.push('invalid value for "start_date", start_date cannot be nil.') end if @start_date.to_s.length > 64 invalid_properties.push('invalid value for "start_date", the character length must be smaller than or equal to 64.') end if @expiry_date.nil? invalid_properties.push('invalid value for "expiry_date", expiry_date cannot be nil.') end if @subledger_id.nil? invalid_properties.push('invalid value for "subledger_id", subledger_id cannot be nil.') end if @subledger_id.to_s.length > 64 invalid_properties.push('invalid value for "subledger_id", the character length must be smaller than or equal to 64.') end if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
445 446 447 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 445 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
451 452 453 454 455 456 457 458 459 460 461 462 463 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 451 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
439 440 441 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 439 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/talon_one/models/ledger_transaction_log_entry_integration_api.rb', line 255 def valid? return false if @created.nil? return false if @program_id.nil? return false if !@customer_session_id.nil? && @customer_session_id.to_s.length > 255 return false if @type.nil? type_validator = EnumAttributeValidator.new('String', ["addition", "subtraction"]) return false unless type_validator.valid?(@type) return false if @type.to_s.length > 255 return false if @name.nil? return false if @name.to_s.length > 255 return false if @start_date.nil? return false if @start_date.to_s.length > 64 return false if @expiry_date.nil? return false if @subledger_id.nil? return false if @subledger_id.to_s.length > 64 return false if @amount.nil? return false if @id.nil? true end |