Composio
composio-core / sdk / Composio
Class: Composio
Defined in: js/src/sdk/index.ts:33
Constructors
Constructor
new Composio(
config):Composio
Defined in: js/src/sdk/index.ts:58
Initializes a new instance of the Composio class.
Parameters
config
Configuration object for the Composio SDK
allowTracing?
boolean
Whether to allow tracing for the SDK.
apiKey?
string
The API key for authenticating with the Composio backend. Can also be set locally in an environment variable.
baseUrl?
string
The base URL for the Composio backend. By default, it is set to the production URL.
runtime?
string
The runtime environment for the SDK.
Returns
Composio
Properties
actions
actions:
Actions
Defined in: js/src/sdk/index.ts:42
activeTriggers
activeTriggers:
ActiveTriggers
Defined in: js/src/sdk/index.ts:45
apps
apps:
Apps
Defined in: js/src/sdk/index.ts:41
backendClient
backendClient:
AxiosBackendClient
Defined in: js/src/sdk/index.ts:39
The Composio class serves as the main entry point for interacting with the Composio SDK. It provides access to various models that allow for operations on connected accounts, apps, actions, triggers, integrations, and active triggers.
connectedAccounts
connectedAccounts:
ConnectedAccounts
Defined in: js/src/sdk/index.ts:40
fileName
fileName:
string="js/src/sdk/index.ts"
Defined in: js/src/sdk/index.ts:47
integrations
integrations:
Integrations
Defined in: js/src/sdk/index.ts:44
triggers
triggers:
Triggers
Defined in: js/src/sdk/index.ts:43
Methods
getEntity()
getEntity(
id?):Entity
Defined in: js/src/sdk/index.ts:168
Retrieves an Entity instance associated with a given ID.
Parameters
id?
string = "default"
The ID of the entity to retrieve.
Returns
Entity
An instance of the Entity class.
getExpectedParamsForUser()
getExpectedParamsForUser(
params):Promise<{authScheme:"OAUTH2"|"OAUTH1"|"OAUTH1A"|"API_KEY"|"BASIC"|"BEARER_TOKEN"|"GOOGLE_SERVICE_ACCOUNT"|"NO_AUTH"|"BASIC_WITH_JWT";expectedInputFields:object[];integrationId:string; }>
Defined in: js/src/sdk/index.ts:177
Parameters
params
app?
string = ...
authScheme?
"OAUTH2" | "OAUTH1" | "OAUTH1A" | "API_KEY" | "BASIC" | "BEARER_TOKEN" | "GOOGLE_SERVICE_ACCOUNT" | "NO_AUTH" | "BASIC_WITH_JWT" = ...
entityId?
string = ...
integrationId?
string = ...
Returns
Promise<{ authScheme: "OAUTH2" | "OAUTH1" | "OAUTH1A" | "API_KEY" | "BASIC" | "BEARER_TOKEN" | "GOOGLE_SERVICE_ACCOUNT" | "NO_AUTH" | "BASIC_WITH_JWT"; expectedInputFields: object[]; integrationId: string; }>