@studyfetch/sdk 1.36.0 → 1.38.0

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

@@ -12,17 +12,14 @@ export class RubricTemplates extends APIResource {
    *
    * @example
    * ```ts
-   * const rubricTemplate =
+   * const rubricTemplateResponse =
    *   await client.v1.assignmentGrader.rubricTemplates.create({
    *     criteria: [{ pointsPossible: 0, title: 'title' }],
    *     name: 'name',
    *   });
    * ```
    */
-  create(
-    body: RubricTemplateCreateParams,
-    options?: RequestOptions,
-  ): APIPromise<RubricTemplateCreateResponse> {
+  create(body: RubricTemplateCreateParams, options?: RequestOptions): APIPromise<RubricTemplateResponse> {
     return this._client.post('/api/v1/assignment-grader/rubric-templates', { body, ...options });
   }
 
@@ -31,7 +28,7 @@ export class RubricTemplates extends APIResource {
    *
    * @example
    * ```ts
-   * const rubricTemplates =
+   * const rubricTemplateResponses =
    *   await client.v1.assignmentGrader.rubricTemplates.list();
    * ```
    */
@@ -61,144 +58,35 @@ export class RubricTemplates extends APIResource {
    *
    * @example
    * ```ts
-   * const response =
+   * const rubricTemplateResponse =
    *   await client.v1.assignmentGrader.rubricTemplates.getByID(
    *     'id',
    *   );
    * ```
    */
-  getByID(id: string, options?: RequestOptions): APIPromise<RubricTemplateGetByIDResponse> {
+  getByID(id: string, options?: RequestOptions): APIPromise<RubricTemplateResponse> {
     return this._client.get(path`/api/v1/assignment-grader/rubric-templates/${id}`, options);
   }
 }
 
-export interface RubricTemplateCreateResponse {
+export interface RubricCriterion {
   /**
-   * Template ID
+   * Points possible for this criterion
    */
-  _id: string;
+  pointsPossible: number;
 
   /**
-   * Creation timestamp
+   * Title of the criterion
    */
-  createdAt: string;
+  title: string;
 
   /**
-   * Created by user ID
-   */
-  createdBy: string;
-
-  /**
-   * Grading criteria
-   */
-  criteria: Array<RubricTemplateCreateResponse.Criterion>;
-
-  /**
-   * Template name
-   */
-  name: string;
-
-  /**
-   * Organization ID
-   */
-  organizationId: string;
-
-  /**
-   * Update timestamp
-   */
-  updatedAt: string;
-
-  /**
-   * Template description
+   * Description of the criterion
    */
   description?: string;
 }
 
-export namespace RubricTemplateCreateResponse {
-  export interface Criterion {
-    /**
-     * Points possible for this criterion
-     */
-    pointsPossible: number;
-
-    /**
-     * Title of the criterion
-     */
-    title: string;
-
-    /**
-     * Description of the criterion
-     */
-    description?: string;
-  }
-}
-
-export type RubricTemplateListResponse = Array<RubricTemplateListResponse.RubricTemplateListResponseItem>;
-
-export namespace RubricTemplateListResponse {
-  export interface RubricTemplateListResponseItem {
-    /**
-     * Template ID
-     */
-    _id: string;
-
-    /**
-     * Creation timestamp
-     */
-    createdAt: string;
-
-    /**
-     * Created by user ID
-     */
-    createdBy: string;
-
-    /**
-     * Grading criteria
-     */
-    criteria: Array<RubricTemplateListResponseItem.Criterion>;
-
-    /**
-     * Template name
-     */
-    name: string;
-
-    /**
-     * Organization ID
-     */
-    organizationId: string;
-
-    /**
-     * Update timestamp
-     */
-    updatedAt: string;
-
-    /**
-     * Template description
-     */
-    description?: string;
-  }
-
-  export namespace RubricTemplateListResponseItem {
-    export interface Criterion {
-      /**
-       * Points possible for this criterion
-       */
-      pointsPossible: number;
-
-      /**
-       * Title of the criterion
-       */
-      title: string;
-
-      /**
-       * Description of the criterion
-       */
-      description?: string;
-    }
-  }
-}
-
-export interface RubricTemplateGetByIDResponse {
+export interface RubricTemplateResponse {
   /**
    * Template ID
    */
@@ -217,7 +105,7 @@ export interface RubricTemplateGetByIDResponse {
   /**
    * Grading criteria
    */
-  criteria: Array<RubricTemplateGetByIDResponse.Criterion>;
+  criteria: Array<RubricCriterion>;
 
   /**
    * Template name
@@ -240,30 +128,13 @@ export interface RubricTemplateGetByIDResponse {
   description?: string;
 }
 
-export namespace RubricTemplateGetByIDResponse {
-  export interface Criterion {
-    /**
-     * Points possible for this criterion
-     */
-    pointsPossible: number;
-
-    /**
-     * Title of the criterion
-     */
-    title: string;
-
-    /**
-     * Description of the criterion
-     */
-    description?: string;
-  }
-}
+export type RubricTemplateListResponse = Array<RubricTemplateResponse>;
 
 export interface RubricTemplateCreateParams {
   /**
    * Grading criteria
    */
-  criteria: Array<RubricTemplateCreateParams.Criterion>;
+  criteria: Array<RubricCriterion>;
 
   /**
    * Name of the rubric template
@@ -276,30 +147,11 @@ export interface RubricTemplateCreateParams {
   description?: string;
 }
 
-export namespace RubricTemplateCreateParams {
-  export interface Criterion {
-    /**
-     * Points possible for this criterion
-     */
-    pointsPossible: number;
-
-    /**
-     * Title of the criterion
-     */
-    title: string;
-
-    /**
-     * Description of the criterion
-     */
-    description?: string;
-  }
-}
-
 export declare namespace RubricTemplates {
   export {
-    type RubricTemplateCreateResponse as RubricTemplateCreateResponse,
+    type RubricCriterion as RubricCriterion,
+    type RubricTemplateResponse as RubricTemplateResponse,
     type RubricTemplateListResponse as RubricTemplateListResponse,
-    type RubricTemplateGetByIDResponse as RubricTemplateGetByIDResponse,
     type RubricTemplateCreateParams as RubricTemplateCreateParams,
   };
 }

package/src/resources/v1/chat-analytics.ts

@@ -13,13 +13,14 @@ export class ChatAnalytics extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.v1.chatAnalytics.analyze();
+   * const chatAnalyticsResponse =
+   *   await client.v1.chatAnalytics.analyze();
    * ```
    */
   analyze(
     query: ChatAnalyticAnalyzeParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ChatAnalyticAnalyzeResponse> {
+  ): APIPromise<ChatAnalyticsResponse> {
     return this._client.get('/api/v1/chat-analytics/analyze', { query, ...options });
   }
 
@@ -47,21 +48,20 @@ export class ChatAnalytics extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.v1.chatAnalytics.getComponent(
-   *   'componentId',
-   * );
+   * const chatAnalyticsResponse =
+   *   await client.v1.chatAnalytics.getComponent('componentId');
    * ```
    */
   getComponent(
     componentID: string,
     query: ChatAnalyticGetComponentParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ChatAnalyticGetComponentResponse> {
+  ): APIPromise<ChatAnalyticsResponse> {
     return this._client.get(path`/api/v1/chat-analytics/component/${componentID}`, { query, ...options });
   }
 }
 
-export interface ChatAnalyticAnalyzeResponse {
+export interface ChatAnalyticsResponse {
   /**
    * Date when analytics were generated
    */
@@ -70,15 +70,15 @@ export interface ChatAnalyticAnalyzeResponse {
   /**
    * Analytics summary
    */
-  summary: ChatAnalyticAnalyzeResponse.Summary;
+  summary: ChatAnalyticsResponse.Summary;
 
   /**
    * User statistics
    */
-  userStats: Array<ChatAnalyticAnalyzeResponse.UserStat>;
+  userStats: Array<ChatAnalyticsResponse.UserStat>;
 }
 
-export namespace ChatAnalyticAnalyzeResponse {
+export namespace ChatAnalyticsResponse {
   /**
    * Analytics summary
    */
@@ -179,122 +179,6 @@ export namespace ChatAnalyticAnalyzeResponse {
 
 export type ChatAnalyticExportResponse = Uploadable;
 
-export interface ChatAnalyticGetComponentResponse {
-  /**
-   * Date when analytics were generated
-   */
-  generatedAt: string;
-
-  /**
-   * Analytics summary
-   */
-  summary: ChatAnalyticGetComponentResponse.Summary;
-
-  /**
-   * User statistics
-   */
-  userStats: Array<ChatAnalyticGetComponentResponse.UserStat>;
-}
-
-export namespace ChatAnalyticGetComponentResponse {
-  /**
-   * Analytics summary
-   */
-  export interface Summary {
-    /**
-     * Average messages per user
-     */
-    averageMessagesPerUser: number;
-
-    /**
-     * Engagement metrics
-     */
-    engagement: unknown;
-
-    /**
-     * Natural language summary of chat usage
-     */
-    summary: string;
-
-    /**
-     * Top topics discussed
-     */
-    topTopics: Array<string>;
-
-    /**
-     * Total messages
-     */
-    totalMessages: number;
-
-    /**
-     * Total chat sessions
-     */
-    totalSessions: number;
-
-    /**
-     * Total unique users
-     */
-    totalUsers: number;
-  }
-
-  export interface UserStat {
-    /**
-     * Average messages per session
-     */
-    averageMessagesPerSession: number;
-
-    /**
-     * Average session duration in minutes
-     */
-    averageSessionDuration: number;
-
-    /**
-     * First active date
-     */
-    firstActive: string;
-
-    /**
-     * Last active date
-     */
-    lastActive: string;
-
-    /**
-     * Top topics discussed
-     */
-    topTopics: Array<string>;
-
-    /**
-     * Total messages sent by user
-     */
-    totalMessages: number;
-
-    /**
-     * Total chat sessions
-     */
-    totalSessions: number;
-
-    /**
-     * User ID
-     */
-    userId: string;
-
-    /**
-     * User email
-     */
-    email?: string;
-
-    /**
-     * Group IDs associated with the user
-     */
-    groupIds?: Array<string>;
-
-    /**
-     * User name
-     */
-    name?: string;
-  }
-}
-
 export interface ChatAnalyticAnalyzeParams {
   /**
    * Component ID to analyze
@@ -403,9 +287,8 @@ export interface ChatAnalyticGetComponentParams {
 
 export declare namespace ChatAnalytics {
   export {
-    type ChatAnalyticAnalyzeResponse as ChatAnalyticAnalyzeResponse,
+    type ChatAnalyticsResponse as ChatAnalyticsResponse,
     type ChatAnalyticExportResponse as ChatAnalyticExportResponse,
-    type ChatAnalyticGetComponentResponse as ChatAnalyticGetComponentResponse,
     type ChatAnalyticAnalyzeParams as ChatAnalyticAnalyzeParams,
     type ChatAnalyticExportParams as ChatAnalyticExportParams,
     type ChatAnalyticGetComponentParams as ChatAnalyticGetComponentParams,