@studyfetch/sdk 1.1.1 → 1.3.0

package/src/resources/v1/index.ts

@@ -8,40 +8,70 @@ export {
 } from './audio-recaps/index';
 export {
   Auth,
-  type AuthForgotPasswordParams,
+  type AuthRegisterNewUserParams,
   type AuthRegisterWithInviteParams,
+  type AuthRequestPasswordResetParams,
   type AuthResetPasswordParams,
+  type AuthVerifyResetTokenParams,
 } from './auth/index';
 export {
   Chat,
-  type ChatCreateStreamParams,
   type ChatRetrieveSessionParams,
   type ChatSendMessageParams,
+  type ChatStreamParams,
 } from './chat/index';
 export {
   Components,
+  type ComponentCreateResponse,
+  type ComponentRetrieveResponse,
+  type ComponentUpdateResponse,
+  type ComponentListResponse,
+  type ComponentEmbedResponse,
   type ComponentCreateParams,
   type ComponentUpdateParams,
   type ComponentListParams,
   type ComponentEmbedParams,
 } from './components';
-export {
-  Embed,
-  type EmbedRetrieveParams,
-  type EmbedGetThemeParams,
-  type EmbedVerifyParams,
-} from './embed/index';
-export { Explainers, type ExplainerCreateParams } from './explainers';
+export { Embed, type EmbedGetThemeParams, type EmbedVerifyParams } from './embed/index';
+export { Explainers, type ExplainerCreateParams, type ExplainerHandleWebhookParams } from './explainers';
 export {
   Flashcards,
+  type FlashcardBatchProcessResponse,
+  type FlashcardGetAlgorithmInfoResponse,
+  type FlashcardGetTypesResponse,
+  type FlashcardBatchProcessParams,
+  type FlashcardGetAllParams,
   type FlashcardGetDueParams,
   type FlashcardGetStatsParams,
-  type FlashcardListAllParams,
+  type FlashcardRateParams,
 } from './flashcards';
-export { Folders } from './folders';
-export { Materials, type MaterialCreateParams, type MaterialGetDownloadURLParams } from './materials/index';
+export { Folders, type FolderCreateParams, type FolderUpdateParams, type FolderListParams } from './folders';
+export {
+  Materials,
+  type MaterialCreateResponse,
+  type MaterialRetrieveResponse,
+  type MaterialListResponse,
+  type MaterialCreateParams,
+  type MaterialListParams,
+  type MaterialGetDownloadURLParams,
+} from './materials/index';
 export { Organizations, type OrganizationUpdateParams } from './organizations/index';
-export { Scenarios } from './scenarios/index';
-export { Tests } from './tests/index';
-export { Usage, type UsageChatParams, type UsageTrackParams } from './usage';
+export { Scenarios, type ScenarioCreateParams, type ScenarioUpdateParams } from './scenarios/index';
+export {
+  Tests,
+  type TestCreateParams,
+  type TestRetakeParams,
+  type TestSubmitParams,
+  type TestSubmitAnswerParams,
+} from './tests/index';
+export { Upload } from './upload/index';
+export {
+  Usage,
+  type UsageGetStatsParams,
+  type UsageGetSummaryParams,
+  type UsageListEventsParams,
+  type UsageTrackChatParams,
+  type UsageTrackEventParams,
+  type UsageTrackPerformanceParams,
+} from './usage';
 export { V1 } from './v1';

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

@@ -6,6 +6,12 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 
 export class Bulk extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.bulk.move();
+   * ```
+   */
   move(options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/materials/bulk/move', {
       ...options,

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

@@ -1,6 +1,20 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export { Bulk } from './bulk';
-export { Materials, type MaterialCreateParams, type MaterialGetDownloadURLParams } from './materials';
+export {
+  Materials,
+  type MaterialCreateResponse,
+  type MaterialRetrieveResponse,
+  type MaterialListResponse,
+  type MaterialCreateParams,
+  type MaterialListParams,
+  type MaterialGetDownloadURLParams,
+} from './materials';
 export { Test } from './test';
-export { Upload } from './upload';
+export {
+  Upload,
+  type UploadUploadFileResponse,
+  type UploadUploadFromURLResponse,
+  type UploadUploadFileParams,
+  type UploadUploadFromURLParams,
+} from './upload';

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

@@ -6,7 +6,13 @@ import { Bulk } from './bulk';
 import * as TestAPI from './test';
 import { Test } from './test';
 import * as UploadAPI from './upload';
-import { Upload } from './upload';
+import {
+  Upload,
+  UploadUploadFileParams,
+  UploadUploadFileResponse,
+  UploadUploadFromURLParams,
+  UploadUploadFromURLResponse,
+} from './upload';
 import { APIPromise } from '../../../core/api-promise';
 import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
@@ -17,28 +23,56 @@ export class Materials extends APIResource {
   bulk: BulkAPI.Bulk = new BulkAPI.Bulk(this._client);
   test: TestAPI.Test = new TestAPI.Test(this._client);
 
-  create(body: MaterialCreateParams, options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/api/v1/materials', {
-      body,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  /**
+   * Create a new material
+   *
+   * @example
+   * ```ts
+   * const material = await client.v1.materials.create({
+   *   content: { type: 'text' },
+   *   name: 'Chapter 1 - Introduction',
+   * });
+   * ```
+   */
+  create(body: MaterialCreateParams, options?: RequestOptions): APIPromise<MaterialCreateResponse> {
+    return this._client.post('/api/v1/materials', { body, ...options });
   }
 
-  retrieve(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.get(path`/api/v1/materials/${id}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  /**
+   * Get material by ID
+   *
+   * @example
+   * ```ts
+   * const material = await client.v1.materials.retrieve('id');
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<MaterialRetrieveResponse> {
+    return this._client.get(path`/api/v1/materials/${id}`, options);
   }
 
-  list(options?: RequestOptions): APIPromise<void> {
-    return this._client.get('/api/v1/materials', {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  /**
+   * Get all materials for organization
+   *
+   * @example
+   * ```ts
+   * const materials = await client.v1.materials.list();
+   * ```
+   */
+  list(
+    query: MaterialListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<MaterialListResponse> {
+    return this._client.get('/api/v1/materials', { query, ...options });
   }
 
+  /**
+   * Delete material
+   *
+   * @example
+   * ```ts
+   * await client.v1.materials.delete('id');
+   * ```
+   */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/api/v1/materials/${id}`, {
       ...options,
@@ -46,13 +80,25 @@ export class Materials extends APIResource {
     });
   }
 
-  batchCreate(options?: RequestOptions): APIPromise<void> {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.createBatch();
+   * ```
+   */
+  createBatch(options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/materials/batch', {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.debug('id');
+   * ```
+   */
   debug(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.get(path`/api/v1/materials/${id}/debug`, {
       ...options,
@@ -60,6 +106,14 @@ export class Materials extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.getDownloadURL('id', {
+   *   expiresIn: 'expiresIn',
+   * });
+   * ```
+   */
   getDownloadURL(
     id: string,
     query: MaterialGetDownloadURLParams,
@@ -72,6 +126,12 @@ export class Materials extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.move('id');
+   * ```
+   */
   move(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/materials/${id}/move`, {
       ...options,
@@ -79,6 +139,12 @@ export class Materials extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.rename('id');
+   * ```
+   */
   rename(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/materials/${id}/rename`, {
       ...options,
@@ -86,6 +152,12 @@ export class Materials extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.reprocess('id');
+   * ```
+   */
   reprocess(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/materials/${id}/reprocess`, {
       ...options,
@@ -93,6 +165,12 @@ export class Materials extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.search();
+   * ```
+   */
   search(options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/materials/search', {
       ...options,
@@ -101,7 +179,294 @@ export class Materials extends APIResource {
   }
 }
 
-export interface MaterialCreateParams {}
+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;
+
+  /**
+   * 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 MaterialCreateResponse {
+  /**
+   * Material content
+   */
+  export interface Content {
+    filename?: string;
+
+    fileSize?: number;
+
+    mimeType?: string;
+
+    s3Key?: string;
+
+    s3Url?: string;
+
+    text?: string;
+
+    url?: string;
+  }
+}
+
+export interface MaterialRetrieveResponse {
+  /**
+   * Material ID
+   */
+  _id: string;
+
+  /**
+   * Material content
+   */
+  content: MaterialRetrieveResponse.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 MaterialRetrieveResponse {
+  /**
+   * Material content
+   */
+  export interface Content {
+    filename?: string;
+
+    fileSize?: number;
+
+    mimeType?: string;
+
+    s3Key?: string;
+
+    s3Url?: string;
+
+    text?: string;
+
+    url?: string;
+  }
+}
+
+export type MaterialListResponse = Array<MaterialListResponse.MaterialListResponseItem>;
+
+export namespace MaterialListResponse {
+  export interface MaterialListResponseItem {
+    /**
+     * Material ID
+     */
+    _id: string;
+
+    /**
+     * Material content
+     */
+    content: MaterialListResponseItem.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 MaterialListResponseItem {
+    /**
+     * Material content
+     */
+    export interface Content {
+      filename?: string;
+
+      fileSize?: number;
+
+      mimeType?: string;
+
+      s3Key?: string;
+
+      s3Url?: string;
+
+      text?: string;
+
+      url?: string;
+    }
+  }
+}
+
+export interface MaterialCreateParams {
+  /**
+   * Content details
+   */
+  content: MaterialCreateParams.Content;
+
+  /**
+   * Name of the material
+   */
+  name: string;
+
+  /**
+   * Folder ID to place the material in
+   */
+  folderId?: string;
+}
+
+export namespace MaterialCreateParams {
+  /**
+   * Content details
+   */
+  export 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
+   */
+  folderId?: string;
+}
 
 export interface MaterialGetDownloadURLParams {
   expiresIn: string;
@@ -113,11 +478,21 @@ Materials.Test = Test;
 
 export declare namespace Materials {
   export {
+    type MaterialCreateResponse as MaterialCreateResponse,
+    type MaterialRetrieveResponse as MaterialRetrieveResponse,
+    type MaterialListResponse as MaterialListResponse,
     type MaterialCreateParams as MaterialCreateParams,
+    type MaterialListParams as MaterialListParams,
     type MaterialGetDownloadURLParams as MaterialGetDownloadURLParams,
   };
 
-  export { Upload as Upload };
+  export {
+    Upload as Upload,
+    type UploadUploadFileResponse as UploadUploadFileResponse,
+    type UploadUploadFromURLResponse as UploadUploadFromURLResponse,
+    type UploadUploadFileParams as UploadUploadFileParams,
+    type UploadUploadFromURLParams as UploadUploadFromURLParams,
+  };
 
   export { Bulk as Bulk };
 

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

@@ -6,28 +6,52 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 
 export class Test extends APIResource {
-  epubProcessing(options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/api/v1/materials/test/epub-processing', {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.test.performOcr();
+   * ```
+   */
+  performOcr(options?: RequestOptions): APIPromise<void> {
+    return this._client.post('/api/v1/materials/test/ocr', {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  imageProcessing(options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/api/v1/materials/test/image-processing', {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.test.processEpub();
+   * ```
+   */
+  processEpub(options?: RequestOptions): APIPromise<void> {
+    return this._client.post('/api/v1/materials/test/epub-processing', {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  ocr(options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/api/v1/materials/test/ocr', {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.test.processImage();
+   * ```
+   */
+  processImage(options?: RequestOptions): APIPromise<void> {
+    return this._client.post('/api/v1/materials/test/image-processing', {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  videoProcessing(options?: RequestOptions): APIPromise<void> {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.test.processVideo();
+   * ```
+   */
+  processVideo(options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/materials/test/video-processing', {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),