@studyfetch/sdk 1.1.1 → 1.3.0

package/resources/v1/components.d.ts

@@ -2,26 +2,480 @@ 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(body: ComponentCreateParams, options?: RequestOptions): APIPromise<void>;
-    retrieve(id: string, options?: RequestOptions): APIPromise<void>;
-    update(id: string, body: ComponentUpdateParams, options?: RequestOptions): APIPromise<void>;
-    list(query: ComponentListParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Create a new component
+     *
+     * @example
+     * ```ts
+     * const component = await client.v1.components.create({
+     *   config: {},
+     *   name: 'My Study Component',
+     *   origin: 'chat',
+     *   type: 'chat',
+     * });
+     * ```
+     */
+    create(body: ComponentCreateParams, options?: RequestOptions): APIPromise<ComponentCreateResponse>;
+    /**
+     * Get component by ID
+     *
+     * @example
+     * ```ts
+     * const component = await client.v1.components.retrieve('id');
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<ComponentRetrieveResponse>;
+    /**
+     * Update component
+     *
+     * @example
+     * ```ts
+     * const component = await client.v1.components.update('id');
+     * ```
+     */
+    update(id: string, body: ComponentUpdateParams, options?: RequestOptions): APIPromise<ComponentUpdateResponse>;
+    /**
+     * Get all components
+     *
+     * @example
+     * ```ts
+     * const components = await client.v1.components.list();
+     * ```
+     */
+    list(query?: ComponentListParams | null | undefined, options?: RequestOptions): APIPromise<ComponentListResponse>;
+    /**
+     * 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>;
-    embed(id: string, body: ComponentEmbedParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Generate embed code for component
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.components.embed('id');
+     * ```
+     */
+    embed(id: string, body: ComponentEmbedParams, options?: RequestOptions): APIPromise<ComponentEmbedResponse>;
+    /**
+     * @example
+     * ```ts
+     * await client.v1.components.interact('id');
+     * ```
+     */
     interact(id: string, options?: RequestOptions): APIPromise<void>;
 }
+export interface ComponentCreateResponse {
+    /**
+     * 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' | 'tests' | 'scenarios' | 'explainers' | 'audio-recap';
+    /**
+     * Last update timestamp
+     */
+    updatedAt: string;
+    /**
+     * Usage statistics
+     */
+    usage: unknown;
+    /**
+     * Component description
+     */
+    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' | 'tests' | 'scenarios' | 'explainers' | 'audio-recap';
+    /**
+     * 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' | 'tests' | 'scenarios' | 'explainers' | 'audio-recap';
+    /**
+     * Last update timestamp
+     */
+    updatedAt: string;
+    /**
+     * Usage statistics
+     */
+    usage: unknown;
+    /**
+     * Component description
+     */
+    description?: string;
+}
+export type ComponentListResponse = Array<ComponentListResponse.ComponentListResponseItem>;
+export declare namespace ComponentListResponse {
+    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' | 'tests' | 'scenarios' | 'explainers' | 'audio-recap';
+        /**
+         * Last update timestamp
+         */
+        updatedAt: string;
+        /**
+         * Usage statistics
+         */
+        usage: unknown;
+        /**
+         * Component description
+         */
+        description?: string;
+    }
+}
+export interface ComponentEmbedResponse {
+    /**
+     * JWT token for authentication
+     */
+    token: string;
+    /**
+     * Component ID
+     */
+    componentId: string;
+    /**
+     * Component type
+     */
+    componentType: string;
+    /**
+     * The embed URL for iframe integration
+     */
+    embedUrl: string;
+    /**
+     * Token expiration timestamp
+     */
+    expiresAt: string;
+    /**
+     * Embed options
+     */
+    options: ComponentEmbedResponse.Options;
+}
+export declare namespace ComponentEmbedResponse {
+    /**
+     * Embed options
+     */
+    interface Options {
+        /**
+         * Embed height
+         */
+        height?: string;
+        /**
+         * Embed width
+         */
+        width?: string;
+    }
+}
 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, };
+    export { type ComponentCreateResponse as ComponentCreateResponse, type ComponentRetrieveResponse as ComponentRetrieveResponse, type ComponentUpdateResponse as ComponentUpdateResponse, type ComponentListResponse as ComponentListResponse, type ComponentEmbedResponse as ComponentEmbedResponse, type ComponentCreateParams as ComponentCreateParams, type ComponentUpdateParams as ComponentUpdateParams, type ComponentListParams as ComponentListParams, type ComponentEmbedParams as ComponentEmbedParams, };
 }
 //# sourceMappingURL=components.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"components.d.ts","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.ts","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,uBAAuB,CAAC;IAIlG;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;IAIrF;;;;;;;OAOG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;IAIpC;;;;;;;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,CACH,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMjE;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,OAAO,CAAC;IAExC;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,OAAO,GAAG,WAAW,GAAG,YAAY,GAAG,aAAa,CAAC;IAEnF;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,OAAO,CAAC;IAExC;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,OAAO,GAAG,WAAW,GAAG,YAAY,GAAG,aAAa,CAAC;IAEnF;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,OAAO,CAAC;IAExC;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,OAAO,GAAG,WAAW,GAAG,YAAY,GAAG,aAAa,CAAC;IAEnF;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,CAAC,yBAAyB,CAAC,CAAC;AAE3F,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,yBAAyB;QACxC;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,MAAM,EAAE,OAAO,CAAC;QAEhB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,OAAO,CAAC;QAExC;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,OAAO,GAAG,WAAW,GAAG,YAAY,GAAG,aAAa,CAAC;QAEnF;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;QAEf;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC;CACzC;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;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,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,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.js

@@ -6,58 +6,110 @@ const resource_1 = require("../../core/resource.js");
 const headers_1 = require("../../internal/headers.js");
 const path_1 = require("../../internal/utils/path.js");
 class Components extends resource_1.APIResource {
+    /**
+     * Create a new component
+     *
+     * @example
+     * ```ts
+     * const component = await client.v1.components.create({
+     *   config: {},
+     *   name: 'My Study Component',
+     *   origin: 'chat',
+     *   type: 'chat',
+     * });
+     * ```
+     */
     create(body, options) {
-        return this._client.post('/api/v1/components', {
-            body,
-            ...options,
-            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
-        });
+        return this._client.post('/api/v1/components', { body, ...options });
     }
+    /**
+     * Get component by ID
+     *
+     * @example
+     * ```ts
+     * const component = await client.v1.components.retrieve('id');
+     * ```
+     */
     retrieve(id, options) {
-        return this._client.get((0, path_1.path) `/api/v1/components/${id}`, {
-            ...options,
-            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
-        });
+        return this._client.get((0, path_1.path) `/api/v1/components/${id}`, options);
     }
+    /**
+     * Update component
+     *
+     * @example
+     * ```ts
+     * const component = await client.v1.components.update('id');
+     * ```
+     */
     update(id, body, options) {
-        return this._client.patch((0, path_1.path) `/api/v1/components/${id}`, {
-            body,
-            ...options,
-            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
-        });
+        return this._client.patch((0, path_1.path) `/api/v1/components/${id}`, { body, ...options });
     }
-    list(query, options) {
-        return this._client.get('/api/v1/components', {
-            query,
-            ...options,
-            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
-        });
+    /**
+     * Get all components
+     *
+     * @example
+     * ```ts
+     * const components = await client.v1.components.list();
+     * ```
+     */
+    list(query = {}, options) {
+        return this._client.get('/api/v1/components', { query, ...options });
     }
+    /**
+     * Delete component
+     *
+     * @example
+     * ```ts
+     * await client.v1.components.delete('id');
+     * ```
+     */
     delete(id, options) {
         return this._client.delete((0, path_1.path) `/api/v1/components/${id}`, {
             ...options,
             headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
         });
     }
+    /**
+     * @example
+     * ```ts
+     * await client.v1.components.activate('id');
+     * ```
+     */
     activate(id, options) {
         return this._client.post((0, path_1.path) `/api/v1/components/${id}/activate`, {
             ...options,
             headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
         });
     }
+    /**
+     * @example
+     * ```ts
+     * await client.v1.components.deactivate('id');
+     * ```
+     */
     deactivate(id, options) {
         return this._client.post((0, path_1.path) `/api/v1/components/${id}/deactivate`, {
             ...options,
             headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
         });
     }
+    /**
+     * Generate embed code for component
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.components.embed('id');
+     * ```
+     */
     embed(id, body, options) {
-        return this._client.post((0, path_1.path) `/api/v1/components/${id}/embed`, {
-            body,
-            ...options,
-            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
-        });
+        return this._client.post((0, path_1.path) `/api/v1/components/${id}/embed`, { body, ...options });
     }
+    /**
+     * @example
+     * ```ts
+     * await client.v1.components.interact('id');
+     * ```
+     */
     interact(id, options) {
         return this._client.post((0, path_1.path) `/api/v1/components/${id}/interact`, {
             ...options,

package/resources/v1/components.js.map

@@ -1 +1 @@
-{"version":3,"file":"components.js","sourceRoot":"","sources":["../../src/resources/v1/components.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,UAAW,SAAQ,sBAAW;IACzC,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE;YAC7C,IAAI;YACJ,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,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,EAAE,EAAE;YACtD,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,MAAM,CAAC,EAAU,EAAE,IAA2B,EAAE,OAAwB;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,EAAE,EAAE;YACxD,IAAI;YACJ,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,IAAI,CAAC,KAA0B,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE;YAC5C,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;IAED,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,EAAE,EAAE;YACzD,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,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,WAAW,EAAE;YAChE,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,UAAU,CAAC,EAAU,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,aAAa,EAAE;YAClE,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,KAAK,CAAC,EAAU,EAAE,IAA0B,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,QAAQ,EAAE;YAC7D,IAAI;YACJ,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,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,WAAW,EAAE;YAChE,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;AAnED,gCAmEC"}
+{"version":3,"file":"components.js","sourceRoot":"","sources":["../../src/resources/v1/components.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CACJ,EAAU,EACV,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,EAAE,EAAE;YACzD,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,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,WAAW,EAAE;YAChE,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,UAAU,CAAC,EAAU,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,aAAa,EAAE;YAClE,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,KAAK,CACH,EAAU,EACV,IAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,WAAW,EAAE;YAChE,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;AAlID,gCAkIC"}