@composio/client 2.0.0-rc.9 → 2.0.0

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,55 @@
+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 shared_connection_fields: 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.Finite;
+  readonly current_page: Schema.Finite;
+  readonly total_items: Schema.Finite;
+}>, 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,67 @@
+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": "Shared credentials that will be inherited by all connected accounts using this auth config. DEPRECATED: use `shared_connection_fields` instead. It takes the same value and behaves the same way." })),
+		"shared_connection_fields": Schema.optionalKey(Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" })).annotate({ "description": "Connection field values inherited by every connected account created under this auth config. Same value as shared_credentials; secret values are redacted." })),
+		"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.Finite,
+	"current_page": Schema.Finite,
+	"total_items": Schema.Finite
+}), [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,49 @@
+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 shared_connection_fields: 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,61 @@
+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": "Shared credentials that will be inherited by all connected accounts using this auth config. DEPRECATED: use `shared_connection_fields` instead. It takes the same value and behaves the same way." })),
+	"shared_connection_fields": Schema.optionalKey(Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" })).annotate({ "description": "Connection field values inherited by every connected account created under this auth config. Same value as shared_credentials; secret values are redacted." })),
+	"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/components/auth-config-retrieve-response-expected-input-fields.d.mts

@@ -0,0 +1,17 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/components/auth-config-retrieve-response-expected-input-fields.d.ts
+/** The `AuthConfigRetrieveResponseExpectedInputFields` component schema. */
+declare const AuthConfigRetrieveResponseExpectedInputFields: 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>>]>>;
+//#endregion
+export { AuthConfigRetrieveResponseExpectedInputFields };

package/dist/effect/schemas/components/auth-config-retrieve-response-expected-input-fields.mjs

@@ -0,0 +1,22 @@
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/components/auth-config-retrieve-response-expected-input-fields.ts
+/** The `AuthConfigRetrieveResponseExpectedInputFields` component schema. */
+const AuthConfigRetrieveResponseExpectedInputFields = Schema.Array(Schema.StructWithRest(Schema.Struct({
+	"name": Schema.String,
+	"displayName": Schema.String,
+	"default": Schema.optionalKey(Schema.Union([Schema.String, Schema.Null])),
+	"type": Schema.String,
+	"description": Schema.String,
+	"required": Schema.Boolean,
+	"is_secret": Schema.optionalKey(Schema.Boolean.annotate({ "description": "Whether this field holds a secret/credential value. Clients use it to decide whether to mask the input." })),
+	"legacy_template_name": Schema.optionalKey(Schema.String),
+	"user_visible": Schema.Boolean.annotate({ "description": "Whether this field is shown to the end user in the hosted connect flow. Fields with `false` are never required — the field's `default` applies unless the developer supplies a value on the auth config (e.g. as a shared credential)." }),
+	"is_available_as_shared_credentials": Schema.optionalKey(Schema.Boolean)
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))])).annotate({
+	"description": "Fields expected during connection initialization",
+	"identifier": "AuthConfigRetrieveResponseExpectedInputFields"
+});
+
+//#endregion
+export { AuthConfigRetrieveResponseExpectedInputFields };

package/dist/effect/schemas/components/auth-config-retrieve-response-tool-access-config.d.mts

@@ -0,0 +1,9 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/components/auth-config-retrieve-response-tool-access-config.d.ts
+/** The `AuthConfigRetrieveResponseToolAccessConfig` component schema. */
+declare const AuthConfigRetrieveResponseToolAccessConfig: 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>>]>;
+//#endregion
+export { AuthConfigRetrieveResponseToolAccessConfig };

package/dist/effect/schemas/components/auth-config-retrieve-response-tool-access-config.mjs

@@ -0,0 +1,20 @@
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/components/auth-config-retrieve-response-tool-access-config.ts
+/** The `AuthConfigRetrieveResponseToolAccessConfig` component schema. */
+const AuthConfigRetrieveResponseToolAccessConfig = Schema.StructWithRest(Schema.Struct({
+	"tools_for_connected_account_creation": Schema.optionalKey(Schema.Array(Schema.String).annotate({
+		"description": "Tools used to generate the minimum required scopes for the auth config (only valid for OAuth). If passed, this will update the scopes. 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": []
+	})),
+	"tools_available_for_execution": Schema.optionalKey(Schema.Array(Schema.String).annotate({
+		"description": "The actions that the user can perform on the auth config. If passed, this will update the actions that the user can perform on 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" }))]).annotate({
+	"description": "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`.",
+	"identifier": "AuthConfigRetrieveResponseToolAccessConfig"
+});
+
+//#endregion
+export { AuthConfigRetrieveResponseToolAccessConfig };

package/dist/effect/schemas/components/block-reason.d.mts

@@ -0,0 +1,12 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/components/block-reason.d.ts
+/** The `BlockReason` component schema. */
+declare const BlockReason: Schema.Union<readonly [Schema.StructWithRest<Schema.Struct<{
+  readonly type: Schema.Literal<"request_blocked">;
+  readonly hook_id: Schema.String;
+}>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>, Schema.StructWithRest<Schema.Struct<{
+  readonly type: Schema.Literal<"response_blocked">;
+  readonly hook_id: Schema.String;
+}>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>]>;
+//#endregion
+export { BlockReason };

package/dist/effect/schemas/components/block-reason.mjs

@@ -0,0 +1,14 @@
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/components/block-reason.ts
+/** The `BlockReason` component schema. */
+const BlockReason = Schema.Union([Schema.StructWithRest(Schema.Struct({
+	"type": Schema.Literal("request_blocked").annotate({ "description": "A before_execute hook stopped the call. The tool did not run." }),
+	"hook_id": Schema.String
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]), Schema.StructWithRest(Schema.Struct({
+	"type": Schema.Literal("response_blocked").annotate({ "description": "An after_execute hook stopped the call. The tool ran; its response was withheld." }),
+	"hook_id": Schema.String
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))])], { mode: "oneOf" }).annotate({ "identifier": "BlockReason" });
+
+//#endregion
+export { BlockReason };

package/dist/effect/schemas/components/connected-account-create-response-connection-data-option1-val-option1.d.mts

@@ -0,0 +1,31 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/components/connected-account-create-response-connection-data-option1-val-option1.d.ts
+/** The `ConnectedAccountCreateResponseConnectionDataOption1ValOption1` component schema. */
+declare const ConnectedAccountCreateResponseConnectionDataOption1ValOption1: Schema.StructWithRest<Schema.Struct<{
+  readonly subdomain: Schema.optionalKey<Schema.String>;
+  readonly "your-domain": Schema.optionalKey<Schema.String>;
+  readonly region: Schema.optionalKey<Schema.String>;
+  readonly shop: Schema.optionalKey<Schema.String>;
+  readonly account_url: Schema.optionalKey<Schema.String>;
+  readonly COMPANYDOMAIN: Schema.optionalKey<Schema.String>;
+  readonly extension: Schema.optionalKey<Schema.String>;
+  readonly form_api_base_url: Schema.optionalKey<Schema.String>;
+  readonly instanceEndpoint: Schema.optionalKey<Schema.String>;
+  readonly api_url: Schema.optionalKey<Schema.String>;
+  readonly borneo_dashboard_url: Schema.optionalKey<Schema.String>;
+  readonly proxy_username: Schema.optionalKey<Schema.String>;
+  readonly proxy_password: Schema.optionalKey<Schema.String>;
+  readonly domain: Schema.optionalKey<Schema.String>;
+  readonly version: Schema.optionalKey<Schema.String>;
+  readonly dc: Schema.optionalKey<Schema.String>;
+  readonly site_name: Schema.optionalKey<Schema.String>;
+  readonly instanceName: Schema.optionalKey<Schema.String>;
+  readonly account_id: Schema.optionalKey<Schema.String>;
+  readonly your_server: Schema.optionalKey<Schema.String>;
+  readonly server_location: Schema.optionalKey<Schema.String>;
+  readonly base_url: Schema.optionalKey<Schema.String>;
+  readonly displayName: Schema.optionalKey<Schema.String>;
+  readonly status: Schema.Literal<"INITIALIZING">;
+}>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+//#endregion
+export { ConnectedAccountCreateResponseConnectionDataOption1ValOption1 };

package/dist/effect/schemas/components/connected-account-create-response-connection-data-option1-val-option1.mjs

@@ -0,0 +1,33 @@
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/components/connected-account-create-response-connection-data-option1-val-option1.ts
+/** The `ConnectedAccountCreateResponseConnectionDataOption1ValOption1` component schema. */
+const ConnectedAccountCreateResponseConnectionDataOption1ValOption1 = Schema.StructWithRest(Schema.Struct({
+	"subdomain": Schema.optionalKey(Schema.String),
+	"your-domain": Schema.optionalKey(Schema.String),
+	"region": Schema.optionalKey(Schema.String),
+	"shop": Schema.optionalKey(Schema.String),
+	"account_url": Schema.optionalKey(Schema.String),
+	"COMPANYDOMAIN": Schema.optionalKey(Schema.String),
+	"extension": Schema.optionalKey(Schema.String),
+	"form_api_base_url": Schema.optionalKey(Schema.String),
+	"instanceEndpoint": Schema.optionalKey(Schema.String),
+	"api_url": Schema.optionalKey(Schema.String),
+	"borneo_dashboard_url": Schema.optionalKey(Schema.String),
+	"proxy_username": Schema.optionalKey(Schema.String),
+	"proxy_password": Schema.optionalKey(Schema.String),
+	"domain": Schema.optionalKey(Schema.String),
+	"version": Schema.optionalKey(Schema.String),
+	"dc": Schema.optionalKey(Schema.String),
+	"site_name": Schema.optionalKey(Schema.String),
+	"instanceName": Schema.optionalKey(Schema.String),
+	"account_id": Schema.optionalKey(Schema.String),
+	"your_server": Schema.optionalKey(Schema.String),
+	"server_location": Schema.optionalKey(Schema.String),
+	"base_url": Schema.optionalKey(Schema.String),
+	"displayName": Schema.optionalKey(Schema.String),
+	"status": Schema.Literal("INITIALIZING")
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]).annotate({ "identifier": "ConnectedAccountCreateResponseConnectionDataOption1ValOption1" });
+
+//#endregion
+export { ConnectedAccountCreateResponseConnectionDataOption1ValOption1 };

package/dist/effect/schemas/components/connected-account-create-response-connection-data-option1-val-option4.d.mts

@@ -0,0 +1,33 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/components/connected-account-create-response-connection-data-option1-val-option4.d.ts
+/** The `ConnectedAccountCreateResponseConnectionDataOption1ValOption4` component schema. */
+declare const ConnectedAccountCreateResponseConnectionDataOption1ValOption4: Schema.StructWithRest<Schema.Struct<{
+  readonly subdomain: Schema.optionalKey<Schema.String>;
+  readonly "your-domain": Schema.optionalKey<Schema.String>;
+  readonly region: Schema.optionalKey<Schema.String>;
+  readonly shop: Schema.optionalKey<Schema.String>;
+  readonly account_url: Schema.optionalKey<Schema.String>;
+  readonly COMPANYDOMAIN: Schema.optionalKey<Schema.String>;
+  readonly extension: Schema.optionalKey<Schema.String>;
+  readonly form_api_base_url: Schema.optionalKey<Schema.String>;
+  readonly instanceEndpoint: Schema.optionalKey<Schema.String>;
+  readonly api_url: Schema.optionalKey<Schema.String>;
+  readonly borneo_dashboard_url: Schema.optionalKey<Schema.String>;
+  readonly proxy_username: Schema.optionalKey<Schema.String>;
+  readonly proxy_password: Schema.optionalKey<Schema.String>;
+  readonly domain: Schema.optionalKey<Schema.String>;
+  readonly version: Schema.optionalKey<Schema.String>;
+  readonly dc: Schema.optionalKey<Schema.String>;
+  readonly site_name: Schema.optionalKey<Schema.String>;
+  readonly instanceName: Schema.optionalKey<Schema.String>;
+  readonly account_id: Schema.optionalKey<Schema.String>;
+  readonly your_server: Schema.optionalKey<Schema.String>;
+  readonly server_location: Schema.optionalKey<Schema.String>;
+  readonly base_url: Schema.optionalKey<Schema.String>;
+  readonly displayName: Schema.optionalKey<Schema.String>;
+  readonly status: Schema.Literal<"FAILED">;
+  readonly error: Schema.optionalKey<Schema.String>;
+  readonly error_description: Schema.optionalKey<Schema.String>;
+}>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+//#endregion
+export { ConnectedAccountCreateResponseConnectionDataOption1ValOption4 };

package/dist/effect/schemas/components/connected-account-create-response-connection-data-option1-val-option4.mjs

@@ -0,0 +1,35 @@
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/components/connected-account-create-response-connection-data-option1-val-option4.ts
+/** The `ConnectedAccountCreateResponseConnectionDataOption1ValOption4` component schema. */
+const ConnectedAccountCreateResponseConnectionDataOption1ValOption4 = Schema.StructWithRest(Schema.Struct({
+	"subdomain": Schema.optionalKey(Schema.String),
+	"your-domain": Schema.optionalKey(Schema.String),
+	"region": Schema.optionalKey(Schema.String),
+	"shop": Schema.optionalKey(Schema.String),
+	"account_url": Schema.optionalKey(Schema.String),
+	"COMPANYDOMAIN": Schema.optionalKey(Schema.String),
+	"extension": Schema.optionalKey(Schema.String),
+	"form_api_base_url": Schema.optionalKey(Schema.String),
+	"instanceEndpoint": Schema.optionalKey(Schema.String),
+	"api_url": Schema.optionalKey(Schema.String),
+	"borneo_dashboard_url": Schema.optionalKey(Schema.String),
+	"proxy_username": Schema.optionalKey(Schema.String),
+	"proxy_password": Schema.optionalKey(Schema.String),
+	"domain": Schema.optionalKey(Schema.String),
+	"version": Schema.optionalKey(Schema.String),
+	"dc": Schema.optionalKey(Schema.String),
+	"site_name": Schema.optionalKey(Schema.String),
+	"instanceName": Schema.optionalKey(Schema.String),
+	"account_id": Schema.optionalKey(Schema.String),
+	"your_server": Schema.optionalKey(Schema.String),
+	"server_location": Schema.optionalKey(Schema.String),
+	"base_url": Schema.optionalKey(Schema.String),
+	"displayName": Schema.optionalKey(Schema.String),
+	"status": Schema.Literal("FAILED"),
+	"error": Schema.optionalKey(Schema.String),
+	"error_description": Schema.optionalKey(Schema.String)
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]).annotate({ "identifier": "ConnectedAccountCreateResponseConnectionDataOption1ValOption4" });
+
+//#endregion
+export { ConnectedAccountCreateResponseConnectionDataOption1ValOption4 };

package/dist/effect/schemas/components/connected-account-create-response-connection-data-option1-val-option5.d.mts

@@ -0,0 +1,32 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/components/connected-account-create-response-connection-data-option1-val-option5.d.ts
+/** The `ConnectedAccountCreateResponseConnectionDataOption1ValOption5` component schema. */
+declare const ConnectedAccountCreateResponseConnectionDataOption1ValOption5: Schema.StructWithRest<Schema.Struct<{
+  readonly subdomain: Schema.optionalKey<Schema.String>;
+  readonly "your-domain": Schema.optionalKey<Schema.String>;
+  readonly region: Schema.optionalKey<Schema.String>;
+  readonly shop: Schema.optionalKey<Schema.String>;
+  readonly account_url: Schema.optionalKey<Schema.String>;
+  readonly COMPANYDOMAIN: Schema.optionalKey<Schema.String>;
+  readonly extension: Schema.optionalKey<Schema.String>;
+  readonly form_api_base_url: Schema.optionalKey<Schema.String>;
+  readonly instanceEndpoint: Schema.optionalKey<Schema.String>;
+  readonly api_url: Schema.optionalKey<Schema.String>;
+  readonly borneo_dashboard_url: Schema.optionalKey<Schema.String>;
+  readonly proxy_username: Schema.optionalKey<Schema.String>;
+  readonly proxy_password: Schema.optionalKey<Schema.String>;
+  readonly domain: Schema.optionalKey<Schema.String>;
+  readonly version: Schema.optionalKey<Schema.String>;
+  readonly dc: Schema.optionalKey<Schema.String>;
+  readonly site_name: Schema.optionalKey<Schema.String>;
+  readonly instanceName: Schema.optionalKey<Schema.String>;
+  readonly account_id: Schema.optionalKey<Schema.String>;
+  readonly your_server: Schema.optionalKey<Schema.String>;
+  readonly server_location: Schema.optionalKey<Schema.String>;
+  readonly base_url: Schema.optionalKey<Schema.String>;
+  readonly displayName: Schema.optionalKey<Schema.String>;
+  readonly status: Schema.Literal<"EXPIRED">;
+  readonly expired_at: Schema.optionalKey<Schema.String>;
+}>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+//#endregion
+export { ConnectedAccountCreateResponseConnectionDataOption1ValOption5 };