Class: Zernio::ValueRule

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

Overview

One bid-adjustment rule. Rules are evaluated in ARRAY ORDER and only the first matching rule adjusts the bid for an overlapping audience, so the order is semantic.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
141
142
143
144
145
146
147
 
# File 'lib/zernio-sdk/models/value_rule.rb', line 100

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

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

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

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

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

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

Instance Attribute Details

#adjust_sign ⇒ Object

Direction of the adjustment. There is no signed value field.



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

def adjust_sign
  @adjust_sign
end

#adjust_value ⇒ Object

Unsigned percentage magnitude. INCREASE accepts 1-1000, DECREASE accepts 1-90. 0 is out of range on both.



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

def adjust_value
  @adjust_value
end

#criteria ⇒ Object

All criteria on a rule must match for the rule to fire.



34
35
36
 
# File 'lib/zernio-sdk/models/value_rule.rb', line 34

def criteria
  @criteria
end

#id ⇒ Object

Platform rule id. Echo it on PUT to KEEP this rule, omit it to CREATE a new one. A rule left out of the array entirely is DELETED.



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

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#status ⇒ Object

Meta returns ACTIVE here but documents no enum for the field. Treat it as a passthrough: echo whatever the GET returned, and do not synthesize values.



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

def status
  @status
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



71
72
73
 
# File 'lib/zernio-sdk/models/value_rule.rb', line 71

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/zernio-sdk/models/value_rule.rb', line 76

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/zernio-sdk/models/value_rule.rb', line 59

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'adjust_sign' => :'adjustSign',
    :'adjust_value' => :'adjustValue',
    :'status' => :'status',
    :'criteria' => :'criteria'
  }
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



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/zernio-sdk/models/value_rule.rb', line 308

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



93
94
95
96
 
# File 'lib/zernio-sdk/models/value_rule.rb', line 93

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

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/zernio-sdk/models/value_rule.rb', line 81

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'adjust_sign' => :'String',
    :'adjust_value' => :'Integer',
    :'status' => :'String',
    :'criteria' => :'Array<ValueRuleCriterion>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



282
283
284
285
286
287
288
289
290
291
 
# File 'lib/zernio-sdk/models/value_rule.rb', line 282

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      adjust_sign == o.adjust_sign &&
      adjust_value == o.adjust_value &&
      status == o.status &&
      criteria == o.criteria
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


295
296
297
 
# File 'lib/zernio-sdk/models/value_rule.rb', line 295

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



301
302
303
 
# File 'lib/zernio-sdk/models/value_rule.rb', line 301

def hash
  [id, name, adjust_sign, adjust_value, status, criteria].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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

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

  if @adjust_sign.nil?
    invalid_properties.push('invalid value for "adjust_sign", adjust_sign cannot be nil.')
  end

  if @adjust_value.nil?
    invalid_properties.push('invalid value for "adjust_value", adjust_value cannot be nil.')
  end

  if @adjust_value > 1000
    invalid_properties.push('invalid value for "adjust_value", must be smaller than or equal to 1000.')
  end

  if @adjust_value < 1
    invalid_properties.push('invalid value for "adjust_value", must be greater than or equal to 1.')
  end

  if @criteria.nil?
    invalid_properties.push('invalid value for "criteria", criteria cannot be nil.')
  end

  if @criteria.length > 4
    invalid_properties.push('invalid value for "criteria", number of items must be less than or equal to 4.')
  end

  if @criteria.length < 1
    invalid_properties.push('invalid value for "criteria", number of items must be greater than or equal to 1.')
  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



330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/zernio-sdk/models/value_rule.rb', line 330

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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/zernio-sdk/models/value_rule.rb', line 199

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length > 255
  return false if @name.to_s.length < 1
  return false if @adjust_sign.nil?
  adjust_sign_validator = EnumAttributeValidator.new('String', ["INCREASE", "DECREASE"])
  return false unless adjust_sign_validator.valid?(@adjust_sign)
  return false if @adjust_value.nil?
  return false if @adjust_value > 1000
  return false if @adjust_value < 1
  return false if @criteria.nil?
  return false if @criteria.length > 4
  return false if @criteria.length < 1
  true
end