Class: Knievel::DecisionCreativeTemplatedCreative

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/knievel/models/decision_creative_templated_creative.rb

Overview

The decision response’s typed creative block — a discriminated union on ‘type` mirroring `API.md` § 1 / § 3.5. The four arms match the four creative `kind`s.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/knievel/models/decision_creative_templated_creative.rb', line 102

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

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

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

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

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

Instance Attribute Details

#body ⇒ Object

The template’s Liquid source rendered against ‘values` plus the injected decision context (signed URLs, placement id, snapshot version) at decision time.



26
27
28
 
# File 'lib/knievel/models/decision_creative_templated_creative.rb', line 26

def body
  @body
end

#click_through_url ⇒ Object

Returns the value of attribute click_through_url.



28
29
30
 
# File 'lib/knievel/models/decision_creative_templated_creative.rb', line 28

def click_through_url
  @click_through_url
end

#template ⇒ Object

The referenced template’s name.



20
21
22
 
# File 'lib/knievel/models/decision_creative_templated_creative.rb', line 20

def template
  @template
end

#type ⇒ Object

Returns the value of attribute type.



30
31
32
 
# File 'lib/knievel/models/decision_creative_templated_creative.rb', line 30

def type
  @type
end

#values ⇒ Object

Echoed so callers can re-render or inspect.



23
24
25
 
# File 'lib/knievel/models/decision_creative_templated_creative.rb', line 23

def values
  @values
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



66
67
68
 
# File 'lib/knievel/models/decision_creative_templated_creative.rb', line 66

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/knievel/models/decision_creative_templated_creative.rb', line 71

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
 
# File 'lib/knievel/models/decision_creative_templated_creative.rb', line 55

def self.attribute_map
  {
    :'template' => :'template',
    :'values' => :'values',
    :'body' => :'body',
    :'click_through_url' => :'click_through_url',
    :'type' => :'type'
  }
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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/knievel/models/decision_creative_templated_creative.rb', line 217

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



94
95
96
97
98
 
# File 'lib/knievel/models/decision_creative_templated_creative.rb', line 94

def self.openapi_all_of
  [
  :'TemplatedCreative'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



87
88
89
90
91
 
# File 'lib/knievel/models/decision_creative_templated_creative.rb', line 87

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

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
 
# File 'lib/knievel/models/decision_creative_templated_creative.rb', line 76

def self.openapi_types
  {
    :'template' => :'String',
    :'values' => :'Object',
    :'body' => :'String',
    :'click_through_url' => :'String',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



192
193
194
195
196
197
198
199
200
 
# File 'lib/knievel/models/decision_creative_templated_creative.rb', line 192

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      template == o.template &&
      values == o.values &&
      body == o.body &&
      click_through_url == o.click_through_url &&
      type == o.type
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


204
205
206
 
# File 'lib/knievel/models/decision_creative_templated_creative.rb', line 204

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



210
211
212
 
# File 'lib/knievel/models/decision_creative_templated_creative.rb', line 210

def hash
  [template, values, body, click_through_url, type].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



145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/knievel/models/decision_creative_templated_creative.rb', line 145

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @body.nil?
    invalid_properties.push('invalid value for "body", body cannot be nil.')
  end

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



239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/knievel/models/decision_creative_templated_creative.rb', line 239

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



161
162
163
164
165
166
167
168
 
# File 'lib/knievel/models/decision_creative_templated_creative.rb', line 161

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @body.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["templated"])
  return false unless type_validator.valid?(@type)
  true
end