Class: LessonlyApi::ResourceType::User

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

Overview

Class represents API response as a Ruby object.

Instance Method Summary collapse

Methods inherited from Base

#attributes, dump, fields, from_json, #initialize, load

Constructor Details

This class inherits a constructor from LessonlyApi::ResourceType::Base

Instance Method Details

#archived_at ⇒ DateTime

Returns timestamp of the user’s archiving.

Returns:

  • (DateTime) —

    timestamp of the user’s archiving




# File 'lib/lessonly_api/resource_type/user.rb', line 29

#archived_by_user_id ⇒ Inteher

Returns ID of a user who archived the given user.

Returns:

  • (Inteher) —

    ID of a user who archived the given user




# File 'lib/lessonly_api/resource_type/user.rb', line 32

#business_unit ⇒ String

Returns business unit the user.

Returns:

  • (String) —

    business unit the user




# File 'lib/lessonly_api/resource_type/user.rb', line 38

#custom_user_field_data ⇒ Array

Returns array of hashes with custom fields.

Returns:

  • (Array) —

    array of hashes with custom fields




# File 'lib/lessonly_api/resource_type/user.rb', line 59

#department ⇒ String

Returns name of the user’s department.

Returns:

  • (String) —

    name of the user’s department




# File 'lib/lessonly_api/resource_type/user.rb', line 41

#email ⇒ String

Returns an email of the user.

Returns:

  • (String) —

    an email of the user




# File 'lib/lessonly_api/resource_type/user.rb', line 17

#ext_uid ⇒ String

Returns external ID of the user.

Returns:

  • (String) —

    external ID of the user




# File 'lib/lessonly_api/resource_type/user.rb', line 14

#groups ⇒ ResourceType::UserGroup

Returns the list of a user’s group memberships and groups the user is managing.

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/lessonly_api/resource_type/user.rb', line 65

fields(
  :id,
  :resource_type,
  :type,
  :ext_uid,
  :email,
  :name,
  :role,
  :role_id,
  {archived_at: :date_time},
  :archived_by_user_id,
  :job_title,
  :business_unit,
  :department,
  :location,
  :locale,
  {hire_date: :date},
  :manager_name,
  :mobile_phone_number,
  :custom_user_field_data,
  {groups: :user_group}
)

#hire_date ⇒ Date

Returns date of the user’s hire.

Returns:

  • (Date) —

    date of the user’s hire




# File 'lib/lessonly_api/resource_type/user.rb', line 50

#id ⇒ Integer

Returns ID of the user.

Returns:

  • (Integer) —

    ID of the user




# File 'lib/lessonly_api/resource_type/user.rb', line 5

#job_title ⇒ String

Returns title of the user’s job.

Returns:

  • (String) —

    title of the user’s job




# File 'lib/lessonly_api/resource_type/user.rb', line 35

#locale ⇒ String

Returns locale of the user.

Returns:

  • (String) —

    locale of the user




# File 'lib/lessonly_api/resource_type/user.rb', line 47

#location ⇒ String

Returns location of the user.

Returns:

  • (String) —

    location of the user




# File 'lib/lessonly_api/resource_type/user.rb', line 44

#manager_name ⇒ String

Returns name of the user’s manager.

Returns:

  • (String) —

    name of the user’s manager




# File 'lib/lessonly_api/resource_type/user.rb', line 53

#mobile_phone_number ⇒ String

Returns phone number of the user.

Returns:

  • (String) —

    phone number of the user




# File 'lib/lessonly_api/resource_type/user.rb', line 56

#name ⇒ String

Returns a name of the user.

Returns:

  • (String) —

    a name of the user




# File 'lib/lessonly_api/resource_type/user.rb', line 20

#resource_type ⇒ String

Returns type of the resource.

Returns:

  • (String) —

    type of the resource




# File 'lib/lessonly_api/resource_type/user.rb', line 8

#role ⇒ String

Returns a role of the user.

Returns:

  • (String) —

    a role of the user




# File 'lib/lessonly_api/resource_type/user.rb', line 23

#role_id ⇒ Integer

Returns ID of a user’s role.

Returns:

  • (Integer) —

    ID of a user’s role




# File 'lib/lessonly_api/resource_type/user.rb', line 26

#type ⇒ String

Returns type of the resource.

Returns:

  • (String) —

    type of the resource




# File 'lib/lessonly_api/resource_type/user.rb', line 11