Class: Figo::User

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

Overview

Object representing an User

Instance Attribute Summary collapse

Method Summary

Methods inherited from Base

#dump, dump_attributes, #initialize

Constructor Details

This class inherits a constructor from Figo::Base

Instance Attribute Details

#addressDict

Postal address for bills, etc.

Returns:

  • (Dict)


98
99
100
# File 'lib/models.rb', line 98

def address
  @address
end

#emailString

Email address

Returns:

  • (String)


94
95
96
# File 'lib/models.rb', line 94

def email
  @email
end

#join_dateDateTime

Timestamp of figo Account registration

Returns:

  • (DateTime)


126
127
128
# File 'lib/models.rb', line 126

def join_date
  @join_date
end

#languageString

Two-letter code of preferred language

Returns:

  • (String)


110
111
112
# File 'lib/models.rb', line 110

def language
  @language
end

#nameString

First and last name

Returns:

  • (String)


90
91
92
# File 'lib/models.rb', line 90

def name
  @name
end

#premiumBoolean

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

Returns:

  • (Boolean)


114
115
116
# File 'lib/models.rb', line 114

def premium
  @premium
end

#premium_expires_onDateTime

Timestamp of premium figo Account expiry

Returns:

  • (DateTime)


118
119
120
# File 'lib/models.rb', line 118

def premium_expires_on
  @premium_expires_on
end

#premium_subscriptionString

Provider for premium subscription or Null of no subscription is active

Returns:

  • (String)


122
123
124
# File 'lib/models.rb', line 122

def premium_subscription
  @premium_subscription
end

#send_newsletterBoolean

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

Returns:

  • (Boolean)


106
107
108
# File 'lib/models.rb', line 106

def send_newsletter
  @send_newsletter
end

#User_idString

Internal figo Connect User ID

Returns:

  • (String)


86
87
88
# File 'lib/models.rb', line 86

def User_id
  @User_id
end

#verified_emailBoolean

This flag indicates whether the email address has been verified

Returns:

  • (Boolean)


102
103
104
# File 'lib/models.rb', line 102

def verified_email
  @verified_email
end