@studyfetch/sdk 1.2.0 → 1.3.0

package/src/resources/v1/components.ts

@@ -12,7 +12,7 @@ export class Components extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.components.create({
+   * const component = await client.v1.components.create({
    *   config: {},
    *   name: 'My Study Component',
    *   origin: 'chat',
@@ -20,12 +20,8 @@ export class Components extends APIResource {
    * });
    * ```
    */
-  create(body: ComponentCreateParams, options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/api/v1/components', {
-      body,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  create(body: ComponentCreateParams, options?: RequestOptions): APIPromise<ComponentCreateResponse> {
+    return this._client.post('/api/v1/components', { body, ...options });
   }
 
   /**
@@ -33,14 +29,11 @@ export class Components extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.components.retrieve('id');
+   * const component = await client.v1.components.retrieve('id');
    * ```
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.get(path`/api/v1/components/${id}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  retrieve(id: string, options?: RequestOptions): APIPromise<ComponentRetrieveResponse> {
+    return this._client.get(path`/api/v1/components/${id}`, options);
   }
 
   /**
@@ -48,15 +41,15 @@ export class Components extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.components.update('id');
+   * const component = 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,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  update(
+    id: string,
+    body: ComponentUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<ComponentUpdateResponse> {
+    return this._client.patch(path`/api/v1/components/${id}`, { body, ...options });
   }
 
   /**
@@ -64,15 +57,14 @@ export class Components extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.components.list();
+   * const components = await client.v1.components.list();
    * ```
    */
-  list(query: ComponentListParams | null | undefined = {}, options?: RequestOptions): APIPromise<void> {
-    return this._client.get('/api/v1/components', {
-      query,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  list(
+    query: ComponentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ComponentListResponse> {
+    return this._client.get('/api/v1/components', { query, ...options });
   }
 
   /**
@@ -121,15 +113,15 @@ export class Components extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.components.embed('id');
+   * const response = 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,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  embed(
+    id: string,
+    body: ComponentEmbedParams,
+    options?: RequestOptions,
+  ): APIPromise<ComponentEmbedResponse> {
+    return this._client.post(path`/api/v1/components/${id}/embed`, { body, ...options });
   }
 
   /**
@@ -146,6 +138,287 @@ export class Components extends APIResource {
   }
 }
 
+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 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' | '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 namespace ComponentEmbedResponse {
+  /**
+   * Embed options
+   */
+  export interface Options {
+    /**
+     * Embed height
+     */
+    height?: string;
+
+    /**
+     * Embed width
+     */
+    width?: string;
+  }
+}
+
 export interface ComponentCreateParams {
   /**
    * Component-specific configuration
@@ -364,6 +637,11 @@ export namespace ComponentEmbedParams {
 
 export declare namespace Components {
   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,

package/src/resources/v1/index.ts

@@ -22,6 +22,11 @@ export {
 } from './chat/index';
 export {
   Components,
+  type ComponentCreateResponse,
+  type ComponentRetrieveResponse,
+  type ComponentUpdateResponse,
+  type ComponentListResponse,
+  type ComponentEmbedResponse,
   type ComponentCreateParams,
   type ComponentUpdateParams,
   type ComponentListParams,
@@ -43,6 +48,9 @@ export {
 export { Folders, type FolderCreateParams, type FolderUpdateParams, type FolderListParams } from './folders';
 export {
   Materials,
+  type MaterialCreateResponse,
+  type MaterialRetrieveResponse,
+  type MaterialListResponse,
   type MaterialCreateParams,
   type MaterialListParams,
   type MaterialGetDownloadURLParams,

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

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