@composio/client 0.1.0-alpha.5 → 0.1.0-alpha.50

package/src/resources/cli.ts

@@ -5,152 +5,110 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
 export class Cli extends APIResource {
+  /**
+   * Generates a new CLI session with a random 6-character code. This endpoint is the
+   * first step in the CLI authentication flow, creating a session that can later be
+   * linked to a user account. The generated code is displayed to the user in the CLI
+   * and should be entered in the web interface to complete authentication.
+   */
   createSession(options?: RequestOptions): APIPromise<CliCreateSessionResponse> {
     return this._client.post('/api/v3/cli/create-session', options);
   }
 
-  linkSession(body: CliLinkSessionParams, options?: RequestOptions): APIPromise<CliLinkSessionResponse> {
-    return this._client.put('/api/v3/cli/link-session', { body, ...options });
-  }
-
-  retrieveSession(
-    query: CliRetrieveSessionParams,
-    options?: RequestOptions,
-  ): APIPromise<CliRetrieveSessionResponse> {
+  /**
+   * Retrieves the current state of a CLI session using either the session ID (UUID)
+   * or the 6-character code. This endpoint is used by both the CLI client to check
+   * if the session has been linked, and by the web interface to display session
+   * details before linking.
+   */
+  getSession(query: CliGetSessionParams, options?: RequestOptions): APIPromise<CliGetSessionResponse> {
     return this._client.get('/api/v3/cli/get-session', { query, ...options });
   }
 }
 
 export interface CliCreateSessionResponse {
   /**
-   * Unique identifier for the CLI session
+   * Unique identifier for the CLI session. UUID v4 format used for tracking and
+   * retrieval.
    */
   id: string;
 
   /**
-   * Temporary code to use for CLI login
+   * The 6-character hexadecimal code used for CLI login
    */
   code: string;
 
   /**
-   * Expiration time of the session
+   * The ISO timestamp when the session expires
    */
   expiresAt: string;
 
   /**
-   * Current status of the session
+   * The current status of the session
    */
   status: 'pending' | 'linked';
 }
 
-export interface CliLinkSessionResponse {
+export interface CliGetSessionResponse {
   /**
-   * Unique identifier for the CLI session
+   * The unique identifier for the CLI session
    */
   id: string;
 
   /**
-   * Information about the linked account
+   * Information about the linked account, if any. Null if the session status is
+   * "pending".
    */
-  account: CliLinkSessionResponse.Account;
+  account: CliGetSessionResponse.Account | null;
 
   /**
-   * Temporary code used for CLI login
+   * The API key for the linked account
    */
-  code: string;
-
-  /**
-   * Expiration time of the session
-   */
-  expiresAt: string;
+  api_key: string | null;
 
   /**
-   * Current status of the session
-   */
-  status: 'pending' | 'linked';
-}
-
-export namespace CliLinkSessionResponse {
-  /**
-   * Information about the linked account
-   */
-  export interface Account {
-    /**
-     * ID of the linked account
-     */
-    id: string;
-
-    /**
-     * Email of the linked account
-     */
-    email: string;
-
-    /**
-     * Name of the linked account
-     */
-    name: string;
-  }
-}
-
-export interface CliRetrieveSessionResponse {
-  /**
-   * Unique identifier for the CLI session
-   */
-  id: string;
-
-  /**
-   * Information about the linked account, if any
-   */
-  account: CliRetrieveSessionResponse.Account | null;
-
-  /**
-   * Temporary code used for CLI login
+   * The 6-character hexadecimal code used for CLI login
    */
   code: string;
 
   /**
-   * Expiration time of the session
+   * The ISO timestamp when the session expires
    */
   expiresAt: string;
 
   /**
-   * Current status of the session
+   * The current status of the session
    */
   status: 'pending' | 'linked';
 }
 
-export namespace CliRetrieveSessionResponse {
+export namespace CliGetSessionResponse {
   /**
-   * Information about the linked account, if any
+   * Information about the linked account, if any. Null if the session status is
+   * "pending".
    */
   export interface Account {
     /**
-     * ID of the linked account
+     * The ID of the linked account
      */
     id: string;
 
     /**
-     * Email of the linked account
+     * The email address of the linked account
      */
     email: string;
 
     /**
-     * Name of the linked account
+     * The display name of the linked account
      */
     name: string;
   }
 }
 
-export interface CliLinkSessionParams {
-  /**
-   * CLI session ID or code to link
-   */
-  id: string;
-}
-
-export interface CliRetrieveSessionParams {
+export interface CliGetSessionParams {
   /**
-   * CLI session ID or code to check
+   * CLI session ID (UUID format) or 6-character code to check. Both formats are
+   * supported for flexibility in client implementations.
    */
   id: string;
 }
@@ -158,9 +116,7 @@ export interface CliRetrieveSessionParams {
 export declare namespace Cli {
   export {
     type CliCreateSessionResponse as CliCreateSessionResponse,
-    type CliLinkSessionResponse as CliLinkSessionResponse,
-    type CliRetrieveSessionResponse as CliRetrieveSessionResponse,
-    type CliLinkSessionParams as CliLinkSessionParams,
-    type CliRetrieveSessionParams as CliRetrieveSessionParams,
+    type CliGetSessionResponse as CliGetSessionResponse,
+    type CliGetSessionParams as CliGetSessionParams,
   };
 }