@studyfetch/sdk 1.11.0 → 1.13.0

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

@@ -6,13 +6,7 @@ import { Bulk } from './bulk';
 import * as TestAPI from './test';
 import { Test } from './test';
 import * as UploadAPI from './upload';
-import {
-  Upload,
-  UploadUploadFileParams,
-  UploadUploadFileResponse,
-  UploadUploadFromURLParams,
-  UploadUploadFromURLResponse,
-} from './upload';
+import { Upload, UploadUploadFileParams, UploadUploadFromURLParams } from './upload';
 import { APIPromise } from '../../../core/api-promise';
 import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
@@ -34,7 +28,7 @@ export class Materials extends APIResource {
    * });
    * ```
    */
-  create(body: MaterialCreateParams, options?: RequestOptions): APIPromise<MaterialCreateResponse> {
+  create(body: MaterialCreateParams, options?: RequestOptions): APIPromise<Material> {
     return this._client.post('/api/v1/materials', { body, ...options });
   }
 
@@ -46,7 +40,7 @@ export class Materials extends APIResource {
    * const material = await client.v1.materials.retrieve('id');
    * ```
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<MaterialRetrieveResponse> {
+  retrieve(id: string, options?: RequestOptions): APIPromise<Material> {
     return this._client.get(path`/api/v1/materials/${id}`, options);
   }
 
@@ -83,10 +77,10 @@ export class Materials extends APIResource {
   /**
    * @example
    * ```ts
-   * await client.v1.materials.createBatch();
+   * await client.v1.materials.batchCreate();
    * ```
    */
-  createBatch(options?: RequestOptions): APIPromise<void> {
+  batchCreate(options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/materials/batch', {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
@@ -179,7 +173,7 @@ export class Materials extends APIResource {
   }
 }
 
-export interface MaterialCreateResponse {
+export interface Material {
   /**
    * Material ID
    */
@@ -188,7 +182,7 @@ export interface MaterialCreateResponse {
   /**
    * Material content
    */
-  content: MaterialCreateResponse.Content;
+  content: Material.Content;
 
   /**
    * Content type
@@ -236,7 +230,7 @@ export interface MaterialCreateResponse {
   usage?: unknown;
 }
 
-export namespace MaterialCreateResponse {
+export namespace Material {
   /**
    * Material content
    */
@@ -257,165 +251,7 @@ export namespace MaterialCreateResponse {
   }
 }
 
-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 type MaterialListResponse = Array<Material>;
 
 export interface MaterialCreateParams {
   /**
@@ -478,8 +314,7 @@ Materials.Test = Test;
 
 export declare namespace Materials {
   export {
-    type MaterialCreateResponse as MaterialCreateResponse,
-    type MaterialRetrieveResponse as MaterialRetrieveResponse,
+    type Material as Material,
     type MaterialListResponse as MaterialListResponse,
     type MaterialCreateParams as MaterialCreateParams,
     type MaterialListParams as MaterialListParams,
@@ -488,8 +323,6 @@ export declare namespace Materials {
 
   export {
     Upload as Upload,
-    type UploadUploadFileResponse as UploadUploadFileResponse,
-    type UploadUploadFromURLResponse as UploadUploadFromURLResponse,
     type UploadUploadFileParams as UploadUploadFileParams,
     type UploadUploadFromURLParams as UploadUploadFromURLParams,
   };

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

@@ -1,6 +1,7 @@
 // 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 { buildHeaders } from '../../../internal/headers';
@@ -24,10 +25,10 @@ export class Upload extends APIResource {
   /**
    * @example
    * ```ts
-   * await client.v1.materials.upload.getPresignedURL();
+   * await client.v1.materials.upload.createPresignedURL();
    * ```
    */
-  getPresignedURL(options?: RequestOptions): APIPromise<void> {
+  createPresignedURL(options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/materials/upload/presigned-url', {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
@@ -39,14 +40,14 @@ export class Upload extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
+   * const material =
    *   await client.v1.materials.upload.uploadFile({
    *     file: fs.createReadStream('path/to/file'),
    *     name: 'name',
    *   });
    * ```
    */
-  uploadFile(body: UploadUploadFileParams, options?: RequestOptions): APIPromise<UploadUploadFileResponse> {
+  uploadFile(body: UploadUploadFileParams, options?: RequestOptions): APIPromise<MaterialsAPI.Material> {
     return this._client.post(
       '/api/v1/materials/upload',
       multipartFormRequestOptions({ body, ...options }, this._client),
@@ -58,7 +59,7 @@ export class Upload extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
+   * const material =
    *   await client.v1.materials.upload.uploadFromURL({
    *     name: 'name',
    *     url: 'url',
@@ -68,167 +69,11 @@ export class Upload extends APIResource {
   uploadFromURL(
     body: UploadUploadFromURLParams,
     options?: RequestOptions,
-  ): APIPromise<UploadUploadFromURLResponse> {
+  ): APIPromise<MaterialsAPI.Material> {
     return this._client.post('/api/v1/materials/upload/url', { body, ...options });
   }
 }
 
-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;
-
-  /**
-   * 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 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;
-
-  /**
-   * 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 UploadUploadFileParams {
   file: Uploadable;
 
@@ -262,8 +107,6 @@ export interface UploadUploadFromURLParams {
 
 export declare namespace Upload {
   export {
-    type UploadUploadFileResponse as UploadUploadFileResponse,
-    type UploadUploadFromURLResponse as UploadUploadFromURLResponse,
     type UploadUploadFileParams as UploadUploadFileParams,
     type UploadUploadFromURLParams as UploadUploadFromURLParams,
   };

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

@@ -3,9 +3,10 @@
 export { Component, type ComponentUpdateParams } from './component';
 export {
   Scenarios,
+  type Scenario,
   type ScenarioCreateParams,
   type ScenarioUpdateParams,
-  type ScenarioSubmitParams,
+  type ScenarioSubmitAnswerParams,
 } from './scenarios';
 export { Sessions } from './sessions';
 export { Submissions } from './submissions/index';

package/src/resources/v1/scenarios/scenarios.ts

@@ -118,12 +118,12 @@ export class Scenarios extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.scenarios.submit('id', {
+   * await client.v1.scenarios.submitAnswer('id', {
    *   conversationHistory: [{}],
    * });
    * ```
    */
-  submit(id: string, body: ScenarioSubmitParams, options?: RequestOptions): APIPromise<void> {
+  submitAnswer(id: string, body: ScenarioSubmitAnswerParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/scenarios/${id}/submit`, {
       body,
       ...options,
@@ -132,6 +132,68 @@ export class Scenarios extends APIResource {
   }
 }
 
+export interface Scenario {
+  /**
+   * Associated component ID
+   */
+  componentId: string;
+
+  /**
+   * Scenario name
+   */
+  name: string;
+
+  /**
+   * Scenario characters
+   */
+  characters?: Array<unknown>;
+
+  /**
+   * Scenario context
+   */
+  context?: string;
+
+  /**
+   * Scenario description
+   */
+  description?: string;
+
+  /**
+   * Prompt for final answer
+   */
+  finalAnswerPrompt?: string;
+
+  /**
+   * Interaction format
+   */
+  format?: string;
+
+  /**
+   * Scenario goal
+   */
+  goal?: string;
+
+  /**
+   * Character ID for greeting
+   */
+  greetingCharacterId?: string;
+
+  /**
+   * Greeting message
+   */
+  greetingMessage?: string;
+
+  /**
+   * Whether scenario requires a final answer
+   */
+  requiresFinalAnswer?: boolean;
+
+  /**
+   * Available tools
+   */
+  tools?: Array<unknown>;
+}
+
 export interface ScenarioCreateParams {
   /**
    * Associated component ID
@@ -256,7 +318,7 @@ export interface ScenarioUpdateParams {
   tools?: Array<unknown>;
 }
 
-export interface ScenarioSubmitParams {
+export interface ScenarioSubmitAnswerParams {
   /**
    * Conversation history
    */
@@ -274,9 +336,10 @@ Scenarios.Submissions = Submissions;
 
 export declare namespace Scenarios {
   export {
+    type Scenario as Scenario,
     type ScenarioCreateParams as ScenarioCreateParams,
     type ScenarioUpdateParams as ScenarioUpdateParams,
-    type ScenarioSubmitParams as ScenarioSubmitParams,
+    type ScenarioSubmitAnswerParams as ScenarioSubmitAnswerParams,
   };
 
   export { Component as Component, type ComponentUpdateParams as ComponentUpdateParams };

package/src/resources/v1/scenarios/submissions/user.ts

@@ -10,11 +10,11 @@ export class User extends APIResource {
   /**
    * @example
    * ```ts
-   * await client.v1.scenarios.submissions.user.retrieve('id');
+   * await client.v1.scenarios.submissions.user.getAll();
    * ```
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.get(path`/api/v1/scenarios/${id}/submissions/user`, {
+  getAll(options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/api/v1/scenarios/submissions/user', {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -23,11 +23,13 @@ export class User extends APIResource {
   /**
    * @example
    * ```ts
-   * await client.v1.scenarios.submissions.user.list();
+   * await client.v1.scenarios.submissions.user.getByScenario(
+   *   'id',
+   * );
    * ```
    */
-  list(options?: RequestOptions): APIPromise<void> {
-    return this._client.get('/api/v1/scenarios/submissions/user', {
+  getByScenario(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.get(path`/api/v1/scenarios/${id}/submissions/user`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });