Class: Phyllo::Account
- Inherits:
-
Object
- Object
- Phyllo::Account
- Defined in:
- lib/phyllo/models/account.rb
Overview
Represents work platform accounts that your users link via Phyllo. Once a user connects a work platform account from the Connect SDK then an account object is created for the user.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#created_at ⇒ Object
Account creation time (UTC date and time in ISO 8601 format).
-
#data ⇒ Object
Returns the value of attribute data.
-
#id ⇒ Object
Unique ID of the connected account.
-
#platform_profile_id ⇒ Object
Unique profile ID of the user on the work platform.
-
#platform_profile_name ⇒ Object
User’s profile name on the work platform.
-
#platform_profile_published_at ⇒ Object
Timestamp when the profile was created on the platform.
-
#platform_username ⇒ Object
Username of the connected account.
-
#profile_pic_url ⇒ Object
URL of the user’s profile image from the work platform.
-
#status ⇒ Object
Account connection status.
-
#updated_at ⇒ Object
Account updation time (UTC date and time in ISO 8601 format).
-
#user ⇒ Object
Returns the value of attribute user.
-
#work_platform ⇒ Object
Returns the value of attribute work_platform.
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 = {}) ⇒ Account
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 = {}) ⇒ Account
Initializes the object
124 125 126 127 128 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 |
# File 'lib/phyllo/models/account.rb', line 124 def initialize(attributes = {}) if !attributes.is_a?(Hash) fail ArgumentError, "The input argument (attributes) must be a hash in `Phyllo::Account` 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::Account`. 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 } self.id = if attributes.key?(:id) attributes[:id] end self.created_at = if attributes.key?(:created_at) attributes[:created_at] end self.updated_at = if attributes.key?(:updated_at) attributes[:updated_at] end self.user = if attributes.key?(:user) attributes[:user] end self.work_platform = if attributes.key?(:work_platform) attributes[:work_platform] end self.platform_username = if attributes.key?(:platform_username) attributes[:platform_username] end if attributes.key?(:profile_pic_url) self.profile_pic_url = attributes[:profile_pic_url] end self.status = if attributes.key?(:status) attributes[:status] end self.platform_profile_name = if attributes.key?(:platform_profile_name) attributes[:platform_profile_name] end self.platform_profile_id = if attributes.key?(:platform_profile_id) attributes[:platform_profile_id] end if attributes.key?(:platform_profile_published_at) self.platform_profile_published_at = attributes[:platform_profile_published_at] end self.data = if attributes.key?(:data) attributes[:data] end end |
Instance Attribute Details
#created_at ⇒ Object
Account creation time (UTC date and time in ISO 8601 format)
21 22 23 |
# File 'lib/phyllo/models/account.rb', line 21 def created_at @created_at end |
#data ⇒ Object
Returns the value of attribute data.
48 49 50 |
# File 'lib/phyllo/models/account.rb', line 48 def data @data end |
#id ⇒ Object
Unique ID of the connected account.
18 19 20 |
# File 'lib/phyllo/models/account.rb', line 18 def id @id end |
#platform_profile_id ⇒ Object
Unique profile ID of the user on the work platform. Ex - For YouTube it’s the channel ID and for Instagram it’s the Instagram page ID.
43 44 45 |
# File 'lib/phyllo/models/account.rb', line 43 def platform_profile_id @platform_profile_id end |
#platform_profile_name ⇒ Object
User’s profile name on the work platform. This is not unique, is displayed prominently on the profile, usually editable and is most commonly associated with that user’s identity on the platform. Ex - For YouTube, it’s the channel name displayed on the channel page and for Instagram / Twitter / TikTok etc, it’s the name displayed on the user’s profile page.
40 41 42 |
# File 'lib/phyllo/models/account.rb', line 40 def platform_profile_name @platform_profile_name end |
#platform_profile_published_at ⇒ Object
Timestamp when the profile was created on the platform.
46 47 48 |
# File 'lib/phyllo/models/account.rb', line 46 def platform_profile_published_at @platform_profile_published_at end |
#platform_username ⇒ Object
Username of the connected account. This is used to uniquely identify a user on any platform and usually the name that is present in the URLs, used to tag a user etc. Ex - For YouTube, it’s the channel name in the URL and for Instagram / Twitter / TikTok etc, it’s the handle.
31 32 33 |
# File 'lib/phyllo/models/account.rb', line 31 def platform_username @platform_username end |
#profile_pic_url ⇒ Object
URL of the user’s profile image from the work platform.
34 35 36 |
# File 'lib/phyllo/models/account.rb', line 34 def profile_pic_url @profile_pic_url end |
#status ⇒ Object
Account connection status.
37 38 39 |
# File 'lib/phyllo/models/account.rb', line 37 def status @status end |
#updated_at ⇒ Object
Account updation time (UTC date and time in ISO 8601 format)
24 25 26 |
# File 'lib/phyllo/models/account.rb', line 24 def updated_at @updated_at end |
#user ⇒ Object
Returns the value of attribute user.
26 27 28 |
# File 'lib/phyllo/models/account.rb', line 26 def user @user end |
#work_platform ⇒ Object
Returns the value of attribute work_platform.
28 29 30 |
# File 'lib/phyllo/models/account.rb', line 28 def work_platform @work_platform end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 |
# File 'lib/phyllo/models/account.rb', line 316 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
91 92 93 |
# File 'lib/phyllo/models/account.rb', line 91 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/phyllo/models/account.rb', line 73 def self.attribute_map { id: :id, created_at: :created_at, updated_at: :updated_at, user: :user, work_platform: :work_platform, platform_username: :platform_username, profile_pic_url: :profile_pic_url, status: :status, platform_profile_name: :platform_profile_name, platform_profile_id: :platform_profile_id, platform_profile_published_at: :platform_profile_published_at, data: :data } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 |
# File 'lib/phyllo/models/account.rb', line 292 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
114 115 116 117 118 119 120 |
# File 'lib/phyllo/models/account.rb', line 114 def self.openapi_nullable Set.new([ :platform_username, :profile_pic_url, :platform_profile_published_at ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'lib/phyllo/models/account.rb', line 96 def self.openapi_types { id: :String, created_at: :Time, updated_at: :Time, user: :UserAttribute1, work_platform: :WorkPlatformAttribute1, platform_username: :String, profile_pic_url: :String, status: :String, platform_profile_name: :String, platform_profile_id: :String, platform_profile_published_at: :Time, data: :Account1Data } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/phyllo/models/account.rb', line 260 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && created_at == other.created_at && updated_at == other.updated_at && user == other.user && work_platform == other.work_platform && platform_username == other.platform_username && profile_pic_url == other.profile_pic_url && status == other.status && platform_profile_name == other.platform_profile_name && platform_profile_id == other.platform_profile_id && platform_profile_published_at == other.platform_profile_published_at && data == other.data end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
387 388 389 390 391 392 393 394 395 396 397 398 399 |
# File 'lib/phyllo/models/account.rb', line 387 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
279 280 281 |
# File 'lib/phyllo/models/account.rb', line 279 def eql?(other) self == other end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
285 286 287 |
# File 'lib/phyllo/models/account.rb', line 285 def hash [id, created_at, updated_at, user, work_platform, platform_username, profile_pic_url, status, platform_profile_name, platform_profile_id, platform_profile_published_at, data].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
# File 'lib/phyllo/models/account.rb', line 188 def list_invalid_properties warn "[DEPRECATED] the `list_invalid_properties` method is obsolete" invalid_properties = [] if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @created_at.nil? invalid_properties.push('invalid value for "created_at", created_at cannot be nil.') end if @updated_at.nil? invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.') end if @user.nil? invalid_properties.push('invalid value for "user", user cannot be nil.') end if @work_platform.nil? invalid_properties.push('invalid value for "work_platform", work_platform cannot be nil.') end if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end if @platform_profile_name.nil? invalid_properties.push('invalid value for "platform_profile_name", platform_profile_name cannot be nil.') end if @platform_profile_id.nil? invalid_properties.push('invalid value for "platform_profile_id", platform_profile_id cannot be nil.') end if @data.nil? invalid_properties.push('invalid value for "data", data cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
363 364 365 |
# File 'lib/phyllo/models/account.rb', line 363 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
369 370 371 372 373 374 375 376 377 378 379 380 381 |
# File 'lib/phyllo/models/account.rb', line 369 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
357 358 359 |
# File 'lib/phyllo/models/account.rb', line 357 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 |
# File 'lib/phyllo/models/account.rb', line 232 def valid? warn "[DEPRECATED] the `valid?` method is obsolete" return false if @id.nil? return false if @created_at.nil? return false if @updated_at.nil? return false if @user.nil? return false if @work_platform.nil? return false if @status.nil? status_validator = EnumAttributeValidator.new("String", ["CONNECTED", "NOT_CONNECTED", "SESSION_EXPIRED"]) return false unless status_validator.valid?(@status) return false if @platform_profile_name.nil? return false if @platform_profile_id.nil? return false if @data.nil? true end |