@studyfetch/sdk 1.28.0 → 1.30.0

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

@@ -143,13 +143,31 @@ export class Materials extends APIResource {
     return this._client.get(path`/api/v1/materials/${id}/debug`, options);
   }
 
+  /**
+   * Uses AI to generate study materials like outlines, notes, summaries, etc. from a
+   * given topic. Returns immediately without waiting for processing.
+   *
+   * @example
+   * ```ts
+   * const generatedMaterial =
+   *   await client.v1.materials.generate({
+   *     name: 'Photosynthesis Study Plan',
+   *     topic: 'Photosynthesis in plants',
+   *     type: 'notes',
+   *   });
+   * ```
+   */
+  generate(body: MaterialGenerateParams, options?: RequestOptions): APIPromise<GeneratedMaterial> {
+    return this._client.post('/api/v1/materials/generate', { body, ...options });
+  }
+
   /**
    * 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 generatedMaterial =
    *   await client.v1.materials.generateAndProcess({
    *     name: 'Photosynthesis Study Plan',
    *     topic: 'Photosynthesis in plants',
@@ -160,7 +178,7 @@ export class Materials extends APIResource {
   generateAndProcess(
     body: MaterialGenerateAndProcessParams,
     options?: RequestOptions,
-  ): APIPromise<MaterialGenerateAndProcessResponse> {
+  ): APIPromise<GeneratedMaterial> {
     return this._client.post('/api/v1/materials/generate-and-process', { body, ...options });
   }
 
@@ -259,6 +277,89 @@ export interface Content {
   url?: string;
 }
 
+export interface GeneratedMaterial {
+  /**
+   * Material ID
+   */
+  _id: string;
+
+  /**
+   * Material content
+   */
+  content: GeneratedMaterial.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 namespace GeneratedMaterial {
+  /**
+   * Material content
+   */
+  export interface Content {
+    filename?: string;
+
+    fileSize?: number;
+
+    mimeType?: string;
+
+    s3Key?: string;
+
+    s3Url?: string;
+
+    text?: string;
+
+    url?: string;
+  }
+}
+
 export interface Material {
   /**
    * Material ID
@@ -421,89 +522,6 @@ export namespace MaterialDebugResponse {
   }
 }
 
-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 namespace MaterialGenerateAndProcessResponse {
-  /**
-   * Material content
-   */
-  export interface Content {
-    filename?: string;
-
-    fileSize?: number;
-
-    mimeType?: string;
-
-    s3Key?: string;
-
-    s3Url?: string;
-
-    text?: string;
-
-    url?: string;
-  }
-}
-
 export interface MaterialGetDownloadURLResponse {
   /**
    * Temporary download URL
@@ -666,6 +684,43 @@ export interface MaterialCreateAndProcessParams {
   timeoutMs?: number;
 }
 
+export interface MaterialGenerateParams {
+  /**
+   * Name for the generated material
+   */
+  name: string;
+
+  /**
+   * Topic or context to generate material from
+   */
+  topic: string;
+
+  /**
+   * Type of material to generate
+   */
+  type: 'outline' | 'overview' | 'notes' | 'summary';
+
+  /**
+   * Additional context or details about the topic
+   */
+  context?: string;
+
+  /**
+   * Target folder ID
+   */
+  folderId?: string;
+
+  /**
+   * Length of the generated content
+   */
+  length?: 'short' | 'medium' | 'long';
+
+  /**
+   * Target education level
+   */
+  level?: 'high_school' | 'college' | 'professional';
+}
+
 export interface MaterialGenerateAndProcessParams {
   /**
    * Name for the generated material
@@ -701,6 +756,16 @@ export interface MaterialGenerateAndProcessParams {
    * Target education level
    */
   level?: 'high_school' | 'college' | 'professional';
+
+  /**
+   * Polling interval in milliseconds (default: 2 seconds)
+   */
+  pollIntervalMs?: number;
+
+  /**
+   * Maximum time to wait for processing in milliseconds (default: 5 minutes)
+   */
+  timeoutMs?: number;
 }
 
 export interface MaterialGetDownloadURLParams {
@@ -753,17 +818,18 @@ Materials.Test = Test;
 export declare namespace Materials {
   export {
     type Content as Content,
+    type GeneratedMaterial as GeneratedMaterial,
     type Material as Material,
     type MaterialListResponse as MaterialListResponse,
     type MaterialBatchCreateResponse as MaterialBatchCreateResponse,
     type MaterialDebugResponse as MaterialDebugResponse,
-    type MaterialGenerateAndProcessResponse as MaterialGenerateAndProcessResponse,
     type MaterialGetDownloadURLResponse as MaterialGetDownloadURLResponse,
     type MaterialSearchResponse as MaterialSearchResponse,
     type MaterialCreateParams as MaterialCreateParams,
     type MaterialListParams as MaterialListParams,
     type MaterialBatchCreateParams as MaterialBatchCreateParams,
     type MaterialCreateAndProcessParams as MaterialCreateAndProcessParams,
+    type MaterialGenerateParams as MaterialGenerateParams,
     type MaterialGenerateAndProcessParams as MaterialGenerateAndProcessParams,
     type MaterialGetDownloadURLParams as MaterialGetDownloadURLParams,
     type MaterialMoveParams as MaterialMoveParams,

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

@@ -15,10 +15,8 @@ export class Upload extends APIResource {
    * ```ts
    * const material =
    *   await client.v1.materials.upload.completeUpload({
-   *     materialId: '507f1f77bcf86cd799439013',
-   *     organizationId: '507f1f77bcf86cd799439011',
-   *     s3Key:
-   *       'organizations/507f1f77bcf86cd799439011/materials/document.pdf',
+   *     materialId: 'materialId',
+   *     s3Key: 's3Key',
    *   });
    * ```
    */
@@ -133,17 +131,12 @@ export class Upload extends APIResource {
 
 export interface Complete {
   /**
-   * The ID of the material that was uploaded
+   * Material ID from presigned URL response
    */
   materialId: string;
 
   /**
-   * The ID of the organization
-   */
-  organizationId: string;
-
-  /**
-   * The S3 key of the uploaded file
+   * S3 key from presigned URL response
    */
   s3Key: string;
 }
@@ -167,17 +160,12 @@ export interface UploadCreatePresignedURLResponse {
 
 export interface UploadCompleteUploadParams {
   /**
-   * The ID of the material that was uploaded
+   * Material ID from presigned URL response
    */
   materialId: string;
 
   /**
-   * The ID of the organization
-   */
-  organizationId: string;
-
-  /**
-   * The S3 key of the uploaded file
+   * S3 key from presigned URL response
    */
   s3Key: string;
 }
@@ -252,7 +240,7 @@ export interface UploadUploadFileAndProcessParams {
   pollIntervalMs?: number;
 
   /**
-   * Processing timeout in milliseconds (default: 300000)
+   * Processing timeout in milliseconds (default: 300000 - 5 minutes)
    */
   timeoutMs?: number;
 }

package/src/resources/v1/v1.ts

@@ -8,6 +8,8 @@ import {
   AssignmentGraderGetAllResponse,
   AssignmentGraderResponse,
 } from './assignment-grader';
+import * as ChatAPI from './chat';
+import { Chat, ChatStreamParams } from './chat';
 import * as ComponentsAPI from './components';
 import {
   Component,
@@ -26,6 +28,7 @@ import { Embed, EmbedGetThemeParams, EmbedVerifyParams } from './embed/embed';
 import * as MaterialsAPI from './materials/materials';
 import {
   Content,
+  GeneratedMaterial,
   Material,
   MaterialBatchCreateParams,
   MaterialBatchCreateResponse,
@@ -33,7 +36,7 @@ import {
   MaterialCreateParams,
   MaterialDebugResponse,
   MaterialGenerateAndProcessParams,
-  MaterialGenerateAndProcessResponse,
+  MaterialGenerateParams,
   MaterialGetDownloadURLParams,
   MaterialGetDownloadURLResponse,
   MaterialListParams,
@@ -44,8 +47,6 @@ import {
   MaterialSearchResponse,
   Materials,
 } from './materials/materials';
-import * as UploadAPI from './upload/upload';
-import { Upload } from './upload/upload';
 import * as UsageAPI from './usage/usage';
 import { Usage, UsageGetStatsParams, UsageGetSummaryParams, UsageListEventsParams } from './usage/usage';
 import { APIPromise } from '../../core/api-promise';
@@ -58,10 +59,10 @@ export class V1 extends APIResource {
   components: ComponentsAPI.Components = new ComponentsAPI.Components(this._client);
   usage: UsageAPI.Usage = new UsageAPI.Usage(this._client);
   embed: EmbedAPI.Embed = new EmbedAPI.Embed(this._client);
-  upload: UploadAPI.Upload = new UploadAPI.Upload(this._client);
   assignmentGrader: AssignmentGraderAPI.AssignmentGrader = new AssignmentGraderAPI.AssignmentGrader(
     this._client,
   );
+  chat: ChatAPI.Chat = new ChatAPI.Chat(this._client);
 
   /**
    * Test MongoDB connection and get outbound IP
@@ -84,24 +85,25 @@ V1.Folders = Folders;
 V1.Components = Components;
 V1.Usage = Usage;
 V1.Embed = Embed;
-V1.Upload = Upload;
 V1.AssignmentGrader = AssignmentGrader;
+V1.Chat = Chat;
 
 export declare namespace V1 {
   export {
     Materials as Materials,
     type Content as Content,
+    type GeneratedMaterial as GeneratedMaterial,
     type Material as Material,
     type MaterialListResponse as MaterialListResponse,
     type MaterialBatchCreateResponse as MaterialBatchCreateResponse,
     type MaterialDebugResponse as MaterialDebugResponse,
-    type MaterialGenerateAndProcessResponse as MaterialGenerateAndProcessResponse,
     type MaterialGetDownloadURLResponse as MaterialGetDownloadURLResponse,
     type MaterialSearchResponse as MaterialSearchResponse,
     type MaterialCreateParams as MaterialCreateParams,
     type MaterialListParams as MaterialListParams,
     type MaterialBatchCreateParams as MaterialBatchCreateParams,
     type MaterialCreateAndProcessParams as MaterialCreateAndProcessParams,
+    type MaterialGenerateParams as MaterialGenerateParams,
     type MaterialGenerateAndProcessParams as MaterialGenerateAndProcessParams,
     type MaterialGetDownloadURLParams as MaterialGetDownloadURLParams,
     type MaterialMoveParams as MaterialMoveParams,
@@ -140,12 +142,12 @@ export declare namespace V1 {
     type EmbedVerifyParams as EmbedVerifyParams,
   };
 
-  export { Upload as Upload };
-
   export {
     AssignmentGrader as AssignmentGrader,
     type AssignmentGraderResponse as AssignmentGraderResponse,
     type AssignmentGraderGetAllResponse as AssignmentGraderGetAllResponse,
     type AssignmentGraderCreateParams as AssignmentGraderCreateParams,
   };
+
+  export { Chat as Chat, type ChatStreamParams as ChatStreamParams };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.28.0'; // x-release-please-version
+export const VERSION = '1.30.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.28.0";
+export declare const VERSION = "1.30.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.28.0";
+export declare const VERSION = "1.30.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '1.28.0'; // x-release-please-version
+exports.VERSION = '1.30.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '1.28.0'; // x-release-please-version
+export const VERSION = '1.30.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/resources/v1/upload/component.d.mts

@@ -1,191 +0,0 @@
-import { APIResource } from "../../../core/resource.mjs";
-import { APIPromise } from "../../../core/api-promise.mjs";
-import { type Uploadable } from "../../../core/uploads.mjs";
-import { RequestOptions } from "../../../internal/request-options.mjs";
-export declare class Component extends APIResource {
-    /**
-     * Complete a file upload after using presigned URL
-     *
-     * @example
-     * ```ts
-     * const response =
-     *   await client.v1.upload.component.completeUpload(
-     *     'componentId',
-     *     {
-     *       materialId: '507f1f77bcf86cd799439013',
-     *       organizationId: '507f1f77bcf86cd799439011',
-     *       s3Key:
-     *         'organizations/507f1f77bcf86cd799439011/materials/document.pdf',
-     *     },
-     *   );
-     * ```
-     */
-    completeUpload(componentID: string, body: ComponentCompleteUploadParams, options?: RequestOptions): APIPromise<ComponentCompleteUploadResponse>;
-    /**
-     * Get a presigned URL for direct file upload
-     *
-     * @example
-     * ```ts
-     * const response =
-     *   await client.v1.upload.component.getPresignedURL(
-     *     'componentId',
-     *     {
-     *       contentType: 'application/pdf',
-     *       filename: 'document.pdf',
-     *       folderId: '507f1f77bcf86cd799439012',
-     *       organizationId: '507f1f77bcf86cd799439011',
-     *     },
-     *   );
-     * ```
-     */
-    getPresignedURL(componentID: string, body: ComponentGetPresignedURLParams, options?: RequestOptions): APIPromise<ComponentGetPresignedURLResponse>;
-    /**
-     * Upload a file to a component
-     *
-     * @example
-     * ```ts
-     * const fileUploadResponse =
-     *   await client.v1.upload.component.uploadFile(
-     *     'componentId',
-     *     {
-     *       file: fs.createReadStream('path/to/file'),
-     *       folderId: '507f1f77bcf86cd799439012',
-     *       organizationId: '507f1f77bcf86cd799439011',
-     *     },
-     *   );
-     * ```
-     */
-    uploadFile(componentID: string, body: ComponentUploadFileParams, options?: RequestOptions): APIPromise<FileUploadResponse>;
-    /**
-     * Upload a file from URL to a component
-     *
-     * @example
-     * ```ts
-     * const fileUploadResponse =
-     *   await client.v1.upload.component.uploadURL(
-     *     'componentId',
-     *     {
-     *       folderId: '507f1f77bcf86cd799439012',
-     *       name: 'my-document.pdf',
-     *       organizationId: '507f1f77bcf86cd799439011',
-     *       url: 'https://example.com/document.pdf',
-     *     },
-     *   );
-     * ```
-     */
-    uploadURL(componentID: string, body: ComponentUploadURLParams, options?: RequestOptions): APIPromise<FileUploadResponse>;
-}
-export interface FileUploadResponse {
-    /**
-     * The ID of the uploaded material
-     */
-    id: string;
-    /**
-     * The content type of the material
-     */
-    contentType: string;
-    /**
-     * The name of the material
-     */
-    name: string;
-    /**
-     * The S3 key of the uploaded file
-     */
-    s3Key: string;
-    /**
-     * The status of the material
-     */
-    status: string;
-}
-export interface ComponentCompleteUploadResponse {
-    /**
-     * The ID of the uploaded material
-     */
-    id: string;
-    /**
-     * The name of the material
-     */
-    name: string;
-    /**
-     * The status of the material
-     */
-    status: string;
-}
-export interface ComponentGetPresignedURLResponse {
-    /**
-     * The S3 key for the file
-     */
-    key: string;
-    /**
-     * The presigned URL for uploading
-     */
-    uploadUrl: string;
-}
-export interface ComponentCompleteUploadParams {
-    /**
-     * The ID of the material that was uploaded
-     */
-    materialId: string;
-    /**
-     * The ID of the organization
-     */
-    organizationId: string;
-    /**
-     * The S3 key of the uploaded file
-     */
-    s3Key: string;
-}
-export interface ComponentGetPresignedURLParams {
-    /**
-     * The MIME type of the file
-     */
-    contentType: string;
-    /**
-     * The name of the file to upload
-     */
-    filename: string;
-    /**
-     * The ID of the folder to upload to
-     */
-    folderId: string;
-    /**
-     * The ID of the organization
-     */
-    organizationId: string;
-}
-export interface ComponentUploadFileParams {
-    /**
-     * The file to upload
-     */
-    file: Uploadable;
-    /**
-     * The ID of the folder to upload to
-     */
-    folderId: string;
-    /**
-     * The ID of the organization
-     */
-    organizationId: string;
-}
-export interface ComponentUploadURLParams {
-    /**
-     * The ID of the folder to upload to
-     */
-    folderId: string;
-    /**
-     * The name for the uploaded file
-     */
-    name: string;
-    /**
-     * The ID of the organization
-     */
-    organizationId: string;
-    /**
-     * The URL of the file to upload
-     */
-    url: string;
-}
-export declare namespace Component {
-    export { type FileUploadResponse as FileUploadResponse, type ComponentCompleteUploadResponse as ComponentCompleteUploadResponse, type ComponentGetPresignedURLResponse as ComponentGetPresignedURLResponse, type ComponentCompleteUploadParams as ComponentCompleteUploadParams, type ComponentGetPresignedURLParams as ComponentGetPresignedURLParams, type ComponentUploadFileParams as ComponentUploadFileParams, type ComponentUploadURLParams as ComponentUploadURLParams, };
-}
-//# sourceMappingURL=component.d.mts.map

package/resources/v1/upload/component.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"component.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/upload/component.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,KAAK,UAAU,EAAE;OACnB,EAAE,cAAc,EAAE;AAIzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc,CACZ,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CACb,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAO/C;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CACR,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAOjC;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CACP,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;CAGlC;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}