Class: TalonOne::Audience

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Audience

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/talon_one/models/audience.rb', line 88

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

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'created')
    self.created = attributes[:'created']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'sandbox')
    self.sandbox = attributes[:'sandbox']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'integration')
    self.integration = attributes[:'integration']
  end

  if attributes.key?(:'integration_id')
    self.integration_id = attributes[:'integration_id']
  end

  if attributes.key?(:'created_in3rd_party')
    self.created_in3rd_party = attributes[:'created_in3rd_party']
  end

  if attributes.key?(:'last_update')
    self.last_update = attributes[:'last_update']
  end
end

Instance Attribute Details

#account_id ⇒ Object

The ID of the account that owns this entity.



19
20
21
 
# File 'lib/talon_one/models/audience.rb', line 19

def 
  @account_id
end

#created ⇒ Object

The time this entity was created.



25
26
27
 
# File 'lib/talon_one/models/audience.rb', line 25

def created
  @created
end

#created_in3rd_party ⇒ Object

Determines if this audience is a 3rd party audience or not.



43
44
45
 
# File 'lib/talon_one/models/audience.rb', line 43

def created_in3rd_party
  @created_in3rd_party
end

#description ⇒ Object

A description of the audience.



34
35
36
 
# File 'lib/talon_one/models/audience.rb', line 34

def description
  @description
end

#id ⇒ Object

Internal ID of this entity.



22
23
24
 
# File 'lib/talon_one/models/audience.rb', line 22

def id
  @id
end

#integration ⇒ Object

The Talon.One-supported [3rd-party platform](docs.talon.one/docs/dev/technology-partners/overview) that this audience was created in. For example, ‘mParticle`, `Segment`, `Selligent`, `Braze`, or `Iterable`. Note: If you do not integrate with any of these platforms, do not use this property.



37
38
39
 
# File 'lib/talon_one/models/audience.rb', line 37

def integration
  @integration
end

#integration_id ⇒ Object

The ID of this audience in the third-party integration. Note: To create an audience that doesn’t come from a 3rd party platform, do not use this property.



40
41
42
 
# File 'lib/talon_one/models/audience.rb', line 40

def integration_id
  @integration_id
end

#last_update ⇒ Object

The last time that the audience memberships changed.



46
47
48
 
# File 'lib/talon_one/models/audience.rb', line 46

def last_update
  @last_update
end

#name ⇒ Object

The human-friendly display name for this audience.



28
29
30
 
# File 'lib/talon_one/models/audience.rb', line 28

def name
  @name
end

#sandbox ⇒ Object

Indicates if this is a live or sandbox Application.



31
32
33
 
# File 'lib/talon_one/models/audience.rb', line 31

def sandbox
  @sandbox
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/talon_one/models/audience.rb', line 49

def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'id' => :'id',
    :'created' => :'created',
    :'name' => :'name',
    :'sandbox' => :'sandbox',
    :'description' => :'description',
    :'integration' => :'integration',
    :'integration_id' => :'integrationId',
    :'created_in3rd_party' => :'createdIn3rdParty',
    :'last_update' => :'lastUpdate'
  }
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



250
251
252
 
# File 'lib/talon_one/models/audience.rb', line 250

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
 
# File 'lib/talon_one/models/audience.rb', line 81

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

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/talon_one/models/audience.rb', line 65

def self.openapi_types
  {
    :'account_id' => :'Integer',
    :'id' => :'Integer',
    :'created' => :'DateTime',
    :'name' => :'String',
    :'sandbox' => :'Boolean',
    :'description' => :'String',
    :'integration' => :'String',
    :'integration_id' => :'String',
    :'created_in3rd_party' => :'Boolean',
    :'last_update' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/talon_one/models/audience.rb', line 220

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      id == o.id &&
      created == o.created &&
      name == o.name &&
      sandbox == o.sandbox &&
      description == o.description &&
      integration == o.integration &&
      integration_id == o.integration_id &&
      created_in3rd_party == o.created_in3rd_party &&
      last_update == o.last_update
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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/talon_one/models/audience.rb', line 278

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



347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/talon_one/models/audience.rb', line 347

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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/talon_one/models/audience.rb', line 257

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


237
238
239
 
# File 'lib/talon_one/models/audience.rb', line 237

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



243
244
245
 
# File 'lib/talon_one/models/audience.rb', line 243

def hash
  [, id, created, name, sandbox, description, integration, integration_id, created_in3rd_party, last_update].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



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

def list_invalid_properties
  invalid_properties = Array.new
  if @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
  end

  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 @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  end

  if !@integration_id.nil? && @integration_id.to_s.length > 1000
    invalid_properties.push('invalid value for "integration_id", the character length must be smaller than or equal to 1000.')
  end

  if !@integration_id.nil? && @integration_id.to_s.length < 1
    invalid_properties.push('invalid value for "integration_id", the character length must be great than or equal to 1.')
  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



323
324
325
 
# File 'lib/talon_one/models/audience.rb', line 323

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



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/talon_one/models/audience.rb', line 329

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



317
318
319
 
# File 'lib/talon_one/models/audience.rb', line 317

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



179
180
181
182
183
184
185
186
187
188
 
# File 'lib/talon_one/models/audience.rb', line 179

def valid?
  return false if @account_id.nil?
  return false if @id.nil?
  return false if @created.nil?
  return false if @name.nil?
  return false if @name.to_s.length < 1
  return false if !@integration_id.nil? && @integration_id.to_s.length > 1000
  return false if !@integration_id.nil? && @integration_id.to_s.length < 1
  true
end