@studyfetch/sdk 1.40.0 → 1.41.0

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

@@ -1,7 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../../core/resource';
-import * as MaterialsAPI from './materials';
 import { APIPromise } from '../../../core/api-promise';
 import { type Uploadable } from '../../../core/uploads';
 import { RequestOptions } from '../../../internal/request-options';
@@ -13,7 +12,7 @@ export class Upload extends APIResource {
    *
    * @example
    * ```ts
-   * const materialResponse =
+   * const response =
    *   await client.v1.materials.upload.completeUpload({
    *     materialId: 'materialId',
    *     s3Key: 's3Key',
@@ -23,7 +22,7 @@ export class Upload extends APIResource {
   completeUpload(
     body: UploadCompleteUploadParams,
     options?: RequestOptions,
-  ): APIPromise<MaterialsAPI.MaterialResponse> {
+  ): APIPromise<UploadCompleteUploadResponse> {
     return this._client.post('/api/v1/materials/upload/complete', { body, ...options });
   }
 
@@ -52,17 +51,14 @@ export class Upload extends APIResource {
    *
    * @example
    * ```ts
-   * const materialResponse =
+   * const response =
    *   await client.v1.materials.upload.uploadFile({
    *     file: fs.createReadStream('path/to/file'),
    *     name: 'name',
    *   });
    * ```
    */
-  uploadFile(
-    body: UploadUploadFileParams,
-    options?: RequestOptions,
-  ): APIPromise<MaterialsAPI.MaterialResponse> {
+  uploadFile(body: UploadUploadFileParams, options?: RequestOptions): APIPromise<UploadUploadFileResponse> {
     return this._client.post(
       '/api/v1/materials/upload',
       multipartFormRequestOptions({ body, ...options }, this._client),
@@ -75,7 +71,7 @@ export class Upload extends APIResource {
    *
    * @example
    * ```ts
-   * const materialResponse =
+   * const response =
    *   await client.v1.materials.upload.uploadFileAndProcess({
    *     file: fs.createReadStream('path/to/file'),
    *     name: 'name',
@@ -85,7 +81,7 @@ export class Upload extends APIResource {
   uploadFileAndProcess(
     body: UploadUploadFileAndProcessParams,
     options?: RequestOptions,
-  ): APIPromise<MaterialsAPI.MaterialResponse> {
+  ): APIPromise<UploadUploadFileAndProcessResponse> {
     return this._client.post(
       '/api/v1/materials/upload/file-and-process',
       multipartFormRequestOptions({ body, ...options }, this._client),
@@ -97,7 +93,7 @@ export class Upload extends APIResource {
    *
    * @example
    * ```ts
-   * const materialResponse =
+   * const response =
    *   await client.v1.materials.upload.uploadFromURL({
    *     name: 'name',
    *     url: 'url',
@@ -107,7 +103,7 @@ export class Upload extends APIResource {
   uploadFromURL(
     body: UploadUploadFromURLParams,
     options?: RequestOptions,
-  ): APIPromise<MaterialsAPI.MaterialResponse> {
+  ): APIPromise<UploadUploadFromURLResponse> {
     return this._client.post('/api/v1/materials/upload/url', { body, ...options });
   }
 
@@ -117,7 +113,7 @@ export class Upload extends APIResource {
    *
    * @example
    * ```ts
-   * const materialResponse =
+   * const response =
    *   await client.v1.materials.upload.uploadFromURLAndProcess({
    *     name: 'My Document',
    *     url: 'https://example.com/document.pdf',
@@ -127,11 +123,106 @@ export class Upload extends APIResource {
   uploadFromURLAndProcess(
     body: UploadUploadFromURLAndProcessParams,
     options?: RequestOptions,
-  ): APIPromise<MaterialsAPI.MaterialResponse> {
+  ): APIPromise<UploadUploadFromURLAndProcessResponse> {
     return this._client.post('/api/v1/materials/upload/url-and-process', { body, ...options });
   }
 }
 
+export interface UploadCompleteUploadResponse {
+  /**
+   * Material ID
+   */
+  _id: string;
+
+  /**
+   * Material content
+   */
+  content: UploadCompleteUploadResponse.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;
+
+  /**
+   * References that this material cites
+   */
+  references?: Array<UploadCompleteUploadResponse.Reference>;
+
+  /**
+   * Usage information
+   */
+  usage?: unknown;
+}
+
+export namespace UploadCompleteUploadResponse {
+  /**
+   * Material content
+   */
+  export interface Content {
+    filename?: string;
+
+    fileSize?: number;
+
+    mimeType?: string;
+
+    s3Key?: string;
+
+    s3Url?: string;
+
+    text?: string;
+
+    url?: string;
+  }
+
+  export interface Reference {
+    /**
+     * Reference title
+     */
+    title: string;
+
+    /**
+     * Reference URL
+     */
+    url?: string;
+  }
+}
+
 export interface UploadGetPresignedURLResponse {
   /**
    * Material ID to use for completion
@@ -149,6 +240,386 @@ export interface UploadGetPresignedURLResponse {
   uploadUrl: string;
 }
 
+export interface UploadUploadFileResponse {
+  /**
+   * Material ID
+   */
+  _id: string;
+
+  /**
+   * Material content
+   */
+  content: UploadUploadFileResponse.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;
+
+  /**
+   * References that this material cites
+   */
+  references?: Array<UploadUploadFileResponse.Reference>;
+
+  /**
+   * Usage information
+   */
+  usage?: unknown;
+}
+
+export namespace UploadUploadFileResponse {
+  /**
+   * Material content
+   */
+  export interface Content {
+    filename?: string;
+
+    fileSize?: number;
+
+    mimeType?: string;
+
+    s3Key?: string;
+
+    s3Url?: string;
+
+    text?: string;
+
+    url?: string;
+  }
+
+  export interface Reference {
+    /**
+     * Reference title
+     */
+    title: string;
+
+    /**
+     * Reference URL
+     */
+    url?: string;
+  }
+}
+
+export interface UploadUploadFileAndProcessResponse {
+  /**
+   * Material ID
+   */
+  _id: string;
+
+  /**
+   * Material content
+   */
+  content: UploadUploadFileAndProcessResponse.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;
+
+  /**
+   * References that this material cites
+   */
+  references?: Array<UploadUploadFileAndProcessResponse.Reference>;
+
+  /**
+   * Usage information
+   */
+  usage?: unknown;
+}
+
+export namespace UploadUploadFileAndProcessResponse {
+  /**
+   * Material content
+   */
+  export interface Content {
+    filename?: string;
+
+    fileSize?: number;
+
+    mimeType?: string;
+
+    s3Key?: string;
+
+    s3Url?: string;
+
+    text?: string;
+
+    url?: string;
+  }
+
+  export interface Reference {
+    /**
+     * Reference title
+     */
+    title: string;
+
+    /**
+     * Reference URL
+     */
+    url?: string;
+  }
+}
+
+export interface UploadUploadFromURLResponse {
+  /**
+   * Material ID
+   */
+  _id: string;
+
+  /**
+   * Material content
+   */
+  content: UploadUploadFromURLResponse.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;
+
+  /**
+   * References that this material cites
+   */
+  references?: Array<UploadUploadFromURLResponse.Reference>;
+
+  /**
+   * Usage information
+   */
+  usage?: unknown;
+}
+
+export namespace UploadUploadFromURLResponse {
+  /**
+   * Material content
+   */
+  export interface Content {
+    filename?: string;
+
+    fileSize?: number;
+
+    mimeType?: string;
+
+    s3Key?: string;
+
+    s3Url?: string;
+
+    text?: string;
+
+    url?: string;
+  }
+
+  export interface Reference {
+    /**
+     * Reference title
+     */
+    title: string;
+
+    /**
+     * Reference URL
+     */
+    url?: string;
+  }
+}
+
+export interface UploadUploadFromURLAndProcessResponse {
+  /**
+   * Material ID
+   */
+  _id: string;
+
+  /**
+   * Material content
+   */
+  content: UploadUploadFromURLAndProcessResponse.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;
+
+  /**
+   * References that this material cites
+   */
+  references?: Array<UploadUploadFromURLAndProcessResponse.Reference>;
+
+  /**
+   * Usage information
+   */
+  usage?: unknown;
+}
+
+export namespace UploadUploadFromURLAndProcessResponse {
+  /**
+   * Material content
+   */
+  export interface Content {
+    filename?: string;
+
+    fileSize?: number;
+
+    mimeType?: string;
+
+    s3Key?: string;
+
+    s3Url?: string;
+
+    text?: string;
+
+    url?: string;
+  }
+
+  export interface Reference {
+    /**
+     * Reference title
+     */
+    title: string;
+
+    /**
+     * Reference URL
+     */
+    url?: string;
+  }
+}
+
 export interface UploadCompleteUploadParams {
   /**
    * Material ID from presigned URL response
@@ -186,6 +657,25 @@ export interface UploadGetPresignedURLParams {
    * Folder ID to place the material in
    */
   folderId?: string;
+
+  /**
+   * References that this material cites
+   */
+  references?: Array<UploadGetPresignedURLParams.Reference>;
+}
+
+export namespace UploadGetPresignedURLParams {
+  export interface Reference {
+    /**
+     * Reference title
+     */
+    title: string;
+
+    /**
+     * Reference URL
+     */
+    url?: string;
+  }
 }
 
 export interface UploadUploadFileParams {
@@ -205,6 +695,11 @@ export interface UploadUploadFileParams {
    * Folder ID (optional)
    */
   folderId?: string;
+
+  /**
+   * JSON string of references array (optional)
+   */
+  references?: string;
 }
 
 export interface UploadUploadFileAndProcessParams {
@@ -274,15 +769,39 @@ export interface UploadUploadFromURLAndProcessParams {
    */
   pollIntervalMs?: number;
 
+  /**
+   * References that this material cites
+   */
+  references?: Array<UploadUploadFromURLAndProcessParams.Reference>;
+
   /**
    * Maximum time to wait for processing in milliseconds (default: 5 minutes)
    */
   timeoutMs?: number;
 }
 
+export namespace UploadUploadFromURLAndProcessParams {
+  export interface Reference {
+    /**
+     * Reference title
+     */
+    title: string;
+
+    /**
+     * Reference URL
+     */
+    url?: string;
+  }
+}
+
 export declare namespace Upload {
   export {
+    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,