@composio/client 2.0.0-rc.11 → 2.0.0-rc.12

package/dist/effect/schemas/components/toolkit-list-response-items.mjs

@@ -0,0 +1,101 @@
+import { DeprecatedToolkitInfo } from "./deprecated-toolkit-info.mjs";
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/components/toolkit-list-response-items.ts
+/** The `ToolkitListResponseItems` component schema. */
+const ToolkitListResponseItems = Schema.Array(Schema.StructWithRest(Schema.Struct({
+	"slug": Schema.String.annotate({
+		"description": "URL-friendly unique identifier for the toolkit",
+		"examples": ["github"]
+	}),
+	"name": Schema.String.annotate({
+		"description": "Human-readable name of the toolkit",
+		"examples": ["GitHub"]
+	}),
+	"type": Schema.Literals(["native", "custom"]).annotate({
+		"description": "Toolkit provenance: \"native\" for Composio-managed toolkits, \"custom\" for a project-registered custom (MCP) toolkit",
+		"examples": ["native"]
+	}),
+	"instant": Schema.optionalKey(Schema.StructWithRest(Schema.Struct({ "supported": Schema.Literal(true) }), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]).annotate({ "description": "Present when the latest version of this toolkit supports Instant accounts. See the tools endpoint for support on individual tools." })),
+	"access": Schema.optionalKey(Schema.Literals(["all", "user"]).annotate({
+		"description": "[EXPERIMENTAL] Custom toolkits only. \"all\": every user in the project can use it. \"user\": only the user it was created for can.",
+		"examples": ["all"]
+	})),
+	"auth_schemes": Schema.optionalKey(Schema.Array(Schema.String).annotate({
+		"description": "List of authentication methods supported by this toolkit",
+		"examples": [["oauth2", "api_key"]]
+	})),
+	"composio_managed_auth_schemes": Schema.optionalKey(Schema.Array(Schema.String).annotate({
+		"description": "List of authentication methods that Composio manages for this toolkit",
+		"examples": [["oauth2"]]
+	})),
+	"is_local_toolkit": Schema.Boolean.annotate({
+		"description": "DEPRECATED: This field is no longer meaningful and will always return false. It was previously used to indicate if a toolkit is specific to the current project.",
+		"examples": [false]
+	}),
+	"no_auth": Schema.optionalKey(Schema.Boolean.annotate({
+		"description": "When true, this toolkit can be used without authentication",
+		"examples": [false]
+	})),
+	"auth_guide_url": Schema.optionalKey(Schema.Union([Schema.String, Schema.Null]).annotate({
+		"description": "URL to a guide page with authentication setup instructions for this toolkit",
+		"examples": ["https://composio.dev/auth/github"]
+	})),
+	"deprecated": DeprecatedToolkitInfo,
+	"meta": Schema.StructWithRest(Schema.Struct({
+		"created_at": Schema.String.annotate({
+			"description": "Creation date and time of the toolkit",
+			"examples": ["2023-01-15T09:30:00.000Z"]
+		}),
+		"updated_at": Schema.String.annotate({
+			"description": "Last modification date and time of the toolkit",
+			"examples": ["2023-05-20T14:45:00.000Z"]
+		}),
+		"description": Schema.String.annotate({
+			"description": "Human-readable description explaining the toolkit's purpose and functionality",
+			"examples": ["Integrate with GitHub repositories, issues, pull requests, and more."]
+		}),
+		"logo": Schema.String.annotate({
+			"description": "Image URL for the toolkit's branding",
+			"examples": ["https://assets.composio.dev/logos/github.png"]
+		}),
+		"app_url": Schema.optionalKey(Schema.Union([Schema.String, Schema.Null]).annotate({
+			"description": "Link to the toolkit's main application or service website",
+			"examples": ["https://github.com"]
+		})),
+		"categories": Schema.Array(Schema.StructWithRest(Schema.Struct({
+			"id": Schema.String.annotate({
+				"description": "Category identifier",
+				"examples": ["developer-tools"]
+			}),
+			"name": Schema.String.annotate({
+				"description": "Human-readable category name",
+				"examples": ["Developer Tools"]
+			})
+		}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))])).annotate({
+			"description": "List of categories associated with this toolkit",
+			"examples": [[{
+				"id": "developer-tools",
+				"name": "Developer Tools"
+			}, {
+				"id": "productivity",
+				"name": "Productivity"
+			}]]
+		}),
+		"triggers_count": Schema.Number.annotate({
+			"description": "Count of available triggers in this toolkit",
+			"examples": [5]
+		}).check(Schema.isFinite().annotate({ "expected": "a finite number" })),
+		"tools_count": Schema.Number.annotate({
+			"description": "Count of available tools in this toolkit",
+			"examples": [12]
+		}).check(Schema.isFinite().annotate({ "expected": "a finite number" })),
+		"version": Schema.String.annotate({
+			"description": "Version of the toolkit",
+			"examples": ["20250905_00"]
+		})
+	}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]).annotate({ "description": "Additional metadata about the toolkit" })
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]).annotate({ "description": "Detailed information about a toolkit" })).annotate({ "identifier": "ToolkitListResponseItems" });
+
+//#endregion
+export { ToolkitListResponseItems };

package/dist/effect/schemas/components/tools-paginated.d.mts

@@ -0,0 +1,57 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/components/tools-paginated.d.ts
+/** The `ToolsPaginated` component schema. */
+declare const ToolsPaginated: Schema.StructWithRest<Schema.Struct<{
+  readonly items: Schema.$Array<Schema.StructWithRest<Schema.Struct<{
+    readonly slug: Schema.String;
+    readonly name: Schema.String;
+    readonly description: Schema.String;
+    readonly toolkit: Schema.StructWithRest<Schema.Struct<{
+      readonly slug: Schema.String;
+      readonly name: Schema.String;
+      readonly logo: Schema.String;
+    }>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+    readonly input_parameters: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+    readonly no_auth: Schema.Boolean;
+    readonly available_versions: Schema.$Array<Schema.String>;
+    readonly version: Schema.String;
+    readonly instant: Schema.optionalKey<Schema.StructWithRest<Schema.Struct<{
+      readonly supported: Schema.Literal<true>;
+      readonly price: Schema.optionalKey<Schema.Struct<{
+        readonly description: Schema.optionalKey<Schema.String>;
+        readonly discount: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
+      }>>;
+    }>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>>;
+    readonly output_parameters: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+    readonly scopes: Schema.$Array<Schema.String>;
+    readonly scope_requirements: Schema.Union<readonly [Schema.StructWithRest<Schema.Struct<{
+      readonly all_of: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.StructWithRest<Schema.Struct<{
+        readonly any_of: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.StructWithRest<Schema.Struct<{
+          readonly all_of: Schema.$Array<Schema.String>;
+          readonly source: Schema.optionalKey<Schema.$Array<Schema.String>>;
+        }>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>]>>;
+        readonly when: Schema.optionalKey<Schema.$Record<Schema.String, Schema.$Array<Schema.String>>>;
+        readonly source: Schema.optionalKey<Schema.$Array<Schema.String>>;
+      }>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>]>>;
+      readonly source: Schema.optionalKey<Schema.$Array<Schema.String>>;
+    }>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>, Schema.Null]>;
+    readonly tags: Schema.$Array<Schema.String>;
+    readonly human_description: Schema.optionalKey<Schema.String>;
+    readonly is_deprecated: Schema.Boolean;
+    readonly deprecated: Schema.StructWithRest<Schema.Struct<{
+      readonly displayName: Schema.String;
+      readonly version: Schema.String;
+      readonly available_versions: Schema.$Array<Schema.String>;
+      readonly is_deprecated: Schema.Boolean;
+      readonly toolkit: Schema.StructWithRest<Schema.Struct<{
+        readonly logo: Schema.String;
+      }>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+    }>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+  }>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>>;
+  readonly next_cursor: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
+  readonly total_pages: Schema.Number;
+  readonly current_page: Schema.Number;
+  readonly total_items: Schema.Number;
+}>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+//#endregion
+export { ToolsPaginated };

package/dist/effect/schemas/components/tools-paginated.mjs

@@ -0,0 +1,15 @@
+import { Tool } from "./tool.mjs";
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/components/tools-paginated.ts
+/** The `ToolsPaginated` component schema. */
+const ToolsPaginated = Schema.StructWithRest(Schema.Struct({
+	"items": Schema.Array(Tool),
+	"next_cursor": Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+	"total_pages": Schema.Number.check(Schema.isFinite().annotate({ "expected": "a finite number" })),
+	"current_page": Schema.Number.check(Schema.isFinite().annotate({ "expected": "a finite number" })),
+	"total_items": Schema.Number.check(Schema.isFinite().annotate({ "expected": "a finite number" }))
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]).annotate({ "identifier": "ToolsPaginated" });
+
+//#endregion
+export { ToolsPaginated };

package/dist/effect/schemas/components/trigger-retrieve-response-log.d.mts

@@ -0,0 +1,31 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/components/trigger-retrieve-response-log.d.ts
+/** The `TriggerRetrieveResponseLog` component schema. */
+declare const TriggerRetrieveResponseLog: Schema.StructWithRest<Schema.Struct<{
+  readonly id: Schema.String;
+  readonly connectionId: Schema.String;
+  readonly clientId: Schema.String;
+  readonly entityId: Schema.String;
+  readonly status: Schema.String;
+  readonly appName: Schema.String;
+  readonly createdAt: Schema.String;
+  readonly type: Schema.Literals<readonly ["trigger", "action"]>;
+  readonly meta: Schema.StructWithRest<Schema.Struct<{
+    readonly id: Schema.String;
+    readonly type: Schema.Literals<readonly ["trigger", "action"]>;
+    readonly createdAt: Schema.String;
+    readonly updatedAt: Schema.String;
+    readonly provider: Schema.String;
+    readonly clientId: Schema.String;
+    readonly connectionId: Schema.String;
+    readonly triggerProviderPayload: Schema.optionalKey<Schema.String>;
+    readonly triggerClientPayload: Schema.optionalKey<Schema.String>;
+    readonly triggerClientError: Schema.optionalKey<Schema.String>;
+    readonly triggerName: Schema.optionalKey<Schema.String>;
+    readonly triggerClientResponse: Schema.optionalKey<Schema.String>;
+    readonly triggerId: Schema.optionalKey<Schema.String>;
+    readonly triggerNanoId: Schema.optionalKey<Schema.String>;
+  }>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+}>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+//#endregion
+export { TriggerRetrieveResponseLog };

package/dist/effect/schemas/components/trigger-retrieve-response-log.mjs

@@ -0,0 +1,39 @@
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/components/trigger-retrieve-response-log.ts
+/** The `TriggerRetrieveResponseLog` component schema. */
+const TriggerRetrieveResponseLog = Schema.StructWithRest(Schema.Struct({
+	"id": Schema.String,
+	"connectionId": Schema.String,
+	"clientId": Schema.String,
+	"entityId": Schema.String,
+	"status": Schema.String,
+	"appName": Schema.String,
+	"createdAt": Schema.String,
+	"type": Schema.Literals(["trigger", "action"]).annotate({
+		"description": "Log entity type (trigger or action)",
+		"examples": ["trigger"]
+	}),
+	"meta": Schema.StructWithRest(Schema.Struct({
+		"id": Schema.String,
+		"type": Schema.Literals(["trigger", "action"]).annotate({
+			"description": "Log entity type (trigger or action)",
+			"examples": ["trigger"]
+		}),
+		"createdAt": Schema.String,
+		"updatedAt": Schema.String,
+		"provider": Schema.String,
+		"clientId": Schema.String,
+		"connectionId": Schema.String,
+		"triggerProviderPayload": Schema.optionalKey(Schema.String),
+		"triggerClientPayload": Schema.optionalKey(Schema.String),
+		"triggerClientError": Schema.optionalKey(Schema.String),
+		"triggerName": Schema.optionalKey(Schema.String),
+		"triggerClientResponse": Schema.optionalKey(Schema.String),
+		"triggerId": Schema.optionalKey(Schema.String),
+		"triggerNanoId": Schema.optionalKey(Schema.String)
+	}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))])
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]).annotate({ "identifier": "TriggerRetrieveResponseLog" });
+
+//#endregion
+export { TriggerRetrieveResponseLog };

package/dist/effect/schemas/components/user-input-request.d.mts

@@ -0,0 +1,11 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/components/user-input-request.d.ts
+/** The `UserInputRequest` component schema. */
+declare const UserInputRequest: Schema.StructWithRest<Schema.Struct<{
+  readonly type: Schema.Literal<"elicitation">;
+  readonly mode: Schema.Literal<"form">;
+  readonly message: Schema.String;
+  readonly requested_schema: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+}>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+//#endregion
+export { UserInputRequest };

package/dist/effect/schemas/components/user-input-request.mjs

@@ -0,0 +1,19 @@
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/components/user-input-request.ts
+/** The `UserInputRequest` component schema. */
+const UserInputRequest = Schema.StructWithRest(Schema.Struct({
+	"type": Schema.Literal("elicitation").annotate({ "description": "Always `elicitation`" }),
+	"mode": Schema.Literal("form").annotate({ "description": "Always `form`: collect the answer with a form built from `requested_schema`" }),
+	"message": Schema.String.annotate({
+		"description": "Text to show the user",
+		"examples": ["Your agent wants to run the following tool:\n\nGITHUB_DELETE_A_REPOSITORY({\"owner\": \"acme\", \"repo\": \"old-api\"})"]
+	}),
+	"requested_schema": Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" })).annotate({ "description": "JSON Schema for the answer. As in MCP form mode, it is a flat object whose fields are strings, numbers, booleans, or single- or multi-select enums." })
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]).annotate({
+	"description": "A question for the user, in the shape of an MCP `elicitation/create` request in form mode (https://modelcontextprotocol.io/specification/2026-07-28/client/elicitation). Show `message` to the user and collect an answer that matches `requested_schema`.",
+	"identifier": "UserInputRequest"
+});
+
+//#endregion
+export { UserInputRequest };

package/dist/effect/schemas/connected-accounts/complete-auth.d.mts

@@ -0,0 +1,9 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/connected-accounts/complete-auth.d.ts
+/** The 200 response of `POST /api/v3.1/connected_accounts/complete_auth`, which `client.connectedAccounts.completeAuth` answers with. */
+declare const ConnectedAccountCompleteAuthResponse: Schema.StructWithRest<Schema.Struct<{
+  readonly connected_account_id: Schema.String;
+  readonly toolkit_slug: Schema.String;
+}>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+//#endregion
+export { ConnectedAccountCompleteAuthResponse };

package/dist/effect/schemas/connected-accounts/complete-auth.mjs

@@ -0,0 +1,11 @@
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/connected-accounts/complete-auth.ts
+/** The 200 response of `POST /api/v3.1/connected_accounts/complete_auth`, which `client.connectedAccounts.completeAuth` answers with. */
+const ConnectedAccountCompleteAuthResponse = Schema.StructWithRest(Schema.Struct({
+	"connected_account_id": Schema.String.annotate({ "description": "The connection that was completed." }),
+	"toolkit_slug": Schema.String.annotate({ "description": "The toolkit the connection belongs to." })
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]);
+
+//#endregion
+export { ConnectedAccountCompleteAuthResponse };