@instructure/athena-api-client 3.30.0 → 3.30.1

package/README.md

@@ -64,6 +64,7 @@ All URIs are relative to *http://localhost:3000*
 *AdminApi* | [**adminGetStudyObjectiveSummary**](docs/AdminApi.md#admingetstudyobjectivesummary) | **GET** /api/v1/admin/study-objectives/summary | Aggregate study-objective statistics across all account users
 *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* | [**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* | [**adminListQuizSessions**](docs/AdminApi.md#adminlistquizsessions) | **GET** /api/v1/admin/quiz-sessions | List recent quiz sessions across all account users
@@ -206,7 +207,10 @@ All URIs are relative to *http://localhost:3000*
 - [AdminTaxonomyEnrollmentTaxonomy](docs/AdminTaxonomyEnrollmentTaxonomy.md)
 - [AdminTriggerAnalysisResponse](docs/AdminTriggerAnalysisResponse.md)
 - [AdminUpdateChatRequest](docs/AdminUpdateChatRequest.md)
+- [AdminUserActivity](docs/AdminUserActivity.md)
+- [AdminUserActivityDay](docs/AdminUserActivityDay.md)
 - [AdminUserEngagement](docs/AdminUserEngagement.md)
+- [AdminUsersActivityRequest](docs/AdminUsersActivityRequest.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, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminResetLearningDataResponse, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserEngagement, QuizSessionSummary } from '../models/index';
+import type { AdminChat, AdminChatAnalysis, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminResetLearningDataResponse, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserEngagement, AdminUsersActivityRequest, QuizSessionSummary } from '../models/index';
 export interface AdminGetChatRequest {
     xUserId: string;
     chatId: string;
@@ -39,6 +39,10 @@ export interface AdminGetUserEngagementRequest {
     xUserId: string;
     externalId: string;
 }
+export interface AdminGetUsersActivityRequest {
+    xUserId: string;
+    adminUsersActivityRequest: AdminUsersActivityRequest;
+}
 export interface AdminListActiveStreaksRequest {
     xUserId: string;
     limit?: number;
@@ -164,6 +168,16 @@ export declare class AdminApi extends runtime.BaseAPI {
      * Get engagement dates for a user
      */
     adminGetUserEngagement(requestParameters: AdminGetUserEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminUserEngagement>;
+    /**
+     * Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in a regular or level-up chat, created a quiz or flashcard set (including Canvas practice quizzes), answered a quiz question (including the daily quiz), or viewed flashcards (proxied by starting a flashcards-mode quiz session). Unknown external ids are omitted from the response.
+     * Get per-day activity for a batch of users
+     */
+    adminGetUsersActivityRaw(requestParameters: AdminGetUsersActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AdminUserActivity>>>;
+    /**
+     * Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in a regular or level-up chat, created a quiz or flashcard set (including Canvas practice quizzes), answered a quiz question (including the daily quiz), or viewed flashcards (proxied by starting a flashcards-mode quiz session). Unknown external ids are omitted from the response.
+     * Get per-day activity for a batch of users
+     */
+    adminGetUsersActivity(requestParameters: AdminGetUsersActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminUserActivity>>;
     /**
      * List all active streaks (currentDays > 0) across the account, paginated
      */

package/dist/apis/AdminApi.js

@@ -310,6 +310,48 @@ class AdminApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in a regular or level-up chat, created a quiz or flashcard set (including Canvas practice quizzes), answered a quiz question (including the daily quiz), or viewed flashcards (proxied by starting a flashcards-mode quiz session). Unknown external ids are omitted from the response.
+     * Get per-day activity for a batch of users
+     */
+    adminGetUsersActivityRaw(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 adminGetUsersActivity().');
+            }
+            if (requestParameters['adminUsersActivityRequest'] == null) {
+                throw new runtime.RequiredError('adminUsersActivityRequest', 'Required parameter "adminUsersActivityRequest" was null or undefined when calling adminGetUsersActivity().');
+            }
+            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`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.AdminUsersActivityRequestToJSON)(requestParameters['adminUsersActivityRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.AdminUserActivityFromJSON));
+        });
+    }
+    /**
+     * Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in a regular or level-up chat, created a quiz or flashcard set (including Canvas practice quizzes), answered a quiz question (including the daily quiz), or viewed flashcards (proxied by starting a flashcards-mode quiz session). Unknown external ids are omitted from the response.
+     * Get per-day activity for a batch of users
+     */
+    adminGetUsersActivity(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminGetUsersActivityRaw(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, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminResetLearningDataResponse, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserEngagement, QuizSessionSummary } from '../models/index';
+import type { AdminChat, AdminChatAnalysis, AdminChatWithStats, AdminCohortStats, AdminPaginatedActiveStreaks, AdminPaginatedChats, AdminPaginatedQuizSessions, AdminPaginatedStudyObjectiveUserCounts, AdminPaginatedStudyObjectives, AdminPaginatedTaxonomyEnrollments, AdminResetLearningDataResponse, AdminStreak, AdminStudyObjectiveSummary, AdminTriggerAnalysisResponse, AdminUpdateChatRequest, AdminUserActivity, AdminUserEngagement, AdminUsersActivityRequest, QuizSessionSummary } from '../models/index';
 export interface AdminGetChatRequest {
     xUserId: string;
     chatId: string;
@@ -39,6 +39,10 @@ export interface AdminGetUserEngagementRequest {
     xUserId: string;
     externalId: string;
 }
+export interface AdminGetUsersActivityRequest {
+    xUserId: string;
+    adminUsersActivityRequest: AdminUsersActivityRequest;
+}
 export interface AdminListActiveStreaksRequest {
     xUserId: string;
     limit?: number;
@@ -164,6 +168,16 @@ export declare class AdminApi extends runtime.BaseAPI {
      * Get engagement dates for a user
      */
     adminGetUserEngagement(requestParameters: AdminGetUserEngagementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminUserEngagement>;
+    /**
+     * Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in a regular or level-up chat, created a quiz or flashcard set (including Canvas practice quizzes), answered a quiz question (including the daily quiz), or viewed flashcards (proxied by starting a flashcards-mode quiz session). Unknown external ids are omitted from the response.
+     * Get per-day activity for a batch of users
+     */
+    adminGetUsersActivityRaw(requestParameters: AdminGetUsersActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AdminUserActivity>>>;
+    /**
+     * Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in a regular or level-up chat, created a quiz or flashcard set (including Canvas practice quizzes), answered a quiz question (including the daily quiz), or viewed flashcards (proxied by starting a flashcards-mode quiz session). Unknown external ids are omitted from the response.
+     * Get per-day activity for a batch of users
+     */
+    adminGetUsersActivity(requestParameters: AdminGetUsersActivityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AdminUserActivity>>;
     /**
      * 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, AdminPaginatedQuizSessionsFromJSON, AdminPaginatedStudyObjectiveUserCountsFromJSON, AdminPaginatedStudyObjectivesFromJSON, AdminPaginatedTaxonomyEnrollmentsFromJSON, AdminResetLearningDataResponseFromJSON, AdminStreakFromJSON, AdminStudyObjectiveSummaryFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserEngagementFromJSON, QuizSessionSummaryFromJSON, } from '../models/index';
+import { AdminChatFromJSON, AdminChatAnalysisFromJSON, AdminChatWithStatsFromJSON, AdminCohortStatsFromJSON, AdminPaginatedActiveStreaksFromJSON, AdminPaginatedChatsFromJSON, AdminPaginatedQuizSessionsFromJSON, AdminPaginatedStudyObjectiveUserCountsFromJSON, AdminPaginatedStudyObjectivesFromJSON, AdminPaginatedTaxonomyEnrollmentsFromJSON, AdminResetLearningDataResponseFromJSON, AdminStreakFromJSON, AdminStudyObjectiveSummaryFromJSON, AdminTriggerAnalysisResponseFromJSON, AdminUpdateChatRequestToJSON, AdminUserActivityFromJSON, AdminUserEngagementFromJSON, AdminUsersActivityRequestToJSON, QuizSessionSummaryFromJSON, } from '../models/index';
 /**
  *
  */
@@ -307,6 +307,48 @@ export class AdminApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in a regular or level-up chat, created a quiz or flashcard set (including Canvas practice quizzes), answered a quiz question (including the daily quiz), or viewed flashcards (proxied by starting a flashcards-mode quiz session). Unknown external ids are omitted from the response.
+     * Get per-day activity for a batch of users
+     */
+    adminGetUsersActivityRaw(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 adminGetUsersActivity().');
+            }
+            if (requestParameters['adminUsersActivityRequest'] == null) {
+                throw new runtime.RequiredError('adminUsersActivityRequest', 'Required parameter "adminUsersActivityRequest" was null or undefined when calling adminGetUsersActivity().');
+            }
+            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`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: AdminUsersActivityRequestToJSON(requestParameters['adminUsersActivityRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(AdminUserActivityFromJSON));
+        });
+    }
+    /**
+     * Returns, for each known external user id, the distinct local days (bucketed in the requested timezone, default UTC) on which the user was active, tagged with the kinds of activity: sent a message in a regular or level-up chat, created a quiz or flashcard set (including Canvas practice quizzes), answered a quiz question (including the daily quiz), or viewed flashcards (proxied by starting a flashcards-mode quiz session). Unknown external ids are omitted from the response.
+     * Get per-day activity for a batch of users
+     */
+    adminGetUsersActivity(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.adminGetUsersActivityRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * List all active streaks (currentDays > 0) across the account, paginated
      */

package/dist/esm/models/AdminUserActivity.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 { AdminUserActivityDay } from './AdminUserActivityDay';
+/**
+ *
+ * @export
+ * @interface AdminUserActivity
+ */
+export interface AdminUserActivity {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminUserActivity
+     */
+    externalId: string;
+    /**
+     *
+     * @type {Array<AdminUserActivityDay>}
+     * @memberof AdminUserActivity
+     */
+    activeDays: Array<AdminUserActivityDay>;
+}
+/**
+ * Check if a given object implements the AdminUserActivity interface.
+ */
+export declare function instanceOfAdminUserActivity(value: object): value is AdminUserActivity;
+export declare function AdminUserActivityFromJSON(json: any): AdminUserActivity;
+export declare function AdminUserActivityFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminUserActivity;
+export declare function AdminUserActivityToJSON(json: any): AdminUserActivity;
+export declare function AdminUserActivityToJSONTyped(value?: AdminUserActivity | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminUserActivity.js

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AdminUserActivityDayFromJSON, AdminUserActivityDayToJSON, } from './AdminUserActivityDay';
+/**
+ * Check if a given object implements the AdminUserActivity interface.
+ */
+export function instanceOfAdminUserActivity(value) {
+    if (!('externalId' in value) || value['externalId'] === undefined)
+        return false;
+    if (!('activeDays' in value) || value['activeDays'] === undefined)
+        return false;
+    return true;
+}
+export function AdminUserActivityFromJSON(json) {
+    return AdminUserActivityFromJSONTyped(json, false);
+}
+export function AdminUserActivityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'externalId': json['externalId'],
+        'activeDays': (json['activeDays'].map(AdminUserActivityDayFromJSON)),
+    };
+}
+export function AdminUserActivityToJSON(json) {
+    return AdminUserActivityToJSONTyped(json, false);
+}
+export function AdminUserActivityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'externalId': value['externalId'],
+        'activeDays': (value['activeDays'].map(AdminUserActivityDayToJSON)),
+    };
+}

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

@@ -0,0 +1,48 @@
+/**
+ * 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 AdminUserActivityDay
+ */
+export interface AdminUserActivityDay {
+    /**
+     * Local day (YYYY-MM-DD) in the requested timezone
+     * @type {string}
+     * @memberof AdminUserActivityDay
+     */
+    day: string;
+    /**
+     * Kinds of activity the user performed on this day
+     * @type {Array<string>}
+     * @memberof AdminUserActivityDay
+     */
+    kinds: Array<AdminUserActivityDayKindsEnum>;
+}
+/**
+ * @export
+ */
+export declare const AdminUserActivityDayKindsEnum: {
+    readonly Message: "message";
+    readonly QuizCreated: "quiz-created";
+    readonly QuizAnswered: "quiz-answered";
+    readonly FlashcardsViewed: "flashcards-viewed";
+};
+export type AdminUserActivityDayKindsEnum = typeof AdminUserActivityDayKindsEnum[keyof typeof AdminUserActivityDayKindsEnum];
+/**
+ * Check if a given object implements the AdminUserActivityDay interface.
+ */
+export declare function instanceOfAdminUserActivityDay(value: object): value is AdminUserActivityDay;
+export declare function AdminUserActivityDayFromJSON(json: any): AdminUserActivityDay;
+export declare function AdminUserActivityDayFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminUserActivityDay;
+export declare function AdminUserActivityDayToJSON(json: any): AdminUserActivityDay;
+export declare function AdminUserActivityDayToJSONTyped(value?: AdminUserActivityDay | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminUserActivityDay.js

@@ -0,0 +1,56 @@
+/* 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 AdminUserActivityDayKindsEnum = {
+    Message: 'message',
+    QuizCreated: 'quiz-created',
+    QuizAnswered: 'quiz-answered',
+    FlashcardsViewed: 'flashcards-viewed'
+};
+/**
+ * Check if a given object implements the AdminUserActivityDay interface.
+ */
+export function instanceOfAdminUserActivityDay(value) {
+    if (!('day' in value) || value['day'] === undefined)
+        return false;
+    if (!('kinds' in value) || value['kinds'] === undefined)
+        return false;
+    return true;
+}
+export function AdminUserActivityDayFromJSON(json) {
+    return AdminUserActivityDayFromJSONTyped(json, false);
+}
+export function AdminUserActivityDayFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'day': json['day'],
+        'kinds': json['kinds'],
+    };
+}
+export function AdminUserActivityDayToJSON(json) {
+    return AdminUserActivityDayToJSONTyped(json, false);
+}
+export function AdminUserActivityDayToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'day': value['day'],
+        'kinds': value['kinds'],
+    };
+}

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

@@ -0,0 +1,38 @@
+/**
+ * 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 AdminUsersActivityRequest
+ */
+export interface AdminUsersActivityRequest {
+    /**
+     * External user identifiers to fetch activity for
+     * @type {Array<string>}
+     * @memberof AdminUsersActivityRequest
+     */
+    externalIds: Array<string>;
+    /**
+     * IANA timezone used to bucket activity into local days (defaults to UTC)
+     * @type {string}
+     * @memberof AdminUsersActivityRequest
+     */
+    timezone?: string;
+}
+/**
+ * Check if a given object implements the AdminUsersActivityRequest interface.
+ */
+export declare function instanceOfAdminUsersActivityRequest(value: object): value is AdminUsersActivityRequest;
+export declare function AdminUsersActivityRequestFromJSON(json: any): AdminUsersActivityRequest;
+export declare function AdminUsersActivityRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminUsersActivityRequest;
+export declare function AdminUsersActivityRequestToJSON(json: any): AdminUsersActivityRequest;
+export declare function AdminUsersActivityRequestToJSONTyped(value?: AdminUsersActivityRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminUsersActivityRequest.js

@@ -0,0 +1,45 @@
+/* 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 AdminUsersActivityRequest interface.
+ */
+export function instanceOfAdminUsersActivityRequest(value) {
+    if (!('externalIds' in value) || value['externalIds'] === undefined)
+        return false;
+    return true;
+}
+export function AdminUsersActivityRequestFromJSON(json) {
+    return AdminUsersActivityRequestFromJSONTyped(json, false);
+}
+export function AdminUsersActivityRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'externalIds': json['externalIds'],
+        'timezone': json['timezone'] == null ? undefined : json['timezone'],
+    };
+}
+export function AdminUsersActivityRequestToJSON(json) {
+    return AdminUsersActivityRequestToJSONTyped(json, false);
+}
+export function AdminUsersActivityRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'externalIds': value['externalIds'],
+        'timezone': value['timezone'],
+    };
+}

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

@@ -23,7 +23,10 @@ export * from './AdminTaxonomyEnrollment';
 export * from './AdminTaxonomyEnrollmentTaxonomy';
 export * from './AdminTriggerAnalysisResponse';
 export * from './AdminUpdateChatRequest';
+export * from './AdminUserActivity';
+export * from './AdminUserActivityDay';
 export * from './AdminUserEngagement';
+export * from './AdminUsersActivityRequest';
 export * from './AssociateUserFileRequest';
 export * from './CanvasCourseAccess';
 export * from './CanvasDomainMatch';

package/dist/esm/models/index.js

@@ -25,7 +25,10 @@ export * from './AdminTaxonomyEnrollment';
 export * from './AdminTaxonomyEnrollmentTaxonomy';
 export * from './AdminTriggerAnalysisResponse';
 export * from './AdminUpdateChatRequest';
+export * from './AdminUserActivity';
+export * from './AdminUserActivityDay';
 export * from './AdminUserEngagement';
+export * from './AdminUsersActivityRequest';
 export * from './AssociateUserFileRequest';
 export * from './CanvasCourseAccess';
 export * from './CanvasDomainMatch';

package/dist/models/AdminUserActivity.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 { AdminUserActivityDay } from './AdminUserActivityDay';
+/**
+ *
+ * @export
+ * @interface AdminUserActivity
+ */
+export interface AdminUserActivity {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminUserActivity
+     */
+    externalId: string;
+    /**
+     *
+     * @type {Array<AdminUserActivityDay>}
+     * @memberof AdminUserActivity
+     */
+    activeDays: Array<AdminUserActivityDay>;
+}
+/**
+ * Check if a given object implements the AdminUserActivity interface.
+ */
+export declare function instanceOfAdminUserActivity(value: object): value is AdminUserActivity;
+export declare function AdminUserActivityFromJSON(json: any): AdminUserActivity;
+export declare function AdminUserActivityFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminUserActivity;
+export declare function AdminUserActivityToJSON(json: any): AdminUserActivity;
+export declare function AdminUserActivityToJSONTyped(value?: AdminUserActivity | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminUserActivity.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.instanceOfAdminUserActivity = instanceOfAdminUserActivity;
+exports.AdminUserActivityFromJSON = AdminUserActivityFromJSON;
+exports.AdminUserActivityFromJSONTyped = AdminUserActivityFromJSONTyped;
+exports.AdminUserActivityToJSON = AdminUserActivityToJSON;
+exports.AdminUserActivityToJSONTyped = AdminUserActivityToJSONTyped;
+const AdminUserActivityDay_1 = require("./AdminUserActivityDay");
+/**
+ * Check if a given object implements the AdminUserActivity interface.
+ */
+function instanceOfAdminUserActivity(value) {
+    if (!('externalId' in value) || value['externalId'] === undefined)
+        return false;
+    if (!('activeDays' in value) || value['activeDays'] === undefined)
+        return false;
+    return true;
+}
+function AdminUserActivityFromJSON(json) {
+    return AdminUserActivityFromJSONTyped(json, false);
+}
+function AdminUserActivityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'externalId': json['externalId'],
+        'activeDays': (json['activeDays'].map(AdminUserActivityDay_1.AdminUserActivityDayFromJSON)),
+    };
+}
+function AdminUserActivityToJSON(json) {
+    return AdminUserActivityToJSONTyped(json, false);
+}
+function AdminUserActivityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'externalId': value['externalId'],
+        'activeDays': (value['activeDays'].map(AdminUserActivityDay_1.AdminUserActivityDayToJSON)),
+    };
+}

package/dist/models/AdminUserActivityDay.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 AdminUserActivityDay
+ */
+export interface AdminUserActivityDay {
+    /**
+     * Local day (YYYY-MM-DD) in the requested timezone
+     * @type {string}
+     * @memberof AdminUserActivityDay
+     */
+    day: string;
+    /**
+     * Kinds of activity the user performed on this day
+     * @type {Array<string>}
+     * @memberof AdminUserActivityDay
+     */
+    kinds: Array<AdminUserActivityDayKindsEnum>;
+}
+/**
+ * @export
+ */
+export declare const AdminUserActivityDayKindsEnum: {
+    readonly Message: "message";
+    readonly QuizCreated: "quiz-created";
+    readonly QuizAnswered: "quiz-answered";
+    readonly FlashcardsViewed: "flashcards-viewed";
+};
+export type AdminUserActivityDayKindsEnum = typeof AdminUserActivityDayKindsEnum[keyof typeof AdminUserActivityDayKindsEnum];
+/**
+ * Check if a given object implements the AdminUserActivityDay interface.
+ */
+export declare function instanceOfAdminUserActivityDay(value: object): value is AdminUserActivityDay;
+export declare function AdminUserActivityDayFromJSON(json: any): AdminUserActivityDay;
+export declare function AdminUserActivityDayFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminUserActivityDay;
+export declare function AdminUserActivityDayToJSON(json: any): AdminUserActivityDay;
+export declare function AdminUserActivityDayToJSONTyped(value?: AdminUserActivityDay | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminUserActivityDay.js

@@ -0,0 +1,64 @@
+"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.AdminUserActivityDayKindsEnum = void 0;
+exports.instanceOfAdminUserActivityDay = instanceOfAdminUserActivityDay;
+exports.AdminUserActivityDayFromJSON = AdminUserActivityDayFromJSON;
+exports.AdminUserActivityDayFromJSONTyped = AdminUserActivityDayFromJSONTyped;
+exports.AdminUserActivityDayToJSON = AdminUserActivityDayToJSON;
+exports.AdminUserActivityDayToJSONTyped = AdminUserActivityDayToJSONTyped;
+/**
+ * @export
+ */
+exports.AdminUserActivityDayKindsEnum = {
+    Message: 'message',
+    QuizCreated: 'quiz-created',
+    QuizAnswered: 'quiz-answered',
+    FlashcardsViewed: 'flashcards-viewed'
+};
+/**
+ * Check if a given object implements the AdminUserActivityDay interface.
+ */
+function instanceOfAdminUserActivityDay(value) {
+    if (!('day' in value) || value['day'] === undefined)
+        return false;
+    if (!('kinds' in value) || value['kinds'] === undefined)
+        return false;
+    return true;
+}
+function AdminUserActivityDayFromJSON(json) {
+    return AdminUserActivityDayFromJSONTyped(json, false);
+}
+function AdminUserActivityDayFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'day': json['day'],
+        'kinds': json['kinds'],
+    };
+}
+function AdminUserActivityDayToJSON(json) {
+    return AdminUserActivityDayToJSONTyped(json, false);
+}
+function AdminUserActivityDayToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'day': value['day'],
+        'kinds': value['kinds'],
+    };
+}

package/dist/models/AdminUsersActivityRequest.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 AdminUsersActivityRequest
+ */
+export interface AdminUsersActivityRequest {
+    /**
+     * External user identifiers to fetch activity for
+     * @type {Array<string>}
+     * @memberof AdminUsersActivityRequest
+     */
+    externalIds: Array<string>;
+    /**
+     * IANA timezone used to bucket activity into local days (defaults to UTC)
+     * @type {string}
+     * @memberof AdminUsersActivityRequest
+     */
+    timezone?: string;
+}
+/**
+ * Check if a given object implements the AdminUsersActivityRequest interface.
+ */
+export declare function instanceOfAdminUsersActivityRequest(value: object): value is AdminUsersActivityRequest;
+export declare function AdminUsersActivityRequestFromJSON(json: any): AdminUsersActivityRequest;
+export declare function AdminUsersActivityRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminUsersActivityRequest;
+export declare function AdminUsersActivityRequestToJSON(json: any): AdminUsersActivityRequest;
+export declare function AdminUsersActivityRequestToJSONTyped(value?: AdminUsersActivityRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/AdminUsersActivityRequest.js

@@ -0,0 +1,52 @@
+"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.instanceOfAdminUsersActivityRequest = instanceOfAdminUsersActivityRequest;
+exports.AdminUsersActivityRequestFromJSON = AdminUsersActivityRequestFromJSON;
+exports.AdminUsersActivityRequestFromJSONTyped = AdminUsersActivityRequestFromJSONTyped;
+exports.AdminUsersActivityRequestToJSON = AdminUsersActivityRequestToJSON;
+exports.AdminUsersActivityRequestToJSONTyped = AdminUsersActivityRequestToJSONTyped;
+/**
+ * Check if a given object implements the AdminUsersActivityRequest interface.
+ */
+function instanceOfAdminUsersActivityRequest(value) {
+    if (!('externalIds' in value) || value['externalIds'] === undefined)
+        return false;
+    return true;
+}
+function AdminUsersActivityRequestFromJSON(json) {
+    return AdminUsersActivityRequestFromJSONTyped(json, false);
+}
+function AdminUsersActivityRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'externalIds': json['externalIds'],
+        'timezone': json['timezone'] == null ? undefined : json['timezone'],
+    };
+}
+function AdminUsersActivityRequestToJSON(json) {
+    return AdminUsersActivityRequestToJSONTyped(json, false);
+}
+function AdminUsersActivityRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'externalIds': value['externalIds'],
+        'timezone': value['timezone'],
+    };
+}

package/dist/models/index.d.ts

@@ -23,7 +23,10 @@ export * from './AdminTaxonomyEnrollment';
 export * from './AdminTaxonomyEnrollmentTaxonomy';
 export * from './AdminTriggerAnalysisResponse';
 export * from './AdminUpdateChatRequest';
+export * from './AdminUserActivity';
+export * from './AdminUserActivityDay';
 export * from './AdminUserEngagement';
+export * from './AdminUsersActivityRequest';
 export * from './AssociateUserFileRequest';
 export * from './CanvasCourseAccess';
 export * from './CanvasDomainMatch';

package/dist/models/index.js

@@ -41,7 +41,10 @@ __exportStar(require("./AdminTaxonomyEnrollment"), exports);
 __exportStar(require("./AdminTaxonomyEnrollmentTaxonomy"), exports);
 __exportStar(require("./AdminTriggerAnalysisResponse"), exports);
 __exportStar(require("./AdminUpdateChatRequest"), exports);
+__exportStar(require("./AdminUserActivity"), exports);
+__exportStar(require("./AdminUserActivityDay"), exports);
 __exportStar(require("./AdminUserEngagement"), exports);
+__exportStar(require("./AdminUsersActivityRequest"), 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.30.0",
+  "version": "3.30.1",
   "description": "OpenAPI client for the Athena API",
   "author": "Instructure",
   "repository": {