diff --git a/.gitignore b/.gitignore index 53fa6f8..bbd4940 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ node_modules/ dist/ -types/ +/types/* lib/ \ No newline at end of file diff --git a/docs/types/sdk_client_types_gen.CreateConnectionData.html b/docs/types/sdk_client_types_gen.CreateConnectionData.html new file mode 100644 index 0000000..4a7595d --- /dev/null +++ b/docs/types/sdk_client_types_gen.CreateConnectionData.html @@ -0,0 +1 @@ +
Optional
requestOptional
data?: { Optional
redirectOptional
userOptional
connectedOptional
connectionOptional
redirectOptional
requestOptional
appOptional
authAn object containing the authentication configuration for the connector.
+Optional
api_The API key used for authentication with the app - if authScheme is API_KEY
+Optional
base_The base URL for making API requests to the app.
+Optional
client_The client ID used for authentication with the app - if authScheme is OAUTH2
+Optional
client_The client secret used for authentication with the app - if authScheme is OAUTH2
+Optional
consumer_The Consumer key used for authentication with the app - if authScheme is OAUTH1
+Optional
consumer_The Consumer secret used for authentication with the app - if authScheme is OAUTH1
+Optional
authThe authentication scheme used by the connector (e.g., "OAUTH2", "API_KEY").
+Optional
name?: stringThe name of the connector.
+Optional
useUse default Composio credentials to proceed. The developer app credentials will be of Composio.
+Optional
appThe unique identifier of the app associated with the connector.
+Optional
appThe name of the app associated with the connector.
+Optional
authAn object containing the authentication configuration for the connector.
+Optional
base_The base URL for making API requests to the app.
+Optional
client_The client ID used for authentication with the app.
+Optional
client_The client secret used for authentication with the app.
+Optional
authThe authentication scheme used by the connector.
+Optional
createdThe timestamp indicating when the connector was created.
+Optional
enabled?: booleanA boolean indicating whether the connector is enabled or not.
+Optional
expectedAn array of input fields expected by the connector.
+Optional
id?: stringThe unique identifier of the newly created connector.
+Optional
logo?: stringThe URL of the logo of the app associated with the connector.
+Optional
name?: stringThe name of the connector.
+Optional
updatedThe timestamp indicating when the connector was last updated.
+The unique identifier of the connection.
+Optional
status?: stringStatus of the api call.
+The name of the action to execute.
+Optional
requestOptional
appOptional
connectedThe unique identifier of the connection to use for executing the action.
+Optional
input?: { An object containing the input parameters for the action.
+Optional
execution_An object containing the details of the action execution.
+Optional
executed?: booleanA boolean indicating whether the action was executed successfully.
+Optional
response_An object containing the response data from the action execution.
+The unique identifier of the action.
+Optional
appThe unique identifier of the app associated with the action.
+Optional
appThe key of the app associated with the action.
+Optional
appThe name of the app associated with the action.
+Optional
description?: stringA description of the action.
+Optional
display_The display name of the action.
+Optional
enabled?: booleanA boolean indicating whether the action is enabled or not.
+Optional
logo?: stringThe URL of the logo of the app associated with the action.
+Optional
name?: stringThe name of the action.
+Optional
parameters?: { An object describing the input parameters of the action.
+Optional
properties?: { An object containing the properties of the input parameters.
+Optional
required?: string[]An array of required parameter names.
+Optional
title?: stringThe title of the input parameters.
+Optional
type?: stringThe type of the input parameters (e.g., "object").
+Optional
response?: { An object describing the response of the action.
+Optional
properties?: { An object containing the properties of the response.
+Optional
required?: string[]An array of required response field names.
+Optional
title?: stringThe title of the response.
+Optional
type?: stringThe type of the response (e.g., "object").
+The ID of the trigger to retrieve.
+Optional
connectionIdentifier for the connection associated with the trigger.
+Optional
createdTimestamp when the trigger was created.
+Optional
disabledTimestamp when the trigger was disabled, if applicable.
+Optional
id?: stringUnique identifier for the trigger.
+Optional
state?: { State information for the trigger.
+Optional
triggerConfiguration settings for the trigger.
+Optional
triggerData associated with the trigger.
+Optional
triggerName of the trigger.
+Optional
updatedTimestamp when the trigger was last updated.
+Optional
configuration_Optional
description?: stringOptional
docs?: stringOptional
documentation_Optional
logo?: stringOptional
testThe unique identifier of the connection.
+Optional
connectionAn object containing the parameters specific to the connection.
+Optional
access_The access token used for authentication with the connected app.
+Optional
base_The base URL for making API requests to the connected app.
+Optional
client_The client ID used for authentication with the connected app.
+Optional
client_The client secret used for authentication with the connected app.
+Optional
scope?: stringThe scope of permissions granted to the connection.
+Optional
token_The type of token used for authentication (e.g., "bearer").
+Optional
createdThe timestamp indicating when the connection was created.
+Optional
id?: stringThe unique identifier of the connection.
+The unique identifier of the connector associated with the connection.
+Optional
status?: "ACTIVE" | "INITIATED" | "FAILED"The status of the connection (e.g., "SUCCESS").
+Optional
updatedThe timestamp indicating when the connection was last updated.
+The unique identifier of the integration.
+Optional
appThe unique identifier of the app associated with the connector.
+Optional
appThe name of the app associated with the connector.
+Optional
authAn object containing the authentication configuration for the connector.
+Optional
base_The base URL for making API requests to the app.
+Optional
client_The client ID used for authentication with the app.
+Optional
client_The client secret used for authentication with the app.
+Optional
authThe authentication scheme used by the connector (e.g., "OAUTH2", "API_KEY").
+Optional
createdThe timestamp indicating when the connector was created.
+Optional
enabled?: booleanA boolean indicating whether the connector is enabled or not.
+Optional
expectedAn array of input fields expected by the connector.
+Optional
id?: stringThe unique identifier of the connector.
+Optional
logo?: stringThe URL of the logo of the app associated with the connector.
+Optional
name?: stringThe name of the connector.
+Optional
updatedThe timestamp indicating when the connector was last updated.
+Optional
actions?: stringFilter by Action names
+Optional
apps?: stringName of the apps like "github", "linear" seperated by a comma
+Optional
showShow all actions - i.e disable pagination
+Optional
showShow actions enabled for the API Key
+Optional
tags?: stringFilter by Action tags
+Optional
useFilter by use case
+Optional
usecaseLimit of use-cases based search
+Optional
items?: { An array of action objects.
+Optional
connectedFilter by Connected Account ids
+Optional
integrationFilter by Integration ids
+Optional
triggerFilter by Trigger ids
+Optional
triggerFilter by Trigger names
+Optional
pageOptional
currentThe current page number.
+Optional
perThe number of items per page.
+Optional
totalThe total number of pages.
+Optional
triggers?: { Optional
items?: { An array of app objects.
+Optional
integrationFilter by using specific Integration
+Optional
page?: numberPage number to fetch
+Optional
pagePage size to assume
+Optional
user_Filter by using specific entity id, seperated by comma
+Optional
items?: { Optional
page?: numberOptional
totalOptional
page?: numberPage number to fetch
+Optional
pagePage Size to assume
+Optional
items?: { Optional
page?: numberOptional
totalOptional
appName of the apps like "github", "linear" seperated by a comma
+Optional
connectedFilter by Aonnected Account ids
+Optional
showShow triggers enabled for the API Key
+Optional
appThe unique ID of the app.
+Optional
appThe key of the app.
+Optional
appThe name of the app.
+Optional
config?: { Optional
properties?: { Optional
description?: stringstring
+Optional
required?: string[]Optional
title?: stringstring
+Optional
type?: stringstring
+Optional
required?: string[]Optional
title?: stringOptional
type?: stringOptional
count?: numberThe count of the event.
+Optional
description?: stringA brief description of the event.
+Optional
display_The display name of the event.
+Optional
enabled?: booleanWhether the event is enabled.
+Optional
instructions?: stringInstructions for the event.
+Optional
logo?: stringThe URL of the app's logo image.
+Optional
name?: stringThe name of the event.
+Optional
payload?: { Optional
properties?: { The GitHub username of the commit author.
+The SHA of the commit.
+The commit message.
+The timestamp of the commit.
+The GitHub URL of the commit.
+The ID of the trigger to enable or disable.
+Optional
verifyThe unique identifier of the integration.
+Optional
requestOptional
enabled?: booleanAll the parameters that you see in the GET connector
+Optional
status?: stringOK
+Optional
appThe unique identifier of the app associated with the action.
+Optional
appThe name of the app associated with the action.
+Optional
description?: stringA description of the action.
+Optional
display_The display name of the action.
+Optional
enabled?: booleanA boolean indicating whether the action is enabled or not.
+Optional
logo?: stringThe URL of the logo of the app associated with the action.
+Optional
name?: stringThe name of the action.
+Optional
parameters?: { An object describing the input parameters of the action.
+Optional
properties?: { An object containing the properties of the input parameters.
+Optional
required?: string[]An array of required parameter names.
+Optional
title?: stringThe title of the input parameters.
+Optional
type?: stringThe type of the input parameters (e.g., "object").
+Optional
response?: { An object describing the response of the action.
+Optional
properties?: { An object containing the properties of the response.
+Optional
required?: string[]An array of required response field names.
+Optional
title?: stringThe title of the response.
+Optional
type?: stringThe type of the response (e.g., "object").
+Not Found
+OK
+Optional
execution_An object containing the details of the action execution.
+Optional
executed?: booleanA boolean indicating whether the action was executed successfully.
+Optional
response_An object containing the response data from the action execution.
+Not Found
+OK
+Optional
items?: { An array of app objects.
+OK
+Optional
items?: { Optional
page?: numberOptional
totalOK
+Optional
connectionOptional
connectionOptional
redirect{ +"message": "Connector not found" +}
+{ +"message": "Connection not found or already deleted" +}
+Optional
status?: stringStatus of the api call.
+Not Found
+OK
+Optional
connectionAn object containing the parameters specific to the connection.
+Optional
access_The access token used for authentication with the connected app.
+Optional
base_The base URL for making API requests to the connected app.
+Optional
client_The client ID used for authentication with the connected app.
+Optional
client_The client secret used for authentication with the connected app.
+Optional
scope?: stringThe scope of permissions granted to the connection.
+Optional
token_The type of token used for authentication (e.g., "bearer").
+Optional
createdThe timestamp indicating when the connection was created.
+Optional
id?: stringThe unique identifier of the connection.
+Optional
integrationThe unique identifier of the connector associated with the connection.
+Optional
status?: "ACTIVE" | "INITIATED" | "FAILED"The status of the connection (e.g., "SUCCESS").
+Optional
updatedThe timestamp indicating when the connection was last updated.
+{ +"message": "Connection not found or already deleted" +}
+OK
+Optional
items?: { Optional
page?: numberOptional
totalOK
+Optional
appThe unique identifier of the app associated with the connector.
+Optional
appThe name of the app associated with the connector.
+Optional
authAn object containing the authentication configuration for the connector.
+Optional
base_The base URL for making API requests to the app.
+Optional
client_The client ID used for authentication with the app.
+Optional
client_The client secret used for authentication with the app.
+Optional
authThe authentication scheme used by the connector.
+Optional
createdThe timestamp indicating when the connector was created.
+Optional
enabled?: booleanA boolean indicating whether the connector is enabled or not.
+Optional
expectedAn array of input fields expected by the connector.
+Optional
id?: stringThe unique identifier of the newly created connector.
+Optional
logo?: stringThe URL of the logo of the app associated with the connector.
+Optional
name?: stringThe name of the connector.
+Optional
updatedThe timestamp indicating when the connector was last updated.
+Bad Request
+OK
+Optional
appThe unique identifier of the app associated with the connector.
+Optional
appThe name of the app associated with the connector.
+Optional
authAn object containing the authentication configuration for the connector.
+Optional
base_The base URL for making API requests to the app.
+Optional
client_The client ID used for authentication with the app.
+Optional
client_The client secret used for authentication with the app.
+Optional
authThe authentication scheme used by the connector (e.g., "OAUTH2", "API_KEY").
+Optional
createdThe timestamp indicating when the connector was created.
+Optional
enabled?: booleanA boolean indicating whether the connector is enabled or not.
+Optional
expectedAn array of input fields expected by the connector.
+Optional
id?: stringThe unique identifier of the connector.
+Optional
logo?: stringThe URL of the logo of the app associated with the connector.
+Optional
name?: stringThe name of the connector.
+Optional
updatedThe timestamp indicating when the connector was last updated.
+Not Found
+OK
+Optional
status?: stringNot Found
+OK
+A list of active triggers
+Optional
pageOptional
currentThe current page number.
+Optional
perThe number of items per page.
+Optional
totalThe total number of pages.
+Optional
triggers?: { A successful response containing the details of the active trigger.
+Optional
connectionIdentifier for the connection associated with the trigger.
+Optional
createdTimestamp when the trigger was created.
+Optional
disabledTimestamp when the trigger was disabled, if applicable.
+Optional
id?: stringUnique identifier for the trigger.
+Optional
state?: { State information for the trigger.
+Optional
triggerConfiguration settings for the trigger.
+Optional
triggerData associated with the trigger.
+Optional
triggerName of the trigger.
+Optional
updatedTimestamp when the trigger was last updated.
+Trigger not found
+Internal server error
+OK
+Optional
items?: { An array of action objects.
+Optional
page?: numberThe current page number of the action list.
+Optional
totalThe total number of pages available for the action list.
+
The unique identifier of the app associated with the connector.
+