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

package/dist/esm/models/index.js

@@ -1,7 +1,14 @@
 /* tslint:disable */
 /* eslint-disable */
 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';
@@ -50,6 +57,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';

package/dist/models/AdminChat.d.ts

@@ -0,0 +1,112 @@
+/**
+ * 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 AdminChat
+ */
+export interface AdminChat {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminChat
+     */
+    id: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminChat
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminChat
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminChat
+     */
+    chatType: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminChat
+     */
+    lastViewedAt: Date | null;
+    /**
+     * External user ID (externalId), null if not set
+     * @type {string}
+     * @memberof AdminChat
+     */
+    userId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminChat
+     */
+    visibility: AdminChatVisibilityEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminChat
+     */
+    subjectId: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminChat
+     */
+    latestJobId: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminChat
+     */
+    analysisScheduledFor: Date | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminChat
+     */
+    goal: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AdminChat
+     */
+    goalAchieved: boolean | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AdminChat
+     */
+    forReview: boolean;
+}
+/**
+ * @export
+ */
+export declare const AdminChatVisibilityEnum: {
+    readonly Public: "public";
+    readonly Private: "private";
+};
+export type AdminChatVisibilityEnum = typeof AdminChatVisibilityEnum[keyof typeof AdminChatVisibilityEnum];
+/**
+ * Check if a given object implements the AdminChat interface.
+ */
+export declare function instanceOfAdminChat(value: object): value is AdminChat;
+export declare function AdminChatFromJSON(json: any): AdminChat;
+export declare function AdminChatFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminChat;
+export declare function AdminChatToJSON(json: any): AdminChat;
+export declare function AdminChatToJSONTyped(value?: AdminChat | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminChat.js

@@ -0,0 +1,106 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdminChatVisibilityEnum = void 0;
+exports.instanceOfAdminChat = instanceOfAdminChat;
+exports.AdminChatFromJSON = AdminChatFromJSON;
+exports.AdminChatFromJSONTyped = AdminChatFromJSONTyped;
+exports.AdminChatToJSON = AdminChatToJSON;
+exports.AdminChatToJSONTyped = AdminChatToJSONTyped;
+/**
+ * @export
+ */
+exports.AdminChatVisibilityEnum = {
+    Public: 'public',
+    Private: 'private'
+};
+/**
+ * Check if a given object implements the AdminChat interface.
+ */
+function instanceOfAdminChat(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('chatType' in value) || value['chatType'] === undefined)
+        return false;
+    if (!('lastViewedAt' in value) || value['lastViewedAt'] === undefined)
+        return false;
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('visibility' in value) || value['visibility'] === undefined)
+        return false;
+    if (!('subjectId' in value) || value['subjectId'] === undefined)
+        return false;
+    if (!('latestJobId' in value) || value['latestJobId'] === undefined)
+        return false;
+    if (!('analysisScheduledFor' in value) || value['analysisScheduledFor'] === undefined)
+        return false;
+    if (!('goal' in value) || value['goal'] === undefined)
+        return false;
+    if (!('goalAchieved' in value) || value['goalAchieved'] === undefined)
+        return false;
+    if (!('forReview' in value) || value['forReview'] === undefined)
+        return false;
+    return true;
+}
+function AdminChatFromJSON(json) {
+    return AdminChatFromJSONTyped(json, false);
+}
+function AdminChatFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'createdAt': (new Date(json['createdAt'])),
+        'title': json['title'],
+        'chatType': json['chatType'],
+        'lastViewedAt': (json['lastViewedAt'] == null ? null : new Date(json['lastViewedAt'])),
+        'userId': json['userId'],
+        'visibility': json['visibility'],
+        'subjectId': json['subjectId'],
+        'latestJobId': json['latestJobId'],
+        'analysisScheduledFor': (json['analysisScheduledFor'] == null ? null : new Date(json['analysisScheduledFor'])),
+        'goal': json['goal'],
+        'goalAchieved': json['goalAchieved'],
+        'forReview': json['forReview'],
+    };
+}
+function AdminChatToJSON(json) {
+    return AdminChatToJSONTyped(json, false);
+}
+function AdminChatToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'createdAt': value['createdAt'].toISOString(),
+        'title': value['title'],
+        'chatType': value['chatType'],
+        'lastViewedAt': value['lastViewedAt'] == null ? value['lastViewedAt'] : value['lastViewedAt'].toISOString(),
+        'userId': value['userId'],
+        'visibility': value['visibility'],
+        'subjectId': value['subjectId'],
+        'latestJobId': value['latestJobId'],
+        'analysisScheduledFor': value['analysisScheduledFor'] == null ? value['analysisScheduledFor'] : value['analysisScheduledFor'].toISOString(),
+        'goal': value['goal'],
+        'goalAchieved': value['goalAchieved'],
+        'forReview': value['forReview'],
+    };
+}

package/dist/models/AdminChatAnalysis.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 AdminChatAnalysis
+ */
+export interface AdminChatAnalysis {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminChatAnalysis
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminChatAnalysis
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminChatAnalysis
+     */
+    goal: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AdminChatAnalysis
+     */
+    goalAchieved: boolean | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminChatAnalysis
+     */
+    subject: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminChatAnalysis
+     */
+    summary: string | null;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof AdminChatAnalysis
+     */
+    concepts: Array<string>;
+}
+/**
+ * Check if a given object implements the AdminChatAnalysis interface.
+ */
+export declare function instanceOfAdminChatAnalysis(value: object): value is AdminChatAnalysis;
+export declare function AdminChatAnalysisFromJSON(json: any): AdminChatAnalysis;
+export declare function AdminChatAnalysisFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminChatAnalysis;
+export declare function AdminChatAnalysisToJSON(json: any): AdminChatAnalysis;
+export declare function AdminChatAnalysisToJSONTyped(value?: AdminChatAnalysis | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminChatAnalysis.js

@@ -0,0 +1,74 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfAdminChatAnalysis = instanceOfAdminChatAnalysis;
+exports.AdminChatAnalysisFromJSON = AdminChatAnalysisFromJSON;
+exports.AdminChatAnalysisFromJSONTyped = AdminChatAnalysisFromJSONTyped;
+exports.AdminChatAnalysisToJSON = AdminChatAnalysisToJSON;
+exports.AdminChatAnalysisToJSONTyped = AdminChatAnalysisToJSONTyped;
+/**
+ * Check if a given object implements the AdminChatAnalysis interface.
+ */
+function instanceOfAdminChatAnalysis(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === 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 (!('summary' in value) || value['summary'] === undefined)
+        return false;
+    if (!('concepts' in value) || value['concepts'] === undefined)
+        return false;
+    return true;
+}
+function AdminChatAnalysisFromJSON(json) {
+    return AdminChatAnalysisFromJSONTyped(json, false);
+}
+function AdminChatAnalysisFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'title': json['title'],
+        'goal': json['goal'],
+        'goalAchieved': json['goalAchieved'],
+        'subject': json['subject'],
+        'summary': json['summary'],
+        'concepts': json['concepts'],
+    };
+}
+function AdminChatAnalysisToJSON(json) {
+    return AdminChatAnalysisToJSONTyped(json, false);
+}
+function AdminChatAnalysisToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'title': value['title'],
+        'goal': value['goal'],
+        'goalAchieved': value['goalAchieved'],
+        'subject': value['subject'],
+        'summary': value['summary'],
+        'concepts': value['concepts'],
+    };
+}

package/dist/models/AdminChatWithStats.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 AdminChatWithStats
+ */
+export interface AdminChatWithStats {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminChatWithStats
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminChatWithStats
+     */
+    title: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminChatWithStats
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminChatWithStats
+     */
+    messageCount: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminChatWithStats
+     */
+    lastMessageAt: Date | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminChatWithStats
+     */
+    subjectName: string | null;
+}
+/**
+ * Check if a given object implements the AdminChatWithStats interface.
+ */
+export declare function instanceOfAdminChatWithStats(value: object): value is AdminChatWithStats;
+export declare function AdminChatWithStatsFromJSON(json: any): AdminChatWithStats;
+export declare function AdminChatWithStatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminChatWithStats;
+export declare function AdminChatWithStatsToJSON(json: any): AdminChatWithStats;
+export declare function AdminChatWithStatsToJSONTyped(value?: AdminChatWithStats | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminChatWithStats.js

@@ -0,0 +1,70 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfAdminChatWithStats = instanceOfAdminChatWithStats;
+exports.AdminChatWithStatsFromJSON = AdminChatWithStatsFromJSON;
+exports.AdminChatWithStatsFromJSONTyped = AdminChatWithStatsFromJSONTyped;
+exports.AdminChatWithStatsToJSON = AdminChatWithStatsToJSON;
+exports.AdminChatWithStatsToJSONTyped = AdminChatWithStatsToJSONTyped;
+/**
+ * Check if a given object implements the AdminChatWithStats interface.
+ */
+function instanceOfAdminChatWithStats(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('messageCount' in value) || value['messageCount'] === undefined)
+        return false;
+    if (!('lastMessageAt' in value) || value['lastMessageAt'] === undefined)
+        return false;
+    if (!('subjectName' in value) || value['subjectName'] === undefined)
+        return false;
+    return true;
+}
+function AdminChatWithStatsFromJSON(json) {
+    return AdminChatWithStatsFromJSONTyped(json, false);
+}
+function AdminChatWithStatsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'title': json['title'],
+        'createdAt': (new Date(json['createdAt'])),
+        'messageCount': json['messageCount'],
+        'lastMessageAt': (json['lastMessageAt'] == null ? null : new Date(json['lastMessageAt'])),
+        'subjectName': json['subjectName'],
+    };
+}
+function AdminChatWithStatsToJSON(json) {
+    return AdminChatWithStatsToJSONTyped(json, false);
+}
+function AdminChatWithStatsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'title': value['title'],
+        'createdAt': value['createdAt'].toISOString(),
+        'messageCount': value['messageCount'],
+        'lastMessageAt': value['lastMessageAt'] == null ? value['lastMessageAt'] : value['lastMessageAt'].toISOString(),
+        'subjectName': value['subjectName'],
+    };
+}

package/dist/models/AdminPaginatedChats.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 { AdminChat } from './AdminChat';
+/**
+ *
+ * @export
+ * @interface AdminPaginatedChats
+ */
+export interface AdminPaginatedChats {
+    /**
+     *
+     * @type {Array<AdminChat>}
+     * @memberof AdminPaginatedChats
+     */
+    data: Array<AdminChat>;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminPaginatedChats
+     */
+    nextCursor: string | null;
+}
+/**
+ * Check if a given object implements the AdminPaginatedChats interface.
+ */
+export declare function instanceOfAdminPaginatedChats(value: object): value is AdminPaginatedChats;
+export declare function AdminPaginatedChatsFromJSON(json: any): AdminPaginatedChats;
+export declare function AdminPaginatedChatsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminPaginatedChats;
+export declare function AdminPaginatedChatsToJSON(json: any): AdminPaginatedChats;
+export declare function AdminPaginatedChatsToJSONTyped(value?: AdminPaginatedChats | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminPaginatedChats.js

@@ -0,0 +1,55 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfAdminPaginatedChats = instanceOfAdminPaginatedChats;
+exports.AdminPaginatedChatsFromJSON = AdminPaginatedChatsFromJSON;
+exports.AdminPaginatedChatsFromJSONTyped = AdminPaginatedChatsFromJSONTyped;
+exports.AdminPaginatedChatsToJSON = AdminPaginatedChatsToJSON;
+exports.AdminPaginatedChatsToJSONTyped = AdminPaginatedChatsToJSONTyped;
+const AdminChat_1 = require("./AdminChat");
+/**
+ * Check if a given object implements the AdminPaginatedChats interface.
+ */
+function instanceOfAdminPaginatedChats(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+function AdminPaginatedChatsFromJSON(json) {
+    return AdminPaginatedChatsFromJSONTyped(json, false);
+}
+function AdminPaginatedChatsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(AdminChat_1.AdminChatFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+function AdminPaginatedChatsToJSON(json) {
+    return AdminPaginatedChatsToJSONTyped(json, false);
+}
+function AdminPaginatedChatsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(AdminChat_1.AdminChatToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

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