@studyfetch/sdk 1.36.0 → 1.38.0

package/resources/v1/materials/materials.d.ts

@@ -1,37 +1,36 @@
 import { APIResource } from "../../../core/resource.js";
 import * as BulkAPI from "./bulk.js";
 import { Bulk, BulkMoveParams, BulkMoveResponse } from "./bulk.js";
-import * as TestAPI from "./test.js";
-import { Test, TestTestEpubProcessingResponse, TestTestImageProcessingResponse, TestTestOcrResponse, TestTestVideoProcessingResponse } from "./test.js";
 import * as UploadAPI from "./upload.js";
-import { Upload, UploadCompleteUploadParams, UploadCompleteUploadResponse, UploadGetPresignedURLParams, UploadGetPresignedURLResponse, UploadUploadFileAndProcessParams, UploadUploadFileAndProcessResponse, UploadUploadFileParams, UploadUploadFileResponse, UploadUploadFromURLAndProcessParams, UploadUploadFromURLAndProcessResponse, UploadUploadFromURLParams, UploadUploadFromURLResponse } from "./upload.js";
+import { Upload, UploadCompleteUploadParams, UploadGetPresignedURLParams, UploadGetPresignedURLResponse, UploadUploadFileAndProcessParams, UploadUploadFileParams, UploadUploadFromURLAndProcessParams, UploadUploadFromURLParams } from "./upload.js";
 import { APIPromise } from "../../../core/api-promise.js";
 import { RequestOptions } from "../../../internal/request-options.js";
 export declare class Materials extends APIResource {
     upload: UploadAPI.Upload;
     bulk: BulkAPI.Bulk;
-    test: TestAPI.Test;
     /**
      * Create a new material
      *
      * @example
      * ```ts
-     * const material = await client.v1.materials.create({
+     * const materialResponse = await client.v1.materials.create({
      *   content: { type: 'text' },
      *   name: 'Chapter 1 - Introduction',
      * });
      * ```
      */
-    create(body: MaterialCreateParams, options?: RequestOptions): APIPromise<MaterialCreateResponse>;
+    create(body: MaterialCreateParams, options?: RequestOptions): APIPromise<MaterialResponse>;
     /**
      * Get material by ID
      *
      * @example
      * ```ts
-     * const material = await client.v1.materials.retrieve('id');
+     * const materialResponse = await client.v1.materials.retrieve(
+     *   'id',
+     * );
      * ```
      */
-    retrieve(id: string, options?: RequestOptions): APIPromise<MaterialRetrieveResponse>;
+    retrieve(id: string, options?: RequestOptions): APIPromise<MaterialResponse>;
     /**
      * Get all materials for organization
      *
@@ -56,15 +55,14 @@ export declare class Materials extends APIResource {
      *
      * @example
      * ```ts
-     * const response = await client.v1.materials.createAndProcess(
-     *   {
+     * const materialResponse =
+     *   await client.v1.materials.createAndProcess({
      *     content: { type: 'text' },
      *     name: 'Chapter 1 - Introduction',
-     *   },
-     * );
+     *   });
      * ```
      */
-    createAndProcess(body: MaterialCreateAndProcessParams, options?: RequestOptions): APIPromise<MaterialCreateAndProcessResponse>;
+    createAndProcess(body: MaterialCreateAndProcessParams, options?: RequestOptions): APIPromise<MaterialResponse>;
     /**
      * Create batch upload URLs for multiple materials
      *
@@ -89,21 +87,22 @@ export declare class Materials extends APIResource {
      *
      * @example
      * ```ts
-     * const response = await client.v1.materials.generate({
-     *   name: 'Photosynthesis Study Plan',
-     *   topic: 'Photosynthesis in plants',
-     *   type: 'notes',
-     * });
+     * const generatedMaterialResponse =
+     *   await client.v1.materials.generate({
+     *     name: 'Photosynthesis Study Plan',
+     *     topic: 'Photosynthesis in plants',
+     *     type: 'notes',
+     *   });
      * ```
      */
-    generate(body: MaterialGenerateParams, options?: RequestOptions): APIPromise<MaterialGenerateResponse>;
+    generate(body: MaterialGenerateParams, options?: RequestOptions): APIPromise<GeneratedMaterialResponse>;
     /**
      * Uses AI to generate study materials like outlines, notes, summaries, etc. from a
      * given topic and waits for processing to complete
      *
      * @example
      * ```ts
-     * const response =
+     * const generatedMaterialResponse =
      *   await client.v1.materials.generateAndProcess({
      *     name: 'Photosynthesis Study Plan',
      *     topic: 'Photosynthesis in plants',
@@ -111,7 +110,7 @@ export declare class Materials extends APIResource {
      *   });
      * ```
      */
-    generateAndProcess(body: MaterialGenerateAndProcessParams, options?: RequestOptions): APIPromise<MaterialGenerateAndProcessResponse>;
+    generateAndProcess(body: MaterialGenerateAndProcessParams, options?: RequestOptions): APIPromise<GeneratedMaterialResponse>;
     /**
      * Get debug information for a material including extracted content
      *
@@ -139,32 +138,35 @@ export declare class Materials extends APIResource {
      *
      * @example
      * ```ts
-     * const response = await client.v1.materials.move('id', {
-     *   folderId: 'folderId',
-     * });
+     * const materialResponse = await client.v1.materials.move(
+     *   'id',
+     *   { folderId: 'folderId' },
+     * );
      * ```
      */
-    move(id: string, body: MaterialMoveParams, options?: RequestOptions): APIPromise<MaterialMoveResponse>;
+    move(id: string, body: MaterialMoveParams, options?: RequestOptions): APIPromise<MaterialResponse>;
     /**
      * Rename a material
      *
      * @example
      * ```ts
-     * const response = await client.v1.materials.rename('id', {
-     *   name: 'New Material Name',
-     * });
+     * const materialResponse = await client.v1.materials.rename(
+     *   'id',
+     *   { name: 'New Material Name' },
+     * );
      * ```
      */
-    rename(id: string, body: MaterialRenameParams, options?: RequestOptions): APIPromise<MaterialRenameResponse>;
+    rename(id: string, body: MaterialRenameParams, options?: RequestOptions): APIPromise<MaterialResponse>;
     /**
      * Reprocess material to regenerate embeddings and extract content
      *
      * @example
      * ```ts
-     * const response = await client.v1.materials.reprocess('id');
+     * const materialResponse =
+     *   await client.v1.materials.reprocess('id');
      * ```
      */
-    reprocess(id: string, options?: RequestOptions): APIPromise<MaterialReprocessResponse>;
+    reprocess(id: string, options?: RequestOptions): APIPromise<MaterialResponse>;
     /**
      * Search materials using RAG (Retrieval-Augmented Generation)
      *
@@ -177,67 +179,25 @@ export declare class Materials extends APIResource {
      */
     search(body: MaterialSearchParams, options?: RequestOptions): APIPromise<MaterialSearchResponse>;
 }
-export interface MaterialCreateResponse {
-    /**
-     * Material ID
-     */
-    _id: string;
-    /**
-     * Material content
-     */
-    content: MaterialCreateResponse.Content;
-    /**
-     * Content type
-     */
-    contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
-    /**
-     * Creation timestamp
-     */
-    createdAt: string;
-    /**
-     * Folder ID
-     */
-    folderId: string | null;
-    /**
-     * Material name
-     */
-    name: string;
+export interface Content {
     /**
-     * Organization ID
+     * Type of content
      */
-    organizationId: string;
+    type: 'text' | 'pdf' | 'video' | 'audio' | 'url';
     /**
-     * Material status
+     * URL to fetch content from
      */
-    status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
+    sourceUrl?: string;
     /**
-     * Last update timestamp
+     * Text content (for text type)
      */
-    updatedAt: string;
+    text?: string;
     /**
-     * Material metadata
+     * URL to the content (for url type)
      */
-    metadata?: unknown;
-    /**
-     * Usage information
-     */
-    usage?: unknown;
+    url?: string;
 }
-export declare namespace MaterialCreateResponse {
-    /**
-     * Material content
-     */
-    interface Content {
-        filename?: string;
-        fileSize?: number;
-        mimeType?: string;
-        s3Key?: string;
-        s3Url?: string;
-        text?: string;
-        url?: string;
-    }
-}
-export interface MaterialRetrieveResponse {
+export interface GeneratedMaterialResponse {
     /**
      * Material ID
      */
@@ -245,7 +205,7 @@ export interface MaterialRetrieveResponse {
     /**
      * Material content
      */
-    content: MaterialRetrieveResponse.Content;
+    content: GeneratedMaterialResponse.Content;
     /**
      * Content type
      */
@@ -274,6 +234,10 @@ export interface MaterialRetrieveResponse {
      * Last update timestamp
      */
     updatedAt: string;
+    /**
+     * Generation metadata
+     */
+    generationMetadata?: unknown;
     /**
      * Material metadata
      */
@@ -283,7 +247,7 @@ export interface MaterialRetrieveResponse {
      */
     usage?: unknown;
 }
-export declare namespace MaterialRetrieveResponse {
+export declare namespace GeneratedMaterialResponse {
     /**
      * Material content
      */
@@ -297,29 +261,7 @@ export declare namespace MaterialRetrieveResponse {
         url?: string;
     }
 }
-export interface MaterialListResponse {
-    /**
-     * Array of materials
-     */
-    data: Array<unknown>;
-    /**
-     * Number of items per page
-     */
-    limit: number;
-    /**
-     * Current page number
-     */
-    page: number;
-    /**
-     * Total number of materials
-     */
-    total: number;
-    /**
-     * Total number of pages
-     */
-    totalPages: number;
-}
-export interface MaterialCreateAndProcessResponse {
+export interface MaterialResponse {
     /**
      * Material ID
      */
@@ -327,7 +269,7 @@ export interface MaterialCreateAndProcessResponse {
     /**
      * Material content
      */
-    content: MaterialCreateAndProcessResponse.Content;
+    content: MaterialResponse.Content;
     /**
      * Content type
      */
@@ -365,7 +307,7 @@ export interface MaterialCreateAndProcessResponse {
      */
     usage?: unknown;
 }
-export declare namespace MaterialCreateAndProcessResponse {
+export declare namespace MaterialResponse {
     /**
      * Material content
      */
@@ -379,6 +321,12 @@ export declare namespace MaterialCreateAndProcessResponse {
         url?: string;
     }
 }
+export interface MaterialListResponse {
+    materials?: Array<MaterialResponse>;
+    page?: number;
+    totalCount?: number;
+    totalPages?: number;
+}
 export type MaterialCreateBatchUploadURLsResponse = Array<MaterialCreateBatchUploadURLsResponse.MaterialCreateBatchUploadURLsResponseItem>;
 export declare namespace MaterialCreateBatchUploadURLsResponse {
     interface MaterialCreateBatchUploadURLsResponseItem {
@@ -400,134 +348,6 @@ export declare namespace MaterialCreateBatchUploadURLsResponse {
         uploadUrl: string;
     }
 }
-export interface MaterialGenerateResponse {
-    /**
-     * Material ID
-     */
-    _id: string;
-    /**
-     * Material content
-     */
-    content: MaterialGenerateResponse.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;
-    /**
-     * Generation metadata
-     */
-    generationMetadata?: unknown;
-    /**
-     * Material metadata
-     */
-    metadata?: unknown;
-    /**
-     * Usage information
-     */
-    usage?: unknown;
-}
-export declare namespace MaterialGenerateResponse {
-    /**
-     * Material content
-     */
-    interface Content {
-        filename?: string;
-        fileSize?: number;
-        mimeType?: string;
-        s3Key?: string;
-        s3Url?: string;
-        text?: string;
-        url?: string;
-    }
-}
-export interface MaterialGenerateAndProcessResponse {
-    /**
-     * Material ID
-     */
-    _id: string;
-    /**
-     * Material content
-     */
-    content: MaterialGenerateAndProcessResponse.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;
-    /**
-     * Generation metadata
-     */
-    generationMetadata?: unknown;
-    /**
-     * Material metadata
-     */
-    metadata?: unknown;
-    /**
-     * Usage information
-     */
-    usage?: unknown;
-}
-export declare namespace MaterialGenerateAndProcessResponse {
-    /**
-     * Material content
-     */
-    interface Content {
-        filename?: string;
-        fileSize?: number;
-        mimeType?: string;
-        s3Key?: string;
-        s3Url?: string;
-        text?: string;
-        url?: string;
-    }
-}
 export interface MaterialGetDebugInfoResponse {
     /**
      * Content details
@@ -577,186 +397,6 @@ export interface MaterialGetDownloadURLResponse {
      */
     downloadUrl: string;
 }
-export interface MaterialMoveResponse {
-    /**
-     * Material ID
-     */
-    _id: string;
-    /**
-     * Material content
-     */
-    content: MaterialMoveResponse.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 declare namespace MaterialMoveResponse {
-    /**
-     * Material content
-     */
-    interface Content {
-        filename?: string;
-        fileSize?: number;
-        mimeType?: string;
-        s3Key?: string;
-        s3Url?: string;
-        text?: string;
-        url?: string;
-    }
-}
-export interface MaterialRenameResponse {
-    /**
-     * Material ID
-     */
-    _id: string;
-    /**
-     * Material content
-     */
-    content: MaterialRenameResponse.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 declare namespace MaterialRenameResponse {
-    /**
-     * Material content
-     */
-    interface Content {
-        filename?: string;
-        fileSize?: number;
-        mimeType?: string;
-        s3Key?: string;
-        s3Url?: string;
-        text?: string;
-        url?: string;
-    }
-}
-export interface MaterialReprocessResponse {
-    /**
-     * Material ID
-     */
-    _id: string;
-    /**
-     * Material content
-     */
-    content: MaterialReprocessResponse.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 declare namespace MaterialReprocessResponse {
-    /**
-     * Material content
-     */
-    interface Content {
-        filename?: string;
-        fileSize?: number;
-        mimeType?: string;
-        s3Key?: string;
-        s3Url?: string;
-        text?: string;
-        url?: string;
-    }
-}
 export interface MaterialSearchResponse {
     /**
      * Whether results were filtered by scope
@@ -820,7 +460,7 @@ export interface MaterialCreateParams {
     /**
      * Content details
      */
-    content: MaterialCreateParams.Content;
+    content: Content;
     /**
      * Name of the material
      */
@@ -830,29 +470,6 @@ export interface MaterialCreateParams {
      */
     folderId?: string;
 }
-export declare namespace MaterialCreateParams {
-    /**
-     * Content details
-     */
-    interface Content {
-        /**
-         * Type of content
-         */
-        type: 'text' | 'pdf' | 'video' | 'audio' | 'url';
-        /**
-         * URL to fetch content from
-         */
-        sourceUrl?: string;
-        /**
-         * Text content (for text type)
-         */
-        text?: string;
-        /**
-         * URL to the content (for url type)
-         */
-        url?: string;
-    }
-}
 export interface MaterialListParams {
     /**
      * Filter by folder ID
@@ -866,12 +483,16 @@ export interface MaterialListParams {
      * Page number (default: 1)
      */
     page?: string;
+    /**
+     * Search materials by name
+     */
+    search?: string;
 }
 export interface MaterialCreateAndProcessParams {
     /**
      * Content details
      */
-    content: MaterialCreateAndProcessParams.Content;
+    content: Content;
     /**
      * Name of the material
      */
@@ -889,29 +510,6 @@ export interface MaterialCreateAndProcessParams {
      */
     timeoutMs?: number;
 }
-export declare namespace MaterialCreateAndProcessParams {
-    /**
-     * Content details
-     */
-    interface Content {
-        /**
-         * Type of content
-         */
-        type: 'text' | 'pdf' | 'video' | 'audio' | 'url';
-        /**
-         * URL to fetch content from
-         */
-        sourceUrl?: string;
-        /**
-         * Text content (for text type)
-         */
-        text?: string;
-        /**
-         * URL to the content (for url type)
-         */
-        url?: string;
-    }
-}
 export interface MaterialCreateBatchUploadURLsParams {
     /**
      * Array of materials to create
@@ -1043,9 +641,8 @@ export interface MaterialSearchParams {
     topK?: number;
 }
 export declare namespace Materials {
-    export { type MaterialCreateResponse as MaterialCreateResponse, type MaterialRetrieveResponse as MaterialRetrieveResponse, type MaterialListResponse as MaterialListResponse, type MaterialCreateAndProcessResponse as MaterialCreateAndProcessResponse, type MaterialCreateBatchUploadURLsResponse as MaterialCreateBatchUploadURLsResponse, type MaterialGenerateResponse as MaterialGenerateResponse, type MaterialGenerateAndProcessResponse as MaterialGenerateAndProcessResponse, type MaterialGetDebugInfoResponse as MaterialGetDebugInfoResponse, type MaterialGetDownloadURLResponse as MaterialGetDownloadURLResponse, type MaterialMoveResponse as MaterialMoveResponse, type MaterialRenameResponse as MaterialRenameResponse, type MaterialReprocessResponse as MaterialReprocessResponse, type MaterialSearchResponse as MaterialSearchResponse, type MaterialCreateParams as MaterialCreateParams, type MaterialListParams as MaterialListParams, type MaterialCreateAndProcessParams as MaterialCreateAndProcessParams, type MaterialCreateBatchUploadURLsParams as MaterialCreateBatchUploadURLsParams, type MaterialGenerateParams as MaterialGenerateParams, type MaterialGenerateAndProcessParams as MaterialGenerateAndProcessParams, type MaterialGetDownloadURLParams as MaterialGetDownloadURLParams, type MaterialMoveParams as MaterialMoveParams, type MaterialRenameParams as MaterialRenameParams, type MaterialSearchParams as MaterialSearchParams, };
-    export { Upload as Upload, type UploadCompleteUploadResponse as UploadCompleteUploadResponse, type UploadGetPresignedURLResponse as UploadGetPresignedURLResponse, type UploadUploadFileResponse as UploadUploadFileResponse, type UploadUploadFileAndProcessResponse as UploadUploadFileAndProcessResponse, type UploadUploadFromURLResponse as UploadUploadFromURLResponse, type UploadUploadFromURLAndProcessResponse as UploadUploadFromURLAndProcessResponse, type UploadCompleteUploadParams as UploadCompleteUploadParams, type UploadGetPresignedURLParams as UploadGetPresignedURLParams, type UploadUploadFileParams as UploadUploadFileParams, type UploadUploadFileAndProcessParams as UploadUploadFileAndProcessParams, type UploadUploadFromURLParams as UploadUploadFromURLParams, type UploadUploadFromURLAndProcessParams as UploadUploadFromURLAndProcessParams, };
+    export { type Content as Content, type GeneratedMaterialResponse as GeneratedMaterialResponse, type MaterialResponse as MaterialResponse, type MaterialListResponse as MaterialListResponse, type MaterialCreateBatchUploadURLsResponse as MaterialCreateBatchUploadURLsResponse, type MaterialGetDebugInfoResponse as MaterialGetDebugInfoResponse, type MaterialGetDownloadURLResponse as MaterialGetDownloadURLResponse, type MaterialSearchResponse as MaterialSearchResponse, type MaterialCreateParams as MaterialCreateParams, type MaterialListParams as MaterialListParams, type MaterialCreateAndProcessParams as MaterialCreateAndProcessParams, type MaterialCreateBatchUploadURLsParams as MaterialCreateBatchUploadURLsParams, type MaterialGenerateParams as MaterialGenerateParams, type MaterialGenerateAndProcessParams as MaterialGenerateAndProcessParams, type MaterialGetDownloadURLParams as MaterialGetDownloadURLParams, type MaterialMoveParams as MaterialMoveParams, type MaterialRenameParams as MaterialRenameParams, type MaterialSearchParams as MaterialSearchParams, };
+    export { Upload as Upload, type UploadGetPresignedURLResponse as UploadGetPresignedURLResponse, type UploadCompleteUploadParams as UploadCompleteUploadParams, type UploadGetPresignedURLParams as UploadGetPresignedURLParams, type UploadUploadFileParams as UploadUploadFileParams, type UploadUploadFileAndProcessParams as UploadUploadFileAndProcessParams, type UploadUploadFromURLParams as UploadUploadFromURLParams, type UploadUploadFromURLAndProcessParams as UploadUploadFromURLAndProcessParams, };
     export { Bulk as Bulk, type BulkMoveResponse as BulkMoveResponse, type BulkMoveParams as BulkMoveParams };
-    export { Test as Test, type TestTestEpubProcessingResponse as TestTestEpubProcessingResponse, type TestTestImageProcessingResponse as TestTestImageProcessingResponse, type TestTestOcrResponse as TestTestOcrResponse, type TestTestVideoProcessingResponse as TestTestVideoProcessingResponse, };
 }
 //# sourceMappingURL=materials.d.ts.map