deno.land / x / gesso@v0.1.2 / src / Users.ts
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640import { BaseApi } from "./BaseApi.ts";import { Configuration } from "./Configuration.ts";import { Assignment, Avatar, Conversation, Course, Page, Profile, Scope, User,} from "../types/models.ts";import { CreateUserParams, DeleteCustomDataParams, deprecatedSelfRegisterUserParams, EditUserParams, GetPandataEventsJwtTokenItsExpirationDateParams, ListCountsForTodoItemsParams, ListMissingSubmissionsParams, ListTheActivityStreamParams, ListTheTodoItemsParams, ListUserPageViewsParams, ListUsersInAccountParams, LoadCustomDataParams, SetCourseNicknameParams, ShowUserDetailsParams, StoreCustomDataParams, UpdateCustomColorParams, UpdateUserSettingsParams,} from "../types/params.ts";
export class Users extends BaseApi { constructor(config: Configuration) { super(config); }
public async listUsersInAccount( account_id: string, params?: ListUsersInAccountParams, body?: unknown, ): Promise<User[]> { const endpoint = `/api/v1/accounts/${account_id}/users`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as User[]; }
return Promise.reject(response); }
public async listTheActivityStream( params?: ListTheActivityStreamParams, body?: unknown, ): Promise<Assignment> { const endpoint = "/api/v1/users/self/activity_stream"; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Assignment; }
return Promise.reject(response); }
public async activityStreamSummary(body?: unknown): Promise<Conversation> { const endpoint = "/api/v1/users/self/activity_stream/summary"; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Conversation; }
return Promise.reject(response); }
public async listTheTodoItems( params?: ListTheTodoItemsParams, body?: unknown, ): Promise<Scope> { const endpoint = "/api/v1/users/self/todo"; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async listCountsForTodoItems( params?: ListCountsForTodoItemsParams, body?: unknown, ): Promise<Scope> { const endpoint = "/api/v1/users/self/todo_item_count"; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async listUpcomingAssignmentsCalendarEvents( body?: unknown, ): Promise<Scope> { const endpoint = "/api/v1/users/self/upcoming_events"; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async listMissingSubmissions( user_id: string, params?: ListMissingSubmissionsParams, body?: unknown, ): Promise<Assignment[]> { const endpoint = `/api/v1/users/${user_id}/missing_submissions`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Assignment[]; }
return Promise.reject(response); }
public async hideStreamItem(id: string, body?: unknown): Promise<Scope> { const endpoint = `/api/v1/users/self/activity_stream/${id}`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.delete(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async hideAllStreamItems(body?: unknown): Promise<Scope> { const endpoint = "/api/v1/users/self/activity_stream"; const url = new URL(endpoint, this.configuration.domain);
const response = await this.delete(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async uploadFile(user_id: string, body?: unknown): Promise<Scope> { const endpoint = `/api/v1/users/${user_id}/files`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.post(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async showUserDetails( id: string, params?: ShowUserDetailsParams, body?: unknown, ): Promise<User> { const endpoint = `/api/v1/users/${id}`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as User; }
return Promise.reject(response); }
public async createUser( account_id: string, params?: CreateUserParams, body?: unknown, ): Promise<User> { const endpoint = `/api/v1/accounts/${account_id}/users`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.post(url, JSON.stringify(body)); if (response.ok) { return await response.json() as User; }
return Promise.reject(response); }
public async deprecatedSelfRegisterUser( account_id: string, params?: deprecatedSelfRegisterUserParams, body?: unknown, ): Promise<User> { const endpoint = `/api/v1/accounts/${account_id}/self_registration`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.post(url, JSON.stringify(body)); if (response.ok) { return await response.json() as User; }
return Promise.reject(response); }
public async updateUserSettings( id: string, params?: UpdateUserSettingsParams, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/users/${id}/settings`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async getCustomColors(id: string, body?: unknown): Promise<unknown> { const endpoint = `/api/v1/users/${id}/colors`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as unknown; }
return Promise.reject(response); }
public async getCustomColor( id: string, asset_string: string, body?: unknown, ): Promise<unknown> { const endpoint = `/api/v1/users/${id}/colors/${asset_string}`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as unknown; }
return Promise.reject(response); }
public async updateCustomColor( id: string, asset_string: string, params?: UpdateCustomColorParams, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/users/${id}/colors/${asset_string}`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.put(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async getDashboardPositions( id: string, body?: unknown, ): Promise<unknown> { const endpoint = `/api/v1/users/${id}/dashboard_positions`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as unknown; }
return Promise.reject(response); }
public async updateDashboardPositions( id: string, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/users/${id}/dashboard_positions`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.put(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async editUser( id: string, params?: EditUserParams, body?: unknown, ): Promise<User> { const endpoint = `/api/v1/users/${id}`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.put(url, JSON.stringify(body)); if (response.ok) { return await response.json() as User; }
return Promise.reject(response); }
public async terminateAllUserSessions( id: string, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/users/${id}/sessions`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.delete(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async mergeUserIntoAnotherUser( id: string, destination_user_id: string, body?: unknown, ): Promise<User> { const endpoint = `/api/v1/users/${id}/merge_into/${destination_user_id}`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.put(url, JSON.stringify(body)); if (response.ok) { return await response.json() as User; }
return Promise.reject(response); }
public async splitMergedUsersIntoSeparateUsers( id: string, body?: unknown, ): Promise<User[]> { const endpoint = `/api/v1/users/${id}/split`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.post(url, JSON.stringify(body)); if (response.ok) { return await response.json() as User[]; }
return Promise.reject(response); }
public async getPandataEventsJwtTokenItsExpirationDate( params?: GetPandataEventsJwtTokenItsExpirationDateParams, body?: unknown, ): Promise<unknown> { const endpoint = "/api/v1/users/self/pandata_events_token"; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.post(url, JSON.stringify(body)); if (response.ok) { return await response.json() as unknown; }
return Promise.reject(response); }
public async getUsersMostRecentlyGradedSubmissions( id: string, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/users/${id}/graded_submissions`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async getUserProfile( user_id: string, body?: unknown, ): Promise<Profile> { const endpoint = `/api/v1/users/${user_id}/profile`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Profile; }
return Promise.reject(response); }
public async listAvatarOptions( user_id: string, body?: unknown, ): Promise<Avatar[]> { const endpoint = `/api/v1/users/${user_id}/avatars`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Avatar[]; }
return Promise.reject(response); }
public async listUserPageViews( user_id: string, params?: ListUserPageViewsParams, body?: unknown, ): Promise<Page[]> { const endpoint = `/api/v1/users/${user_id}/page_views`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Page[]; }
return Promise.reject(response); }
public async storeCustomData( user_id: string, params?: StoreCustomDataParams, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/users/${user_id}/custom_data(/*scope)`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.put(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async loadCustomData( user_id: string, params?: LoadCustomDataParams, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/users/${user_id}/custom_data(/*scope)`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async deleteCustomData( user_id: string, params?: DeleteCustomDataParams, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/users/${user_id}/custom_data(/*scope)`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.delete(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }
public async listCourseNicknames(body?: unknown): Promise<Course[]> { const endpoint = "/api/v1/users/self/course_nicknames"; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Course[]; }
return Promise.reject(response); }
public async getCourseNickname( course_id: string, body?: unknown, ): Promise<Course> { const endpoint = `/api/v1/users/self/course_nicknames/${course_id}`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.get(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Course; }
return Promise.reject(response); }
public async setCourseNickname( course_id: string, params?: SetCourseNicknameParams, body?: unknown, ): Promise<Course> { const endpoint = `/api/v1/users/self/course_nicknames/${course_id}`; const url = new URL(endpoint, this.configuration.domain); if (params !== undefined) { for (const [key, value] of Object.entries(params)) { url.searchParams.set(key, JSON.stringify(value)); } } const response = await this.put(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Course; }
return Promise.reject(response); }
public async removeCourseNickname( course_id: string, body?: unknown, ): Promise<Course> { const endpoint = `/api/v1/users/self/course_nicknames/${course_id}`; const url = new URL(endpoint, this.configuration.domain);
const response = await this.delete(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Course; }
return Promise.reject(response); }
public async clearCourseNicknames(body?: unknown): Promise<Scope> { const endpoint = "/api/v1/users/self/course_nicknames"; const url = new URL(endpoint, this.configuration.domain);
const response = await this.delete(url, JSON.stringify(body)); if (response.ok) { return await response.json() as Scope; }
return Promise.reject(response); }}
Version Info