Class: TalonOne::LoyaltyCard
- Inherits:
-
Object
- Object
- TalonOne::LoyaltyCard
- Defined in:
- lib/talon_one/models/loyalty_card.rb
Instance Attribute Summary collapse
-
#created ⇒ Object
The time this entity was created.
-
#id ⇒ Object
Internal ID of this entity.
-
#identifier ⇒ Object
The alphanumeric identifier of the loyalty card.
-
#ledger ⇒ Object
Returns the value of attribute ledger.
-
#modified ⇒ Object
Timestamp of the most recent update of the loyalty card.
-
#new_card_identifier ⇒ Object
The alphanumeric identifier of the loyalty card.
-
#old_card_identifier ⇒ Object
The alphanumeric identifier of the loyalty card.
-
#profiles ⇒ Object
Integration IDs of the customers profiles linked to the card.
-
#program_id ⇒ Object
The ID of the loyalty program that owns this entity.
-
#status ⇒ Object
Status of the loyalty card.
-
#subledgers ⇒ Object
Displays point balances of the card in the subledgers of the loyalty program.
-
#users_per_card_limit ⇒ Object
The max amount of customer profiles that can be linked to the card.
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 = {}) ⇒ LoyaltyCard
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 = {}) ⇒ LoyaltyCard
Initializes the object
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 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 |
# File 'lib/talon_one/models/loyalty_card.rb', line 97 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::LoyaltyCard` 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::LoyaltyCard`. 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?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'created') self.created = attributes[:'created'] end if attributes.key?(:'program_id') self.program_id = attributes[:'program_id'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'identifier') self.identifier = attributes[:'identifier'] end if attributes.key?(:'users_per_card_limit') self.users_per_card_limit = attributes[:'users_per_card_limit'] end if attributes.key?(:'profiles') if (value = attributes[:'profiles']).is_a?(Array) self.profiles = value end end if attributes.key?(:'ledger') self.ledger = attributes[:'ledger'] end if attributes.key?(:'subledgers') if (value = attributes[:'subledgers']).is_a?(Hash) self.subledgers = value end end if attributes.key?(:'modified') self.modified = attributes[:'modified'] end if attributes.key?(:'old_card_identifier') self.old_card_identifier = attributes[:'old_card_identifier'] end if attributes.key?(:'new_card_identifier') self.new_card_identifier = attributes[:'new_card_identifier'] end end |
Instance Attribute Details
#created ⇒ Object
The time this entity was created.
22 23 24 |
# File 'lib/talon_one/models/loyalty_card.rb', line 22 def created @created end |
#id ⇒ Object
Internal ID of this entity.
19 20 21 |
# File 'lib/talon_one/models/loyalty_card.rb', line 19 def id @id end |
#identifier ⇒ Object
The alphanumeric identifier of the loyalty card.
31 32 33 |
# File 'lib/talon_one/models/loyalty_card.rb', line 31 def identifier @identifier end |
#ledger ⇒ Object
Returns the value of attribute ledger.
39 40 41 |
# File 'lib/talon_one/models/loyalty_card.rb', line 39 def ledger @ledger end |
#modified ⇒ Object
Timestamp of the most recent update of the loyalty card.
45 46 47 |
# File 'lib/talon_one/models/loyalty_card.rb', line 45 def modified @modified end |
#new_card_identifier ⇒ Object
The alphanumeric identifier of the loyalty card.
51 52 53 |
# File 'lib/talon_one/models/loyalty_card.rb', line 51 def new_card_identifier @new_card_identifier end |
#old_card_identifier ⇒ Object
The alphanumeric identifier of the loyalty card.
48 49 50 |
# File 'lib/talon_one/models/loyalty_card.rb', line 48 def old_card_identifier @old_card_identifier end |
#profiles ⇒ Object
Integration IDs of the customers profiles linked to the card.
37 38 39 |
# File 'lib/talon_one/models/loyalty_card.rb', line 37 def profiles @profiles end |
#program_id ⇒ Object
The ID of the loyalty program that owns this entity.
25 26 27 |
# File 'lib/talon_one/models/loyalty_card.rb', line 25 def program_id @program_id end |
#status ⇒ Object
Status of the loyalty card. Can be one of: [‘active’, ‘inactive’]
28 29 30 |
# File 'lib/talon_one/models/loyalty_card.rb', line 28 def status @status end |
#subledgers ⇒ Object
Displays point balances of the card in the subledgers of the loyalty program.
42 43 44 |
# File 'lib/talon_one/models/loyalty_card.rb', line 42 def subledgers @subledgers end |
#users_per_card_limit ⇒ Object
The max amount of customer profiles that can be linked to the card. 0 means unlimited.
34 35 36 |
# File 'lib/talon_one/models/loyalty_card.rb', line 34 def users_per_card_limit @users_per_card_limit end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/talon_one/models/loyalty_card.rb', line 54 def self.attribute_map { :'id' => :'id', :'created' => :'created', :'program_id' => :'programID', :'status' => :'status', :'identifier' => :'identifier', :'users_per_card_limit' => :'usersPerCardLimit', :'profiles' => :'profiles', :'ledger' => :'ledger', :'subledgers' => :'subledgers', :'modified' => :'modified', :'old_card_identifier' => :'oldCardIdentifier', :'new_card_identifier' => :'newCardIdentifier' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
308 309 310 |
# File 'lib/talon_one/models/loyalty_card.rb', line 308 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
90 91 92 93 |
# File 'lib/talon_one/models/loyalty_card.rb', line 90 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/talon_one/models/loyalty_card.rb', line 72 def self.openapi_types { :'id' => :'Integer', :'created' => :'DateTime', :'program_id' => :'Integer', :'status' => :'String', :'identifier' => :'String', :'users_per_card_limit' => :'Integer', :'profiles' => :'Array<LoyaltyCardProfileRegistration>', :'ledger' => :'LedgerInfo', :'subledgers' => :'Hash<String, LedgerInfo>', :'modified' => :'DateTime', :'old_card_identifier' => :'String', :'new_card_identifier' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 |
# File 'lib/talon_one/models/loyalty_card.rb', line 276 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && created == o.created && program_id == o.program_id && status == o.status && identifier == o.identifier && users_per_card_limit == o.users_per_card_limit && profiles == o.profiles && ledger == o.ledger && subledgers == o.subledgers && modified == o.modified && old_card_identifier == o.old_card_identifier && new_card_identifier == o.new_card_identifier end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 |
# File 'lib/talon_one/models/loyalty_card.rb', line 336 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
405 406 407 408 409 410 411 412 413 414 415 416 417 |
# File 'lib/talon_one/models/loyalty_card.rb', line 405 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
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 |
# File 'lib/talon_one/models/loyalty_card.rb', line 315 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
295 296 297 |
# File 'lib/talon_one/models/loyalty_card.rb', line 295 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
301 302 303 |
# File 'lib/talon_one/models/loyalty_card.rb', line 301 def hash [id, created, program_id, status, identifier, users_per_card_limit, profiles, ledger, subledgers, modified, old_card_identifier, new_card_identifier].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 |
# File 'lib/talon_one/models/loyalty_card.rb', line 165 def list_invalid_properties invalid_properties = Array.new if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end 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 @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end if @identifier.nil? invalid_properties.push('invalid value for "identifier", identifier cannot be nil.') end if @identifier.to_s.length > 108 invalid_properties.push('invalid value for "identifier", the character length must be smaller than or equal to 108.') end if @users_per_card_limit.nil? invalid_properties.push('invalid value for "users_per_card_limit", users_per_card_limit cannot be nil.') end if @users_per_card_limit < 0 invalid_properties.push('invalid value for "users_per_card_limit", must be greater than or equal to 0.') end if !@old_card_identifier.nil? && @old_card_identifier.to_s.length > 108 invalid_properties.push('invalid value for "old_card_identifier", the character length must be smaller than or equal to 108.') end if !@new_card_identifier.nil? && @new_card_identifier.to_s.length > 108 invalid_properties.push('invalid value for "new_card_identifier", the character length must be smaller than or equal to 108.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
381 382 383 |
# File 'lib/talon_one/models/loyalty_card.rb', line 381 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
387 388 389 390 391 392 393 394 395 396 397 398 399 |
# File 'lib/talon_one/models/loyalty_card.rb', line 387 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
375 376 377 |
# File 'lib/talon_one/models/loyalty_card.rb', line 375 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
212 213 214 215 216 217 218 219 220 221 222 223 224 |
# File 'lib/talon_one/models/loyalty_card.rb', line 212 def valid? return false if @id.nil? return false if @created.nil? return false if @program_id.nil? return false if @status.nil? return false if @identifier.nil? return false if @identifier.to_s.length > 108 return false if @users_per_card_limit.nil? return false if @users_per_card_limit < 0 return false if !@old_card_identifier.nil? && @old_card_identifier.to_s.length > 108 return false if !@new_card_identifier.nil? && @new_card_identifier.to_s.length > 108 true end |