@studyfetch/sdk 1.10.0 → 1.12.0

package/src/resources/v1/components.ts

@@ -13,14 +13,14 @@ export class Components extends APIResource {
    * @example
    * ```ts
    * const component = await client.v1.components.create({
-   *   config: { model: 'gpt-4o-mini' },
+   *   config: { model: 'gpt-4o-mini-2024-07-18' },
    *   name: 'My Study Component',
    *   origin: 'chat',
    *   type: 'chat',
    * });
    * ```
    */
-  create(body: ComponentCreateParams, options?: RequestOptions): APIPromise<ComponentCreateResponse> {
+  create(body: ComponentCreateParams, options?: RequestOptions): APIPromise<Component> {
     return this._client.post('/api/v1/components', { body, ...options });
   }
 
@@ -32,7 +32,7 @@ export class Components extends APIResource {
    * const component = await client.v1.components.retrieve('id');
    * ```
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<ComponentRetrieveResponse> {
+  retrieve(id: string, options?: RequestOptions): APIPromise<Component> {
     return this._client.get(path`/api/v1/components/${id}`, options);
   }
 
@@ -44,11 +44,7 @@ export class Components extends APIResource {
    * const component = await client.v1.components.update('id');
    * ```
    */
-  update(
-    id: string,
-    body: ComponentUpdateParams,
-    options?: RequestOptions,
-  ): APIPromise<ComponentUpdateResponse> {
+  update(id: string, body: ComponentUpdateParams, options?: RequestOptions): APIPromise<Component> {
     return this._client.patch(path`/api/v1/components/${id}`, { body, ...options });
   }
 
@@ -113,14 +109,16 @@ export class Components extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.v1.components.embed('id');
+   * const response = await client.v1.components.generateEmbed(
+   *   'id',
+   * );
    * ```
    */
-  embed(
+  generateEmbed(
     id: string,
-    body: ComponentEmbedParams,
+    body: ComponentGenerateEmbedParams,
     options?: RequestOptions,
-  ): APIPromise<ComponentEmbedResponse> {
+  ): APIPromise<ComponentGenerateEmbedResponse> {
     return this._client.post(path`/api/v1/components/${id}/embed`, { body, ...options });
   }
 
@@ -138,72 +136,7 @@ export class Components extends APIResource {
   }
 }
 
-export interface ComponentCreateResponse {
-  /**
-   * Component ID (MongoDB ObjectId)
-   */
-  _id: string;
-
-  /**
-   * Unique component identifier
-   */
-  componentId: string;
-
-  /**
-   * Component configuration
-   */
-  config: unknown;
-
-  /**
-   * Creation timestamp
-   */
-  createdAt: string;
-
-  /**
-   * Component name
-   */
-  name: string;
-
-  /**
-   * Organization ID
-   */
-  organization: string;
-
-  /**
-   * Component status
-   */
-  status: 'active' | 'inactive' | 'draft';
-
-  /**
-   * Component type
-   */
-  type:
-    | 'chat'
-    | 'flashcards'
-    | 'scenarios'
-    | 'practice_test'
-    | 'audio_recap'
-    | 'tutor_me'
-    | 'explainers'
-    | 'uploads';
-
-  /**
-   * Last update timestamp
-   */
-  updatedAt: string;
-
-  /**
-   * Usage statistics
-   */
-  usage: unknown;
-
-  /**
-   * Component description
-   */
-  description?: string;
-}
-
-export interface ComponentRetrieveResponse {
+export interface Component {
   /**
    * Component ID (MongoDB ObjectId)
    */
@@ -268,141 +201,9 @@ export interface ComponentRetrieveResponse {
   description?: string;
 }
 
-export interface ComponentUpdateResponse {
-  /**
-   * Component ID (MongoDB ObjectId)
-   */
-  _id: string;
-
-  /**
-   * Unique component identifier
-   */
-  componentId: string;
-
-  /**
-   * Component configuration
-   */
-  config: unknown;
+export type ComponentListResponse = Array<Component>;
 
-  /**
-   * Creation timestamp
-   */
-  createdAt: string;
-
-  /**
-   * Component name
-   */
-  name: string;
-
-  /**
-   * Organization ID
-   */
-  organization: string;
-
-  /**
-   * Component status
-   */
-  status: 'active' | 'inactive' | 'draft';
-
-  /**
-   * Component type
-   */
-  type:
-    | 'chat'
-    | 'flashcards'
-    | 'scenarios'
-    | 'practice_test'
-    | 'audio_recap'
-    | 'tutor_me'
-    | 'explainers'
-    | 'uploads';
-
-  /**
-   * Last update timestamp
-   */
-  updatedAt: string;
-
-  /**
-   * Usage statistics
-   */
-  usage: unknown;
-
-  /**
-   * Component description
-   */
-  description?: string;
-}
-
-export type ComponentListResponse = Array<ComponentListResponse.ComponentListResponseItem>;
-
-export namespace ComponentListResponse {
-  export interface ComponentListResponseItem {
-    /**
-     * Component ID (MongoDB ObjectId)
-     */
-    _id: string;
-
-    /**
-     * Unique component identifier
-     */
-    componentId: string;
-
-    /**
-     * Component configuration
-     */
-    config: unknown;
-
-    /**
-     * Creation timestamp
-     */
-    createdAt: string;
-
-    /**
-     * Component name
-     */
-    name: string;
-
-    /**
-     * Organization ID
-     */
-    organization: string;
-
-    /**
-     * Component status
-     */
-    status: 'active' | 'inactive' | 'draft';
-
-    /**
-     * Component type
-     */
-    type:
-      | 'chat'
-      | 'flashcards'
-      | 'scenarios'
-      | 'practice_test'
-      | 'audio_recap'
-      | 'tutor_me'
-      | 'explainers'
-      | 'uploads';
-
-    /**
-     * Last update timestamp
-     */
-    updatedAt: string;
-
-    /**
-     * Usage statistics
-     */
-    usage: unknown;
-
-    /**
-     * Component description
-     */
-    description?: string;
-  }
-}
-
-export interface ComponentEmbedResponse {
+export interface ComponentGenerateEmbedResponse {
   /**
    * JWT token for authentication
    */
@@ -431,10 +232,10 @@ export interface ComponentEmbedResponse {
   /**
    * Embed options
    */
-  options: ComponentEmbedResponse.Options;
+  options: ComponentGenerateEmbedResponse.Options;
 }
 
-export namespace ComponentEmbedResponse {
+export namespace ComponentGenerateEmbedResponse {
   /**
    * Embed options
    */
@@ -603,6 +404,11 @@ export namespace ComponentCreateParams {
      */
     maxReviewInterval?: number;
 
+    /**
+     * AI model to use for flashcard generation
+     */
+    model?: string;
+
     /**
      * Total number of flashcards to generate
      */
@@ -670,6 +476,11 @@ export namespace ComponentCreateParams {
      */
     materials?: Array<string>;
 
+    /**
+     * AI model to use for scenario generation
+     */
+    model?: string;
+
     /**
      * Placeholder text
      */
@@ -720,10 +531,20 @@ export namespace ComponentCreateParams {
        */
       name: string;
 
+      /**
+       * Data format provided by the tool
+       */
+      dataFormat?: string;
+
       /**
        * Tool description
        */
       description?: string;
+
+      /**
+       * Tool type
+       */
+      type?: string;
     }
   }
 
@@ -763,6 +584,11 @@ export namespace ComponentCreateParams {
      */
     maxAttempts?: number;
 
+    /**
+     * AI model to use for question generation and grading
+     */
+    model?: string;
+
     /**
      * Passing score percentage
      */
@@ -837,15 +663,20 @@ export namespace ComponentCreateParams {
   }
 
   export interface AudioRecapConfigDto {
+    /**
+     * Duration of audio recap in minutes
+     */
+    duration?: number;
+
     /**
      * Folder IDs
      */
     folders?: Array<string>;
 
     /**
-     * Audio format
+     * Enable multi-voice conversation mode
      */
-    format?: 'podcast' | 'summary' | 'lecture';
+    isMultiVoice?: boolean;
 
     /**
      * Material IDs
@@ -853,14 +684,39 @@ export namespace ComponentCreateParams {
     materials?: Array<string>;
 
     /**
-     * Playback speed
+     * AI model to use for generation
+     */
+    model?: string;
+
+    /**
+     * Number of parts to split the audio into
+     */
+    numParts?: number;
+
+    /**
+     * Type of audio recap
+     */
+    recapType?: 'SUMMARY' | 'LECTURE' | 'PODCAST' | 'AUDIO_BOOK';
+
+    /**
+     * Theme or style for the audio recap
      */
-    speed?: number;
+    theme?: string;
 
     /**
-     * Voice to use for audio
+     * Specific topic to focus on
      */
-    voice?: string;
+    topic?: string;
+
+    /**
+     * Primary voice for narration
+     */
+    voice1?: string;
+
+    /**
+     * Secondary voice for multi-voice mode
+     */
+    voice2?: string;
   }
 
   export interface ExplainersConfigDto {
@@ -869,10 +725,45 @@ export namespace ComponentCreateParams {
      */
     folders?: Array<string>;
 
+    /**
+     * Enable image search for visuals
+     */
+    imageSearch?: boolean;
+
     /**
      * Material IDs
      */
     materials?: Array<string>;
+
+    /**
+     * AI model to use for generation
+     */
+    model?: string;
+
+    /**
+     * Video style
+     */
+    style?: string;
+
+    /**
+     * Target length in seconds
+     */
+    targetLength?: number;
+
+    /**
+     * Video title (defaults to component name if not provided)
+     */
+    title?: string;
+
+    /**
+     * Create vertical video format (9:16)
+     */
+    verticalVideo?: boolean;
+
+    /**
+     * Enable web search for additional content
+     */
+    webSearch?: boolean;
   }
 
   export interface UploadsConfigDto {
@@ -947,7 +838,7 @@ export interface ComponentListParams {
     | 'uploads';
 }
 
-export interface ComponentEmbedParams {
+export interface ComponentGenerateEmbedParams {
   /**
    * Token expiry time in hours
    */
@@ -956,7 +847,7 @@ export interface ComponentEmbedParams {
   /**
    * Feature toggles
    */
-  features?: ComponentEmbedParams.Features;
+  features?: ComponentGenerateEmbedParams.Features;
 
   /**
    * Group IDs for collaboration
@@ -976,7 +867,7 @@ export interface ComponentEmbedParams {
   /**
    * Theme customization
    */
-  theme?: ComponentEmbedParams.Theme;
+  theme?: ComponentGenerateEmbedParams.Theme;
 
   /**
    * User ID for tracking
@@ -989,7 +880,7 @@ export interface ComponentEmbedParams {
   width?: string;
 }
 
-export namespace ComponentEmbedParams {
+export namespace ComponentGenerateEmbedParams {
   /**
    * Feature toggles
    */
@@ -1103,14 +994,12 @@ export namespace ComponentEmbedParams {
 
 export declare namespace Components {
   export {
-    type ComponentCreateResponse as ComponentCreateResponse,
-    type ComponentRetrieveResponse as ComponentRetrieveResponse,
-    type ComponentUpdateResponse as ComponentUpdateResponse,
+    type Component as Component,
     type ComponentListResponse as ComponentListResponse,
-    type ComponentEmbedResponse as ComponentEmbedResponse,
+    type ComponentGenerateEmbedResponse as ComponentGenerateEmbedResponse,
     type ComponentCreateParams as ComponentCreateParams,
     type ComponentUpdateParams as ComponentUpdateParams,
     type ComponentListParams as ComponentListParams,
-    type ComponentEmbedParams as ComponentEmbedParams,
+    type ComponentGenerateEmbedParams as ComponentGenerateEmbedParams,
   };
 }

package/src/resources/v1/explainers.ts

@@ -4,6 +4,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';
 
 export class Explainers extends APIResource {
   /**
@@ -11,7 +12,13 @@ export class Explainers extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.explainers.create();
+   * await client.v1.explainers.create({
+   *   componentId: 'componentId',
+   *   folderIds: ['string'],
+   *   materialIds: ['string'],
+   *   targetLength: 15,
+   *   title: 'title',
+   * });
    * ```
    */
   create(body: ExplainerCreateParams, options?: RequestOptions): APIPromise<void> {
@@ -23,27 +30,169 @@ export class Explainers extends APIResource {
   }
 
   /**
-   * Handle webhook events
+   * Get explainer video by component ID
    *
    * @example
    * ```ts
-   * await client.v1.explainers.handleWebhook({ body: 'body' });
+   * await client.v1.explainers.retrieve('componentId');
    * ```
    */
-  handleWebhook(params: ExplainerHandleWebhookParams, options?: RequestOptions): APIPromise<void> {
-    const { body } = params;
+  retrieve(componentID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.get(path`/api/v1/explainers/component/${componentID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Handle explainer video webhook events
+   *
+   * @example
+   * ```ts
+   * await client.v1.explainers.handleWebhook({
+   *   event: 'video.completed',
+   *   video: { id: 'id' },
+   * });
+   * ```
+   */
+  handleWebhook(body: ExplainerHandleWebhookParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/explainers/webhook', {
-      body: body,
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 }
 
-export interface ExplainerCreateParams {}
+export interface ExplainerCreateParams {
+  /**
+   * Component ID
+   */
+  componentId: string;
+
+  /**
+   * Folder IDs to include
+   */
+  folderIds: Array<string>;
+
+  /**
+   * Material IDs to include
+   */
+  materialIds: Array<string>;
+
+  /**
+   * Target video length in seconds
+   */
+  targetLength: number;
+
+  /**
+   * Title for the explainer video
+   */
+  title: string;
+
+  /**
+   * Enable image search for visuals
+   */
+  imageSearch?: boolean;
+
+  /**
+   * AI model to use
+   */
+  model?: string;
+
+  /**
+   * Video style
+   */
+  style?: string;
+
+  /**
+   * User ID
+   */
+  userId?: string;
+
+  /**
+   * Create vertical video format (9:16)
+   */
+  verticalVideo?: boolean;
+
+  /**
+   * Enable web search for additional content
+   */
+  webSearch?: boolean;
+}
 
 export interface ExplainerHandleWebhookParams {
-  body: string;
+  /**
+   * Webhook event type
+   */
+  event: 'video.completed' | 'video.progress' | 'video.failed';
+
+  /**
+   * Video data
+   */
+  video: ExplainerHandleWebhookParams.Video;
+}
+
+export namespace ExplainerHandleWebhookParams {
+  /**
+   * Video data
+   */
+  export interface Video {
+    /**
+     * Video ID
+     */
+    id: string;
+
+    /**
+     * Image sources
+     */
+    imageSources?: unknown;
+
+    /**
+     * Progress percentage
+     */
+    progress?: number;
+
+    /**
+     * Video sections
+     */
+    sections?: Array<string>;
+
+    /**
+     * Stream ID
+     */
+    streamId?: string;
+
+    /**
+     * Stream URL
+     */
+    streamUrl?: string;
+
+    /**
+     * Thumbnail URL
+     */
+    thumbnailUrl?: string;
+
+    /**
+     * Video transcript
+     */
+    transcript?: string;
+
+    /**
+     * Video URL
+     */
+    videoUrl?: string;
+
+    /**
+     * Web search results
+     */
+    webSearchResults?: unknown;
+
+    /**
+     * Web search sources
+     */
+    webSearchSources?: unknown;
+  }
 }
 
 export declare namespace Explainers {