@groton/canvas-api 0.3.4 → 0.3.5

package/dist/Endpoints/V1/Courses/ActivityStream/course_activity_stream.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type course_activity_streamPathParameters = {
     /**
@@ -27,5 +28,5 @@ type Options = {
  *
  * Nickname: course_activity_stream
  */
-export declare function course_activity_stream(options: Options): Promise<void>;
+export declare function course_activity_stream(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/Messages/index.d.ts

@@ -0,0 +1 @@
+export * from './post_message_to_conversation.js';

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/Messages/index.js

@@ -0,0 +1 @@
+export * from './post_message_to_conversation.js';

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/Messages/post_message_to_conversation.d.ts

@@ -0,0 +1,47 @@
+import { JSONValue } from '@battis/typescript-tricks';
+import { Masquerade } from '@groton/canvas-api.client.base';
+export type post_message_to_conversationPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    course_id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    ai_experience_id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    id: string | number;
+};
+export type post_message_to_conversationSearchParameters = Masquerade;
+export type post_message_to_conversationFormParameters = Masquerade & {
+    /** The user's message to send to the AI */
+    message: string;
+};
+type Options = {
+    pathParams: post_message_to_conversationPathParameters;
+} & ({
+    searchParams?: Partial<post_message_to_conversationSearchParameters>;
+    params?: Partial<post_message_to_conversationFormParameters>;
+    strict?: false;
+} | {
+    searchParams: post_message_to_conversationSearchParameters;
+    params: post_message_to_conversationFormParameters;
+    strict: true;
+});
+/**
+ * Post message to conversation
+ *
+ * Send a message to an existing conversation and get the AI response
+ *
+ * Nickname: post_message_to_conversation
+ */
+export declare function post_message_to_conversation(options: Options): Promise<JSONValue>;
+export {};

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/Messages/post_message_to_conversation.js

@@ -0,0 +1,15 @@
+import { client } from '../../../../../../Client.js';
+/**
+ * Post message to conversation
+ *
+ * Send a message to an existing conversation and get the AI response
+ *
+ * Nickname: post_message_to_conversation
+ */
+export async function post_message_to_conversation(options) {
+    const response = await client().fetchAs(`/api/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}/messages`, {
+        method: 'POST',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/create.d.ts

@@ -0,0 +1,35 @@
+import { JSONValue } from '@battis/typescript-tricks';
+import { Masquerade } from '@groton/canvas-api.client.base';
+export type createPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    course_id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    ai_experience_id: string | number;
+};
+export type createSearchParameters = Masquerade;
+type Options = {
+    pathParams: createPathParameters;
+} & ({
+    searchParams?: Partial<createSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: createSearchParameters;
+    strict: true;
+});
+/**
+ * Create AI conversation
+ *
+ * Initialize a new conversation with the AI experience
+ *
+ * Nickname: create_ai_conversation
+ */
+export declare function create(options: Options): Promise<JSONValue>;
+export {};

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/create.js

@@ -0,0 +1,15 @@
+import { client } from '../../../../../Client.js';
+/**
+ * Create AI conversation
+ *
+ * Initialize a new conversation with the AI experience
+ *
+ * Nickname: create_ai_conversation
+ */
+export async function create(options) {
+    const response = await client().fetchAs(`/api/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations`, {
+        method: 'POST',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/delete_ai_conversation.d.ts

@@ -0,0 +1,40 @@
+import { Masquerade } from '@groton/canvas-api.client.base';
+export type delete_ai_conversationPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    course_id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    ai_experience_id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    id: string | number;
+};
+export type delete_ai_conversationSearchParameters = Masquerade;
+type Options = {
+    pathParams: delete_ai_conversationPathParameters;
+} & ({
+    searchParams?: Partial<delete_ai_conversationSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: delete_ai_conversationSearchParameters;
+    strict: true;
+});
+/**
+ * Delete AI conversation
+ *
+ * Mark a conversation as completed/deleted
+ *
+ * Nickname: delete_ai_conversation
+ */
+export declare function delete_ai_conversation(options: Options): Promise<string>;
+export {};

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/delete_ai_conversation.js

@@ -0,0 +1,15 @@
+import { client } from '../../../../../Client.js';
+/**
+ * Delete AI conversation
+ *
+ * Mark a conversation as completed/deleted
+ *
+ * Nickname: delete_ai_conversation
+ */
+export async function delete_ai_conversation(options) {
+    const response = await client().fetchAs(`/api/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}`, {
+        method: 'DELETE',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/get.d.ts

@@ -0,0 +1,35 @@
+import { JSONValue } from '@battis/typescript-tricks';
+import { Masquerade } from '@groton/canvas-api.client.base';
+export type getPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    course_id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    ai_experience_id: string | number;
+};
+export type getSearchParameters = Masquerade;
+type Options = {
+    pathParams: getPathParameters;
+} & ({
+    searchParams?: Partial<getSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: getSearchParameters;
+    strict: true;
+});
+/**
+ * Get active conversation
+ *
+ * Get the active conversation for the current user and AI experience
+ *
+ * Nickname: get_active_conversation
+ */
+export declare function get(options: Options): Promise<JSONValue>;
+export {};

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/get.js

@@ -0,0 +1,15 @@
+import { client } from '../../../../../Client.js';
+/**
+ * Get active conversation
+ *
+ * Get the active conversation for the current user and AI experience
+ *
+ * Nickname: get_active_conversation
+ */
+export async function get(options) {
+    const response = await client().fetchAs(`/api/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/index.d.ts

@@ -0,0 +1,4 @@
+export * from './create.js';
+export * from './delete_ai_conversation.js';
+export * from './get.js';
+export * as Messages from './Messages/index.js';

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/index.js

@@ -0,0 +1,4 @@
+export * from './create.js';
+export * from './delete_ai_conversation.js';
+export * from './get.js';
+export * as Messages from './Messages/index.js';

package/dist/Endpoints/V1/Courses/AiExperiences/Edit/index.d.ts

@@ -0,0 +1 @@
+export * from './show_edit_ai_experience_form.js';

package/dist/Endpoints/V1/Courses/AiExperiences/Edit/index.js

@@ -0,0 +1 @@
+export * from './show_edit_ai_experience_form.js';

package/dist/Endpoints/V1/Courses/AiExperiences/Edit/show_edit_ai_experience_form.d.ts

@@ -0,0 +1,35 @@
+import { JSONValue } from '@battis/typescript-tricks';
+import { Masquerade } from '@groton/canvas-api.client.base';
+export type show_edit_ai_experience_formPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    course_id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    id: string | number;
+};
+export type show_edit_ai_experience_formSearchParameters = Masquerade;
+type Options = {
+    pathParams: show_edit_ai_experience_formPathParameters;
+} & ({
+    searchParams?: Partial<show_edit_ai_experience_formSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: show_edit_ai_experience_formSearchParameters;
+    strict: true;
+});
+/**
+ * Show edit AI experience form
+ *
+ * Display the form for editing an existing AI experience
+ *
+ * Nickname: show_edit_ai_experience_form
+ */
+export declare function show_edit_ai_experience_form(options: Options): Promise<JSONValue>;
+export {};

package/dist/Endpoints/V1/Courses/AiExperiences/Edit/show_edit_ai_experience_form.js

@@ -0,0 +1,15 @@
+import { client } from '../../../../../Client.js';
+/**
+ * Show edit AI experience form
+ *
+ * Display the form for editing an existing AI experience
+ *
+ * Nickname: show_edit_ai_experience_form
+ */
+export async function show_edit_ai_experience_form(options) {
+    const response = await client().fetchAs(`/api/v1/courses/{course_id}/ai_experiences/{id}/edit`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Courses/AiExperiences/New/index.d.ts

@@ -0,0 +1 @@
+export * from './show_new_ai_experience_form.js';

package/dist/Endpoints/V1/Courses/AiExperiences/New/index.js

@@ -0,0 +1 @@
+export * from './show_new_ai_experience_form.js';

package/dist/Endpoints/V1/Courses/AiExperiences/New/show_new_ai_experience_form.d.ts

@@ -0,0 +1,29 @@
+import { JSONValue } from '@battis/typescript-tricks';
+import { Masquerade } from '@groton/canvas-api.client.base';
+export type show_new_ai_experience_formPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    course_id: string | number;
+};
+export type show_new_ai_experience_formSearchParameters = Masquerade;
+type Options = {
+    pathParams: show_new_ai_experience_formPathParameters;
+} & ({
+    searchParams?: Partial<show_new_ai_experience_formSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: show_new_ai_experience_formSearchParameters;
+    strict: true;
+});
+/**
+ * Show new AI experience form
+ *
+ * Display the form for creating a new AI experience
+ *
+ * Nickname: show_new_ai_experience_form
+ */
+export declare function show_new_ai_experience_form(options: Options): Promise<JSONValue>;
+export {};

package/dist/Endpoints/V1/Courses/AiExperiences/New/show_new_ai_experience_form.js

@@ -0,0 +1,15 @@
+import { client } from '../../../../../Client.js';
+/**
+ * Show new AI experience form
+ *
+ * Display the form for creating a new AI experience
+ *
+ * Nickname: show_new_ai_experience_form
+ */
+export async function show_new_ai_experience_form(options) {
+    const response = await client().fetchAs(`/api/v1/courses/{course_id}/ai_experiences/new`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Courses/AiExperiences/create.d.ts

@@ -0,0 +1,48 @@
+import { Masquerade } from '@groton/canvas-api.client.base';
+import { AiExperience } from '../../../../Resources/AiExperiences.js';
+export type createPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    course_id: string | number;
+};
+export type createSearchParameters = Masquerade;
+export type createFormParameters = Masquerade & {
+    /** The title of the AI experience. */
+    title: string;
+    /** The description of the AI experience. */
+    description: string;
+    /** The AI facts for the experience. */
+    facts: string;
+    /** The learning objectives for this experience. */
+    learning_objective: string;
+    /** The pedagogical guidance for the experience. */
+    pedagogical_guidance: string;
+    /**
+     * The initial state of the experience. Defaults to 'unpublished'. Allowed
+     * values: published, unpublished
+     */
+    workflow_state: string;
+};
+type Options = {
+    pathParams: createPathParameters;
+} & ({
+    searchParams?: Partial<createSearchParameters>;
+    params?: Partial<createFormParameters>;
+    strict?: false;
+} | {
+    searchParams: createSearchParameters;
+    params: createFormParameters;
+    strict: true;
+});
+/**
+ * Create an AI experience
+ *
+ * Create a new AI experience for the specified course
+ *
+ * Nickname: create_ai_experience
+ */
+export declare function create(options: Options): Promise<AiExperience>;
+export {};

package/dist/Endpoints/V1/Courses/AiExperiences/create.js

@@ -0,0 +1,15 @@
+import { client } from '../../../../Client.js';
+/**
+ * Create an AI experience
+ *
+ * Create a new AI experience for the specified course
+ *
+ * Nickname: create_ai_experience
+ */
+export async function create(options) {
+    const response = await client().fetchAs(`/api/v1/courses/{course_id}/ai_experiences`, {
+        method: 'POST',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Courses/AiExperiences/delete_ai_experience.d.ts

@@ -0,0 +1,35 @@
+import { Masquerade } from '@groton/canvas-api.client.base';
+import { AiExperience } from '../../../../Resources/AiExperiences.js';
+export type delete_ai_experiencePathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    course_id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    id: string | number;
+};
+export type delete_ai_experienceSearchParameters = Masquerade;
+type Options = {
+    pathParams: delete_ai_experiencePathParameters;
+} & ({
+    searchParams?: Partial<delete_ai_experienceSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: delete_ai_experienceSearchParameters;
+    strict: true;
+});
+/**
+ * Delete an AI experience
+ *
+ * Delete an AI experience (soft delete - marks as deleted)
+ *
+ * Nickname: delete_ai_experience
+ */
+export declare function delete_ai_experience(options: Options): Promise<AiExperience>;
+export {};

package/dist/Endpoints/V1/Courses/AiExperiences/delete_ai_experience.js

@@ -0,0 +1,15 @@
+import { client } from '../../../../Client.js';
+/**
+ * Delete an AI experience
+ *
+ * Delete an AI experience (soft delete - marks as deleted)
+ *
+ * Nickname: delete_ai_experience
+ */
+export async function delete_ai_experience(options) {
+    const response = await client().fetchAs(`/api/v1/courses/{course_id}/ai_experiences/{id}`, {
+        method: 'DELETE',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Courses/AiExperiences/index.d.ts

@@ -0,0 +1,8 @@
+export * as Conversations from './Conversations/index.js';
+export * from './create.js';
+export * from './delete_ai_experience.js';
+export * as Edit from './Edit/index.js';
+export * from './list.js';
+export * as New from './New/index.js';
+export * from './show_ai_experience.js';
+export * from './update.js';

package/dist/Endpoints/V1/Courses/AiExperiences/index.js

@@ -0,0 +1,8 @@
+export * as Conversations from './Conversations/index.js';
+export * from './create.js';
+export * from './delete_ai_experience.js';
+export * as Edit from './Edit/index.js';
+export * from './list.js';
+export * as New from './New/index.js';
+export * from './show_ai_experience.js';
+export * from './update.js';

package/dist/Endpoints/V1/Courses/AiExperiences/list.d.ts

@@ -0,0 +1,35 @@
+import { Masquerade, Paginated } from '@groton/canvas-api.client.base';
+import { AiExperience } from '../../../../Resources/AiExperiences.js';
+export type listPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    course_id: string | number;
+};
+export type listSearchParameters = Masquerade & Paginated & Partial<{
+    /**
+     * Only return experiences with the specified workflow state. Allowed
+     * values: published, unpublished, deleted
+     */
+    workflow_state: string;
+}>;
+type Options = {
+    pathParams: listPathParameters;
+} & ({
+    searchParams?: Partial<listSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: listSearchParameters;
+    strict: true;
+});
+/**
+ * List AI experiences
+ *
+ * Retrieve the paginated list of AI experiences for a course
+ *
+ * Nickname: list_ai_experiences
+ */
+export declare function list(options: Options): Promise<AiExperience[]>;
+export {};

package/dist/Endpoints/V1/Courses/AiExperiences/list.js

@@ -0,0 +1,15 @@
+import { client } from '../../../../Client.js';
+/**
+ * List AI experiences
+ *
+ * Retrieve the paginated list of AI experiences for a course
+ *
+ * Nickname: list_ai_experiences
+ */
+export async function list(options) {
+    const response = await client().fetchAs(`/api/v1/courses/{course_id}/ai_experiences`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Courses/AiExperiences/show_ai_experience.d.ts

@@ -0,0 +1,35 @@
+import { Masquerade } from '@groton/canvas-api.client.base';
+import { AiExperience } from '../../../../Resources/AiExperiences.js';
+export type show_ai_experiencePathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    course_id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    id: string | number;
+};
+export type show_ai_experienceSearchParameters = Masquerade;
+type Options = {
+    pathParams: show_ai_experiencePathParameters;
+} & ({
+    searchParams?: Partial<show_ai_experienceSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: show_ai_experienceSearchParameters;
+    strict: true;
+});
+/**
+ * Show an AI experience
+ *
+ * Retrieve an AI experience by ID
+ *
+ * Nickname: show_ai_experience
+ */
+export declare function show_ai_experience(options: Options): Promise<AiExperience>;
+export {};

package/dist/Endpoints/V1/Courses/AiExperiences/show_ai_experience.js

@@ -0,0 +1,15 @@
+import { client } from '../../../../Client.js';
+/**
+ * Show an AI experience
+ *
+ * Retrieve an AI experience by ID
+ *
+ * Nickname: show_ai_experience
+ */
+export async function show_ai_experience(options) {
+    const response = await client().fetchAs(`/api/v1/courses/{course_id}/ai_experiences/{id}`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Courses/AiExperiences/update.d.ts

@@ -0,0 +1,51 @@
+import { Masquerade } from '@groton/canvas-api.client.base';
+import { AiExperience } from '../../../../Resources/AiExperiences.js';
+export type updatePathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    course_id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    id: string | number;
+};
+export type updateSearchParameters = Masquerade;
+export type updateFormParameters = Masquerade & {
+    /** The title of the AI experience. */
+    title: string;
+    /** The description of the AI experience. */
+    description: string;
+    /** The AI facts for the experience. */
+    facts: string;
+    /** The learning objectives for this experience. */
+    learning_objective: string;
+    /** The pedagogical guidance for the experience. */
+    pedagogical_guidance: string;
+    /** The state of the experience. Allowed values: published, unpublished */
+    workflow_state: string;
+};
+type Options = {
+    pathParams: updatePathParameters;
+} & ({
+    searchParams?: Partial<updateSearchParameters>;
+    params?: Partial<updateFormParameters>;
+    strict?: false;
+} | {
+    searchParams: updateSearchParameters;
+    params: updateFormParameters;
+    strict: true;
+});
+/**
+ * Update an AI experience
+ *
+ * Update an existing AI experience
+ *
+ * Nickname: update_ai_experience
+ */
+export declare function update(options: Options): Promise<AiExperience>;
+export {};