@instructure/athena-api-client 3.33.2 → 3.33.3

package/README.md

@@ -65,6 +65,7 @@ All URIs are relative to *http://localhost:3000*
 *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* | [**adminGetUsersActivity**](docs/AdminApi.md#admingetusersactivity) | **POST** /api/v1/admin/users/activity | Get per-day activity for a batch of users
+*AdminApi* | [**adminGetUsersActivityTotals**](docs/AdminApi.md#admingetusersactivitytotals) | **POST** /api/v1/admin/users/activity-totals | Get lifetime activity totals for a batch of users
 *AdminApi* | [**adminListActiveStreaks**](docs/AdminApi.md#adminlistactivestreaks) | **GET** /api/v1/admin/streaks/active | List all active streaks (currentDays > 0) across the account, paginated
 *AdminApi* | [**adminListChats**](docs/AdminApi.md#adminlistchats) | **GET** /api/v1/admin/chats | List recent chats across all account users
 *AdminApi* | [**adminListLastExchanges**](docs/AdminApi.md#adminlistlastexchanges) | **GET** /api/v1/admin/last-exchanges | List the final user message and assistant reply for low-engagement new users
@@ -215,8 +216,10 @@ All URIs are relative to *http://localhost:3000*
 - [AdminUpdateChatRequest](docs/AdminUpdateChatRequest.md)
 - [AdminUserActivity](docs/AdminUserActivity.md)
 - [AdminUserActivityDay](docs/AdminUserActivityDay.md)
+- [AdminUserActivityTotals](docs/AdminUserActivityTotals.md)
 - [AdminUserEngagement](docs/AdminUserEngagement.md)
 - [AdminUsersActivityRequest](docs/AdminUsersActivityRequest.md)
+- [AdminUsersActivityTotalsRequest](docs/AdminUsersActivityTotalsRequest.md)
 - [AssociateUserFileRequest](docs/AssociateUserFileRequest.md)
 - [CanvasCourseAccess](docs/CanvasCourseAccess.md)
 - [CanvasDomainMatch](docs/CanvasDomainMatch.md)

package/dist/apis/AdminApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AdminChat, AdminChatAnalysis, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedLastExchanges, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminResetLearningDataResponse, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserEngagement, AdminUsersActivityRequest, QuizSessionSummary } from '../models/index';
+import type { AdminChat, AdminChatAnalysis, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedLastExchanges, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminResetLearningDataResponse, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserActivityTotals, AdminUserEngagement, AdminUsersActivityRequest, AdminUsersActivityTotalsRequest, QuizSessionSummary } from '../models/index';
 export interface AdminGetChatRequest {
     xUserId: string;
     chatId: string;
@@ -43,6 +43,10 @@ export interface AdminGetUsersActivityRequest {
     xUserId: string;
     adminUsersActivityRequest: AdminUsersActivityRequest;
 }
+export interface AdminGetUsersActivityTotalsRequest {
+    xUserId: string;
+    adminUsersActivityTotalsRequest: AdminUsersActivityTotalsRequest;
+}
 export interface AdminListActiveStreaksRequest {
     xUserId: string;
     limit?: number;
@@ -187,6 +191,16 @@ export declare class AdminApi extends runtime.BaseAPI {
      * Get per-day activity for a batch of users
      */
     adminGetUsersActivity(requestParameters: AdminGetUsersActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminUserActivity>>;
+    /**
+     * Returns, for each known external user id, all-time counts of messages sent (in a regular or level-up chat, the same definition the per-day activity endpoint uses), quiz questions answered (daily quiz included), and flashcards viewed (the per-card view counter summed over the flashcard sets the user owns). Unknown external ids are omitted from the response.
+     * Get lifetime activity totals for a batch of users
+     */
+    adminGetUsersActivityTotalsRaw(requestParameters: AdminGetUsersActivityTotalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AdminUserActivityTotals>>>;
+    /**
+     * Returns, for each known external user id, all-time counts of messages sent (in a regular or level-up chat, the same definition the per-day activity endpoint uses), quiz questions answered (daily quiz included), and flashcards viewed (the per-card view counter summed over the flashcard sets the user owns). Unknown external ids are omitted from the response.
+     * Get lifetime activity totals for a batch of users
+     */
+    adminGetUsersActivityTotals(requestParameters: AdminGetUsersActivityTotalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminUserActivityTotals>>;
     /**
      * List all active streaks (currentDays > 0) across the account, paginated
      */

package/dist/apis/AdminApi.js

@@ -352,6 +352,48 @@ class AdminApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns, for each known external user id, all-time counts of messages sent (in a regular or level-up chat, the same definition the per-day activity endpoint uses), quiz questions answered (daily quiz included), and flashcards viewed (the per-card view counter summed over the flashcard sets the user owns). Unknown external ids are omitted from the response.
+     * Get lifetime activity totals for a batch of users
+     */
+    adminGetUsersActivityTotalsRaw(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 adminGetUsersActivityTotals().');
+            }
+            if (requestParameters['adminUsersActivityTotalsRequest'] == null) {
+                throw new runtime.RequiredError('adminUsersActivityTotalsRequest', 'Required parameter "adminUsersActivityTotalsRequest" was null or undefined when calling adminGetUsersActivityTotals().');
+            }
+            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/admin/users/activity-totals`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.AdminUsersActivityTotalsRequestToJSON)(requestParameters['adminUsersActivityTotalsRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.AdminUserActivityTotalsFromJSON));
+        });
+    }
+    /**
+     * Returns, for each known external user id, all-time counts of messages sent (in a regular or level-up chat, the same definition the per-day activity endpoint uses), quiz questions answered (daily quiz included), and flashcards viewed (the per-card view counter summed over the flashcard sets the user owns). Unknown external ids are omitted from the response.
+     * Get lifetime activity totals for a batch of users
+     */
+    adminGetUsersActivityTotals(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminGetUsersActivityTotalsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * List all active streaks (currentDays > 0) across the account, paginated
      */

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

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { AdminChat, AdminChatAnalysis, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedLastExchanges, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminResetLearningDataResponse, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserEngagement, AdminUsersActivityRequest, QuizSessionSummary } from '../models/index';
+import type { AdminChat, AdminChatAnalysis, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedLastExchanges, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminResetLearningDataResponse, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserActivityTotals, AdminUserEngagement, AdminUsersActivityRequest, AdminUsersActivityTotalsRequest, QuizSessionSummary } from '../models/index';
 export interface AdminGetChatRequest {
     xUserId: string;
     chatId: string;
@@ -43,6 +43,10 @@ export interface AdminGetUsersActivityRequest {
     xUserId: string;
     adminUsersActivityRequest: AdminUsersActivityRequest;
 }
+export interface AdminGetUsersActivityTotalsRequest {
+    xUserId: string;
+    adminUsersActivityTotalsRequest: AdminUsersActivityTotalsRequest;
+}
 export interface AdminListActiveStreaksRequest {
     xUserId: string;
     limit?: number;
@@ -187,6 +191,16 @@ export declare class AdminApi extends runtime.BaseAPI {
      * Get per-day activity for a batch of users
      */
     adminGetUsersActivity(requestParameters: AdminGetUsersActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminUserActivity>>;
+    /**
+     * Returns, for each known external user id, all-time counts of messages sent (in a regular or level-up chat, the same definition the per-day activity endpoint uses), quiz questions answered (daily quiz included), and flashcards viewed (the per-card view counter summed over the flashcard sets the user owns). Unknown external ids are omitted from the response.
+     * Get lifetime activity totals for a batch of users
+     */
+    adminGetUsersActivityTotalsRaw(requestParameters: AdminGetUsersActivityTotalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AdminUserActivityTotals>>>;
+    /**
+     * Returns, for each known external user id, all-time counts of messages sent (in a regular or level-up chat, the same definition the per-day activity endpoint uses), quiz questions answered (daily quiz included), and flashcards viewed (the per-card view counter summed over the flashcard sets the user owns). Unknown external ids are omitted from the response.
+     * Get lifetime activity totals for a batch of users
+     */
+    adminGetUsersActivityTotals(requestParameters: AdminGetUsersActivityTotalsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminUserActivityTotals>>;
     /**
      * List all active streaks (currentDays > 0) across the account, paginated
      */

package/dist/esm/apis/AdminApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { AdminChatFromJSON, AdminChatAnalysisFromJSON, AdminChatWithStatsFromJSON, AdminCohortStatsFromJSON, AdminPaginatedActiveStreaksFromJSON, AdminPaginatedChatsFromJSON, AdminPaginatedLastExchangesFromJSON, AdminPaginatedQuizSessionsFromJSON, AdminPaginatedStudyObjectiveUserCountsFromJSON, AdminPaginatedStudyObjectivesFromJSON, AdminPaginatedTaxonomyEnrollmentsFromJSON, AdminResetLearningDataResponseFromJSON, AdminStreakFromJSON, AdminStudyObjectiveSummaryFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserActivityFromJSON, AdminUserEngagementFromJSON, AdminUsersActivityRequestToJSON, QuizSessionSummaryFromJSON, } from '../models/index';
+import { AdminChatFromJSON, AdminChatAnalysisFromJSON, AdminChatWithStatsFromJSON, AdminCohortStatsFromJSON, AdminPaginatedActiveStreaksFromJSON, AdminPaginatedChatsFromJSON, AdminPaginatedLastExchangesFromJSON, AdminPaginatedQuizSessionsFromJSON, AdminPaginatedStudyObjectiveUserCountsFromJSON, AdminPaginatedStudyObjectivesFromJSON, AdminPaginatedTaxonomyEnrollmentsFromJSON, AdminResetLearningDataResponseFromJSON, AdminStreakFromJSON, AdminStudyObjectiveSummaryFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserActivityFromJSON, AdminUserActivityTotalsFromJSON, AdminUserEngagementFromJSON, AdminUsersActivityRequestToJSON, AdminUsersActivityTotalsRequestToJSON, QuizSessionSummaryFromJSON, } from '../models/index';
 /**
  *
  */
@@ -349,6 +349,48 @@ export class AdminApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns, for each known external user id, all-time counts of messages sent (in a regular or level-up chat, the same definition the per-day activity endpoint uses), quiz questions answered (daily quiz included), and flashcards viewed (the per-card view counter summed over the flashcard sets the user owns). Unknown external ids are omitted from the response.
+     * Get lifetime activity totals for a batch of users
+     */
+    adminGetUsersActivityTotalsRaw(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 adminGetUsersActivityTotals().');
+            }
+            if (requestParameters['adminUsersActivityTotalsRequest'] == null) {
+                throw new runtime.RequiredError('adminUsersActivityTotalsRequest', 'Required parameter "adminUsersActivityTotalsRequest" was null or undefined when calling adminGetUsersActivityTotals().');
+            }
+            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/admin/users/activity-totals`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: AdminUsersActivityTotalsRequestToJSON(requestParameters['adminUsersActivityTotalsRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(AdminUserActivityTotalsFromJSON));
+        });
+    }
+    /**
+     * Returns, for each known external user id, all-time counts of messages sent (in a regular or level-up chat, the same definition the per-day activity endpoint uses), quiz questions answered (daily quiz included), and flashcards viewed (the per-card view counter summed over the flashcard sets the user owns). Unknown external ids are omitted from the response.
+     * Get lifetime activity totals for a batch of users
+     */
+    adminGetUsersActivityTotals(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminGetUsersActivityTotalsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * List all active streaks (currentDays > 0) across the account, paginated
      */

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

@@ -0,0 +1,50 @@
+/**
+ * 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 AdminUserActivityTotals
+ */
+export interface AdminUserActivityTotals {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminUserActivityTotals
+     */
+    externalId: string;
+    /**
+     * Messages the user sent in regular or level-up chats, all time
+     * @type {number}
+     * @memberof AdminUserActivityTotals
+     */
+    messagesSent: number;
+    /**
+     * Quiz questions the user answered, all time (daily quiz included)
+     * @type {number}
+     * @memberof AdminUserActivityTotals
+     */
+    quizQuestionsAnswered: number;
+    /**
+     * Card views recorded across the flashcard sets the user owns, all time
+     * @type {number}
+     * @memberof AdminUserActivityTotals
+     */
+    flashcardsViewed: number;
+}
+/**
+ * Check if a given object implements the AdminUserActivityTotals interface.
+ */
+export declare function instanceOfAdminUserActivityTotals(value: object): value is AdminUserActivityTotals;
+export declare function AdminUserActivityTotalsFromJSON(json: any): AdminUserActivityTotals;
+export declare function AdminUserActivityTotalsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminUserActivityTotals;
+export declare function AdminUserActivityTotalsToJSON(json: any): AdminUserActivityTotals;
+export declare function AdminUserActivityTotalsToJSONTyped(value?: AdminUserActivityTotals | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminUserActivityTotals.js

@@ -0,0 +1,55 @@
+/* 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 AdminUserActivityTotals interface.
+ */
+export function instanceOfAdminUserActivityTotals(value) {
+    if (!('externalId' in value) || value['externalId'] === undefined)
+        return false;
+    if (!('messagesSent' in value) || value['messagesSent'] === undefined)
+        return false;
+    if (!('quizQuestionsAnswered' in value) || value['quizQuestionsAnswered'] === undefined)
+        return false;
+    if (!('flashcardsViewed' in value) || value['flashcardsViewed'] === undefined)
+        return false;
+    return true;
+}
+export function AdminUserActivityTotalsFromJSON(json) {
+    return AdminUserActivityTotalsFromJSONTyped(json, false);
+}
+export function AdminUserActivityTotalsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'externalId': json['externalId'],
+        'messagesSent': json['messagesSent'],
+        'quizQuestionsAnswered': json['quizQuestionsAnswered'],
+        'flashcardsViewed': json['flashcardsViewed'],
+    };
+}
+export function AdminUserActivityTotalsToJSON(json) {
+    return AdminUserActivityTotalsToJSONTyped(json, false);
+}
+export function AdminUserActivityTotalsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'externalId': value['externalId'],
+        'messagesSent': value['messagesSent'],
+        'quizQuestionsAnswered': value['quizQuestionsAnswered'],
+        'flashcardsViewed': value['flashcardsViewed'],
+    };
+}

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

@@ -0,0 +1,32 @@
+/**
+ * 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 AdminUsersActivityTotalsRequest
+ */
+export interface AdminUsersActivityTotalsRequest {
+    /**
+     * External user identifiers to fetch activity for
+     * @type {Array<string>}
+     * @memberof AdminUsersActivityTotalsRequest
+     */
+    externalIds: Array<string>;
+}
+/**
+ * Check if a given object implements the AdminUsersActivityTotalsRequest interface.
+ */
+export declare function instanceOfAdminUsersActivityTotalsRequest(value: object): value is AdminUsersActivityTotalsRequest;
+export declare function AdminUsersActivityTotalsRequestFromJSON(json: any): AdminUsersActivityTotalsRequest;
+export declare function AdminUsersActivityTotalsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminUsersActivityTotalsRequest;
+export declare function AdminUsersActivityTotalsRequestToJSON(json: any): AdminUsersActivityTotalsRequest;
+export declare function AdminUsersActivityTotalsRequestToJSONTyped(value?: AdminUsersActivityTotalsRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminUsersActivityTotalsRequest.js

@@ -0,0 +1,43 @@
+/* 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 AdminUsersActivityTotalsRequest interface.
+ */
+export function instanceOfAdminUsersActivityTotalsRequest(value) {
+    if (!('externalIds' in value) || value['externalIds'] === undefined)
+        return false;
+    return true;
+}
+export function AdminUsersActivityTotalsRequestFromJSON(json) {
+    return AdminUsersActivityTotalsRequestFromJSONTyped(json, false);
+}
+export function AdminUsersActivityTotalsRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'externalIds': json['externalIds'],
+    };
+}
+export function AdminUsersActivityTotalsRequestToJSON(json) {
+    return AdminUsersActivityTotalsRequestToJSONTyped(json, false);
+}
+export function AdminUsersActivityTotalsRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'externalIds': value['externalIds'],
+    };
+}

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

@@ -29,8 +29,10 @@ export * from './AdminTriggerAnalysisResponse';
 export * from './AdminUpdateChatRequest';
 export * from './AdminUserActivity';
 export * from './AdminUserActivityDay';
+export * from './AdminUserActivityTotals';
 export * from './AdminUserEngagement';
 export * from './AdminUsersActivityRequest';
+export * from './AdminUsersActivityTotalsRequest';
 export * from './AssociateUserFileRequest';
 export * from './CanvasCourseAccess';
 export * from './CanvasDomainMatch';

package/dist/esm/models/index.js

@@ -31,8 +31,10 @@ export * from './AdminTriggerAnalysisResponse';
 export * from './AdminUpdateChatRequest';
 export * from './AdminUserActivity';
 export * from './AdminUserActivityDay';
+export * from './AdminUserActivityTotals';
 export * from './AdminUserEngagement';
 export * from './AdminUsersActivityRequest';
+export * from './AdminUsersActivityTotalsRequest';
 export * from './AssociateUserFileRequest';
 export * from './CanvasCourseAccess';
 export * from './CanvasDomainMatch';

package/dist/models/AdminUserActivityTotals.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 AdminUserActivityTotals
+ */
+export interface AdminUserActivityTotals {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminUserActivityTotals
+     */
+    externalId: string;
+    /**
+     * Messages the user sent in regular or level-up chats, all time
+     * @type {number}
+     * @memberof AdminUserActivityTotals
+     */
+    messagesSent: number;
+    /**
+     * Quiz questions the user answered, all time (daily quiz included)
+     * @type {number}
+     * @memberof AdminUserActivityTotals
+     */
+    quizQuestionsAnswered: number;
+    /**
+     * Card views recorded across the flashcard sets the user owns, all time
+     * @type {number}
+     * @memberof AdminUserActivityTotals
+     */
+    flashcardsViewed: number;
+}
+/**
+ * Check if a given object implements the AdminUserActivityTotals interface.
+ */
+export declare function instanceOfAdminUserActivityTotals(value: object): value is AdminUserActivityTotals;
+export declare function AdminUserActivityTotalsFromJSON(json: any): AdminUserActivityTotals;
+export declare function AdminUserActivityTotalsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminUserActivityTotals;
+export declare function AdminUserActivityTotalsToJSON(json: any): AdminUserActivityTotals;
+export declare function AdminUserActivityTotalsToJSONTyped(value?: AdminUserActivityTotals | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminUserActivityTotals.js

@@ -0,0 +1,62 @@
+"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.instanceOfAdminUserActivityTotals = instanceOfAdminUserActivityTotals;
+exports.AdminUserActivityTotalsFromJSON = AdminUserActivityTotalsFromJSON;
+exports.AdminUserActivityTotalsFromJSONTyped = AdminUserActivityTotalsFromJSONTyped;
+exports.AdminUserActivityTotalsToJSON = AdminUserActivityTotalsToJSON;
+exports.AdminUserActivityTotalsToJSONTyped = AdminUserActivityTotalsToJSONTyped;
+/**
+ * Check if a given object implements the AdminUserActivityTotals interface.
+ */
+function instanceOfAdminUserActivityTotals(value) {
+    if (!('externalId' in value) || value['externalId'] === undefined)
+        return false;
+    if (!('messagesSent' in value) || value['messagesSent'] === undefined)
+        return false;
+    if (!('quizQuestionsAnswered' in value) || value['quizQuestionsAnswered'] === undefined)
+        return false;
+    if (!('flashcardsViewed' in value) || value['flashcardsViewed'] === undefined)
+        return false;
+    return true;
+}
+function AdminUserActivityTotalsFromJSON(json) {
+    return AdminUserActivityTotalsFromJSONTyped(json, false);
+}
+function AdminUserActivityTotalsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'externalId': json['externalId'],
+        'messagesSent': json['messagesSent'],
+        'quizQuestionsAnswered': json['quizQuestionsAnswered'],
+        'flashcardsViewed': json['flashcardsViewed'],
+    };
+}
+function AdminUserActivityTotalsToJSON(json) {
+    return AdminUserActivityTotalsToJSONTyped(json, false);
+}
+function AdminUserActivityTotalsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'externalId': value['externalId'],
+        'messagesSent': value['messagesSent'],
+        'quizQuestionsAnswered': value['quizQuestionsAnswered'],
+        'flashcardsViewed': value['flashcardsViewed'],
+    };
+}

package/dist/models/AdminUsersActivityTotalsRequest.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 AdminUsersActivityTotalsRequest
+ */
+export interface AdminUsersActivityTotalsRequest {
+    /**
+     * External user identifiers to fetch activity for
+     * @type {Array<string>}
+     * @memberof AdminUsersActivityTotalsRequest
+     */
+    externalIds: Array<string>;
+}
+/**
+ * Check if a given object implements the AdminUsersActivityTotalsRequest interface.
+ */
+export declare function instanceOfAdminUsersActivityTotalsRequest(value: object): value is AdminUsersActivityTotalsRequest;
+export declare function AdminUsersActivityTotalsRequestFromJSON(json: any): AdminUsersActivityTotalsRequest;
+export declare function AdminUsersActivityTotalsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminUsersActivityTotalsRequest;
+export declare function AdminUsersActivityTotalsRequestToJSON(json: any): AdminUsersActivityTotalsRequest;
+export declare function AdminUsersActivityTotalsRequestToJSONTyped(value?: AdminUsersActivityTotalsRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminUsersActivityTotalsRequest.js

@@ -0,0 +1,50 @@
+"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.instanceOfAdminUsersActivityTotalsRequest = instanceOfAdminUsersActivityTotalsRequest;
+exports.AdminUsersActivityTotalsRequestFromJSON = AdminUsersActivityTotalsRequestFromJSON;
+exports.AdminUsersActivityTotalsRequestFromJSONTyped = AdminUsersActivityTotalsRequestFromJSONTyped;
+exports.AdminUsersActivityTotalsRequestToJSON = AdminUsersActivityTotalsRequestToJSON;
+exports.AdminUsersActivityTotalsRequestToJSONTyped = AdminUsersActivityTotalsRequestToJSONTyped;
+/**
+ * Check if a given object implements the AdminUsersActivityTotalsRequest interface.
+ */
+function instanceOfAdminUsersActivityTotalsRequest(value) {
+    if (!('externalIds' in value) || value['externalIds'] === undefined)
+        return false;
+    return true;
+}
+function AdminUsersActivityTotalsRequestFromJSON(json) {
+    return AdminUsersActivityTotalsRequestFromJSONTyped(json, false);
+}
+function AdminUsersActivityTotalsRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'externalIds': json['externalIds'],
+    };
+}
+function AdminUsersActivityTotalsRequestToJSON(json) {
+    return AdminUsersActivityTotalsRequestToJSONTyped(json, false);
+}
+function AdminUsersActivityTotalsRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'externalIds': value['externalIds'],
+    };
+}

package/dist/models/index.d.ts

@@ -29,8 +29,10 @@ export * from './AdminTriggerAnalysisResponse';
 export * from './AdminUpdateChatRequest';
 export * from './AdminUserActivity';
 export * from './AdminUserActivityDay';
+export * from './AdminUserActivityTotals';
 export * from './AdminUserEngagement';
 export * from './AdminUsersActivityRequest';
+export * from './AdminUsersActivityTotalsRequest';
 export * from './AssociateUserFileRequest';
 export * from './CanvasCourseAccess';
 export * from './CanvasDomainMatch';

package/dist/models/index.js

@@ -47,8 +47,10 @@ __exportStar(require("./AdminTriggerAnalysisResponse"), exports);
 __exportStar(require("./AdminUpdateChatRequest"), exports);
 __exportStar(require("./AdminUserActivity"), exports);
 __exportStar(require("./AdminUserActivityDay"), exports);
+__exportStar(require("./AdminUserActivityTotals"), exports);
 __exportStar(require("./AdminUserEngagement"), exports);
 __exportStar(require("./AdminUsersActivityRequest"), exports);
+__exportStar(require("./AdminUsersActivityTotalsRequest"), exports);
 __exportStar(require("./AssociateUserFileRequest"), exports);
 __exportStar(require("./CanvasCourseAccess"), exports);
 __exportStar(require("./CanvasDomainMatch"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@instructure/athena-api-client",
   "private": false,
-  "version": "3.33.2",
+  "version": "3.33.3",
   "description": "OpenAPI client for the Athena API",
   "author": "Instructure",
   "repository": {