[![Visit Composio](./header.png)](https://composio.dev) # [Composio](https://composio.dev) Composio SDK: Equip your agent with high-quality tools and build your real-world usecase [![npm](https://img.shields.io/badge/gem-v0.1.8-blue)](https://rubygems.org/gems/composio/versions/0.1.8) [![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://composio.dev)
## Table of Contents - [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_action_proxy`](#composioactionsexecute_action_proxy) * [`composio.actions.get_action_by_id`](#composioactionsget_action_by_id) * [`composio.actions.get_action_inputs`](#composioactionsget_action_inputs) * [`composio.actions.get_all_actions_based_on_query`](#composioactionsget_all_actions_based_on_query) * [`composio.analytics.get`](#composioanalyticsget) * [`composio.analytics.get_top_entities`](#composioanalyticsget_top_entities) * [`composio.apps.delete_open_api_spec_tool`](#composioappsdelete_open_api_spec_tool) * [`composio.apps.get_details`](#composioappsget_details) * [`composio.apps.get_open_api_spec_status`](#composioappsget_open_api_spec_status) * [`composio.apps.list`](#composioappslist) * [`composio.apps.list_open_api_specs`](#composioappslist_open_api_specs) * [`composio.apps.send_email_to_client`](#composioappssend_email_to_client) * [`composio.auth.identify_client_operation`](#composioauthidentify_client_operation) * [`composio.connections.delete`](#composioconnectionsdelete) * [`composio.connections.disable`](#composioconnectionsdisable) * [`composio.connections.enable`](#composioconnectionsenable) * [`composio.connections.get`](#composioconnectionsget) * [`composio.connections.get_info`](#composioconnectionsget_info) * [`composio.connections.initiate`](#composioconnectionsinitiate) * [`composio.connections.list`](#composioconnectionslist) * [`composio.event_logs.get_events`](#composioevent_logsget_events) * [`composio.event_logs.get_webhook`](#composioevent_logsget_webhook) * [`composio.event_logs.get_webhook_secret`](#composioevent_logsget_webhook_secret) * [`composio.event_logs.refresh_webhook_secret`](#composioevent_logsrefresh_webhook_secret) * [`composio.event_logs.update_webhook`](#composioevent_logsupdate_webhook) * [`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.logs.add_new_logs`](#composiologsadd_new_logs) * [`composio.logs.list`](#composiologslist) * [`composio.payment.create_checkout_session`](#composiopaymentcreate_checkout_session) * [`composio.payment.get_checkout_session_status`](#composiopaymentget_checkout_session_status) * [`composio.payment.get_invoice`](#composiopaymentget_invoice) * [`composio.payment.get_invoices`](#composiopaymentget_invoices) * [`composio.payment.handle_stripe_webhook`](#composiopaymenthandle_stripe_webhook) * [`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_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) ## Installation Add to Gemfile: ```ruby gem 'composio', '~> 0.1.8' ``` ## Getting Started ```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 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 ### `composio.api_keys.generate` Generate api key #### 🛠️ Usage ```ruby result = composio.api_keys.generate( name: "string_example", ) p result ``` #### ⚙️ Parameters ##### name: `String` The name of the API key to be generated #### 🔄 Return [APIKeyResDTO](./lib/composio/models/api_key_res_dto.rb) #### 🌐 Endpoint `/api/v1/api_keys` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.api_keys.list` List api keys #### 🛠️ Usage ```ruby result = composio.api_keys.list p result ``` #### 🔄 Return [APIKeyResDTO](./lib/composio/models/api_key_res_dto.rb) #### 🌐 Endpoint `/api/v1/api_keys` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.api_keys.remove` Delete api key #### 🛠️ Usage ```ruby result = composio.api_keys.remove( id: "'+j>6", ) p result ``` #### ⚙️ Parameters ##### id: `String` #### 🔄 Return [DeleteAPIKeyResponseDTO](./lib/composio/models/delete_api_key_response_dto.rb) #### 🌐 Endpoint `/api/v1/api_keys/{id}` `DELETE` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.actions.execute` Execute an action. Support both connected account and no auth auth. #### 🛠️ Usage ```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 ##### action_id: `String` ##### connectedAccountId: `String` ##### appName: `String` ##### entityId: `String` ##### endpoint: `String` ##### input: `Object` ##### text: `String` #### 🔄 Return [ActionExecutionResDto](./lib/composio/models/action_execution_res_dto.rb) #### 🌐 Endpoint `/api/v2/actions/{actionId}/execute` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.actions.execute_action_proxy` Execute an action with direct auth. #### 🛠️ Usage ```ruby result = composio.actions.execute_action_proxy( endpoint: "endpoint_example", connected_account_id: "connectedAccountId_example", ) p result ``` #### ⚙️ Parameters ##### endpoint: `String` ##### connected_account_id: `String` #### 🔄 Return [ActionExecutionResDto](./lib/composio/models/action_execution_res_dto.rb) #### 🌐 Endpoint `/api/v2/actions/proxy` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.actions.get_action_by_id` Get action details #### 🛠️ Usage ```ruby result = composio.actions.get_action_by_id( action_id: "'+j>6", ) p result ``` #### ⚙️ Parameters ##### action_id: `String` #### 🔄 Return [ActionDetails](./lib/composio/models/action_details.rb) #### 🌐 Endpoint `/api/v2/actions/{actionId}` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.actions.get_action_inputs` Get the inputs for an action with NLA #### 🛠️ Usage ```ruby result = composio.actions.get_action_inputs( text: "string_example", action_id: "'+j>6", ) p result ``` #### ⚙️ Parameters ##### text: `String` ##### action_id: `String` #### 🌐 Endpoint `/api/v2/actions/{actionId}/execute/get.inputs` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.actions.get_all_actions_based_on_query` Retrieve a list of all actions based on query parameters. #### 🛠️ Usage ```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 ##### app_names: `String` ##### use_case: `String` ##### show_enabled_only: `Boolean` ##### limit: `Float` ##### apps: `String` ##### actions: `String` ##### tags: `String` ##### usecase_limit: `Float` ##### filter_important_actions: `Boolean` ##### show_all: `Boolean` #### 🔄 Return [ActionsListResponseDTO](./lib/composio/models/actions_list_response_dto.rb) #### 🌐 Endpoint `/api/v2/actions/list/all` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.analytics.get` Get analytics #### 🛠️ Usage ```ruby result = composio.analytics.get( last_time_period: "DAY", ) p result ``` #### ⚙️ Parameters ##### last_time_period: `String` #### 🔄 Return [AnalyticsDataResDTO](./lib/composio/models/analytics_data_res_dto.rb) #### 🌐 Endpoint `/api/v1/analytics` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.analytics.get_top_entities` Get top entities #### 🛠️ Usage ```ruby result = composio.analytics.get_top_entities( query: "string_example", ) p result ``` #### ⚙️ Parameters ##### query: `String` #### 🔄 Return [TopEntitiesResDTO](./lib/composio/models/top_entities_res_dto.rb) #### 🌐 Endpoint `/api/v1/analytics/entities` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.apps.delete_open_api_spec_tool` Delete open api spec tool #### 🛠️ Usage ```ruby result = composio.apps.delete_open_api_spec_tool( id: "'+j>6", ) p result ``` #### ⚙️ Parameters ##### id: `String` #### 🌐 Endpoint `/api/v1/apps/openapi/spec/delete/{id}` `DELETE` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.apps.get_details` Get app details #### 🛠️ Usage ```ruby result = composio.apps.get_details( app_name: "'+j>6", ) p result ``` #### ⚙️ Parameters ##### app_name: `String` #### 🔄 Return [SingleAppInfoResDTO](./lib/composio/models/single_app_info_res_dto.rb) #### 🌐 Endpoint `/api/v1/apps/{appName}` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.apps.get_open_api_spec_status` Get open api spec status #### 🛠️ Usage ```ruby result = composio.apps.get_open_api_spec_status( id: "'+j>6", ) p result ``` #### ⚙️ Parameters ##### id: `String` #### 🌐 Endpoint `/api/v1/apps/openapi/spec/status/{id}` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.apps.list` Retrieve a list of all applications based on query parameters. #### 🛠️ Usage ```ruby result = composio.apps.list( category: "string_example", include_local: "string_example", ) p result ``` #### ⚙️ Parameters ##### category: `String` ##### include_local: `String` #### 🔄 Return [AppListResDTO](./lib/composio/models/app_list_res_dto.rb) #### 🌐 Endpoint `/api/v1/apps` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.apps.list_open_api_specs` Get opena api specs #### 🛠️ Usage ```ruby result = composio.apps.list_open_api_specs p result ``` #### 🔄 Return [AppListResDTO](./lib/composio/models/app_list_res_dto.rb) #### 🌐 Endpoint `/api/v1/apps/openapi/spec/list` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.apps.send_email_to_client` Send email to client #### 🛠️ Usage ```ruby result = composio.apps.send_email_to_client( admin_token: "string_example", body: None, ) p result ``` #### ⚙️ Parameters ##### admin_token: `String` #### 🌐 Endpoint `/api/v1/apps/openapi/send_email_to_client` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.auth.identify_client_operation` Identify client #### 🛠️ Usage ```ruby result = composio.auth.identify_client_operation( hash: "string_example", framework: "string_example", ) p result ``` #### ⚙️ Parameters ##### hash: `String` The hash of the client ##### framework: `String` The framework used by the client #### 🔄 Return [IdentifyClientResDTO](./lib/composio/models/identify_client_res_dto.rb) #### 🌐 Endpoint `/api/v1/client/auth/identify` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.connections.delete` Delete connection #### 🛠️ Usage ```ruby result = composio.connections.delete( connected_account_id: "'+j>6", ) p result ``` #### ⚙️ Parameters ##### connected_account_id: `String` #### 🔄 Return [DeleteRowAPIDTO](./lib/composio/models/delete_row_apidto.rb) #### 🌐 Endpoint `/api/v1/connectedAccounts/{connectedAccountId}` `DELETE` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.connections.disable` Disable connection #### 🛠️ Usage ```ruby result = composio.connections.disable( connected_account_id: "'+j>6", ) p result ``` #### ⚙️ Parameters ##### connected_account_id: `String` #### 🔄 Return [ToggleConnectedAccountResponseDTO](./lib/composio/models/toggle_connected_account_response_dto.rb) #### 🌐 Endpoint `/api/v1/connectedAccounts/{connectedAccountId}/disable` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.connections.enable` Enable connection #### 🛠️ Usage ```ruby result = composio.connections.enable( connected_account_id: "'+j>6", ) p result ``` #### ⚙️ Parameters ##### connected_account_id: `String` #### 🔄 Return [ToggleConnectedAccountResponseDTO](./lib/composio/models/toggle_connected_account_response_dto.rb) #### 🌐 Endpoint `/api/v1/connectedAccounts/{connectedAccountId}/enable` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.connections.get` Get connection #### 🛠️ Usage ```ruby result = composio.connections.get( connected_account_id: "'+j>6", ) p result ``` #### ⚙️ Parameters ##### connected_account_id: `String` #### 🔄 Return [ConnectedAccountResponseDTO](./lib/composio/models/connected_account_response_dto.rb) #### 🌐 Endpoint `/api/v1/connectedAccounts/{connectedAccountId}` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.connections.get_info` Get connection info #### 🛠️ Usage ```ruby result = composio.connections.get_info( connected_account_id: "'+j>6", ) p result ``` #### ⚙️ Parameters ##### connected_account_id: `String` #### 🔄 Return [GetConnectionInfoResponseDTO](./lib/composio/models/get_connection_info_response_dto.rb) #### 🌐 Endpoint `/api/v1/connectedAccounts/{connectedAccountId}/info` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.connections.initiate` Initiate connection #### 🛠️ Usage ```ruby result = composio.connections.initiate( integration_id: "a", data: "a", redirect_uri: "string_example", user_uuid: "string_example", ) p result ``` #### ⚙️ Parameters ##### integrationId: `String` ##### data: `String` ##### redirectUri: `String` ##### userUuid: `String` #### 🔄 Return [InitiateConnectionResponse](./lib/composio/models/initiate_connection_response.rb) #### 🌐 Endpoint `/api/v1/connectedAccounts` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.connections.list` Get connections #### 🛠️ Usage ```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 ##### page: `Float` ##### page_size: `Float` ##### app_names: `String` ##### integration_id: `String` ##### connection_id: `String` ##### user_uuid: `String` ##### show_active_only: `Boolean` ##### status: `String` ##### show_disabled: `Boolean` #### 🔄 Return [GetConnectionsResponseDto](./lib/composio/models/get_connections_response_dto.rb) #### 🌐 Endpoint `/api/v1/connectedAccounts` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.event_logs.get_events` Fetch events from database #### 🛠️ Usage ```ruby result = composio.event_logs.get_events( start_time: "0480-02-18T20:01:32F21798096225500850762068629339333975650685", end_time: "0480-02-18T20:01:32F21798096225500850762068629339333975650685", ) p result ``` #### ⚙️ Parameters ##### start_time: `String` ##### end_time: `String` #### 🌐 Endpoint `/api/v1/event_logs/get/events` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.event_logs.get_webhook` Get webhook #### 🛠️ Usage ```ruby result = composio.event_logs.get_webhook p result ``` #### 🌐 Endpoint `/api/v1/event_logs/get/webhook` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.event_logs.get_webhook_secret` Get webhook secret #### 🛠️ Usage ```ruby result = composio.event_logs.get_webhook_secret p result ``` #### 🌐 Endpoint `/api/v1/event_logs/webhook/secret/get` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.event_logs.refresh_webhook_secret` Refresh webhook #### 🛠️ Usage ```ruby result = composio.event_logs.refresh_webhook_secret p result ``` #### 🌐 Endpoint `/api/v1/event_logs/webhook/secret/refresh` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.event_logs.update_webhook` Update webhook #### 🛠️ Usage ```ruby result = composio.event_logs.update_webhook( event_webhook_url: "string_example", ) p result ``` #### ⚙️ Parameters ##### eventWebhookURL: `String` Event Webhook URL #### 🌐 Endpoint `/api/v1/event_logs/set/webhook` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.integrations.create_integration` Create connector #### 🛠️ Usage ```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 ##### name: `String` Name of the connector ##### appId: `String` Application ID ##### authScheme: `String` Authentication scheme ##### authConfig: [`AuthConfigDTO`](./lib/composio/models/auth_config_dto.rb) ##### useComposioAuth: [`CreateConnectorPayloadDTOUseComposioAuth`](./lib/composio/models/create_connector_payload_dto_use_composio_auth.rb) ##### forceNewIntegration: `Boolean` Flag to force new integration #### 🔄 Return [GetConnectorInfoResDTO](./lib/composio/models/get_connector_info_res_dto.rb) #### 🌐 Endpoint `/api/v1/integrations` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.integrations.delete_connector` Delete connector #### 🛠️ Usage ```ruby result = composio.integrations.delete_connector( integration_id: "'+j>6", ) p result ``` #### ⚙️ Parameters ##### integration_id: `String` #### 🔄 Return [DeleteRowAPIDTO](./lib/composio/models/delete_row_apidto.rb) #### 🌐 Endpoint `/api/v1/integrations/{integrationId}` `DELETE` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.integrations.get_connector_info` Get connector info #### 🛠️ Usage ```ruby result = composio.integrations.get_connector_info( integration_id: "'+j>6", ) p result ``` #### ⚙️ Parameters ##### integration_id: `String` #### 🔄 Return [GetConnectorInfoResDTO](./lib/composio/models/get_connector_info_res_dto.rb) #### 🌐 Endpoint `/api/v1/integrations/{integrationId}` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.integrations.list_global_connectors` List all connectors #### 🛠️ Usage ```ruby result = composio.integrations.list_global_connectors p result ``` #### 🔄 Return [GetConnectorListResDTO](./lib/composio/models/get_connector_list_res_dto.rb) #### 🌐 Endpoint `/api/v1/integrations` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.integrations.update_integration` Modify connector #### 🛠️ Usage ```ruby result = composio.integrations.update_integration( integration_id: "'+j>6", auth_config: {}, enabled: true, ) p result ``` #### ⚙️ Parameters ##### integration_id: `String` ##### authConfig: `Object` Authentication configuration for the connector ##### enabled: `Boolean` Flag to indicate if the connector is enabled #### 🔄 Return [PatchConnectorResDTO](./lib/composio/models/patch_connector_res_dto.rb) #### 🌐 Endpoint `/api/v1/integrations/{integrationId}` `PATCH` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.logs.add_new_logs` Add new logs #### 🛠️ Usage ```ruby result = composio.logs.add_new_logs( provider_name: "string_example", action_name: "string_example", request: {}, response: {}, is_error: true, connection_id: "string_example", entity_id: "string_example", ) p result ``` #### ⚙️ Parameters ##### providerName: `String` Provider name of the log ##### actionName: `String` Action name of the log ##### request: `Object` ##### response: `Object` ##### isError: `Boolean` ##### connectionId: `String` Connection ID of the log ##### entityId: `String` Entity ID of the log #### 🔄 Return [IngestDataResponseDTO](./lib/composio/models/ingest_data_response_dto.rb) #### 🌐 Endpoint `/api/v1/logs` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.logs.list` List logs #### 🛠️ Usage ```ruby result = composio.logs.list( type: "error", time: "5m", status: "all", search: "string_example", integration_id: "string_example", entity_id: "string_example", limit: 10, cursor: "string_example", logs_type: "string_example", ) p result ``` #### ⚙️ Parameters ##### type: `String` ##### time: `String` ##### status: `String` ##### search: `String` ##### integration_id: `String` ##### entity_id: `String` ##### limit: `Float` ##### cursor: `String` ##### logs_type: `String` #### 🔄 Return [LogsResDTO](./lib/composio/models/logs_res_dto.rb) #### 🌐 Endpoint `/api/v1/logs` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.payment.create_checkout_session` Create checkout session #### 🛠️ Usage ```ruby result = composio.payment.create_checkout_session( plan: "HOBBY", ) p result ``` #### ⚙️ Parameters ##### plan: [`Plan`](./lib/composio/models/plan.rb) #### 🌐 Endpoint `/api/v1/payment/create-checkout-session` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.payment.get_checkout_session_status` Get checkout session status #### 🛠️ Usage ```ruby result = composio.payment.get_checkout_session_status( session_id: "'+j>6", ) p result ``` #### ⚙️ Parameters ##### session_id: `String` #### 🌐 Endpoint `/api/v1/payment/checkout-session/{sessionId}/status` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.payment.get_invoice` Get invoice #### 🛠️ Usage ```ruby result = composio.payment.get_invoice( invoice_id: "'+j>6", ) p result ``` #### ⚙️ Parameters ##### invoice_id: `String` #### 🌐 Endpoint `/api/v1/payment/invoices/{invoiceId}` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.payment.get_invoices` Get invoices #### 🛠️ Usage ```ruby result = composio.payment.get_invoices p result ``` #### 🌐 Endpoint `/api/v1/payment/invoices` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.payment.handle_stripe_webhook` Handle stripe webhook #### 🛠️ Usage ```ruby result = composio.payment.handle_stripe_webhook( body: None, ) p result ``` #### 🌐 Endpoint `/api/v1/payment/webhook` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.delete_trigger_instance` Deletes a specified trigger instance. #### 🛠️ Usage ```ruby result = composio.triggers.delete_trigger_instance( trigger_instance_id: "'+j>6", ) p result ``` #### ⚙️ Parameters ##### trigger_instance_id: `String` #### 🔄 Return [DeleteRowAPIDTO](./lib/composio/models/delete_row_apidto.rb) #### 🌐 Endpoint `/api/v1/triggers/instance/{triggerInstanceId}` `DELETE` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.disable_trigger_instance` Disables a specified trigger instance. #### 🛠️ Usage ```ruby result = composio.triggers.disable_trigger_instance( trigger_instance_id: "'+j>6", ) p result ``` #### ⚙️ Parameters ##### trigger_instance_id: `String` #### 🔄 Return [TriggerResponseDTO](./lib/composio/models/trigger_response_dto.rb) #### 🌐 Endpoint `/api/v1/triggers/disable/{triggerInstanceId}` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.enable` Enables a trigger for a connected account and specific trigger name. #### 🛠️ Usage ```ruby result = composio.triggers.enable( trigger_config: {}, connected_account_id: "'+j>6", trigger_name: "'+j>6", verify_host: "string_example", ) p result ``` #### ⚙️ Parameters ##### triggerConfig: `Object` The trigger configuration ##### connected_account_id: `String` ##### trigger_name: `String` ##### verifyHost: `String` The verify host #### 🔄 Return [TriggerResponseDTO](./lib/composio/models/trigger_response_dto.rb) #### 🌐 Endpoint `/api/v1/triggers/enable/{connectedAccountId}/{triggerName}` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.get_active_triggers` Lists active triggers based on query parameters. #### 🛠️ Usage ```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 ##### connected_account_ids: `String` ##### integration_ids: `String` ##### trigger_ids: `String` ##### trigger_names: `String` ##### page: `Float` ##### limit: `Float` ##### show_disabled: `Boolean` #### 🔄 Return [ActiveTriggersResDTO](./lib/composio/models/active_triggers_res_dto.rb) #### 🌐 Endpoint `/api/v1/triggers/active_triggers` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.get_callback_url` Retrieves the universal callback URL set for the client. #### 🛠️ Usage ```ruby result = composio.triggers.get_callback_url p result ``` #### 🔄 Return [WebhookURLResponseDTO](./lib/composio/models/webhook_url_response_dto.rb) #### 🌐 Endpoint `/api/v1/triggers/callback_url` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.get_logs_based_on_connection_and_integration_details` Fetches logs based on connection and integration details. #### 🛠️ Usage ```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 ##### connection_id: `String` ##### integration_id: `String` ##### page: `Float` ##### limit: `Float` #### 🔄 Return [TriggerLogsResDTO](./lib/composio/models/trigger_logs_res_dto.rb) #### 🌐 Endpoint `/api/v1/triggers/logs` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.get_trigger_info` Get Trigger Info #### 🛠️ Usage ```ruby result = composio.triggers.get_trigger_info( trigger_name: "'+j>6", ) p result ``` #### ⚙️ Parameters ##### trigger_name: `String` #### 🔄 Return [SingleTriggerResDTO](./lib/composio/models/single_trigger_res_dto.rb) #### 🌐 Endpoint `/api/v2/triggers/{triggerName}` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.list` List triggers #### 🛠️ Usage ```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 ##### app_names: `String` ##### connected_account_ids: `String` ##### trigger_ids: `String` ##### show_enabled_only: `Boolean` #### 🔄 Return [TriggerResDTO](./lib/composio/models/trigger_res_dto.rb) #### 🌐 Endpoint `/api/v1/triggers` `GET` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.set_callback_url` Sets a universal callback URL for the client. #### 🛠️ Usage ```ruby result = composio.triggers.set_callback_url( callback_url: "string_example", ) p result ``` #### ⚙️ Parameters ##### callbackURL: `String` The callback URL #### 🔄 Return [TriggerResponseDTO](./lib/composio/models/trigger_response_dto.rb) #### 🌐 Endpoint `/api/v1/triggers/set_callback_url` `POST` [🔙 **Back to Table of Contents**](#table-of-contents) --- ### `composio.triggers.switch_instance_status` Switches the status of a trigger instance. #### 🛠️ Usage ```ruby result = composio.triggers.switch_instance_status( enabled: true, trigger_id: "'+j>6", ) p result ``` #### ⚙️ Parameters ##### enabled: `Boolean` The new enabled status of the trigger ##### trigger_id: `String` #### 🔄 Return [TriggerResponseDTO](./lib/composio/models/trigger_response_dto.rb) #### 🌐 Endpoint `/api/v1/triggers/instance/{triggerId}/status` `PATCH` [🔙 **Back to Table of Contents**](#table-of-contents) --- ## Author This TypeScript package is automatically generated by [Konfig](https://konfigthis.com)