Skip to main content
Module

x/gesso/src/mod.ts>Users

A TypeScript API client for Canvas LMS
Latest
class Users
extends BaseApi
import { Users } from "https://deno.land/x/gesso@v0.1.2/src/mod.ts";

Constructors

new
Users(config: Configuration)

Methods

activityStreamSummary(body?: unknown): Promise<Conversation>
clearCourseNicknames(body?: unknown): Promise<Scope>
createUser(
account_id: string,
params?: CreateUserParams,
body?: unknown,
): Promise<User>
deleteCustomData(
user_id: string,
params?: DeleteCustomDataParams,
body?: unknown,
): Promise<Scope>
deprecatedSelfRegisterUser(
account_id: string,
params?: deprecatedSelfRegisterUserParams,
body?: unknown,
): Promise<User>
editUser(
id: string,
params?: EditUserParams,
body?: unknown,
): Promise<User>
getCourseNickname(course_id: string, body?: unknown): Promise<Course>
getCustomColor(
id: string,
asset_string: string,
body?: unknown,
): Promise<unknown>
getCustomColors(id: string, body?: unknown): Promise<unknown>
getDashboardPositions(id: string, body?: unknown): Promise<unknown>
getPandataEventsJwtTokenItsExpirationDate(params?: GetPandataEventsJwtTokenItsExpirationDateParams, body?: unknown): Promise<unknown>
getUserProfile(user_id: string, body?: unknown): Promise<Profile>
getUsersMostRecentlyGradedSubmissions(id: string, body?: unknown): Promise<Scope>
hideAllStreamItems(body?: unknown): Promise<Scope>
hideStreamItem(id: string, body?: unknown): Promise<Scope>
listAvatarOptions(user_id: string, body?: unknown): Promise<Avatar[]>
listCountsForTodoItems(params?: ListCountsForTodoItemsParams, body?: unknown): Promise<Scope>
listCourseNicknames(body?: unknown): Promise<Course[]>
listMissingSubmissions(
user_id: string,
params?: ListMissingSubmissionsParams,
body?: unknown,
): Promise<Assignment[]>
listTheActivityStream(params?: ListTheActivityStreamParams, body?: unknown): Promise<Assignment>
listTheTodoItems(params?: ListTheTodoItemsParams, body?: unknown): Promise<Scope>
listUpcomingAssignmentsCalendarEvents(body?: unknown): Promise<Scope>
listUserPageViews(
user_id: string,
params?: ListUserPageViewsParams,
body?: unknown,
): Promise<Page[]>
listUsersInAccount(
account_id: string,
params?: ListUsersInAccountParams,
body?: unknown,
): Promise<User[]>
loadCustomData(
user_id: string,
params?: LoadCustomDataParams,
body?: unknown,
): Promise<Scope>
mergeUserIntoAnotherUser(
id: string,
destination_user_id: string,
body?: unknown,
): Promise<User>
removeCourseNickname(course_id: string, body?: unknown): Promise<Course>
setCourseNickname(
course_id: string,
params?: SetCourseNicknameParams,
body?: unknown,
): Promise<Course>
showUserDetails(
id: string,
params?: ShowUserDetailsParams,
body?: unknown,
): Promise<User>
splitMergedUsersIntoSeparateUsers(id: string, body?: unknown): Promise<User[]>
storeCustomData(
user_id: string,
params?: StoreCustomDataParams,
body?: unknown,
): Promise<Scope>
terminateAllUserSessions(id: string, body?: unknown): Promise<Scope>
updateCustomColor(
id: string,
asset_string: string,
params?: UpdateCustomColorParams,
body?: unknown,
): Promise<Scope>
updateDashboardPositions(id: string, body?: unknown): Promise<Scope>
updateUserSettings(
id: string,
params?: UpdateUserSettingsParams,
body?: unknown,
): Promise<Scope>
uploadFile(user_id: string, body?: unknown): Promise<Scope>