Class: Phyllo::Profile1Reputation
- Inherits:
-
Object
- Object
- Phyllo::Profile1Reputation
- Defined in:
- lib/phyllo/models/profile1_reputation.rb
Overview
Profile reputation object.
Instance Attribute Summary collapse
-
#average_click_rate ⇒ Object
The historical average clickthrough rate of the publication as percentage.
-
#average_open_rate ⇒ Object
The historical average open rate of the publication as percentage.
-
#content_count ⇒ Object
Total number of content items (videos, images, posts etc).
-
#content_group_count ⇒ Object
Total number of content group items (playlists, albums, collections etc).
-
#follower_count ⇒ Object
Total number of followers of this profile.
-
#following_count ⇒ Object
Total number of profiles this profile is following.
-
#paid_subscriber_count ⇒ Object
Total number of paid/premium subscribers.
-
#subscriber_count ⇒ Object
Total number of free subscribers.
-
#watch_time_in_hours ⇒ Object
Total watch time in hours (available for YouTube).
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 = {}) ⇒ Profile1Reputation
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 = {}) ⇒ Profile1Reputation
Initializes the object
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 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 94 def initialize(attributes = {}) if !attributes.is_a?(Hash) fail ArgumentError, "The input argument (attributes) must be a hash in `Phyllo::Profile1Reputation` 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::Profile1Reputation`. 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?(:follower_count) self.follower_count = attributes[:follower_count] end if attributes.key?(:following_count) self.following_count = attributes[:following_count] end if attributes.key?(:subscriber_count) self.subscriber_count = attributes[:subscriber_count] end if attributes.key?(:paid_subscriber_count) self.paid_subscriber_count = attributes[:paid_subscriber_count] end if attributes.key?(:content_count) self.content_count = attributes[:content_count] end if attributes.key?(:content_group_count) self.content_group_count = attributes[:content_group_count] end if attributes.key?(:watch_time_in_hours) self.watch_time_in_hours = attributes[:watch_time_in_hours] end if attributes.key?(:average_open_rate) self.average_open_rate = attributes[:average_open_rate] end if attributes.key?(:average_click_rate) self.average_click_rate = attributes[:average_click_rate] end end |
Instance Attribute Details
#average_click_rate ⇒ Object
The historical average clickthrough rate of the publication as percentage.
42 43 44 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 42 def average_click_rate @average_click_rate end |
#average_open_rate ⇒ Object
The historical average open rate of the publication as percentage.
39 40 41 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 39 def average_open_rate @average_open_rate end |
#content_count ⇒ Object
Total number of content items (videos, images, posts etc).
30 31 32 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 30 def content_count @content_count end |
#content_group_count ⇒ Object
Total number of content group items (playlists, albums, collections etc).
33 34 35 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 33 def content_group_count @content_group_count end |
#follower_count ⇒ Object
Total number of followers of this profile.
18 19 20 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 18 def follower_count @follower_count end |
#following_count ⇒ Object
Total number of profiles this profile is following.
21 22 23 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 21 def following_count @following_count end |
#paid_subscriber_count ⇒ Object
Total number of paid/premium subscribers.
27 28 29 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 27 def paid_subscriber_count @paid_subscriber_count end |
#subscriber_count ⇒ Object
Total number of free subscribers.
24 25 26 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 24 def subscriber_count @subscriber_count end |
#watch_time_in_hours ⇒ Object
Total watch time in hours (available for YouTube).
36 37 38 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 36 def watch_time_in_hours @watch_time_in_hours end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 213 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
60 61 62 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 60 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
45 46 47 48 49 50 51 52 53 54 55 56 57 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 45 def self.attribute_map { follower_count: :follower_count, following_count: :following_count, subscriber_count: :subscriber_count, paid_subscriber_count: :paid_subscriber_count, content_count: :content_count, content_group_count: :content_group_count, watch_time_in_hours: :watch_time_in_hours, average_open_rate: :average_open_rate, average_click_rate: :average_click_rate } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 189 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
80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 80 def self.openapi_nullable Set.new([ :subscriber_count, :paid_subscriber_count, :content_count, :content_group_count, :watch_time_in_hours, :average_open_rate, :average_click_rate ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 65 def self.openapi_types { follower_count: :Integer, following_count: :Integer, subscriber_count: :Integer, paid_subscriber_count: :Integer, content_count: :Integer, content_group_count: :Integer, watch_time_in_hours: :Integer, average_open_rate: :Float, average_click_rate: :Float } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 160 def ==(other) return true if equal?(other) self.class == other.class && follower_count == other.follower_count && following_count == other.following_count && subscriber_count == other.subscriber_count && paid_subscriber_count == other.paid_subscriber_count && content_count == other.content_count && content_group_count == other.content_group_count && watch_time_in_hours == other.watch_time_in_hours && average_open_rate == other.average_open_rate && average_click_rate == other.average_click_rate end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
284 285 286 287 288 289 290 291 292 293 294 295 296 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 284 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
176 177 178 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 176 def eql?(other) self == other end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
182 183 184 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 182 def hash [follower_count, following_count, subscriber_count, paid_subscriber_count, content_count, content_group_count, watch_time_in_hours, average_open_rate, average_click_rate].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
146 147 148 149 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 146 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)
260 261 262 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 260 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
266 267 268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 266 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
254 255 256 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 254 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
153 154 155 156 |
# File 'lib/phyllo/models/profile1_reputation.rb', line 153 def valid? warn "[DEPRECATED] the `valid?` method is obsolete" true end |