@instructure/athena-api-client 1.0.12 → 1.0.13-rc.1

package/README.md

@@ -57,6 +57,12 @@ All URIs are relative to *http://localhost:3000*
 *AccountsApi* | [**createAccount**](docs/AccountsApi.md#createaccountoperation) | **POST** /api/v1/accounts | Create a new account
 *AccountsApi* | [**listAccounts**](docs/AccountsApi.md#listaccounts) | **GET** /api/v1/accounts | List all accounts
 *AccountsApi* | [**updateAccount**](docs/AccountsApi.md#updateaccount) | **PATCH** /api/v1/accounts/{id} | Update an account
+*AdminApi* | [**adminGetChat**](docs/AdminApi.md#admingetchat) | **GET** /api/v1/admin/chats/{chatId} | Get any chat by ID within the account
+*AdminApi* | [**adminGetChatAnalysis**](docs/AdminApi.md#admingetchatanalysis) | **GET** /api/v1/admin/chats/{chatId}/analysis | Get chat analysis for any chat within the account
+*AdminApi* | [**adminGetUserChats**](docs/AdminApi.md#admingetuserchats) | **GET** /api/v1/admin/users/{externalId}/chats | Get chats with stats for a user
+*AdminApi* | [**adminGetUserEngagement**](docs/AdminApi.md#admingetuserengagement) | **GET** /api/v1/admin/users/{externalId}/engagement | Get engagement dates for a user
+*AdminApi* | [**adminListChats**](docs/AdminApi.md#adminlistchats) | **GET** /api/v1/admin/chats | List recent chats across all account users
+*AdminApi* | [**adminListTopStreaks**](docs/AdminApi.md#adminlisttopstreaks) | **GET** /api/v1/admin/streaks | List top N streaks across the account
 *ChatAnalysisApi* | [**getChatAnalysis**](docs/ChatAnalysisApi.md#getchatanalysis) | **GET** /api/v1/chats/{chatId}/analysis | Get chat analysis
 *ChatsApi* | [**createChat**](docs/ChatsApi.md#createchatoperation) | **POST** /api/v1/chats | Create a chat
 *ChatsApi* | [**deleteChat**](docs/ChatsApi.md#deletechat) | **DELETE** /api/v1/chats/{chatId} | Delete a chat
@@ -108,6 +114,12 @@ All URIs are relative to *http://localhost:3000*
 ### Models
 
 - [Account](docs/Account.md)
+- [AdminChat](docs/AdminChat.md)
+- [AdminChatAnalysis](docs/AdminChatAnalysis.md)
+- [AdminChatWithStats](docs/AdminChatWithStats.md)
+- [AdminPaginatedChats](docs/AdminPaginatedChats.md)
+- [AdminStreak](docs/AdminStreak.md)
+- [AdminUserEngagement](docs/AdminUserEngagement.md)
 - [Chat](docs/Chat.md)
 - [ChatAnalysis](docs/ChatAnalysis.md)
 - [ChatRequest](docs/ChatRequest.md)

package/dist/apis/AdminApi.d.ts

@@ -0,0 +1,92 @@
+/**
+ * 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 * as runtime from '../runtime';
+import type { AdminChat, AdminChatAnalysis, AdminChatWithStats, AdminPaginatedChats, AdminStreak, AdminUserEngagement } from '../models/index';
+export interface AdminGetChatRequest {
+    xUserId: string;
+    chatId: string;
+}
+export interface AdminGetChatAnalysisRequest {
+    xUserId: string;
+    chatId: string;
+}
+export interface AdminGetUserChatsRequest {
+    xUserId: string;
+    externalId: string;
+}
+export interface AdminGetUserEngagementRequest {
+    xUserId: string;
+    externalId: string;
+}
+export interface AdminListChatsRequest {
+    xUserId: string;
+    limit?: number;
+    cursor?: string;
+    chatType?: string;
+}
+export interface AdminListTopStreaksRequest {
+    xUserId: string;
+    limit?: number;
+}
+/**
+ *
+ */
+export declare class AdminApi extends runtime.BaseAPI {
+    /**
+     * Get any chat by ID within the account
+     */
+    adminGetChatRaw(requestParameters: AdminGetChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminChat>>;
+    /**
+     * Get any chat by ID within the account
+     */
+    adminGetChat(requestParameters: AdminGetChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminChat>;
+    /**
+     * Get chat analysis for any chat within the account
+     */
+    adminGetChatAnalysisRaw(requestParameters: AdminGetChatAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminChatAnalysis>>;
+    /**
+     * Get chat analysis for any chat within the account
+     */
+    adminGetChatAnalysis(requestParameters: AdminGetChatAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminChatAnalysis>;
+    /**
+     * Get chats with stats for a user
+     */
+    adminGetUserChatsRaw(requestParameters: AdminGetUserChatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AdminChatWithStats>>>;
+    /**
+     * Get chats with stats for a user
+     */
+    adminGetUserChats(requestParameters: AdminGetUserChatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminChatWithStats>>;
+    /**
+     * Get engagement dates for a user
+     */
+    adminGetUserEngagementRaw(requestParameters: AdminGetUserEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminUserEngagement>>;
+    /**
+     * Get engagement dates for a user
+     */
+    adminGetUserEngagement(requestParameters: AdminGetUserEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminUserEngagement>;
+    /**
+     * List recent chats across all account users
+     */
+    adminListChatsRaw(requestParameters: AdminListChatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminPaginatedChats>>;
+    /**
+     * List recent chats across all account users
+     */
+    adminListChats(requestParameters: AdminListChatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedChats>;
+    /**
+     * List top N streaks across the account
+     */
+    adminListTopStreaksRaw(requestParameters: AdminListTopStreaksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AdminStreak>>>;
+    /**
+     * List top N streaks across the account
+     */
+    adminListTopStreaks(requestParameters: AdminListTopStreaksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminStreak>>;
+}

package/dist/apis/AdminApi.js

@@ -0,0 +1,271 @@
+"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.
+ */
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdminApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class AdminApi extends runtime.BaseAPI {
+    /**
+     * Get any chat by ID within the account
+     */
+    adminGetChatRaw(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 adminGetChat().');
+            }
+            if (requestParameters['chatId'] == null) {
+                throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling adminGetChat().');
+            }
+            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/admin/chats/{chatId}`;
+            urlPath = urlPath.replace(`{${"chatId"}}`, encodeURIComponent(String(requestParameters['chatId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AdminChatFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get any chat by ID within the account
+     */
+    adminGetChat(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminGetChatRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Get chat analysis for any chat within the account
+     */
+    adminGetChatAnalysisRaw(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 adminGetChatAnalysis().');
+            }
+            if (requestParameters['chatId'] == null) {
+                throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling adminGetChatAnalysis().');
+            }
+            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/admin/chats/{chatId}/analysis`;
+            urlPath = urlPath.replace(`{${"chatId"}}`, encodeURIComponent(String(requestParameters['chatId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AdminChatAnalysisFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get chat analysis for any chat within the account
+     */
+    adminGetChatAnalysis(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminGetChatAnalysisRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Get chats with stats for a user
+     */
+    adminGetUserChatsRaw(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 adminGetUserChats().');
+            }
+            if (requestParameters['externalId'] == null) {
+                throw new runtime.RequiredError('externalId', 'Required parameter "externalId" was null or undefined when calling adminGetUserChats().');
+            }
+            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/admin/users/{externalId}/chats`;
+            urlPath = urlPath.replace(`{${"externalId"}}`, encodeURIComponent(String(requestParameters['externalId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.AdminChatWithStatsFromJSON));
+        });
+    }
+    /**
+     * Get chats with stats for a user
+     */
+    adminGetUserChats(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminGetUserChatsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Get engagement dates for a user
+     */
+    adminGetUserEngagementRaw(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 adminGetUserEngagement().');
+            }
+            if (requestParameters['externalId'] == null) {
+                throw new runtime.RequiredError('externalId', 'Required parameter "externalId" was null or undefined when calling adminGetUserEngagement().');
+            }
+            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/admin/users/{externalId}/engagement`;
+            urlPath = urlPath.replace(`{${"externalId"}}`, encodeURIComponent(String(requestParameters['externalId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AdminUserEngagementFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get engagement dates for a user
+     */
+    adminGetUserEngagement(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminGetUserEngagementRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * List recent chats across all account users
+     */
+    adminListChatsRaw(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 adminListChats().');
+            }
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['cursor'] != null) {
+                queryParameters['cursor'] = requestParameters['cursor'];
+            }
+            if (requestParameters['chatType'] != null) {
+                queryParameters['chatType'] = requestParameters['chatType'];
+            }
+            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/admin/chats`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AdminPaginatedChatsFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * List recent chats across all account users
+     */
+    adminListChats(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminListChatsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * List top N streaks across the account
+     */
+    adminListTopStreaksRaw(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 adminListTopStreaks().');
+            }
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            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/admin/streaks`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.AdminStreakFromJSON));
+        });
+    }
+    /**
+     * List top N streaks across the account
+     */
+    adminListTopStreaks(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminListTopStreaksRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.AdminApi = AdminApi;

package/dist/apis/index.d.ts

@@ -1,4 +1,5 @@
 export * from './AccountsApi';
+export * from './AdminApi';
 export * from './ChatAnalysisApi';
 export * from './ChatsApi';
 export * from './FeatureOverridesApi';

package/dist/apis/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /* tslint:disable */
 /* eslint-disable */
 __exportStar(require("./AccountsApi"), exports);
+__exportStar(require("./AdminApi"), exports);
 __exportStar(require("./ChatAnalysisApi"), exports);
 __exportStar(require("./ChatsApi"), exports);
 __exportStar(require("./FeatureOverridesApi"), exports);

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

@@ -0,0 +1,92 @@
+/**
+ * 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 * as runtime from '../runtime';
+import type { AdminChat, AdminChatAnalysis, AdminChatWithStats, AdminPaginatedChats, AdminStreak, AdminUserEngagement } from '../models/index';
+export interface AdminGetChatRequest {
+    xUserId: string;
+    chatId: string;
+}
+export interface AdminGetChatAnalysisRequest {
+    xUserId: string;
+    chatId: string;
+}
+export interface AdminGetUserChatsRequest {
+    xUserId: string;
+    externalId: string;
+}
+export interface AdminGetUserEngagementRequest {
+    xUserId: string;
+    externalId: string;
+}
+export interface AdminListChatsRequest {
+    xUserId: string;
+    limit?: number;
+    cursor?: string;
+    chatType?: string;
+}
+export interface AdminListTopStreaksRequest {
+    xUserId: string;
+    limit?: number;
+}
+/**
+ *
+ */
+export declare class AdminApi extends runtime.BaseAPI {
+    /**
+     * Get any chat by ID within the account
+     */
+    adminGetChatRaw(requestParameters: AdminGetChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminChat>>;
+    /**
+     * Get any chat by ID within the account
+     */
+    adminGetChat(requestParameters: AdminGetChatRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminChat>;
+    /**
+     * Get chat analysis for any chat within the account
+     */
+    adminGetChatAnalysisRaw(requestParameters: AdminGetChatAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminChatAnalysis>>;
+    /**
+     * Get chat analysis for any chat within the account
+     */
+    adminGetChatAnalysis(requestParameters: AdminGetChatAnalysisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminChatAnalysis>;
+    /**
+     * Get chats with stats for a user
+     */
+    adminGetUserChatsRaw(requestParameters: AdminGetUserChatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AdminChatWithStats>>>;
+    /**
+     * Get chats with stats for a user
+     */
+    adminGetUserChats(requestParameters: AdminGetUserChatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminChatWithStats>>;
+    /**
+     * Get engagement dates for a user
+     */
+    adminGetUserEngagementRaw(requestParameters: AdminGetUserEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminUserEngagement>>;
+    /**
+     * Get engagement dates for a user
+     */
+    adminGetUserEngagement(requestParameters: AdminGetUserEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminUserEngagement>;
+    /**
+     * List recent chats across all account users
+     */
+    adminListChatsRaw(requestParameters: AdminListChatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminPaginatedChats>>;
+    /**
+     * List recent chats across all account users
+     */
+    adminListChats(requestParameters: AdminListChatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminPaginatedChats>;
+    /**
+     * List top N streaks across the account
+     */
+    adminListTopStreaksRaw(requestParameters: AdminListTopStreaksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AdminStreak>>>;
+    /**
+     * List top N streaks across the account
+     */
+    adminListTopStreaks(requestParameters: AdminListTopStreaksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminStreak>>;
+}