composio 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +11 -0
- data/Gemfile.lock +93 -0
- data/README.md +1779 -0
- data/Rakefile +10 -0
- data/composio.gemspec +39 -0
- data/header.png +0 -0
- data/lib/composio/api/actions_api.rb +1062 -0
- data/lib/composio/api/api_keys_api.rb +268 -0
- data/lib/composio/api/apps_api.rb +266 -0
- data/lib/composio/api/auth_api.rb +370 -0
- data/lib/composio/api/cli_api.rb +266 -0
- data/lib/composio/api/connections_api.rb +591 -0
- data/lib/composio/api/integrations_api.rb +578 -0
- data/lib/composio/api/logs_api.rb +166 -0
- data/lib/composio/api/metadata_api.rb +180 -0
- data/lib/composio/api/team_api.rb +188 -0
- data/lib/composio/api/triggers_api.rb +1222 -0
- data/lib/composio/api_client.rb +436 -0
- data/lib/composio/api_client_custom.rb +14 -0
- data/lib/composio/api_error.rb +53 -0
- data/lib/composio/configuration.rb +330 -0
- data/lib/composio/models/action_details.rb +357 -0
- data/lib/composio/models/action_details_minimal.rb +329 -0
- data/lib/composio/models/action_execution_req_dto.rb +260 -0
- data/lib/composio/models/action_execution_res_dto.rb +238 -0
- data/lib/composio/models/action_log_data.rb +345 -0
- data/lib/composio/models/action_metadata.rb +402 -0
- data/lib/composio/models/action_metadata_type.rb +101 -0
- data/lib/composio/models/actions_controller_v1.rb +222 -0
- data/lib/composio/models/actions_list_response_dto.rb +250 -0
- data/lib/composio/models/actions_minimal_list_response_dto.rb +250 -0
- data/lib/composio/models/actions_query_dto.rb +300 -0
- data/lib/composio/models/active_trigger_instance.rb +311 -0
- data/lib/composio/models/active_triggers_res_dto.rb +238 -0
- data/lib/composio/models/add_repo_url_req_dto.rb +221 -0
- data/lib/composio/models/add_repo_url_res_dto.rb +221 -0
- data/lib/composio/models/add_tools_req_dto.rb +251 -0
- data/lib/composio/models/add_tools_request_dto.rb +251 -0
- data/lib/composio/models/api_key_res_dto.rb +323 -0
- data/lib/composio/models/app_info_response_dto.rb +323 -0
- data/lib/composio/models/app_list_res_dto.rb +238 -0
- data/lib/composio/models/app_query_dto.rb +216 -0
- data/lib/composio/models/auth_config_dto.rb +229 -0
- data/lib/composio/models/cli_query_dto.rb +231 -0
- data/lib/composio/models/connected_account_response_dto.rb +331 -0
- data/lib/composio/models/connection_params.rb +395 -0
- data/lib/composio/models/connection_params_for_account.rb +323 -0
- data/lib/composio/models/connection_params_headers.rb +224 -0
- data/lib/composio/models/connection_with_app_data.rb +358 -0
- data/lib/composio/models/connection_with_app_data_created_at.rb +101 -0
- data/lib/composio/models/connector_list_item_dto.rb +376 -0
- data/lib/composio/models/connector_list_item_dto_created_at.rb +102 -0
- data/lib/composio/models/connector_list_item_dto_updated_at.rb +102 -0
- data/lib/composio/models/create_connector_payload_dto.rb +274 -0
- data/lib/composio/models/create_connector_payload_dto_use_composio_auth.rb +226 -0
- data/lib/composio/models/delete_api_key_req_dto.rb +221 -0
- data/lib/composio/models/delete_api_key_response_dto.rb +221 -0
- data/lib/composio/models/delete_row_apidto.rb +236 -0
- data/lib/composio/models/delete_tools_req_dto.rb +221 -0
- data/lib/composio/models/delete_tools_res_dto.rb +221 -0
- data/lib/composio/models/direct_execute_req_dto.rb +262 -0
- data/lib/composio/models/enable_trigger_body_dto.rb +221 -0
- data/lib/composio/models/enable_trigger_params_dto.rb +236 -0
- data/lib/composio/models/execute_action_res_dto.rb +236 -0
- data/lib/composio/models/generate_api_key_req_dto.rb +221 -0
- data/lib/composio/models/generate_cli_session_req_dto.rb +221 -0
- data/lib/composio/models/generate_cli_session_res_dto.rb +221 -0
- data/lib/composio/models/get_active_triggers_query_dto.rb +276 -0
- data/lib/composio/models/get_cli_session_res_dto.rb +236 -0
- data/lib/composio/models/get_connections_query_dto.rb +287 -0
- data/lib/composio/models/get_connections_response_dto.rb +250 -0
- data/lib/composio/models/get_connections_result.rb +236 -0
- data/lib/composio/models/get_connector_info_res_dto.rb +417 -0
- data/lib/composio/models/get_connector_list_res_dto.rb +253 -0
- data/lib/composio/models/get_logs_dto.rb +288 -0
- data/lib/composio/models/get_logs_query_dto.rb +246 -0
- data/lib/composio/models/get_trigger_params_dto.rb +221 -0
- data/lib/composio/models/get_trigger_response_dto.rb +230 -0
- data/lib/composio/models/handle_trigger_body_dto.rb +221 -0
- data/lib/composio/models/handle_trigger_params_dto.rb +236 -0
- data/lib/composio/models/identify_client_req_dto.rb +231 -0
- data/lib/composio/models/identify_client_res_dto.rb +251 -0
- data/lib/composio/models/initiate_connection_payload_dto.rb +281 -0
- data/lib/composio/models/initiate_connection_response.rb +272 -0
- data/lib/composio/models/invite_member_req_dto.rb +251 -0
- data/lib/composio/models/job_status.rb +37 -0
- data/lib/composio/models/list_triggers_query_dto.rb +246 -0
- data/lib/composio/models/logout_res_dto.rb +221 -0
- data/lib/composio/models/logs_res_dto.rb +233 -0
- data/lib/composio/models/magic_link_req_dto.rb +236 -0
- data/lib/composio/models/magic_link_res_dto.rb +220 -0
- data/lib/composio/models/member_res_dto.rb +305 -0
- data/lib/composio/models/meta.rb +220 -0
- data/lib/composio/models/meta_app.rb +220 -0
- data/lib/composio/models/metadata_query_dto.rb +221 -0
- data/lib/composio/models/metadata_req_dto.rb +232 -0
- data/lib/composio/models/o_auth2_callback_query_dto.rb +220 -0
- data/lib/composio/models/open_api_spec_list_res_dto.rb +436 -0
- data/lib/composio/models/page_info.rb +338 -0
- data/lib/composio/models/page_info_dto.rb +248 -0
- data/lib/composio/models/patch_connector_req_dto.rb +226 -0
- data/lib/composio/models/patch_connector_res_dto.rb +221 -0
- data/lib/composio/models/proxy_execution_req_dto.rb +234 -0
- data/lib/composio/models/redirect_uri_dto.rb +215 -0
- data/lib/composio/models/set_callback_url_body_dto.rb +221 -0
- data/lib/composio/models/single_app_info_res_dto.rb +394 -0
- data/lib/composio/models/single_trigger_res_dto.rb +336 -0
- data/lib/composio/models/status.rb +37 -0
- data/lib/composio/models/switch_trigger_status_body_dto.rb +221 -0
- data/lib/composio/models/switch_trigger_status_params_dto.rb +221 -0
- data/lib/composio/models/time.rb +41 -0
- data/lib/composio/models/toggle_connected_account_response_dto.rb +220 -0
- data/lib/composio/models/toggle_trigger_state_response_dto.rb +220 -0
- data/lib/composio/models/tools_execute_req_dto.rb +275 -0
- data/lib/composio/models/track_client_req_dto.rb +240 -0
- data/lib/composio/models/track_client_res_dto.rb +221 -0
- data/lib/composio/models/trigger_config.rb +237 -0
- data/lib/composio/models/trigger_instance_params_dto.rb +221 -0
- data/lib/composio/models/trigger_log_data.rb +345 -0
- data/lib/composio/models/trigger_log_item_dto.rb +336 -0
- data/lib/composio/models/trigger_logs_res_dto.rb +236 -0
- data/lib/composio/models/trigger_metadata.rb +402 -0
- data/lib/composio/models/trigger_metadata_dto.rb +347 -0
- data/lib/composio/models/trigger_metadata_type.rb +101 -0
- data/lib/composio/models/trigger_res_dto.rb +361 -0
- data/lib/composio/models/trigger_response_dto.rb +241 -0
- data/lib/composio/models/trigger_toggle_info_response_dto.rb +221 -0
- data/lib/composio/models/triggers_enabled_toggle_req_dto.rb +221 -0
- data/lib/composio/models/triggers_enabled_toggle_res_dto.rb +221 -0
- data/lib/composio/models/type.rb +37 -0
- data/lib/composio/models/user_git_user_info.rb +230 -0
- data/lib/composio/models/verify_cli_code_res_dto.rb +251 -0
- data/lib/composio/models/verify_magic_link_data_dto.rb +263 -0
- data/lib/composio/models/verify_magic_link_req_dto.rb +221 -0
- data/lib/composio/models/verify_magic_link_res_dto.rb +230 -0
- data/lib/composio/models/webhook_url_response_dto.rb +231 -0
- data/lib/composio/version.rb +11 -0
- data/lib/composio.rb +214 -0
- data/spec/api/actions_api_spec.rb +164 -0
- data/spec/api/api_keys_api_spec.rb +61 -0
- data/spec/api/apps_api_spec.rb +63 -0
- data/spec/api/auth_api_spec.rb +73 -0
- data/spec/api/cli_api_spec.rb +63 -0
- data/spec/api/connections_api_spec.rb +103 -0
- data/spec/api/integrations_api_spec.rb +96 -0
- data/spec/api/logs_api_spec.rb +48 -0
- data/spec/api/metadata_api_spec.rb +50 -0
- data/spec/api/team_api_spec.rb +50 -0
- data/spec/api/triggers_api_spec.rb +188 -0
- data/spec/api_client_spec.rb +191 -0
- data/spec/configuration_spec.rb +38 -0
- data/spec/models/action_details_minimal_spec.rb +76 -0
- data/spec/models/action_details_spec.rb +88 -0
- data/spec/models/action_execution_req_dto_spec.rb +58 -0
- data/spec/models/action_execution_res_dto_spec.rb +40 -0
- data/spec/models/action_log_data_spec.rb +70 -0
- data/spec/models/action_metadata_spec.rb +88 -0
- data/spec/models/action_metadata_type_spec.rb +25 -0
- data/spec/models/actions_controller_v1_spec.rb +28 -0
- data/spec/models/actions_list_response_dto_spec.rb +40 -0
- data/spec/models/actions_minimal_list_response_dto_spec.rb +40 -0
- data/spec/models/actions_query_dto_spec.rb +82 -0
- data/spec/models/active_trigger_instance_spec.rb +70 -0
- data/spec/models/active_triggers_res_dto_spec.rb +34 -0
- data/spec/models/add_repo_url_req_dto_spec.rb +28 -0
- data/spec/models/add_repo_url_res_dto_spec.rb +28 -0
- data/spec/models/add_tools_req_dto_spec.rb +40 -0
- data/spec/models/add_tools_request_dto_spec.rb +40 -0
- data/spec/models/api_key_res_dto_spec.rb +52 -0
- data/spec/models/app_info_response_dto_spec.rb +70 -0
- data/spec/models/app_list_res_dto_spec.rb +34 -0
- data/spec/models/app_query_dto_spec.rb +28 -0
- data/spec/models/auth_config_dto_spec.rb +34 -0
- data/spec/models/cli_query_dto_spec.rb +34 -0
- data/spec/models/connected_account_response_dto_spec.rb +82 -0
- data/spec/models/connection_params_for_account_spec.rb +100 -0
- data/spec/models/connection_params_headers_spec.rb +34 -0
- data/spec/models/connection_params_spec.rb +118 -0
- data/spec/models/connection_with_app_data_created_at_spec.rb +25 -0
- data/spec/models/connection_with_app_data_spec.rb +100 -0
- data/spec/models/connector_list_item_dto_created_at_spec.rb +25 -0
- data/spec/models/connector_list_item_dto_spec.rb +94 -0
- data/spec/models/connector_list_item_dto_updated_at_spec.rb +25 -0
- data/spec/models/create_connector_payload_dto_spec.rb +58 -0
- data/spec/models/create_connector_payload_dto_use_composio_auth_spec.rb +22 -0
- data/spec/models/delete_api_key_req_dto_spec.rb +28 -0
- data/spec/models/delete_api_key_response_dto_spec.rb +28 -0
- data/spec/models/delete_row_apidto_spec.rb +34 -0
- data/spec/models/delete_tools_req_dto_spec.rb +28 -0
- data/spec/models/delete_tools_res_dto_spec.rb +28 -0
- data/spec/models/direct_execute_req_dto_spec.rb +46 -0
- data/spec/models/enable_trigger_body_dto_spec.rb +28 -0
- data/spec/models/enable_trigger_params_dto_spec.rb +34 -0
- data/spec/models/execute_action_res_dto_spec.rb +34 -0
- data/spec/models/generate_api_key_req_dto_spec.rb +28 -0
- data/spec/models/generate_cli_session_req_dto_spec.rb +28 -0
- data/spec/models/generate_cli_session_res_dto_spec.rb +28 -0
- data/spec/models/get_active_triggers_query_dto_spec.rb +64 -0
- data/spec/models/get_cli_session_res_dto_spec.rb +34 -0
- data/spec/models/get_connections_query_dto_spec.rb +76 -0
- data/spec/models/get_connections_response_dto_spec.rb +40 -0
- data/spec/models/get_connections_result_spec.rb +34 -0
- data/spec/models/get_connector_info_res_dto_spec.rb +106 -0
- data/spec/models/get_connector_list_res_dto_spec.rb +40 -0
- data/spec/models/get_logs_dto_spec.rb +70 -0
- data/spec/models/get_logs_query_dto_spec.rb +46 -0
- data/spec/models/get_trigger_params_dto_spec.rb +28 -0
- data/spec/models/get_trigger_response_dto_spec.rb +34 -0
- data/spec/models/handle_trigger_body_dto_spec.rb +28 -0
- data/spec/models/handle_trigger_params_dto_spec.rb +34 -0
- data/spec/models/identify_client_req_dto_spec.rb +34 -0
- data/spec/models/identify_client_res_dto_spec.rb +40 -0
- data/spec/models/initiate_connection_payload_dto_spec.rb +46 -0
- data/spec/models/initiate_connection_response_spec.rb +34 -0
- data/spec/models/invite_member_req_dto_spec.rb +40 -0
- data/spec/models/job_status_spec.rb +22 -0
- data/spec/models/list_triggers_query_dto_spec.rb +46 -0
- data/spec/models/logout_res_dto_spec.rb +28 -0
- data/spec/models/logs_res_dto_spec.rb +34 -0
- data/spec/models/magic_link_req_dto_spec.rb +34 -0
- data/spec/models/magic_link_res_dto_spec.rb +28 -0
- data/spec/models/member_res_dto_spec.rb +52 -0
- data/spec/models/meta_app_spec.rb +28 -0
- data/spec/models/meta_spec.rb +28 -0
- data/spec/models/metadata_query_dto_spec.rb +28 -0
- data/spec/models/metadata_req_dto_spec.rb +34 -0
- data/spec/models/o_auth2_callback_query_dto_spec.rb +28 -0
- data/spec/models/open_api_spec_list_res_dto_spec.rb +94 -0
- data/spec/models/page_info_dto_spec.rb +40 -0
- data/spec/models/page_info_spec.rb +46 -0
- data/spec/models/patch_connector_req_dto_spec.rb +34 -0
- data/spec/models/patch_connector_res_dto_spec.rb +28 -0
- data/spec/models/proxy_execution_req_dto_spec.rb +34 -0
- data/spec/models/redirect_uri_dto_spec.rb +28 -0
- data/spec/models/set_callback_url_body_dto_spec.rb +28 -0
- data/spec/models/single_app_info_res_dto_spec.rb +118 -0
- data/spec/models/single_trigger_res_dto_spec.rb +76 -0
- data/spec/models/status_spec.rb +22 -0
- data/spec/models/switch_trigger_status_body_dto_spec.rb +28 -0
- data/spec/models/switch_trigger_status_params_dto_spec.rb +28 -0
- data/spec/models/time_spec.rb +22 -0
- data/spec/models/toggle_connected_account_response_dto_spec.rb +28 -0
- data/spec/models/toggle_trigger_state_response_dto_spec.rb +28 -0
- data/spec/models/tools_execute_req_dto_spec.rb +58 -0
- data/spec/models/track_client_req_dto_spec.rb +40 -0
- data/spec/models/track_client_res_dto_spec.rb +28 -0
- data/spec/models/trigger_config_spec.rb +34 -0
- data/spec/models/trigger_instance_params_dto_spec.rb +28 -0
- data/spec/models/trigger_log_data_spec.rb +70 -0
- data/spec/models/trigger_log_item_dto_spec.rb +82 -0
- data/spec/models/trigger_logs_res_dto_spec.rb +34 -0
- data/spec/models/trigger_metadata_dto_spec.rb +82 -0
- data/spec/models/trigger_metadata_spec.rb +94 -0
- data/spec/models/trigger_metadata_type_spec.rb +25 -0
- data/spec/models/trigger_res_dto_spec.rb +100 -0
- data/spec/models/trigger_response_dto_spec.rb +40 -0
- data/spec/models/trigger_toggle_info_response_dto_spec.rb +28 -0
- data/spec/models/triggers_enabled_toggle_req_dto_spec.rb +28 -0
- data/spec/models/triggers_enabled_toggle_res_dto_spec.rb +28 -0
- data/spec/models/type_spec.rb +22 -0
- data/spec/models/user_git_user_info_spec.rb +34 -0
- data/spec/models/verify_cli_code_res_dto_spec.rb +40 -0
- data/spec/models/verify_magic_link_data_dto_spec.rb +46 -0
- data/spec/models/verify_magic_link_req_dto_spec.rb +28 -0
- data/spec/models/verify_magic_link_res_dto_spec.rb +34 -0
- data/spec/models/webhook_url_response_dto_spec.rb +34 -0
- data/spec/simple_test_spec.rb +52 -0
- data/spec/spec_helper.rb +107 -0
- metadata +504 -0
data/README.md
ADDED
@@ -0,0 +1,1779 @@
|
|
1
|
+
<div align="center">
|
2
|
+
|
3
|
+
[![Visit Composio](./header.png)](https://composio.dev)
|
4
|
+
|
5
|
+
# [Composio](https://composio.dev)<a id="composio"></a>
|
6
|
+
|
7
|
+
Composio SDK: Equip your agent with high-quality tools and build your real-world usecase
|
8
|
+
|
9
|
+
[![npm](https://img.shields.io/badge/gem-v0.1.0-blue)](https://rubygems.org/gems/composio/versions/0.1.0)
|
10
|
+
[![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://composio.dev)
|
11
|
+
|
12
|
+
</div>
|
13
|
+
|
14
|
+
## Table of Contents<a id="table-of-contents"></a>
|
15
|
+
|
16
|
+
<!-- toc -->
|
17
|
+
|
18
|
+
- [Installation](#installation)
|
19
|
+
- [Getting Started](#getting-started)
|
20
|
+
- [Raw HTTP Response](#raw-http-response)
|
21
|
+
- [Reference](#reference)
|
22
|
+
* [`composio.api_keys.generate`](#composioapi_keysgenerate)
|
23
|
+
* [`composio.api_keys.list`](#composioapi_keyslist)
|
24
|
+
* [`composio.api_keys.remove`](#composioapi_keysremove)
|
25
|
+
* [`composio.actions.execute`](#composioactionsexecute)
|
26
|
+
* [`composio.actions.execute_0`](#composioactionsexecute_0)
|
27
|
+
* [`composio.actions.execute_action_proxy`](#composioactionsexecute_action_proxy)
|
28
|
+
* [`composio.actions.execute_proxy`](#composioactionsexecute_proxy)
|
29
|
+
* [`composio.actions.get`](#composioactionsget)
|
30
|
+
* [`composio.actions.get_action_by_id`](#composioactionsget_action_by_id)
|
31
|
+
* [`composio.actions.get_all_actions_based_on_query`](#composioactionsget_all_actions_based_on_query)
|
32
|
+
* [`composio.actions.list`](#composioactionslist)
|
33
|
+
* [`composio.actions.list_0`](#composioactionslist_0)
|
34
|
+
* [`composio.apps.get_details`](#composioappsget_details)
|
35
|
+
* [`composio.apps.list`](#composioappslist)
|
36
|
+
* [`composio.apps.list_open_api_specs`](#composioappslist_open_api_specs)
|
37
|
+
* [`composio.auth.identify_client_operation`](#composioauthidentify_client_operation)
|
38
|
+
* [`composio.auth.send_magic_link`](#composioauthsend_magic_link)
|
39
|
+
* [`composio.auth.user_logout`](#composioauthuser_logout)
|
40
|
+
* [`composio.auth.verify_magic_link`](#composioauthverify_magic_link)
|
41
|
+
* [`composio.cli.exchange_code`](#composiocliexchange_code)
|
42
|
+
* [`composio.cli.get_code`](#composiocliget_code)
|
43
|
+
* [`composio.cli.verify_code`](#composiocliverify_code)
|
44
|
+
* [`composio.connections.delete`](#composioconnectionsdelete)
|
45
|
+
* [`composio.connections.disable`](#composioconnectionsdisable)
|
46
|
+
* [`composio.connections.enable`](#composioconnectionsenable)
|
47
|
+
* [`composio.connections.get`](#composioconnectionsget)
|
48
|
+
* [`composio.connections.initiate`](#composioconnectionsinitiate)
|
49
|
+
* [`composio.connections.list`](#composioconnectionslist)
|
50
|
+
* [`composio.integrations.create_integration`](#composiointegrationscreate_integration)
|
51
|
+
* [`composio.integrations.delete_connector`](#composiointegrationsdelete_connector)
|
52
|
+
* [`composio.integrations.get_connector_info`](#composiointegrationsget_connector_info)
|
53
|
+
* [`composio.integrations.list_global_connectors`](#composiointegrationslist_global_connectors)
|
54
|
+
* [`composio.integrations.update_integration`](#composiointegrationsupdate_integration)
|
55
|
+
* [`composio.integrations.update_status`](#composiointegrationsupdate_status)
|
56
|
+
* [`composio.logs.list`](#composiologslist)
|
57
|
+
* [`composio.metadata.get_toggle_info`](#composiometadataget_toggle_info)
|
58
|
+
* [`composio.metadata.toggle_trigger_state`](#composiometadatatoggle_trigger_state)
|
59
|
+
* [`composio.team.get_member_list`](#composioteamget_member_list)
|
60
|
+
* [`composio.team.send_invitation`](#composioteamsend_invitation)
|
61
|
+
* [`composio.triggers.delete_trigger_instance`](#composiotriggersdelete_trigger_instance)
|
62
|
+
* [`composio.triggers.disable_trigger_instance`](#composiotriggersdisable_trigger_instance)
|
63
|
+
* [`composio.triggers.enable`](#composiotriggersenable)
|
64
|
+
* [`composio.triggers.get_active_triggers`](#composiotriggersget_active_triggers)
|
65
|
+
* [`composio.triggers.get_by_id`](#composiotriggersget_by_id)
|
66
|
+
* [`composio.triggers.get_callback_url`](#composiotriggersget_callback_url)
|
67
|
+
* [`composio.triggers.get_logs_based_on_connection_and_integration_details`](#composiotriggersget_logs_based_on_connection_and_integration_details)
|
68
|
+
* [`composio.triggers.get_trigger_info`](#composiotriggersget_trigger_info)
|
69
|
+
* [`composio.triggers.list`](#composiotriggerslist)
|
70
|
+
* [`composio.triggers.set_callback_url`](#composiotriggersset_callback_url)
|
71
|
+
* [`composio.triggers.switch_instance_status`](#composiotriggersswitch_instance_status)
|
72
|
+
* [`composio.triggers.switch_post_instance_status`](#composiotriggersswitch_post_instance_status)
|
73
|
+
|
74
|
+
<!-- tocstop -->
|
75
|
+
|
76
|
+
## Installation<a id="installation"></a>
|
77
|
+
|
78
|
+
Add to Gemfile:
|
79
|
+
|
80
|
+
```ruby
|
81
|
+
gem 'composio', '~> 0.1.0'
|
82
|
+
```
|
83
|
+
|
84
|
+
## Getting Started<a id="getting-started"></a>
|
85
|
+
|
86
|
+
```ruby
|
87
|
+
require 'composio'
|
88
|
+
configuration = Composio::Configuration.new
|
89
|
+
configuration.api_key = 'YOUR API KEY'
|
90
|
+
composio = composio::Client.new(configuration)
|
91
|
+
result = composio.api_keys.generate(
|
92
|
+
name: "string_example",
|
93
|
+
)
|
94
|
+
p result
|
95
|
+
```
|
96
|
+
|
97
|
+
## Raw HTTP Response<a id="raw-http-response"></a>
|
98
|
+
|
99
|
+
To access the raw HTTP response, suffix any method with `_with_http_info`.
|
100
|
+
|
101
|
+
```ruby
|
102
|
+
result = composio.api_keys.generate_with_http_info(
|
103
|
+
name: "string_example",
|
104
|
+
)
|
105
|
+
p result.data # [APIKeyResDTO] Deserialized data
|
106
|
+
p.result.status_code # [Integer] HTTP status code
|
107
|
+
p.result.headers # [Hash] HTTP headers
|
108
|
+
p.result.response # [Faraday::Response] Raw HTTP response
|
109
|
+
```
|
110
|
+
|
111
|
+
## Reference<a id="reference"></a>
|
112
|
+
|
113
|
+
|
114
|
+
### `composio.api_keys.generate`<a id="composioapi_keysgenerate"></a>
|
115
|
+
|
116
|
+
Generate api key
|
117
|
+
|
118
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
119
|
+
|
120
|
+
```ruby
|
121
|
+
result = composio.api_keys.generate(
|
122
|
+
name: "string_example",
|
123
|
+
)
|
124
|
+
p result
|
125
|
+
```
|
126
|
+
|
127
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
128
|
+
|
129
|
+
##### name: `String`<a id="name-string"></a>
|
130
|
+
The name of the API key to be generated
|
131
|
+
|
132
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
133
|
+
|
134
|
+
[APIKeyResDTO](./lib/composio/models/api_key_res_dto.rb)
|
135
|
+
|
136
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
137
|
+
|
138
|
+
`/api/v1/api_keys` `POST`
|
139
|
+
|
140
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
141
|
+
|
142
|
+
---
|
143
|
+
|
144
|
+
|
145
|
+
### `composio.api_keys.list`<a id="composioapi_keyslist"></a>
|
146
|
+
|
147
|
+
List api keys
|
148
|
+
|
149
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
150
|
+
|
151
|
+
```ruby
|
152
|
+
result = composio.api_keys.list
|
153
|
+
p result
|
154
|
+
```
|
155
|
+
|
156
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
157
|
+
|
158
|
+
[APIKeyResDTO](./lib/composio/models/api_key_res_dto.rb)
|
159
|
+
|
160
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
161
|
+
|
162
|
+
`/api/v1/api_keys` `GET`
|
163
|
+
|
164
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
165
|
+
|
166
|
+
---
|
167
|
+
|
168
|
+
|
169
|
+
### `composio.api_keys.remove`<a id="composioapi_keysremove"></a>
|
170
|
+
|
171
|
+
Delete api key
|
172
|
+
|
173
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
174
|
+
|
175
|
+
```ruby
|
176
|
+
result = composio.api_keys.remove(
|
177
|
+
id: "'+j>6",
|
178
|
+
)
|
179
|
+
p result
|
180
|
+
```
|
181
|
+
|
182
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
183
|
+
|
184
|
+
##### id: `String`<a id="id-string"></a>
|
185
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
186
|
+
|
187
|
+
[DeleteAPIKeyResponseDTO](./lib/composio/models/delete_api_key_response_dto.rb)
|
188
|
+
|
189
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
190
|
+
|
191
|
+
`/api/v1/api_keys/{id}` `DELETE`
|
192
|
+
|
193
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
194
|
+
|
195
|
+
---
|
196
|
+
|
197
|
+
|
198
|
+
### `composio.actions.execute`<a id="composioactionsexecute"></a>
|
199
|
+
|
200
|
+
Execute action
|
201
|
+
|
202
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
203
|
+
|
204
|
+
```ruby
|
205
|
+
result = composio.actions.execute(
|
206
|
+
action_id: "'+j>6",
|
207
|
+
connected_account_id: "string_example",
|
208
|
+
app_name: "string_example",
|
209
|
+
entity_id: "string_example",
|
210
|
+
endpoint: "string_example",
|
211
|
+
input: {},
|
212
|
+
text: "string_example",
|
213
|
+
)
|
214
|
+
p result
|
215
|
+
```
|
216
|
+
|
217
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
218
|
+
|
219
|
+
##### action_id: `String`<a id="action_id-string"></a>
|
220
|
+
##### connectedAccountId: `String`<a id="connectedaccountid-string"></a>
|
221
|
+
##### appName: `String`<a id="appname-string"></a>
|
222
|
+
##### entityId: `String`<a id="entityid-string"></a>
|
223
|
+
##### endpoint: `String`<a id="endpoint-string"></a>
|
224
|
+
##### input: `Object`<a id="input-object"></a>
|
225
|
+
##### text: `String`<a id="text-string"></a>
|
226
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
227
|
+
|
228
|
+
[ActionExecutionResDto](./lib/composio/models/action_execution_res_dto.rb)
|
229
|
+
|
230
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
231
|
+
|
232
|
+
`/api/v1/actions/{actionId}/execute` `POST`
|
233
|
+
|
234
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
235
|
+
|
236
|
+
---
|
237
|
+
|
238
|
+
|
239
|
+
### `composio.actions.execute_0`<a id="composioactionsexecute_0"></a>
|
240
|
+
|
241
|
+
Execute an action. Support both connected account and no auth auth.
|
242
|
+
|
243
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
244
|
+
|
245
|
+
```ruby
|
246
|
+
result = composio.actions.execute_0(
|
247
|
+
action_id: "'+j>6",
|
248
|
+
connected_account_id: "string_example",
|
249
|
+
app_name: "string_example",
|
250
|
+
entity_id: "string_example",
|
251
|
+
endpoint: "string_example",
|
252
|
+
input: {},
|
253
|
+
text: "string_example",
|
254
|
+
)
|
255
|
+
p result
|
256
|
+
```
|
257
|
+
|
258
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
259
|
+
|
260
|
+
##### action_id: `String`<a id="action_id-string"></a>
|
261
|
+
##### connectedAccountId: `String`<a id="connectedaccountid-string"></a>
|
262
|
+
##### appName: `String`<a id="appname-string"></a>
|
263
|
+
##### entityId: `String`<a id="entityid-string"></a>
|
264
|
+
##### endpoint: `String`<a id="endpoint-string"></a>
|
265
|
+
##### input: `Object`<a id="input-object"></a>
|
266
|
+
##### text: `String`<a id="text-string"></a>
|
267
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
268
|
+
|
269
|
+
[ActionExecutionResDto](./lib/composio/models/action_execution_res_dto.rb)
|
270
|
+
|
271
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
272
|
+
|
273
|
+
`/api/v2/actions/{actionId}/execute` `POST`
|
274
|
+
|
275
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
276
|
+
|
277
|
+
---
|
278
|
+
|
279
|
+
|
280
|
+
### `composio.actions.execute_action_proxy`<a id="composioactionsexecute_action_proxy"></a>
|
281
|
+
|
282
|
+
Execute an action with direct auth.
|
283
|
+
|
284
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
285
|
+
|
286
|
+
```ruby
|
287
|
+
result = composio.actions.execute_action_proxy(
|
288
|
+
endpoint: "endpoint_example",
|
289
|
+
connected_account_id: "connectedAccountId_example",
|
290
|
+
)
|
291
|
+
p result
|
292
|
+
```
|
293
|
+
|
294
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
295
|
+
|
296
|
+
##### endpoint: `String`<a id="endpoint-string"></a>
|
297
|
+
##### connected_account_id: `String`<a id="connected_account_id-string"></a>
|
298
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
299
|
+
|
300
|
+
[ActionExecutionResDto](./lib/composio/models/action_execution_res_dto.rb)
|
301
|
+
|
302
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
303
|
+
|
304
|
+
`/api/v2/actions/proxy` `POST`
|
305
|
+
|
306
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
307
|
+
|
308
|
+
---
|
309
|
+
|
310
|
+
|
311
|
+
### `composio.actions.execute_proxy`<a id="composioactionsexecute_proxy"></a>
|
312
|
+
|
313
|
+
Execute action proxy
|
314
|
+
|
315
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
316
|
+
|
317
|
+
```ruby
|
318
|
+
result = composio.actions.execute_proxy(
|
319
|
+
endpoint: "endpoint_example",
|
320
|
+
connected_account_id: "connectedAccountId_example",
|
321
|
+
)
|
322
|
+
p result
|
323
|
+
```
|
324
|
+
|
325
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
326
|
+
|
327
|
+
##### endpoint: `String`<a id="endpoint-string"></a>
|
328
|
+
##### connected_account_id: `String`<a id="connected_account_id-string"></a>
|
329
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
330
|
+
|
331
|
+
[ExecuteActionResDTO](./lib/composio/models/execute_action_res_dto.rb)
|
332
|
+
|
333
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
334
|
+
|
335
|
+
`/api/v1/actions/proxy` `POST`
|
336
|
+
|
337
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
338
|
+
|
339
|
+
---
|
340
|
+
|
341
|
+
|
342
|
+
### `composio.actions.get`<a id="composioactionsget"></a>
|
343
|
+
|
344
|
+
Get action
|
345
|
+
|
346
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
347
|
+
|
348
|
+
```ruby
|
349
|
+
result = composio.actions.get(
|
350
|
+
action_id: "'+j>6",
|
351
|
+
)
|
352
|
+
p result
|
353
|
+
```
|
354
|
+
|
355
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
356
|
+
|
357
|
+
##### action_id: `String`<a id="action_id-string"></a>
|
358
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
359
|
+
|
360
|
+
[ActionDetails](./lib/composio/models/action_details.rb)
|
361
|
+
|
362
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
363
|
+
|
364
|
+
`/api/v1/actions/{actionId}` `GET`
|
365
|
+
|
366
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
367
|
+
|
368
|
+
---
|
369
|
+
|
370
|
+
|
371
|
+
### `composio.actions.get_action_by_id`<a id="composioactionsget_action_by_id"></a>
|
372
|
+
|
373
|
+
Get action details
|
374
|
+
|
375
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
376
|
+
|
377
|
+
```ruby
|
378
|
+
result = composio.actions.get_action_by_id(
|
379
|
+
action_id: "'+j>6",
|
380
|
+
)
|
381
|
+
p result
|
382
|
+
```
|
383
|
+
|
384
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
385
|
+
|
386
|
+
##### action_id: `String`<a id="action_id-string"></a>
|
387
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
388
|
+
|
389
|
+
[ActionDetails](./lib/composio/models/action_details.rb)
|
390
|
+
|
391
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
392
|
+
|
393
|
+
`/api/v2/actions/{actionId}` `GET`
|
394
|
+
|
395
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
396
|
+
|
397
|
+
---
|
398
|
+
|
399
|
+
|
400
|
+
### `composio.actions.get_all_actions_based_on_query`<a id="composioactionsget_all_actions_based_on_query"></a>
|
401
|
+
|
402
|
+
Retrieve a list of all actions based on query parameters.
|
403
|
+
|
404
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
405
|
+
|
406
|
+
```ruby
|
407
|
+
result = composio.actions.get_all_actions_based_on_query(
|
408
|
+
app_names: "string_example",
|
409
|
+
use_case: "string_example",
|
410
|
+
show_enabled_only: true,
|
411
|
+
limit: 3.14,
|
412
|
+
apps: "string_example",
|
413
|
+
actions: "string_example",
|
414
|
+
tags: "string_example",
|
415
|
+
usecase_limit: 3.14,
|
416
|
+
filter_important_actions: true,
|
417
|
+
show_all: true,
|
418
|
+
)
|
419
|
+
p result
|
420
|
+
```
|
421
|
+
|
422
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
423
|
+
|
424
|
+
##### app_names: `String`<a id="app_names-string"></a>
|
425
|
+
##### use_case: `String`<a id="use_case-string"></a>
|
426
|
+
##### show_enabled_only: `Boolean`<a id="show_enabled_only-boolean"></a>
|
427
|
+
##### limit: `Float`<a id="limit-float"></a>
|
428
|
+
##### apps: `String`<a id="apps-string"></a>
|
429
|
+
##### actions: `String`<a id="actions-string"></a>
|
430
|
+
##### tags: `String`<a id="tags-string"></a>
|
431
|
+
##### usecase_limit: `Float`<a id="usecase_limit-float"></a>
|
432
|
+
##### filter_important_actions: `Boolean`<a id="filter_important_actions-boolean"></a>
|
433
|
+
##### show_all: `Boolean`<a id="show_all-boolean"></a>
|
434
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
435
|
+
|
436
|
+
[ActionsListResponseDTO](./lib/composio/models/actions_list_response_dto.rb)
|
437
|
+
|
438
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
439
|
+
|
440
|
+
`/api/v2/actions/list/all` `GET`
|
441
|
+
|
442
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
443
|
+
|
444
|
+
---
|
445
|
+
|
446
|
+
|
447
|
+
### `composio.actions.list`<a id="composioactionslist"></a>
|
448
|
+
|
449
|
+
List actions
|
450
|
+
|
451
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
452
|
+
|
453
|
+
```ruby
|
454
|
+
result = composio.actions.list(
|
455
|
+
app_names: "string_example",
|
456
|
+
use_case: "string_example",
|
457
|
+
show_enabled_only: true,
|
458
|
+
limit: 3.14,
|
459
|
+
apps: "string_example",
|
460
|
+
actions: "string_example",
|
461
|
+
tags: "string_example",
|
462
|
+
usecase_limit: 3.14,
|
463
|
+
filter_important_actions: true,
|
464
|
+
show_all: true,
|
465
|
+
)
|
466
|
+
p result
|
467
|
+
```
|
468
|
+
|
469
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
470
|
+
|
471
|
+
##### app_names: `String`<a id="app_names-string"></a>
|
472
|
+
##### use_case: `String`<a id="use_case-string"></a>
|
473
|
+
##### show_enabled_only: `Boolean`<a id="show_enabled_only-boolean"></a>
|
474
|
+
##### limit: `Float`<a id="limit-float"></a>
|
475
|
+
##### apps: `String`<a id="apps-string"></a>
|
476
|
+
##### actions: `String`<a id="actions-string"></a>
|
477
|
+
##### tags: `String`<a id="tags-string"></a>
|
478
|
+
##### usecase_limit: `Float`<a id="usecase_limit-float"></a>
|
479
|
+
##### filter_important_actions: `Boolean`<a id="filter_important_actions-boolean"></a>
|
480
|
+
##### show_all: `Boolean`<a id="show_all-boolean"></a>
|
481
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
482
|
+
|
483
|
+
[ActionsListResponseDTO](./lib/composio/models/actions_list_response_dto.rb)
|
484
|
+
|
485
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
486
|
+
|
487
|
+
`/api/v1/actions` `GET`
|
488
|
+
|
489
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
490
|
+
|
491
|
+
---
|
492
|
+
|
493
|
+
|
494
|
+
### `composio.actions.list_0`<a id="composioactionslist_0"></a>
|
495
|
+
|
496
|
+
Retrieve a list of all actions based on query parameters.
|
497
|
+
|
498
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
499
|
+
|
500
|
+
```ruby
|
501
|
+
result = composio.actions.list_0(
|
502
|
+
app_names: "string_example",
|
503
|
+
use_case: "string_example",
|
504
|
+
show_enabled_only: true,
|
505
|
+
limit: 3.14,
|
506
|
+
apps: "string_example",
|
507
|
+
actions: "string_example",
|
508
|
+
tags: "string_example",
|
509
|
+
usecase_limit: 3.14,
|
510
|
+
filter_important_actions: true,
|
511
|
+
show_all: true,
|
512
|
+
)
|
513
|
+
p result
|
514
|
+
```
|
515
|
+
|
516
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
517
|
+
|
518
|
+
##### app_names: `String`<a id="app_names-string"></a>
|
519
|
+
##### use_case: `String`<a id="use_case-string"></a>
|
520
|
+
##### show_enabled_only: `Boolean`<a id="show_enabled_only-boolean"></a>
|
521
|
+
##### limit: `Float`<a id="limit-float"></a>
|
522
|
+
##### apps: `String`<a id="apps-string"></a>
|
523
|
+
##### actions: `String`<a id="actions-string"></a>
|
524
|
+
##### tags: `String`<a id="tags-string"></a>
|
525
|
+
##### usecase_limit: `Float`<a id="usecase_limit-float"></a>
|
526
|
+
##### filter_important_actions: `Boolean`<a id="filter_important_actions-boolean"></a>
|
527
|
+
##### show_all: `Boolean`<a id="show_all-boolean"></a>
|
528
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
529
|
+
|
530
|
+
[ActionsListResponseDTO](./lib/composio/models/actions_list_response_dto.rb)
|
531
|
+
|
532
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
533
|
+
|
534
|
+
`/api/v2/actions` `GET`
|
535
|
+
|
536
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
537
|
+
|
538
|
+
---
|
539
|
+
|
540
|
+
|
541
|
+
### `composio.apps.get_details`<a id="composioappsget_details"></a>
|
542
|
+
|
543
|
+
Get app details
|
544
|
+
|
545
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
546
|
+
|
547
|
+
```ruby
|
548
|
+
result = composio.apps.get_details(
|
549
|
+
app_name: "'+j>6",
|
550
|
+
)
|
551
|
+
p result
|
552
|
+
```
|
553
|
+
|
554
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
555
|
+
|
556
|
+
##### app_name: `String`<a id="app_name-string"></a>
|
557
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
558
|
+
|
559
|
+
[SingleAppInfoResDTO](./lib/composio/models/single_app_info_res_dto.rb)
|
560
|
+
|
561
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
562
|
+
|
563
|
+
`/api/v1/apps/{appName}` `GET`
|
564
|
+
|
565
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
566
|
+
|
567
|
+
---
|
568
|
+
|
569
|
+
|
570
|
+
### `composio.apps.list`<a id="composioappslist"></a>
|
571
|
+
|
572
|
+
Retrieve a list of all applications based on query parameters.
|
573
|
+
|
574
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
575
|
+
|
576
|
+
```ruby
|
577
|
+
result = composio.apps.list(
|
578
|
+
category: "string_example",
|
579
|
+
)
|
580
|
+
p result
|
581
|
+
```
|
582
|
+
|
583
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
584
|
+
|
585
|
+
##### category: `String`<a id="category-string"></a>
|
586
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
587
|
+
|
588
|
+
[AppListResDTO](./lib/composio/models/app_list_res_dto.rb)
|
589
|
+
|
590
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
591
|
+
|
592
|
+
`/api/v1/apps` `GET`
|
593
|
+
|
594
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
595
|
+
|
596
|
+
---
|
597
|
+
|
598
|
+
|
599
|
+
### `composio.apps.list_open_api_specs`<a id="composioappslist_open_api_specs"></a>
|
600
|
+
|
601
|
+
Get opena api specs
|
602
|
+
|
603
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
604
|
+
|
605
|
+
```ruby
|
606
|
+
result = composio.apps.list_open_api_specs
|
607
|
+
p result
|
608
|
+
```
|
609
|
+
|
610
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
611
|
+
|
612
|
+
[AppListResDTO](./lib/composio/models/app_list_res_dto.rb)
|
613
|
+
|
614
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
615
|
+
|
616
|
+
`/api/v1/apps/openapi/spec/list` `GET`
|
617
|
+
|
618
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
619
|
+
|
620
|
+
---
|
621
|
+
|
622
|
+
|
623
|
+
### `composio.auth.identify_client_operation`<a id="composioauthidentify_client_operation"></a>
|
624
|
+
|
625
|
+
Identify client
|
626
|
+
|
627
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
628
|
+
|
629
|
+
```ruby
|
630
|
+
result = composio.auth.identify_client_operation(
|
631
|
+
hash: "string_example",
|
632
|
+
framework: "string_example",
|
633
|
+
)
|
634
|
+
p result
|
635
|
+
```
|
636
|
+
|
637
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
638
|
+
|
639
|
+
##### hash: `String`<a id="hash-string"></a>
|
640
|
+
The hash of the client
|
641
|
+
|
642
|
+
##### framework: `String`<a id="framework-string"></a>
|
643
|
+
The framework used by the client
|
644
|
+
|
645
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
646
|
+
|
647
|
+
[IdentifyClientResDTO](./lib/composio/models/identify_client_res_dto.rb)
|
648
|
+
|
649
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
650
|
+
|
651
|
+
`/api/v1/client/auth/identify` `POST`
|
652
|
+
|
653
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
654
|
+
|
655
|
+
---
|
656
|
+
|
657
|
+
|
658
|
+
### `composio.auth.send_magic_link`<a id="composioauthsend_magic_link"></a>
|
659
|
+
|
660
|
+
Send magic link
|
661
|
+
|
662
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
663
|
+
|
664
|
+
```ruby
|
665
|
+
result = composio.auth.send_magic_link(
|
666
|
+
email: "string_example",
|
667
|
+
verify_host: "string_example",
|
668
|
+
)
|
669
|
+
p result
|
670
|
+
```
|
671
|
+
|
672
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
673
|
+
|
674
|
+
##### email: `String`<a id="email-string"></a>
|
675
|
+
The email of the user
|
676
|
+
|
677
|
+
##### verifyHost: `String`<a id="verifyhost-string"></a>
|
678
|
+
The frontend host of the user
|
679
|
+
|
680
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
681
|
+
|
682
|
+
[MagicLinkResDTO](./lib/composio/models/magic_link_res_dto.rb)
|
683
|
+
|
684
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
685
|
+
|
686
|
+
`/api/v1/client/auth/send_magic_link` `POST`
|
687
|
+
|
688
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
689
|
+
|
690
|
+
---
|
691
|
+
|
692
|
+
|
693
|
+
### `composio.auth.user_logout`<a id="composioauthuser_logout"></a>
|
694
|
+
|
695
|
+
Logout the user and clear the server side session
|
696
|
+
|
697
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
698
|
+
|
699
|
+
```ruby
|
700
|
+
result = composio.auth.user_logout
|
701
|
+
p result
|
702
|
+
```
|
703
|
+
|
704
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
705
|
+
|
706
|
+
[LogoutResDTO](./lib/composio/models/logout_res_dto.rb)
|
707
|
+
|
708
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
709
|
+
|
710
|
+
`/api/v1/client/auth/logout` `POST`
|
711
|
+
|
712
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
713
|
+
|
714
|
+
---
|
715
|
+
|
716
|
+
|
717
|
+
### `composio.auth.verify_magic_link`<a id="composioauthverify_magic_link"></a>
|
718
|
+
|
719
|
+
Verify magic link
|
720
|
+
|
721
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
722
|
+
|
723
|
+
```ruby
|
724
|
+
result = composio.auth.verify_magic_link(
|
725
|
+
token: "string_example",
|
726
|
+
)
|
727
|
+
p result
|
728
|
+
```
|
729
|
+
|
730
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
731
|
+
|
732
|
+
##### token: `String`<a id="token-string"></a>
|
733
|
+
The magic link token
|
734
|
+
|
735
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
736
|
+
|
737
|
+
[VerifyMagicLinkResDTO](./lib/composio/models/verify_magic_link_res_dto.rb)
|
738
|
+
|
739
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
740
|
+
|
741
|
+
`/api/v1/client/auth/verify_magic_link` `POST`
|
742
|
+
|
743
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
744
|
+
|
745
|
+
---
|
746
|
+
|
747
|
+
|
748
|
+
### `composio.cli.exchange_code`<a id="composiocliexchange_code"></a>
|
749
|
+
|
750
|
+
Handle cli code exchange
|
751
|
+
|
752
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
753
|
+
|
754
|
+
```ruby
|
755
|
+
result = composio.cli.exchange_code
|
756
|
+
p result
|
757
|
+
```
|
758
|
+
|
759
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
760
|
+
|
761
|
+
[GenerateCLISessionResDTO](./lib/composio/models/generate_cli_session_res_dto.rb)
|
762
|
+
|
763
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
764
|
+
|
765
|
+
`/api/v1/cli/generate-cli-session` `GET`
|
766
|
+
|
767
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
768
|
+
|
769
|
+
---
|
770
|
+
|
771
|
+
|
772
|
+
### `composio.cli.get_code`<a id="composiocliget_code"></a>
|
773
|
+
|
774
|
+
Get cli code
|
775
|
+
|
776
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
777
|
+
|
778
|
+
```ruby
|
779
|
+
result = composio.cli.get_code(
|
780
|
+
key: "key_example",
|
781
|
+
code: "string_example",
|
782
|
+
)
|
783
|
+
p result
|
784
|
+
```
|
785
|
+
|
786
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
787
|
+
|
788
|
+
##### key: `String`<a id="key-string"></a>
|
789
|
+
##### code: `String`<a id="code-string"></a>
|
790
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
791
|
+
|
792
|
+
[GetCLISessionResDTO](./lib/composio/models/get_cli_session_res_dto.rb)
|
793
|
+
|
794
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
795
|
+
|
796
|
+
`/api/v1/cli/get-cli-code` `GET`
|
797
|
+
|
798
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
799
|
+
|
800
|
+
---
|
801
|
+
|
802
|
+
|
803
|
+
### `composio.cli.verify_code`<a id="composiocliverify_code"></a>
|
804
|
+
|
805
|
+
Handle cli code verification
|
806
|
+
|
807
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
808
|
+
|
809
|
+
```ruby
|
810
|
+
result = composio.cli.verify_code(
|
811
|
+
key: "key_example",
|
812
|
+
code: "string_example",
|
813
|
+
)
|
814
|
+
p result
|
815
|
+
```
|
816
|
+
|
817
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
818
|
+
|
819
|
+
##### key: `String`<a id="key-string"></a>
|
820
|
+
##### code: `String`<a id="code-string"></a>
|
821
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
822
|
+
|
823
|
+
[VerifyCLICodeResDTO](./lib/composio/models/verify_cli_code_res_dto.rb)
|
824
|
+
|
825
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
826
|
+
|
827
|
+
`/api/v1/cli/verify-cli-code` `GET`
|
828
|
+
|
829
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
830
|
+
|
831
|
+
---
|
832
|
+
|
833
|
+
|
834
|
+
### `composio.connections.delete`<a id="composioconnectionsdelete"></a>
|
835
|
+
|
836
|
+
Delete connection
|
837
|
+
|
838
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
839
|
+
|
840
|
+
```ruby
|
841
|
+
result = composio.connections.delete(
|
842
|
+
connected_account_id: "'+j>6",
|
843
|
+
)
|
844
|
+
p result
|
845
|
+
```
|
846
|
+
|
847
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
848
|
+
|
849
|
+
##### connected_account_id: `String`<a id="connected_account_id-string"></a>
|
850
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
851
|
+
|
852
|
+
[DeleteRowAPIDTO](./lib/composio/models/delete_row_apidto.rb)
|
853
|
+
|
854
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
855
|
+
|
856
|
+
`/api/v1/connectedAccounts/{connectedAccountId}` `DELETE`
|
857
|
+
|
858
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
859
|
+
|
860
|
+
---
|
861
|
+
|
862
|
+
|
863
|
+
### `composio.connections.disable`<a id="composioconnectionsdisable"></a>
|
864
|
+
|
865
|
+
Disable connection
|
866
|
+
|
867
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
868
|
+
|
869
|
+
```ruby
|
870
|
+
result = composio.connections.disable(
|
871
|
+
connected_account_id: "'+j>6",
|
872
|
+
)
|
873
|
+
p result
|
874
|
+
```
|
875
|
+
|
876
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
877
|
+
|
878
|
+
##### connected_account_id: `String`<a id="connected_account_id-string"></a>
|
879
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
880
|
+
|
881
|
+
[ToggleConnectedAccountResponseDTO](./lib/composio/models/toggle_connected_account_response_dto.rb)
|
882
|
+
|
883
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
884
|
+
|
885
|
+
`/api/v1/connectedAccounts/{connectedAccountId}/disable` `POST`
|
886
|
+
|
887
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
888
|
+
|
889
|
+
---
|
890
|
+
|
891
|
+
|
892
|
+
### `composio.connections.enable`<a id="composioconnectionsenable"></a>
|
893
|
+
|
894
|
+
Enable connection
|
895
|
+
|
896
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
897
|
+
|
898
|
+
```ruby
|
899
|
+
result = composio.connections.enable(
|
900
|
+
connected_account_id: "'+j>6",
|
901
|
+
)
|
902
|
+
p result
|
903
|
+
```
|
904
|
+
|
905
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
906
|
+
|
907
|
+
##### connected_account_id: `String`<a id="connected_account_id-string"></a>
|
908
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
909
|
+
|
910
|
+
[ToggleConnectedAccountResponseDTO](./lib/composio/models/toggle_connected_account_response_dto.rb)
|
911
|
+
|
912
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
913
|
+
|
914
|
+
`/api/v1/connectedAccounts/{connectedAccountId}/enable` `POST`
|
915
|
+
|
916
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
917
|
+
|
918
|
+
---
|
919
|
+
|
920
|
+
|
921
|
+
### `composio.connections.get`<a id="composioconnectionsget"></a>
|
922
|
+
|
923
|
+
Get connection
|
924
|
+
|
925
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
926
|
+
|
927
|
+
```ruby
|
928
|
+
result = composio.connections.get(
|
929
|
+
connected_account_id: "'+j>6",
|
930
|
+
)
|
931
|
+
p result
|
932
|
+
```
|
933
|
+
|
934
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
935
|
+
|
936
|
+
##### connected_account_id: `String`<a id="connected_account_id-string"></a>
|
937
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
938
|
+
|
939
|
+
[ConnectedAccountResponseDTO](./lib/composio/models/connected_account_response_dto.rb)
|
940
|
+
|
941
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
942
|
+
|
943
|
+
`/api/v1/connectedAccounts/{connectedAccountId}` `GET`
|
944
|
+
|
945
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
946
|
+
|
947
|
+
---
|
948
|
+
|
949
|
+
|
950
|
+
### `composio.connections.initiate`<a id="composioconnectionsinitiate"></a>
|
951
|
+
|
952
|
+
Initiate connection
|
953
|
+
|
954
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
955
|
+
|
956
|
+
```ruby
|
957
|
+
result = composio.connections.initiate(
|
958
|
+
integration_id: "a",
|
959
|
+
data: "a",
|
960
|
+
redirect_uri: "string_example",
|
961
|
+
user_uuid: "string_example",
|
962
|
+
)
|
963
|
+
p result
|
964
|
+
```
|
965
|
+
|
966
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
967
|
+
|
968
|
+
##### integrationId: `String`<a id="integrationid-string"></a>
|
969
|
+
##### data: `String`<a id="data-string"></a>
|
970
|
+
##### redirectUri: `String`<a id="redirecturi-string"></a>
|
971
|
+
##### userUuid: `String`<a id="useruuid-string"></a>
|
972
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
973
|
+
|
974
|
+
[InitiateConnectionResponse](./lib/composio/models/initiate_connection_response.rb)
|
975
|
+
|
976
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
977
|
+
|
978
|
+
`/api/v1/connectedAccounts` `POST`
|
979
|
+
|
980
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
981
|
+
|
982
|
+
---
|
983
|
+
|
984
|
+
|
985
|
+
### `composio.connections.list`<a id="composioconnectionslist"></a>
|
986
|
+
|
987
|
+
Get connections
|
988
|
+
|
989
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
990
|
+
|
991
|
+
```ruby
|
992
|
+
result = composio.connections.list(
|
993
|
+
page: 3.14,
|
994
|
+
page_size: 3.14,
|
995
|
+
app_names: "string_example",
|
996
|
+
integration_id: "string_example",
|
997
|
+
connection_id: "string_example",
|
998
|
+
user_uuid: "string_example",
|
999
|
+
show_active_only: true,
|
1000
|
+
status: "string_example",
|
1001
|
+
show_disabled: true,
|
1002
|
+
)
|
1003
|
+
p result
|
1004
|
+
```
|
1005
|
+
|
1006
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1007
|
+
|
1008
|
+
##### page: `Float`<a id="page-float"></a>
|
1009
|
+
##### page_size: `Float`<a id="page_size-float"></a>
|
1010
|
+
##### app_names: `String`<a id="app_names-string"></a>
|
1011
|
+
##### integration_id: `String`<a id="integration_id-string"></a>
|
1012
|
+
##### connection_id: `String`<a id="connection_id-string"></a>
|
1013
|
+
##### user_uuid: `String`<a id="user_uuid-string"></a>
|
1014
|
+
##### show_active_only: `Boolean`<a id="show_active_only-boolean"></a>
|
1015
|
+
##### status: `String`<a id="status-string"></a>
|
1016
|
+
##### show_disabled: `Boolean`<a id="show_disabled-boolean"></a>
|
1017
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1018
|
+
|
1019
|
+
[GetConnectionsResponseDto](./lib/composio/models/get_connections_response_dto.rb)
|
1020
|
+
|
1021
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1022
|
+
|
1023
|
+
`/api/v1/connectedAccounts` `GET`
|
1024
|
+
|
1025
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1026
|
+
|
1027
|
+
---
|
1028
|
+
|
1029
|
+
|
1030
|
+
### `composio.integrations.create_integration`<a id="composiointegrationscreate_integration"></a>
|
1031
|
+
|
1032
|
+
Create connector
|
1033
|
+
|
1034
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1035
|
+
|
1036
|
+
```ruby
|
1037
|
+
result = composio.integrations.create_integration(
|
1038
|
+
name: "string_example",
|
1039
|
+
app_id: "string_example",
|
1040
|
+
auth_scheme: "string_example",
|
1041
|
+
auth_config: {
|
1042
|
+
},
|
1043
|
+
use_composio_auth: true,
|
1044
|
+
force_new_integration: true,
|
1045
|
+
)
|
1046
|
+
p result
|
1047
|
+
```
|
1048
|
+
|
1049
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1050
|
+
|
1051
|
+
##### name: `String`<a id="name-string"></a>
|
1052
|
+
Name of the connector
|
1053
|
+
|
1054
|
+
##### appId: `String`<a id="appid-string"></a>
|
1055
|
+
Application ID
|
1056
|
+
|
1057
|
+
##### authScheme: `String`<a id="authscheme-string"></a>
|
1058
|
+
Authentication scheme
|
1059
|
+
|
1060
|
+
##### authConfig: [`AuthConfigDTO`](./lib/composio/models/auth_config_dto.rb)<a id="authconfig-authconfigdtolibcomposiomodelsauth_config_dtorb"></a>
|
1061
|
+
##### useComposioAuth: [`CreateConnectorPayloadDTOUseComposioAuth`](./lib/composio/models/create_connector_payload_dto_use_composio_auth.rb)<a id="usecomposioauth-createconnectorpayloaddtousecomposioauthlibcomposiomodelscreate_connector_payload_dto_use_composio_authrb"></a>
|
1062
|
+
##### forceNewIntegration: `Boolean`<a id="forcenewintegration-boolean"></a>
|
1063
|
+
Flag to force new integration
|
1064
|
+
|
1065
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1066
|
+
|
1067
|
+
[GetConnectorInfoResDTO](./lib/composio/models/get_connector_info_res_dto.rb)
|
1068
|
+
|
1069
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1070
|
+
|
1071
|
+
`/api/v1/integrations` `POST`
|
1072
|
+
|
1073
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1074
|
+
|
1075
|
+
---
|
1076
|
+
|
1077
|
+
|
1078
|
+
### `composio.integrations.delete_connector`<a id="composiointegrationsdelete_connector"></a>
|
1079
|
+
|
1080
|
+
Delete connector
|
1081
|
+
|
1082
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1083
|
+
|
1084
|
+
```ruby
|
1085
|
+
result = composio.integrations.delete_connector(
|
1086
|
+
integration_id: "'+j>6",
|
1087
|
+
)
|
1088
|
+
p result
|
1089
|
+
```
|
1090
|
+
|
1091
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1092
|
+
|
1093
|
+
##### integration_id: `String`<a id="integration_id-string"></a>
|
1094
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1095
|
+
|
1096
|
+
[DeleteRowAPIDTO](./lib/composio/models/delete_row_apidto.rb)
|
1097
|
+
|
1098
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1099
|
+
|
1100
|
+
`/api/v1/integrations/{integrationId}` `DELETE`
|
1101
|
+
|
1102
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1103
|
+
|
1104
|
+
---
|
1105
|
+
|
1106
|
+
|
1107
|
+
### `composio.integrations.get_connector_info`<a id="composiointegrationsget_connector_info"></a>
|
1108
|
+
|
1109
|
+
Get connector info
|
1110
|
+
|
1111
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1112
|
+
|
1113
|
+
```ruby
|
1114
|
+
result = composio.integrations.get_connector_info(
|
1115
|
+
integration_id: "'+j>6",
|
1116
|
+
)
|
1117
|
+
p result
|
1118
|
+
```
|
1119
|
+
|
1120
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1121
|
+
|
1122
|
+
##### integration_id: `String`<a id="integration_id-string"></a>
|
1123
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1124
|
+
|
1125
|
+
[GetConnectorInfoResDTO](./lib/composio/models/get_connector_info_res_dto.rb)
|
1126
|
+
|
1127
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1128
|
+
|
1129
|
+
`/api/v1/integrations/{integrationId}` `GET`
|
1130
|
+
|
1131
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1132
|
+
|
1133
|
+
---
|
1134
|
+
|
1135
|
+
|
1136
|
+
### `composio.integrations.list_global_connectors`<a id="composiointegrationslist_global_connectors"></a>
|
1137
|
+
|
1138
|
+
List global connectors
|
1139
|
+
|
1140
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1141
|
+
|
1142
|
+
```ruby
|
1143
|
+
result = composio.integrations.list_global_connectors
|
1144
|
+
p result
|
1145
|
+
```
|
1146
|
+
|
1147
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1148
|
+
|
1149
|
+
[GetConnectorListResDTO](./lib/composio/models/get_connector_list_res_dto.rb)
|
1150
|
+
|
1151
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1152
|
+
|
1153
|
+
`/api/v1/integrations` `GET`
|
1154
|
+
|
1155
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1156
|
+
|
1157
|
+
---
|
1158
|
+
|
1159
|
+
|
1160
|
+
### `composio.integrations.update_integration`<a id="composiointegrationsupdate_integration"></a>
|
1161
|
+
|
1162
|
+
Patch connector
|
1163
|
+
|
1164
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1165
|
+
|
1166
|
+
```ruby
|
1167
|
+
result = composio.integrations.update_integration(
|
1168
|
+
integration_id: "'+j>6",
|
1169
|
+
auth_config: {},
|
1170
|
+
enabled: true,
|
1171
|
+
)
|
1172
|
+
p result
|
1173
|
+
```
|
1174
|
+
|
1175
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1176
|
+
|
1177
|
+
##### integration_id: `String`<a id="integration_id-string"></a>
|
1178
|
+
##### authConfig: `Object`<a id="authconfig-object"></a>
|
1179
|
+
Authentication configuration for the connector
|
1180
|
+
|
1181
|
+
##### enabled: `Boolean`<a id="enabled-boolean"></a>
|
1182
|
+
Flag to indicate if the connector is enabled
|
1183
|
+
|
1184
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1185
|
+
|
1186
|
+
[PatchConnectorResDTO](./lib/composio/models/patch_connector_res_dto.rb)
|
1187
|
+
|
1188
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1189
|
+
|
1190
|
+
`/api/v1/integrations/{integrationId}` `PATCH`
|
1191
|
+
|
1192
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1193
|
+
|
1194
|
+
---
|
1195
|
+
|
1196
|
+
|
1197
|
+
### `composio.integrations.update_status`<a id="composiointegrationsupdate_status"></a>
|
1198
|
+
|
1199
|
+
Patch post connector
|
1200
|
+
|
1201
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1202
|
+
|
1203
|
+
```ruby
|
1204
|
+
result = composio.integrations.update_status(
|
1205
|
+
integration_id: "'+j>6",
|
1206
|
+
auth_config: {},
|
1207
|
+
enabled: true,
|
1208
|
+
)
|
1209
|
+
p result
|
1210
|
+
```
|
1211
|
+
|
1212
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1213
|
+
|
1214
|
+
##### integration_id: `String`<a id="integration_id-string"></a>
|
1215
|
+
##### authConfig: `Object`<a id="authconfig-object"></a>
|
1216
|
+
Authentication configuration for the connector
|
1217
|
+
|
1218
|
+
##### enabled: `Boolean`<a id="enabled-boolean"></a>
|
1219
|
+
Flag to indicate if the connector is enabled
|
1220
|
+
|
1221
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1222
|
+
|
1223
|
+
[PatchConnectorResDTO](./lib/composio/models/patch_connector_res_dto.rb)
|
1224
|
+
|
1225
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1226
|
+
|
1227
|
+
`/api/v1/integrations/{integrationId}/status` `POST`
|
1228
|
+
|
1229
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1230
|
+
|
1231
|
+
---
|
1232
|
+
|
1233
|
+
|
1234
|
+
### `composio.logs.list`<a id="composiologslist"></a>
|
1235
|
+
|
1236
|
+
List logs
|
1237
|
+
|
1238
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1239
|
+
|
1240
|
+
```ruby
|
1241
|
+
result = composio.logs.list(
|
1242
|
+
type: "error",
|
1243
|
+
time: "5m",
|
1244
|
+
status: "all",
|
1245
|
+
search: "string_example",
|
1246
|
+
integration_id: "string_example",
|
1247
|
+
limit: 10,
|
1248
|
+
cursor: "string_example",
|
1249
|
+
connection_id: "string_example",
|
1250
|
+
)
|
1251
|
+
p result
|
1252
|
+
```
|
1253
|
+
|
1254
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1255
|
+
|
1256
|
+
##### type: `String`<a id="type-string"></a>
|
1257
|
+
##### time: `String`<a id="time-string"></a>
|
1258
|
+
##### status: `String`<a id="status-string"></a>
|
1259
|
+
##### search: `String`<a id="search-string"></a>
|
1260
|
+
##### integration_id: `String`<a id="integration_id-string"></a>
|
1261
|
+
##### limit: `Float`<a id="limit-float"></a>
|
1262
|
+
##### cursor: `String`<a id="cursor-string"></a>
|
1263
|
+
##### connection_id: `String`<a id="connection_id-string"></a>
|
1264
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1265
|
+
|
1266
|
+
[LogsResDTO](./lib/composio/models/logs_res_dto.rb)
|
1267
|
+
|
1268
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1269
|
+
|
1270
|
+
`/api/v1/logs` `GET`
|
1271
|
+
|
1272
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1273
|
+
|
1274
|
+
---
|
1275
|
+
|
1276
|
+
|
1277
|
+
### `composio.metadata.get_toggle_info`<a id="composiometadataget_toggle_info"></a>
|
1278
|
+
|
1279
|
+
Get toggle info
|
1280
|
+
|
1281
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1282
|
+
|
1283
|
+
```ruby
|
1284
|
+
result = composio.metadata.get_toggle_info
|
1285
|
+
p result
|
1286
|
+
```
|
1287
|
+
|
1288
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1289
|
+
|
1290
|
+
[TriggerToggleInfoResponseDTO](./lib/composio/models/trigger_toggle_info_response_dto.rb)
|
1291
|
+
|
1292
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1293
|
+
|
1294
|
+
`/api/v1/metadata/toggle.info` `GET`
|
1295
|
+
|
1296
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1297
|
+
|
1298
|
+
---
|
1299
|
+
|
1300
|
+
|
1301
|
+
### `composio.metadata.toggle_trigger_state`<a id="composiometadatatoggle_trigger_state"></a>
|
1302
|
+
|
1303
|
+
Toggle trigger state
|
1304
|
+
|
1305
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1306
|
+
|
1307
|
+
```ruby
|
1308
|
+
result = composio.metadata.toggle_trigger_state(
|
1309
|
+
enabled: true,
|
1310
|
+
)
|
1311
|
+
p result
|
1312
|
+
```
|
1313
|
+
|
1314
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1315
|
+
|
1316
|
+
##### enabled: `Boolean`<a id="enabled-boolean"></a>
|
1317
|
+
Flag to enable or disable triggers
|
1318
|
+
|
1319
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1320
|
+
|
1321
|
+
[ToggleTriggerStateResponseDTO](./lib/composio/models/toggle_trigger_state_response_dto.rb)
|
1322
|
+
|
1323
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1324
|
+
|
1325
|
+
`/api/v1/metadata/toggle/trigger` `POST`
|
1326
|
+
|
1327
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1328
|
+
|
1329
|
+
---
|
1330
|
+
|
1331
|
+
|
1332
|
+
### `composio.team.get_member_list`<a id="composioteamget_member_list"></a>
|
1333
|
+
|
1334
|
+
List members
|
1335
|
+
|
1336
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1337
|
+
|
1338
|
+
```ruby
|
1339
|
+
result = composio.team.get_member_list
|
1340
|
+
p result
|
1341
|
+
```
|
1342
|
+
|
1343
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1344
|
+
|
1345
|
+
[MemberResDTO](./lib/composio/models/member_res_dto.rb)
|
1346
|
+
|
1347
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1348
|
+
|
1349
|
+
`/api/v1/team/members` `GET`
|
1350
|
+
|
1351
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1352
|
+
|
1353
|
+
---
|
1354
|
+
|
1355
|
+
|
1356
|
+
### `composio.team.send_invitation`<a id="composioteamsend_invitation"></a>
|
1357
|
+
|
1358
|
+
Invite member
|
1359
|
+
|
1360
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1361
|
+
|
1362
|
+
```ruby
|
1363
|
+
result = composio.team.send_invitation(
|
1364
|
+
email: "string_example",
|
1365
|
+
name: "string_example",
|
1366
|
+
verify_host: "string_example",
|
1367
|
+
)
|
1368
|
+
p result
|
1369
|
+
```
|
1370
|
+
|
1371
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1372
|
+
|
1373
|
+
##### email: `String`<a id="email-string"></a>
|
1374
|
+
The email of the member
|
1375
|
+
|
1376
|
+
##### name: `String`<a id="name-string"></a>
|
1377
|
+
The name of the member
|
1378
|
+
|
1379
|
+
##### verifyHost: `String`<a id="verifyhost-string"></a>
|
1380
|
+
The host to verify the member
|
1381
|
+
|
1382
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1383
|
+
|
1384
|
+
[MemberResDTO](./lib/composio/models/member_res_dto.rb)
|
1385
|
+
|
1386
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1387
|
+
|
1388
|
+
`/api/v1/team/invite` `POST`
|
1389
|
+
|
1390
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1391
|
+
|
1392
|
+
---
|
1393
|
+
|
1394
|
+
|
1395
|
+
### `composio.triggers.delete_trigger_instance`<a id="composiotriggersdelete_trigger_instance"></a>
|
1396
|
+
|
1397
|
+
Deletes a specified trigger instance.
|
1398
|
+
|
1399
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1400
|
+
|
1401
|
+
```ruby
|
1402
|
+
result = composio.triggers.delete_trigger_instance(
|
1403
|
+
trigger_instance_id: "'+j>6",
|
1404
|
+
)
|
1405
|
+
p result
|
1406
|
+
```
|
1407
|
+
|
1408
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1409
|
+
|
1410
|
+
##### trigger_instance_id: `String`<a id="trigger_instance_id-string"></a>
|
1411
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1412
|
+
|
1413
|
+
[DeleteRowAPIDTO](./lib/composio/models/delete_row_apidto.rb)
|
1414
|
+
|
1415
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1416
|
+
|
1417
|
+
`/api/v1/triggers/instance/{triggerInstanceId}` `DELETE`
|
1418
|
+
|
1419
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1420
|
+
|
1421
|
+
---
|
1422
|
+
|
1423
|
+
|
1424
|
+
### `composio.triggers.disable_trigger_instance`<a id="composiotriggersdisable_trigger_instance"></a>
|
1425
|
+
|
1426
|
+
Disables a specified trigger instance.
|
1427
|
+
|
1428
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1429
|
+
|
1430
|
+
```ruby
|
1431
|
+
result = composio.triggers.disable_trigger_instance(
|
1432
|
+
trigger_instance_id: "'+j>6",
|
1433
|
+
)
|
1434
|
+
p result
|
1435
|
+
```
|
1436
|
+
|
1437
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1438
|
+
|
1439
|
+
##### trigger_instance_id: `String`<a id="trigger_instance_id-string"></a>
|
1440
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1441
|
+
|
1442
|
+
[TriggerResponseDTO](./lib/composio/models/trigger_response_dto.rb)
|
1443
|
+
|
1444
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1445
|
+
|
1446
|
+
`/api/v1/triggers/disable/{triggerInstanceId}` `POST`
|
1447
|
+
|
1448
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1449
|
+
|
1450
|
+
---
|
1451
|
+
|
1452
|
+
|
1453
|
+
### `composio.triggers.enable`<a id="composiotriggersenable"></a>
|
1454
|
+
|
1455
|
+
Enables a trigger for a connected account and specific trigger name.
|
1456
|
+
|
1457
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1458
|
+
|
1459
|
+
```ruby
|
1460
|
+
result = composio.triggers.enable(
|
1461
|
+
trigger_config: {},
|
1462
|
+
connected_account_id: "'+j>6",
|
1463
|
+
trigger_name: "'+j>6",
|
1464
|
+
)
|
1465
|
+
p result
|
1466
|
+
```
|
1467
|
+
|
1468
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1469
|
+
|
1470
|
+
##### triggerConfig: `Object`<a id="triggerconfig-object"></a>
|
1471
|
+
The trigger configuration
|
1472
|
+
|
1473
|
+
##### connected_account_id: `String`<a id="connected_account_id-string"></a>
|
1474
|
+
##### trigger_name: `String`<a id="trigger_name-string"></a>
|
1475
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1476
|
+
|
1477
|
+
[TriggerResponseDTO](./lib/composio/models/trigger_response_dto.rb)
|
1478
|
+
|
1479
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1480
|
+
|
1481
|
+
`/api/v1/triggers/enable/{connectedAccountId}/{triggerName}` `POST`
|
1482
|
+
|
1483
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1484
|
+
|
1485
|
+
---
|
1486
|
+
|
1487
|
+
|
1488
|
+
### `composio.triggers.get_active_triggers`<a id="composiotriggersget_active_triggers"></a>
|
1489
|
+
|
1490
|
+
Lists active triggers based on query parameters.
|
1491
|
+
|
1492
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1493
|
+
|
1494
|
+
```ruby
|
1495
|
+
result = composio.triggers.get_active_triggers(
|
1496
|
+
connected_account_ids: "string_example",
|
1497
|
+
integration_ids: "string_example",
|
1498
|
+
trigger_ids: "string_example",
|
1499
|
+
trigger_names: "string_example",
|
1500
|
+
page: 3.14,
|
1501
|
+
limit: 3.14,
|
1502
|
+
show_disabled: true,
|
1503
|
+
)
|
1504
|
+
p result
|
1505
|
+
```
|
1506
|
+
|
1507
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1508
|
+
|
1509
|
+
##### connected_account_ids: `String`<a id="connected_account_ids-string"></a>
|
1510
|
+
##### integration_ids: `String`<a id="integration_ids-string"></a>
|
1511
|
+
##### trigger_ids: `String`<a id="trigger_ids-string"></a>
|
1512
|
+
##### trigger_names: `String`<a id="trigger_names-string"></a>
|
1513
|
+
##### page: `Float`<a id="page-float"></a>
|
1514
|
+
##### limit: `Float`<a id="limit-float"></a>
|
1515
|
+
##### show_disabled: `Boolean`<a id="show_disabled-boolean"></a>
|
1516
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1517
|
+
|
1518
|
+
[ActiveTriggersResDTO](./lib/composio/models/active_triggers_res_dto.rb)
|
1519
|
+
|
1520
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1521
|
+
|
1522
|
+
`/api/v1/triggers/active_triggers` `GET`
|
1523
|
+
|
1524
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1525
|
+
|
1526
|
+
---
|
1527
|
+
|
1528
|
+
|
1529
|
+
### `composio.triggers.get_by_id`<a id="composiotriggersget_by_id"></a>
|
1530
|
+
|
1531
|
+
Retrieves a specific trigger by its ID.
|
1532
|
+
|
1533
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1534
|
+
|
1535
|
+
```ruby
|
1536
|
+
result = composio.triggers.get_by_id(
|
1537
|
+
trigger_id: "'+j>6",
|
1538
|
+
)
|
1539
|
+
p result
|
1540
|
+
```
|
1541
|
+
|
1542
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1543
|
+
|
1544
|
+
##### trigger_id: `String`<a id="trigger_id-string"></a>
|
1545
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1546
|
+
|
1547
|
+
[GetTriggerResponseDTO](./lib/composio/models/get_trigger_response_dto.rb)
|
1548
|
+
|
1549
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1550
|
+
|
1551
|
+
`/api/v1/triggers/get/{triggerId}` `GET`
|
1552
|
+
|
1553
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1554
|
+
|
1555
|
+
---
|
1556
|
+
|
1557
|
+
|
1558
|
+
### `composio.triggers.get_callback_url`<a id="composiotriggersget_callback_url"></a>
|
1559
|
+
|
1560
|
+
Retrieves the universal callback URL set for the client.
|
1561
|
+
|
1562
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1563
|
+
|
1564
|
+
```ruby
|
1565
|
+
result = composio.triggers.get_callback_url
|
1566
|
+
p result
|
1567
|
+
```
|
1568
|
+
|
1569
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1570
|
+
|
1571
|
+
[WebhookURLResponseDTO](./lib/composio/models/webhook_url_response_dto.rb)
|
1572
|
+
|
1573
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1574
|
+
|
1575
|
+
`/api/v1/triggers/callback_url` `GET`
|
1576
|
+
|
1577
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1578
|
+
|
1579
|
+
---
|
1580
|
+
|
1581
|
+
|
1582
|
+
### `composio.triggers.get_logs_based_on_connection_and_integration_details`<a id="composiotriggersget_logs_based_on_connection_and_integration_details"></a>
|
1583
|
+
|
1584
|
+
Fetches logs based on connection and integration details.
|
1585
|
+
|
1586
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1587
|
+
|
1588
|
+
```ruby
|
1589
|
+
result = composio.triggers.get_logs_based_on_connection_and_integration_details(
|
1590
|
+
connection_id: "string_example",
|
1591
|
+
integration_id: "string_example",
|
1592
|
+
page: 3.14,
|
1593
|
+
limit: 3.14,
|
1594
|
+
)
|
1595
|
+
p result
|
1596
|
+
```
|
1597
|
+
|
1598
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1599
|
+
|
1600
|
+
##### connection_id: `String`<a id="connection_id-string"></a>
|
1601
|
+
##### integration_id: `String`<a id="integration_id-string"></a>
|
1602
|
+
##### page: `Float`<a id="page-float"></a>
|
1603
|
+
##### limit: `Float`<a id="limit-float"></a>
|
1604
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1605
|
+
|
1606
|
+
[TriggerLogsResDTO](./lib/composio/models/trigger_logs_res_dto.rb)
|
1607
|
+
|
1608
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1609
|
+
|
1610
|
+
`/api/v1/triggers/logs` `GET`
|
1611
|
+
|
1612
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1613
|
+
|
1614
|
+
---
|
1615
|
+
|
1616
|
+
|
1617
|
+
### `composio.triggers.get_trigger_info`<a id="composiotriggersget_trigger_info"></a>
|
1618
|
+
|
1619
|
+
Get Trigger Info
|
1620
|
+
|
1621
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1622
|
+
|
1623
|
+
```ruby
|
1624
|
+
result = composio.triggers.get_trigger_info(
|
1625
|
+
trigger_name: "'+j>6",
|
1626
|
+
)
|
1627
|
+
p result
|
1628
|
+
```
|
1629
|
+
|
1630
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1631
|
+
|
1632
|
+
##### trigger_name: `String`<a id="trigger_name-string"></a>
|
1633
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1634
|
+
|
1635
|
+
[SingleTriggerResDTO](./lib/composio/models/single_trigger_res_dto.rb)
|
1636
|
+
|
1637
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1638
|
+
|
1639
|
+
`/api/v2/triggers/{triggerName}` `GET`
|
1640
|
+
|
1641
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1642
|
+
|
1643
|
+
---
|
1644
|
+
|
1645
|
+
|
1646
|
+
### `composio.triggers.list`<a id="composiotriggerslist"></a>
|
1647
|
+
|
1648
|
+
List triggers
|
1649
|
+
|
1650
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1651
|
+
|
1652
|
+
```ruby
|
1653
|
+
result = composio.triggers.list(
|
1654
|
+
app_names: "string_example",
|
1655
|
+
connected_account_ids: "string_example",
|
1656
|
+
trigger_ids: "string_example",
|
1657
|
+
show_enabled_only: true,
|
1658
|
+
)
|
1659
|
+
p result
|
1660
|
+
```
|
1661
|
+
|
1662
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1663
|
+
|
1664
|
+
##### app_names: `String`<a id="app_names-string"></a>
|
1665
|
+
##### connected_account_ids: `String`<a id="connected_account_ids-string"></a>
|
1666
|
+
##### trigger_ids: `String`<a id="trigger_ids-string"></a>
|
1667
|
+
##### show_enabled_only: `Boolean`<a id="show_enabled_only-boolean"></a>
|
1668
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1669
|
+
|
1670
|
+
[TriggerResDTO](./lib/composio/models/trigger_res_dto.rb)
|
1671
|
+
|
1672
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1673
|
+
|
1674
|
+
`/api/v1/triggers` `GET`
|
1675
|
+
|
1676
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1677
|
+
|
1678
|
+
---
|
1679
|
+
|
1680
|
+
|
1681
|
+
### `composio.triggers.set_callback_url`<a id="composiotriggersset_callback_url"></a>
|
1682
|
+
|
1683
|
+
Sets a universal callback URL for the client.
|
1684
|
+
|
1685
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1686
|
+
|
1687
|
+
```ruby
|
1688
|
+
result = composio.triggers.set_callback_url(
|
1689
|
+
callback_url: "string_example",
|
1690
|
+
)
|
1691
|
+
p result
|
1692
|
+
```
|
1693
|
+
|
1694
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1695
|
+
|
1696
|
+
##### callbackURL: `String`<a id="callbackurl-string"></a>
|
1697
|
+
The callback URL
|
1698
|
+
|
1699
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1700
|
+
|
1701
|
+
[TriggerResponseDTO](./lib/composio/models/trigger_response_dto.rb)
|
1702
|
+
|
1703
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1704
|
+
|
1705
|
+
`/api/v1/triggers/set_callback_url` `POST`
|
1706
|
+
|
1707
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1708
|
+
|
1709
|
+
---
|
1710
|
+
|
1711
|
+
|
1712
|
+
### `composio.triggers.switch_instance_status`<a id="composiotriggersswitch_instance_status"></a>
|
1713
|
+
|
1714
|
+
Switches the status of a trigger instance.
|
1715
|
+
|
1716
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1717
|
+
|
1718
|
+
```ruby
|
1719
|
+
result = composio.triggers.switch_instance_status(
|
1720
|
+
enabled: true,
|
1721
|
+
trigger_id: "'+j>6",
|
1722
|
+
)
|
1723
|
+
p result
|
1724
|
+
```
|
1725
|
+
|
1726
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1727
|
+
|
1728
|
+
##### enabled: `Boolean`<a id="enabled-boolean"></a>
|
1729
|
+
The new enabled status of the trigger
|
1730
|
+
|
1731
|
+
##### trigger_id: `String`<a id="trigger_id-string"></a>
|
1732
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1733
|
+
|
1734
|
+
[TriggerResponseDTO](./lib/composio/models/trigger_response_dto.rb)
|
1735
|
+
|
1736
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1737
|
+
|
1738
|
+
`/api/v1/triggers/instance/{triggerId}/status` `PATCH`
|
1739
|
+
|
1740
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1741
|
+
|
1742
|
+
---
|
1743
|
+
|
1744
|
+
|
1745
|
+
### `composio.triggers.switch_post_instance_status`<a id="composiotriggersswitch_post_instance_status"></a>
|
1746
|
+
|
1747
|
+
Switches the status of a trigger instance.
|
1748
|
+
|
1749
|
+
#### 🛠️ Usage<a id="🛠️-usage"></a>
|
1750
|
+
|
1751
|
+
```ruby
|
1752
|
+
result = composio.triggers.switch_post_instance_status(
|
1753
|
+
enabled: true,
|
1754
|
+
trigger_id: "'+j>6",
|
1755
|
+
)
|
1756
|
+
p result
|
1757
|
+
```
|
1758
|
+
|
1759
|
+
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
|
1760
|
+
|
1761
|
+
##### enabled: `Boolean`<a id="enabled-boolean"></a>
|
1762
|
+
The new enabled status of the trigger
|
1763
|
+
|
1764
|
+
##### trigger_id: `String`<a id="trigger_id-string"></a>
|
1765
|
+
#### 🔄 Return<a id="🔄-return"></a>
|
1766
|
+
|
1767
|
+
[TriggerResponseDTO](./lib/composio/models/trigger_response_dto.rb)
|
1768
|
+
|
1769
|
+
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
|
1770
|
+
|
1771
|
+
`/api/v1/triggers/instance/{triggerId}/status` `POST`
|
1772
|
+
|
1773
|
+
[🔙 **Back to Table of Contents**](#table-of-contents)
|
1774
|
+
|
1775
|
+
---
|
1776
|
+
|
1777
|
+
|
1778
|
+
## Author<a id="author"></a>
|
1779
|
+
This TypeScript package is automatically generated by [Konfig](https://konfigthis.com)
|