Class: Zernio::UpdateAdSetStatus200Response

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

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 = {}) ⇒ UpdateAdSetStatus200Response

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

  if attributes.key?(:'skipped_reasons')
    if (value = attributes[:'skipped_reasons']).is_a?(Array)
      self.skipped_reasons = value
    end
  end

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

Instance Attribute Details

#message ⇒ Object

Present only where the platform has no ad-set switch and no child ad was actionable



31
32
33
 
# File 'lib/zernio-sdk/models/update_ad_set_status200_response.rb', line 31

def message
  @message
end

#skipped ⇒ Object

Number of ads whose own status was left as it was



25
26
27
 
# File 'lib/zernio-sdk/models/update_ad_set_status200_response.rb', line 25

def skipped
  @skipped
end

#skipped_reasons ⇒ Object

Why each group of ads was skipped



28
29
30
 
# File 'lib/zernio-sdk/models/update_ad_set_status200_response.rb', line 28

def skipped_reasons
  @skipped_reasons
end

#status ⇒ Object

The status written to the ad set. Absent when nothing was written (see message).



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

def status
  @status
end

#updated ⇒ Object

Number of ads whose own stored status changed too. 0 is normal on a resume whose ads are all awaiting the platform.



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

def updated
  @updated
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



67
68
69
 
# File 'lib/zernio-sdk/models/update_ad_set_status200_response.rb', line 67

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



72
73
74
 
# File 'lib/zernio-sdk/models/update_ad_set_status200_response.rb', line 72

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
 
# File 'lib/zernio-sdk/models/update_ad_set_status200_response.rb', line 56

def self.attribute_map
  {
    :'status' => :'status',
    :'updated' => :'updated',
    :'skipped' => :'skipped',
    :'skipped_reasons' => :'skippedReasons',
    :'message' => :'message'
  }
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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/zernio-sdk/models/update_ad_set_status200_response.rb', line 186

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



88
89
90
91
 
# File 'lib/zernio-sdk/models/update_ad_set_status200_response.rb', line 88

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

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
 
# File 'lib/zernio-sdk/models/update_ad_set_status200_response.rb', line 77

def self.openapi_types
  {
    :'status' => :'String',
    :'updated' => :'Integer',
    :'skipped' => :'Integer',
    :'skipped_reasons' => :'Array<String>',
    :'message' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



161
162
163
164
165
166
167
168
169
 
# File 'lib/zernio-sdk/models/update_ad_set_status200_response.rb', line 161

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      status == o.status &&
      updated == o.updated &&
      skipped == o.skipped &&
      skipped_reasons == o.skipped_reasons &&
      message == o.message
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


173
174
175
 
# File 'lib/zernio-sdk/models/update_ad_set_status200_response.rb', line 173

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



179
180
181
 
# File 'lib/zernio-sdk/models/update_ad_set_status200_response.rb', line 179

def hash
  [status, updated, skipped, skipped_reasons, message].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



134
135
136
137
138
 
# File 'lib/zernio-sdk/models/update_ad_set_status200_response.rb', line 134

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/zernio-sdk/models/update_ad_set_status200_response.rb', line 208

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



142
143
144
145
146
147
 
# File 'lib/zernio-sdk/models/update_ad_set_status200_response.rb', line 142

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  status_validator = EnumAttributeValidator.new('String', ["active", "paused"])
  return false unless status_validator.valid?(@status)
  true
end