Class: Zernio::SavedTargetingAudience

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/saved_targeting_audience.rb

Overview

A reusable, stored TargetingSpec. No member upload step, no adAccountId, the spec is the audience. Reference it later via savedTargetingId on POST /v1/ads/create.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ SavedTargetingAudience

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/zernio-sdk/models/saved_targeting_audience.rb', line 94

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::SavedTargetingAudience` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::SavedTargetingAudience`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = nil
  end

  if attributes.key?(:'account_id')
    self. = attributes[:'account_id']
  else
    self. = nil
  end

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

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

  if attributes.key?(:'spec')
    self.spec = attributes[:'spec']
  else
    self.spec = nil
  end
end

Instance Attribute Details

#account_id ⇒ Object

Social account ID on the target ad platform.



22
23
24
 
# File 'lib/zernio-sdk/models/saved_targeting_audience.rb', line 22

def 
  @account_id
end

#description ⇒ Object

Returns the value of attribute description.



26
27
28
 
# File 'lib/zernio-sdk/models/saved_targeting_audience.rb', line 26

def description
  @description
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/zernio-sdk/models/saved_targeting_audience.rb', line 24

def name
  @name
end

#spec ⇒ Object

The targeting spec to store.



29
30
31
 
# File 'lib/zernio-sdk/models/saved_targeting_audience.rb', line 29

def spec
  @spec
end

#type ⇒ Object

Returns the value of attribute type.



19
20
21
 
# File 'lib/zernio-sdk/models/saved_targeting_audience.rb', line 19

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



65
66
67
 
# File 'lib/zernio-sdk/models/saved_targeting_audience.rb', line 65

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



70
71
72
 
# File 'lib/zernio-sdk/models/saved_targeting_audience.rb', line 70

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
 
# File 'lib/zernio-sdk/models/saved_targeting_audience.rb', line 54

def self.attribute_map
  {
    :'type' => :'type',
    :'account_id' => :'accountId',
    :'name' => :'name',
    :'description' => :'description',
    :'spec' => :'spec'
  }
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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/zernio-sdk/models/saved_targeting_audience.rb', line 235

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



86
87
88
89
90
 
# File 'lib/zernio-sdk/models/saved_targeting_audience.rb', line 86

def self.openapi_nullable
  Set.new([
    :'spec'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
 
# File 'lib/zernio-sdk/models/saved_targeting_audience.rb', line 75

def self.openapi_types
  {
    :'type' => :'String',
    :'account_id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'spec' => :'TargetingSpec'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



210
211
212
213
214
215
216
217
218
 
# File 'lib/zernio-sdk/models/saved_targeting_audience.rb', line 210

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
       == o. &&
      name == o.name &&
      description == o.description &&
      spec == o.spec
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


222
223
224
 
# File 'lib/zernio-sdk/models/saved_targeting_audience.rb', line 222

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



228
229
230
 
# File 'lib/zernio-sdk/models/saved_targeting_audience.rb', line 228

def hash
  [type, , name, description, spec].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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/zernio-sdk/models/saved_targeting_audience.rb', line 139

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type 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 @name.to_s.length > 255
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/zernio-sdk/models/saved_targeting_audience.rb', line 257

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



163
164
165
166
167
168
169
170
171
172
 
# File 'lib/zernio-sdk/models/saved_targeting_audience.rb', line 163

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["saved_targeting"])
  return false unless type_validator.valid?(@type)
  return false if @account_id.nil?
  return false if @name.nil?
  return false if @name.to_s.length > 255
  true
end