Class: TalonOne::CustomEffect
- Inherits:
-
Object
- Object
- TalonOne::CustomEffect
- Defined in:
- lib/talon_one/models/custom_effect.rb
Instance Attribute Summary collapse
-
#account_id ⇒ Object
The ID of the account that owns this entity.
-
#created ⇒ Object
The exact moment this entity was created.
-
#created_by ⇒ Object
ID of the user who created this effect.
-
#description ⇒ Object
The description of this effect.
-
#enabled ⇒ Object
Determines if this effect is active.
-
#id ⇒ Object
Unique ID for this entity.
-
#modified ⇒ Object
The exact moment this entity was last modified.
-
#modified_by ⇒ Object
ID of the user who last updated this effect if available.
-
#name ⇒ Object
The name of this effect.
-
#params ⇒ Object
Array of template argument definitions.
-
#payload ⇒ Object
The JSON payload of this effect.
-
#subscribed_applications_ids ⇒ Object
A list of the IDs of the applications that this effect is enabled for.
-
#title ⇒ Object
The title of this effect.
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 = {}) ⇒ CustomEffect
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 = {}) ⇒ CustomEffect
Initializes the object
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 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/talon_one/models/custom_effect.rb', line 103 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::CustomEffect` 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::CustomEffect`. 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?(:'modified') self.modified = attributes[:'modified'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'title') self.title = attributes[:'title'] end if attributes.key?(:'payload') self.payload = attributes[:'payload'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'enabled') self.enabled = attributes[:'enabled'] 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?(:'params') if (value = attributes[:'params']).is_a?(Array) self.params = value end end if attributes.key?(:'modified_by') self.modified_by = attributes[:'modified_by'] end if attributes.key?(:'created_by') self.created_by = attributes[:'created_by'] 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/custom_effect.rb', line 25 def account_id @account_id end |
#created ⇒ Object
The exact moment this entity was created.
22 23 24 |
# File 'lib/talon_one/models/custom_effect.rb', line 22 def created @created end |
#created_by ⇒ Object
ID of the user who created this effect.
55 56 57 |
# File 'lib/talon_one/models/custom_effect.rb', line 55 def created_by @created_by end |
#description ⇒ Object
The description of this effect.
40 41 42 |
# File 'lib/talon_one/models/custom_effect.rb', line 40 def description @description end |
#enabled ⇒ Object
Determines if this effect is active.
43 44 45 |
# File 'lib/talon_one/models/custom_effect.rb', line 43 def enabled @enabled end |
#id ⇒ Object
Unique ID for this entity.
19 20 21 |
# File 'lib/talon_one/models/custom_effect.rb', line 19 def id @id end |
#modified ⇒ Object
The exact moment this entity was last modified.
28 29 30 |
# File 'lib/talon_one/models/custom_effect.rb', line 28 def modified @modified end |
#modified_by ⇒ Object
ID of the user who last updated this effect if available.
52 53 54 |
# File 'lib/talon_one/models/custom_effect.rb', line 52 def modified_by @modified_by end |
#name ⇒ Object
The name of this effect.
31 32 33 |
# File 'lib/talon_one/models/custom_effect.rb', line 31 def name @name end |
#params ⇒ Object
Array of template argument definitions
49 50 51 |
# File 'lib/talon_one/models/custom_effect.rb', line 49 def params @params end |
#payload ⇒ Object
The JSON payload of this effect.
37 38 39 |
# File 'lib/talon_one/models/custom_effect.rb', line 37 def payload @payload end |
#subscribed_applications_ids ⇒ Object
A list of the IDs of the applications that this effect is enabled for
46 47 48 |
# File 'lib/talon_one/models/custom_effect.rb', line 46 def subscribed_applications_ids @subscribed_applications_ids end |
#title ⇒ Object
The title of this effect.
34 35 36 |
# File 'lib/talon_one/models/custom_effect.rb', line 34 def title @title end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/talon_one/models/custom_effect.rb', line 58 def self.attribute_map { :'id' => :'id', :'created' => :'created', :'account_id' => :'accountId', :'modified' => :'modified', :'name' => :'name', :'title' => :'title', :'payload' => :'payload', :'description' => :'description', :'enabled' => :'enabled', :'subscribed_applications_ids' => :'subscribedApplicationsIds', :'params' => :'params', :'modified_by' => :'modifiedBy', :'created_by' => :'createdBy' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
266 267 268 |
# File 'lib/talon_one/models/custom_effect.rb', line 266 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
96 97 98 99 |
# File 'lib/talon_one/models/custom_effect.rb', line 96 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/talon_one/models/custom_effect.rb', line 77 def self.openapi_types { :'id' => :'Integer', :'created' => :'DateTime', :'account_id' => :'Integer', :'modified' => :'DateTime', :'name' => :'String', :'title' => :'String', :'payload' => :'String', :'description' => :'String', :'enabled' => :'Boolean', :'subscribed_applications_ids' => :'Array<Integer>', :'params' => :'Array<TemplateArgDef>', :'modified_by' => :'Integer', :'created_by' => :'Integer' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
# File 'lib/talon_one/models/custom_effect.rb', line 233 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && created == o.created && account_id == o.account_id && modified == o.modified && name == o.name && title == o.title && payload == o.payload && description == o.description && enabled == o.enabled && subscribed_applications_ids == o.subscribed_applications_ids && params == o.params && modified_by == o.modified_by && created_by == o.created_by end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 |
# File 'lib/talon_one/models/custom_effect.rb', line 294 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
363 364 365 366 367 368 369 370 371 372 373 374 375 |
# File 'lib/talon_one/models/custom_effect.rb', line 363 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
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 |
# File 'lib/talon_one/models/custom_effect.rb', line 273 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
253 254 255 |
# File 'lib/talon_one/models/custom_effect.rb', line 253 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
259 260 261 |
# File 'lib/talon_one/models/custom_effect.rb', line 259 def hash [id, created, account_id, modified, name, title, payload, description, enabled, subscribed_applications_ids, params, modified_by, created_by].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 |
# File 'lib/talon_one/models/custom_effect.rb', line 175 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 @modified.nil? invalid_properties.push('invalid value for "modified", modified 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 @payload.nil? invalid_properties.push('invalid value for "payload", payload cannot be nil.') end if @enabled.nil? invalid_properties.push('invalid value for "enabled", enabled cannot be nil.') end if @created_by.nil? invalid_properties.push('invalid value for "created_by", created_by cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
339 340 341 |
# File 'lib/talon_one/models/custom_effect.rb', line 339 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
345 346 347 348 349 350 351 352 353 354 355 356 357 |
# File 'lib/talon_one/models/custom_effect.rb', line 345 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
333 334 335 |
# File 'lib/talon_one/models/custom_effect.rb', line 333 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
218 219 220 221 222 223 224 225 226 227 228 229 |
# File 'lib/talon_one/models/custom_effect.rb', line 218 def valid? return false if @id.nil? return false if @created.nil? return false if @account_id.nil? return false if @modified.nil? return false if @name.nil? return false if @title.nil? return false if @payload.nil? return false if @enabled.nil? return false if @created_by.nil? true end |