CourseApiClientInterface

Methods

changeCourseCover()

changeCourseCover(id, data, config?): Promise<SCCourseType>

Parameters

Parameter	Type
id	string | number
data	FormData
config?	AxiosRequestConfig

Returns

Promise<SCCourseType>

---

changeCourseUserRole()

changeCourseUserRole(id, data, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
data	CourseUserRoleParams
config?	AxiosRequestConfig

Returns

Promise<any>

---

createCourse()

createCourse(data, config?): Promise<SCCourseType>

Parameters

Parameter	Type
data	CourseCreateParams | FormData
config?	AxiosRequestConfig

Returns

Promise<SCCourseType>

---

createCourseComment()

createCourseComment(id, section_id, lesson_id, data, config?): Promise<SCCourseCommentType>

Parameters

Parameter	Type
id	string | number
section_id	string | number
lesson_id	string | number
data	SCCourseCommentType
config?	AxiosRequestConfig

Returns

Promise<SCCourseCommentType>

---

createCourseLesson()

createCourseLesson(data, config?): Promise<SCCourseLessonType>

Parameters

Parameter	Type
data	SCCourseLessonType
config?	AxiosRequestConfig

Returns

Promise<SCCourseLessonType>

---

createCourseSection()

createCourseSection(id, data, config?): Promise<SCCourseSectionType>

Parameters

Parameter	Type
id	string | number
data	CourseSectionParams
config?	AxiosRequestConfig

Returns

Promise<SCCourseSectionType>

---

deleteCourse()

deleteCourse(id, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

deleteCourseComment()

deleteCourseComment(id, section_id, lesson_id, comment_id, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
section_id	string | number
lesson_id	string | number
comment_id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

deleteCourseLesson()

deleteCourseLesson(id, section_id, lesson_id, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
section_id	string | number
lesson_id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

deleteCourseSection()

deleteCourseSection(id, section_id, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
section_id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

getCourseComments()

getCourseComments(id, course_id, config?): Promise<SCPaginatedResponse<SCCourseCommentType>>

Parameters

Parameter	Type
id	string | number
course_id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCCourseCommentType>>

---

getCourseDashboardUsers()

getCourseDashboardUsers(id, params?, config?): Promise<SCPaginatedResponse<SCUserType>>

Parameters

Parameter	Type
id	string | number
params?	CourseDashboardUsersParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getCourseInvitedUsers()

getCourseInvitedUsers(id, params?, config?): Promise<SCPaginatedResponse<SCUserType>>

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getCourseJoinedUsers()

getCourseJoinedUsers(id, params?, config?): Promise<SCPaginatedResponse<SCUserType>>

Parameters

Parameter	Type
id	string | number
params?	CourseUsersParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getCourseLesson()

getCourseLesson(id, section_id, lesson_id, config?): Promise<SCCourseLessonType>

Parameters

Parameter	Type
id	string | number
section_id	string | number
lesson_id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCCourseLessonType>

---

getCourseLessonComment()

getCourseLessonComment(id, section_id, lesson_id, comment_id, config?): Promise<SCCourseCommentType>

Parameters

Parameter	Type
id	string | number
section_id	string | number
lesson_id	string | number
comment_id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCCourseCommentType>

---

getCourseLessonComments()

getCourseLessonComments(id, section_id, lesson_id, params?, config?): Promise<SCCourseCommentType[]>

Parameters

Parameter	Type
id	string | number
section_id	string | number
lesson_id	string | number
params?	CourseLessonCommentsParams
config?	AxiosRequestConfig

Returns

Promise<SCCourseCommentType[]>

---

getCourseLessons()

getCourseLessons(id, section_id, config?): Promise<SCCourseLessonType[]>

Parameters

Parameter	Type
id	string | number
section_id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCCourseLessonType[]>

---

getCourseSection()

getCourseSection(id, section_id, config?): Promise<SCCourseSectionType>

Parameters

Parameter	Type
id	string | number
section_id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCCourseSectionType>

---

getCourseSections()

getCourseSections(id, config?): Promise<SCCourseSectionType[]>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCCourseSectionType[]>

---

getCourseStatus()

getCourseStatus(id, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

getCourseSuggestedUsers()

getCourseSuggestedUsers(id, search, config?): Promise<SCPaginatedResponse<SCUserType>>

Parameters

Parameter	Type
id	string | number
search	string
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getCourseWaitingApproval()

getCourseWaitingApproval(id, params?, config?): Promise<SCPaginatedResponse<SCUserType>>

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getJoinedCourses()

getJoinedCourses(params?, config?): Promise<SCPaginatedResponse<SCCourseType>>

Parameters

Parameter	Type
params?	CourseUserParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCCourseType>>

---

getSpecificCourseInfo()

getSpecificCourseInfo(id, params?, config?): Promise<SCCourseType>

Parameters

Parameter	Type
id	string | number
params?	CourseInfoParams
config?	AxiosRequestConfig

Returns

Promise<SCCourseType>

---

getUserJoinedCourses()

getUserJoinedCourses(id, params?, config?): Promise<SCPaginatedResponse<SCCourseType>>

Parameters

Parameter	Type
id	string | number
params?	CourseUsersParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCCourseType>>

---

inviteOrAcceptUsersToCourse()

inviteOrAcceptUsersToCourse(id, data, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
data	{ users: number[]; }
data.users	number[]
config?	AxiosRequestConfig

Returns

Promise<any>

---

joinOrAcceptInviteToCourse()

joinOrAcceptInviteToCourse(id, config?): Promise<SCCourseType>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCCourseType>

---

leaveOrRemoveCourseRequest()

leaveOrRemoveCourseRequest(id, params?, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
params?	{ user: number; }
params.user?	number
config?	AxiosRequestConfig

Returns

Promise<any>

---

markLessonComplete()

markLessonComplete(id, section_id, lesson_id, data, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
section_id	string | number
lesson_id	string | number
data	SCCourseLessonType
config?	AxiosRequestConfig

Returns

Promise<any>

---

markLessonInComplete()

markLessonInComplete(id, section_id, lesson_id, data, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
section_id	string | number
lesson_id	string | number
data	SCCourseLessonType
config?	AxiosRequestConfig

Returns

Promise<any>

---

patchCourse()

patchCourse(id, data, config?): Promise<SCCourseType>

Parameters

Parameter	Type
id	string | number
data	Partial<SCCourseType> | FormData
config?	AxiosRequestConfig

Returns

Promise<SCCourseType>

---

patchCourseComment()

patchCourseComment(id, section_id, lesson_id, comment_id, data, config?): Promise<SCCourseCommentType>

Parameters

Parameter	Type
id	string | number
section_id	string | number
lesson_id	string | number
comment_id	string | number
data	SCCourseLessonType
config?	AxiosRequestConfig

Returns

Promise<SCCourseCommentType>

---

patchCourseLesson()

patchCourseLesson(id, section_id, lesson_id, data, config?): Promise<SCCourseLessonType>

Parameters

Parameter	Type
id	string | number
section_id	string | number
lesson_id	string | number
data	Partial<SCCourseLessonType>
config?	AxiosRequestConfig

Returns

Promise<SCCourseLessonType>

---

patchCourseSection()

patchCourseSection(id, section_id, data, config?): Promise<SCCourseSectionType>

Parameters

Parameter	Type
id	string | number
section_id	string | number
data	SCCourseSectionType
config?	AxiosRequestConfig

Returns

Promise<SCCourseSectionType>

---

removeInvitationToCourse()

removeInvitationToCourse(id, data, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
data	{ users: number[]; }
data.users	number[]
config?	AxiosRequestConfig

Returns

Promise<any>

---

searchCourses()

searchCourses(params?, config?): Promise<SCPaginatedResponse<SCCourseType>>

Parameters

Parameter	Type
params?	CourseSearchParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCCourseType>>

---

updateCourse()

updateCourse(id, data, config?): Promise<SCCourseType>

Parameters

Parameter	Type
id	string | number
data	SCCourseType | FormData
config?	AxiosRequestConfig

Returns

Promise<SCCourseType>

---

updateCourseComment()

updateCourseComment(id, section_id, lesson_id, comment_id, data, config?): Promise<SCCourseCommentType>

Parameters

Parameter	Type
id	string | number
section_id	string | number
lesson_id	string | number
comment_id	string | number
data	SCCourseCommentType
config?	AxiosRequestConfig

Returns

Promise<SCCourseCommentType>

---

updateCourseLesson()

updateCourseLesson(id, section_id, lesson_id, data, config?): Promise<SCCourseLessonType>

Parameters

Parameter	Type
id	string | number
section_id	string | number
lesson_id	string | number
data	SCCourseLessonType
config?	AxiosRequestConfig

Returns

Promise<SCCourseLessonType>

---

updateCourseSection()

updateCourseSection(id, section_id, data, config?): Promise<SCCourseSectionType>

Parameters

Parameter	Type
id	string | number
section_id	string | number
data	SCCourseSectionType
config?	AxiosRequestConfig

Returns

Promise<SCCourseSectionType>