@studyfetch/sdk 1.35.0 → 1.37.0

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,

package/src/resources/v1/components.ts

@@ -12,14 +12,16 @@ export class Components extends APIResource {
    *
    * @example
    * ```ts
-   * const component = await client.v1.components.create({
-   *   config: { model: 'gpt-4o-mini-2024-07-18' },
-   *   name: 'My Study Component',
-   *   type: 'chat',
-   * });
+   * const componentResponse = await client.v1.components.create(
+   *   {
+   *     config: { model: 'gpt-4o-mini-2024-07-18' },
+   *     name: 'My Study Component',
+   *     type: 'chat',
+   *   },
+   * );
    * ```
    */
-  create(body: ComponentCreateParams, options?: RequestOptions): APIPromise<ComponentCreateResponse> {
+  create(body: ComponentCreateParams, options?: RequestOptions): APIPromise<ComponentResponse> {
     return this._client.post('/api/v1/components', { body, ...options });
   }
 
@@ -28,10 +30,11 @@ export class Components extends APIResource {
    *
    * @example
    * ```ts
-   * const component = await client.v1.components.retrieve('id');
+   * const componentResponse =
+   *   await client.v1.components.retrieve('id');
    * ```
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<ComponentRetrieveResponse> {
+  retrieve(id: string, options?: RequestOptions): APIPromise<ComponentResponse> {
     return this._client.get(path`/api/v1/components/${id}`, options);
   }
 
@@ -40,14 +43,12 @@ export class Components extends APIResource {
    *
    * @example
    * ```ts
-   * const component = await client.v1.components.update('id');
+   * const componentResponse = await client.v1.components.update(
+   *   'id',
+   * );
    * ```
    */
-  update(
-    id: string,
-    body: ComponentUpdateParams,
-    options?: RequestOptions,
-  ): APIPromise<ComponentUpdateResponse> {
+  update(id: string, body: ComponentUpdateParams, options?: RequestOptions): APIPromise<ComponentResponse> {
     return this._client.patch(path`/api/v1/components/${id}`, { body, ...options });
   }
 
@@ -56,7 +57,8 @@ export class Components extends APIResource {
    *
    * @example
    * ```ts
-   * const components = await client.v1.components.list();
+   * const componentResponses =
+   *   await client.v1.components.list();
    * ```
    */
   list(
@@ -139,141 +141,7 @@ export class Components extends APIResource {
   }
 }
 
-export interface ComponentCreateResponse {
-  /**
-   * Component ID (MongoDB ObjectId)
-   */
-  _id: string;
-
-  /**
-   * Unique component identifier
-   */
-  componentId: string;
-
-  /**
-   * Component configuration
-   */
-  config: unknown;
-
-  /**
-   * Creation timestamp
-   */
-  createdAt: string;
-
-  /**
-   * Component name
-   */
-  name: string;
-
-  /**
-   * Organization ID
-   */
-  organization: string;
-
-  /**
-   * Component status
-   */
-  status: 'active' | 'inactive' | 'draft';
-
-  /**
-   * Component type
-   */
-  type:
-    | 'chat'
-    | 'data_analyst'
-    | 'flashcards'
-    | 'scenarios'
-    | 'practice_test'
-    | 'audio_recap'
-    | 'tutor_me'
-    | 'explainers'
-    | 'uploads'
-    | 'chat_analytics';
-
-  /**
-   * Last update timestamp
-   */
-  updatedAt: string;
-
-  /**
-   * Usage statistics
-   */
-  usage: unknown;
-
-  /**
-   * Component description
-   */
-  description?: string;
-}
-
-export interface ComponentRetrieveResponse {
-  /**
-   * Component ID (MongoDB ObjectId)
-   */
-  _id: string;
-
-  /**
-   * Unique component identifier
-   */
-  componentId: string;
-
-  /**
-   * Component configuration
-   */
-  config: unknown;
-
-  /**
-   * Creation timestamp
-   */
-  createdAt: string;
-
-  /**
-   * Component name
-   */
-  name: string;
-
-  /**
-   * Organization ID
-   */
-  organization: string;
-
-  /**
-   * Component status
-   */
-  status: 'active' | 'inactive' | 'draft';
-
-  /**
-   * Component type
-   */
-  type:
-    | 'chat'
-    | 'data_analyst'
-    | 'flashcards'
-    | 'scenarios'
-    | 'practice_test'
-    | 'audio_recap'
-    | 'tutor_me'
-    | 'explainers'
-    | 'uploads'
-    | 'chat_analytics';
-
-  /**
-   * Last update timestamp
-   */
-  updatedAt: string;
-
-  /**
-   * Usage statistics
-   */
-  usage: unknown;
-
-  /**
-   * Component description
-   */
-  description?: string;
-}
-
-export interface ComponentUpdateResponse {
+export interface ComponentResponse {
   /**
    * Component ID (MongoDB ObjectId)
    */
@@ -340,76 +208,7 @@ export interface ComponentUpdateResponse {
   description?: string;
 }
 
-export type ComponentListResponse = Array<ComponentListResponse.ComponentListResponseItem>;
-
-export namespace ComponentListResponse {
-  export interface ComponentListResponseItem {
-    /**
-     * Component ID (MongoDB ObjectId)
-     */
-    _id: string;
-
-    /**
-     * Unique component identifier
-     */
-    componentId: string;
-
-    /**
-     * Component configuration
-     */
-    config: unknown;
-
-    /**
-     * Creation timestamp
-     */
-    createdAt: string;
-
-    /**
-     * Component name
-     */
-    name: string;
-
-    /**
-     * Organization ID
-     */
-    organization: string;
-
-    /**
-     * Component status
-     */
-    status: 'active' | 'inactive' | 'draft';
-
-    /**
-     * Component type
-     */
-    type:
-      | 'chat'
-      | 'data_analyst'
-      | 'flashcards'
-      | 'scenarios'
-      | 'practice_test'
-      | 'audio_recap'
-      | 'tutor_me'
-      | 'explainers'
-      | 'uploads'
-      | 'chat_analytics';
-
-    /**
-     * Last update timestamp
-     */
-    updatedAt: string;
-
-    /**
-     * Usage statistics
-     */
-    usage: unknown;
-
-    /**
-     * Component description
-     */
-    description?: string;
-  }
-}
+export type ComponentListResponse = Array<ComponentResponse>;
 
 export interface ComponentGenerateEmbedResponse {
   /**
@@ -1361,9 +1160,7 @@ export namespace ComponentGenerateEmbedParams {
 
 export declare namespace Components {
   export {
-    type ComponentCreateResponse as ComponentCreateResponse,
-    type ComponentRetrieveResponse as ComponentRetrieveResponse,
-    type ComponentUpdateResponse as ComponentUpdateResponse,
+    type ComponentResponse as ComponentResponse,
     type ComponentListResponse as ComponentListResponse,
     type ComponentGenerateEmbedResponse as ComponentGenerateEmbedResponse,
     type ComponentCreateParams as ComponentCreateParams,