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

package/dist/effect/schemas/auth/session/retrieve-info.mjs

@@ -0,0 +1,174 @@
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/auth/session/retrieve-info.ts
+/** The 200 response of `GET /api/v3.1/auth/session/info`, which `client.auth.session.retrieveInfo` answers with. */
+const SessionRetrieveInfoResponse = Schema.StructWithRest(Schema.Struct({
+	"project": Schema.Union([Schema.StructWithRest(Schema.Struct({
+		"auto_id": Schema.Number.annotate({
+			"description": "Internal auto-incrementing ID for the project",
+			"examples": [12345]
+		}).check(Schema.isFinite().annotate({ "expected": "a finite number" })),
+		"id": Schema.String.annotate({
+			"description": "UUID identifier for the project",
+			"examples": ["550e8400-e29b-41d4-a716-446655440000"]
+		}),
+		"org_id": Schema.String.annotate({
+			"description": "Organization UUID that this project belongs to",
+			"examples": ["550e8400-e29b-41d4-a716-446655440001"]
+		}),
+		"name": Schema.String.annotate({
+			"description": "User-defined name for the project",
+			"examples": ["Production API"]
+		}),
+		"email": Schema.String.annotate({
+			"description": "Email address used for project notifications",
+			"examples": ["project-123@composio.dev"]
+		}),
+		"nano_id": Schema.String.annotate({
+			"description": "Short, URL-friendly unique identifier for the project",
+			"examples": ["pr_1a2b3c4d5e6f"],
+			"format": "projectId"
+		}),
+		"created_at": Schema.String.annotate({
+			"description": "Date and time when the project was created",
+			"examples": ["2023-05-16T14:30:00.000Z"]
+		}),
+		"updated_at": Schema.String.annotate({
+			"description": "Date and time when the project was last modified",
+			"examples": ["2023-05-18T09:15:30.000Z"]
+		}),
+		"webhook_url": Schema.Union([Schema.String, Schema.Null]).annotate({
+			"description": "Endpoint URL for trigger webhook notifications",
+			"examples": ["https://example.com/webhook"]
+		}),
+		"event_webhook_url": Schema.Union([Schema.String, Schema.Null]).annotate({
+			"description": "Endpoint URL for event webhook notifications",
+			"examples": ["https://example.com/events"]
+		}),
+		"webhook_secret": Schema.Union([Schema.String, Schema.Null]).annotate({
+			"description": "Secret used to verify webhook signatures",
+			"examples": ["whsec_a1b2c3d4e5f6g7h8i9j0"]
+		}),
+		"triggers_enabled": Schema.Boolean.annotate({
+			"description": "Flag indicating if triggers are enabled for this project",
+			"examples": [true]
+		}),
+		"last_subscribed_at": Schema.Union([Schema.String, Schema.Null]).annotate({
+			"description": "Date and time when the project last subscribed to updates",
+			"examples": ["2023-05-17T10:00:00.000Z"]
+		}),
+		"deleted": Schema.Boolean.annotate({
+			"description": "Flag indicating if the project has been deleted",
+			"examples": [false]
+		}),
+		"is_new_webhook": Schema.Boolean.annotate({
+			"description": "Deprecated: Please refer to webhook_version instead. True indicates if the webhook configuration is using the previous new format (V2). False indicates the oldest format (V1)",
+			"examples": [true]
+		}),
+		"webhook_version": Schema.Literals([
+			"V1",
+			"V2",
+			"V3"
+		]).annotate({
+			"description": "Version of the webhook configuration",
+			"examples": ["V2"]
+		}),
+		"org": Schema.StructWithRest(Schema.Struct({
+			"id": Schema.String.annotate({
+				"description": "Short, URL-friendly unique identifier for the organization",
+				"examples": ["ok_1a2b3c4d5e6f"],
+				"format": "orgId"
+			}),
+			"name": Schema.String.annotate({
+				"description": "User-defined name for the organization",
+				"examples": ["Acme Corp"]
+			}),
+			"plan": Schema.String.annotate({
+				"description": "Current subscription plan level",
+				"examples": ["BUSINESS"]
+			})
+		}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]).annotate({ "description": "Organization details" })
+	}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]), Schema.Null]).annotate({ "description": "Details of the current active project (null if accessing with org-level credentials)" }),
+	"api_key": Schema.Union([Schema.StructWithRest(Schema.Struct({
+		"auto_id": Schema.Number.annotate({
+			"description": "Internal auto-incrementing ID for the API key",
+			"examples": [7890]
+		}).check(Schema.isFinite().annotate({ "expected": "a finite number" })),
+		"id": Schema.String.annotate({
+			"description": "UUID identifier for the API key",
+			"examples": ["550e8400-e29b-41d4-a716-446655440003"]
+		}),
+		"name": Schema.String.annotate({
+			"description": "User-defined name for the API key",
+			"examples": ["Development Key"]
+		}),
+		"project_id": Schema.String.annotate({
+			"description": "Short, URL-friendly unique identifier for the associated project",
+			"examples": ["pr_1a2b3c4d5e6f"],
+			"format": "projectId"
+		}),
+		"org_member_id": Schema.String.annotate({
+			"description": "UUID identifier for the organization member who owns this API key",
+			"examples": ["550e8400-e29b-41d4-a716-446655440002"]
+		}),
+		"created_at": Schema.String.annotate({
+			"description": "Date and time when the API key was created",
+			"examples": ["2023-05-01T10:00:00.000Z"]
+		}),
+		"updated_at": Schema.String.annotate({
+			"description": "Date and time when the API key was last modified",
+			"examples": ["2023-05-01T10:00:00.000Z"]
+		}),
+		"deleted_at": Schema.Union([Schema.String, Schema.Null]).annotate({ "description": "Date and time when the API key was deleted (if applicable)" }),
+		"key": Schema.String.annotate({
+			"description": "The actual API key value (usually only shown once during creation)",
+			"examples": ["ak_a1b2c3d4e5f6g7h8i9j0"]
+		}),
+		"deleted": Schema.Boolean.annotate({
+			"description": "Flag indicating if the API key has been deleted",
+			"examples": [false]
+		})
+	}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]), Schema.Null]).annotate({ "description": "Details of the API key used for authentication (null if using session auth)" }),
+	"org_member": Schema.StructWithRest(Schema.Struct({
+		"id": Schema.String.annotate({
+			"description": "UUID identifier for the organization member",
+			"examples": ["550e8400-e29b-41d4-a716-446655440002"]
+		}),
+		"email": Schema.String.annotate({
+			"description": "Email address of the authenticated user",
+			"examples": ["user@example.com"]
+		}),
+		"name": Schema.String.annotate({
+			"description": "Display name of the authenticated user",
+			"examples": ["John Doe"]
+		}),
+		"role": Schema.String.annotate({
+			"description": "Access role of the authenticated user within the organization",
+			"examples": ["admin"]
+		}),
+		"metadata": Schema.StructWithRest(Schema.Struct({
+			"prefers_old_dashboard": Schema.optionalKey(Schema.Boolean.annotate({ "description": "If true, the user will be redirected to the legacy dashboard at platform.composio.dev." })),
+			"onboarding_platform": Schema.optionalKey(Schema.Literals(["consumer", "developer"]).annotate({ "description": "Platform the user onboarded on." })),
+			"seen_flow_consumer": Schema.optionalKey(Schema.Boolean.annotate({ "description": "True once the user has completed the consumer onboarding flow." })),
+			"seen_flow_developer": Schema.optionalKey(Schema.Boolean.annotate({ "description": "True once the user has completed the developer onboarding flow." })),
+			"seen_flow_cli": Schema.optionalKey(Schema.Boolean.annotate({ "description": "True once the user has completed the CLI onboarding flow." })),
+			"seen_connect_announcement": Schema.optionalKey(Schema.Boolean.annotate({ "description": "True once the user has dismissed the Composio For You announcement modal in the developer dashboard." }))
+		}), [Schema.Record(Schema.String, Schema.Union([
+			Schema.String,
+			Schema.Boolean,
+			Schema.Number.check(Schema.isFinite().annotate({ "expected": "a finite number" }))
+		]))]).annotate({ "description": "User metadata (JSONB). Typed keys are shown; additional keys pass through unchanged." })
+	}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]).annotate({
+		"description": "Information about the authenticated user",
+		"examples": [{
+			"id": "550e8400-e29b-41d4-a716-446655440002",
+			"email": "user@example.com",
+			"name": "John Doe",
+			"role": "admin",
+			"metadata": { "prefers_old_dashboard": false }
+		}]
+	})
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]).annotate({ "description": "Response containing user session information" });
+
+//#endregion
+export { SessionRetrieveInfoResponse };

package/dist/effect/schemas/auth-configs/create.d.mts

@@ -0,0 +1,16 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/auth-configs/create.d.ts
+/** The 201 response of `POST /api/v3.1/auth_configs`, which `client.authConfigs.create` answers with. */
+declare const AuthConfigCreateResponse: Schema.StructWithRest<Schema.Struct<{
+  readonly toolkit: Schema.StructWithRest<Schema.Struct<{
+    readonly slug: Schema.String;
+  }>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+  readonly auth_config: Schema.StructWithRest<Schema.Struct<{
+    readonly id: Schema.String;
+    readonly auth_scheme: Schema.String;
+    readonly is_composio_managed: Schema.Boolean;
+    readonly restrict_to_following_tools: Schema.optionalKey<Schema.$Array<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 { AuthConfigCreateResponse };

package/dist/effect/schemas/auth-configs/create.mjs

@@ -0,0 +1,22 @@
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/auth-configs/create.ts
+/** The 201 response of `POST /api/v3.1/auth_configs`, which `client.authConfigs.create` answers with. */
+const AuthConfigCreateResponse = Schema.StructWithRest(Schema.Struct({
+	"toolkit": Schema.StructWithRest(Schema.Struct({ "slug": Schema.String.annotate({ "description": "The unique key of the toolkit" }) }), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]),
+	"auth_config": Schema.StructWithRest(Schema.Struct({
+		"id": Schema.String.annotate({
+			"description": "The auth config id of the toolkit (must be a valid auth config id)",
+			"format": "authConfigId"
+		}),
+		"auth_scheme": Schema.String.annotate({ "description": "The authentication mode of the toolkit" }),
+		"is_composio_managed": Schema.Boolean.annotate({ "description": "Whether the auth config is managed by Composio" }),
+		"restrict_to_following_tools": Schema.optionalKey(Schema.Array(Schema.String).annotate({
+			"description": "The tools that the user can use with the auth config. DEPRECATED: use [Get required scopes](https://docs.composio.dev/reference/api-reference/toolkits/recommendToolkitScopes) to resolve the scopes for the tools you need, then pass those scopes in `credentials.scopes`.",
+			"default": []
+		}))
+	}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))])
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]);
+
+//#endregion
+export { AuthConfigCreateResponse };

package/dist/effect/schemas/auth-configs/delete.d.mts

@@ -0,0 +1,10 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/auth-configs/delete.d.ts
+/** The 200 response of `DELETE /api/v3.1/auth_configs/{nanoid}`, which `client.authConfigs.delete` answers with. */
+declare const AuthConfigDeleteResponse: Schema.StructWithRest<Schema.Struct<{
+  readonly success: Schema.Boolean;
+  readonly message: Schema.String;
+  readonly revoke_job_id: Schema.optionalKey<Schema.String>;
+}>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+//#endregion
+export { AuthConfigDeleteResponse };

package/dist/effect/schemas/auth-configs/delete.mjs

@@ -0,0 +1,15 @@
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/auth-configs/delete.ts
+/** The 200 response of `DELETE /api/v3.1/auth_configs/{nanoid}`, which `client.authConfigs.delete` answers with. */
+const AuthConfigDeleteResponse = Schema.StructWithRest(Schema.Struct({
+	"success": Schema.Boolean.annotate({ "description": "Whether the auth config was deleted" }),
+	"message": Schema.String.annotate({ "description": "A human-readable result message" }),
+	"revoke_job_id": Schema.optionalKey(Schema.String.annotate({
+		"description": "Identifier of the background revoke job started for this delete. Present only when `revoke_on_delete=true`. Track the job and its per-connection results from the Composio dashboard — a programmatic endpoint to poll this job is not yet generally available.",
+		"examples": ["pj_1a2b3c4d5e6f"]
+	}))
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]);
+
+//#endregion
+export { AuthConfigDeleteResponse };

package/dist/effect/schemas/auth-configs/list.d.mts

@@ -0,0 +1,54 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/auth-configs/list.d.ts
+/** The 200 response of `GET /api/v3.1/auth_configs`, which `client.authConfigs.list` answers with. */
+declare const AuthConfigListResponse: Schema.StructWithRest<Schema.Struct<{
+  readonly items: Schema.$Array<Schema.StructWithRest<Schema.Struct<{
+    readonly id: Schema.String;
+    readonly uuid: Schema.String;
+    readonly type: Schema.Literals<readonly ["default", "custom"]>;
+    readonly toolkit: Schema.StructWithRest<Schema.Struct<{
+      readonly slug: Schema.String;
+      readonly logo: Schema.String;
+      readonly auth_guide_url: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
+      readonly auth_hint_url: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
+    }>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+    readonly name: Schema.String;
+    readonly auth_scheme: Schema.optionalKey<Schema.Literals<readonly ["OAUTH2", "OAUTH1", "API_KEY", "BASIC", "BILLCOM_AUTH", "BEARER_TOKEN", "GOOGLE_SERVICE_ACCOUNT", "NO_AUTH", "BASIC_WITH_JWT", "CALCOM_AUTH", "SERVICE_ACCOUNT", "SAML", "DCR_OAUTH", "CIMD_OAUTH", "S2S_OAUTH2"]>>;
+    readonly is_composio_managed: Schema.optionalKey<Schema.Boolean>;
+    readonly credentials: Schema.optionalKey<Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>>;
+    readonly proxy_config: Schema.optionalKey<Schema.Union<readonly [Schema.StructWithRest<Schema.Struct<{
+      readonly proxy_url: Schema.String;
+      readonly proxy_auth_key: Schema.optionalKey<Schema.String>;
+    }>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>, Schema.Null]>>;
+    readonly status: Schema.Literals<readonly ["ENABLED", "DISABLED"]>;
+    readonly created_by: Schema.optionalKey<Schema.String>;
+    readonly created_at: Schema.optionalKey<Schema.String>;
+    readonly last_updated_at: Schema.optionalKey<Schema.String>;
+    readonly no_of_connections: Schema.Number;
+    readonly expected_input_fields: Schema.optionalKey<Schema.$Array<Schema.StructWithRest<Schema.Struct<{
+      readonly name: Schema.String;
+      readonly displayName: Schema.String;
+      readonly default: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
+      readonly type: Schema.String;
+      readonly description: Schema.String;
+      readonly required: Schema.Boolean;
+      readonly is_secret: Schema.optionalKey<Schema.Boolean>;
+      readonly legacy_template_name: Schema.optionalKey<Schema.String>;
+      readonly user_visible: Schema.Boolean;
+      readonly is_available_as_shared_credentials: Schema.optionalKey<Schema.Boolean>;
+    }>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>>>;
+    readonly restrict_to_following_tools: Schema.optionalKey<Schema.$Array<Schema.String>>;
+    readonly tool_access_config: Schema.StructWithRest<Schema.Struct<{
+      readonly tools_for_connected_account_creation: Schema.optionalKey<Schema.$Array<Schema.String>>;
+      readonly tools_available_for_execution: Schema.optionalKey<Schema.$Array<Schema.String>>;
+    }>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+    readonly shared_credentials: Schema.optionalKey<Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>>;
+    readonly is_enabled_for_tool_router: Schema.optionalKey<Schema.Boolean>;
+  }>, 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 { AuthConfigListResponse };

package/dist/effect/schemas/auth-configs/list.mjs

@@ -0,0 +1,66 @@
+import { AuthConfigRetrieveResponseExpectedInputFields } from "../components/auth-config-retrieve-response-expected-input-fields.mjs";
+import { AuthConfigRetrieveResponseToolAccessConfig } from "../components/auth-config-retrieve-response-tool-access-config.mjs";
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/auth-configs/list.ts
+/** The 200 response of `GET /api/v3.1/auth_configs`, which `client.authConfigs.list` answers with. */
+const AuthConfigListResponse = Schema.StructWithRest(Schema.Struct({
+	"items": Schema.Array(Schema.StructWithRest(Schema.Struct({
+		"id": Schema.String.annotate({
+			"description": "The unique ID of the authentication configuration",
+			"format": "authConfigId"
+		}),
+		"uuid": Schema.String.annotate({ "description": "The UUID of the authentication configuration (for backward compatibility)" }),
+		"type": Schema.Literals(["default", "custom"]).annotate({ "description": "The type of the authentication configuration (custom or default)" }),
+		"toolkit": Schema.StructWithRest(Schema.Struct({
+			"slug": Schema.String.annotate({ "description": "The unique identifier of the integration app" }),
+			"logo": Schema.String.annotate({ "description": "The URL to the integration app's logo image" }),
+			"auth_guide_url": Schema.optionalKey(Schema.Union([Schema.String, Schema.Null]).annotate({ "description": "URL to a guide page with authentication setup instructions" })),
+			"auth_hint_url": Schema.optionalKey(Schema.Union([Schema.String, Schema.Null]).annotate({ "description": "URL to a page where users can obtain or configure credentials" }))
+		}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]).annotate({ "description": "Information about the associated integration" }),
+		"name": Schema.String.annotate({ "description": "The display name of the authentication configuration" }),
+		"auth_scheme": Schema.optionalKey(Schema.Literals([
+			"OAUTH2",
+			"OAUTH1",
+			"API_KEY",
+			"BASIC",
+			"BILLCOM_AUTH",
+			"BEARER_TOKEN",
+			"GOOGLE_SERVICE_ACCOUNT",
+			"NO_AUTH",
+			"BASIC_WITH_JWT",
+			"CALCOM_AUTH",
+			"SERVICE_ACCOUNT",
+			"SAML",
+			"DCR_OAUTH",
+			"CIMD_OAUTH",
+			"S2S_OAUTH2"
+		]).annotate({ "description": "The authentication scheme used (e.g., OAuth2, API Key, etc.)" })),
+		"is_composio_managed": Schema.optionalKey(Schema.Boolean.annotate({ "description": "Whether this authentication configuration is managed by Composio or the user" })),
+		"credentials": Schema.optionalKey(Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" })).annotate({ "description": "The authentication credentials (tokens, keys, etc.) - may be partially hidden for security" })),
+		"proxy_config": Schema.optionalKey(Schema.Union([Schema.StructWithRest(Schema.Struct({
+			"proxy_url": Schema.String.annotate({
+				"description": "The url of the auth proxy",
+				"format": "uri"
+			}),
+			"proxy_auth_key": Schema.optionalKey(Schema.String.annotate({ "description": "The auth key for the auth proxy" }))
+		}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]), Schema.Null])),
+		"status": Schema.Literals(["ENABLED", "DISABLED"]).annotate({ "description": "Current status of the authentication configuration" }),
+		"created_by": Schema.optionalKey(Schema.String.annotate({ "description": "The identifier of the user who created the auth config" })),
+		"created_at": Schema.optionalKey(Schema.String.annotate({ "description": "ISO 8601 date-time when the auth config was created" })),
+		"last_updated_at": Schema.optionalKey(Schema.String.annotate({ "description": "ISO 8601 date-time when the auth config was last updated" })),
+		"no_of_connections": Schema.Number.annotate({ "description": "The number of active connections using this auth config" }).check(Schema.isFinite().annotate({ "expected": "a finite number" })),
+		"expected_input_fields": Schema.optionalKey(AuthConfigRetrieveResponseExpectedInputFields),
+		"restrict_to_following_tools": Schema.optionalKey(Schema.Array(Schema.String).annotate({ "description": "List of tool slugs this auth config is restricted to use with. DEPRECATED: use [Get required scopes](https://docs.composio.dev/reference/api-reference/toolkits/recommendToolkitScopes) to resolve the scopes for the tools you need, then pass those scopes in `credentials.scopes`." })),
+		"tool_access_config": AuthConfigRetrieveResponseToolAccessConfig,
+		"shared_credentials": Schema.optionalKey(Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" })).annotate({ "description": "[EXPERIMENTAL] Shared credentials that will be inherited by all connected accounts using this auth config" })),
+		"is_enabled_for_tool_router": Schema.optionalKey(Schema.Boolean.annotate({ "description": "Whether this auth config is enabled for tool router" }))
+	}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))])),
+	"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" }))]);
+
+//#endregion
+export { AuthConfigListResponse };

package/dist/effect/schemas/auth-configs/retrieve.d.mts

@@ -0,0 +1,48 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/auth-configs/retrieve.d.ts
+/** The 200 response of `GET /api/v3.1/auth_configs/{nanoid}`, which `client.authConfigs.retrieve` answers with. */
+declare const AuthConfigRetrieveResponse: Schema.StructWithRest<Schema.Struct<{
+  readonly id: Schema.String;
+  readonly uuid: Schema.String;
+  readonly type: Schema.Literals<readonly ["default", "custom"]>;
+  readonly toolkit: Schema.StructWithRest<Schema.Struct<{
+    readonly slug: Schema.String;
+    readonly logo: Schema.String;
+    readonly auth_guide_url: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
+    readonly auth_hint_url: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
+  }>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+  readonly name: Schema.String;
+  readonly auth_scheme: Schema.optionalKey<Schema.Literals<readonly ["OAUTH2", "OAUTH1", "API_KEY", "BASIC", "BILLCOM_AUTH", "BEARER_TOKEN", "GOOGLE_SERVICE_ACCOUNT", "NO_AUTH", "BASIC_WITH_JWT", "CALCOM_AUTH", "SERVICE_ACCOUNT", "SAML", "DCR_OAUTH", "CIMD_OAUTH", "S2S_OAUTH2"]>>;
+  readonly is_composio_managed: Schema.optionalKey<Schema.Boolean>;
+  readonly credentials: Schema.optionalKey<Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>>;
+  readonly proxy_config: Schema.optionalKey<Schema.Union<readonly [Schema.StructWithRest<Schema.Struct<{
+    readonly proxy_url: Schema.String;
+    readonly proxy_auth_key: Schema.optionalKey<Schema.String>;
+  }>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>, Schema.Null]>>;
+  readonly status: Schema.Literals<readonly ["ENABLED", "DISABLED"]>;
+  readonly created_by: Schema.optionalKey<Schema.String>;
+  readonly created_at: Schema.optionalKey<Schema.String>;
+  readonly last_updated_at: Schema.optionalKey<Schema.String>;
+  readonly no_of_connections: Schema.Number;
+  readonly expected_input_fields: Schema.optionalKey<Schema.$Array<Schema.StructWithRest<Schema.Struct<{
+    readonly name: Schema.String;
+    readonly displayName: Schema.String;
+    readonly default: Schema.optionalKey<Schema.Union<readonly [Schema.String, Schema.Null]>>;
+    readonly type: Schema.String;
+    readonly description: Schema.String;
+    readonly required: Schema.Boolean;
+    readonly is_secret: Schema.optionalKey<Schema.Boolean>;
+    readonly legacy_template_name: Schema.optionalKey<Schema.String>;
+    readonly user_visible: Schema.Boolean;
+    readonly is_available_as_shared_credentials: Schema.optionalKey<Schema.Boolean>;
+  }>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>>>;
+  readonly restrict_to_following_tools: Schema.optionalKey<Schema.$Array<Schema.String>>;
+  readonly tool_access_config: Schema.StructWithRest<Schema.Struct<{
+    readonly tools_for_connected_account_creation: Schema.optionalKey<Schema.$Array<Schema.String>>;
+    readonly tools_available_for_execution: Schema.optionalKey<Schema.$Array<Schema.String>>;
+  }>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+  readonly shared_credentials: Schema.optionalKey<Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>>;
+  readonly is_enabled_for_tool_router: Schema.optionalKey<Schema.Boolean>;
+}>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+//#endregion
+export { AuthConfigRetrieveResponse };

package/dist/effect/schemas/auth-configs/retrieve.mjs

@@ -0,0 +1,60 @@
+import { AuthConfigRetrieveResponseExpectedInputFields } from "../components/auth-config-retrieve-response-expected-input-fields.mjs";
+import { AuthConfigRetrieveResponseToolAccessConfig } from "../components/auth-config-retrieve-response-tool-access-config.mjs";
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/auth-configs/retrieve.ts
+/** The 200 response of `GET /api/v3.1/auth_configs/{nanoid}`, which `client.authConfigs.retrieve` answers with. */
+const AuthConfigRetrieveResponse = Schema.StructWithRest(Schema.Struct({
+	"id": Schema.String.annotate({
+		"description": "The unique ID of the authentication configuration",
+		"format": "authConfigId"
+	}),
+	"uuid": Schema.String.annotate({ "description": "The UUID of the authentication configuration (for backward compatibility)" }),
+	"type": Schema.Literals(["default", "custom"]).annotate({ "description": "The type of the authentication configuration (custom or default)" }),
+	"toolkit": Schema.StructWithRest(Schema.Struct({
+		"slug": Schema.String.annotate({ "description": "The unique identifier of the integration app" }),
+		"logo": Schema.String.annotate({ "description": "The URL to the integration app's logo image" }),
+		"auth_guide_url": Schema.optionalKey(Schema.Union([Schema.String, Schema.Null]).annotate({ "description": "URL to a guide page with authentication setup instructions" })),
+		"auth_hint_url": Schema.optionalKey(Schema.Union([Schema.String, Schema.Null]).annotate({ "description": "URL to a page where users can obtain or configure credentials" }))
+	}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]).annotate({ "description": "Information about the associated integration" }),
+	"name": Schema.String.annotate({ "description": "The display name of the authentication configuration" }),
+	"auth_scheme": Schema.optionalKey(Schema.Literals([
+		"OAUTH2",
+		"OAUTH1",
+		"API_KEY",
+		"BASIC",
+		"BILLCOM_AUTH",
+		"BEARER_TOKEN",
+		"GOOGLE_SERVICE_ACCOUNT",
+		"NO_AUTH",
+		"BASIC_WITH_JWT",
+		"CALCOM_AUTH",
+		"SERVICE_ACCOUNT",
+		"SAML",
+		"DCR_OAUTH",
+		"CIMD_OAUTH",
+		"S2S_OAUTH2"
+	]).annotate({ "description": "The authentication scheme used (e.g., OAuth2, API Key, etc.)" })),
+	"is_composio_managed": Schema.optionalKey(Schema.Boolean.annotate({ "description": "Whether this authentication configuration is managed by Composio or the user" })),
+	"credentials": Schema.optionalKey(Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" })).annotate({ "description": "The authentication credentials (tokens, keys, etc.) - may be partially hidden for security" })),
+	"proxy_config": Schema.optionalKey(Schema.Union([Schema.StructWithRest(Schema.Struct({
+		"proxy_url": Schema.String.annotate({
+			"description": "The url of the auth proxy",
+			"format": "uri"
+		}),
+		"proxy_auth_key": Schema.optionalKey(Schema.String.annotate({ "description": "The auth key for the auth proxy" }))
+	}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]), Schema.Null])),
+	"status": Schema.Literals(["ENABLED", "DISABLED"]).annotate({ "description": "Current status of the authentication configuration" }),
+	"created_by": Schema.optionalKey(Schema.String.annotate({ "description": "The identifier of the user who created the auth config" })),
+	"created_at": Schema.optionalKey(Schema.String.annotate({ "description": "ISO 8601 date-time when the auth config was created" })),
+	"last_updated_at": Schema.optionalKey(Schema.String.annotate({ "description": "ISO 8601 date-time when the auth config was last updated" })),
+	"no_of_connections": Schema.Number.annotate({ "description": "The number of active connections using this auth config" }).check(Schema.isFinite().annotate({ "expected": "a finite number" })),
+	"expected_input_fields": Schema.optionalKey(AuthConfigRetrieveResponseExpectedInputFields),
+	"restrict_to_following_tools": Schema.optionalKey(Schema.Array(Schema.String).annotate({ "description": "List of tool slugs this auth config is restricted to use with. DEPRECATED: use [Get required scopes](https://docs.composio.dev/reference/api-reference/toolkits/recommendToolkitScopes) to resolve the scopes for the tools you need, then pass those scopes in `credentials.scopes`." })),
+	"tool_access_config": AuthConfigRetrieveResponseToolAccessConfig,
+	"shared_credentials": Schema.optionalKey(Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" })).annotate({ "description": "[EXPERIMENTAL] Shared credentials that will be inherited by all connected accounts using this auth config" })),
+	"is_enabled_for_tool_router": Schema.optionalKey(Schema.Boolean.annotate({ "description": "Whether this auth config is enabled for tool router" }))
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]);
+
+//#endregion
+export { AuthConfigRetrieveResponse };

package/dist/effect/schemas/auth-configs/update-status.d.mts

@@ -0,0 +1,9 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/auth-configs/update-status.d.ts
+/** The 200 response of `PATCH /api/v3.1/auth_configs/{nanoid}/{status}`, which `client.authConfigs.updateStatus` answers with. */
+declare const AuthConfigUpdateStatusResponse: Schema.StructWithRest<Schema.Struct<{
+  readonly success: Schema.Boolean;
+  readonly message: Schema.String;
+}>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+//#endregion
+export { AuthConfigUpdateStatusResponse };

package/dist/effect/schemas/auth-configs/update-status.mjs

@@ -0,0 +1,11 @@
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/auth-configs/update-status.ts
+/** The 200 response of `PATCH /api/v3.1/auth_configs/{nanoid}/{status}`, which `client.authConfigs.updateStatus` answers with. */
+const AuthConfigUpdateStatusResponse = Schema.StructWithRest(Schema.Struct({
+	"success": Schema.Boolean.annotate({ "description": "Whether the status update succeeded" }),
+	"message": Schema.String.annotate({ "description": "A human-readable result message" })
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]);
+
+//#endregion
+export { AuthConfigUpdateStatusResponse };

package/dist/effect/schemas/auth-configs/update.d.mts

@@ -0,0 +1,9 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/auth-configs/update.d.ts
+/** The 200 response of `PATCH /api/v3.1/auth_configs/{nanoid}`, which `client.authConfigs.update` answers with. */
+declare const AuthConfigUpdateResponse: Schema.StructWithRest<Schema.Struct<{
+  readonly success: Schema.Boolean;
+  readonly message: Schema.String;
+}>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+//#endregion
+export { AuthConfigUpdateResponse };

package/dist/effect/schemas/auth-configs/update.mjs

@@ -0,0 +1,11 @@
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/auth-configs/update.ts
+/** The 200 response of `PATCH /api/v3.1/auth_configs/{nanoid}`, which `client.authConfigs.update` answers with. */
+const AuthConfigUpdateResponse = Schema.StructWithRest(Schema.Struct({
+	"success": Schema.Boolean.annotate({ "description": "Whether the auth config was updated" }),
+	"message": Schema.String.annotate({ "description": "A human-readable result message" })
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]);
+
+//#endregion
+export { AuthConfigUpdateResponse };

package/dist/effect/schemas/cli/create-codact-failure.d.mts

@@ -0,0 +1,9 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/cli/create-codact-failure.d.ts
+/** The 200 response of `POST /api/v3.1/cli/codact_failures`, which `client.cli.createCodactFailure` answers with. */
+declare const CliCreateCodactFailureResponse: Schema.StructWithRest<Schema.Struct<{
+  readonly tracked: Schema.Boolean;
+  readonly id: Schema.String;
+}>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+//#endregion
+export { CliCreateCodactFailureResponse };

package/dist/effect/schemas/cli/create-codact-failure.mjs

@@ -0,0 +1,17 @@
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/cli/create-codact-failure.ts
+/** The 200 response of `POST /api/v3.1/cli/codact_failures`, which `client.cli.createCodactFailure` answers with. */
+const CliCreateCodactFailureResponse = Schema.StructWithRest(Schema.Struct({
+	"tracked": Schema.Boolean.annotate({
+		"description": "Whether the codact failure row was accepted for storage.",
+		"examples": [true]
+	}),
+	"id": Schema.String.annotate({
+		"description": "Unique identifier for the stored failure row.",
+		"examples": ["5f6f7a1d-72d1-4f7c-bf3a-2fd7421bc123"]
+	})
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]);
+
+//#endregion
+export { CliCreateCodactFailureResponse };

package/dist/effect/schemas/cli/create-session.d.mts

@@ -0,0 +1,12 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/cli/create-session.d.ts
+/** The 201 response of `POST /api/v3.1/cli/create-session`, which `client.cli.createSession` answers with. */
+declare const CliCreateSessionResponse: Schema.StructWithRest<Schema.Struct<{
+  readonly id: Schema.String;
+  readonly code: Schema.String;
+  readonly expiresAt: Schema.String;
+  readonly status: Schema.Literals<readonly ["pending", "linked"]>;
+  readonly scope: Schema.Literals<readonly ["project", "user"]>;
+}>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+//#endregion
+export { CliCreateSessionResponse };

package/dist/effect/schemas/cli/create-session.mjs

@@ -0,0 +1,26 @@
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/cli/create-session.ts
+/** The 201 response of `POST /api/v3.1/cli/create-session`, which `client.cli.createSession` answers with. */
+const CliCreateSessionResponse = Schema.StructWithRest(Schema.Struct({
+	"id": Schema.String.annotate({ "description": "Unique identifier for the CLI session. UUID v4 format used for tracking and retrieval." }),
+	"code": Schema.String.annotate({
+		"description": "The 6-character hexadecimal code used for CLI login",
+		"examples": ["ABC123"]
+	}),
+	"expiresAt": Schema.String.annotate({
+		"description": "The ISO timestamp when the session expires",
+		"examples": ["2023-01-01T12:00:00.000Z"]
+	}),
+	"status": Schema.Literals(["pending", "linked"]).annotate({
+		"description": "The current status of the session",
+		"examples": ["pending"]
+	}),
+	"scope": Schema.Literals(["project", "user"]).annotate({
+		"description": "The key scope for this session",
+		"examples": ["project"]
+	})
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]);
+
+//#endregion
+export { CliCreateSessionResponse };

package/dist/effect/schemas/cli/get-session.d.mts

@@ -0,0 +1,18 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/cli/get-session.d.ts
+/** The 200 response of `GET /api/v3.1/cli/get-session`, which `client.cli.getSession` answers with. */
+declare const CliGetSessionResponse: Schema.StructWithRest<Schema.Struct<{
+  readonly id: Schema.String;
+  readonly code: Schema.String;
+  readonly status: Schema.Literals<readonly ["pending", "linked"]>;
+  readonly expiresAt: Schema.String;
+  readonly account: Schema.Union<readonly [Schema.StructWithRest<Schema.Struct<{
+    readonly id: Schema.String;
+    readonly email: Schema.String;
+    readonly name: Schema.String;
+  }>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>, Schema.Null]>;
+  readonly api_key: Schema.Union<readonly [Schema.String, Schema.Null]>;
+  readonly scope: Schema.Union<readonly [Schema.Literals<readonly ["project", "user"]>, Schema.Null]>;
+}>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+//#endregion
+export { CliGetSessionResponse };