Class: TalonOne::LoyaltyProgram
- Inherits:
-
Object
- Object
- TalonOne::LoyaltyProgram
- Defined in:
- lib/talon_one/models/loyalty_program.rb
Overview
A Loyalty Program
Instance Attribute Summary collapse
-
#account_id ⇒ Object
The ID of the Talon.One account that owns this program.
-
#allow_subledger ⇒ Object
Indicates if this program supports subledgers inside the program.
-
#default_validity ⇒ Object
Indicates the default duration after which new loyalty points should expire.
-
#description ⇒ Object
Description of our Loyalty Program.
-
#id ⇒ Object
The ID of loyalty program.
-
#name ⇒ Object
The internal name for the Loyalty Program.
-
#subscribed_applications ⇒ Object
A list containing the IDs of all applications that are subscribed to this Loyalty Program.
-
#title ⇒ Object
The display title for the Loyalty Program.
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 = {}) ⇒ LoyaltyProgram
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 = {}) ⇒ LoyaltyProgram
Initializes the object
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 123 124 |
# File 'lib/talon_one/models/loyalty_program.rb', line 78 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::LoyaltyProgram` 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::LoyaltyProgram`. 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?(:'account_id') self.account_id = attributes[:'account_id'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'title') self.title = attributes[:'title'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'subscribed_applications') if (value = attributes[:'subscribed_applications']).is_a?(Array) self.subscribed_applications = value end end if attributes.key?(:'default_validity') self.default_validity = attributes[:'default_validity'] end if attributes.key?(:'allow_subledger') self.allow_subledger = attributes[:'allow_subledger'] end end |
Instance Attribute Details
#account_id ⇒ Object
The ID of the Talon.One account that owns this program.
22 23 24 |
# File 'lib/talon_one/models/loyalty_program.rb', line 22 def account_id @account_id end |
#allow_subledger ⇒ Object
Indicates if this program supports subledgers inside the program
40 41 42 |
# File 'lib/talon_one/models/loyalty_program.rb', line 40 def allow_subledger @allow_subledger end |
#default_validity ⇒ Object
Indicates the default duration after which new loyalty points should expire. The format is a number, followed by one letter indicating the unit; like ‘1h’ or ‘40m’ or ‘30d’.
37 38 39 |
# File 'lib/talon_one/models/loyalty_program.rb', line 37 def default_validity @default_validity end |
#description ⇒ Object
Description of our Loyalty Program.
31 32 33 |
# File 'lib/talon_one/models/loyalty_program.rb', line 31 def description @description end |
#id ⇒ Object
The ID of loyalty program.
19 20 21 |
# File 'lib/talon_one/models/loyalty_program.rb', line 19 def id @id end |
#name ⇒ Object
The internal name for the Loyalty Program.
25 26 27 |
# File 'lib/talon_one/models/loyalty_program.rb', line 25 def name @name end |
#subscribed_applications ⇒ Object
A list containing the IDs of all applications that are subscribed to this Loyalty Program.
34 35 36 |
# File 'lib/talon_one/models/loyalty_program.rb', line 34 def subscribed_applications @subscribed_applications end |
#title ⇒ Object
The display title for the Loyalty Program.
28 29 30 |
# File 'lib/talon_one/models/loyalty_program.rb', line 28 def title @title 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/loyalty_program.rb', line 43 def self.attribute_map { :'id' => :'id', :'account_id' => :'accountID', :'name' => :'name', :'title' => :'title', :'description' => :'description', :'subscribed_applications' => :'subscribedApplications', :'default_validity' => :'defaultValidity', :'allow_subledger' => :'allowSubledger' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
209 210 211 |
# File 'lib/talon_one/models/loyalty_program.rb', line 209 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/loyalty_program.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/loyalty_program.rb', line 57 def self.openapi_types { :'id' => :'Integer', :'account_id' => :'Integer', :'name' => :'String', :'title' => :'String', :'description' => :'String', :'subscribed_applications' => :'Array<Integer>', :'default_validity' => :'String', :'allow_subledger' => :'Boolean' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/talon_one/models/loyalty_program.rb', line 181 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && account_id == o.account_id && name == o.name && title == o.title && description == o.description && subscribed_applications == o.subscribed_applications && default_validity == o.default_validity && allow_subledger == o.allow_subledger end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 264 265 266 267 268 269 270 271 272 |
# File 'lib/talon_one/models/loyalty_program.rb', line 237 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
306 307 308 309 310 311 312 313 314 315 316 317 318 |
# File 'lib/talon_one/models/loyalty_program.rb', line 306 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
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 |
# File 'lib/talon_one/models/loyalty_program.rb', line 216 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
196 197 198 |
# File 'lib/talon_one/models/loyalty_program.rb', line 196 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
202 203 204 |
# File 'lib/talon_one/models/loyalty_program.rb', line 202 def hash [id, account_id, name, title, description, subscribed_applications, default_validity, allow_subledger].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 |
# File 'lib/talon_one/models/loyalty_program.rb', line 128 def list_invalid_properties invalid_properties = Array.new if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @account_id.nil? invalid_properties.push('invalid value for "account_id", account_id cannot be nil.') end if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @title.nil? invalid_properties.push('invalid value for "title", title cannot be nil.') end if @description.nil? invalid_properties.push('invalid value for "description", description cannot be nil.') end if @subscribed_applications.nil? invalid_properties.push('invalid value for "subscribed_applications", subscribed_applications cannot be nil.') end if @default_validity.nil? invalid_properties.push('invalid value for "default_validity", default_validity cannot be nil.') end if @allow_subledger.nil? invalid_properties.push('invalid value for "allow_subledger", allow_subledger cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
282 283 284 |
# File 'lib/talon_one/models/loyalty_program.rb', line 282 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
288 289 290 291 292 293 294 295 296 297 298 299 300 |
# File 'lib/talon_one/models/loyalty_program.rb', line 288 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
276 277 278 |
# File 'lib/talon_one/models/loyalty_program.rb', line 276 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
167 168 169 170 171 172 173 174 175 176 177 |
# File 'lib/talon_one/models/loyalty_program.rb', line 167 def valid? return false if @id.nil? return false if @account_id.nil? return false if @name.nil? return false if @title.nil? return false if @description.nil? return false if @subscribed_applications.nil? return false if @default_validity.nil? return false if @allow_subledger.nil? true end |