@instructure/athena-api-client 1.0.10 → 1.0.12

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

@@ -0,0 +1,44 @@
+/**
+ * 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 UpsertOverrideDto
+ */
+export interface UpsertOverrideDto {
+    /**
+     *
+     * @type {string}
+     * @memberof UpsertOverrideDto
+     */
+    accountId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UpsertOverrideDto
+     */
+    featureId: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UpsertOverrideDto
+     */
+    enabled: boolean;
+}
+/**
+ * Check if a given object implements the UpsertOverrideDto interface.
+ */
+export declare function instanceOfUpsertOverrideDto(value: object): value is UpsertOverrideDto;
+export declare function UpsertOverrideDtoFromJSON(json: any): UpsertOverrideDto;
+export declare function UpsertOverrideDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpsertOverrideDto;
+export declare function UpsertOverrideDtoToJSON(json: any): UpsertOverrideDto;
+export declare function UpsertOverrideDtoToJSONTyped(value?: UpsertOverrideDto | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UpsertOverrideDto.js

@@ -0,0 +1,51 @@
+/* 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 UpsertOverrideDto interface.
+ */
+export function instanceOfUpsertOverrideDto(value) {
+    if (!('accountId' in value) || value['accountId'] === undefined)
+        return false;
+    if (!('featureId' in value) || value['featureId'] === undefined)
+        return false;
+    if (!('enabled' in value) || value['enabled'] === undefined)
+        return false;
+    return true;
+}
+export function UpsertOverrideDtoFromJSON(json) {
+    return UpsertOverrideDtoFromJSONTyped(json, false);
+}
+export function UpsertOverrideDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'accountId': json['accountId'],
+        'featureId': json['featureId'],
+        'enabled': json['enabled'],
+    };
+}
+export function UpsertOverrideDtoToJSON(json) {
+    return UpsertOverrideDtoToJSONTyped(json, false);
+}
+export function UpsertOverrideDtoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'accountId': value['accountId'],
+        'featureId': value['featureId'],
+        'enabled': value['enabled'],
+    };
+}

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/VotesResponse.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 type { Vote } from './Vote';
+/**
+ *
+ * @export
+ * @interface VotesResponse
+ */
+export interface VotesResponse {
+    /**
+     * Array of vote objects
+     * @type {Array<Vote>}
+     * @memberof VotesResponse
+     */
+    data: Array<Vote>;
+}
+/**
+ * Check if a given object implements the VotesResponse interface.
+ */
+export declare function instanceOfVotesResponse(value: object): value is VotesResponse;
+export declare function VotesResponseFromJSON(json: any): VotesResponse;
+export declare function VotesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): VotesResponse;
+export declare function VotesResponseToJSON(json: any): VotesResponse;
+export declare function VotesResponseToJSONTyped(value?: VotesResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/VotesResponse.js

@@ -0,0 +1,44 @@
+/* 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 { VoteFromJSON, VoteToJSON, } from './Vote';
+/**
+ * Check if a given object implements the VotesResponse interface.
+ */
+export function instanceOfVotesResponse(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    return true;
+}
+export function VotesResponseFromJSON(json) {
+    return VotesResponseFromJSONTyped(json, false);
+}
+export function VotesResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(VoteFromJSON)),
+    };
+}
+export function VotesResponseToJSON(json) {
+    return VotesResponseToJSONTyped(json, false);
+}
+export function VotesResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(VoteToJSON)),
+    };
+}

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

@@ -1,44 +1,56 @@
 export * from './Account';
 export * from './Chat';
+export * from './ChatAnalysis';
 export * from './ChatRequest';
 export * from './ChatRequestAttachmentsInner';
 export * from './CreateAccountRequest';
-export * from './CreateChatMessages201Response';
 export * from './CreateChatRequest';
+export * from './CreateFeatureDto';
 export * from './CreateMessagesRequest';
 export * from './CreateMessagesRequestMessagesInner';
+export * from './CreateMessagesResponse';
+export * from './CreatePlanDto';
 export * from './CreateTokenRequest';
 export * from './CreateTokenResponse';
+export * from './FeatureEntity';
+export * from './FeatureOverrideEntity';
+export * from './HealthCheck';
 export * from './LearningDaysResponse';
 export * from './LearningMoment';
 export * from './LearningStreakResponse';
-export * from './ListChatVotes200Response';
 export * from './Message';
-export * from './MessageAttachmentsInner';
+export * from './MessageAttachment';
 export * from './MessageCountResponse';
-export * from './MessagePartsInner';
-export * from './ModelError';
+export * from './MessagePart';
 export * from './PaginatedChats';
 export * from './PaginatedLearningMoments';
 export * from './PaginatedMessages';
+export * from './Plan';
 export * from './Quiz';
 export * from './QuizQuestion';
 export * from './QuizResponse';
 export * from './QuizSession';
 export * from './QuizSessionSummary';
-export * from './QuizSessionSummaryScore';
 export * from './QuizWithQuestions';
+export * from './Score';
 export * from './ScoreByTypeValue';
 export * from './ServiceToken';
 export * from './SubmitQuizResponseRequest';
 export * from './Tag';
+export * from './UpdateAccountDto';
 export * from './UpdateChatRequest';
+export * from './UpdateFeatureDto';
+export * from './UpdatePlanDto';
 export * from './UpdateQuizSessionRequest';
 export * from './UpdateTokenRequest';
 export * from './UpdateTokenResponse';
+export * from './UploadUrlFile';
 export * from './UploadUrlRequest';
 export * from './UploadUrlRequestFilesInner';
 export * from './UploadUrlResponse';
-export * from './UploadUrlResponseFilesInner';
+export * from './UpsertOverrideDto';
+export * from './UpsertUserContextRequest';
 export * from './UpsertVoteRequest';
+export * from './UserContext';
 export * from './Vote';
+export * from './VotesResponse';

package/dist/esm/models/index.js

@@ -2,45 +2,57 @@
 /* eslint-disable */
 export * from './Account';
 export * from './Chat';
+export * from './ChatAnalysis';
 export * from './ChatRequest';
 export * from './ChatRequestAttachmentsInner';
 export * from './CreateAccountRequest';
-export * from './CreateChatMessages201Response';
 export * from './CreateChatRequest';
+export * from './CreateFeatureDto';
 export * from './CreateMessagesRequest';
 export * from './CreateMessagesRequestMessagesInner';
+export * from './CreateMessagesResponse';
+export * from './CreatePlanDto';
 export * from './CreateTokenRequest';
 export * from './CreateTokenResponse';
+export * from './FeatureEntity';
+export * from './FeatureOverrideEntity';
+export * from './HealthCheck';
 export * from './LearningDaysResponse';
 export * from './LearningMoment';
 export * from './LearningStreakResponse';
-export * from './ListChatVotes200Response';
 export * from './Message';
-export * from './MessageAttachmentsInner';
+export * from './MessageAttachment';
 export * from './MessageCountResponse';
-export * from './MessagePartsInner';
-export * from './ModelError';
+export * from './MessagePart';
 export * from './PaginatedChats';
 export * from './PaginatedLearningMoments';
 export * from './PaginatedMessages';
+export * from './Plan';
 export * from './Quiz';
 export * from './QuizQuestion';
 export * from './QuizResponse';
 export * from './QuizSession';
 export * from './QuizSessionSummary';
-export * from './QuizSessionSummaryScore';
 export * from './QuizWithQuestions';
+export * from './Score';
 export * from './ScoreByTypeValue';
 export * from './ServiceToken';
 export * from './SubmitQuizResponseRequest';
 export * from './Tag';
+export * from './UpdateAccountDto';
 export * from './UpdateChatRequest';
+export * from './UpdateFeatureDto';
+export * from './UpdatePlanDto';
 export * from './UpdateQuizSessionRequest';
 export * from './UpdateTokenRequest';
 export * from './UpdateTokenResponse';
+export * from './UploadUrlFile';
 export * from './UploadUrlRequest';
 export * from './UploadUrlRequestFilesInner';
 export * from './UploadUrlResponse';
-export * from './UploadUrlResponseFilesInner';
+export * from './UpsertOverrideDto';
+export * from './UpsertUserContextRequest';
 export * from './UpsertVoteRequest';
+export * from './UserContext';
 export * from './Vote';
+export * from './VotesResponse';

package/dist/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;