Class: Figo::User

Inherits:
Base
  • Object
show all
Defined in:
lib/user/model.rb

Overview

Object representing an User

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#dump, dump_attributes

Constructor Details

#initialize(session, json) ⇒ User

Returns a new instance of User.



7
8
9
 
# File 'lib/user/model.rb', line 7

def initialize(session, json)
  super(session, json)
end

Instance Attribute Details

#address ⇒ Dict

Postal address for bills, etc.

Returns:

  • (Dict) 


25
26
27
 
# File 'lib/user/model.rb', line 25

def address
  @address
end

#email ⇒ String

Email address

Returns:

  • (String) 


21
22
23
 
# File 'lib/user/model.rb', line 21

def email
  @email
end

#join_date ⇒ DateTime

Timestamp of figo Account registration

Returns:

  • (DateTime) 


53
54
55
 
# File 'lib/user/model.rb', line 53

def join_date
  @join_date
end

#language ⇒ String

Two-letter code of preferred language

Returns:

  • (String) 


37
38
39
 
# File 'lib/user/model.rb', line 37

def language
  @language
end

#name ⇒ String

First and last name

Returns:

  • (String) 


17
18
19
 
# File 'lib/user/model.rb', line 17

def name
  @name
end

#premium ⇒ Boolean

This flag indicates whether the figo Account plan is free or premium

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/user/model.rb', line 41

def premium
  @premium
end

#premium_expires_on ⇒ DateTime

Timestamp of premium figo Account expiry

Returns:

  • (DateTime) 


45
46
47
 
# File 'lib/user/model.rb', line 45

def premium_expires_on
  @premium_expires_on
end

#premium_subscription ⇒ String

Provider for premium subscription or nil of no subscription is active

Returns:

  • (String) 


49
50
51
 
# File 'lib/user/model.rb', line 49

def premium_subscription
  @premium_subscription
end

#send_newsletter ⇒ Boolean

This flag indicates whether the User has agreed to be contacted by email

Returns:

  • (Boolean) 


33
34
35
 
# File 'lib/user/model.rb', line 33

def send_newsletter
  @send_newsletter
end

#User_id ⇒ String

Internal figo Connect User ID

Returns:

  • (String) 


13
14
15
 
# File 'lib/user/model.rb', line 13

def User_id
  @User_id
end

#verified_email ⇒ Boolean

This flag indicates whether the email address has been verified

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/user/model.rb', line 29

def verified_email
  @verified_email
end