@studyfetch/sdk 1.42.0 → 1.45.0

package/src/resources/v1/index.ts

@@ -9,7 +9,7 @@ export {
   type AssignmentGraderGetAllResponse,
   type AssignmentGraderCreateParams,
 } from './assignment-grader/index';
-export { Chat, type ChatStreamParams } from './chat';
+export { Chat, type ChatRetrieveFeedbackParams, type ChatStreamParams } from './chat';
 export {
   ChatAnalytics,
   type ChatAnalyticsResponse,
@@ -33,6 +33,7 @@ export {
   Folders,
   type FolderMetadata,
   type FolderCreateResponse,
+  type FolderGetByNameResponse,
   type FolderRetrieveResponse,
   type FolderUpdateResponse,
   type FolderListResponse,
@@ -40,6 +41,7 @@ export {
   type FolderListMaterialsResponse,
   type FolderMoveResponse,
   type FolderCreateParams,
+  type FolderGetByNameParams,
   type FolderUpdateParams,
   type FolderListParams,
   type FolderListMaterialsParams,
@@ -52,9 +54,11 @@ export {
   type MaterialResponse,
   type Reference,
   type MaterialListResponse,
+  type MaterialCancelJobResponse,
   type MaterialCreateBatchUploadURLsResponse,
   type MaterialGetDebugInfoResponse,
   type MaterialGetDownloadURLResponse,
+  type MaterialGetJobStatusResponse,
   type MaterialSearchResponse,
   type MaterialCreateParams,
   type MaterialUpdateParams,
@@ -68,6 +72,19 @@ export {
   type MaterialRenameParams,
   type MaterialSearchParams,
 } from './materials/index';
+export {
+  PdfGenerator,
+  type PdfGeneratorCreateResponse,
+  type PdfGeneratorDeleteResponse,
+  type PdfGeneratorGetAllResponse,
+  type PdfGeneratorCreateParams,
+} from './pdf-generator/index';
+export {
+  PerformanceInsights,
+  type PerformanceInsightsGenerateEmbedResponse,
+  type PerformanceInsightsGenerateEmbedParams,
+  type PerformanceInsightsStreamParams,
+} from './performance-insights/index';
 export {
   Usage,
   type UsageGetStatsParams,

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

@@ -8,9 +8,11 @@ export {
   type MaterialResponse,
   type Reference,
   type MaterialListResponse,
+  type MaterialCancelJobResponse,
   type MaterialCreateBatchUploadURLsResponse,
   type MaterialGetDebugInfoResponse,
   type MaterialGetDownloadURLResponse,
+  type MaterialGetJobStatusResponse,
   type MaterialSearchResponse,
   type MaterialCreateParams,
   type MaterialUpdateParams,

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

@@ -96,6 +96,18 @@ export class Materials extends APIResource {
     });
   }
 
+  /**
+   * Attempts to cancel a currently running PDF processing job
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.materials.cancelJob('id');
+   * ```
+   */
+  cancelJob(id: string, options?: RequestOptions): APIPromise<MaterialCancelJobResponse> {
+    return this._client.post(path`/api/v1/materials/${id}/cancel-job`, options);
+  }
+
   /**
    * Creates a material and waits for processing to finish before returning. Useful
    * for synchronous API usage.
@@ -211,6 +223,21 @@ export class Materials extends APIResource {
     return this._client.get(path`/api/v1/materials/${id}/download-url`, { query, ...options });
   }
 
+  /**
+   * Returns the current status of a PDF processing job including progress
+   * information
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.materials.getJobStatus(
+   *   'id',
+   * );
+   * ```
+   */
+  getJobStatus(id: string, options?: RequestOptions): APIPromise<MaterialGetJobStatusResponse> {
+    return this._client.get(path`/api/v1/materials/${id}/job-status`, options);
+  }
+
   /**
    * Move material to a different folder
    *
@@ -484,6 +511,12 @@ export interface MaterialListResponse {
   totalPages?: number;
 }
 
+export interface MaterialCancelJobResponse {
+  message?: string;
+
+  success?: boolean;
+}
+
 export type MaterialCreateBatchUploadURLsResponse =
   Array<MaterialCreateBatchUploadURLsResponse.MaterialCreateBatchUploadURLsResponseItem>;
 
@@ -574,6 +607,88 @@ export interface MaterialGetDownloadURLResponse {
   downloadUrl: string;
 }
 
+export interface MaterialGetJobStatusResponse {
+  /**
+   * Job completion time
+   */
+  completedAt?: string;
+
+  /**
+   * Error message if job failed
+   */
+  error?: string;
+
+  /**
+   * Unique job identifier
+   */
+  jobId?: string;
+
+  progress?: MaterialGetJobStatusResponse.Progress;
+
+  resultSummary?: MaterialGetJobStatusResponse.ResultSummary;
+
+  /**
+   * Job start time
+   */
+  startedAt?: string;
+
+  /**
+   * Current job status
+   */
+  status?: 'pending' | 'running' | 'completed' | 'failed' | 'cancelled';
+}
+
+export namespace MaterialGetJobStatusResponse {
+  export interface Progress {
+    /**
+     * Current batch being processed
+     */
+    currentBatch?: number;
+
+    /**
+     * Completion percentage (0-100)
+     */
+    percentage?: number;
+
+    /**
+     * Images processed so far
+     */
+    processedImages?: number;
+
+    /**
+     * Total number of batches
+     */
+    totalBatches?: number;
+
+    /**
+     * Total images to process
+     */
+    totalImages?: number;
+  }
+
+  export interface ResultSummary {
+    /**
+     * Number of images processed
+     */
+    imagesProcessed?: number;
+
+    /**
+     * Total processing time in milliseconds
+     */
+    processingTimeMs?: number;
+
+    /**
+     * Whether text was extracted
+     */
+    textExtracted?: boolean;
+
+    /**
+     * Length of extracted text
+     */
+    textLength?: number;
+  }
+}
+
 export interface MaterialSearchResponse {
   /**
    * Whether results were filtered by scope
@@ -922,9 +1037,11 @@ export declare namespace Materials {
     type MaterialResponse as MaterialResponse,
     type Reference as Reference,
     type MaterialListResponse as MaterialListResponse,
+    type MaterialCancelJobResponse as MaterialCancelJobResponse,
     type MaterialCreateBatchUploadURLsResponse as MaterialCreateBatchUploadURLsResponse,
     type MaterialGetDebugInfoResponse as MaterialGetDebugInfoResponse,
     type MaterialGetDownloadURLResponse as MaterialGetDownloadURLResponse,
+    type MaterialGetJobStatusResponse as MaterialGetJobStatusResponse,
     type MaterialSearchResponse as MaterialSearchResponse,
     type MaterialCreateParams as MaterialCreateParams,
     type MaterialUpdateParams as MaterialUpdateParams,

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

@@ -0,0 +1,80 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+
+export class Get extends APIResource {}
+
+export interface PdfResponse {
+  /**
+   * PDF presentation ID
+   */
+  _id: string;
+
+  /**
+   * Creation timestamp
+   */
+  createdAt: string;
+
+  /**
+   * Locale of the presentation
+   */
+  locale: string;
+
+  /**
+   * Number of slides
+   */
+  numberOfSlides: number;
+
+  /**
+   * Organization ID
+   */
+  organizationId: string;
+
+  /**
+   * Topic of the presentation
+   */
+  topic: string;
+
+  /**
+   * Transcript of each slide
+   */
+  transcript: Array<PdfResponse.Transcript>;
+
+  /**
+   * Update timestamp
+   */
+  updatedAt: string;
+
+  /**
+   * URL to the generated PDF on S3
+   */
+  url: string;
+
+  /**
+   * URL to the generated PowerPoint (PPTX) on S3
+   */
+  pptxUrl?: string;
+
+  /**
+   * User ID
+   */
+  userId?: string;
+}
+
+export namespace PdfResponse {
+  export interface Transcript {
+    /**
+     * Description of the slide content and OCR text
+     */
+    descriptionOfPage: string;
+
+    /**
+     * Page number of the slide
+     */
+    pageNum: number;
+  }
+}
+
+export declare namespace Get {
+  export { type PdfResponse as PdfResponse };
+}

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

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Get, type PdfResponse } from './get';
+export {
+  PdfGenerator,
+  type PdfGeneratorCreateResponse,
+  type PdfGeneratorDeleteResponse,
+  type PdfGeneratorGetAllResponse,
+  type PdfGeneratorCreateParams,
+} from './pdf-generator';

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

@@ -0,0 +1,147 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as GetAPI from './get';
+import { Get, PdfResponse } from './get';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class PdfGenerator extends APIResource {
+  get: GetAPI.Get = new GetAPI.Get(this._client);
+
+  /**
+   * Generate a new PDF presentation
+   *
+   * @example
+   * ```ts
+   * const pdfGenerator = await client.v1.pdfGenerator.create({
+   *   locale: 'locale',
+   *   numberOfSlides: 1,
+   *   topic: 'topic',
+   * });
+   * ```
+   */
+  create(body: PdfGeneratorCreateParams, options?: RequestOptions): APIPromise<PdfGeneratorCreateResponse> {
+    return this._client.post('/api/v1/pdf-generator/create', { body, ...options });
+  }
+
+  /**
+   * Delete a PDF presentation by ID
+   *
+   * @example
+   * ```ts
+   * const pdfGenerator = await client.v1.pdfGenerator.delete(
+   *   'id',
+   * );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<PdfGeneratorDeleteResponse> {
+    return this._client.delete(path`/api/v1/pdf-generator/delete/${id}`, options);
+  }
+
+  /**
+   * Get all PDF presentations
+   *
+   * @example
+   * ```ts
+   * const pdfResponses = await client.v1.pdfGenerator.getAll();
+   * ```
+   */
+  getAll(options?: RequestOptions): APIPromise<PdfGeneratorGetAllResponse> {
+    return this._client.get('/api/v1/pdf-generator/get', options);
+  }
+
+  /**
+   * Get a PDF presentation by ID
+   *
+   * @example
+   * ```ts
+   * const pdfResponse = await client.v1.pdfGenerator.getByID(
+   *   'id',
+   * );
+   * ```
+   */
+  getByID(id: string, options?: RequestOptions): APIPromise<GetAPI.PdfResponse> {
+    return this._client.get(path`/api/v1/pdf-generator/get/${id}`, options);
+  }
+}
+
+export interface PdfGeneratorCreateResponse {
+  presentation?: GetAPI.PdfResponse;
+
+  success?: boolean;
+}
+
+export interface PdfGeneratorDeleteResponse {
+  message?: string;
+
+  success?: boolean;
+}
+
+export type PdfGeneratorGetAllResponse = Array<GetAPI.PdfResponse>;
+
+export interface PdfGeneratorCreateParams {
+  /**
+   * Locale/language for the presentation (e.g., en-US, es-ES, fr-FR)
+   */
+  locale: string;
+
+  /**
+   * Number of slides to generate
+   */
+  numberOfSlides: number;
+
+  /**
+   * 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;
+
+export declare namespace PdfGenerator {
+  export {
+    type PdfGeneratorCreateResponse as PdfGeneratorCreateResponse,
+    type PdfGeneratorDeleteResponse as PdfGeneratorDeleteResponse,
+    type PdfGeneratorGetAllResponse as PdfGeneratorGetAllResponse,
+    type PdfGeneratorCreateParams as PdfGeneratorCreateParams,
+  };
+
+  export { Get as Get, type PdfResponse as PdfResponse };
+}

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

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