<div align="center"> [](https://composio.dev) # [Composio](https://composio.dev)<a id="composio"></a> Composio SDK: Equip your agent with high-quality tools and build your real-world usecase [](https://rubygems.org/gems/composio/versions/0.1.0) [](https://composio.dev) </div> ## Table of Contents<a id="table-of-contents"></a> <!-- toc --> - [Installation](#installation) - [Getting Started](#getting-started) - [Raw HTTP Response](#raw-http-response) - [Reference](#reference) * [`composio.api_keys.generate`](#composioapi_keysgenerate) * [`composio.api_keys.list`](#composioapi_keyslist) * [`composio.api_keys.remove`](#composioapi_keysremove) * [`composio.actions.execute`](#composioactionsexecute) * [`composio.actions.execute_0`](#composioactionsexecute_0) * [`composio.actions.execute_action_proxy`](#composioactionsexecute_action_proxy) * [`composio.actions.execute_proxy`](#composioactionsexecute_proxy) * [`composio.actions.get`](#composioactionsget) * [`composio.actions.get_action_by_id`](#composioactionsget_action_by_id) * [`composio.actions.get_all_actions_based_on_query`](#composioactionsget_all_actions_based_on_query) * [`composio.actions.list`](#composioactionslist) * [`composio.actions.list_0`](#composioactionslist_0) * [`composio.apps.get_details`](#composioappsget_details) * [`composio.apps.list`](#composioappslist) * [`composio.apps.list_open_api_specs`](#composioappslist_open_api_specs) * [`composio.auth.identify_client_operation`](#composioauthidentify_client_operation) * [`composio.auth.send_magic_link`](#composioauthsend_magic_link) * [`composio.auth.user_logout`](#composioauthuser_logout) * [`composio.auth.verify_magic_link`](#composioauthverify_magic_link) * [`composio.cli.exchange_code`](#composiocliexchange_code) * [`composio.cli.get_code`](#composiocliget_code) * [`composio.cli.verify_code`](#composiocliverify_code) * [`composio.connections.delete`](#composioconnectionsdelete) * [`composio.connections.disable`](#composioconnectionsdisable) * [`composio.connections.enable`](#composioconnectionsenable) * [`composio.connections.get`](#composioconnectionsget) * [`composio.connections.initiate`](#composioconnectionsinitiate) * [`composio.connections.list`](#composioconnectionslist) * [`composio.integrations.create_integration`](#composiointegrationscreate_integration) * [`composio.integrations.delete_connector`](#composiointegrationsdelete_connector) * [`composio.integrations.get_connector_info`](#composiointegrationsget_connector_info) * [`composio.integrations.list_global_connectors`](#composiointegrationslist_global_connectors) * [`composio.integrations.update_integration`](#composiointegrationsupdate_integration) * [`composio.integrations.update_status`](#composiointegrationsupdate_status) * [`composio.logs.list`](#composiologslist) * [`composio.metadata.get_toggle_info`](#composiometadataget_toggle_info) * [`composio.metadata.toggle_trigger_state`](#composiometadatatoggle_trigger_state) * [`composio.team.get_member_list`](#composioteamget_member_list) * [`composio.team.send_invitation`](#composioteamsend_invitation) * [`composio.triggers.delete_trigger_instance`](#composiotriggersdelete_trigger_instance) * [`composio.triggers.disable_trigger_instance`](#composiotriggersdisable_trigger_instance) * [`composio.triggers.enable`](#composiotriggersenable) * [`composio.triggers.get_active_triggers`](#composiotriggersget_active_triggers) * [`composio.triggers.get_by_id`](#composiotriggersget_by_id) * [`composio.triggers.get_callback_url`](#composiotriggersget_callback_url) * [`composio.triggers.get_logs_based_on_connection_and_integration_details`](#composiotriggersget_logs_based_on_connection_and_integration_details) * [`composio.triggers.get_trigger_info`](#composiotriggersget_trigger_info) * [`composio.triggers.list`](#composiotriggerslist) * [`composio.triggers.set_callback_url`](#composiotriggersset_callback_url) * [`composio.triggers.switch_instance_status`](#composiotriggersswitch_instance_status) * [`composio.triggers.switch_post_instance_status`](#composiotriggersswitch_post_instance_status) <!-- tocstop --> ## Installation<a id="installation"></a> Add to Gemfile: ```ruby gem 'composio', '~> 0.1.0' ``` ## Getting Started<a id="getting-started"></a> ```ruby require 'composio' configuration = Composio::Configuration.new configuration.api_key = 'YOUR API KEY' composio = composio::Client.new(configuration) result = composio.api_keys.generate( name: "string_example", ) p result ``` ## Raw HTTP Response<a id="raw-http-response"></a> To access the raw HTTP response, suffix any method with `_with_http_info`. ```ruby result = composio.api_keys.generate_with_http_info( name: "string_example", ) p result.data # [APIKeyResDTO] Deserialized data p.result.status_code # [Integer] HTTP status code p.result.headers # [Hash] HTTP headers p.result.response # [Faraday::Response] Raw HTTP response ``` ## Reference<a id="reference"></a> ### `composio.api_keys.generate`<a id="composioapi_keysgenerate"></a> Generate api key #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.api_keys.generate( name: "string_example", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### name: `String`<a id="name-string"></a> The name of the API key to be generated #### 🔄 Return<a id="🔄-return"></a> [APIKeyResDTO](./lib/composio/models/api_key_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/api_keys` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.api_keys.list`<a id="composioapi_keyslist"></a> List api keys #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.api_keys.list p result ``` #### 🔄 Return<a id="🔄-return"></a> [APIKeyResDTO](./lib/composio/models/api_key_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/api_keys` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.api_keys.remove`<a id="composioapi_keysremove"></a> Delete api key #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.api_keys.remove( id: "'+j>6", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### id: `String`<a id="id-string"></a> #### 🔄 Return<a id="🔄-return"></a> [DeleteAPIKeyResponseDTO](./lib/composio/models/delete_api_key_response_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/api_keys/{id}` `DELETE` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.actions.execute`<a id="composioactionsexecute"></a> Execute action #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.actions.execute( action_id: "'+j>6", connected_account_id: "string_example", app_name: "string_example", entity_id: "string_example", endpoint: "string_example", input: {}, text: "string_example", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### action_id: `String`<a id="action_id-string"></a> ##### connectedAccountId: `String`<a id="connectedaccountid-string"></a> ##### appName: `String`<a id="appname-string"></a> ##### entityId: `String`<a id="entityid-string"></a> ##### endpoint: `String`<a id="endpoint-string"></a> ##### input: `Object`<a id="input-object"></a> ##### text: `String`<a id="text-string"></a> #### 🔄 Return<a id="🔄-return"></a> [ActionExecutionResDto](./lib/composio/models/action_execution_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/actions/{actionId}/execute` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.actions.execute_0`<a id="composioactionsexecute_0"></a> Execute an action. Support both connected account and no auth auth. #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.actions.execute_0( action_id: "'+j>6", connected_account_id: "string_example", app_name: "string_example", entity_id: "string_example", endpoint: "string_example", input: {}, text: "string_example", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### action_id: `String`<a id="action_id-string"></a> ##### connectedAccountId: `String`<a id="connectedaccountid-string"></a> ##### appName: `String`<a id="appname-string"></a> ##### entityId: `String`<a id="entityid-string"></a> ##### endpoint: `String`<a id="endpoint-string"></a> ##### input: `Object`<a id="input-object"></a> ##### text: `String`<a id="text-string"></a> #### 🔄 Return<a id="🔄-return"></a> [ActionExecutionResDto](./lib/composio/models/action_execution_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v2/actions/{actionId}/execute` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.actions.execute_action_proxy`<a id="composioactionsexecute_action_proxy"></a> Execute an action with direct auth. #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.actions.execute_action_proxy( endpoint: "endpoint_example", connected_account_id: "connectedAccountId_example", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### endpoint: `String`<a id="endpoint-string"></a> ##### connected_account_id: `String`<a id="connected_account_id-string"></a> #### 🔄 Return<a id="🔄-return"></a> [ActionExecutionResDto](./lib/composio/models/action_execution_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v2/actions/proxy` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.actions.execute_proxy`<a id="composioactionsexecute_proxy"></a> Execute action proxy #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.actions.execute_proxy( endpoint: "endpoint_example", connected_account_id: "connectedAccountId_example", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### endpoint: `String`<a id="endpoint-string"></a> ##### connected_account_id: `String`<a id="connected_account_id-string"></a> #### 🔄 Return<a id="🔄-return"></a> [ExecuteActionResDTO](./lib/composio/models/execute_action_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/actions/proxy` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.actions.get`<a id="composioactionsget"></a> Get action #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.actions.get( action_id: "'+j>6", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### action_id: `String`<a id="action_id-string"></a> #### 🔄 Return<a id="🔄-return"></a> [ActionDetails](./lib/composio/models/action_details.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/actions/{actionId}` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.actions.get_action_by_id`<a id="composioactionsget_action_by_id"></a> Get action details #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.actions.get_action_by_id( action_id: "'+j>6", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### action_id: `String`<a id="action_id-string"></a> #### 🔄 Return<a id="🔄-return"></a> [ActionDetails](./lib/composio/models/action_details.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v2/actions/{actionId}` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.actions.get_all_actions_based_on_query`<a id="composioactionsget_all_actions_based_on_query"></a> Retrieve a list of all actions based on query parameters. #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.actions.get_all_actions_based_on_query( app_names: "string_example", use_case: "string_example", show_enabled_only: true, limit: 3.14, apps: "string_example", actions: "string_example", tags: "string_example", usecase_limit: 3.14, filter_important_actions: true, show_all: true, ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### app_names: `String`<a id="app_names-string"></a> ##### use_case: `String`<a id="use_case-string"></a> ##### show_enabled_only: `Boolean`<a id="show_enabled_only-boolean"></a> ##### limit: `Float`<a id="limit-float"></a> ##### apps: `String`<a id="apps-string"></a> ##### actions: `String`<a id="actions-string"></a> ##### tags: `String`<a id="tags-string"></a> ##### usecase_limit: `Float`<a id="usecase_limit-float"></a> ##### filter_important_actions: `Boolean`<a id="filter_important_actions-boolean"></a> ##### show_all: `Boolean`<a id="show_all-boolean"></a> #### 🔄 Return<a id="🔄-return"></a> [ActionsListResponseDTO](./lib/composio/models/actions_list_response_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v2/actions/list/all` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.actions.list`<a id="composioactionslist"></a> List actions #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.actions.list( app_names: "string_example", use_case: "string_example", show_enabled_only: true, limit: 3.14, apps: "string_example", actions: "string_example", tags: "string_example", usecase_limit: 3.14, filter_important_actions: true, show_all: true, ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### app_names: `String`<a id="app_names-string"></a> ##### use_case: `String`<a id="use_case-string"></a> ##### show_enabled_only: `Boolean`<a id="show_enabled_only-boolean"></a> ##### limit: `Float`<a id="limit-float"></a> ##### apps: `String`<a id="apps-string"></a> ##### actions: `String`<a id="actions-string"></a> ##### tags: `String`<a id="tags-string"></a> ##### usecase_limit: `Float`<a id="usecase_limit-float"></a> ##### filter_important_actions: `Boolean`<a id="filter_important_actions-boolean"></a> ##### show_all: `Boolean`<a id="show_all-boolean"></a> #### 🔄 Return<a id="🔄-return"></a> [ActionsListResponseDTO](./lib/composio/models/actions_list_response_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/actions` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.actions.list_0`<a id="composioactionslist_0"></a> Retrieve a list of all actions based on query parameters. #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.actions.list_0( app_names: "string_example", use_case: "string_example", show_enabled_only: true, limit: 3.14, apps: "string_example", actions: "string_example", tags: "string_example", usecase_limit: 3.14, filter_important_actions: true, show_all: true, ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### app_names: `String`<a id="app_names-string"></a> ##### use_case: `String`<a id="use_case-string"></a> ##### show_enabled_only: `Boolean`<a id="show_enabled_only-boolean"></a> ##### limit: `Float`<a id="limit-float"></a> ##### apps: `String`<a id="apps-string"></a> ##### actions: `String`<a id="actions-string"></a> ##### tags: `String`<a id="tags-string"></a> ##### usecase_limit: `Float`<a id="usecase_limit-float"></a> ##### filter_important_actions: `Boolean`<a id="filter_important_actions-boolean"></a> ##### show_all: `Boolean`<a id="show_all-boolean"></a> #### 🔄 Return<a id="🔄-return"></a> [ActionsListResponseDTO](./lib/composio/models/actions_list_response_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v2/actions` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.apps.get_details`<a id="composioappsget_details"></a> Get app details #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.apps.get_details( app_name: "'+j>6", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### app_name: `String`<a id="app_name-string"></a> #### 🔄 Return<a id="🔄-return"></a> [SingleAppInfoResDTO](./lib/composio/models/single_app_info_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/apps/{appName}` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.apps.list`<a id="composioappslist"></a> Retrieve a list of all applications based on query parameters. #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.apps.list( category: "string_example", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### category: `String`<a id="category-string"></a> #### 🔄 Return<a id="🔄-return"></a> [AppListResDTO](./lib/composio/models/app_list_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/apps` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.apps.list_open_api_specs`<a id="composioappslist_open_api_specs"></a> Get opena api specs #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.apps.list_open_api_specs p result ``` #### 🔄 Return<a id="🔄-return"></a> [AppListResDTO](./lib/composio/models/app_list_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/apps/openapi/spec/list` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.auth.identify_client_operation`<a id="composioauthidentify_client_operation"></a> Identify client #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.auth.identify_client_operation( hash: "string_example", framework: "string_example", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### hash: `String`<a id="hash-string"></a> The hash of the client ##### framework: `String`<a id="framework-string"></a> The framework used by the client #### 🔄 Return<a id="🔄-return"></a> [IdentifyClientResDTO](./lib/composio/models/identify_client_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/client/auth/identify` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.auth.send_magic_link`<a id="composioauthsend_magic_link"></a> Send magic link #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.auth.send_magic_link( email: "string_example", verify_host: "string_example", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### email: `String`<a id="email-string"></a> The email of the user ##### verifyHost: `String`<a id="verifyhost-string"></a> The frontend host of the user #### 🔄 Return<a id="🔄-return"></a> [MagicLinkResDTO](./lib/composio/models/magic_link_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/client/auth/send_magic_link` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.auth.user_logout`<a id="composioauthuser_logout"></a> Logout the user and clear the server side session #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.auth.user_logout p result ``` #### 🔄 Return<a id="🔄-return"></a> [LogoutResDTO](./lib/composio/models/logout_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/client/auth/logout` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.auth.verify_magic_link`<a id="composioauthverify_magic_link"></a> Verify magic link #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.auth.verify_magic_link( token: "string_example", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### token: `String`<a id="token-string"></a> The magic link token #### 🔄 Return<a id="🔄-return"></a> [VerifyMagicLinkResDTO](./lib/composio/models/verify_magic_link_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/client/auth/verify_magic_link` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.cli.exchange_code`<a id="composiocliexchange_code"></a> Handle cli code exchange #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.cli.exchange_code p result ``` #### 🔄 Return<a id="🔄-return"></a> [GenerateCLISessionResDTO](./lib/composio/models/generate_cli_session_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/cli/generate-cli-session` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.cli.get_code`<a id="composiocliget_code"></a> Get cli code #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.cli.get_code( key: "key_example", code: "string_example", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### key: `String`<a id="key-string"></a> ##### code: `String`<a id="code-string"></a> #### 🔄 Return<a id="🔄-return"></a> [GetCLISessionResDTO](./lib/composio/models/get_cli_session_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/cli/get-cli-code` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.cli.verify_code`<a id="composiocliverify_code"></a> Handle cli code verification #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.cli.verify_code( key: "key_example", code: "string_example", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### key: `String`<a id="key-string"></a> ##### code: `String`<a id="code-string"></a> #### 🔄 Return<a id="🔄-return"></a> [VerifyCLICodeResDTO](./lib/composio/models/verify_cli_code_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/cli/verify-cli-code` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.connections.delete`<a id="composioconnectionsdelete"></a> Delete connection #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.connections.delete( connected_account_id: "'+j>6", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### connected_account_id: `String`<a id="connected_account_id-string"></a> #### 🔄 Return<a id="🔄-return"></a> [DeleteRowAPIDTO](./lib/composio/models/delete_row_apidto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/connectedAccounts/{connectedAccountId}` `DELETE` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.connections.disable`<a id="composioconnectionsdisable"></a> Disable connection #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.connections.disable( connected_account_id: "'+j>6", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### connected_account_id: `String`<a id="connected_account_id-string"></a> #### 🔄 Return<a id="🔄-return"></a> [ToggleConnectedAccountResponseDTO](./lib/composio/models/toggle_connected_account_response_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/connectedAccounts/{connectedAccountId}/disable` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.connections.enable`<a id="composioconnectionsenable"></a> Enable connection #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.connections.enable( connected_account_id: "'+j>6", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### connected_account_id: `String`<a id="connected_account_id-string"></a> #### 🔄 Return<a id="🔄-return"></a> [ToggleConnectedAccountResponseDTO](./lib/composio/models/toggle_connected_account_response_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/connectedAccounts/{connectedAccountId}/enable` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.connections.get`<a id="composioconnectionsget"></a> Get connection #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.connections.get( connected_account_id: "'+j>6", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### connected_account_id: `String`<a id="connected_account_id-string"></a> #### 🔄 Return<a id="🔄-return"></a> [ConnectedAccountResponseDTO](./lib/composio/models/connected_account_response_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/connectedAccounts/{connectedAccountId}` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.connections.initiate`<a id="composioconnectionsinitiate"></a> Initiate connection #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.connections.initiate( integration_id: "a", data: "a", redirect_uri: "string_example", user_uuid: "string_example", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### integrationId: `String`<a id="integrationid-string"></a> ##### data: `String`<a id="data-string"></a> ##### redirectUri: `String`<a id="redirecturi-string"></a> ##### userUuid: `String`<a id="useruuid-string"></a> #### 🔄 Return<a id="🔄-return"></a> [InitiateConnectionResponse](./lib/composio/models/initiate_connection_response.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/connectedAccounts` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.connections.list`<a id="composioconnectionslist"></a> Get connections #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.connections.list( page: 3.14, page_size: 3.14, app_names: "string_example", integration_id: "string_example", connection_id: "string_example", user_uuid: "string_example", show_active_only: true, status: "string_example", show_disabled: true, ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### page: `Float`<a id="page-float"></a> ##### page_size: `Float`<a id="page_size-float"></a> ##### app_names: `String`<a id="app_names-string"></a> ##### integration_id: `String`<a id="integration_id-string"></a> ##### connection_id: `String`<a id="connection_id-string"></a> ##### user_uuid: `String`<a id="user_uuid-string"></a> ##### show_active_only: `Boolean`<a id="show_active_only-boolean"></a> ##### status: `String`<a id="status-string"></a> ##### show_disabled: `Boolean`<a id="show_disabled-boolean"></a> #### 🔄 Return<a id="🔄-return"></a> [GetConnectionsResponseDto](./lib/composio/models/get_connections_response_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/connectedAccounts` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.integrations.create_integration`<a id="composiointegrationscreate_integration"></a> Create connector #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.integrations.create_integration( name: "string_example", app_id: "string_example", auth_scheme: "string_example", auth_config: { }, use_composio_auth: true, force_new_integration: true, ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### name: `String`<a id="name-string"></a> Name of the connector ##### appId: `String`<a id="appid-string"></a> Application ID ##### authScheme: `String`<a id="authscheme-string"></a> Authentication scheme ##### authConfig: [`AuthConfigDTO`](./lib/composio/models/auth_config_dto.rb)<a id="authconfig-authconfigdtolibcomposiomodelsauth_config_dtorb"></a> ##### useComposioAuth: [`CreateConnectorPayloadDTOUseComposioAuth`](./lib/composio/models/create_connector_payload_dto_use_composio_auth.rb)<a id="usecomposioauth-createconnectorpayloaddtousecomposioauthlibcomposiomodelscreate_connector_payload_dto_use_composio_authrb"></a> ##### forceNewIntegration: `Boolean`<a id="forcenewintegration-boolean"></a> Flag to force new integration #### 🔄 Return<a id="🔄-return"></a> [GetConnectorInfoResDTO](./lib/composio/models/get_connector_info_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/integrations` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.integrations.delete_connector`<a id="composiointegrationsdelete_connector"></a> Delete connector #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.integrations.delete_connector( integration_id: "'+j>6", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### integration_id: `String`<a id="integration_id-string"></a> #### 🔄 Return<a id="🔄-return"></a> [DeleteRowAPIDTO](./lib/composio/models/delete_row_apidto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/integrations/{integrationId}` `DELETE` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.integrations.get_connector_info`<a id="composiointegrationsget_connector_info"></a> Get connector info #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.integrations.get_connector_info( integration_id: "'+j>6", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### integration_id: `String`<a id="integration_id-string"></a> #### 🔄 Return<a id="🔄-return"></a> [GetConnectorInfoResDTO](./lib/composio/models/get_connector_info_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/integrations/{integrationId}` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.integrations.list_global_connectors`<a id="composiointegrationslist_global_connectors"></a> List global connectors #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.integrations.list_global_connectors p result ``` #### 🔄 Return<a id="🔄-return"></a> [GetConnectorListResDTO](./lib/composio/models/get_connector_list_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/integrations` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.integrations.update_integration`<a id="composiointegrationsupdate_integration"></a> Patch connector #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.integrations.update_integration( integration_id: "'+j>6", auth_config: {}, enabled: true, ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### integration_id: `String`<a id="integration_id-string"></a> ##### authConfig: `Object`<a id="authconfig-object"></a> Authentication configuration for the connector ##### enabled: `Boolean`<a id="enabled-boolean"></a> Flag to indicate if the connector is enabled #### 🔄 Return<a id="🔄-return"></a> [PatchConnectorResDTO](./lib/composio/models/patch_connector_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/integrations/{integrationId}` `PATCH` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.integrations.update_status`<a id="composiointegrationsupdate_status"></a> Patch post connector #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.integrations.update_status( integration_id: "'+j>6", auth_config: {}, enabled: true, ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### integration_id: `String`<a id="integration_id-string"></a> ##### authConfig: `Object`<a id="authconfig-object"></a> Authentication configuration for the connector ##### enabled: `Boolean`<a id="enabled-boolean"></a> Flag to indicate if the connector is enabled #### 🔄 Return<a id="🔄-return"></a> [PatchConnectorResDTO](./lib/composio/models/patch_connector_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/integrations/{integrationId}/status` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.logs.list`<a id="composiologslist"></a> List logs #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.logs.list( type: "error", time: "5m", status: "all", search: "string_example", integration_id: "string_example", limit: 10, cursor: "string_example", connection_id: "string_example", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### type: `String`<a id="type-string"></a> ##### time: `String`<a id="time-string"></a> ##### status: `String`<a id="status-string"></a> ##### search: `String`<a id="search-string"></a> ##### integration_id: `String`<a id="integration_id-string"></a> ##### limit: `Float`<a id="limit-float"></a> ##### cursor: `String`<a id="cursor-string"></a> ##### connection_id: `String`<a id="connection_id-string"></a> #### 🔄 Return<a id="🔄-return"></a> [LogsResDTO](./lib/composio/models/logs_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/logs` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.metadata.get_toggle_info`<a id="composiometadataget_toggle_info"></a> Get toggle info #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.metadata.get_toggle_info p result ``` #### 🔄 Return<a id="🔄-return"></a> [TriggerToggleInfoResponseDTO](./lib/composio/models/trigger_toggle_info_response_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/metadata/toggle.info` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.metadata.toggle_trigger_state`<a id="composiometadatatoggle_trigger_state"></a> Toggle trigger state #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.metadata.toggle_trigger_state( enabled: true, ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### enabled: `Boolean`<a id="enabled-boolean"></a> Flag to enable or disable triggers #### 🔄 Return<a id="🔄-return"></a> [ToggleTriggerStateResponseDTO](./lib/composio/models/toggle_trigger_state_response_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/metadata/toggle/trigger` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.team.get_member_list`<a id="composioteamget_member_list"></a> List members #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.team.get_member_list p result ``` #### 🔄 Return<a id="🔄-return"></a> [MemberResDTO](./lib/composio/models/member_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/team/members` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.team.send_invitation`<a id="composioteamsend_invitation"></a> Invite member #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.team.send_invitation( email: "string_example", name: "string_example", verify_host: "string_example", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### email: `String`<a id="email-string"></a> The email of the member ##### name: `String`<a id="name-string"></a> The name of the member ##### verifyHost: `String`<a id="verifyhost-string"></a> The host to verify the member #### 🔄 Return<a id="🔄-return"></a> [MemberResDTO](./lib/composio/models/member_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/team/invite` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.delete_trigger_instance`<a id="composiotriggersdelete_trigger_instance"></a> Deletes a specified trigger instance. #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.triggers.delete_trigger_instance( trigger_instance_id: "'+j>6", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### trigger_instance_id: `String`<a id="trigger_instance_id-string"></a> #### 🔄 Return<a id="🔄-return"></a> [DeleteRowAPIDTO](./lib/composio/models/delete_row_apidto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/triggers/instance/{triggerInstanceId}` `DELETE` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.disable_trigger_instance`<a id="composiotriggersdisable_trigger_instance"></a> Disables a specified trigger instance. #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.triggers.disable_trigger_instance( trigger_instance_id: "'+j>6", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### trigger_instance_id: `String`<a id="trigger_instance_id-string"></a> #### 🔄 Return<a id="🔄-return"></a> [TriggerResponseDTO](./lib/composio/models/trigger_response_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/triggers/disable/{triggerInstanceId}` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.enable`<a id="composiotriggersenable"></a> Enables a trigger for a connected account and specific trigger name. #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.triggers.enable( trigger_config: {}, connected_account_id: "'+j>6", trigger_name: "'+j>6", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### triggerConfig: `Object`<a id="triggerconfig-object"></a> The trigger configuration ##### connected_account_id: `String`<a id="connected_account_id-string"></a> ##### trigger_name: `String`<a id="trigger_name-string"></a> #### 🔄 Return<a id="🔄-return"></a> [TriggerResponseDTO](./lib/composio/models/trigger_response_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/triggers/enable/{connectedAccountId}/{triggerName}` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.get_active_triggers`<a id="composiotriggersget_active_triggers"></a> Lists active triggers based on query parameters. #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.triggers.get_active_triggers( connected_account_ids: "string_example", integration_ids: "string_example", trigger_ids: "string_example", trigger_names: "string_example", page: 3.14, limit: 3.14, show_disabled: true, ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### connected_account_ids: `String`<a id="connected_account_ids-string"></a> ##### integration_ids: `String`<a id="integration_ids-string"></a> ##### trigger_ids: `String`<a id="trigger_ids-string"></a> ##### trigger_names: `String`<a id="trigger_names-string"></a> ##### page: `Float`<a id="page-float"></a> ##### limit: `Float`<a id="limit-float"></a> ##### show_disabled: `Boolean`<a id="show_disabled-boolean"></a> #### 🔄 Return<a id="🔄-return"></a> [ActiveTriggersResDTO](./lib/composio/models/active_triggers_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/triggers/active_triggers` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.get_by_id`<a id="composiotriggersget_by_id"></a> Retrieves a specific trigger by its ID. #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.triggers.get_by_id( trigger_id: "'+j>6", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### trigger_id: `String`<a id="trigger_id-string"></a> #### 🔄 Return<a id="🔄-return"></a> [GetTriggerResponseDTO](./lib/composio/models/get_trigger_response_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/triggers/get/{triggerId}` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.get_callback_url`<a id="composiotriggersget_callback_url"></a> Retrieves the universal callback URL set for the client. #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.triggers.get_callback_url p result ``` #### 🔄 Return<a id="🔄-return"></a> [WebhookURLResponseDTO](./lib/composio/models/webhook_url_response_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/triggers/callback_url` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.get_logs_based_on_connection_and_integration_details`<a id="composiotriggersget_logs_based_on_connection_and_integration_details"></a> Fetches logs based on connection and integration details. #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.triggers.get_logs_based_on_connection_and_integration_details( connection_id: "string_example", integration_id: "string_example", page: 3.14, limit: 3.14, ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### connection_id: `String`<a id="connection_id-string"></a> ##### integration_id: `String`<a id="integration_id-string"></a> ##### page: `Float`<a id="page-float"></a> ##### limit: `Float`<a id="limit-float"></a> #### 🔄 Return<a id="🔄-return"></a> [TriggerLogsResDTO](./lib/composio/models/trigger_logs_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/triggers/logs` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.get_trigger_info`<a id="composiotriggersget_trigger_info"></a> Get Trigger Info #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.triggers.get_trigger_info( trigger_name: "'+j>6", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### trigger_name: `String`<a id="trigger_name-string"></a> #### 🔄 Return<a id="🔄-return"></a> [SingleTriggerResDTO](./lib/composio/models/single_trigger_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v2/triggers/{triggerName}` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.list`<a id="composiotriggerslist"></a> List triggers #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.triggers.list( app_names: "string_example", connected_account_ids: "string_example", trigger_ids: "string_example", show_enabled_only: true, ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### app_names: `String`<a id="app_names-string"></a> ##### connected_account_ids: `String`<a id="connected_account_ids-string"></a> ##### trigger_ids: `String`<a id="trigger_ids-string"></a> ##### show_enabled_only: `Boolean`<a id="show_enabled_only-boolean"></a> #### 🔄 Return<a id="🔄-return"></a> [TriggerResDTO](./lib/composio/models/trigger_res_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/triggers` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.set_callback_url`<a id="composiotriggersset_callback_url"></a> Sets a universal callback URL for the client. #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.triggers.set_callback_url( callback_url: "string_example", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### callbackURL: `String`<a id="callbackurl-string"></a> The callback URL #### 🔄 Return<a id="🔄-return"></a> [TriggerResponseDTO](./lib/composio/models/trigger_response_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/triggers/set_callback_url` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.switch_instance_status`<a id="composiotriggersswitch_instance_status"></a> Switches the status of a trigger instance. #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.triggers.switch_instance_status( enabled: true, trigger_id: "'+j>6", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### enabled: `Boolean`<a id="enabled-boolean"></a> The new enabled status of the trigger ##### trigger_id: `String`<a id="trigger_id-string"></a> #### 🔄 Return<a id="🔄-return"></a> [TriggerResponseDTO](./lib/composio/models/trigger_response_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/triggers/instance/{triggerId}/status` `PATCH` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.switch_post_instance_status`<a id="composiotriggersswitch_post_instance_status"></a> Switches the status of a trigger instance. #### 🛠️ Usage<a id="🛠️-usage"></a> ```ruby result = composio.triggers.switch_post_instance_status( enabled: true, trigger_id: "'+j>6", ) p result ``` #### ⚙️ Parameters<a id="⚙️-parameters"></a> ##### enabled: `Boolean`<a id="enabled-boolean"></a> The new enabled status of the trigger ##### trigger_id: `String`<a id="trigger_id-string"></a> #### 🔄 Return<a id="🔄-return"></a> [TriggerResponseDTO](./lib/composio/models/trigger_response_dto.rb) #### 🌐 Endpoint<a id="🌐-endpoint"></a> `/api/v1/triggers/instance/{triggerId}/status` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ## Author<a id="author"></a> This TypeScript package is automatically generated by [Konfig](https://konfigthis.com)