@studyfetch/sdk 1.1.1 → 1.2.0

package/resources/v1/chat/sessions.js.map

@@ -1 +1 @@
-{"version":3,"file":"sessions.js","sourceRoot":"","sources":["../../../src/resources/v1/chat/sessions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,0DAAyD;AAEzD,0DAAoD;AAEpD,MAAa,QAAS,SAAQ,sBAAW;IACvC,MAAM,CAAC,OAAwB;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,8BAA8B,EAAE;YACvD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED,QAAQ,CAAC,MAAc,EAAE,KAA4B,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,MAAM,EAAE,EAAE;YAC7D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAfD,4BAeC"}
+{"version":3,"file":"sessions.js","sourceRoot":"","sources":["../../../src/resources/v1/chat/sessions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,0DAAyD;AAEzD,0DAAoD;AAEpD,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;OAKG;IACH,MAAM,CAAC,OAAwB;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,8BAA8B,EAAE;YACvD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,MAAc,EAAE,KAA4B,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,MAAM,EAAE,EAAE;YAC7D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA7BD,4BA6BC"}

package/resources/v1/chat/sessions.mjs

@@ -3,12 +3,26 @@ import { APIResource } from "../../../core/resource.mjs";
 import { buildHeaders } from "../../../internal/headers.mjs";
 import { path } from "../../../internal/utils/path.mjs";
 export class Sessions extends APIResource {
+    /**
+     * @example
+     * ```ts
+     * await client.v1.chat.sessions.create();
+     * ```
+     */
     create(options) {
         return this._client.post('/api/v1/chat/sessions/create', {
             ...options,
             headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
         });
     }
+    /**
+     * @example
+     * ```ts
+     * await client.v1.chat.sessions.retrieve('userId', {
+     *   limit: 'limit',
+     * });
+     * ```
+     */
     retrieve(userID, query, options) {
         return this._client.get(path `/api/v1/chat/sessions/${userID}`, {
             query,

package/resources/v1/chat/sessions.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"sessions.mjs","sourceRoot":"","sources":["../../../src/resources/v1/chat/sessions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC,MAAM,CAAC,OAAwB;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,8BAA8B,EAAE;YACvD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED,QAAQ,CAAC,MAAc,EAAE,KAA4B,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,MAAM,EAAE,EAAE;YAC7D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"sessions.mjs","sourceRoot":"","sources":["../../../src/resources/v1/chat/sessions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;OAKG;IACH,MAAM,CAAC,OAAwB;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,8BAA8B,EAAE;YACvD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,MAAc,EAAE,KAA4B,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,MAAM,EAAE,EAAE;YAC7D,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/v1/chat/test.d.mts

@@ -2,7 +2,19 @@ import { APIResource } from "../../../core/resource.mjs";
 import { APIPromise } from "../../../core/api-promise.mjs";
 import { RequestOptions } from "../../../internal/request-options.mjs";
 export declare class Test extends APIResource {
+    /**
+     * @example
+     * ```ts
+     * await client.v1.chat.test.citeImage();
+     * ```
+     */
     citeImage(options?: RequestOptions): APIPromise<void>;
+    /**
+     * @example
+     * ```ts
+     * await client.v1.chat.test.uploadImage();
+     * ```
+     */
     uploadImage(options?: RequestOptions): APIPromise<void>;
 }
 //# sourceMappingURL=test.d.mts.map

package/resources/v1/chat/test.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"test.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/chat/test.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC,SAAS,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOrD,WAAW,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMxD"}
+{"version":3,"file":"test.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/chat/test.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;OAKG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOrD;;;;;OAKG;IACH,WAAW,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMxD"}

package/resources/v1/chat/test.d.ts

@@ -2,7 +2,19 @@ import { APIResource } from "../../../core/resource.js";
 import { APIPromise } from "../../../core/api-promise.js";
 import { RequestOptions } from "../../../internal/request-options.js";
 export declare class Test extends APIResource {
+    /**
+     * @example
+     * ```ts
+     * await client.v1.chat.test.citeImage();
+     * ```
+     */
     citeImage(options?: RequestOptions): APIPromise<void>;
+    /**
+     * @example
+     * ```ts
+     * await client.v1.chat.test.uploadImage();
+     * ```
+     */
     uploadImage(options?: RequestOptions): APIPromise<void>;
 }
 //# sourceMappingURL=test.d.ts.map

package/resources/v1/chat/test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/chat/test.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC,SAAS,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOrD,WAAW,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMxD"}
+{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/chat/test.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;OAKG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOrD;;;;;OAKG;IACH,WAAW,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMxD"}

package/resources/v1/chat/test.js

@@ -5,12 +5,24 @@ exports.Test = void 0;
 const resource_1 = require("../../../core/resource.js");
 const headers_1 = require("../../../internal/headers.js");
 class Test extends resource_1.APIResource {
+    /**
+     * @example
+     * ```ts
+     * await client.v1.chat.test.citeImage();
+     * ```
+     */
     citeImage(options) {
         return this._client.post('/api/v1/chat/test/image-citation', {
             ...options,
             headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
         });
     }
+    /**
+     * @example
+     * ```ts
+     * await client.v1.chat.test.uploadImage();
+     * ```
+     */
     uploadImage(options) {
         return this._client.post('/api/v1/chat/test/image', {
             ...options,

package/resources/v1/chat/test.js.map

@@ -1 +1 @@
-{"version":3,"file":"test.js","sourceRoot":"","sources":["../../../src/resources/v1/chat/test.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,0DAAyD;AAGzD,MAAa,IAAK,SAAQ,sBAAW;IACnC,SAAS,CAAC,OAAwB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE;YAC3D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED,WAAW,CAAC,OAAwB;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE;YAClD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAdD,oBAcC"}
+{"version":3,"file":"test.js","sourceRoot":"","sources":["../../../src/resources/v1/chat/test.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,0DAAyD;AAGzD,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;OAKG;IACH,SAAS,CAAC,OAAwB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE;YAC3D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,OAAwB;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE;YAClD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA1BD,oBA0BC"}

package/resources/v1/chat/test.mjs

@@ -2,12 +2,24 @@
 import { APIResource } from "../../../core/resource.mjs";
 import { buildHeaders } from "../../../internal/headers.mjs";
 export class Test extends APIResource {
+    /**
+     * @example
+     * ```ts
+     * await client.v1.chat.test.citeImage();
+     * ```
+     */
     citeImage(options) {
         return this._client.post('/api/v1/chat/test/image-citation', {
             ...options,
             headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
         });
     }
+    /**
+     * @example
+     * ```ts
+     * await client.v1.chat.test.uploadImage();
+     * ```
+     */
     uploadImage(options) {
         return this._client.post('/api/v1/chat/test/image', {
             ...options,

package/resources/v1/chat/test.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"test.mjs","sourceRoot":"","sources":["../../../src/resources/v1/chat/test.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;AAGvB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC,SAAS,CAAC,OAAwB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE;YAC3D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED,WAAW,CAAC,OAAwB;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE;YAClD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"test.mjs","sourceRoot":"","sources":["../../../src/resources/v1/chat/test.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;AAGvB,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;OAKG;IACH,SAAS,CAAC,OAAwB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kCAAkC,EAAE;YAC3D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,OAAwB;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE;YAClD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/v1/components.d.mts

@@ -2,24 +2,250 @@ import { APIResource } from "../../core/resource.mjs";
 import { APIPromise } from "../../core/api-promise.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
 export declare 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>;
+    /**
+     * Get component by ID
+     *
+     * @example
+     * ```ts
+     * await client.v1.components.retrieve('id');
+     * ```
+     */
     retrieve(id: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Update component
+     *
+     * @example
+     * ```ts
+     * await client.v1.components.update('id');
+     * ```
+     */
     update(id: string, body: ComponentUpdateParams, options?: RequestOptions): APIPromise<void>;
-    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>;
+    /**
+     * Delete component
+     *
+     * @example
+     * ```ts
+     * await client.v1.components.delete('id');
+     * ```
+     */
     delete(id: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * @example
+     * ```ts
+     * await client.v1.components.activate('id');
+     * ```
+     */
     activate(id: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * @example
+     * ```ts
+     * await client.v1.components.deactivate('id');
+     * ```
+     */
     deactivate(id: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Generate embed code for component
+     *
+     * @example
+     * ```ts
+     * await client.v1.components.embed('id');
+     * ```
+     */
     embed(id: string, body: ComponentEmbedParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * @example
+     * ```ts
+     * await client.v1.components.interact('id');
+     * ```
+     */
     interact(id: string, options?: RequestOptions): APIPromise<void>;
 }
 export interface ComponentCreateParams {
+    /**
+     * Component-specific configuration
+     */
+    config: unknown;
+    /**
+     * 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 {
+    /**
+     * 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 declare namespace ComponentEmbedParams {
+    /**
+     * Feature toggles
+     */
+    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
+     */
+    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 { type ComponentCreateParams as ComponentCreateParams, type ComponentUpdateParams as ComponentUpdateParams, type ComponentListParams as ComponentListParams, type ComponentEmbedParams as ComponentEmbedParams, };

package/resources/v1/components.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"components.d.mts","sourceRoot":"","sources":["../../src/resources/v1/components.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,UAAW,SAAQ,WAAW;IACzC,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ/E,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOhE,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ3F,IAAI,CAAC,KAAK,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ5E,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOhE,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOlE,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQzF,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMjE;AAED,MAAM,WAAW,qBAAqB;CAAG;AAEzC,MAAM,WAAW,qBAAqB;CAAG;AAEzC,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAoB;CAAG;AAExC,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"components.d.mts","sourceRoot":"","sources":["../../src/resources/v1/components.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ/E;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOhE;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ3F;;;;;;;OAOG;IACH,IAAI,CAAC,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQpG;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOhE;;;;;OAKG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOlE;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQzF;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMjE;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,KAAK,CAAC;IAE5D;;OAEG;IACH,IAAI,EACA,MAAM,GACN,YAAY,GACZ,WAAW,GACX,eAAe,GACf,aAAa,GACb,UAAU,GACV,YAAY,GACZ,SAAS,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,GAAG,YAAY,GAAG,OAAO,CAAC;CACnE;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,CAAC,EACD,MAAM,GACN,YAAY,GACZ,WAAW,GACX,eAAe,GACf,aAAa,GACb,UAAU,GACV,YAAY,GACZ,SAAS,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,oBAAoB,CAAC,QAAQ,CAAC;IAEzC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,oBAAoB,CAAC,KAAK,CAAC;IAEnC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;QAElC;;WAEG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAE7B;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAE3B;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QAEtB;;WAEG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;QAEjC;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/v1/components.d.ts

@@ -2,24 +2,250 @@ import { APIResource } from "../../core/resource.js";
 import { APIPromise } from "../../core/api-promise.js";
 import { RequestOptions } from "../../internal/request-options.js";
 export declare 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>;
+    /**
+     * Get component by ID
+     *
+     * @example
+     * ```ts
+     * await client.v1.components.retrieve('id');
+     * ```
+     */
     retrieve(id: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Update component
+     *
+     * @example
+     * ```ts
+     * await client.v1.components.update('id');
+     * ```
+     */
     update(id: string, body: ComponentUpdateParams, options?: RequestOptions): APIPromise<void>;
-    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>;
+    /**
+     * Delete component
+     *
+     * @example
+     * ```ts
+     * await client.v1.components.delete('id');
+     * ```
+     */
     delete(id: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * @example
+     * ```ts
+     * await client.v1.components.activate('id');
+     * ```
+     */
     activate(id: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * @example
+     * ```ts
+     * await client.v1.components.deactivate('id');
+     * ```
+     */
     deactivate(id: string, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Generate embed code for component
+     *
+     * @example
+     * ```ts
+     * await client.v1.components.embed('id');
+     * ```
+     */
     embed(id: string, body: ComponentEmbedParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * @example
+     * ```ts
+     * await client.v1.components.interact('id');
+     * ```
+     */
     interact(id: string, options?: RequestOptions): APIPromise<void>;
 }
 export interface ComponentCreateParams {
+    /**
+     * Component-specific configuration
+     */
+    config: unknown;
+    /**
+     * 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 {
+    /**
+     * 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 declare namespace ComponentEmbedParams {
+    /**
+     * Feature toggles
+     */
+    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
+     */
+    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 { type ComponentCreateParams as ComponentCreateParams, type ComponentUpdateParams as ComponentUpdateParams, type ComponentListParams as ComponentListParams, type ComponentEmbedParams as ComponentEmbedParams, };