@studyfetch/sdk 1.1.1 → 1.2.0

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

@@ -2,13 +2,15 @@
 
 export {
   Auth,
-  type AuthForgotPasswordParams,
+  type AuthRegisterNewUserParams,
   type AuthRegisterWithInviteParams,
+  type AuthRequestPasswordResetParams,
   type AuthResetPasswordParams,
+  type AuthVerifyResetTokenParams,
 } from './auth';
 export {
   Login,
-  type LoginCreateParams,
+  type LoginAuthenticateParams,
   type LoginVerify2faParams,
   type LoginVerifyBackupCodeParams,
 } from './login';

package/src/resources/v1/auth/login.ts

@@ -6,7 +6,18 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 
 export class Login extends APIResource {
-  create(body: LoginCreateParams, options?: RequestOptions): APIPromise<void> {
+  /**
+   * User login
+   *
+   * @example
+   * ```ts
+   * await client.v1.auth.login.authenticate({
+   *   email: 'user@example.com',
+   *   password: 'password123',
+   * });
+   * ```
+   */
+  authenticate(body: LoginAuthenticateParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/auth/login', {
       body,
       ...options,
@@ -14,6 +25,17 @@ export class Login extends APIResource {
     });
   }
 
+  /**
+   * Verify 2FA code for login
+   *
+   * @example
+   * ```ts
+   * await client.v1.auth.login.verify2fa({
+   *   code: '123456',
+   *   email: 'user@example.com',
+   * });
+   * ```
+   */
   verify2fa(body: LoginVerify2faParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/auth/login/verify-2fa', {
       body,
@@ -22,6 +44,17 @@ export class Login extends APIResource {
     });
   }
 
+  /**
+   * Verify backup code for login
+   *
+   * @example
+   * ```ts
+   * await client.v1.auth.login.verifyBackupCode({
+   *   backupCode: 'ABCD-EFGH-IJKL',
+   *   email: 'user@example.com',
+   * });
+   * ```
+   */
   verifyBackupCode(body: LoginVerifyBackupCodeParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/auth/login/verify-backup-code', {
       body,
@@ -31,15 +64,45 @@ export class Login extends APIResource {
   }
 }
 
-export interface LoginCreateParams {}
+export interface LoginAuthenticateParams {
+  /**
+   * User email address
+   */
+  email: string;
 
-export interface LoginVerify2faParams {}
+  /**
+   * User password
+   */
+  password: string;
+}
+
+export interface LoginVerify2faParams {
+  /**
+   * 6-digit verification code
+   */
+  code: string;
+
+  /**
+   * User email address
+   */
+  email: string;
+}
+
+export interface LoginVerifyBackupCodeParams {
+  /**
+   * Backup code
+   */
+  backupCode: string;
 
-export interface LoginVerifyBackupCodeParams {}
+  /**
+   * User email address
+   */
+  email: string;
+}
 
 export declare namespace Login {
   export {
-    type LoginCreateParams as LoginCreateParams,
+    type LoginAuthenticateParams as LoginAuthenticateParams,
     type LoginVerify2faParams as LoginVerify2faParams,
     type LoginVerifyBackupCodeParams as LoginVerifyBackupCodeParams,
   };

package/src/resources/v1/auth/number-2fa.ts

@@ -6,6 +6,16 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 
 export class Number2fa extends APIResource {
+  /**
+   * Disable 2FA for user
+   *
+   * @example
+   * ```ts
+   * await client.v1.auth.number2fa.disable({
+   *   password: 'password123',
+   * });
+   * ```
+   */
   disable(body: Number2faDisableParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/auth/2fa/disable', {
       body,
@@ -14,6 +24,16 @@ export class Number2fa extends APIResource {
     });
   }
 
+  /**
+   * Enable 2FA for user
+   *
+   * @example
+   * ```ts
+   * await client.v1.auth.number2fa.enable({
+   *   password: 'password123',
+   * });
+   * ```
+   */
   enable(body: Number2faEnableParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/auth/2fa/enable', {
       body,
@@ -22,6 +42,29 @@ export class Number2fa extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.auth.number2fa.getStatus();
+   * ```
+   */
+  getStatus(options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/api/v1/auth/2fa/status', {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Regenerate 2FA backup codes
+   *
+   * @example
+   * ```ts
+   * await client.v1.auth.number2fa.regenerateBackupCodes({
+   *   password: 'password123',
+   * });
+   * ```
+   */
   regenerateBackupCodes(
     body: Number2faRegenerateBackupCodesParams,
     options?: RequestOptions,
@@ -33,6 +76,16 @@ export class Number2fa extends APIResource {
     });
   }
 
+  /**
+   * Send 2FA verification code
+   *
+   * @example
+   * ```ts
+   * await client.v1.auth.number2fa.sendCode({
+   *   email: 'user@example.com',
+   * });
+   * ```
+   */
   sendCode(body: Number2faSendCodeParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/auth/2fa/send-code', {
       body,
@@ -40,22 +93,35 @@ export class Number2fa extends APIResource {
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
-
-  status(options?: RequestOptions): APIPromise<void> {
-    return this._client.get('/api/v1/auth/2fa/status', {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
 }
 
-export interface Number2faDisableParams {}
+export interface Number2faDisableParams {
+  /**
+   * User password for verification
+   */
+  password: string;
+}
 
-export interface Number2faEnableParams {}
+export interface Number2faEnableParams {
+  /**
+   * User password for verification
+   */
+  password: string;
+}
 
-export interface Number2faRegenerateBackupCodesParams {}
+export interface Number2faRegenerateBackupCodesParams {
+  /**
+   * User password for verification
+   */
+  password: string;
+}
 
-export interface Number2faSendCodeParams {}
+export interface Number2faSendCodeParams {
+  /**
+   * Email to send verification code
+   */
+  email: string;
+}
 
 export declare namespace Number2fa {
   export {

package/src/resources/v1/auth/organization-invites.ts

@@ -7,6 +7,12 @@ import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
 export class OrganizationInvites extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.auth.organizationInvites.preview('token');
+   * ```
+   */
   preview(token: string, options?: RequestOptions): APIPromise<void> {
     return this._client.get(path`/api/v1/auth/organization-invites/preview/${token}`, {
       ...options,

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

@@ -14,21 +14,12 @@ export class Chat extends APIResource {
   sessions: SessionsAPI.Sessions = new SessionsAPI.Sessions(this._client);
   test: TestAPI.Test = new TestAPI.Test(this._client);
 
-  createFollowup(options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/api/v1/chat/followups', {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-
-  createStream(params: ChatCreateStreamParams, options?: RequestOptions): APIPromise<void> {
-    const { 'x-component-id': xComponentID } = params;
-    return this._client.post('/api/v1/chat/stream', {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*', 'x-component-id': xComponentID }, options?.headers]),
-    });
-  }
-
+  /**
+   * @example
+   * ```ts
+   * await client.v1.chat.getHistory();
+   * ```
+   */
   getHistory(options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/chat/history', {
       ...options,
@@ -36,6 +27,14 @@ export class Chat extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.chat.retrieveSession('sessionId', {
+   *   userId: 'userId',
+   * });
+   * ```
+   */
   retrieveSession(
     sessionID: string,
     query: ChatRetrieveSessionParams,
@@ -48,6 +47,29 @@ export class Chat extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.chat.sendFollowups();
+   * ```
+   */
+  sendFollowups(options?: RequestOptions): APIPromise<void> {
+    return this._client.post('/api/v1/chat/followups', {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * @example
+   * ```ts
+   * await client.v1.chat.sendMessage({
+   *   componentId: 'componentId',
+   *   message: {},
+   *   'x-component-id': 'x-component-id',
+   * });
+   * ```
+   */
   sendMessage(params: ChatSendMessageParams, options?: RequestOptions): APIPromise<void> {
     const { 'x-component-id': xComponentID, ...body } = params;
     return this._client.post('/api/v1/chat/message', {
@@ -56,10 +78,26 @@ export class Chat extends APIResource {
       headers: buildHeaders([{ Accept: '*/*', 'x-component-id': xComponentID }, options?.headers]),
     });
   }
-}
 
-export interface ChatCreateStreamParams {
-  'x-component-id': string;
+  /**
+   * Stream chat responses
+   *
+   * @example
+   * ```ts
+   * await client.v1.chat.stream();
+   * ```
+   */
+  stream(params: ChatStreamParams, options?: RequestOptions): APIPromise<void> {
+    const { 'x-component-id': xComponentID, ...body } = params;
+    return this._client.post('/api/v1/chat/stream', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { Accept: '*/*', ...(xComponentID != null ? { 'x-component-id': xComponentID } : undefined) },
+        options?.headers,
+      ]),
+    });
+  }
 }
 
 export interface ChatRetrieveSessionParams {
@@ -67,7 +105,116 @@ export interface ChatRetrieveSessionParams {
 }
 
 export interface ChatSendMessageParams {
+  /**
+   * Body param: Component ID for context
+   */
+  componentId: string;
+
+  /**
+   * Body param: Chat message content
+   */
+  message: ChatSendMessageParams.Message;
+
+  /**
+   * Header param:
+   */
   'x-component-id': string;
+
+  /**
+   * Body param: Additional context data
+   */
+  context?: unknown;
+
+  /**
+   * Body param: Group ID for collaboration
+   */
+  groupId?: string;
+
+  /**
+   * Body param: Session ID for conversation continuity
+   */
+  sessionId?: string;
+
+  /**
+   * Body param: User ID for tracking
+   */
+  userId?: string;
+}
+
+export namespace ChatSendMessageParams {
+  /**
+   * Chat message content
+   */
+  export interface Message {
+    /**
+     * Images attached to the message
+     */
+    images?: Array<Message.Image>;
+
+    /**
+     * Text content of the message
+     */
+    text?: string;
+  }
+
+  export namespace Message {
+    export interface Image {
+      /**
+       * Base64 encoded image data
+       */
+      base64?: string;
+
+      /**
+       * Caption for the image
+       */
+      caption?: string;
+
+      /**
+       * MIME type of the image
+       */
+      mimeType?: string;
+
+      /**
+       * URL of the image
+       */
+      url?: string;
+    }
+  }
+}
+
+export interface ChatStreamParams {
+  /**
+   * Body param:
+   */
+  context?: unknown;
+
+  /**
+   * Body param:
+   */
+  groupId?: string;
+
+  /**
+   * Body param:
+   */
+  messages?: Array<ChatStreamParams.Message>;
+
+  /**
+   * Body param:
+   */
+  userId?: string;
+
+  /**
+   * Header param: Component ID for context
+   */
+  'x-component-id'?: string;
+}
+
+export namespace ChatStreamParams {
+  export interface Message {
+    content?: string;
+
+    role?: 'user' | 'assistant' | 'system';
+  }
 }
 
 Chat.Sessions = Sessions;
@@ -75,9 +222,9 @@ Chat.Test = Test;
 
 export declare namespace Chat {
   export {
-    type ChatCreateStreamParams as ChatCreateStreamParams,
     type ChatRetrieveSessionParams as ChatRetrieveSessionParams,
     type ChatSendMessageParams as ChatSendMessageParams,
+    type ChatStreamParams as ChatStreamParams,
   };
 
   export { Sessions as Sessions, type SessionRetrieveParams as SessionRetrieveParams };

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

@@ -2,9 +2,9 @@
 
 export {
   Chat,
-  type ChatCreateStreamParams,
   type ChatRetrieveSessionParams,
   type ChatSendMessageParams,
+  type ChatStreamParams,
 } from './chat';
 export { Sessions, type SessionRetrieveParams } from './sessions';
 export { Test } from './test';

package/src/resources/v1/chat/sessions.ts

@@ -7,6 +7,12 @@ import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
 export class Sessions extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.chat.sessions.create();
+   * ```
+   */
   create(options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/chat/sessions/create', {
       ...options,
@@ -14,6 +20,14 @@ export class Sessions extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.chat.sessions.retrieve('userId', {
+   *   limit: 'limit',
+   * });
+   * ```
+   */
   retrieve(userID: string, query: SessionRetrieveParams, options?: RequestOptions): APIPromise<void> {
     return this._client.get(path`/api/v1/chat/sessions/${userID}`, {
       query,

package/src/resources/v1/chat/test.ts

@@ -6,6 +6,12 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 
 export class Test extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.chat.test.citeImage();
+   * ```
+   */
   citeImage(options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/chat/test/image-citation', {
       ...options,
@@ -13,6 +19,12 @@ export class Test extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.chat.test.uploadImage();
+   * ```
+   */
   uploadImage(options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/chat/test/image', {
       ...options,