@studyfetch/sdk 1.43.0 → 1.45.0

package/src/resources/v1/materials/upload.ts

@@ -3,7 +3,7 @@
 import { APIResource } from '../../../core/resource';
 import * as MaterialsAPI from './materials';
 import { APIPromise } from '../../../core/api-promise';
-import { type Uploadable } from '../../../core/uploads';
+import { toFile, type Uploadable } from '../../../core/uploads';
 import { RequestOptions } from '../../../internal/request-options';
 import { multipartFormRequestOptions } from '../../../internal/uploads';
 
@@ -65,7 +65,7 @@ export class Upload extends APIResource {
   ): APIPromise<MaterialsAPI.MaterialResponse> {
     return this._client.post(
       '/api/v1/materials/upload',
-      multipartFormRequestOptions({ body, ...options }, this._client),
+      multipartUploadRequestOptions(body, options, this._client),
     );
   }
 
@@ -88,7 +88,7 @@ export class Upload extends APIResource {
   ): APIPromise<MaterialsAPI.MaterialResponse> {
     return this._client.post(
       '/api/v1/materials/upload/file-and-process',
-      multipartFormRequestOptions({ body, ...options }, this._client),
+      multipartUploadRequestOptions(body, options, this._client),
     );
   }
 
@@ -201,16 +201,29 @@ export interface UploadUploadFileParams {
    */
   name: string;
 
+  /**
+   * Content-Type/MIME type of the file (e.g., video/mp4, application/pdf).
+   * If not provided, the uploadable's existing type is used.
+   */
+  contentType?: string;
+
   /**
    * Whether to extract images from files (true/false, default: true)
    */
   extractImages?: string;
 
   /**
-   * Folder ID (optional)
+   * Folder ID (optional). If folderPath is provided, folderId will be ignored.
    */
   folderId?: string;
 
+  /**
+   * Relative folder path (e.g., "folder1/folder2"). Folders will be created if
+   * they don't exist. The filename can be included and will be extracted
+   * automatically.
+   */
+  folderPath?: string;
+
   /**
    * JSON string of references array (optional)
    */
@@ -225,16 +238,29 @@ export interface UploadUploadFileAndProcessParams {
    */
   name: string;
 
+  /**
+   * Content-Type/MIME type of the file (e.g., video/mp4, application/pdf).
+   * If not provided, the uploadable's existing type is used.
+   */
+  contentType?: string;
+
   /**
    * Whether to extract images from files (true/false, default: true)
    */
   extractImages?: string;
 
   /**
-   * Folder ID (optional)
+   * Folder ID (optional). If folderPath is provided, folderId will be ignored.
    */
   folderId?: string;
 
+  /**
+   * Relative folder path (e.g., "folder1/folder2"). Folders will be created if
+   * they don't exist. The filename can be included and will be extracted
+   * automatically.
+   */
+  folderPath?: string;
+
   /**
    * Polling interval in milliseconds (default: 2000)
    */
@@ -258,9 +284,16 @@ export interface UploadUploadFromURLParams {
   url: string;
 
   /**
-   * Folder ID (optional)
+   * Folder ID (optional). If folderPath is provided, folderId will be ignored.
    */
   folderId?: string;
+
+  /**
+   * Relative folder path (e.g., "folder1/folder2"). Folders will be created if
+   * they don't exist. The filename can be included and will be extracted
+   * automatically.
+   */
+  folderPath?: string;
 }
 
 export interface UploadUploadFromURLAndProcessParams {
@@ -275,10 +308,17 @@ export interface UploadUploadFromURLAndProcessParams {
   url: string;
 
   /**
-   * Folder ID (optional)
+   * Folder ID (optional). If folderPath is provided, folderId will be ignored.
    */
   folderId?: string;
 
+  /**
+   * Relative folder path (e.g., "folder1/folder2"). Folders will be created if
+   * they don't exist. The filename can be included and will be extracted
+   * automatically.
+   */
+  folderPath?: string;
+
   /**
    * Polling interval in milliseconds (default: 2 seconds)
    */
@@ -306,3 +346,30 @@ export declare namespace Upload {
     type UploadUploadFromURLAndProcessParams as UploadUploadFromURLAndProcessParams,
   };
 }
+
+type MultipartClient = Parameters<typeof multipartFormRequestOptions>[1];
+type MultipartUploadBody = UploadUploadFileParams | UploadUploadFileAndProcessParams;
+
+async function multipartUploadRequestOptions(
+  body: MultipartUploadBody,
+  options: RequestOptions | undefined,
+  client: MultipartClient,
+): Promise<RequestOptions> {
+  const { contentType, ...bodyWithoutContentType } = body;
+  const multipartBody =
+    contentType ?
+      { ...bodyWithoutContentType, file: await toUploadableWithContentType(body.file, contentType) }
+    : bodyWithoutContentType;
+
+  return multipartFormRequestOptions({ body: multipartBody, ...options }, client);
+}
+
+async function toUploadableWithContentType(file: Uploadable, contentType: string): Promise<Uploadable> {
+  const typedFile = await toFile(file, undefined, { type: contentType });
+  if (typedFile.type === contentType) return typedFile;
+
+  return new File([typedFile], typedFile.name, {
+    type: contentType,
+    lastModified: typedFile.lastModified,
+  });
+}

package/src/resources/v1/pdf-generator/get.ts

@@ -50,6 +50,11 @@ export interface PdfResponse {
    */
   url: string;
 
+  /**
+   * URL to the generated PowerPoint (PPTX) on S3
+   */
+  pptxUrl?: string;
+
   /**
    * User ID
    */

package/src/resources/v1/pdf-generator/pdf-generator.ts

@@ -96,6 +96,41 @@ export interface PdfGeneratorCreateParams {
    * The topic for the PDF presentation
    */
   topic: string;
+
+  /**
+   * Custom images to use (required when imageMode is "provide-own")
+   */
+  customImages?: Array<PdfGeneratorCreateParams.CustomImage>;
+
+  /**
+   * Image handling mode: search (auto-search), provide-own (use custom images), none
+   * (no images, use icons)
+   */
+  imageMode?: 'search' | 'provide-own' | 'none';
+
+  /**
+   * Custom logo URL to use (optional, falls back to default StudyFetch logo)
+   */
+  logoUrl?: string;
+}
+
+export namespace PdfGeneratorCreateParams {
+  export interface CustomImage {
+    /**
+     * Description of what this image shows
+     */
+    description: string;
+
+    /**
+     * Base64-encoded image data (provide either url or base64)
+     */
+    base64?: string;
+
+    /**
+     * Image URL to download and use (provide either url or base64)
+     */
+    url?: string;
+  }
 }
 
 PdfGenerator.Get = Get;

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

@@ -0,0 +1,238 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Conversations extends APIResource {
+  /**
+   * List Performance Insights conversations for the current user.
+   *
+   * @example
+   * ```ts
+   * await client.v1.performanceInsights.conversations.list();
+   * ```
+   */
+  list(params: ConversationListParams | null | undefined = {}, options?: RequestOptions): APIPromise<void> {
+    const { 'x-user-id': xUserID, 'x-group-ids': xGroupIDs, ...query } = params ?? {};
+    return this._client.get('/api/v1/performance-insights/sessions', {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          Accept: '*/*',
+          ...(xUserID != null ? { 'x-user-id': xUserID } : undefined),
+          ...(xGroupIDs != null ? { 'x-group-ids': xGroupIDs } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Create a new Performance Insights conversation.
+   *
+   * @example
+   * ```ts
+   * await client.v1.performanceInsights.conversations.create();
+   * ```
+   */
+  create(
+    params: ConversationCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { 'x-group-ids': xGroupIDs, ...body } = params ?? {};
+    return this._client.post('/api/v1/performance-insights/sessions/create', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { Accept: '*/*', ...(xGroupIDs != null ? { 'x-group-ids': xGroupIDs } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Retrieve a single conversation with its full message history.
+   *
+   * @example
+   * ```ts
+   * await client.v1.performanceInsights.conversations.retrieve('sessionId');
+   * ```
+   */
+  retrieve(
+    sessionID: string,
+    params: ConversationRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { 'x-group-ids': xGroupIDs } = params ?? {};
+    return this._client.get(path`/api/v1/performance-insights/session/${sessionID}`, {
+      ...options,
+      headers: buildHeaders([
+        { Accept: '*/*', ...(xGroupIDs != null ? { 'x-group-ids': xGroupIDs } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Push messages to a conversation. Creates the conversation if it does not exist.
+   *
+   * @example
+   * ```ts
+   * await client.v1.performanceInsights.conversations.pushMessages('sessionId', {
+   *   messages: [],
+   * });
+   * ```
+   */
+  pushMessages(
+    sessionID: string,
+    params: ConversationPushMessagesParams,
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { 'x-group-ids': xGroupIDs, ...body } = params;
+    return this._client.put(path`/api/v1/performance-insights/session/${sessionID}/messages`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { Accept: '*/*', ...(xGroupIDs != null ? { 'x-group-ids': xGroupIDs } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Rename a conversation.
+   *
+   * @example
+   * ```ts
+   * await client.v1.performanceInsights.conversations.rename('sessionId', {
+   *   title: 'New title',
+   * });
+   * ```
+   */
+  rename(sessionID: string, params: ConversationRenameParams, options?: RequestOptions): APIPromise<void> {
+    const { 'x-group-ids': xGroupIDs, ...body } = params;
+    return this._client.patch(path`/api/v1/performance-insights/session/${sessionID}/title`, {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { Accept: '*/*', ...(xGroupIDs != null ? { 'x-group-ids': xGroupIDs } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * Delete a conversation.
+   *
+   * @example
+   * ```ts
+   * await client.v1.performanceInsights.conversations.delete('sessionId');
+   * ```
+   */
+  delete(
+    sessionID: string,
+    params: ConversationDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { 'x-group-ids': xGroupIDs } = params ?? {};
+    return this._client.delete(path`/api/v1/performance-insights/session/${sessionID}`, {
+      ...options,
+      headers: buildHeaders([
+        { Accept: '*/*', ...(xGroupIDs != null ? { 'x-group-ids': xGroupIDs } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface ConversationListParams {
+  /**
+   * Query param: Maximum number of conversations to return (default 50)
+   */
+  limit?: string;
+
+  /**
+   * Header param: Group IDs header (comma-separated) to scope sessions by group
+   */
+  'x-group-ids'?: string;
+
+  /**
+   * Header param: User ID header (used when authenticating via API key)
+   */
+  'x-user-id'?: string;
+}
+
+export interface ConversationCreateParams {
+  /**
+   * Body param: Custom session ID. Auto-generated if omitted.
+   */
+  sessionId?: string;
+
+  /**
+   * Body param: Conversation title (default "New Chat")
+   */
+  title?: string;
+
+  /**
+   * Header param: Group IDs header (comma-separated) to scope sessions by group
+   */
+  'x-group-ids'?: string;
+}
+
+export interface ConversationRetrieveParams {
+  /**
+   * Header param: Group IDs header (comma-separated) to scope sessions by group
+   */
+  'x-group-ids'?: string;
+}
+
+export interface ConversationPushMessagesParams {
+  /**
+   * Body param: Array of AI SDK UIMessage objects to persist
+   */
+  messages: unknown;
+
+  /**
+   * Body param: Update the conversation title
+   */
+  title?: string;
+
+  /**
+   * Header param: Group IDs header (comma-separated) to scope sessions by group
+   */
+  'x-group-ids'?: string;
+}
+
+export interface ConversationRenameParams {
+  /**
+   * Body param: New conversation title
+   */
+  title: string;
+
+  /**
+   * Header param: Group IDs header (comma-separated) to scope sessions by group
+   */
+  'x-group-ids'?: string;
+}
+
+export interface ConversationDeleteParams {
+  /**
+   * Header param: Group IDs header (comma-separated) to scope sessions by group
+   */
+  'x-group-ids'?: string;
+}
+
+export declare namespace Conversations {
+  export {
+    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/index.ts

@@ -0,0 +1,17 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Conversations,
+  type ConversationListParams,
+  type ConversationCreateParams,
+  type ConversationRetrieveParams,
+  type ConversationPushMessagesParams,
+  type ConversationRenameParams,
+  type ConversationDeleteParams,
+} from './conversations';
+export {
+  PerformanceInsights,
+  type PerformanceInsightsGenerateEmbedResponse,
+  type PerformanceInsightsGenerateEmbedParams,
+  type PerformanceInsightsStreamParams,
+} from './performance-insights';

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 {