deno.land / x / gesso@v0.1.2 / src / ExternalTools.ts
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197import { BaseApi } from "./BaseApi.ts";import { Configuration } from "./Configuration.ts";import { Scope } from "../types/models.ts";import { CreateAnExternalToolParams, GetSessionlessLaunchUrlForAnExternalToolParams, GetVisibleCourseNavigationToolsParams, ListExternalToolsParams,} from "../types/params.ts";
export class ExternalTools extends BaseApi { constructor(config: Configuration) { super(config); }
public async listExternalTools( course_id: string, params?: ListExternalToolsParams, body?: unknown, ): Promise<unknown[]> { const endpoint = `/api/v1/courses/${course_id}/external_tools`; 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 unknown[]; }
return Promise.reject(response); }
public async getSessionlessLaunchUrlForAnExternalTool( course_id: string, params?: GetSessionlessLaunchUrlForAnExternalToolParams, body?: unknown, ): Promise<unknown> { const endpoint = `/api/v1/courses/${course_id}/external_tools/sessionless_launch`; 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 unknown; }
return Promise.reject(response); }
public async getSingleExternalTool( course_id: string, external_tool_id: string, body?: unknown, ): Promise<unknown> { const endpoint = `/api/v1/courses/${course_id}/external_tools/${external_tool_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 unknown; }
return Promise.reject(response); }
public async createAnExternalTool( course_id: string, params?: CreateAnExternalToolParams, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/external_tools`; 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 Scope; }
return Promise.reject(response); }
public async editAnExternalTool( course_id: string, external_tool_id: string, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/external_tools/${external_tool_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 Scope; }
return Promise.reject(response); }
public async deleteAnExternalTool( course_id: string, external_tool_id: string, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/courses/${course_id}/external_tools/${external_tool_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 addToolToRceFavorites( account_id: string, id: string, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/accounts/${account_id}/external_tools/rce_favorites/${id}`; 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 removeToolFromRceFavorites( account_id: string, id: string, body?: unknown, ): Promise<Scope> { const endpoint = `/api/v1/accounts/${account_id}/external_tools/rce_favorites/${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 getVisibleCourseNavigationTools( params?: GetVisibleCourseNavigationToolsParams, body?: unknown, ): Promise<Scope[]> { const endpoint = "/api/v1/external_tools/visible_course_nav_tools"; 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 getVisibleCourseNavigationToolsForSingleCourse( course_id: string, body?: unknown, ): Promise<Scope[]> { const endpoint = `/api/v1/courses/${course_id}/external_tools/visible_course_nav_tools`; 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); }}
Version Info