@instructure/athena-api-client 1.0.11 → 1.0.13-rc.0

package/dist/esm/models/AdminPaginatedChats.js

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AdminChatFromJSON, AdminChatToJSON, } from './AdminChat';
+/**
+ * Check if a given object implements the AdminPaginatedChats interface.
+ */
+export function instanceOfAdminPaginatedChats(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+export function AdminPaginatedChatsFromJSON(json) {
+    return AdminPaginatedChatsFromJSONTyped(json, false);
+}
+export function AdminPaginatedChatsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(AdminChatFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+export function AdminPaginatedChatsToJSON(json) {
+    return AdminPaginatedChatsToJSONTyped(json, false);
+}
+export function AdminPaginatedChatsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(AdminChatToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

package/dist/esm/models/AdminStreak.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface AdminStreak
+ */
+export interface AdminStreak {
+    /**
+     * External user ID
+     * @type {string}
+     * @memberof AdminStreak
+     */
+    userId: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminStreak
+     */
+    currentDays: number;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminStreak
+     */
+    longestDays: number;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminStreak
+     */
+    totalMissedDays: number;
+    /**
+     *
+     * @type {Array<number>}
+     * @memberof AdminStreak
+     */
+    missedDaysInCycle: Array<number>;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminStreak
+     */
+    lastMomentDate: Date | null;
+}
+/**
+ * Check if a given object implements the AdminStreak interface.
+ */
+export declare function instanceOfAdminStreak(value: object): value is AdminStreak;
+export declare function AdminStreakFromJSON(json: any): AdminStreak;
+export declare function AdminStreakFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminStreak;
+export declare function AdminStreakToJSON(json: any): AdminStreak;
+export declare function AdminStreakToJSONTyped(value?: AdminStreak | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminStreak.js

@@ -0,0 +1,63 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the AdminStreak interface.
+ */
+export function instanceOfAdminStreak(value) {
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('currentDays' in value) || value['currentDays'] === undefined)
+        return false;
+    if (!('longestDays' in value) || value['longestDays'] === undefined)
+        return false;
+    if (!('totalMissedDays' in value) || value['totalMissedDays'] === undefined)
+        return false;
+    if (!('missedDaysInCycle' in value) || value['missedDaysInCycle'] === undefined)
+        return false;
+    if (!('lastMomentDate' in value) || value['lastMomentDate'] === undefined)
+        return false;
+    return true;
+}
+export function AdminStreakFromJSON(json) {
+    return AdminStreakFromJSONTyped(json, false);
+}
+export function AdminStreakFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'userId': json['userId'],
+        'currentDays': json['currentDays'],
+        'longestDays': json['longestDays'],
+        'totalMissedDays': json['totalMissedDays'],
+        'missedDaysInCycle': json['missedDaysInCycle'],
+        'lastMomentDate': (json['lastMomentDate'] == null ? null : new Date(json['lastMomentDate'])),
+    };
+}
+export function AdminStreakToJSON(json) {
+    return AdminStreakToJSONTyped(json, false);
+}
+export function AdminStreakToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'userId': value['userId'],
+        'currentDays': value['currentDays'],
+        'longestDays': value['longestDays'],
+        'totalMissedDays': value['totalMissedDays'],
+        'missedDaysInCycle': value['missedDaysInCycle'],
+        'lastMomentDate': value['lastMomentDate'] == null ? value['lastMomentDate'] : value['lastMomentDate'].toISOString().substring(0, 10),
+    };
+}

package/dist/esm/models/AdminUserEngagement.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface AdminUserEngagement
+ */
+export interface AdminUserEngagement {
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminUserEngagement
+     */
+    lastViewedChatAt: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminUserEngagement
+     */
+    lastMessageCreatedAt: Date | null;
+}
+/**
+ * Check if a given object implements the AdminUserEngagement interface.
+ */
+export declare function instanceOfAdminUserEngagement(value: object): value is AdminUserEngagement;
+export declare function AdminUserEngagementFromJSON(json: any): AdminUserEngagement;
+export declare function AdminUserEngagementFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminUserEngagement;
+export declare function AdminUserEngagementToJSON(json: any): AdminUserEngagement;
+export declare function AdminUserEngagementToJSONTyped(value?: AdminUserEngagement | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminUserEngagement.js

@@ -0,0 +1,47 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the AdminUserEngagement interface.
+ */
+export function instanceOfAdminUserEngagement(value) {
+    if (!('lastViewedChatAt' in value) || value['lastViewedChatAt'] === undefined)
+        return false;
+    if (!('lastMessageCreatedAt' in value) || value['lastMessageCreatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function AdminUserEngagementFromJSON(json) {
+    return AdminUserEngagementFromJSONTyped(json, false);
+}
+export function AdminUserEngagementFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'lastViewedChatAt': (json['lastViewedChatAt'] == null ? null : new Date(json['lastViewedChatAt'])),
+        'lastMessageCreatedAt': (json['lastMessageCreatedAt'] == null ? null : new Date(json['lastMessageCreatedAt'])),
+    };
+}
+export function AdminUserEngagementToJSON(json) {
+    return AdminUserEngagementToJSONTyped(json, false);
+}
+export function AdminUserEngagementToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'lastViewedChatAt': value['lastViewedChatAt'] == null ? value['lastViewedChatAt'] : value['lastViewedChatAt'].toISOString(),
+        'lastMessageCreatedAt': value['lastMessageCreatedAt'] == null ? value['lastMessageCreatedAt'] : value['lastMessageCreatedAt'].toISOString(),
+    };
+}

package/dist/esm/models/ChatAnalysis.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ChatAnalysis
+ */
+export interface ChatAnalysis {
+    /**
+     * Chat identifier
+     * @type {string}
+     * @memberof ChatAnalysis
+     */
+    id: string;
+    /**
+     * Chat title
+     * @type {string}
+     * @memberof ChatAnalysis
+     */
+    title: string;
+    /**
+     * AI-generated summary of the chat
+     * @type {string}
+     * @memberof ChatAnalysis
+     */
+    summary: string | null;
+    /**
+     * Inferred goal of the chat
+     * @type {string}
+     * @memberof ChatAnalysis
+     */
+    goal: string | null;
+    /**
+     * Whether the goal was achieved
+     * @type {boolean}
+     * @memberof ChatAnalysis
+     */
+    goalAchieved: boolean | null;
+    /**
+     * Subject name associated with the chat
+     * @type {string}
+     * @memberof ChatAnalysis
+     */
+    subject: string | null;
+    /**
+     * Concept names extracted from the chat
+     * @type {Array<string>}
+     * @memberof ChatAnalysis
+     */
+    concepts: Array<string>;
+}
+/**
+ * Check if a given object implements the ChatAnalysis interface.
+ */
+export declare function instanceOfChatAnalysis(value: object): value is ChatAnalysis;
+export declare function ChatAnalysisFromJSON(json: any): ChatAnalysis;
+export declare function ChatAnalysisFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChatAnalysis;
+export declare function ChatAnalysisToJSON(json: any): ChatAnalysis;
+export declare function ChatAnalysisToJSONTyped(value?: ChatAnalysis | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ChatAnalysis.js

@@ -0,0 +1,67 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the ChatAnalysis interface.
+ */
+export function instanceOfChatAnalysis(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('summary' in value) || value['summary'] === undefined)
+        return false;
+    if (!('goal' in value) || value['goal'] === undefined)
+        return false;
+    if (!('goalAchieved' in value) || value['goalAchieved'] === undefined)
+        return false;
+    if (!('subject' in value) || value['subject'] === undefined)
+        return false;
+    if (!('concepts' in value) || value['concepts'] === undefined)
+        return false;
+    return true;
+}
+export function ChatAnalysisFromJSON(json) {
+    return ChatAnalysisFromJSONTyped(json, false);
+}
+export function ChatAnalysisFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'title': json['title'],
+        'summary': json['summary'],
+        'goal': json['goal'],
+        'goalAchieved': json['goalAchieved'],
+        'subject': json['subject'],
+        'concepts': json['concepts'],
+    };
+}
+export function ChatAnalysisToJSON(json) {
+    return ChatAnalysisToJSONTyped(json, false);
+}
+export function ChatAnalysisToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'title': value['title'],
+        'summary': value['summary'],
+        'goal': value['goal'],
+        'goalAchieved': value['goalAchieved'],
+        'subject': value['subject'],
+        'concepts': value['concepts'],
+    };
+}

package/dist/esm/models/UpsertUserContextRequest.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface UpsertUserContextRequest
+ */
+export interface UpsertUserContextRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof UpsertUserContextRequest
+     */
+    chatId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UpsertUserContextRequest
+     */
+    preferredName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UpsertUserContextRequest
+     */
+    summary?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UpsertUserContextRequest
+     */
+    courses?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UpsertUserContextRequest
+     */
+    topicsOfInterest?: string | null;
+}
+/**
+ * Check if a given object implements the UpsertUserContextRequest interface.
+ */
+export declare function instanceOfUpsertUserContextRequest(value: object): value is UpsertUserContextRequest;
+export declare function UpsertUserContextRequestFromJSON(json: any): UpsertUserContextRequest;
+export declare function UpsertUserContextRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpsertUserContextRequest;
+export declare function UpsertUserContextRequestToJSON(json: any): UpsertUserContextRequest;
+export declare function UpsertUserContextRequestToJSONTyped(value?: UpsertUserContextRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UpsertUserContextRequest.js

@@ -0,0 +1,49 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the UpsertUserContextRequest interface.
+ */
+export function instanceOfUpsertUserContextRequest(value) {
+    return true;
+}
+export function UpsertUserContextRequestFromJSON(json) {
+    return UpsertUserContextRequestFromJSONTyped(json, false);
+}
+export function UpsertUserContextRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'chatId': json['chatId'] == null ? undefined : json['chatId'],
+        'preferredName': json['preferredName'] == null ? undefined : json['preferredName'],
+        'summary': json['summary'] == null ? undefined : json['summary'],
+        'courses': json['courses'] == null ? undefined : json['courses'],
+        'topicsOfInterest': json['topicsOfInterest'] == null ? undefined : json['topicsOfInterest'],
+    };
+}
+export function UpsertUserContextRequestToJSON(json) {
+    return UpsertUserContextRequestToJSONTyped(json, false);
+}
+export function UpsertUserContextRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'chatId': value['chatId'],
+        'preferredName': value['preferredName'],
+        'summary': value['summary'],
+        'courses': value['courses'],
+        'topicsOfInterest': value['topicsOfInterest'],
+    };
+}

package/dist/esm/models/UserContext.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface UserContext
+ */
+export interface UserContext {
+    /**
+     * Unique identifier
+     * @type {string}
+     * @memberof UserContext
+     */
+    id: string;
+    /**
+     * External user ID (matches the X-User-Id header value)
+     * @type {string}
+     * @memberof UserContext
+     */
+    userId: string;
+    /**
+     * Chat ID that generated this context (e.g. onboarding chat)
+     * @type {string}
+     * @memberof UserContext
+     */
+    chatId: string | null;
+    /**
+     * User's preferred name
+     * @type {string}
+     * @memberof UserContext
+     */
+    preferredName: string | null;
+    /**
+     * Summary of user preferences and background
+     * @type {string}
+     * @memberof UserContext
+     */
+    summary: string | null;
+    /**
+     * User's courses
+     * @type {string}
+     * @memberof UserContext
+     */
+    courses: string | null;
+    /**
+     * User's topics of interest
+     * @type {string}
+     * @memberof UserContext
+     */
+    topicsOfInterest: string | null;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof UserContext
+     */
+    createdAt: Date;
+    /**
+     * Last update timestamp
+     * @type {Date}
+     * @memberof UserContext
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the UserContext interface.
+ */
+export declare function instanceOfUserContext(value: object): value is UserContext;
+export declare function UserContextFromJSON(json: any): UserContext;
+export declare function UserContextFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserContext;
+export declare function UserContextToJSON(json: any): UserContext;
+export declare function UserContextToJSONTyped(value?: UserContext | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UserContext.js

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the UserContext interface.
+ */
+export function instanceOfUserContext(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
+    if (!('preferredName' in value) || value['preferredName'] === undefined)
+        return false;
+    if (!('summary' in value) || value['summary'] === undefined)
+        return false;
+    if (!('courses' in value) || value['courses'] === undefined)
+        return false;
+    if (!('topicsOfInterest' in value) || value['topicsOfInterest'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function UserContextFromJSON(json) {
+    return UserContextFromJSONTyped(json, false);
+}
+export function UserContextFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'userId': json['userId'],
+        'chatId': json['chatId'],
+        'preferredName': json['preferredName'],
+        'summary': json['summary'],
+        'courses': json['courses'],
+        'topicsOfInterest': json['topicsOfInterest'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+export function UserContextToJSON(json) {
+    return UserContextToJSONTyped(json, false);
+}
+export function UserContextToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'userId': value['userId'],
+        'chatId': value['chatId'],
+        'preferredName': value['preferredName'],
+        'summary': value['summary'],
+        'courses': value['courses'],
+        'topicsOfInterest': value['topicsOfInterest'],
+        'createdAt': value['createdAt'].toISOString(),
+        'updatedAt': value['updatedAt'].toISOString(),
+    };
+}

package/dist/esm/models/index.d.ts

@@ -1,5 +1,12 @@
 export * from './Account';
+export * from './AdminChat';
+export * from './AdminChatAnalysis';
+export * from './AdminChatWithStats';
+export * from './AdminPaginatedChats';
+export * from './AdminStreak';
+export * from './AdminUserEngagement';
 export * from './Chat';
+export * from './ChatAnalysis';
 export * from './ChatRequest';
 export * from './ChatRequestAttachmentsInner';
 export * from './CreateAccountRequest';
@@ -48,6 +55,8 @@ export * from './UploadUrlRequest';
 export * from './UploadUrlRequestFilesInner';
 export * from './UploadUrlResponse';
 export * from './UpsertOverrideDto';
+export * from './UpsertUserContextRequest';
 export * from './UpsertVoteRequest';
+export * from './UserContext';
 export * from './Vote';
 export * from './VotesResponse';