@studyfetch/sdk 1.10.0 → 1.11.0

package/src/resources/v1/components.ts

@@ -13,7 +13,7 @@ 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',
@@ -603,6 +603,11 @@ export namespace ComponentCreateParams {
      */
     maxReviewInterval?: number;
 
+    /**
+     * AI model to use for flashcard generation
+     */
+    model?: string;
+
     /**
      * Total number of flashcards to generate
      */
@@ -670,6 +675,11 @@ export namespace ComponentCreateParams {
      */
     materials?: Array<string>;
 
+    /**
+     * AI model to use for scenario generation
+     */
+    model?: string;
+
     /**
      * Placeholder text
      */
@@ -720,10 +730,20 @@ export namespace ComponentCreateParams {
        */
       name: string;
 
+      /**
+       * Data format provided by the tool
+       */
+      dataFormat?: string;
+
       /**
        * Tool description
        */
       description?: string;
+
+      /**
+       * Tool type
+       */
+      type?: string;
     }
   }
 
@@ -763,6 +783,11 @@ export namespace ComponentCreateParams {
      */
     maxAttempts?: number;
 
+    /**
+     * AI model to use for question generation and grading
+     */
+    model?: string;
+
     /**
      * Passing score percentage
      */
@@ -837,15 +862,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 +883,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 +924,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 {

package/src/resources/v1/explainers.ts

@@ -11,7 +11,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 +29,154 @@ export class Explainers extends APIResource {
   }
 
   /**
-   * Handle webhook events
+   * Handle explainer video webhook events
    *
    * @example
    * ```ts
-   * await client.v1.explainers.handleWebhook({ body: 'body' });
+   * await client.v1.explainers.handleWebhook({
+   *   event: 'video.completed',
+   *   video: { id: 'id' },
+   * });
    * ```
    */
-  handleWebhook(params: ExplainerHandleWebhookParams, options?: RequestOptions): APIPromise<void> {
-    const { body } = params;
+  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 {

package/src/resources/v1/index.ts

@@ -49,7 +49,12 @@ export {
   type MaterialGetDownloadURLParams,
 } from './materials/index';
 export { Organizations } from './organizations/index';
-export { Scenarios, type ScenarioCreateParams, type ScenarioUpdateParams } from './scenarios/index';
+export {
+  Scenarios,
+  type ScenarioCreateParams,
+  type ScenarioUpdateParams,
+  type ScenarioSubmitParams,
+} from './scenarios/index';
 export {
   Tests,
   type TestCreateParams,

package/src/resources/v1/scenarios/component.ts

@@ -28,14 +28,14 @@ export class Component extends APIResource {
    * @example
    * ```ts
    * await client.v1.scenarios.component.update('componentId', {
-   *   body: 'body',
+   *   body_componentId: 'componentId',
+   *   name: 'name',
    * });
    * ```
    */
-  update(componentID: string, params: ComponentUpdateParams, options?: RequestOptions): APIPromise<void> {
-    const { body } = params;
+  update(componentID: string, body: ComponentUpdateParams, options?: RequestOptions): APIPromise<void> {
     return this._client.put(path`/api/v1/scenarios/component/${componentID}`, {
-      body: body,
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -58,7 +58,65 @@ export class Component extends APIResource {
 }
 
 export interface ComponentUpdateParams {
-  body: string;
+  /**
+   * Associated component ID
+   */
+  body_componentId: string;
+
+  /**
+   * Scenario name
+   */
+  name: string;
+
+  /**
+   * Scenario characters
+   */
+  characters?: Array<unknown>;
+
+  /**
+   * Scenario context
+   */
+  context?: string;
+
+  /**
+   * Scenario description
+   */
+  description?: string;
+
+  /**
+   * Prompt for final answer
+   */
+  finalAnswerPrompt?: string;
+
+  /**
+   * Interaction format
+   */
+  format?: string;
+
+  /**
+   * Scenario goal
+   */
+  goal?: string;
+
+  /**
+   * Character ID for greeting
+   */
+  greetingCharacterId?: string;
+
+  /**
+   * Greeting message
+   */
+  greetingMessage?: string;
+
+  /**
+   * Whether scenario requires a final answer
+   */
+  requiresFinalAnswer?: boolean;
+
+  /**
+   * Available tools
+   */
+  tools?: Array<unknown>;
 }
 
 export declare namespace Component {

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

@@ -1,6 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export { Component, type ComponentUpdateParams } from './component';
-export { Scenarios, type ScenarioCreateParams, type ScenarioUpdateParams } from './scenarios';
+export {
+  Scenarios,
+  type ScenarioCreateParams,
+  type ScenarioUpdateParams,
+  type ScenarioSubmitParams,
+} from './scenarios';
 export { Sessions } from './sessions';
 export { Submissions } from './submissions/index';

package/src/resources/v1/scenarios/scenarios.ts

@@ -22,13 +22,15 @@ export class Scenarios extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.scenarios.create({ body: 'body' });
+   * await client.v1.scenarios.create({
+   *   componentId: 'componentId',
+   *   name: 'name',
+   * });
    * ```
    */
-  create(params: ScenarioCreateParams, options?: RequestOptions): APIPromise<void> {
-    const { body } = params;
+  create(body: ScenarioCreateParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/scenarios', {
-      body: body,
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -54,13 +56,15 @@ export class Scenarios extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.scenarios.update('id', { body: 'body' });
+   * await client.v1.scenarios.update('id', {
+   *   componentId: 'componentId',
+   *   name: 'name',
+   * });
    * ```
    */
-  update(id: string, params: ScenarioUpdateParams, options?: RequestOptions): APIPromise<void> {
-    const { body } = params;
+  update(id: string, body: ScenarioUpdateParams, options?: RequestOptions): APIPromise<void> {
     return this._client.put(path`/api/v1/scenarios/${id}`, {
-      body: body,
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -110,13 +114,18 @@ export class Scenarios extends APIResource {
   }
 
   /**
+   * Submit scenario answer
+   *
    * @example
    * ```ts
-   * await client.v1.scenarios.submit('id');
+   * await client.v1.scenarios.submit('id', {
+   *   conversationHistory: [{}],
+   * });
    * ```
    */
-  submit(id: string, options?: RequestOptions): APIPromise<void> {
+  submit(id: string, body: ScenarioSubmitParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/scenarios/${id}/submit`, {
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -124,11 +133,139 @@ export class Scenarios extends APIResource {
 }
 
 export interface ScenarioCreateParams {
-  body: string;
+  /**
+   * Associated component ID
+   */
+  componentId: string;
+
+  /**
+   * Scenario name
+   */
+  name: string;
+
+  /**
+   * Scenario characters
+   */
+  characters?: Array<unknown>;
+
+  /**
+   * Scenario context
+   */
+  context?: string;
+
+  /**
+   * Scenario description
+   */
+  description?: string;
+
+  /**
+   * Prompt for final answer
+   */
+  finalAnswerPrompt?: string;
+
+  /**
+   * Interaction format
+   */
+  format?: string;
+
+  /**
+   * Scenario goal
+   */
+  goal?: string;
+
+  /**
+   * Character ID for greeting
+   */
+  greetingCharacterId?: string;
+
+  /**
+   * Greeting message
+   */
+  greetingMessage?: string;
+
+  /**
+   * Whether scenario requires a final answer
+   */
+  requiresFinalAnswer?: boolean;
+
+  /**
+   * Available tools
+   */
+  tools?: Array<unknown>;
 }
 
 export interface ScenarioUpdateParams {
-  body: string;
+  /**
+   * Associated component ID
+   */
+  componentId: string;
+
+  /**
+   * Scenario name
+   */
+  name: string;
+
+  /**
+   * Scenario characters
+   */
+  characters?: Array<unknown>;
+
+  /**
+   * Scenario context
+   */
+  context?: string;
+
+  /**
+   * Scenario description
+   */
+  description?: string;
+
+  /**
+   * Prompt for final answer
+   */
+  finalAnswerPrompt?: string;
+
+  /**
+   * Interaction format
+   */
+  format?: string;
+
+  /**
+   * Scenario goal
+   */
+  goal?: string;
+
+  /**
+   * Character ID for greeting
+   */
+  greetingCharacterId?: string;
+
+  /**
+   * Greeting message
+   */
+  greetingMessage?: string;
+
+  /**
+   * Whether scenario requires a final answer
+   */
+  requiresFinalAnswer?: boolean;
+
+  /**
+   * Available tools
+   */
+  tools?: Array<unknown>;
+}
+
+export interface ScenarioSubmitParams {
+  /**
+   * Conversation history
+   */
+  conversationHistory: Array<unknown>;
+
+  /**
+   * Final answer for the scenario
+   */
+  finalAnswer?: string;
 }
 
 Scenarios.Component = Component;
@@ -139,6 +276,7 @@ export declare namespace Scenarios {
   export {
     type ScenarioCreateParams as ScenarioCreateParams,
     type ScenarioUpdateParams as ScenarioUpdateParams,
+    type ScenarioSubmitParams as ScenarioSubmitParams,
   };
 
   export { Component as Component, type ComponentUpdateParams as ComponentUpdateParams };

package/src/resources/v1/v1.ts

@@ -59,7 +59,12 @@ import {
 import * as OrganizationsAPI from './organizations/organizations';
 import { Organizations } from './organizations/organizations';
 import * as ScenariosAPI from './scenarios/scenarios';
-import { ScenarioCreateParams, ScenarioUpdateParams, Scenarios } from './scenarios/scenarios';
+import {
+  ScenarioCreateParams,
+  ScenarioSubmitParams,
+  ScenarioUpdateParams,
+  Scenarios,
+} from './scenarios/scenarios';
 import * as TestsAPI from './tests/tests';
 import {
   TestCreateParams,
@@ -190,6 +195,7 @@ export declare namespace V1 {
     Scenarios as Scenarios,
     type ScenarioCreateParams as ScenarioCreateParams,
     type ScenarioUpdateParams as ScenarioUpdateParams,
+    type ScenarioSubmitParams as ScenarioSubmitParams,
   };
 
   export {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.10.0'; // x-release-please-version
+export const VERSION = '1.11.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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