Class: Zernio::UpdateAdSet200Response

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/update_ad_set200_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 = {}) ⇒ UpdateAdSet200Response

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
172
173
174
175
176
177
178
179
180
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 121

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#bid_amount ⇒ Object

Returns the value of attribute bid_amount.



39
40
41
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 39

def bid_amount
  @bid_amount
end

#bid_strategy ⇒ Object

Returns the value of attribute bid_strategy.



37
38
39
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 37

def bid_strategy
  @bid_strategy
end

#budget ⇒ Object

Returns the value of attribute budget.



18
19
20
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 18

def budget
  @budget
end

#budget_level ⇒ Object

Returns the value of attribute budget_level.



20
21
22
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 20

def budget_level
  @budget_level
end

#platform_specific_data ⇒ Object

Returns the value of attribute platform_specific_data.



43
44
45
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 43

def platform_specific_data
  @platform_specific_data
end

#roas_average_floor ⇒ Object

Returns the value of attribute roas_average_floor.



41
42
43
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 41

def roas_average_floor
  @roas_average_floor
end

#status ⇒ Object

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



23
24
25
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 23

def status
  @status
end

#status_message ⇒ Object

Present only where the platform has no ad-set switch and no child ad was actionable; status is then absent because nothing was written



35
36
37
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 35

def status_message
  @status_message
end

#status_skipped ⇒ Object

Number of ads whose own status was left as it was



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

def status_skipped
  @status_skipped
end

#status_skipped_reasons ⇒ Object

Why each group of ads was skipped



32
33
34
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 32

def status_skipped_reasons
  @status_skipped_reasons
end

#status_updated ⇒ Object

Number of ads whose own stored status changed alongside the ad set switch



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

def status_updated
  @status_updated
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



85
86
87
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 85

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 90

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 68

def self.attribute_map
  {
    :'budget' => :'budget',
    :'budget_level' => :'budgetLevel',
    :'status' => :'status',
    :'status_updated' => :'statusUpdated',
    :'status_skipped' => :'statusSkipped',
    :'status_skipped_reasons' => :'statusSkippedReasons',
    :'status_message' => :'statusMessage',
    :'bid_strategy' => :'bidStrategy',
    :'bid_amount' => :'bidAmount',
    :'roas_average_floor' => :'roasAverageFloor',
    :'platform_specific_data' => :'platformSpecificData'
  }
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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 254

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



112
113
114
115
116
117
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 112

def self.openapi_nullable
  Set.new([
    :'bid_amount',
    :'roas_average_floor',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 95

def self.openapi_types
  {
    :'budget' => :'AdBudget',
    :'budget_level' => :'String',
    :'status' => :'String',
    :'status_updated' => :'Integer',
    :'status_skipped' => :'Integer',
    :'status_skipped_reasons' => :'Array<String>',
    :'status_message' => :'String',
    :'bid_strategy' => :'BidStrategy',
    :'bid_amount' => :'Float',
    :'roas_average_floor' => :'Float',
    :'platform_specific_data' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 223

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      budget == o.budget &&
      budget_level == o.budget_level &&
      status == o.status &&
      status_updated == o.status_updated &&
      status_skipped == o.status_skipped &&
      status_skipped_reasons == o.status_skipped_reasons &&
      status_message == o.status_message &&
      bid_strategy == o.bid_strategy &&
      bid_amount == o.bid_amount &&
      roas_average_floor == o.roas_average_floor &&
      platform_specific_data == o.platform_specific_data
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


241
242
243
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 241

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



247
248
249
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 247

def hash
  [budget, budget_level, status, status_updated, status_skipped, status_skipped_reasons, status_message, bid_strategy, bid_amount, roas_average_floor, platform_specific_data].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



184
185
186
187
188
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 184

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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 276

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



192
193
194
195
196
197
198
199
 
# File 'lib/zernio-sdk/models/update_ad_set200_response.rb', line 192

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