@studyfetch/sdk 1.11.0 → 1.12.0

package/src/resources/v1/components.ts

@@ -20,7 +20,7 @@ export class Components extends APIResource {
    * });
    * ```
    */
-  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,7 +136,7 @@ export class Components extends APIResource {
   }
 }
 
-export interface ComponentCreateResponse {
+export interface Component {
   /**
    * Component ID (MongoDB ObjectId)
    */
@@ -203,206 +201,9 @@ export interface ComponentCreateResponse {
   description?: string;
 }
 
-export interface ComponentRetrieveResponse {
-  /**
-   * 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 ComponentUpdateResponse {
-  /**
-   * 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 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 type ComponentListResponse = Array<Component>;
 
-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
    */
@@ -1037,7 +838,7 @@ export interface ComponentListParams {
     | 'uploads';
 }
 
-export interface ComponentEmbedParams {
+export interface ComponentGenerateEmbedParams {
   /**
    * Token expiry time in hours
    */
@@ -1046,7 +847,7 @@ export interface ComponentEmbedParams {
   /**
    * Feature toggles
    */
-  features?: ComponentEmbedParams.Features;
+  features?: ComponentGenerateEmbedParams.Features;
 
   /**
    * Group IDs for collaboration
@@ -1066,7 +867,7 @@ export interface ComponentEmbedParams {
   /**
    * Theme customization
    */
-  theme?: ComponentEmbedParams.Theme;
+  theme?: ComponentGenerateEmbedParams.Theme;
 
   /**
    * User ID for tracking
@@ -1079,7 +880,7 @@ export interface ComponentEmbedParams {
   width?: string;
 }
 
-export namespace ComponentEmbedParams {
+export namespace ComponentGenerateEmbedParams {
   /**
    * Feature toggles
    */
@@ -1193,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 {
   /**
@@ -28,6 +29,21 @@ export class Explainers extends APIResource {
     });
   }
 
+  /**
+   * Get explainer video by component ID
+   *
+   * @example
+   * ```ts
+   * await client.v1.explainers.retrieve('componentId');
+   * ```
+   */
+  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
    *

package/src/resources/v1/flashcards.ts

@@ -31,11 +31,10 @@ export class Flashcards extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
-   *   await client.v1.flashcards.getAlgorithmInfo();
+   * const response = await client.v1.flashcards.getAlgorithm();
    * ```
    */
-  getAlgorithmInfo(options?: RequestOptions): APIPromise<FlashcardGetAlgorithmInfoResponse> {
+  getAlgorithm(options?: RequestOptions): APIPromise<FlashcardGetAlgorithmResponse> {
     return this._client.get('/api/v1/flashcards/algorithm', options);
   }
 
@@ -177,20 +176,20 @@ export namespace FlashcardBatchProcessResponse {
   }
 }
 
-export interface FlashcardGetAlgorithmInfoResponse {
+export interface FlashcardGetAlgorithmResponse {
   /**
    * Algorithm name
    */
   algorithm?: string;
 
-  intervals?: FlashcardGetAlgorithmInfoResponse.Intervals;
+  intervals?: FlashcardGetAlgorithmResponse.Intervals;
 
   phases?: { [key: string]: string };
 
-  ratings?: { [key: string]: FlashcardGetAlgorithmInfoResponse.Ratings };
+  ratings?: { [key: string]: FlashcardGetAlgorithmResponse.Ratings };
 }
 
-export namespace FlashcardGetAlgorithmInfoResponse {
+export namespace FlashcardGetAlgorithmResponse {
   export interface Intervals {
     /**
      * Description of graduated intervals
@@ -343,7 +342,7 @@ export interface FlashcardRateParams {
 export declare namespace Flashcards {
   export {
     type FlashcardBatchProcessResponse as FlashcardBatchProcessResponse,
-    type FlashcardGetAlgorithmInfoResponse as FlashcardGetAlgorithmInfoResponse,
+    type FlashcardGetAlgorithmResponse as FlashcardGetAlgorithmResponse,
     type FlashcardGetTypesResponse as FlashcardGetTypesResponse,
     type FlashcardBatchProcessParams as FlashcardBatchProcessParams,
     type FlashcardGetAllParams as FlashcardGetAllParams,

package/src/resources/v1/index.ts

@@ -1,6 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Admin } from './admin/index';
 export {
   AudioRecaps,
   type AudioRecapCreateParams,
@@ -9,28 +8,26 @@ export {
 export { Auth } from './auth/index';
 export {
   Chat,
-  type ChatRetrieveSessionParams,
+  type ChatGetSessionParams,
   type ChatSendMessageParams,
   type ChatStreamParams,
 } from './chat/index';
 export {
   Components,
-  type ComponentCreateResponse,
-  type ComponentRetrieveResponse,
-  type ComponentUpdateResponse,
+  type Component,
   type ComponentListResponse,
-  type ComponentEmbedResponse,
+  type ComponentGenerateEmbedResponse,
   type ComponentCreateParams,
   type ComponentUpdateParams,
   type ComponentListParams,
-  type ComponentEmbedParams,
+  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 FlashcardGetAlgorithmInfoResponse,
+  type FlashcardGetAlgorithmResponse,
   type FlashcardGetTypesResponse,
   type FlashcardBatchProcessParams,
   type FlashcardGetAllParams,
@@ -41,19 +38,18 @@ export {
 export { Folders, type FolderCreateParams, type FolderUpdateParams, type FolderListParams } from './folders';
 export {
   Materials,
-  type MaterialCreateResponse,
-  type MaterialRetrieveResponse,
+  type Material,
   type MaterialListResponse,
   type MaterialCreateParams,
   type MaterialListParams,
   type MaterialGetDownloadURLParams,
 } from './materials/index';
-export { Organizations } from './organizations/index';
 export {
   Scenarios,
+  type Scenario,
   type ScenarioCreateParams,
   type ScenarioUpdateParams,
-  type ScenarioSubmitParams,
+  type ScenarioSubmitAnswerParams,
 } from './scenarios/index';
 export {
   Tests,

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

@@ -3,18 +3,11 @@
 export { Bulk } from './bulk';
 export {
   Materials,
-  type MaterialCreateResponse,
-  type MaterialRetrieveResponse,
+  type Material,
   type MaterialListResponse,
   type MaterialCreateParams,
   type MaterialListParams,
   type MaterialGetDownloadURLParams,
 } from './materials';
 export { Test } from './test';
-export {
-  Upload,
-  type UploadUploadFileResponse,
-  type UploadUploadFromURLResponse,
-  type UploadUploadFileParams,
-  type UploadUploadFromURLParams,
-} from './upload';
+export { Upload, type UploadUploadFileParams, type UploadUploadFromURLParams } from './upload';