@studyfetch/sdk 1.25.0 → 1.27.0

package/src/resources/v1/assignment-grader.ts

@@ -2,6 +2,7 @@
 
 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';
 
@@ -24,6 +25,21 @@ export class AssignmentGrader extends APIResource {
     return this._client.post('/api/v1/assignment-grader/create', { body, ...options });
   }
 
+  /**
+   * Delete an assignment grader by ID
+   *
+   * @example
+   * ```ts
+   * await client.v1.assignmentGrader.delete('id');
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/api/v1/assignment-grader/delete/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
   /**
    * Get all assignment graders
    *
@@ -52,10 +68,15 @@ export class AssignmentGrader extends APIResource {
 }
 
 export interface AssignmentGraderResponse {
+  /**
+   * Version key
+   */
+  __v: number;
+
   /**
    * Assignment grader ID
    */
-  id: string;
+  _id: string;
 
   /**
    * Creation timestamp
@@ -67,6 +88,11 @@ export interface AssignmentGraderResponse {
    */
   grade: number;
 
+  /**
+   * Organization ID
+   */
+  organizationId: string;
+
   /**
    * Grading results
    */
@@ -76,6 +102,26 @@ export interface AssignmentGraderResponse {
    * Assignment title
    */
   title: string;
+
+  /**
+   * Update timestamp
+   */
+  updatedAt: string;
+
+  /**
+   * Material ID
+   */
+  materialId?: string;
+
+  /**
+   * Text that was graded
+   */
+  textToGrade?: string;
+
+  /**
+   * User ID
+   */
+  userId?: string;
 }
 
 export type AssignmentGraderGetAllResponse = Array<AssignmentGraderResponse>;

package/src/resources/v1/components.ts

@@ -176,6 +176,7 @@ export interface Component {
    */
   type:
     | 'chat'
+    | 'data_analyst'
     | 'flashcards'
     | 'scenarios'
     | 'practice_test'
@@ -257,6 +258,7 @@ export interface ComponentCreateParams {
    */
   config:
     | ComponentCreateParams.ChatConfigDto
+    | ComponentCreateParams.DataAnalystConfigDto
     | ComponentCreateParams.FlashcardsConfigDto
     | ComponentCreateParams.ScenariosConfigDto
     | ComponentCreateParams.PracticeTestConfigDto
@@ -275,6 +277,7 @@ export interface ComponentCreateParams {
    */
   type:
     | 'chat'
+    | 'data_analyst'
     | 'flashcards'
     | 'scenarios'
     | 'practice_test'
@@ -311,6 +314,11 @@ export namespace ComponentCreateParams {
      */
     enableFollowUps?: boolean;
 
+    /**
+     * Enable guardrails for content moderation
+     */
+    enableGuardrails?: boolean;
+
     /**
      * Enable conversation history
      */
@@ -336,6 +344,11 @@ export namespace ComponentCreateParams {
      */
     folders?: Array<string>;
 
+    /**
+     * Guardrail rules for content moderation
+     */
+    guardrailRules?: Array<ChatConfigDto.GuardrailRule>;
+
     /**
      * Material IDs
      */
@@ -362,6 +375,107 @@ export namespace ComponentCreateParams {
     temperature?: number;
   }
 
+  export namespace ChatConfigDto {
+    export interface GuardrailRule {
+      /**
+       * Unique identifier for the rule
+       */
+      id: string;
+
+      /**
+       * Action to take when rule is triggered
+       */
+      action: 'block' | 'warn' | 'modify';
+
+      /**
+       * Condition to check
+       */
+      condition: string;
+
+      /**
+       * Description of the rule
+       */
+      description: string;
+
+      /**
+       * Message to show when rule is triggered
+       */
+      message?: string;
+    }
+  }
+
+  export interface DataAnalystConfigDto {
+    /**
+     * AI model to use
+     */
+    model: string;
+
+    /**
+     * Enable component creation
+     */
+    enableComponentCreation?: boolean;
+
+    /**
+     * Enable follow-up questions
+     */
+    enableFollowUps?: boolean;
+
+    /**
+     * Enable conversation history
+     */
+    enableHistory?: boolean;
+
+    /**
+     * Enable RAG search
+     */
+    enableRAGSearch?: boolean;
+
+    /**
+     * Enable voice interactions
+     */
+    enableVoice?: boolean;
+
+    /**
+     * Enable web search
+     */
+    enableWebSearch?: boolean;
+
+    /**
+     * Folder IDs
+     */
+    folders?: Array<string>;
+
+    /**
+     * Group IDs to filter data
+     */
+    groupIds?: Array<string>;
+
+    /**
+     * Material IDs
+     */
+    materials?: Array<string>;
+
+    /**
+     * Maximum steps for multi-step tool calls
+     */
+    maxSteps?: number;
+
+    /**
+     * Maximum tokens for response
+     */
+    maxTokens?: number;
+
+    /**
+     * System prompt for the data analyst
+     */
+    systemPrompt?: string;
+
+    /**
+     * Temperature for response generation
+     */
+    temperature?: number;
+  }
+
   export interface FlashcardsConfigDto {
     /**
      * Types of flashcards
@@ -818,6 +932,7 @@ export interface ComponentListParams {
    */
   type?:
     | 'chat'
+    | 'data_analyst'
     | 'flashcards'
     | 'scenarios'
     | 'practice_test'
@@ -874,6 +989,11 @@ export namespace ComponentGenerateEmbedParams {
    * Feature toggles
    */
   export interface Features {
+    /**
+     * Enable bad words filter
+     */
+    enableBadWordsFilter: boolean;
+
     /**
      * Enable component creation
      */
@@ -884,6 +1004,11 @@ export namespace ComponentGenerateEmbedParams {
      */
     enableFollowUps?: boolean;
 
+    /**
+     * Enable guardrails
+     */
+    enableGuardrails?: boolean;
+
     /**
      * Enable history
      */

package/src/resources/v1/index.ts

@@ -6,17 +6,6 @@ export {
   type AssignmentGraderGetAllResponse,
   type AssignmentGraderCreateParams,
 } from './assignment-grader';
-export {
-  AudioRecaps,
-  type AudioRecapCreateParams,
-  type AudioRecapAskQuestionParams,
-} from './audio-recaps/index';
-export {
-  Chat,
-  type ChatGetSessionParams,
-  type ChatSendMessageParams,
-  type ChatStreamParams,
-} from './chat/index';
 export {
   Components,
   type Component,
@@ -28,21 +17,10 @@ export {
   type ComponentGenerateEmbedParams,
 } from './components';
 export { Embed, type EmbedGetThemeParams, type EmbedVerifyParams } from './embed/index';
-export { Explainers, type ExplainerCreateParams, type ExplainerHandleWebhookParams } from './explainers';
-export {
-  Flashcards,
-  type FlashcardBatchProcessResponse,
-  type FlashcardGetAlgorithmResponse,
-  type FlashcardGetTypesResponse,
-  type FlashcardBatchProcessParams,
-  type FlashcardGetAllParams,
-  type FlashcardGetDueParams,
-  type FlashcardGetStatsParams,
-  type FlashcardRateParams,
-} from './flashcards';
 export { Folders, type FolderCreateParams, type FolderUpdateParams, type FolderListParams } from './folders';
 export {
   Materials,
+  type Content,
   type Material,
   type MaterialListResponse,
   type MaterialBatchCreateResponse,
@@ -52,26 +30,12 @@ export {
   type MaterialCreateParams,
   type MaterialListParams,
   type MaterialBatchCreateParams,
+  type MaterialCreateAndProcessParams,
   type MaterialGetDownloadURLParams,
   type MaterialMoveParams,
   type MaterialRenameParams,
   type MaterialSearchParams,
 } from './materials/index';
-export {
-  Scenarios,
-  type Scenario,
-  type UpdateScenario,
-  type ScenarioCreateParams,
-  type ScenarioUpdateParams,
-  type ScenarioSubmitAnswerParams,
-} from './scenarios/index';
-export {
-  Tests,
-  type TestCreateParams,
-  type TestRetakeParams,
-  type TestSubmitParams,
-  type TestSubmitAnswerParams,
-} from './tests/index';
 export { Upload } from './upload/index';
 export {
   Usage,

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

@@ -3,6 +3,7 @@
 export { Bulk, type BulkMoveResponse, type BulkMoveParams } from './bulk';
 export {
   Materials,
+  type Content,
   type Material,
   type MaterialListResponse,
   type MaterialBatchCreateResponse,
@@ -12,6 +13,7 @@ export {
   type MaterialCreateParams,
   type MaterialListParams,
   type MaterialBatchCreateParams,
+  type MaterialCreateAndProcessParams,
   type MaterialGetDownloadURLParams,
   type MaterialMoveParams,
   type MaterialRenameParams,
@@ -26,9 +28,12 @@ export {
 } from './test';
 export {
   Upload,
+  type Complete,
   type UploadCreatePresignedURLResponse,
   type UploadCompleteUploadParams,
   type UploadCreatePresignedURLParams,
   type UploadUploadFileParams,
+  type UploadUploadFileAndProcessParams,
   type UploadUploadFromURLParams,
+  type UploadUploadURLAndProcessParams,
 } from './upload';

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

@@ -13,12 +13,15 @@ import {
 } from './test';
 import * as UploadAPI from './upload';
 import {
+  Complete,
   Upload,
   UploadCompleteUploadParams,
   UploadCreatePresignedURLParams,
   UploadCreatePresignedURLResponse,
+  UploadUploadFileAndProcessParams,
   UploadUploadFileParams,
   UploadUploadFromURLParams,
+  UploadUploadURLAndProcessParams,
 } from './upload';
 import { APIPromise } from '../../../core/api-promise';
 import { buildHeaders } from '../../../internal/headers';
@@ -110,6 +113,24 @@ export class Materials extends APIResource {
     return this._client.post('/api/v1/materials/batch', { body, ...options });
   }
 
+  /**
+   * Creates a material and waits for processing to finish before returning. Useful
+   * for synchronous API usage.
+   *
+   * @example
+   * ```ts
+   * const material = await client.v1.materials.createAndProcess(
+   *   {
+   *     content: { type: 'text' },
+   *     name: 'Chapter 1 - Introduction',
+   *   },
+   * );
+   * ```
+   */
+  createAndProcess(body: MaterialCreateAndProcessParams, options?: RequestOptions): APIPromise<Material> {
+    return this._client.post('/api/v1/materials/upload-and-process', { body, ...options });
+  }
+
   /**
    * Get debug information for a material including extracted content
    *
@@ -195,6 +216,28 @@ export class Materials extends APIResource {
   }
 }
 
+export interface Content {
+  /**
+   * Type of content
+   */
+  type: 'text' | 'pdf' | 'video' | 'audio' | 'url';
+
+  /**
+   * URL to fetch content from
+   */
+  sourceUrl?: string;
+
+  /**
+   * Text content (for text type)
+   */
+  text?: string;
+
+  /**
+   * URL to the content (for url type)
+   */
+  url?: string;
+}
+
 export interface Material {
   /**
    * Material ID
@@ -441,7 +484,7 @@ export interface MaterialCreateParams {
   /**
    * Content details
    */
-  content: MaterialCreateParams.Content;
+  content: Content;
 
   /**
    * Name of the material
@@ -454,33 +497,6 @@ export interface MaterialCreateParams {
   folderId?: string;
 }
 
-export namespace MaterialCreateParams {
-  /**
-   * Content details
-   */
-  export interface Content {
-    /**
-     * Type of content
-     */
-    type: 'text' | 'pdf' | 'video' | 'audio' | 'url';
-
-    /**
-     * URL to fetch content from
-     */
-    sourceUrl?: string;
-
-    /**
-     * Text content (for text type)
-     */
-    text?: string;
-
-    /**
-     * URL to the content (for url type)
-     */
-    url?: string;
-  }
-}
-
 export interface MaterialListParams {
   /**
    * Filter by folder ID
@@ -519,6 +535,33 @@ export namespace MaterialBatchCreateParams {
   }
 }
 
+export interface MaterialCreateAndProcessParams {
+  /**
+   * Content details
+   */
+  content: Content;
+
+  /**
+   * Name of the material
+   */
+  name: string;
+
+  /**
+   * Folder ID to place the material in
+   */
+  folderId?: string;
+
+  /**
+   * Polling interval in milliseconds (default: 2 seconds)
+   */
+  pollIntervalMs?: number;
+
+  /**
+   * Maximum time to wait for processing in milliseconds (default: 5 minutes)
+   */
+  timeoutMs?: number;
+}
+
 export interface MaterialGetDownloadURLParams {
   /**
    * URL expiration time in seconds (default: 3600)
@@ -568,6 +611,7 @@ Materials.Test = Test;
 
 export declare namespace Materials {
   export {
+    type Content as Content,
     type Material as Material,
     type MaterialListResponse as MaterialListResponse,
     type MaterialBatchCreateResponse as MaterialBatchCreateResponse,
@@ -577,6 +621,7 @@ export declare namespace Materials {
     type MaterialCreateParams as MaterialCreateParams,
     type MaterialListParams as MaterialListParams,
     type MaterialBatchCreateParams as MaterialBatchCreateParams,
+    type MaterialCreateAndProcessParams as MaterialCreateAndProcessParams,
     type MaterialGetDownloadURLParams as MaterialGetDownloadURLParams,
     type MaterialMoveParams as MaterialMoveParams,
     type MaterialRenameParams as MaterialRenameParams,
@@ -585,11 +630,14 @@ export declare namespace Materials {
 
   export {
     Upload as Upload,
+    type Complete as Complete,
     type UploadCreatePresignedURLResponse as UploadCreatePresignedURLResponse,
     type UploadCompleteUploadParams as UploadCompleteUploadParams,
     type UploadCreatePresignedURLParams as UploadCreatePresignedURLParams,
     type UploadUploadFileParams as UploadUploadFileParams,
+    type UploadUploadFileAndProcessParams as UploadUploadFileAndProcessParams,
     type UploadUploadFromURLParams as UploadUploadFromURLParams,
+    type UploadUploadURLAndProcessParams as UploadUploadURLAndProcessParams,
   };
 
   export { Bulk as Bulk, type BulkMoveResponse as BulkMoveResponse, type BulkMoveParams as BulkMoveParams };

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

@@ -68,6 +68,29 @@ export class Upload extends APIResource {
     );
   }
 
+  /**
+   * Uploads a file and waits for processing to finish before returning. Useful for
+   * synchronous API usage.
+   *
+   * @example
+   * ```ts
+   * const material =
+   *   await client.v1.materials.upload.uploadFileAndProcess({
+   *     file: fs.createReadStream('path/to/file'),
+   *     name: 'name',
+   *   });
+   * ```
+   */
+  uploadFileAndProcess(
+    body: UploadUploadFileAndProcessParams,
+    options?: RequestOptions,
+  ): APIPromise<MaterialsAPI.Material> {
+    return this._client.post(
+      '/api/v1/materials/upload/file-and-process',
+      multipartFormRequestOptions({ body, ...options }, this._client),
+    );
+  }
+
   /**
    * Upload material from URL
    *
@@ -86,6 +109,43 @@ export class Upload extends APIResource {
   ): APIPromise<MaterialsAPI.Material> {
     return this._client.post('/api/v1/materials/upload/url', { body, ...options });
   }
+
+  /**
+   * Fetches content from URL and waits for processing to finish before returning.
+   * Useful for synchronous API usage.
+   *
+   * @example
+   * ```ts
+   * const material =
+   *   await client.v1.materials.upload.uploadURLAndProcess({
+   *     name: 'My Document',
+   *     url: 'https://example.com/document.pdf',
+   *   });
+   * ```
+   */
+  uploadURLAndProcess(
+    body: UploadUploadURLAndProcessParams,
+    options?: RequestOptions,
+  ): APIPromise<MaterialsAPI.Material> {
+    return this._client.post('/api/v1/materials/upload/url-and-process', { body, ...options });
+  }
+}
+
+export interface Complete {
+  /**
+   * The ID of the material that was uploaded
+   */
+  materialId: string;
+
+  /**
+   * The ID of the organization
+   */
+  organizationId: string;
+
+  /**
+   * The S3 key of the uploaded file
+   */
+  s3Key: string;
 }
 
 export interface UploadCreatePresignedURLResponse {
@@ -138,6 +198,11 @@ export interface UploadCreatePresignedURLParams {
    */
   name: string;
 
+  /**
+   * Whether to extract images from files
+   */
+  extractImages?: boolean;
+
   /**
    * Folder ID to place the material in
    */
@@ -152,12 +217,46 @@ export interface UploadUploadFileParams {
    */
   name: string;
 
+  /**
+   * Whether to extract images from files (true/false, default: true)
+   */
+  extractImages?: string;
+
   /**
    * Folder ID (optional)
    */
   folderId?: string;
 }
 
+export interface UploadUploadFileAndProcessParams {
+  file: Uploadable;
+
+  /**
+   * Material name
+   */
+  name: string;
+
+  /**
+   * Whether to extract images from files (true/false, default: true)
+   */
+  extractImages?: string;
+
+  /**
+   * Folder ID (optional)
+   */
+  folderId?: string;
+
+  /**
+   * Polling interval in milliseconds (default: 2000)
+   */
+  pollIntervalMs?: number;
+
+  /**
+   * Processing timeout in milliseconds (default: 300000)
+   */
+  timeoutMs?: number;
+}
+
 export interface UploadUploadFromURLParams {
   /**
    * Material name
@@ -175,12 +274,42 @@ export interface UploadUploadFromURLParams {
   folderId?: string;
 }
 
+export interface UploadUploadURLAndProcessParams {
+  /**
+   * Material name
+   */
+  name: string;
+
+  /**
+   * URL to fetch content from
+   */
+  url: string;
+
+  /**
+   * Folder ID (optional)
+   */
+  folderId?: string;
+
+  /**
+   * Polling interval in milliseconds (default: 2 seconds)
+   */
+  pollIntervalMs?: number;
+
+  /**
+   * Maximum time to wait for processing in milliseconds (default: 5 minutes)
+   */
+  timeoutMs?: number;
+}
+
 export declare namespace Upload {
   export {
+    type Complete as Complete,
     type UploadCreatePresignedURLResponse as UploadCreatePresignedURLResponse,
     type UploadCompleteUploadParams as UploadCompleteUploadParams,
     type UploadCreatePresignedURLParams as UploadCreatePresignedURLParams,
     type UploadUploadFileParams as UploadUploadFileParams,
+    type UploadUploadFileAndProcessParams as UploadUploadFileAndProcessParams,
     type UploadUploadFromURLParams as UploadUploadFromURLParams,
+    type UploadUploadURLAndProcessParams as UploadUploadURLAndProcessParams,
   };
 }