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

package/dist/esm/apis/UserContextApi.js

@@ -0,0 +1,108 @@
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { UpsertUserContextRequestToJSON, UserContextFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class UserContextApi extends runtime.BaseAPI {
+    /**
+     * Returns the personalization context for the authenticated user.
+     * Get user context
+     */
+    getUserContextRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getUserContext().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/user-context`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => UserContextFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the personalization context for the authenticated user.
+     * Get user context
+     */
+    getUserContext(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getUserContextRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates or updates the personalization context for the authenticated user.
+     * Create or update user context
+     */
+    upsertUserContextRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling upsertUserContext().');
+            }
+            if (requestParameters['upsertUserContextRequest'] == null) {
+                throw new runtime.RequiredError('upsertUserContextRequest', 'Required parameter "upsertUserContextRequest" was null or undefined when calling upsertUserContext().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/user-context`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: UpsertUserContextRequestToJSON(requestParameters['upsertUserContextRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => UserContextFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Creates or updates the personalization context for the authenticated user.
+     * Create or update user context
+     */
+    upsertUserContext(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.upsertUserContextRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -1,4 +1,6 @@
 export * from './AccountsApi';
+export * from './AdminApi';
+export * from './ChatAnalysisApi';
 export * from './ChatsApi';
 export * from './FeatureOverridesApi';
 export * from './FeaturesApi';
@@ -13,4 +15,5 @@ export * from './QuizSessionsApi';
 export * from './QuizzesApi';
 export * from './ServiceTokensApi';
 export * from './TagsApi';
+export * from './UserContextApi';
 export * from './VotesApi';

package/dist/esm/apis/index.js

@@ -1,6 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 export * from './AccountsApi';
+export * from './AdminApi';
+export * from './ChatAnalysisApi';
 export * from './ChatsApi';
 export * from './FeatureOverridesApi';
 export * from './FeaturesApi';
@@ -15,4 +17,5 @@ export * from './QuizSessionsApi';
 export * from './QuizzesApi';
 export * from './ServiceTokensApi';
 export * from './TagsApi';
+export * from './UserContextApi';
 export * from './VotesApi';

package/dist/esm/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/esm/models/AdminChat.js

@@ -0,0 +1,98 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const AdminChatVisibilityEnum = {
+    Public: 'public',
+    Private: 'private'
+};
+/**
+ * Check if a given object implements the AdminChat interface.
+ */
+export 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;
+}
+export function AdminChatFromJSON(json) {
+    return AdminChatFromJSONTyped(json, false);
+}
+export 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'],
+    };
+}
+export function AdminChatToJSON(json) {
+    return AdminChatToJSONTyped(json, false);
+}
+export 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/esm/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/esm/models/AdminChatAnalysis.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 AdminChatAnalysis interface.
+ */
+export 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;
+}
+export function AdminChatAnalysisFromJSON(json) {
+    return AdminChatAnalysisFromJSONTyped(json, false);
+}
+export 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'],
+    };
+}
+export function AdminChatAnalysisToJSON(json) {
+    return AdminChatAnalysisToJSONTyped(json, false);
+}
+export 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/esm/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/esm/models/AdminChatWithStats.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 AdminChatWithStats interface.
+ */
+export 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;
+}
+export function AdminChatWithStatsFromJSON(json) {
+    return AdminChatWithStatsFromJSONTyped(json, false);
+}
+export 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'],
+    };
+}
+export function AdminChatWithStatsToJSON(json) {
+    return AdminChatWithStatsToJSONTyped(json, false);
+}
+export 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/esm/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;