Class: LessonlyApi::ResourceType::User

Inherits:

Base

• Object
• Base
• LessonlyApi::ResourceType::User

Defined in:

lib/lessonly_api/resource_type/user.rb

Overview

Class represents API response as a Ruby object.

Instance Method Summary

• #archived_at ⇒ DateTime

  Timestamp of the user’s archiving.

• #archived_by_user_id ⇒ Inteher

  ID of a user who archived the given user.

• #business_unit ⇒ String

  Business unit the user.

• #custom_user_field_data ⇒ Array

  Array of hashes with custom fields.

• #department ⇒ String

  Name of the user’s department.

• #email ⇒ String

  An email of the user.

• #ext_uid ⇒ String

  External ID of the user.

• #groups ⇒ ResourceType::UserGroup

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

• #hire_date ⇒ Date

  Date of the user’s hire.

• #id ⇒ Integer

  ID of the user.

• #job_title ⇒ String

  Title of the user’s job.

• #locale ⇒ String

  Locale of the user.

• #location ⇒ String

  Location of the user.

• #manager_name ⇒ String

  Name of the user’s manager.

• #mobile_phone_number ⇒ String

  Phone number of the user.

• #name ⇒ String

  A name of the user.

• #resource_type ⇒ String

  Type of the resource.

• #role ⇒ String

  A role of the user.

• #role_id ⇒ Integer

  ID of a user’s role.

• #type ⇒ String

  Type of the resource.

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

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

#archived_by_user_id ⇒ Inteher

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

#business_unit ⇒ String

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

#custom_user_field_data ⇒ Array

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

#department ⇒ String

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

#email ⇒ String

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

#ext_uid ⇒ String

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

#groups ⇒ ResourceType::UserGroup

# 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

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

#id ⇒ Integer

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

#job_title ⇒ String

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

#locale ⇒ String

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

#location ⇒ String

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

#manager_name ⇒ String

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

#mobile_phone_number ⇒ String

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

#name ⇒ String

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

#resource_type ⇒ String

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

#role ⇒ String

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

#role_id ⇒ Integer

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

#type ⇒ String

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