@studyfetch/sdk 1.8.0 → 1.10.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: {},
+   *   config: { model: 'gpt-4o-mini' },
    *   name: 'My Study Component',
    *   origin: 'chat',
    *   type: 'chat',
@@ -177,7 +177,15 @@ export interface ComponentCreateResponse {
   /**
    * Component type
    */
-  type: 'chat' | 'flashcards' | 'tests' | 'scenarios' | 'explainers' | 'audio-recap';
+  type:
+    | 'chat'
+    | 'flashcards'
+    | 'scenarios'
+    | 'practice_test'
+    | 'audio_recap'
+    | 'tutor_me'
+    | 'explainers'
+    | 'uploads';
 
   /**
    * Last update timestamp
@@ -234,7 +242,15 @@ export interface ComponentRetrieveResponse {
   /**
    * Component type
    */
-  type: 'chat' | 'flashcards' | 'tests' | 'scenarios' | 'explainers' | 'audio-recap';
+  type:
+    | 'chat'
+    | 'flashcards'
+    | 'scenarios'
+    | 'practice_test'
+    | 'audio_recap'
+    | 'tutor_me'
+    | 'explainers'
+    | 'uploads';
 
   /**
    * Last update timestamp
@@ -291,7 +307,15 @@ export interface ComponentUpdateResponse {
   /**
    * Component type
    */
-  type: 'chat' | 'flashcards' | 'tests' | 'scenarios' | 'explainers' | 'audio-recap';
+  type:
+    | 'chat'
+    | 'flashcards'
+    | 'scenarios'
+    | 'practice_test'
+    | 'audio_recap'
+    | 'tutor_me'
+    | 'explainers'
+    | 'uploads';
 
   /**
    * Last update timestamp
@@ -351,7 +375,15 @@ export namespace ComponentListResponse {
     /**
      * Component type
      */
-    type: 'chat' | 'flashcards' | 'tests' | 'scenarios' | 'explainers' | 'audio-recap';
+    type:
+      | 'chat'
+      | 'flashcards'
+      | 'scenarios'
+      | 'practice_test'
+      | 'audio_recap'
+      | 'tutor_me'
+      | 'explainers'
+      | 'uploads';
 
     /**
      * Last update timestamp
@@ -423,7 +455,15 @@ export interface ComponentCreateParams {
   /**
    * Component-specific configuration
    */
-  config: unknown;
+  config:
+    | ComponentCreateParams.ChatConfigDto
+    | ComponentCreateParams.FlashcardsConfigDto
+    | ComponentCreateParams.ScenariosConfigDto
+    | ComponentCreateParams.PracticeTestConfigDto
+    | ComponentCreateParams.AudioRecapConfigDto
+    | ComponentCreateParams.ExplainersConfigDto
+    | ComponentCreateParams.UploadsConfigDto
+    | ComponentCreateParams.TutorMeConfigDto;
 
   /**
    * Name of the component
@@ -459,6 +499,432 @@ export interface ComponentCreateParams {
   metadata?: unknown;
 }
 
+export namespace ComponentCreateParams {
+  export interface ChatConfigDto {
+    /**
+     * 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>;
+
+    /**
+     * Material IDs
+     */
+    materials?: Array<string>;
+
+    /**
+     * Maximum steps for multi-step tool calls
+     */
+    maxSteps?: number;
+
+    /**
+     * Maximum tokens for response
+     */
+    maxTokens?: number;
+
+    /**
+     * System prompt for the chat
+     */
+    systemPrompt?: string;
+
+    /**
+     * Temperature for response generation
+     */
+    temperature?: number;
+  }
+
+  export interface FlashcardsConfigDto {
+    /**
+     * Types of flashcards
+     */
+    cardTypes?: Array<string>;
+
+    /**
+     * Difficulty level
+     */
+    difficulty?: 'easy' | 'medium' | 'hard' | 'mixed';
+
+    /**
+     * Enable spaced repetition
+     */
+    enableSpacedRepetition?: boolean;
+
+    /**
+     * Folder IDs
+     */
+    folders?: Array<string>;
+
+    /**
+     * Learning steps configuration
+     */
+    learningSteps?: string;
+
+    /**
+     * Material IDs
+     */
+    materials?: Array<string>;
+
+    /**
+     * Maximum review interval in days
+     */
+    maxReviewInterval?: number;
+
+    /**
+     * Total number of flashcards to generate
+     */
+    totalFlashcards?: number;
+
+    /**
+     * View mode for flashcards
+     */
+    viewMode?: 'spaced_repetition' | 'normal';
+  }
+
+  export interface ScenariosConfigDto {
+    /**
+     * Scenario characters
+     */
+    characters?: Array<ScenariosConfigDto.Character>;
+
+    /**
+     * Scenario context
+     */
+    context?: string;
+
+    /**
+     * Enable history
+     */
+    enableHistory?: boolean;
+
+    /**
+     * Enable voice
+     */
+    enableVoice?: boolean;
+
+    /**
+     * Final answer prompt
+     */
+    finalAnswerPrompt?: string;
+
+    /**
+     * Folder IDs
+     */
+    folders?: Array<string>;
+
+    /**
+     * Scenario format
+     */
+    format?: string;
+
+    /**
+     * Scenario goal
+     */
+    goal?: string;
+
+    /**
+     * Character ID for greeting
+     */
+    greetingCharacterId?: string;
+
+    /**
+     * Greeting message
+     */
+    greetingMessage?: string;
+
+    /**
+     * Material IDs
+     */
+    materials?: Array<string>;
+
+    /**
+     * Placeholder text
+     */
+    placeholderText?: string;
+
+    /**
+     * Requires final answer
+     */
+    requiresFinalAnswer?: boolean;
+
+    /**
+     * Available tools
+     */
+    tools?: Array<ScenariosConfigDto.Tool>;
+  }
+
+  export namespace ScenariosConfigDto {
+    export interface Character {
+      /**
+       * Character ID
+       */
+      id: string;
+
+      /**
+       * Character name
+       */
+      name: string;
+
+      /**
+       * Character role
+       */
+      role: string;
+
+      /**
+       * Character description
+       */
+      description?: string;
+    }
+
+    export interface Tool {
+      /**
+       * Tool ID
+       */
+      id: string;
+
+      /**
+       * Tool name
+       */
+      name: string;
+
+      /**
+       * Tool description
+       */
+      description?: string;
+    }
+  }
+
+  export interface PracticeTestConfigDto {
+    /**
+     * Question types
+     */
+    questionTypes: Array<string>;
+
+    /**
+     * AI generation mode
+     */
+    aiGenerationMode?: 'balanced' | 'comprehensive' | 'focused' | 'adaptive';
+
+    /**
+     * Allow retakes
+     */
+    allowRetakes?: boolean;
+
+    /**
+     * Difficulty level
+     */
+    difficulty?: 'easy' | 'medium' | 'hard' | 'mixed';
+
+    /**
+     * Folder IDs
+     */
+    folders?: Array<string>;
+
+    /**
+     * Material IDs
+     */
+    materials?: Array<string>;
+
+    /**
+     * Maximum attempts allowed
+     */
+    maxAttempts?: number;
+
+    /**
+     * Passing score percentage
+     */
+    passingScore?: number;
+
+    /**
+     * Distribution of question types
+     */
+    questionDistribution?: PracticeTestConfigDto.QuestionDistribution;
+
+    /**
+     * Number of questions per test
+     */
+    questionsPerTest?: number;
+
+    /**
+     * Randomize answer order
+     */
+    randomizeAnswers?: boolean;
+
+    /**
+     * Randomize question order
+     */
+    randomizeQuestions?: boolean;
+
+    /**
+     * Show correct answers after submission
+     */
+    showCorrectAnswers?: boolean;
+
+    /**
+     * Show explanations for answers
+     */
+    showExplanations?: boolean;
+
+    /**
+     * Time limit in minutes
+     */
+    timeLimit?: number;
+  }
+
+  export namespace PracticeTestConfigDto {
+    /**
+     * Distribution of question types
+     */
+    export interface QuestionDistribution {
+      /**
+       * Number of fill in the blank questions
+       */
+      fillinblank?: number;
+
+      /**
+       * Number of free response questions
+       */
+      frq?: number;
+
+      /**
+       * Number of multiple choice questions
+       */
+      multiplechoice?: number;
+
+      /**
+       * Number of short answer questions
+       */
+      shortanswer?: number;
+
+      /**
+       * Number of true/false questions
+       */
+      truefalse?: number;
+    }
+  }
+
+  export interface AudioRecapConfigDto {
+    /**
+     * Folder IDs
+     */
+    folders?: Array<string>;
+
+    /**
+     * Audio format
+     */
+    format?: 'podcast' | 'summary' | 'lecture';
+
+    /**
+     * Material IDs
+     */
+    materials?: Array<string>;
+
+    /**
+     * Playback speed
+     */
+    speed?: number;
+
+    /**
+     * Voice to use for audio
+     */
+    voice?: string;
+  }
+
+  export interface ExplainersConfigDto {
+    /**
+     * Folder IDs
+     */
+    folders?: Array<string>;
+
+    /**
+     * Material IDs
+     */
+    materials?: Array<string>;
+  }
+
+  export interface UploadsConfigDto {
+    /**
+     * Folder ID where uploads will be stored
+     */
+    folderId: string;
+
+    /**
+     * Folder IDs
+     */
+    folders?: Array<string>;
+
+    /**
+     * Material IDs
+     */
+    materials?: Array<string>;
+  }
+
+  export interface TutorMeConfigDto {
+    /**
+     * Enable video
+     */
+    enableVideo?: boolean;
+
+    /**
+     * Enable voice
+     */
+    enableVoice?: boolean;
+
+    /**
+     * Folder IDs
+     */
+    folders?: Array<string>;
+
+    /**
+     * Material IDs
+     */
+    materials?: Array<string>;
+
+    /**
+     * Session duration in minutes
+     */
+    sessionDuration?: number;
+
+    /**
+     * Tutor personality
+     */
+    tutorPersonality?: string;
+  }
+}
+
 export interface ComponentUpdateParams {
   /**
    * Component status
@@ -493,9 +959,9 @@ export interface ComponentEmbedParams {
   features?: ComponentEmbedParams.Features;
 
   /**
-   * Group ID for collaboration
+   * Group IDs for collaboration
    */
-  groupId?: string;
+  groupIds?: Array<string>;
 
   /**
    * Embed height (e.g., "400px", "100vh")

package/src/resources/v1/flashcards.ts

@@ -65,7 +65,7 @@ export class Flashcards extends APIResource {
    * @example
    * ```ts
    * await client.v1.flashcards.getDue('componentId', {
-   *   groupId: 'groupId',
+   *   groupIds: 'groupIds',
    * });
    * ```
    */
@@ -272,9 +272,9 @@ export namespace FlashcardBatchProcessParams {
 
 export interface FlashcardGetAllParams {
   /**
-   * Group ID
+   * Group IDs (comma-separated)
    */
-  groupId?: string;
+  groupIds?: string;
 
   /**
    * Max number of cards
@@ -293,7 +293,7 @@ export interface FlashcardGetAllParams {
 }
 
 export interface FlashcardGetDueParams {
-  groupId: string;
+  groupIds: string;
 
   /**
    * Max number of cards
@@ -308,9 +308,9 @@ export interface FlashcardGetDueParams {
 
 export interface FlashcardGetStatsParams {
   /**
-   * Group ID
+   * Group IDs (comma-separated)
    */
-  groupId?: string;
+  groupIds?: string;
 
   /**
    * User ID

package/src/version.ts

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

package/version.d.mts

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

package/version.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.d.ts

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

package/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '1.8.0'; // x-release-please-version
+exports.VERSION = '1.10.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '1.8.0'; // x-release-please-version
+export const VERSION = '1.10.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}