@studyfetch/sdk 1.1.1 → 1.3.0

package/src/resources/v1/usage.ts

@@ -6,44 +6,110 @@ import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
 
 export class Usage extends APIResource {
-  chat(body: UsageChatParams, options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/api/v1/usage/chat', {
-      body,
+  /**
+   * 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]),
     });
   }
 
-  listEvents(options?: RequestOptions): APIPromise<void> {
-    return this._client.get('/api/v1/usage/events', {
+  /**
+   * 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]),
     });
   }
 
-  performance(options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/api/v1/usage/performance', {
+  /**
+   * 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]),
     });
   }
 
-  retrieveStats(options?: RequestOptions): APIPromise<void> {
-    return this._client.get('/api/v1/usage/stats', {
+  /**
+   * Track chat usage
+   *
+   * @example
+   * ```ts
+   * await client.v1.usage.trackChat({
+   *   inputTokens: 0,
+   *   model: 'openai:gpt-4.1',
+   *   outputTokens: 0,
+   *   sessionId: 'sessionId',
+   * });
+   * ```
+   */
+  trackChat(body: UsageTrackChatParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post('/api/v1/usage/chat', {
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  retrieveSummary(options?: RequestOptions): APIPromise<void> {
-    return this._client.get('/api/v1/usage/summary', {
+  /**
+   * Track general usage event
+   *
+   * @example
+   * ```ts
+   * await client.v1.usage.trackEvent({
+   *   eventType: 'material_created',
+   * });
+   * ```
+   */
+  trackEvent(body: UsageTrackEventParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post('/api/v1/usage/track', {
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  track(body: UsageTrackParams, options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/api/v1/usage/track', {
+  /**
+   * Track performance metrics
+   *
+   * @example
+   * ```ts
+   * await client.v1.usage.trackPerformance();
+   * ```
+   */
+  trackPerformance(body: UsageTrackPerformanceParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post('/api/v1/usage/performance', {
       body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
@@ -51,10 +117,359 @@ export class Usage extends APIResource {
   }
 }
 
-export interface UsageChatParams {}
+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'
+    | '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 interface UsageTrackChatParams {
+  /**
+   * Number of input tokens
+   */
+  inputTokens: number;
+
+  /**
+   * AI model used
+   */
+  model:
+    | 'openai:gpt-4.1'
+    | 'openai:gpt-4o'
+    | 'openai:gpt-4o-mini'
+    | 'openai:gpt-4'
+    | 'openai:gpt-3.5-turbo'
+    | 'openai:o1'
+    | 'openai:o1-mini'
+    | 'openai:o3-mini'
+    | 'anthropic:claude-3-opus'
+    | 'anthropic:claude-3-sonnet'
+    | 'anthropic:claude-3-haiku'
+    | 'google:gemini-pro'
+    | 'meta:llama-3';
+
+  /**
+   * Number of output tokens
+   */
+  outputTokens: number;
+
+  /**
+   * Chat session ID
+   */
+  sessionId: string;
+
+  /**
+   * Component ID
+   */
+  componentId?: string;
+
+  /**
+   * Group ID
+   */
+  groupId?: string;
+
+  /**
+   * Additional metadata
+   */
+  metadata?: unknown;
+
+  /**
+   * Number of reasoning tokens
+   */
+  reasoningTokens?: number;
+
+  /**
+   * User ID
+   */
+  userId?: string;
+}
+
+export interface UsageTrackEventParams {
+  /**
+   * Type of usage event
+   */
+  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'
+    | 'api_call'
+    | 'cache_hit'
+    | 'sso_login'
+    | 'sso_logout'
+    | 'student_performance';
+
+  /**
+   * Whether response was served from cache
+   */
+  cacheHit?: boolean;
+
+  /**
+   * Component name
+   */
+  componentName?: string;
+
+  /**
+   * Component type
+   */
+  componentType?: string;
+
+  /**
+   * Size of content in bytes
+   */
+  contentSize?: number;
+
+  /**
+   * API endpoint accessed
+   */
+  endpoint?: string;
+
+  /**
+   * File size in bytes
+   */
+  fileSize?: number;
+
+  /**
+   * File MIME type
+   */
+  fileType?: string;
+
+  /**
+   * Group ID for collaborative sessions
+   */
+  groupId?: string;
+
+  /**
+   * Number of input tokens
+   */
+  inputTokens?: number;
+
+  /**
+   * Client IP address
+   */
+  ipAddress?: string;
+
+  /**
+   * Additional metadata
+   */
+  metadata?: unknown;
+
+  /**
+   * HTTP method used
+   */
+  method?: string;
+
+  /**
+   * AI model used
+   */
+  model?:
+    | 'openai:gpt-4.1'
+    | 'openai:gpt-4o'
+    | 'openai:gpt-4o-mini'
+    | 'openai:gpt-4'
+    | 'openai:gpt-3.5-turbo'
+    | 'openai:o1'
+    | 'openai:o1-mini'
+    | 'openai:o3-mini'
+    | 'anthropic:claude-3-opus'
+    | 'anthropic:claude-3-sonnet'
+    | 'anthropic:claude-3-haiku'
+    | 'google:gemini-pro'
+    | 'meta:llama-3';
+
+  /**
+   * Number of output tokens
+   */
+  outputTokens?: number;
+
+  /**
+   * Performance metrics data
+   */
+  performanceData?: unknown;
+
+  /**
+   * Number of reasoning tokens
+   */
+  reasoningTokens?: number;
+
+  /**
+   * Resource ID being accessed
+   */
+  resourceId?: string;
+
+  /**
+   * Type of resource
+   */
+  resourceType?: string;
+
+  /**
+   * Response time in milliseconds
+   */
+  responseTime?: number;
+
+  /**
+   * Session ID
+   */
+  sessionId?: string;
+
+  /**
+   * HTTP status code
+   */
+  statusCode?: number;
+
+  /**
+   * Total number of tokens
+   */
+  totalTokens?: number;
+
+  /**
+   * Client user agent
+   */
+  userAgent?: string;
+
+  /**
+   * User ID
+   */
+  userId?: string;
+}
+
+export interface UsageTrackPerformanceParams {
+  componentId?: string;
+
+  metrics?: UsageTrackPerformanceParams.Metrics;
+}
 
-export interface UsageTrackParams {}
+export namespace UsageTrackPerformanceParams {
+  export interface Metrics {
+    interactionTime?: number;
+
+    loadTime?: number;
+
+    renderTime?: number;
+  }
+}
 
 export declare namespace Usage {
-  export { type UsageChatParams as UsageChatParams, type UsageTrackParams as UsageTrackParams };
+  export {
+    type UsageGetStatsParams as UsageGetStatsParams,
+    type UsageGetSummaryParams as UsageGetSummaryParams,
+    type UsageListEventsParams as UsageListEventsParams,
+    type UsageTrackChatParams as UsageTrackChatParams,
+    type UsageTrackEventParams as UsageTrackEventParams,
+    type UsageTrackPerformanceParams as UsageTrackPerformanceParams,
+  };
 }

package/src/resources/v1/v1.ts

@@ -4,24 +4,42 @@ import { APIResource } from '../../core/resource';
 import * as ComponentsAPI from './components';
 import {
   ComponentCreateParams,
+  ComponentCreateResponse,
   ComponentEmbedParams,
+  ComponentEmbedResponse,
   ComponentListParams,
+  ComponentListResponse,
+  ComponentRetrieveResponse,
   ComponentUpdateParams,
+  ComponentUpdateResponse,
   Components,
 } from './components';
 import * as ExplainersAPI from './explainers';
-import { ExplainerCreateParams, Explainers } from './explainers';
+import { ExplainerCreateParams, ExplainerHandleWebhookParams, Explainers } from './explainers';
 import * as FlashcardsAPI from './flashcards';
 import {
+  FlashcardBatchProcessParams,
+  FlashcardBatchProcessResponse,
+  FlashcardGetAlgorithmInfoResponse,
+  FlashcardGetAllParams,
   FlashcardGetDueParams,
   FlashcardGetStatsParams,
-  FlashcardListAllParams,
+  FlashcardGetTypesResponse,
+  FlashcardRateParams,
   Flashcards,
 } from './flashcards';
 import * as FoldersAPI from './folders';
-import { Folders } from './folders';
+import { FolderCreateParams, FolderListParams, FolderUpdateParams, Folders } from './folders';
 import * as UsageAPI from './usage';
-import { Usage, UsageChatParams, UsageTrackParams } from './usage';
+import {
+  Usage,
+  UsageGetStatsParams,
+  UsageGetSummaryParams,
+  UsageListEventsParams,
+  UsageTrackChatParams,
+  UsageTrackEventParams,
+  UsageTrackPerformanceParams,
+} from './usage';
 import * as AdminAPI from './admin/admin';
 import { Admin } from './admin/admin';
 import * as AudioRecapsAPI from './audio-recaps/audio-recaps';
@@ -33,22 +51,40 @@ import {
 import * as AuthAPI from './auth/auth';
 import {
   Auth,
-  AuthForgotPasswordParams,
+  AuthRegisterNewUserParams,
   AuthRegisterWithInviteParams,
+  AuthRequestPasswordResetParams,
   AuthResetPasswordParams,
+  AuthVerifyResetTokenParams,
 } from './auth/auth';
 import * as ChatAPI from './chat/chat';
-import { Chat, ChatCreateStreamParams, ChatRetrieveSessionParams, ChatSendMessageParams } from './chat/chat';
+import { Chat, ChatRetrieveSessionParams, ChatSendMessageParams, ChatStreamParams } from './chat/chat';
 import * as EmbedAPI from './embed/embed';
-import { Embed, EmbedGetThemeParams, EmbedRetrieveParams, EmbedVerifyParams } from './embed/embed';
+import { Embed, EmbedGetThemeParams, EmbedVerifyParams } from './embed/embed';
 import * as MaterialsAPI from './materials/materials';
-import { MaterialCreateParams, MaterialGetDownloadURLParams, Materials } from './materials/materials';
+import {
+  MaterialCreateParams,
+  MaterialCreateResponse,
+  MaterialGetDownloadURLParams,
+  MaterialListParams,
+  MaterialListResponse,
+  MaterialRetrieveResponse,
+  Materials,
+} from './materials/materials';
 import * as OrganizationsAPI from './organizations/organizations';
 import { OrganizationUpdateParams, Organizations } from './organizations/organizations';
 import * as ScenariosAPI from './scenarios/scenarios';
-import { Scenarios } from './scenarios/scenarios';
+import { ScenarioCreateParams, ScenarioUpdateParams, Scenarios } from './scenarios/scenarios';
 import * as TestsAPI from './tests/tests';
-import { Tests } from './tests/tests';
+import {
+  TestCreateParams,
+  TestRetakeParams,
+  TestSubmitAnswerParams,
+  TestSubmitParams,
+  Tests,
+} from './tests/tests';
+import * as UploadAPI from './upload/upload';
+import { Upload } from './upload/upload';
 
 export class V1 extends APIResource {
   auth: AuthAPI.Auth = new AuthAPI.Auth(this._client);
@@ -64,6 +100,7 @@ export class V1 extends APIResource {
   audioRecaps: AudioRecapsAPI.AudioRecaps = new AudioRecapsAPI.AudioRecaps(this._client);
   scenarios: ScenariosAPI.Scenarios = new ScenariosAPI.Scenarios(this._client);
   explainers: ExplainersAPI.Explainers = new ExplainersAPI.Explainers(this._client);
+  upload: UploadAPI.Upload = new UploadAPI.Upload(this._client);
   admin: AdminAPI.Admin = new AdminAPI.Admin(this._client);
 }
 
@@ -80,34 +117,55 @@ V1.Tests = Tests;
 V1.AudioRecaps = AudioRecaps;
 V1.Scenarios = Scenarios;
 V1.Explainers = Explainers;
+V1.Upload = Upload;
 V1.Admin = Admin;
 
 export declare namespace V1 {
   export {
     Auth as Auth,
-    type AuthForgotPasswordParams as AuthForgotPasswordParams,
+    type AuthRegisterNewUserParams as AuthRegisterNewUserParams,
     type AuthRegisterWithInviteParams as AuthRegisterWithInviteParams,
+    type AuthRequestPasswordResetParams as AuthRequestPasswordResetParams,
     type AuthResetPasswordParams as AuthResetPasswordParams,
+    type AuthVerifyResetTokenParams as AuthVerifyResetTokenParams,
   };
 
   export { Organizations as Organizations, type OrganizationUpdateParams as OrganizationUpdateParams };
 
   export {
     Materials as Materials,
+    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 {
     Usage as Usage,
-    type UsageChatParams as UsageChatParams,
-    type UsageTrackParams as UsageTrackParams,
+    type UsageGetStatsParams as UsageGetStatsParams,
+    type UsageGetSummaryParams as UsageGetSummaryParams,
+    type UsageListEventsParams as UsageListEventsParams,
+    type UsageTrackChatParams as UsageTrackChatParams,
+    type UsageTrackEventParams as UsageTrackEventParams,
+    type UsageTrackPerformanceParams as UsageTrackPerformanceParams,
   };
 
-  export { Folders as Folders };
+  export {
+    Folders as Folders,
+    type FolderCreateParams as FolderCreateParams,
+    type FolderUpdateParams as FolderUpdateParams,
+    type FolderListParams as FolderListParams,
+  };
 
   export {
     Components as Components,
+    type ComponentCreateResponse as ComponentCreateResponse,
+    type ComponentRetrieveResponse as ComponentRetrieveResponse,
+    type ComponentUpdateResponse as ComponentUpdateResponse,
+    type ComponentListResponse as ComponentListResponse,
+    type ComponentEmbedResponse as ComponentEmbedResponse,
     type ComponentCreateParams as ComponentCreateParams,
     type ComponentUpdateParams as ComponentUpdateParams,
     type ComponentListParams as ComponentListParams,
@@ -116,26 +174,36 @@ export declare namespace V1 {
 
   export {
     Embed as Embed,
-    type EmbedRetrieveParams as EmbedRetrieveParams,
     type EmbedGetThemeParams as EmbedGetThemeParams,
     type EmbedVerifyParams as EmbedVerifyParams,
   };
 
   export {
     Chat as Chat,
-    type ChatCreateStreamParams as ChatCreateStreamParams,
     type ChatRetrieveSessionParams as ChatRetrieveSessionParams,
     type ChatSendMessageParams as ChatSendMessageParams,
+    type ChatStreamParams as ChatStreamParams,
   };
 
   export {
     Flashcards as Flashcards,
+    type FlashcardBatchProcessResponse as FlashcardBatchProcessResponse,
+    type FlashcardGetAlgorithmInfoResponse as FlashcardGetAlgorithmInfoResponse,
+    type FlashcardGetTypesResponse as FlashcardGetTypesResponse,
+    type FlashcardBatchProcessParams as FlashcardBatchProcessParams,
+    type FlashcardGetAllParams as FlashcardGetAllParams,
     type FlashcardGetDueParams as FlashcardGetDueParams,
     type FlashcardGetStatsParams as FlashcardGetStatsParams,
-    type FlashcardListAllParams as FlashcardListAllParams,
+    type FlashcardRateParams as FlashcardRateParams,
   };
 
-  export { Tests as Tests };
+  export {
+    Tests as Tests,
+    type TestCreateParams as TestCreateParams,
+    type TestRetakeParams as TestRetakeParams,
+    type TestSubmitParams as TestSubmitParams,
+    type TestSubmitAnswerParams as TestSubmitAnswerParams,
+  };
 
   export {
     AudioRecaps as AudioRecaps,
@@ -143,9 +211,19 @@ export declare namespace V1 {
     type AudioRecapAskQuestionParams as AudioRecapAskQuestionParams,
   };
 
-  export { Scenarios as Scenarios };
+  export {
+    Scenarios as Scenarios,
+    type ScenarioCreateParams as ScenarioCreateParams,
+    type ScenarioUpdateParams as ScenarioUpdateParams,
+  };
+
+  export {
+    Explainers as Explainers,
+    type ExplainerCreateParams as ExplainerCreateParams,
+    type ExplainerHandleWebhookParams as ExplainerHandleWebhookParams,
+  };
 
-  export { Explainers as Explainers, type ExplainerCreateParams as ExplainerCreateParams };
+  export { Upload as Upload };
 
   export { Admin as Admin };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.1.1'; // x-release-please-version
+export const VERSION = '1.3.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.1.1";
+export declare const VERSION = "1.3.0";
 //# sourceMappingURL=version.d.mts.map