Class: Zernio::GenerateAdPreviews200ResponsePreviewsInner

Inherits:

ApiModelBase

Object
ApiModelBase
Zernio::GenerateAdPreviews200ResponsePreviewsInner

show all

Defined in:: lib/zernio-sdk/models/generate_ad_previews200_response_previews_inner.rb

Instance Attribute Summary collapse

#format ⇒ Object
Returns the value of attribute format.
#html ⇒ Object
Meta's snippet; null when Meta returned no preview for the format.</div> </li> </ul> <h2> Class Method Summary <a href="#" class="summary_toggle">collapse</a> </h2> <ul class="summary"> <li class="public "> <a href="#acceptable_attribute_map-class_method" title="acceptable_attribute_map (class method)">.acceptable_attribute_map ⇒ Object </a> <div class='inline'>Returns attribute mapping this model knows about.</div> </li> <li class="public "> <a href="#acceptable_attributes-class_method" title="acceptable_attributes (class method)">.acceptable_attributes ⇒ Object </a> <div class='inline'>Returns all the JSON keys this model knows about.</div> </li> <li class="public "> <a href="#attribute_map-class_method" title="attribute_map (class method)">.attribute_map ⇒ Object </a> <div class='inline'>Attribute mapping from ruby-style variable name to JSON key.</div> </li> <li class="public "> <a href="#build_from_hash-class_method" title="build_from_hash (class method)">.build_from_hash(attributes) ⇒ Object </a> <div class='inline'>Builds the object from hash.</div> </li> <li class="public "> <a href="#openapi_nullable-class_method" title="openapi_nullable (class method)">.openapi_nullable ⇒ Object </a> <div class='inline'>List of attributes with nullable: true.</div> </li> <li class="public "> <a href="#openapi_types-class_method" title="openapi_types (class method)">.openapi_types ⇒ Object </a> <div class='inline'>Attribute type mapping.</div> </li> </ul> <h2> Instance Method Summary <a href="#" class="summary_toggle">collapse</a> </h2> <ul class="summary"> <li class="public "> <a href="#==-instance_method" title="#== (instance method)">#==(o) ⇒ Object </a> <div class='inline'>Checks equality by comparing each attribute.</div> </li> <li class="public "> <a href="#eql%3F-instance_method" title="#eql? (instance method)">#eql?(o) ⇒ Boolean </a> <div class='inline'></div> </li> <li class="public "> <a href="#hash-instance_method" title="#hash (instance method)">#hash ⇒ Integer </a> <div class='inline'>Calculates hash code according to all attributes.</div> </li> <li class="public "> <a href="#initialize-instance_method" title="#initialize (instance method)">#initialize(attributes = {}) ⇒ GenerateAdPreviews200ResponsePreviewsInner </a> constructor <div class='inline'>Initializes the object.</div> </li> <li class="public "> <a href="#list_invalid_properties-instance_method" title="#list_invalid_properties (instance method)">#list_invalid_properties ⇒ Object </a> <div class='inline'>Show invalid properties with the reasons.</div> </li> <li class="public "> <a href="#to_hash-instance_method" title="#to_hash (instance method)">#to_hash ⇒ Hash </a> <div class='inline'>Returns the object in the form of hash.</div> </li> <li class="public "> <a href="#valid%3F-instance_method" title="#valid? (instance method)">#valid? ⇒ Boolean </a> <div class='inline'>Check to see if the all the properties in the model are valid.</div> </li> </ul> <h3 class="inherited">Methods inherited from <a href="ApiModelBase.html" title="Zernio::ApiModelBase (class)">ApiModelBase</a></h3> <a href="ApiModelBase.html#_deserialize-class_method" title="Zernio::ApiModelBase._deserialize (method)">_deserialize</a>, <a href="ApiModelBase.html#_to_hash-instance_method" title="Zernio::ApiModelBase#_to_hash (method)">#_to_hash</a>, <a href="ApiModelBase.html#to_body-instance_method" title="Zernio::ApiModelBase#to_body (method)">#to_body</a>, <a href="ApiModelBase.html#to_s-instance_method" title="Zernio::ApiModelBase#to_s (method)">#to_s</a> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> #initialize(attributes = {}) ⇒ <tt><a href="" title="Zernio::GenerateAdPreviews200ResponsePreviewsInner (class)">GenerateAdPreviews200ResponsePreviewsInner</a></tt> </h3><div class="docstring"> <div class="discussion"> Initializes the object </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> attributes (<tt>Hash</tt>) (defaults to: <tt>{}</tt>) — <div class='inline'>Model attributes in the form of hash</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79</pre> </td> <td> <pre class="code"># File 'lib/zernio-sdk/models/generate_ad_previews200_response_previews_inner.rb', line 58 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::GenerateAdPreviews200ResponsePreviewsInner` 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::GenerateAdPreviews200ResponsePreviewsInner`. 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?(:'format') self.format = attributes[:'format'] end if attributes.key?(:'html') self.html = attributes[:'html'] end end</pre> </td> </tr> </table> </div> </div> <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> <div class="method_details first"> <h3 class="signature first" id="format-instance_method"> #format ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Returns the value of attribute format. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 18 19 20</pre> </td> <td> <pre class="code"># File 'lib/zernio-sdk/models/generate_ad_previews200_response_previews_inner.rb', line 18 def format @format end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="html-instance_method"> #html ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Meta's <iframe> snippet; null when Meta returned no preview for the format. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 21 22 23</pre> </td> <td> <pre class="code"># File 'lib/zernio-sdk/models/generate_ad_previews200_response_previews_inner.rb', line 21 def html @html end</pre> </td> </tr> </table> </div> </div> <div id="class_method_details" class="method_details_list"> <h2>Class Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="acceptable_attribute_map-class_method"> .acceptable_attribute_map ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Returns attribute mapping this model knows about </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 32 33 34</pre> </td> <td> <pre class="code"># File 'lib/zernio-sdk/models/generate_ad_previews200_response_previews_inner.rb', line 32 def self.acceptable_attribute_map attribute_map end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="acceptable_attributes-class_method"> .acceptable_attributes ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Returns all the JSON keys this model knows about </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 37 38 39</pre> </td> <td> <pre class="code"># File 'lib/zernio-sdk/models/generate_ad_previews200_response_previews_inner.rb', line 37 def self.acceptable_attributes acceptable_attribute_map.values end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="attribute_map-class_method"> .attribute_map ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Attribute mapping from ruby-style variable name to JSON key. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 24 25 26 27 28 29</pre> </td> <td> <pre class="code"># File 'lib/zernio-sdk/models/generate_ad_previews200_response_previews_inner.rb', line 24 def self.attribute_map { :'format' => :'format', :'html' => :'html' } end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="build_from_hash-class_method"> .build_from_hash(attributes) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Builds the object from hash </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> attributes (<tt>Hash</tt>) — <div class='inline'>Model attributes in the form of hash</div> </li> </ul> Returns: <ul class="return"> <li> (<tt>Object</tt>) — <div class='inline'>Returns the model itself</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138</pre> </td> <td> <pre class="code"># File 'lib/zernio-sdk/models/generate_ad_previews200_response_previews_inner.rb', line 120 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</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="openapi_nullable-class_method"> .openapi_nullable ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> List of attributes with nullable: true </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 50 51 52 53 54</pre> </td> <td> <pre class="code"># File 'lib/zernio-sdk/models/generate_ad_previews200_response_previews_inner.rb', line 50 def self.openapi_nullable Set.new([ :'html' ]) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="openapi_types-class_method"> .openapi_types ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Attribute type mapping. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 42 43 44 45 46 47</pre> </td> <td> <pre class="code"># File 'lib/zernio-sdk/models/generate_ad_previews200_response_previews_inner.rb', line 42 def self.openapi_types { :'format' => :'String', :'html' => :'String' } end</pre> </td> </tr> </table> </div> </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="==-instance_method"> #==(o) ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Checks equality by comparing each attribute. </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> Object (<tt>Object</tt>) — <div class='inline'>to be compared</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 98 99 100 101 102 103</pre> </td> <td> <pre class="code"># File 'lib/zernio-sdk/models/generate_ad_previews200_response_previews_inner.rb', line 98 def ==(o) return true if self.equal?(o) self.class == o.class && format == o.format && html == o.html end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="eql?-instance_method"> #eql?(o) ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> Object (<tt>Object</tt>) — <div class='inline'>to be compared</div> </li> </ul> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) </li> </ul> See Also: <ul class="see"> <li>`==` method</li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 107 108 109</pre> </td> <td> <pre class="code"># File 'lib/zernio-sdk/models/generate_ad_previews200_response_previews_inner.rb', line 107 def eql?(o) self == o end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="hash-instance_method"> #hash ⇒ <tt>Integer</tt> </h3><div class="docstring"> <div class="discussion"> Calculates hash code according to all attributes. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Integer</tt>) — <div class='inline'>Hash code</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 113 114 115</pre> </td> <td> <pre class="code"># File 'lib/zernio-sdk/models/generate_ad_previews200_response_previews_inner.rb', line 113 def hash [format, html].hash end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="list_invalid_properties-instance_method"> #list_invalid_properties ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> Show invalid properties with the reasons. Usually used together with valid? </div> </div> <div class="tags"> Returns: <ul class="return"> <li> <div class='inline'>Array for valid properties with the reasons</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 83 84 85 86 87</pre> </td> <td> <pre class="code"># File 'lib/zernio-sdk/models/generate_ad_previews200_response_previews_inner.rb', line 83 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new invalid_properties end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="to_hash-instance_method"> #to_hash ⇒ <tt>Hash</tt> </h3><div class="docstring"> <div class="discussion"> Returns the object in the form of hash </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Hash</tt>) — <div class='inline'>Returns the object in the form of hash</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 142 143 144 145 146 147 148 149 150 151 152 153 154</pre> </td> <td> <pre class="code"># File 'lib/zernio-sdk/models/generate_ad_previews200_response_previews_inner.rb', line 142 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</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="valid?-instance_method"> #valid? ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> Check to see if the all the properties in the model are valid </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Boolean</tt>) — <div class='inline'>true if the model is valid</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 91 92 93 94</pre> </td> <td> <pre class="code"># File 'lib/zernio-sdk/models/generate_ad_previews200_response_previews_inner.rb', line 91 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' true end</pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Tue Jul 21 10:40:37 2026 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.44 (ruby-4.0.2). </div> </div> </body> </html>