@studyfetch/sdk 1.1.1 → 1.2.0

package/src/resources/v1/components.ts

@@ -7,6 +7,19 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 export class Components extends APIResource {
+  /**
+   * Create a new component
+   *
+   * @example
+   * ```ts
+   * await client.v1.components.create({
+   *   config: {},
+   *   name: 'My Study Component',
+   *   origin: 'chat',
+   *   type: 'chat',
+   * });
+   * ```
+   */
   create(body: ComponentCreateParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/components', {
       body,
@@ -15,6 +28,14 @@ export class Components extends APIResource {
     });
   }
 
+  /**
+   * Get component by ID
+   *
+   * @example
+   * ```ts
+   * await client.v1.components.retrieve('id');
+   * ```
+   */
   retrieve(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.get(path`/api/v1/components/${id}`, {
       ...options,
@@ -22,6 +43,14 @@ export class Components extends APIResource {
     });
   }
 
+  /**
+   * Update component
+   *
+   * @example
+   * ```ts
+   * await client.v1.components.update('id');
+   * ```
+   */
   update(id: string, body: ComponentUpdateParams, options?: RequestOptions): APIPromise<void> {
     return this._client.patch(path`/api/v1/components/${id}`, {
       body,
@@ -30,7 +59,15 @@ export class Components extends APIResource {
     });
   }
 
-  list(query: ComponentListParams, options?: RequestOptions): APIPromise<void> {
+  /**
+   * Get all components
+   *
+   * @example
+   * ```ts
+   * await client.v1.components.list();
+   * ```
+   */
+  list(query: ComponentListParams | null | undefined = {}, options?: RequestOptions): APIPromise<void> {
     return this._client.get('/api/v1/components', {
       query,
       ...options,
@@ -38,6 +75,14 @@ export class Components extends APIResource {
     });
   }
 
+  /**
+   * Delete component
+   *
+   * @example
+   * ```ts
+   * await client.v1.components.delete('id');
+   * ```
+   */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/api/v1/components/${id}`, {
       ...options,
@@ -45,6 +90,12 @@ export class Components extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.components.activate('id');
+   * ```
+   */
   activate(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/components/${id}/activate`, {
       ...options,
@@ -52,6 +103,12 @@ export class Components extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.components.deactivate('id');
+   * ```
+   */
   deactivate(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/components/${id}/deactivate`, {
       ...options,
@@ -59,6 +116,14 @@ export class Components extends APIResource {
     });
   }
 
+  /**
+   * Generate embed code for component
+   *
+   * @example
+   * ```ts
+   * await client.v1.components.embed('id');
+   * ```
+   */
   embed(id: string, body: ComponentEmbedParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/components/${id}/embed`, {
       body,
@@ -67,6 +132,12 @@ export class Components extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.components.interact('id');
+   * ```
+   */
   interact(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/components/${id}/interact`, {
       ...options,
@@ -75,15 +146,221 @@ export class Components extends APIResource {
   }
 }
 
-export interface ComponentCreateParams {}
+export interface ComponentCreateParams {
+  /**
+   * Component-specific configuration
+   */
+  config: unknown;
 
-export interface ComponentUpdateParams {}
+  /**
+   * Name of the component
+   */
+  name: string;
+
+  /**
+   * Origin of the component
+   */
+  origin: 'chat' | 'classroom' | 'upload' | 'console' | 'api';
+
+  /**
+   * Type of component to create
+   */
+  type:
+    | 'chat'
+    | 'flashcards'
+    | 'scenarios'
+    | 'practice_test'
+    | 'audio_recap'
+    | 'tutor_me'
+    | 'explainers'
+    | 'uploads';
+
+  /**
+   * Component description
+   */
+  description?: string;
+
+  /**
+   * Additional metadata
+   */
+  metadata?: unknown;
+}
+
+export interface ComponentUpdateParams {
+  /**
+   * Component status
+   */
+  status?: 'draft' | 'active' | 'inactive' | 'processing' | 'error';
+}
 
 export interface ComponentListParams {
-  type: string;
+  /**
+   * Filter by component type
+   */
+  type?:
+    | 'chat'
+    | 'flashcards'
+    | 'scenarios'
+    | 'practice_test'
+    | 'audio_recap'
+    | 'tutor_me'
+    | 'explainers'
+    | 'uploads';
 }
 
-export interface ComponentEmbedParams {}
+export interface ComponentEmbedParams {
+  /**
+   * Token expiry time in hours
+   */
+  expiryHours?: number;
+
+  /**
+   * Feature toggles
+   */
+  features?: ComponentEmbedParams.Features;
+
+  /**
+   * Group ID for collaboration
+   */
+  groupId?: string;
+
+  /**
+   * Embed height (e.g., "400px", "100vh")
+   */
+  height?: string;
+
+  /**
+   * Session ID for continuity
+   */
+  sessionId?: string;
+
+  /**
+   * Theme customization
+   */
+  theme?: ComponentEmbedParams.Theme;
+
+  /**
+   * User ID for tracking
+   */
+  userId?: string;
+
+  /**
+   * Embed width (e.g., "100%", "600px")
+   */
+  width?: string;
+}
+
+export namespace ComponentEmbedParams {
+  /**
+   * Feature toggles
+   */
+  export interface Features {
+    /**
+     * Enable component creation
+     */
+    enableComponentCreation?: boolean;
+
+    /**
+     * Enable follow-up questions
+     */
+    enableFollowUps?: boolean;
+
+    /**
+     * Enable history
+     */
+    enableHistory?: boolean;
+
+    /**
+     * Enable image sources
+     */
+    enableImageSources?: boolean;
+
+    /**
+     * Enable outline
+     */
+    enableOutline?: boolean;
+
+    /**
+     * Enable transcript
+     */
+    enableTranscript?: boolean;
+
+    /**
+     * Enable voice input
+     */
+    enableVoice?: boolean;
+
+    /**
+     * Enable web search
+     */
+    enableWebSearch?: boolean;
+
+    /**
+     * Enable web search sources
+     */
+    enableWebSearchSources?: boolean;
+
+    /**
+     * Placeholder text
+     */
+    placeholderText?: string;
+  }
+
+  /**
+   * Theme customization
+   */
+  export interface Theme {
+    /**
+     * Background color (hex)
+     */
+    backgroundColor?: string;
+
+    /**
+     * Border radius
+     */
+    borderRadius?: string;
+
+    /**
+     * Font family
+     */
+    fontFamily?: string;
+
+    /**
+     * Font size
+     */
+    fontSize?: string;
+
+    /**
+     * Hide branding
+     */
+    hideBranding?: boolean;
+
+    /**
+     * Logo URL
+     */
+    logoUrl?: string;
+
+    /**
+     * Padding
+     */
+    padding?: string;
+
+    /**
+     * Primary color (hex)
+     */
+    primaryColor?: string;
+
+    /**
+     * Secondary color (hex)
+     */
+    secondaryColor?: string;
+
+    /**
+     * Text color (hex)
+     */
+    textColor?: string;
+  }
+}
 
 export declare namespace Components {
   export {

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

@@ -7,6 +7,16 @@ import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
 export class Component extends APIResource {
+  /**
+   * Get component data for embed
+   *
+   * @example
+   * ```ts
+   * await client.v1.embed.component.retrieve('componentId', {
+   *   token: 'token',
+   * });
+   * ```
+   */
   retrieve(componentID: string, query: ComponentRetrieveParams, options?: RequestOptions): APIPromise<void> {
     return this._client.get(path`/api/v1/embed/component/${componentID}`, {
       query,
@@ -15,10 +25,22 @@ export class Component extends APIResource {
     });
   }
 
+  /**
+   * Process embed interaction
+   *
+   * @example
+   * ```ts
+   * await client.v1.embed.component.interact('componentId', {
+   *   token: 'token',
+   *   body: 'body',
+   * });
+   * ```
+   */
   interact(componentID: string, params: ComponentInteractParams, options?: RequestOptions): APIPromise<void> {
-    const { token } = params;
+    const { token, body } = params;
     return this._client.post(path`/api/v1/embed/component/${componentID}/interact`, {
       query: { token },
+      body: body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -26,11 +48,22 @@ export class Component extends APIResource {
 }
 
 export interface ComponentRetrieveParams {
+  /**
+   * Embed token
+   */
   token: string;
 }
 
 export interface ComponentInteractParams {
+  /**
+   * Query param: Embed token
+   */
   token: string;
+
+  /**
+   * Body param:
+   */
+  body: string;
 }
 
 export declare namespace Component {

package/src/resources/v1/embed/embed.ts

@@ -6,34 +6,49 @@ import { Component, ComponentInteractParams, ComponentRetrieveParams } from './c
 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 Embed extends APIResource {
   component: ComponentAPI.Component = new ComponentAPI.Component(this._client);
 
-  retrieve(componentID: string, query: EmbedRetrieveParams, options?: RequestOptions): APIPromise<void> {
-    return this._client.get(path`/api/v1/embed/${componentID}`, {
+  /**
+   * Get theme CSS for embed
+   *
+   * @example
+   * ```ts
+   * await client.v1.embed.getTheme({ token: 'token' });
+   * ```
+   */
+  getTheme(query: EmbedGetThemeParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/api/v1/embed/theme', {
       query,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  getHealth(options?: RequestOptions): APIPromise<void> {
+  /**
+   * Health check endpoint
+   *
+   * @example
+   * ```ts
+   * await client.v1.embed.healthCheck();
+   * ```
+   */
+  healthCheck(options?: RequestOptions): APIPromise<void> {
     return this._client.get('/api/v1/embed/health', {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  getTheme(query: EmbedGetThemeParams, options?: RequestOptions): APIPromise<void> {
-    return this._client.get('/api/v1/embed/theme', {
-      query,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-
+  /**
+   * Verify embed token
+   *
+   * @example
+   * ```ts
+   * await client.v1.embed.verify({ token: 'token' });
+   * ```
+   */
   verify(query: EmbedVerifyParams, options?: RequestOptions): APIPromise<void> {
     return this._client.get('/api/v1/embed/verify', {
       query,
@@ -43,26 +58,24 @@ export class Embed extends APIResource {
   }
 }
 
-export interface EmbedRetrieveParams {
-  token: string;
-}
-
 export interface EmbedGetThemeParams {
+  /**
+   * Embed token
+   */
   token: string;
 }
 
 export interface EmbedVerifyParams {
+  /**
+   * Embed token to verify
+   */
   token: string;
 }
 
 Embed.Component = Component;
 
 export declare namespace Embed {
-  export {
-    type EmbedRetrieveParams as EmbedRetrieveParams,
-    type EmbedGetThemeParams as EmbedGetThemeParams,
-    type EmbedVerifyParams as EmbedVerifyParams,
-  };
+  export { type EmbedGetThemeParams as EmbedGetThemeParams, type EmbedVerifyParams as EmbedVerifyParams };
 
   export {
     Component as Component,

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

@@ -1,4 +1,4 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export { Component, type ComponentRetrieveParams, type ComponentInteractParams } from './component';
-export { Embed, type EmbedRetrieveParams, type EmbedGetThemeParams, type EmbedVerifyParams } from './embed';
+export { Embed, type EmbedGetThemeParams, type EmbedVerifyParams } from './embed';

package/src/resources/v1/explainers.ts

@@ -6,6 +6,14 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 
 export class Explainers extends APIResource {
+  /**
+   * Create explainers component
+   *
+   * @example
+   * ```ts
+   * await client.v1.explainers.create();
+   * ```
+   */
   create(body: ExplainerCreateParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/explainers/create', {
       body,
@@ -14,8 +22,18 @@ export class Explainers extends APIResource {
     });
   }
 
-  webhook(options?: RequestOptions): APIPromise<void> {
+  /**
+   * Handle webhook events
+   *
+   * @example
+   * ```ts
+   * await client.v1.explainers.handleWebhook({ body: 'body' });
+   * ```
+   */
+  handleWebhook(params: ExplainerHandleWebhookParams, options?: RequestOptions): APIPromise<void> {
+    const { body } = params;
     return this._client.post('/api/v1/explainers/webhook', {
+      body: body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -24,6 +42,13 @@ export class Explainers extends APIResource {
 
 export interface ExplainerCreateParams {}
 
+export interface ExplainerHandleWebhookParams {
+  body: string;
+}
+
 export declare namespace Explainers {
-  export { type ExplainerCreateParams as ExplainerCreateParams };
+  export {
+    type ExplainerCreateParams as ExplainerCreateParams,
+    type ExplainerHandleWebhookParams as ExplainerHandleWebhookParams,
+  };
 }