README.md

Lms

(lms)

Overview

Available Operations

• create_lms_class - Create a class
• create_lms_course - Create a course
• create_lms_instructor - Create an instructor
• create_lms_student - Create a student
• get_lms_class - Retrieve a class
• get_lms_course - Retrieve a course
• get_lms_instructor - Retrieve an instructor
• get_lms_student - Retrieve a student
• list_lms_classes - List all classes
• list_lms_courses - List all courses
• list_lms_instructors - List all instructors
• list_lms_students - List all students
• patch_lms_class - Update a class
• patch_lms_course - Update a course
• patch_lms_instructor - Update an instructor
• patch_lms_student - Update a student
• remove_lms_class - Remove a class
• remove_lms_course - Remove a course
• remove_lms_instructor - Remove an instructor
• remove_lms_student - Remove a student
• update_lms_class - Update a class
• update_lms_course - Update a course
• update_lms_instructor - Update an instructor
• update_lms_student - Update a student

create_lms_class

Create a class

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.create_lms_class(connection_id="<id>", lms_class=::UnifiedRubySDK::Shared::LmsClass.new(
  course_id: "<id>",
  name: "<value>",
), fields_=[
  "<value>",
])

if ! res.lms_class.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
lms_class	T.nilable(::UnifiedRubySDK::Shared::LmsClass)	➖	N/A
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreateLmsClassResponse)

create_lms_course

Create a course

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.create_lms_course(connection_id="<id>", lms_course=::UnifiedRubySDK::Shared::LmsCourse.new(
  name: "<value>",
), fields_=[
  "<value>",
])

if ! res.lms_course.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
lms_course	T.nilable(::UnifiedRubySDK::Shared::LmsCourse)	➖	N/A
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreateLmsCourseResponse)

create_lms_instructor

Create an instructor

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.create_lms_instructor(connection_id="<id>", lms_instructor=::UnifiedRubySDK::Shared::LmsInstructor.new(), fields_=[
  "<value>",
])

if ! res.lms_instructor.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
lms_instructor	T.nilable(::UnifiedRubySDK::Shared::LmsInstructor)	➖	N/A
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreateLmsInstructorResponse)

create_lms_student

Create a student

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.create_lms_student(connection_id="<id>", lms_student=::UnifiedRubySDK::Shared::LmsStudent.new(), fields_=[
  "<value>",
])

if ! res.lms_student.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
lms_student	T.nilable(::UnifiedRubySDK::Shared::LmsStudent)	➖	N/A
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreateLmsStudentResponse)

get_lms_class

Retrieve a class

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.get_lms_class(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.lms_class.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Class
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetLmsClassResponse)

get_lms_course

Retrieve a course

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.get_lms_course(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.lms_course.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Course
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetLmsCourseResponse)

get_lms_instructor

Retrieve an instructor

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.get_lms_instructor(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.lms_instructor.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Instructor
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetLmsInstructorResponse)

get_lms_student

Retrieve a student

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.get_lms_student(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.lms_student.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Student
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetLmsStudentResponse)

list_lms_classes

List all classes

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListLmsClassesRequest.new(
  connection_id: "<id>",
)
    
res = s.lms.list_lms_classes(req)

if ! res.lms_classes.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::UnifiedRubySDK::Operations::ListLmsClassesRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListLmsClassesResponse)

list_lms_courses

List all courses

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListLmsCoursesRequest.new(
  connection_id: "<id>",
)
    
res = s.lms.list_lms_courses(req)

if ! res.lms_courses.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::UnifiedRubySDK::Operations::ListLmsCoursesRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListLmsCoursesResponse)

list_lms_instructors

List all instructors

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListLmsInstructorsRequest.new(
  connection_id: "<id>",
)
    
res = s.lms.list_lms_instructors(req)

if ! res.lms_instructors.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::UnifiedRubySDK::Operations::ListLmsInstructorsRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListLmsInstructorsResponse)

list_lms_students

List all students

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListLmsStudentsRequest.new(
  connection_id: "<id>",
)
    
res = s.lms.list_lms_students(req)

if ! res.lms_students.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	::UnifiedRubySDK::Operations::ListLmsStudentsRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListLmsStudentsResponse)

patch_lms_class

Update a class

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.patch_lms_class(connection_id="<id>", id="<id>", lms_class=::UnifiedRubySDK::Shared::LmsClass.new(
  course_id: "<id>",
  name: "<value>",
), fields_=[
  "<value>",
])

if ! res.lms_class.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Class
lms_class	T.nilable(::UnifiedRubySDK::Shared::LmsClass)	➖	N/A
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchLmsClassResponse)

patch_lms_course

Update a course

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.patch_lms_course(connection_id="<id>", id="<id>", lms_course=::UnifiedRubySDK::Shared::LmsCourse.new(
  name: "<value>",
), fields_=[
  "<value>",
])

if ! res.lms_course.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Course
lms_course	T.nilable(::UnifiedRubySDK::Shared::LmsCourse)	➖	N/A
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchLmsCourseResponse)

patch_lms_instructor

Update an instructor

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.patch_lms_instructor(connection_id="<id>", id="<id>", lms_instructor=::UnifiedRubySDK::Shared::LmsInstructor.new(), fields_=[
  "<value>",
])

if ! res.lms_instructor.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Instructor
lms_instructor	T.nilable(::UnifiedRubySDK::Shared::LmsInstructor)	➖	N/A
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchLmsInstructorResponse)

patch_lms_student

Update a student

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.patch_lms_student(connection_id="<id>", id="<id>", lms_student=::UnifiedRubySDK::Shared::LmsStudent.new(), fields_=[
  "<value>",
])

if ! res.lms_student.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Student
lms_student	T.nilable(::UnifiedRubySDK::Shared::LmsStudent)	➖	N/A
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchLmsStudentResponse)

remove_lms_class

Remove a class

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.remove_lms_class(connection_id="<id>", id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Class

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveLmsClassResponse)

remove_lms_course

Remove a course

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.remove_lms_course(connection_id="<id>", id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Course

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveLmsCourseResponse)

remove_lms_instructor

Remove an instructor

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.remove_lms_instructor(connection_id="<id>", id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Instructor

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveLmsInstructorResponse)

remove_lms_student

Remove a student

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.remove_lms_student(connection_id="<id>", id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Student

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveLmsStudentResponse)

update_lms_class

Update a class

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.update_lms_class(connection_id="<id>", id="<id>", lms_class=::UnifiedRubySDK::Shared::LmsClass.new(
  course_id: "<id>",
  name: "<value>",
), fields_=[
  "<value>",
])

if ! res.lms_class.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Class
lms_class	T.nilable(::UnifiedRubySDK::Shared::LmsClass)	➖	N/A
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateLmsClassResponse)

update_lms_course

Update a course

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.update_lms_course(connection_id="<id>", id="<id>", lms_course=::UnifiedRubySDK::Shared::LmsCourse.new(
  name: "<value>",
), fields_=[
  "<value>",
])

if ! res.lms_course.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Course
lms_course	T.nilable(::UnifiedRubySDK::Shared::LmsCourse)	➖	N/A
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateLmsCourseResponse)

update_lms_instructor

Update an instructor

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.update_lms_instructor(connection_id="<id>", id="<id>", lms_instructor=::UnifiedRubySDK::Shared::LmsInstructor.new(), fields_=[
  "<value>",
])

if ! res.lms_instructor.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Instructor
lms_instructor	T.nilable(::UnifiedRubySDK::Shared::LmsInstructor)	➖	N/A
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateLmsInstructorResponse)

update_lms_student

Update a student

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.lms.update_lms_student(connection_id="<id>", id="<id>", lms_student=::UnifiedRubySDK::Shared::LmsStudent.new(), fields_=[
  "<value>",
])

if ! res.lms_student.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
connection_id	::String	✔️	ID of the connection
id	::String	✔️	ID of the Student
lms_student	T.nilable(::UnifiedRubySDK::Shared::LmsStudent)	➖	N/A
fields_	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateLmsStudentResponse)