Class: Knievel::DecisionCreativeHtmlCreative

Inherits:
ApiModelBase show all
Defined in:
lib/knievel/models/decision_creative_html_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 = {}) ⇒ DecisionCreativeHtmlCreative

Initializes the object

Parameters:

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

    Model attributes in the form of hash



91
92
93
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
 
# File 'lib/knievel/models/decision_creative_html_creative.rb', line 91

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

Verbatim HTML stored on the creative, returned as-is.



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

def body
  @body
end

#click_through_url ⇒ Object

Returns the value of attribute click_through_url.



22
23
24
 
# File 'lib/knievel/models/decision_creative_html_creative.rb', line 22

def click_through_url
  @click_through_url
end

#type ⇒ Object

Returns the value of attribute type.



24
25
26
 
# File 'lib/knievel/models/decision_creative_html_creative.rb', line 24

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



58
59
60
 
# File 'lib/knievel/models/decision_creative_html_creative.rb', line 58

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



63
64
65
 
# File 'lib/knievel/models/decision_creative_html_creative.rb', line 63

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
 
# File 'lib/knievel/models/decision_creative_html_creative.rb', line 49

def self.attribute_map
  {
    :'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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/knievel/models/decision_creative_html_creative.rb', line 177

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)



83
84
85
86
87
 
# File 'lib/knievel/models/decision_creative_html_creative.rb', line 83

def self.openapi_all_of
  [
  :'HtmlCreative'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



77
78
79
80
 
# File 'lib/knievel/models/decision_creative_html_creative.rb', line 77

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

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
 
# File 'lib/knievel/models/decision_creative_html_creative.rb', line 68

def self.openapi_types
  {
    :'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



154
155
156
157
158
159
160
 
# File 'lib/knievel/models/decision_creative_html_creative.rb', line 154

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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


164
165
166
 
# File 'lib/knievel/models/decision_creative_html_creative.rb', line 164

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



170
171
172
 
# File 'lib/knievel/models/decision_creative_html_creative.rb', line 170

def hash
  [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



122
123
124
125
126
127
128
129
130
 
# File 'lib/knievel/models/decision_creative_html_creative.rb', line 122

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/knievel/models/decision_creative_html_creative.rb', line 199

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



134
135
136
137
138
139
140
 
# File 'lib/knievel/models/decision_creative_html_creative.rb', line 134

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