Class: Phyllo::Content1Engagement
- Inherits:
-
Object
- Object
- Phyllo::Content1Engagement
- Defined in:
- lib/phyllo/models/content1_engagement.rb
Instance Attribute Summary collapse
-
#additional_info ⇒ Object
Returns the value of attribute additional_info.
-
#click_count ⇒ Object
Total web click count on the content item.
-
#comment_count ⇒ Object
Total comments.
-
#dislike_count ⇒ Object
Total dislikes.
-
#email_click_rate ⇒ Object
Percentage of emails that have been clicked.
-
#email_open_rate ⇒ Object
Percentage of emails that have been opened.
-
#impression_organic_count ⇒ Object
Total organic impressions.
-
#impression_paid_count ⇒ Object
Total paid impressions.
-
#like_count ⇒ Object
Total likes.
-
#reach_organic_count ⇒ Object
Total organic reach.
-
#reach_paid_count ⇒ Object
Total paid reach.
-
#save_count ⇒ Object
Total item saves.
-
#share_count ⇒ Object
Total shares.
-
#spam_report_count ⇒ Object
Number of email subscribers that report this post as spam.
-
#unsubscribe_count ⇒ Object
Number of unsubscribes on the email.
-
#view_count ⇒ Object
Total views.
-
#watch_time_in_hours ⇒ Object
If format is ‘video` - total watch time in hours.
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Content1Engagement
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Content1Engagement
Initializes the object
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 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
# File 'lib/phyllo/models/content1_engagement.rb', line 129 def initialize(attributes = {}) if !attributes.is_a?(Hash) fail ArgumentError, "The input argument (attributes) must be a hash in `Phyllo::Content1Engagement` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if !self.class.attribute_map.key?(k.to_sym) fail ArgumentError, "`#{k}` is not a valid attribute in `Phyllo::Content1Engagement`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:like_count) self.like_count = attributes[:like_count] end if attributes.key?(:dislike_count) self.dislike_count = attributes[:dislike_count] end if attributes.key?(:comment_count) self.comment_count = attributes[:comment_count] end if attributes.key?(:impression_organic_count) self.impression_organic_count = attributes[:impression_organic_count] end if attributes.key?(:reach_organic_count) self.reach_organic_count = attributes[:reach_organic_count] end if attributes.key?(:save_count) self.save_count = attributes[:save_count] end if attributes.key?(:view_count) self.view_count = attributes[:view_count] end if attributes.key?(:watch_time_in_hours) self.watch_time_in_hours = attributes[:watch_time_in_hours] end if attributes.key?(:share_count) self.share_count = attributes[:share_count] end if attributes.key?(:impression_paid_count) self.impression_paid_count = attributes[:impression_paid_count] end if attributes.key?(:reach_paid_count) self.reach_paid_count = attributes[:reach_paid_count] end if attributes.key?(:email_open_rate) self.email_open_rate = attributes[:email_open_rate] end if attributes.key?(:email_click_rate) self.email_click_rate = attributes[:email_click_rate] end if attributes.key?(:unsubscribe_count) self.unsubscribe_count = attributes[:unsubscribe_count] end if attributes.key?(:spam_report_count) self.spam_report_count = attributes[:spam_report_count] end if attributes.key?(:click_count) self.click_count = attributes[:click_count] end if attributes.key?(:additional_info) self.additional_info = attributes[:additional_info] end end |
Instance Attribute Details
#additional_info ⇒ Object
Returns the value of attribute additional_info.
64 65 66 |
# File 'lib/phyllo/models/content1_engagement.rb', line 64 def additional_info @additional_info end |
#click_count ⇒ Object
Total web click count on the content item
62 63 64 |
# File 'lib/phyllo/models/content1_engagement.rb', line 62 def click_count @click_count end |
#comment_count ⇒ Object
Total comments.
23 24 25 |
# File 'lib/phyllo/models/content1_engagement.rb', line 23 def comment_count @comment_count end |
#dislike_count ⇒ Object
Total dislikes.
20 21 22 |
# File 'lib/phyllo/models/content1_engagement.rb', line 20 def dislike_count @dislike_count end |
#email_click_rate ⇒ Object
Percentage of emails that have been clicked
53 54 55 |
# File 'lib/phyllo/models/content1_engagement.rb', line 53 def email_click_rate @email_click_rate end |
#email_open_rate ⇒ Object
Percentage of emails that have been opened
50 51 52 |
# File 'lib/phyllo/models/content1_engagement.rb', line 50 def email_open_rate @email_open_rate end |
#impression_organic_count ⇒ Object
Total organic impressions.
26 27 28 |
# File 'lib/phyllo/models/content1_engagement.rb', line 26 def impression_organic_count @impression_organic_count end |
#impression_paid_count ⇒ Object
Total paid impressions.
44 45 46 |
# File 'lib/phyllo/models/content1_engagement.rb', line 44 def impression_paid_count @impression_paid_count end |
#like_count ⇒ Object
Total likes.
17 18 19 |
# File 'lib/phyllo/models/content1_engagement.rb', line 17 def like_count @like_count end |
#reach_organic_count ⇒ Object
Total organic reach.
29 30 31 |
# File 'lib/phyllo/models/content1_engagement.rb', line 29 def reach_organic_count @reach_organic_count end |
#reach_paid_count ⇒ Object
Total paid reach.
47 48 49 |
# File 'lib/phyllo/models/content1_engagement.rb', line 47 def reach_paid_count @reach_paid_count end |
#save_count ⇒ Object
Total item saves.
32 33 34 |
# File 'lib/phyllo/models/content1_engagement.rb', line 32 def save_count @save_count end |
#share_count ⇒ Object
Total shares.
41 42 43 |
# File 'lib/phyllo/models/content1_engagement.rb', line 41 def share_count @share_count end |
#spam_report_count ⇒ Object
Number of email subscribers that report this post as spam
59 60 61 |
# File 'lib/phyllo/models/content1_engagement.rb', line 59 def spam_report_count @spam_report_count end |
#unsubscribe_count ⇒ Object
Number of unsubscribes on the email
56 57 58 |
# File 'lib/phyllo/models/content1_engagement.rb', line 56 def unsubscribe_count @unsubscribe_count end |
#view_count ⇒ Object
Total views.
35 36 37 |
# File 'lib/phyllo/models/content1_engagement.rb', line 35 def view_count @view_count end |
#watch_time_in_hours ⇒ Object
If format is ‘video` - total watch time in hours.
38 39 40 |
# File 'lib/phyllo/models/content1_engagement.rb', line 38 def watch_time_in_hours @watch_time_in_hours end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 |
# File 'lib/phyllo/models/content1_engagement.rb', line 288 def self._deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model # models (e.g. Pet) or oneOf klass = Phyllo.const_get(type) (klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of)) ? klass.build(value) : klass.build_from_hash(value) end end |
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
90 91 92 |
# File 'lib/phyllo/models/content1_engagement.rb', line 90 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/phyllo/models/content1_engagement.rb', line 67 def self.attribute_map { like_count: :like_count, dislike_count: :dislike_count, comment_count: :comment_count, impression_organic_count: :impression_organic_count, reach_organic_count: :reach_organic_count, save_count: :save_count, view_count: :view_count, watch_time_in_hours: :watch_time_in_hours, share_count: :share_count, impression_paid_count: :impression_paid_count, reach_paid_count: :reach_paid_count, email_open_rate: :email_open_rate, email_click_rate: :email_click_rate, unsubscribe_count: :unsubscribe_count, spam_report_count: :spam_report_count, click_count: :click_count, additional_info: :additional_info } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 |
# File 'lib/phyllo/models/content1_engagement.rb', line 264 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.to_s] = 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.to_s] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } end elsif !attributes[attribute_map[key]].nil? transformed_hash[key.to_s] = _deserialize(type, attributes[attribute_map[key]]) end end new(transformed_hash) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
118 119 120 121 122 123 124 125 |
# File 'lib/phyllo/models/content1_engagement.rb', line 118 def self.openapi_nullable Set.new([ :share_count, :impression_paid_count, :reach_paid_count, :additional_info ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/phyllo/models/content1_engagement.rb', line 95 def self.openapi_types { like_count: :Integer, dislike_count: :Integer, comment_count: :Integer, impression_organic_count: :Integer, reach_organic_count: :Integer, save_count: :Integer, view_count: :Integer, watch_time_in_hours: :Float, share_count: :Integer, impression_paid_count: :Integer, reach_paid_count: :Integer, email_open_rate: :Float, email_click_rate: :Float, unsubscribe_count: :Integer, spam_report_count: :Integer, click_count: :Integer, additional_info: :Content1EngagementAdditionalInfo } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/phyllo/models/content1_engagement.rb', line 227 def ==(other) return true if equal?(other) self.class == other.class && like_count == other.like_count && dislike_count == other.dislike_count && comment_count == other.comment_count && impression_organic_count == other.impression_organic_count && reach_organic_count == other.reach_organic_count && save_count == other.save_count && view_count == other.view_count && watch_time_in_hours == other.watch_time_in_hours && share_count == other.share_count && impression_paid_count == other.impression_paid_count && reach_paid_count == other.reach_paid_count && email_open_rate == other.email_open_rate && email_click_rate == other.email_click_rate && unsubscribe_count == other.unsubscribe_count && spam_report_count == other.spam_report_count && click_count == other.click_count && additional_info == other.additional_info end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
359 360 361 362 363 364 365 366 367 368 369 370 371 |
# File 'lib/phyllo/models/content1_engagement.rb', line 359 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#eql?(other) ⇒ Boolean
251 252 253 |
# File 'lib/phyllo/models/content1_engagement.rb', line 251 def eql?(other) self == other end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
257 258 259 |
# File 'lib/phyllo/models/content1_engagement.rb', line 257 def hash [like_count, dislike_count, comment_count, impression_organic_count, reach_organic_count, save_count, view_count, watch_time_in_hours, share_count, impression_paid_count, reach_paid_count, email_open_rate, email_click_rate, unsubscribe_count, spam_report_count, click_count, additional_info].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
213 214 215 216 |
# File 'lib/phyllo/models/content1_engagement.rb', line 213 def list_invalid_properties warn "[DEPRECATED] the `list_invalid_properties` method is obsolete" [] end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
335 336 337 |
# File 'lib/phyllo/models/content1_engagement.rb', line 335 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
341 342 343 344 345 346 347 348 349 350 351 352 353 |
# File 'lib/phyllo/models/content1_engagement.rb', line 341 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = 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 |
#to_s ⇒ String
Returns the string representation of the object
329 330 331 |
# File 'lib/phyllo/models/content1_engagement.rb', line 329 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
220 221 222 223 |
# File 'lib/phyllo/models/content1_engagement.rb', line 220 def valid? warn "[DEPRECATED] the `valid?` method is obsolete" true end |