Class: TalonOne::Attribute
- Inherits:
-
Object
- Object
- TalonOne::Attribute
- Defined in:
- lib/talon_one/models/attribute.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#account_id ⇒ Object
The ID of the account that owns this entity.
-
#allowed_subscriptions ⇒ Object
A list of allowed subscription types for this attribute.
-
#created ⇒ Object
The time this entity was created.
-
#description ⇒ Object
A description of this attribute.
-
#editable ⇒ Object
Whether or not this attribute can be edited.
-
#entity ⇒ Object
The name of the entity that can have this attribute.
-
#event_type ⇒ Object
Returns the value of attribute event_type.
-
#event_type_id ⇒ Object
Returns the value of attribute event_type_id.
-
#has_allowed_list ⇒ Object
Whether or not this attribute has an allowed list of values associated with it.
-
#id ⇒ Object
Internal ID of this entity.
-
#name ⇒ Object
The attribute name that will be used in API requests and Talang.
-
#restricted_by_suggestions ⇒ Object
Whether or not this attribute’s value is restricted by suggestions (‘suggestions` property) or by an allowed list of value (`hasAllowedList` property).
-
#subscribed_applications_ids ⇒ Object
A list of the IDs of the applications where this attribute is available.
-
#subscribed_catalogs_ids ⇒ Object
A list of the IDs of the catalogs where this attribute is available.
-
#suggestions ⇒ Object
A list of suggestions for the attribute.
-
#title ⇒ Object
The human-readable name for the attribute that will be shown in the Campaign Manager.
-
#type ⇒ Object
The data type of the attribute, a ‘time` attribute must be sent as a string that conforms to the [RFC3339](www.ietf.org/rfc/rfc3339.txt) timestamp format.
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 = {}) ⇒ Attribute
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 = {}) ⇒ Attribute
Initializes the object
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 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 223 224 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/talon_one/models/attribute.rb', line 143 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::Attribute` 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::Attribute`. 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?(:'account_id') self.account_id = attributes[:'account_id'] end if attributes.key?(:'entity') self.entity = attributes[:'entity'] end if attributes.key?(:'event_type') self.event_type = attributes[:'event_type'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'title') self.title = attributes[:'title'] end if attributes.key?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'suggestions') if (value = attributes[:'suggestions']).is_a?(Array) self.suggestions = value end end if attributes.key?(:'has_allowed_list') self.has_allowed_list = attributes[:'has_allowed_list'] else self.has_allowed_list = false end if attributes.key?(:'restricted_by_suggestions') self.restricted_by_suggestions = attributes[:'restricted_by_suggestions'] else self.restricted_by_suggestions = false end if attributes.key?(:'editable') self.editable = attributes[:'editable'] end if attributes.key?(:'subscribed_applications_ids') if (value = attributes[:'subscribed_applications_ids']).is_a?(Array) self.subscribed_applications_ids = value end end if attributes.key?(:'subscribed_catalogs_ids') if (value = attributes[:'subscribed_catalogs_ids']).is_a?(Array) self.subscribed_catalogs_ids = value end end if attributes.key?(:'allowed_subscriptions') if (value = attributes[:'allowed_subscriptions']).is_a?(Array) self.allowed_subscriptions = value end end if attributes.key?(:'event_type_id') self.event_type_id = attributes[:'event_type_id'] end end |
Instance Attribute Details
#account_id ⇒ Object
The ID of the account that owns this entity.
25 26 27 |
# File 'lib/talon_one/models/attribute.rb', line 25 def account_id @account_id end |
#allowed_subscriptions ⇒ Object
A list of allowed subscription types for this attribute. Note: This only applies to attributes associated with the ‘CartItem` entity.
63 64 65 |
# File 'lib/talon_one/models/attribute.rb', line 63 def allowed_subscriptions @allowed_subscriptions end |
#created ⇒ Object
The time this entity was created.
22 23 24 |
# File 'lib/talon_one/models/attribute.rb', line 22 def created @created end |
#description ⇒ Object
A description of this attribute.
42 43 44 |
# File 'lib/talon_one/models/attribute.rb', line 42 def description @description end |
#editable ⇒ Object
Whether or not this attribute can be edited.
54 55 56 |
# File 'lib/talon_one/models/attribute.rb', line 54 def editable @editable end |
#entity ⇒ Object
The name of the entity that can have this attribute. When creating or updating the entities of a given type, you can include an ‘attributes` object with keys corresponding to the `name` of the custom attributes for that type.
28 29 30 |
# File 'lib/talon_one/models/attribute.rb', line 28 def entity @entity end |
#event_type ⇒ Object
Returns the value of attribute event_type.
30 31 32 |
# File 'lib/talon_one/models/attribute.rb', line 30 def event_type @event_type end |
#event_type_id ⇒ Object
Returns the value of attribute event_type_id.
65 66 67 |
# File 'lib/talon_one/models/attribute.rb', line 65 def event_type_id @event_type_id end |
#has_allowed_list ⇒ Object
Whether or not this attribute has an allowed list of values associated with it.
48 49 50 |
# File 'lib/talon_one/models/attribute.rb', line 48 def has_allowed_list @has_allowed_list end |
#id ⇒ Object
Internal ID of this entity.
19 20 21 |
# File 'lib/talon_one/models/attribute.rb', line 19 def id @id end |
#name ⇒ Object
The attribute name that will be used in API requests and Talang. E.g. if ‘name == "region"` then you would set the region attribute by including an `attributes.region` property in your request payload.
33 34 35 |
# File 'lib/talon_one/models/attribute.rb', line 33 def name @name end |
#restricted_by_suggestions ⇒ Object
Whether or not this attribute’s value is restricted by suggestions (‘suggestions` property) or by an allowed list of value (`hasAllowedList` property).
51 52 53 |
# File 'lib/talon_one/models/attribute.rb', line 51 def restricted_by_suggestions @restricted_by_suggestions end |
#subscribed_applications_ids ⇒ Object
A list of the IDs of the applications where this attribute is available.
57 58 59 |
# File 'lib/talon_one/models/attribute.rb', line 57 def subscribed_applications_ids @subscribed_applications_ids end |
#subscribed_catalogs_ids ⇒ Object
A list of the IDs of the catalogs where this attribute is available.
60 61 62 |
# File 'lib/talon_one/models/attribute.rb', line 60 def subscribed_catalogs_ids @subscribed_catalogs_ids end |
#suggestions ⇒ Object
A list of suggestions for the attribute.
45 46 47 |
# File 'lib/talon_one/models/attribute.rb', line 45 def suggestions @suggestions end |
#title ⇒ Object
The human-readable name for the attribute that will be shown in the Campaign Manager. Like ‘name`, the combination of entity and title must also be unique.
36 37 38 |
# File 'lib/talon_one/models/attribute.rb', line 36 def title @title end |
#type ⇒ Object
The data type of the attribute, a ‘time` attribute must be sent as a string that conforms to the [RFC3339](www.ietf.org/rfc/rfc3339.txt) timestamp format.
39 40 41 |
# File 'lib/talon_one/models/attribute.rb', line 39 def type @type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/talon_one/models/attribute.rb', line 90 def self.attribute_map { :'id' => :'id', :'created' => :'created', :'account_id' => :'accountId', :'entity' => :'entity', :'event_type' => :'eventType', :'name' => :'name', :'title' => :'title', :'type' => :'type', :'description' => :'description', :'suggestions' => :'suggestions', :'has_allowed_list' => :'hasAllowedList', :'restricted_by_suggestions' => :'restrictedBySuggestions', :'editable' => :'editable', :'subscribed_applications_ids' => :'subscribedApplicationsIds', :'subscribed_catalogs_ids' => :'subscribedCatalogsIds', :'allowed_subscriptions' => :'allowedSubscriptions', :'event_type_id' => :'eventTypeId' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
405 406 407 |
# File 'lib/talon_one/models/attribute.rb', line 405 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
136 137 138 139 |
# File 'lib/talon_one/models/attribute.rb', line 136 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/talon_one/models/attribute.rb', line 113 def self.openapi_types { :'id' => :'Integer', :'created' => :'DateTime', :'account_id' => :'Integer', :'entity' => :'String', :'event_type' => :'String', :'name' => :'String', :'title' => :'String', :'type' => :'String', :'description' => :'String', :'suggestions' => :'Array<String>', :'has_allowed_list' => :'Boolean', :'restricted_by_suggestions' => :'Boolean', :'editable' => :'Boolean', :'subscribed_applications_ids' => :'Array<Integer>', :'subscribed_catalogs_ids' => :'Array<Integer>', :'allowed_subscriptions' => :'Array<String>', :'event_type_id' => :'Integer' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 |
# File 'lib/talon_one/models/attribute.rb', line 368 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && created == o.created && account_id == o.account_id && entity == o.entity && event_type == o.event_type && name == o.name && title == o.title && type == o.type && description == o.description && suggestions == o.suggestions && has_allowed_list == o.has_allowed_list && restricted_by_suggestions == o.restricted_by_suggestions && editable == o.editable && subscribed_applications_ids == o.subscribed_applications_ids && subscribed_catalogs_ids == o.subscribed_catalogs_ids && allowed_subscriptions == o.allowed_subscriptions && event_type_id == o.event_type_id end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 |
# File 'lib/talon_one/models/attribute.rb', line 433 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
502 503 504 505 506 507 508 509 510 511 512 513 514 |
# File 'lib/talon_one/models/attribute.rb', line 502 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
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 |
# File 'lib/talon_one/models/attribute.rb', line 412 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
392 393 394 |
# File 'lib/talon_one/models/attribute.rb', line 392 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
398 399 400 |
# File 'lib/talon_one/models/attribute.rb', line 398 def hash [id, created, account_id, entity, event_type, name, title, type, description, suggestions, has_allowed_list, restricted_by_suggestions, editable, subscribed_applications_ids, subscribed_catalogs_ids, allowed_subscriptions, event_type_id].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/talon_one/models/attribute.rb', line 239 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 @account_id.nil? invalid_properties.push('invalid value for "account_id", account_id cannot be nil.') end if @entity.nil? invalid_properties.push('invalid value for "entity", entity cannot be nil.') end if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end pattern = Regexp.new(/^[A-Za-z]\w*$/) if @name !~ pattern invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.") end if @title.nil? invalid_properties.push('invalid value for "title", title cannot be nil.') end pattern = Regexp.new(/^[A-Za-z][A-Za-z0-9_.!~*'() -]*$/) if @title !~ pattern invalid_properties.push("invalid value for \"title\", must conform to the pattern #{pattern}.") end if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @description.nil? invalid_properties.push('invalid value for "description", description cannot be nil.') end if @suggestions.nil? invalid_properties.push('invalid value for "suggestions", suggestions cannot be nil.') end if @editable.nil? invalid_properties.push('invalid value for "editable", editable cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
478 479 480 |
# File 'lib/talon_one/models/attribute.rb', line 478 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
484 485 486 487 488 489 490 491 492 493 494 495 496 |
# File 'lib/talon_one/models/attribute.rb', line 484 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
472 473 474 |
# File 'lib/talon_one/models/attribute.rb', line 472 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 |
# File 'lib/talon_one/models/attribute.rb', line 296 def valid? return false if @id.nil? return false if @created.nil? return false if @account_id.nil? return false if @entity.nil? entity_validator = EnumAttributeValidator.new('String', ["Application", "Campaign", "CustomerProfile", "CustomerSession", "CartItem", "Coupon", "Event", "Giveaway", "Referral", "Store"]) return false unless entity_validator.valid?(@entity) return false if @name.nil? return false if @name !~ Regexp.new(/^[A-Za-z]\w*$/) return false if @title.nil? return false if @title !~ Regexp.new(/^[A-Za-z][A-Za-z0-9_.!~*'() -]*$/) return false if @type.nil? type_validator = EnumAttributeValidator.new('String', ["string", "number", "boolean", "time", "(list string)", "(list number)", "(list time)", "location", "(list location)"]) return false unless type_validator.valid?(@type) return false if @description.nil? return false if @suggestions.nil? return false if @editable.nil? true end |