Class: TalonOne::NewAttribute

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/new_attribute.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NewAttribute

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
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
 
# File 'lib/talon_one/models/new_attribute.rb', line 123

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::NewAttribute` 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::NewAttribute`. 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?(:'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
end

Instance Attribute Details

#allowed_subscriptions ⇒ Object

A list of allowed subscription types for this attribute. Note: This only applies to attributes associated with the ‘CartItem` entity.



53
54
55
 
# File 'lib/talon_one/models/new_attribute.rb', line 53

def allowed_subscriptions
  @allowed_subscriptions
end

#description ⇒ Object

A description of this attribute.



32
33
34
 
# File 'lib/talon_one/models/new_attribute.rb', line 32

def description
  @description
end

#editable ⇒ Object

Whether or not this attribute can be edited.



44
45
46
 
# File 'lib/talon_one/models/new_attribute.rb', line 44

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.



18
19
20
 
# File 'lib/talon_one/models/new_attribute.rb', line 18

def entity
  @entity
end

#event_type ⇒ Object

Returns the value of attribute event_type.



20
21
22
 
# File 'lib/talon_one/models/new_attribute.rb', line 20

def event_type
  @event_type
end

#has_allowed_list ⇒ Object

Whether or not this attribute has an allowed list of values associated with it.



38
39
40
 
# File 'lib/talon_one/models/new_attribute.rb', line 38

def has_allowed_list
  @has_allowed_list
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.



23
24
25
 
# File 'lib/talon_one/models/new_attribute.rb', line 23

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).



41
42
43
 
# File 'lib/talon_one/models/new_attribute.rb', line 41

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.



47
48
49
 
# File 'lib/talon_one/models/new_attribute.rb', line 47

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.



50
51
52
 
# File 'lib/talon_one/models/new_attribute.rb', line 50

def subscribed_catalogs_ids
  @subscribed_catalogs_ids
end

#suggestions ⇒ Object

A list of suggestions for the attribute.



35
36
37
 
# File 'lib/talon_one/models/new_attribute.rb', line 35

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.



26
27
28
 
# File 'lib/talon_one/models/new_attribute.rb', line 26

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.



29
30
31
 
# File 'lib/talon_one/models/new_attribute.rb', line 29

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/talon_one/models/new_attribute.rb', line 78

def self.attribute_map
  {
    :'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'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



350
351
352
 
# File 'lib/talon_one/models/new_attribute.rb', line 350

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
 
# File 'lib/talon_one/models/new_attribute.rb', line 116

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/talon_one/models/new_attribute.rb', line 97

def self.openapi_types
  {
    :'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>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/talon_one/models/new_attribute.rb', line 317

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/talon_one/models/new_attribute.rb', line 378

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/talon_one/models/new_attribute.rb', line 447

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/talon_one/models/new_attribute.rb', line 357

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


337
338
339
 
# File 'lib/talon_one/models/new_attribute.rb', line 337

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



343
344
345
 
# File 'lib/talon_one/models/new_attribute.rb', line 343

def hash
  [entity, event_type, name, title, type, description, suggestions, has_allowed_list, restricted_by_suggestions, editable, subscribed_applications_ids, subscribed_catalogs_ids, allowed_subscriptions].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
 
# File 'lib/talon_one/models/new_attribute.rb', line 203

def list_invalid_properties
  invalid_properties = Array.new
  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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



423
424
425
 
# File 'lib/talon_one/models/new_attribute.rb', line 423

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/talon_one/models/new_attribute.rb', line 429

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

Returns:

  • (String) —

    String presentation of the object



417
418
419
 
# File 'lib/talon_one/models/new_attribute.rb', line 417

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/talon_one/models/new_attribute.rb', line 248

def valid?
  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