@studyfetch/sdk 1.43.0 → 1.46.0

package/src/resources/v1/performance-insights/performance-insights.ts

@@ -0,0 +1,214 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as ConversationsAPI from './conversations';
+import {
+  ConversationCreateParams,
+  ConversationDeleteParams,
+  ConversationListParams,
+  ConversationPushMessagesParams,
+  ConversationRenameParams,
+  ConversationRetrieveParams,
+  Conversations,
+} from './conversations';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+
+export class PerformanceInsights extends APIResource {
+  conversations: ConversationsAPI.Conversations = new ConversationsAPI.Conversations(this._client);
+
+  /**
+   * Generate an embeddable URL and token for the Performance Insights dashboard.
+   * Requires a TrueLearn userContextJwt to authenticate data access.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.performanceInsights.generateEmbed({
+   *   userContextJwt: 'userContextJwt',
+   * });
+   * ```
+   */
+  generateEmbed(
+    body: PerformanceInsightsGenerateEmbedParams,
+    options?: RequestOptions,
+  ): APIPromise<PerformanceInsightsGenerateEmbedResponse> {
+    return this._client.post('/api/v1/performance-insights/embed', { body, ...options });
+  }
+
+  /**
+   * Stream an AI-powered analytics response using server-sent events (SSE).
+   *
+   * @example
+   * ```ts
+   * await client.v1.performanceInsights.stream();
+   * ```
+   */
+  stream(
+    params: PerformanceInsightsStreamParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { 'x-embed-token': xEmbedToken, 'x-user-id': xUserID, ...body } = params ?? {};
+    return this._client.post('/api/v1/performance-insights/stream', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xEmbedToken != null ? { 'x-embed-token': xEmbedToken } : undefined),
+          ...(xUserID != null ? { 'x-user-id': xUserID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface PerformanceInsightsGenerateEmbedResponse {
+  /**
+   * Full embed URL for iframe integration
+   */
+  embedUrl: string;
+
+  /**
+   * JWT embed token
+   */
+  token: string;
+
+  /**
+   * Token expiration timestamp (1 hour from creation)
+   */
+  expiresAt: string;
+}
+
+export interface PerformanceInsightsGenerateEmbedParams {
+  /**
+   * TrueLearn user context JWT for data access
+   */
+  userContextJwt: string;
+
+  /**
+   * Show Python code execution details in the embed
+   */
+  debug?: boolean;
+
+  /**
+   * Group IDs for access control
+   */
+  groupIds?: Array<string>;
+
+  /**
+   * Embed height (e.g., "400px", "100vh")
+   */
+  height?: string;
+
+  /**
+   * Swagger/OpenAPI JSON path appended to the API base URL. Scopes which endpoints
+   * the bot can discover. Defaults to swagger/v1/swagger.json when omitted.
+   */
+  swaggerDocPath?: string;
+
+  /**
+   * IANA timezone string for data analysis (e.g., "America/New_York"). Timestamps in
+   * reports will be shown in this timezone.
+   */
+  timezone?: string;
+
+  /**
+   * TrueLearn API origin (https). Defaults to QA when omitted.
+   */
+  trueLearnApiBase?: string;
+
+  /**
+   * TrueLearn OAuth token URL (must include connect/token path). Defaults to QA login
+   * when omitted.
+   */
+  trueLearnTokenUrl?: string;
+
+  /**
+   * User ID for tracking. If omitted, derived from userContextJwt hash.
+   */
+  userId?: string;
+
+  /**
+   * Embed width (e.g., "100%", "600px")
+   */
+  width?: string;
+}
+
+export interface PerformanceInsightsStreamParams {
+  /**
+   * Body param: Session / conversation ID (AI SDK uses "id")
+   */
+  id?: string;
+
+  /**
+   * Body param: Component ID
+   */
+  componentId?: string;
+
+  /**
+   * Body param: Additional context
+   */
+  context?: unknown;
+
+  /**
+   * Body param: Group IDs for access control
+   */
+  groupIds?: Array<string>;
+
+  /**
+   * Body param: Messages array for AI SDK format
+   */
+  messages?: Array<string>;
+
+  /**
+   * Body param: Session ID
+   */
+  sessionId?: string;
+
+  /**
+   * Body param: IANA timezone string for data analysis
+   */
+  timezone?: string;
+
+  /**
+   * Body param: Trigger for AI SDK (what triggered the message)
+   */
+  trigger?: string;
+
+  /**
+   * Body param: User ID
+   */
+  userId?: string;
+
+  /**
+   * Header param: Embed token containing the TrueLearn userContextJwt
+   */
+  'x-embed-token'?: string;
+
+  /**
+   * Header param: User ID header (used when authenticating via API key)
+   */
+  'x-user-id'?: string;
+}
+
+PerformanceInsights.Conversations = Conversations;
+
+export declare namespace PerformanceInsights {
+  export {
+    type PerformanceInsightsGenerateEmbedResponse as PerformanceInsightsGenerateEmbedResponse,
+    type PerformanceInsightsGenerateEmbedParams as PerformanceInsightsGenerateEmbedParams,
+    type PerformanceInsightsStreamParams as PerformanceInsightsStreamParams,
+  };
+
+  export {
+    Conversations as Conversations,
+    type ConversationListParams as ConversationListParams,
+    type ConversationCreateParams as ConversationCreateParams,
+    type ConversationRetrieveParams as ConversationRetrieveParams,
+    type ConversationPushMessagesParams as ConversationPushMessagesParams,
+    type ConversationRenameParams as ConversationRenameParams,
+    type ConversationDeleteParams as ConversationDeleteParams,
+  };
+}

package/src/resources/v1/performance-insights.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './performance-insights/index';

package/src/resources/v1/usage.ts

@@ -63,6 +63,11 @@ export class Usage extends APIResource {
 }
 
 export interface UsageGetStatsParams {
+  /**
+   * Filter by component type
+   */
+  componentType?: string;
+
   /**
    * End date for stats (ISO 8601)
    */
@@ -82,6 +87,11 @@ export interface UsageGetStatsParams {
    * Filter by user ID
    */
   userId?: string;
+
+  /**
+   * Filter by resource ID (component ID)
+   */
+  resourceId?: string;
 }
 
 export interface UsageGetSummaryParams {

package/src/resources/v1/v1.ts

@@ -2,7 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import * as ChatAPI from './chat';
-import { Chat, ChatStreamParams } from './chat';
+import { Chat, ChatRetrieveFeedbackParams, ChatStreamParams } from './chat';
 import * as ChatAnalyticsAPI from './chat-analytics';
 import {
   ChatAnalytics,
@@ -27,6 +27,8 @@ import * as FoldersAPI from './folders';
 import {
   FolderCreateParams,
   FolderCreateResponse,
+  FolderGetByNameParams,
+  FolderGetByNameResponse,
   FolderGetTreeResponse,
   FolderListMaterialsParams,
   FolderListMaterialsResponse,
@@ -96,6 +98,13 @@ import {
   PdfGeneratorDeleteResponse,
   PdfGeneratorGetAllResponse,
 } from './pdf-generator/pdf-generator';
+import * as PerformanceInsightsAPI from './performance-insights/performance-insights';
+import {
+  PerformanceInsights,
+  PerformanceInsightsGenerateEmbedParams,
+  PerformanceInsightsGenerateEmbedResponse,
+  PerformanceInsightsStreamParams,
+} from './performance-insights/performance-insights';
 import { APIPromise } from '../../core/api-promise';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
@@ -113,6 +122,8 @@ export class V1 extends APIResource {
   );
   materials: MaterialsAPI.Materials = new MaterialsAPI.Materials(this._client);
   pdfGenerator: PdfGeneratorAPI.PdfGenerator = new PdfGeneratorAPI.PdfGenerator(this._client);
+  performanceInsights: PerformanceInsightsAPI.PerformanceInsights =
+    new PerformanceInsightsAPI.PerformanceInsights(this._client);
 
   /**
    * Test MongoDB connection and get outbound IP
@@ -140,12 +151,14 @@ V1.ChatAnalytics = ChatAnalytics;
 V1.AssignmentGrader = AssignmentGrader;
 V1.Materials = Materials;
 V1.PdfGenerator = PdfGenerator;
+V1.PerformanceInsights = PerformanceInsights;
 
 export declare namespace V1 {
   export {
     Folders as Folders,
     type FolderMetadata as FolderMetadata,
     type FolderCreateResponse as FolderCreateResponse,
+    type FolderGetByNameResponse as FolderGetByNameResponse,
     type FolderRetrieveResponse as FolderRetrieveResponse,
     type FolderUpdateResponse as FolderUpdateResponse,
     type FolderListResponse as FolderListResponse,
@@ -153,6 +166,7 @@ export declare namespace V1 {
     type FolderListMaterialsResponse as FolderListMaterialsResponse,
     type FolderMoveResponse as FolderMoveResponse,
     type FolderCreateParams as FolderCreateParams,
+    type FolderGetByNameParams as FolderGetByNameParams,
     type FolderUpdateParams as FolderUpdateParams,
     type FolderListParams as FolderListParams,
     type FolderListMaterialsParams as FolderListMaterialsParams,
@@ -191,7 +205,11 @@ export declare namespace V1 {
     type EmbedVerifyParams as EmbedVerifyParams,
   };
 
-  export { Chat as Chat, type ChatStreamParams as ChatStreamParams };
+  export {
+    Chat as Chat,
+    type ChatRetrieveFeedbackParams as ChatRetrieveFeedbackParams,
+    type ChatStreamParams as ChatStreamParams,
+  };
 
   export {
     ChatAnalytics as ChatAnalytics,
@@ -245,4 +263,11 @@ export declare namespace V1 {
     type PdfGeneratorGetAllResponse as PdfGeneratorGetAllResponse,
     type PdfGeneratorCreateParams as PdfGeneratorCreateParams,
   };
+
+  export {
+    PerformanceInsights as PerformanceInsights,
+    type PerformanceInsightsGenerateEmbedResponse as PerformanceInsightsGenerateEmbedResponse,
+    type PerformanceInsightsGenerateEmbedParams as PerformanceInsightsGenerateEmbedParams,
+    type PerformanceInsightsStreamParams as PerformanceInsightsStreamParams,
+  };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.43.0'; // x-release-please-version
+export const VERSION = '1.46.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.43.0";
+export declare const VERSION = "1.46.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.43.0";
+export declare const VERSION = "1.46.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '1.43.0'; // x-release-please-version
+exports.VERSION = '1.46.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '1.43.0'; // x-release-please-version
+export const VERSION = '1.46.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map