@composio/client 0.1.0-alpha.7 → 0.1.0-alpha.71

package/src/resources/cli/cli.ts

@@ -0,0 +1,163 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as RealtimeAPI from './realtime';
+import { Realtime, RealtimeAuthParams, RealtimeAuthResponse, RealtimeCredentialsResponse } from './realtime';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+export class Cli extends APIResource {
+  realtime: RealtimeAPI.Realtime = new RealtimeAPI.Realtime(this._client);
+
+  /**
+   * 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.
+   * Optionally accepts a scope ('project' or 'user') and a source string.
+   */
+  createSession(
+    body: CliCreateSessionParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CliCreateSessionResponse> {
+    return this._client.post('/api/v3.1/cli/create-session', { body, ...options });
+  }
+
+  /**
+   * 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.1/cli/get-session', { query, ...options });
+  }
+}
+
+export interface CliCreateSessionResponse {
+  /**
+   * Unique identifier for the CLI session. UUID v4 format used for tracking and
+   * retrieval.
+   */
+  id: string;
+
+  /**
+   * The 6-character hexadecimal code used for CLI login
+   */
+  code: string;
+
+  /**
+   * The ISO timestamp when the session expires
+   */
+  expiresAt: string;
+
+  /**
+   * The key scope for this session
+   */
+  scope: 'project' | 'user';
+
+  /**
+   * The current status of the session
+   */
+  status: 'pending' | 'linked';
+}
+
+export interface CliGetSessionResponse {
+  /**
+   * The unique identifier for the CLI session
+   */
+  id: string;
+
+  /**
+   * Information about the linked account, if any. Null if the session status is
+   * "pending".
+   */
+  account: CliGetSessionResponse.Account | null;
+
+  /**
+   * The API key for the linked account
+   */
+  api_key: string | null;
+
+  /**
+   * The 6-character hexadecimal code used for CLI login
+   */
+  code: string;
+
+  /**
+   * The ISO timestamp when the session expires
+   */
+  expiresAt: string;
+
+  /**
+   * The key scope for this session
+   */
+  scope: 'project' | 'user' | null;
+
+  /**
+   * The current status of the session
+   */
+  status: 'pending' | 'linked';
+}
+
+export namespace CliGetSessionResponse {
+  /**
+   * Information about the linked account, if any. Null if the session status is
+   * "pending".
+   */
+  export interface Account {
+    /**
+     * The ID of the linked account
+     */
+    id: string;
+
+    /**
+     * The email address of the linked account
+     */
+    email: string;
+
+    /**
+     * The display name of the linked account
+     */
+    name: string;
+  }
+}
+
+export interface CliCreateSessionParams {
+  /**
+   * Key scope. 'project' (default) returns a project-level API key; 'user' returns a
+   * user-level API key valid across projects.
+   */
+  scope?: 'project' | 'user';
+
+  /**
+   * Free-form string describing the source, e.g. 'Johns MacBook (darwin, v1.2.3)'
+   */
+  source?: string;
+}
+
+export interface CliGetSessionParams {
+  /**
+   * CLI session ID (UUID format) or 6-character code to check. Both formats are
+   * supported for flexibility in client implementations.
+   */
+  id: string;
+}
+
+Cli.Realtime = Realtime;
+
+export declare namespace Cli {
+  export {
+    type CliCreateSessionResponse as CliCreateSessionResponse,
+    type CliGetSessionResponse as CliGetSessionResponse,
+    type CliCreateSessionParams as CliCreateSessionParams,
+    type CliGetSessionParams as CliGetSessionParams,
+  };
+
+  export {
+    Realtime as Realtime,
+    type RealtimeAuthResponse as RealtimeAuthResponse,
+    type RealtimeCredentialsResponse as RealtimeCredentialsResponse,
+    type RealtimeAuthParams as RealtimeAuthParams,
+  };
+}

package/src/resources/cli/index.ts

@@ -0,0 +1,15 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Cli,
+  type CliCreateSessionResponse,
+  type CliGetSessionResponse,
+  type CliCreateSessionParams,
+  type CliGetSessionParams,
+} from './cli';
+export {
+  Realtime,
+  type RealtimeAuthResponse,
+  type RealtimeCredentialsResponse,
+  type RealtimeAuthParams,
+} from './realtime';

package/src/resources/cli/realtime.ts

@@ -0,0 +1,75 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+/**
+ * CLI integration endpoints
+ */
+export class Realtime extends APIResource {
+  /**
+   * Authenticate CLI client access to a private-cli-{nanoId} Pusher channel
+   */
+  auth(body: RealtimeAuthParams, options?: RequestOptions): APIPromise<RealtimeAuthResponse> {
+    return this._client.post('/api/v3.1/cli/realtime/auth', { body, ...options });
+  }
+
+  /**
+   * Get the Pusher key and project nanoId for the CLI realtime trigger channel. The
+   * CLI subscribes to private-cli-{project_id}.
+   */
+  credentials(options?: RequestOptions): APIPromise<RealtimeCredentialsResponse> {
+    return this._client.get('/api/v3.1/cli/realtime/credentials', options);
+  }
+}
+
+export interface RealtimeAuthResponse {
+  /**
+   * The authentication string for Pusher
+   */
+  auth: string;
+
+  /**
+   * Channel data for presence channels
+   */
+  channel_data?: string;
+}
+
+export interface RealtimeCredentialsResponse {
+  /**
+   * The project nanoId associated with the API Key provided. Used as part of the CLI
+   * channel name: private-cli-{project_id}
+   */
+  project_id: string;
+
+  /**
+   * The Pusher cluster for subscribing to the trigger
+   */
+  pusher_cluster: string;
+
+  /**
+   * The Pusher client key for subscribing to the trigger
+   */
+  pusher_key: string;
+}
+
+export interface RealtimeAuthParams {
+  /**
+   * The channel name to authenticate for
+   */
+  channel_name: string;
+
+  /**
+   * The socket ID for Pusher authentication
+   */
+  socket_id: string;
+}
+
+export declare namespace Realtime {
+  export {
+    type RealtimeAuthResponse as RealtimeAuthResponse,
+    type RealtimeCredentialsResponse as RealtimeCredentialsResponse,
+    type RealtimeAuthParams as RealtimeAuthParams,
+  };
+}

package/src/resources/cli.ts

@@ -1,166 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../core/resource';
-import { APIPromise } from '../core/api-promise';
-import { RequestOptions } from '../internal/request-options';
-
-export class Cli extends APIResource {
-  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> {
-    return this._client.get('/api/v3/cli/get-session', { query, ...options });
-  }
-}
-
-export interface CliCreateSessionResponse {
-  /**
-   * Unique identifier for the CLI session
-   */
-  id: string;
-
-  /**
-   * Temporary code to use for CLI login
-   */
-  code: string;
-
-  /**
-   * Expiration time of the session
-   */
-  expiresAt: string;
-
-  /**
-   * Current status of the session
-   */
-  status: 'pending' | 'linked';
-}
-
-export interface CliLinkSessionResponse {
-  /**
-   * Unique identifier for the CLI session
-   */
-  id: string;
-
-  /**
-   * Information about the linked account
-   */
-  account: CliLinkSessionResponse.Account;
-
-  /**
-   * Temporary code used for CLI login
-   */
-  code: string;
-
-  /**
-   * Expiration time of the session
-   */
-  expiresAt: string;
-
-  /**
-   * 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
-   */
-  code: string;
-
-  /**
-   * Expiration time of the session
-   */
-  expiresAt: string;
-
-  /**
-   * Current status of the session
-   */
-  status: 'pending' | 'linked';
-}
-
-export namespace CliRetrieveSessionResponse {
-  /**
-   * Information about the linked account, if any
-   */
-  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 CliLinkSessionParams {
-  /**
-   * CLI session ID or code to link
-   */
-  id: string;
-}
-
-export interface CliRetrieveSessionParams {
-  /**
-   * CLI session ID or code to check
-   */
-  id: string;
-}
-
-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,
-  };
-}
+export * from './cli/index';