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

package/dist/effect/schemas/connected-accounts/list.mjs

@@ -0,0 +1,84 @@
+import { ConnectedAccountRetrieveResponseState } from "../components/connected-account-retrieve-response-state.mjs";
+import { SessionLinkResponseExperimental } from "../components/session-link-response-experimental.mjs";
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/connected-accounts/list.ts
+/** The 200 response of `GET /api/v3.1/connected_accounts`, which `client.connectedAccounts.list` answers with. */
+const ConnectedAccountListResponse = Schema.StructWithRest(Schema.Struct({
+	"items": Schema.Array(Schema.StructWithRest(Schema.Struct({
+		"toolkit": Schema.StructWithRest(Schema.Struct({ "slug": Schema.String.annotate({ "description": "The slug 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 id of the auth config",
+				"format": "authConfigId"
+			}),
+			"auth_scheme": 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 authScheme is part of the connection state use it there" }),
+			"is_composio_managed": Schema.Boolean.annotate({ "description": "Whether the auth config is managed by Composio" }),
+			"is_disabled": Schema.Boolean.annotate({ "description": "Whether the auth config is disabled" })
+		}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]),
+		"id": Schema.String.annotate({
+			"description": "The id of the connection",
+			"format": "connectedAccountId"
+		}),
+		"authScheme": 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": "Duplicates state.authScheme. Kept for backward compatibility with existing readers; use state.authScheme instead." })),
+		"word_id": Schema.Union([Schema.String, Schema.Null]).annotate({ "description": "A short, token-friendly identifier for multi-account disambiguation, typically toolkit-prefixed with 1-2 words (e.g., \"gmail_red-castle\")" }),
+		"alias": Schema.Union([Schema.String, Schema.Null]).annotate({ "description": "A user-defined alias for the connected account" }),
+		"user_id": Schema.String.annotate({ "description": "This is deprecated, we will not be providing userId from this api anymore, you will only be able to read via userId not get it back" }),
+		"status": Schema.Literals([
+			"INITIALIZING",
+			"INITIATED",
+			"ACTIVE",
+			"FAILED",
+			"EXPIRED",
+			"INACTIVE",
+			"REVOKED"
+		]).annotate({ "description": "The status of the connection" }),
+		"experimental": Schema.optionalKey(SessionLinkResponseExperimental),
+		"created_at": Schema.String.annotate({ "description": "The created at of the connection" }),
+		"updated_at": Schema.String.annotate({ "description": "The updated at of the connection" }),
+		"state": ConnectedAccountRetrieveResponseState,
+		"data": Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" })).annotate({ "description": "This is deprecated, use `state` instead" }),
+		"status_reason": Schema.Union([Schema.String, Schema.Null]).annotate({ "description": "The reason the connection status changed." }),
+		"is_disabled": Schema.Boolean.annotate({ "description": "Whether the connection is disabled" }),
+		"test_request_endpoint": Schema.optionalKey(Schema.String.annotate({ "description": "The endpoint to make test request for verification" }))
+	}), [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 { ConnectedAccountListResponse };

package/dist/effect/schemas/connected-accounts/patch.d.mts

@@ -0,0 +1,10 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/connected-accounts/patch.d.ts
+/** The 200 response of `PATCH /api/v3.1/connected_accounts/{nanoid}`, which `client.connectedAccounts.patch` answers with. */
+declare const ConnectedAccountPatchResponse: Schema.StructWithRest<Schema.Struct<{
+  readonly success: Schema.Boolean;
+  readonly id: Schema.String;
+  readonly status: Schema.String;
+}>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+//#endregion
+export { ConnectedAccountPatchResponse };

package/dist/effect/schemas/connected-accounts/patch.mjs

@@ -0,0 +1,19 @@
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/connected-accounts/patch.ts
+/** The 200 response of `PATCH /api/v3.1/connected_accounts/{nanoid}`, which `client.connectedAccounts.patch` answers with. */
+const ConnectedAccountPatchResponse = Schema.StructWithRest(Schema.Struct({
+	"success": Schema.Boolean.annotate({ "description": "Whether the update was successful" }),
+	"id": Schema.String.annotate({
+		"description": "The unique identifier of the updated connected account",
+		"format": "connectedAccountId"
+	}),
+	"status": Schema.String.annotate({ "description": "The current status of the connected account after the update (ACTIVE, EXPIRED, INACTIVE, etc.)" })
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]).annotate({ "examples": [{
+	"success": true,
+	"id": "ca_1a2b3c4d5e6f",
+	"status": "ACTIVE"
+}] });
+
+//#endregion
+export { ConnectedAccountPatchResponse };

package/dist/effect/schemas/connected-accounts/refresh.d.mts

@@ -0,0 +1,10 @@
+import * as Schema from "effect/Schema";
+//#region src/effect/generated/schemas/connected-accounts/refresh.d.ts
+/** The 200 response of `POST /api/v3.1/connected_accounts/{nanoid}/refresh`, which `client.connectedAccounts.refresh` answers with. */
+declare const ConnectedAccountRefreshResponse: Schema.StructWithRest<Schema.Struct<{
+  readonly id: Schema.String;
+  readonly status: Schema.Literals<readonly ["INITIALIZING", "INITIATED", "ACTIVE", "FAILED", "EXPIRED", "INACTIVE", "REVOKED"]>;
+  readonly redirect_url: Schema.Union<readonly [Schema.String, Schema.Null]>;
+}>, readonly [Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>]>;
+//#endregion
+export { ConnectedAccountRefreshResponse };

package/dist/effect/schemas/connected-accounts/refresh.mjs

@@ -0,0 +1,27 @@
+import * as Schema from "effect/Schema";
+
+//#region src/effect/generated/schemas/connected-accounts/refresh.ts
+/** The 200 response of `POST /api/v3.1/connected_accounts/{nanoid}/refresh`, which `client.connectedAccounts.refresh` answers with. */
+const ConnectedAccountRefreshResponse = Schema.StructWithRest(Schema.Struct({
+	"id": Schema.String.annotate({ "description": "The unique identifier of the connected account" }),
+	"status": Schema.Literals([
+		"INITIALIZING",
+		"INITIATED",
+		"ACTIVE",
+		"FAILED",
+		"EXPIRED",
+		"INACTIVE",
+		"REVOKED"
+	]).annotate({ "description": "The current status of the connected account (e.g., active, pending, failed)" }),
+	"redirect_url": Schema.Union([Schema.String, Schema.Null]).annotate({ "description": "The URL to which the user should be redirected to complete the authentication process (null for auth schemes that do not require redirection)" })
+}), [Schema.Record(Schema.String, Schema.Json.annotate({ "expected": "JSON value" }))]).annotate({
+	"description": "Response schema for a refreshed connected account authentication",
+	"examples": [{
+		"id": "ca_1a2b3c4d5e6f",
+		"status": "ACTIVE",
+		"redirect_url": "https://app.example.com/oauth/callback"
+	}]
+});
+
+//#endregion
+export { ConnectedAccountRefreshResponse };