@studyfetch/sdk 1.34.0 → 1.35.0

package/src/resources/v1/folders.ts

@@ -12,15 +12,13 @@ export class Folders extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.folders.create({ name: 'name' });
+   * const folder = await client.v1.folders.create({
+   *   name: 'name',
+   * });
    * ```
    */
-  create(body: FolderCreateParams, options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/api/v1/folders', {
-      body,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  create(body: FolderCreateParams, options?: RequestOptions): APIPromise<FolderCreateResponse> {
+    return this._client.post('/api/v1/folders', { body, ...options });
   }
 
   /**
@@ -28,14 +26,11 @@ export class Folders extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.folders.retrieve('id');
+   * const folder = await client.v1.folders.retrieve('id');
    * ```
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.get(path`/api/v1/folders/${id}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  retrieve(id: string, options?: RequestOptions): APIPromise<FolderRetrieveResponse> {
+    return this._client.get(path`/api/v1/folders/${id}`, options);
   }
 
   /**
@@ -43,15 +38,11 @@ export class Folders extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.folders.update('id');
+   * const folder = await client.v1.folders.update('id');
    * ```
    */
-  update(id: string, body: FolderUpdateParams, options?: RequestOptions): APIPromise<void> {
-    return this._client.patch(path`/api/v1/folders/${id}`, {
-      body,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  update(id: string, body: FolderUpdateParams, options?: RequestOptions): APIPromise<FolderUpdateResponse> {
+    return this._client.patch(path`/api/v1/folders/${id}`, { body, ...options });
   }
 
   /**
@@ -59,15 +50,14 @@ export class Folders extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.folders.list();
+   * const folders = await client.v1.folders.list();
    * ```
    */
-  list(query: FolderListParams | null | undefined = {}, options?: RequestOptions): APIPromise<void> {
-    return this._client.get('/api/v1/folders', {
-      query,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  list(
+    query: FolderListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<FolderListResponse> {
+    return this._client.get('/api/v1/folders', { query, ...options });
   }
 
   /**
@@ -90,40 +80,628 @@ export class Folders extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.folders.getTree();
+   * const response = await client.v1.folders.getTree();
    * ```
    */
-  getTree(options?: RequestOptions): APIPromise<void> {
-    return this._client.get('/api/v1/folders/tree', {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  getTree(options?: RequestOptions): APIPromise<FolderGetTreeResponse> {
+    return this._client.get('/api/v1/folders/tree', options);
   }
 
   /**
+   * Get all materials in folder
+   *
    * @example
    * ```ts
-   * await client.v1.folders.listMaterials('id');
+   * const response = await client.v1.folders.listMaterials(
+   *   'id',
+   * );
    * ```
    */
-  listMaterials(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.get(path`/api/v1/folders/${id}/materials`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  listMaterials(id: string, options?: RequestOptions): APIPromise<FolderListMaterialsResponse> {
+    return this._client.get(path`/api/v1/folders/${id}/materials`, options);
   }
 
   /**
+   * Move folder to new parent
+   *
    * @example
    * ```ts
-   * await client.v1.folders.move('id');
+   * const response = await client.v1.folders.move('id', {
+   *   parentFolderId: 'parentFolderId',
+   * });
    * ```
    */
-  move(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.patch(path`/api/v1/folders/${id}/move`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  move(id: string, body: FolderMoveParams, options?: RequestOptions): APIPromise<FolderMoveResponse> {
+    return this._client.patch(path`/api/v1/folders/${id}/move`, { body, ...options });
+  }
+}
+
+export interface FolderCreateResponse {
+  /**
+   * Folder ID
+   */
+  _id: string;
+
+  /**
+   * Creation date
+   */
+  createdAt: string;
+
+  /**
+   * Folder name
+   */
+  name: string;
+
+  /**
+   * Organization ID
+   */
+  organizationId: string;
+
+  /**
+   * Folder status
+   */
+  status: 'active' | 'deleted';
+
+  /**
+   * Last update date
+   */
+  updatedAt: string;
+
+  /**
+   * Folder description
+   */
+  description?: string;
+
+  /**
+   * Folder metadata
+   */
+  metadata?: FolderCreateResponse.Metadata;
+
+  /**
+   * Parent folder ID
+   */
+  parentFolderId?: string | null;
+}
+
+export namespace FolderCreateResponse {
+  /**
+   * Folder metadata
+   */
+  export interface Metadata {
+    /**
+     * Folder color
+     */
+    color?: string;
+
+    /**
+     * Folder icon
+     */
+    icon?: string;
+
+    /**
+     * Last activity date
+     */
+    lastActivity?: string;
+
+    /**
+     * Number of materials in folder
+     */
+    materialCount?: number;
+
+    /**
+     * Total size of materials in folder
+     */
+    totalSize?: number;
+  }
+}
+
+export interface FolderRetrieveResponse {
+  /**
+   * Folder ID
+   */
+  _id: unknown;
+
+  /**
+   * Total number of materials
+   */
+  materialCount: number;
+
+  /**
+   * Materials in this folder
+   */
+  materials: Array<unknown>;
+
+  /**
+   * Folder name
+   */
+  name: string;
+
+  /**
+   * Organization ID
+   */
+  organizationId: string;
+
+  /**
+   * Folder status
+   */
+  status: 'active' | 'deleted';
+
+  /**
+   * Subfolders
+   */
+  subfolders: Array<unknown>;
+
+  /**
+   * Total size of all materials in bytes
+   */
+  totalSize: number;
+
+  /**
+   * Creation date
+   */
+  createdAt?: unknown;
+
+  /**
+   * Folder description
+   */
+  description?: string;
+
+  /**
+   * Folder metadata
+   */
+  metadata?: FolderRetrieveResponse.Metadata;
+
+  /**
+   * Parent folder ID
+   */
+  parentFolderId?: string | null;
+
+  /**
+   * Last update date
+   */
+  updatedAt?: unknown;
+}
+
+export namespace FolderRetrieveResponse {
+  /**
+   * Folder metadata
+   */
+  export interface Metadata {
+    /**
+     * Folder color
+     */
+    color?: string;
+
+    /**
+     * Folder icon
+     */
+    icon?: string;
+
+    /**
+     * Last activity date
+     */
+    lastActivity?: string;
+
+    /**
+     * Number of materials in folder
+     */
+    materialCount?: number;
+
+    /**
+     * Total size of materials in folder
+     */
+    totalSize?: number;
+  }
+}
+
+export interface FolderUpdateResponse {
+  /**
+   * Folder ID
+   */
+  _id: string;
+
+  /**
+   * Creation date
+   */
+  createdAt: string;
+
+  /**
+   * Folder name
+   */
+  name: string;
+
+  /**
+   * Organization ID
+   */
+  organizationId: string;
+
+  /**
+   * Folder status
+   */
+  status: 'active' | 'deleted';
+
+  /**
+   * Last update date
+   */
+  updatedAt: string;
+
+  /**
+   * Folder description
+   */
+  description?: string;
+
+  /**
+   * Folder metadata
+   */
+  metadata?: FolderUpdateResponse.Metadata;
+
+  /**
+   * Parent folder ID
+   */
+  parentFolderId?: string | null;
+}
+
+export namespace FolderUpdateResponse {
+  /**
+   * Folder metadata
+   */
+  export interface Metadata {
+    /**
+     * Folder color
+     */
+    color?: string;
+
+    /**
+     * Folder icon
+     */
+    icon?: string;
+
+    /**
+     * Last activity date
+     */
+    lastActivity?: string;
+
+    /**
+     * Number of materials in folder
+     */
+    materialCount?: number;
+
+    /**
+     * Total size of materials in folder
+     */
+    totalSize?: number;
+  }
+}
+
+export type FolderListResponse = Array<FolderListResponse.FolderListResponseItem>;
+
+export namespace FolderListResponse {
+  export interface FolderListResponseItem {
+    /**
+     * Folder ID
+     */
+    _id: string;
+
+    /**
+     * Creation date
+     */
+    createdAt: string;
+
+    /**
+     * Folder name
+     */
+    name: string;
+
+    /**
+     * Organization ID
+     */
+    organizationId: string;
+
+    /**
+     * Folder status
+     */
+    status: 'active' | 'deleted';
+
+    /**
+     * Last update date
+     */
+    updatedAt: string;
+
+    /**
+     * Folder description
+     */
+    description?: string;
+
+    /**
+     * Folder metadata
+     */
+    metadata?: FolderListResponseItem.Metadata;
+
+    /**
+     * Parent folder ID
+     */
+    parentFolderId?: string | null;
+  }
+
+  export namespace FolderListResponseItem {
+    /**
+     * Folder metadata
+     */
+    export interface Metadata {
+      /**
+       * Folder color
+       */
+      color?: string;
+
+      /**
+       * Folder icon
+       */
+      icon?: string;
+
+      /**
+       * Last activity date
+       */
+      lastActivity?: string;
+
+      /**
+       * Number of materials in folder
+       */
+      materialCount?: number;
+
+      /**
+       * Total size of materials in folder
+       */
+      totalSize?: number;
+    }
+  }
+}
+
+export type FolderGetTreeResponse = Array<FolderGetTreeResponse.FolderGetTreeResponseItem>;
+
+export namespace FolderGetTreeResponse {
+  export interface FolderGetTreeResponseItem {
+    /**
+     * Folder ID
+     */
+    _id: unknown;
+
+    /**
+     * Folder name
+     */
+    name: string;
+
+    /**
+     * Organization ID
+     */
+    organizationId: string;
+
+    /**
+     * Folder status
+     */
+    status: 'active' | 'deleted';
+
+    /**
+     * Nested subfolders
+     */
+    subfolders: Array<unknown>;
+
+    /**
+     * Creation date
+     */
+    createdAt?: unknown;
+
+    /**
+     * Folder description
+     */
+    description?: string;
+
+    /**
+     * Folder metadata
+     */
+    metadata?: FolderGetTreeResponseItem.Metadata;
+
+    /**
+     * Parent folder ID
+     */
+    parentFolderId?: string | null;
+
+    /**
+     * Last update date
+     */
+    updatedAt?: unknown;
+  }
+
+  export namespace FolderGetTreeResponseItem {
+    /**
+     * Folder metadata
+     */
+    export interface Metadata {
+      /**
+       * Folder color
+       */
+      color?: string;
+
+      /**
+       * Folder icon
+       */
+      icon?: string;
+
+      /**
+       * Last activity date
+       */
+      lastActivity?: string;
+
+      /**
+       * Number of materials in folder
+       */
+      materialCount?: number;
+
+      /**
+       * Total size of materials in folder
+       */
+      totalSize?: number;
+    }
+  }
+}
+
+export type FolderListMaterialsResponse = Array<FolderListMaterialsResponse.FolderListMaterialsResponseItem>;
+
+export namespace FolderListMaterialsResponse {
+  export interface FolderListMaterialsResponseItem {
+    /**
+     * Material ID
+     */
+    _id: string;
+
+    /**
+     * Material content
+     */
+    content: FolderListMaterialsResponseItem.Content;
+
+    /**
+     * Content type
+     */
+    contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
+
+    /**
+     * Creation timestamp
+     */
+    createdAt: string;
+
+    /**
+     * Folder ID
+     */
+    folderId: string | null;
+
+    /**
+     * Material name
+     */
+    name: string;
+
+    /**
+     * Organization ID
+     */
+    organizationId: string;
+
+    /**
+     * Material status
+     */
+    status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
+
+    /**
+     * Last update timestamp
+     */
+    updatedAt: string;
+
+    /**
+     * Material metadata
+     */
+    metadata?: unknown;
+
+    /**
+     * Usage information
+     */
+    usage?: unknown;
+  }
+
+  export namespace FolderListMaterialsResponseItem {
+    /**
+     * Material content
+     */
+    export interface Content {
+      filename?: string;
+
+      fileSize?: number;
+
+      mimeType?: string;
+
+      s3Key?: string;
+
+      s3Url?: string;
+
+      text?: string;
+
+      url?: string;
+    }
+  }
+}
+
+export interface FolderMoveResponse {
+  /**
+   * Folder ID
+   */
+  _id: string;
+
+  /**
+   * Creation date
+   */
+  createdAt: string;
+
+  /**
+   * Folder name
+   */
+  name: string;
+
+  /**
+   * Organization ID
+   */
+  organizationId: string;
+
+  /**
+   * Folder status
+   */
+  status: 'active' | 'deleted';
+
+  /**
+   * Last update date
+   */
+  updatedAt: string;
+
+  /**
+   * Folder description
+   */
+  description?: string;
+
+  /**
+   * Folder metadata
+   */
+  metadata?: FolderMoveResponse.Metadata;
+
+  /**
+   * Parent folder ID
+   */
+  parentFolderId?: string | null;
+}
+
+export namespace FolderMoveResponse {
+  /**
+   * Folder metadata
+   */
+  export interface Metadata {
+    /**
+     * Folder color
+     */
+    color?: string;
+
+    /**
+     * Folder icon
+     */
+    icon?: string;
+
+    /**
+     * Last activity date
+     */
+    lastActivity?: string;
+
+    /**
+     * Number of materials in folder
+     */
+    materialCount?: number;
+
+    /**
+     * Total size of materials in folder
+     */
+    totalSize?: number;
   }
 }
 
@@ -134,21 +712,36 @@ export interface FolderCreateParams {
   name: string;
 
   /**
-   * Parent folder ID (optional)
+   * Folder description
    */
-  parentId?: string;
+  description?: string;
+
+  /**
+   * Additional metadata
+   */
+  metadata?: unknown;
+
+  /**
+   * Parent folder ID
+   */
+  parentFolderId?: string;
 }
 
 export interface FolderUpdateParams {
   /**
-   * New folder name
+   * New folder description
    */
-  name?: string;
+  description?: string;
+
+  /**
+   * Updated metadata
+   */
+  metadata?: unknown;
 
   /**
-   * New parent folder ID
+   * New folder name
    */
-  parentId?: string;
+  name?: string;
 }
 
 export interface FolderListParams {
@@ -158,10 +751,25 @@ export interface FolderListParams {
   parentId?: unknown;
 }
 
+export interface FolderMoveParams {
+  /**
+   * New parent folder ID or null for root level
+   */
+  parentFolderId: string | null;
+}
+
 export declare namespace Folders {
   export {
+    type FolderCreateResponse as FolderCreateResponse,
+    type FolderRetrieveResponse as FolderRetrieveResponse,
+    type FolderUpdateResponse as FolderUpdateResponse,
+    type FolderListResponse as FolderListResponse,
+    type FolderGetTreeResponse as FolderGetTreeResponse,
+    type FolderListMaterialsResponse as FolderListMaterialsResponse,
+    type FolderMoveResponse as FolderMoveResponse,
     type FolderCreateParams as FolderCreateParams,
     type FolderUpdateParams as FolderUpdateParams,
     type FolderListParams as FolderListParams,
+    type FolderMoveParams as FolderMoveParams,
   };
 }