@studyfetch/sdk 1.17.0 → 1.19.0

package/src/resources/v1/assignment-grader.ts

@@ -11,7 +11,7 @@ export class AssignmentGrader extends APIResource {
    *
    * @example
    * ```ts
-   * const assignmentGrader =
+   * const assignmentGraderResponse =
    *   await client.v1.assignmentGrader.create({
    *     rubric: {
    *       criteria: [{ pointsPossible: 0, title: 'title' }],
@@ -20,10 +20,7 @@ export class AssignmentGrader extends APIResource {
    *   });
    * ```
    */
-  create(
-    body: AssignmentGraderCreateParams,
-    options?: RequestOptions,
-  ): APIPromise<AssignmentGraderCreateResponse> {
+  create(body: AssignmentGraderCreateParams, options?: RequestOptions): APIPromise<AssignmentGraderResponse> {
     return this._client.post('/api/v1/assignment-grader/create', { body, ...options });
   }
 
@@ -32,7 +29,8 @@ export class AssignmentGrader extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.v1.assignmentGrader.getAll();
+   * const assignmentGraderResponses =
+   *   await client.v1.assignmentGrader.getAll();
    * ```
    */
   getAll(options?: RequestOptions): APIPromise<AssignmentGraderGetAllResponse> {
@@ -44,17 +42,16 @@ export class AssignmentGrader extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.v1.assignmentGrader.getByID(
-   *   'id',
-   * );
+   * const assignmentGraderResponse =
+   *   await client.v1.assignmentGrader.getByID('id');
    * ```
    */
-  getByID(id: string, options?: RequestOptions): APIPromise<AssignmentGraderGetByIDResponse> {
+  getByID(id: string, options?: RequestOptions): APIPromise<AssignmentGraderResponse> {
     return this._client.get(path`/api/v1/assignment-grader/get/${id}`, options);
   }
 }
 
-export interface AssignmentGraderCreateResponse {
+export interface AssignmentGraderResponse {
   /**
    * Assignment grader ID
    */
@@ -81,64 +78,7 @@ export interface AssignmentGraderCreateResponse {
   title: string;
 }
 
-export type AssignmentGraderGetAllResponse =
-  Array<AssignmentGraderGetAllResponse.AssignmentGraderGetAllResponseItem>;
-
-export namespace AssignmentGraderGetAllResponse {
-  export interface AssignmentGraderGetAllResponseItem {
-    /**
-     * Assignment grader ID
-     */
-    id: string;
-
-    /**
-     * Creation timestamp
-     */
-    createdAt: string;
-
-    /**
-     * Overall grade percentage
-     */
-    grade: number;
-
-    /**
-     * Grading results
-     */
-    rubric: unknown;
-
-    /**
-     * Assignment title
-     */
-    title: string;
-  }
-}
-
-export interface AssignmentGraderGetByIDResponse {
-  /**
-   * Assignment grader ID
-   */
-  id: string;
-
-  /**
-   * Creation timestamp
-   */
-  createdAt: string;
-
-  /**
-   * Overall grade percentage
-   */
-  grade: number;
-
-  /**
-   * Grading results
-   */
-  rubric: unknown;
-
-  /**
-   * Assignment title
-   */
-  title: string;
-}
+export type AssignmentGraderGetAllResponse = Array<AssignmentGraderResponse>;
 
 export interface AssignmentGraderCreateParams {
   /**
@@ -205,9 +145,8 @@ export namespace AssignmentGraderCreateParams {
 
 export declare namespace AssignmentGrader {
   export {
-    type AssignmentGraderCreateResponse as AssignmentGraderCreateResponse,
+    type AssignmentGraderResponse as AssignmentGraderResponse,
     type AssignmentGraderGetAllResponse as AssignmentGraderGetAllResponse,
-    type AssignmentGraderGetByIDResponse as AssignmentGraderGetByIDResponse,
     type AssignmentGraderCreateParams as AssignmentGraderCreateParams,
   };
 }

package/src/resources/v1/index.ts

@@ -2,9 +2,8 @@
 
 export {
   AssignmentGrader,
-  type AssignmentGraderCreateResponse,
+  type AssignmentGraderResponse,
   type AssignmentGraderGetAllResponse,
-  type AssignmentGraderGetByIDResponse,
   type AssignmentGraderCreateParams,
 } from './assignment-grader';
 export {
@@ -53,6 +52,7 @@ export {
 export {
   Scenarios,
   type Scenario,
+  type UpdateScenario,
   type ScenarioCreateParams,
   type ScenarioUpdateParams,
   type ScenarioSubmitAnswerParams,
@@ -70,5 +70,5 @@ export {
   type UsageGetStatsParams,
   type UsageGetSummaryParams,
   type UsageListEventsParams,
-} from './usage';
+} from './usage/index';
 export { V1 } from './v1';

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

@@ -4,6 +4,7 @@ export { Component, type ComponentUpdateParams } from './component';
 export {
   Scenarios,
   type Scenario,
+  type UpdateScenario,
   type ScenarioCreateParams,
   type ScenarioUpdateParams,
   type ScenarioSubmitAnswerParams,

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

@@ -191,6 +191,63 @@ export interface Scenario {
   tools?: Array<unknown>;
 }
 
+export interface UpdateScenario {
+  /**
+   * 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
@@ -329,6 +386,7 @@ Scenarios.Submissions = Submissions;
 export declare namespace Scenarios {
   export {
     type Scenario as Scenario,
+    type UpdateScenario as UpdateScenario,
     type ScenarioCreateParams as ScenarioCreateParams,
     type ScenarioUpdateParams as ScenarioUpdateParams,
     type ScenarioSubmitAnswerParams as ScenarioSubmitAnswerParams,

package/src/resources/v1/usage/analyst.ts

@@ -0,0 +1,102 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+
+export class Analyst extends APIResource {
+  /**
+   * Get test results for users and groups in JWT
+   *
+   * @example
+   * ```ts
+   * await client.v1.usage.analyst.getTestQuestions();
+   * ```
+   */
+  getTestQuestions(options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/api/v1/usage-analyst/test-questions', {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get chat messages for users and groups in JWT
+   *
+   * @example
+   * ```ts
+   * await client.v1.usage.analyst.listChatMessages();
+   * ```
+   */
+  listChatMessages(options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/api/v1/usage-analyst/chat-messages', {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get all events based on filters
+   *
+   * @example
+   * ```ts
+   * await client.v1.usage.analyst.listEvents({
+   *   endDate: 'endDate',
+   *   eventType: 'material_created',
+   *   startDate: 'startDate',
+   * });
+   * ```
+   */
+  listEvents(query: AnalystListEventsParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/api/v1/usage-analyst/events', {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface AnalystListEventsParams {
+  /**
+   * End date for filtering (ISO 8601)
+   */
+  endDate: string;
+
+  /**
+   * Type of usage event to filter
+   */
+  eventType:
+    | 'material_created'
+    | 'material_uploaded'
+    | 'material_processed'
+    | 'material_deleted'
+    | 'component_created'
+    | 'component_accessed'
+    | 'component_deleted'
+    | 'component_usage'
+    | 'chat_message_sent'
+    | 'chat_session_started'
+    | 'chat_session_ended'
+    | 'test_created'
+    | 'test_started'
+    | 'test_completed'
+    | 'test_question_answered'
+    | 'test_retaken'
+    | 'audio_recap_create'
+    | 'assignment_grader_create'
+    | 'api_call'
+    | 'cache_hit'
+    | 'sso_login'
+    | 'sso_logout'
+    | 'student_performance';
+
+  /**
+   * Start date for filtering (ISO 8601)
+   */
+  startDate: string;
+}
+
+export declare namespace Analyst {
+  export { type AnalystListEventsParams as AnalystListEventsParams };
+}

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

@@ -0,0 +1,9 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Analyst, type AnalystListEventsParams } from './analyst';
+export {
+  Usage,
+  type UsageGetStatsParams,
+  type UsageGetSummaryParams,
+  type UsageListEventsParams,
+} from './usage';

package/src/resources/v1/usage/usage.ts

@@ -0,0 +1,188 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as AnalystAPI from './analyst';
+import { Analyst, AnalystListEventsParams } from './analyst';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+
+export class Usage extends APIResource {
+  analyst: AnalystAPI.Analyst = new AnalystAPI.Analyst(this._client);
+
+  /**
+   * Get usage statistics
+   *
+   * @example
+   * ```ts
+   * await client.v1.usage.getStats();
+   * ```
+   */
+  getStats(query: UsageGetStatsParams | null | undefined = {}, options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/api/v1/usage/stats', {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get usage summary
+   *
+   * @example
+   * ```ts
+   * await client.v1.usage.getSummary({
+   *   endDate: 'endDate',
+   *   period: 'hourly',
+   *   startDate: 'startDate',
+   * });
+   * ```
+   */
+  getSummary(query: UsageGetSummaryParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/api/v1/usage/summary', {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get usage events
+   *
+   * @example
+   * ```ts
+   * await client.v1.usage.listEvents();
+   * ```
+   */
+  listEvents(
+    query: UsageListEventsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.get('/api/v1/usage/events', {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface UsageGetStatsParams {
+  /**
+   * End date for stats (ISO 8601)
+   */
+  endDate?: string;
+
+  /**
+   * Filter by group ID
+   */
+  groupId?: string;
+
+  /**
+   * Start date for stats (ISO 8601)
+   */
+  startDate?: string;
+
+  /**
+   * Filter by user ID
+   */
+  userId?: string;
+}
+
+export interface UsageGetSummaryParams {
+  /**
+   * End date for summary (ISO 8601)
+   */
+  endDate: string;
+
+  /**
+   * Summary period
+   */
+  period: 'hourly' | 'daily' | 'monthly';
+
+  /**
+   * Start date for summary (ISO 8601)
+   */
+  startDate: string;
+
+  /**
+   * Group results by
+   */
+  groupBy?: 'user' | 'group' | 'model' | 'endpoint';
+}
+
+export interface UsageListEventsParams {
+  /**
+   * End date for filtering (ISO 8601)
+   */
+  endDate?: string;
+
+  /**
+   * Filter by event type
+   */
+  eventType?:
+    | 'material_created'
+    | 'material_uploaded'
+    | 'material_processed'
+    | 'material_deleted'
+    | 'component_created'
+    | 'component_accessed'
+    | 'component_deleted'
+    | 'component_usage'
+    | 'chat_message_sent'
+    | 'chat_session_started'
+    | 'chat_session_ended'
+    | 'test_created'
+    | 'test_started'
+    | 'test_completed'
+    | 'test_question_answered'
+    | 'test_retaken'
+    | 'audio_recap_create'
+    | 'assignment_grader_create'
+    | 'api_call'
+    | 'cache_hit'
+    | 'sso_login'
+    | 'sso_logout'
+    | 'student_performance';
+
+  /**
+   * Filter by group ID
+   */
+  groupId?: string;
+
+  /**
+   * Number of results to return
+   */
+  limit?: number;
+
+  /**
+   * Offset for pagination
+   */
+  offset?: number;
+
+  /**
+   * Filter by resource ID
+   */
+  resourceId?: string;
+
+  /**
+   * Start date for filtering (ISO 8601)
+   */
+  startDate?: string;
+
+  /**
+   * Filter by user ID
+   */
+  userId?: string;
+}
+
+Usage.Analyst = Analyst;
+
+export declare namespace Usage {
+  export {
+    type UsageGetStatsParams as UsageGetStatsParams,
+    type UsageGetSummaryParams as UsageGetSummaryParams,
+    type UsageListEventsParams as UsageListEventsParams,
+  };
+
+  export { Analyst as Analyst, type AnalystListEventsParams as AnalystListEventsParams };
+}

package/src/resources/v1/usage.ts

@@ -1,180 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../core/resource';
-import { APIPromise } from '../../core/api-promise';
-import { buildHeaders } from '../../internal/headers';
-import { RequestOptions } from '../../internal/request-options';
-
-export class Usage extends APIResource {
-  /**
-   * Get usage statistics
-   *
-   * @example
-   * ```ts
-   * await client.v1.usage.getStats();
-   * ```
-   */
-  getStats(query: UsageGetStatsParams | null | undefined = {}, options?: RequestOptions): APIPromise<void> {
-    return this._client.get('/api/v1/usage/stats', {
-      query,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-
-  /**
-   * Get usage summary
-   *
-   * @example
-   * ```ts
-   * await client.v1.usage.getSummary({
-   *   endDate: 'endDate',
-   *   period: 'hourly',
-   *   startDate: 'startDate',
-   * });
-   * ```
-   */
-  getSummary(query: UsageGetSummaryParams, options?: RequestOptions): APIPromise<void> {
-    return this._client.get('/api/v1/usage/summary', {
-      query,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-
-  /**
-   * Get usage events
-   *
-   * @example
-   * ```ts
-   * await client.v1.usage.listEvents();
-   * ```
-   */
-  listEvents(
-    query: UsageListEventsParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<void> {
-    return this._client.get('/api/v1/usage/events', {
-      query,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-}
-
-export interface UsageGetStatsParams {
-  /**
-   * End date for stats (ISO 8601)
-   */
-  endDate?: string;
-
-  /**
-   * Filter by group ID
-   */
-  groupId?: string;
-
-  /**
-   * Start date for stats (ISO 8601)
-   */
-  startDate?: string;
-
-  /**
-   * Filter by user ID
-   */
-  userId?: string;
-}
-
-export interface UsageGetSummaryParams {
-  /**
-   * End date for summary (ISO 8601)
-   */
-  endDate: string;
-
-  /**
-   * Summary period
-   */
-  period: 'hourly' | 'daily' | 'monthly';
-
-  /**
-   * Start date for summary (ISO 8601)
-   */
-  startDate: string;
-
-  /**
-   * Group results by
-   */
-  groupBy?: 'user' | 'group' | 'model' | 'endpoint';
-}
-
-export interface UsageListEventsParams {
-  /**
-   * End date for filtering (ISO 8601)
-   */
-  endDate?: string;
-
-  /**
-   * Filter by event type
-   */
-  eventType?:
-    | 'material_created'
-    | 'material_uploaded'
-    | 'material_processed'
-    | 'material_deleted'
-    | 'component_created'
-    | 'component_accessed'
-    | 'component_deleted'
-    | 'component_usage'
-    | 'chat_message_sent'
-    | 'chat_session_started'
-    | 'chat_session_ended'
-    | 'test_created'
-    | 'test_started'
-    | 'test_completed'
-    | 'test_question_answered'
-    | 'test_retaken'
-    | 'audio_recap_create'
-    | 'assignment_grader_create'
-    | 'api_call'
-    | 'cache_hit'
-    | 'sso_login'
-    | 'sso_logout'
-    | 'student_performance';
-
-  /**
-   * Filter by group ID
-   */
-  groupId?: string;
-
-  /**
-   * Number of results to return
-   */
-  limit?: number;
-
-  /**
-   * Offset for pagination
-   */
-  offset?: number;
-
-  /**
-   * Filter by resource ID
-   */
-  resourceId?: string;
-
-  /**
-   * Start date for filtering (ISO 8601)
-   */
-  startDate?: string;
-
-  /**
-   * Filter by user ID
-   */
-  userId?: string;
-}
-
-export declare namespace Usage {
-  export {
-    type UsageGetStatsParams as UsageGetStatsParams,
-    type UsageGetSummaryParams as UsageGetSummaryParams,
-    type UsageListEventsParams as UsageListEventsParams,
-  };
-}
+export * from './usage/index';