Module: Composio

Defined in:
lib/composio/version.rb,
lib/composio.rb,
lib/composio/api_error.rb,
lib/composio/api_client.rb,
lib/composio/api/cli_api.rb,
lib/composio/models/data.rb,
lib/composio/models/meta.rb,
lib/composio/models/plan.rb,
lib/composio/models/role.rb,
lib/composio/models/time.rb,
lib/composio/models/type.rb,
lib/composio/api/apps_api.rb,
lib/composio/api/auth_api.rb,
lib/composio/api/logs_api.rb,
lib/composio/models/state.rb,
lib/composio/api/admin_api.rb,
lib/composio/configuration.rb,
lib/composio/models/method.rb,
lib/composio/models/status.rb,
lib/composio/api/actions_api.rb,
lib/composio/api/payment_api.rb,
lib/composio/models/meta_app.rb,
lib/composio/models/model_in.rb,
lib/composio/api/api_keys_api.rb,
lib/composio/api/triggers_api.rb,
lib/composio/models/page_info.rb,
lib/composio/models/parameter.rb,
lib/composio/api/analytics_api.rb,
lib/composio/api_client_custom.rb,
lib/composio/models/client_dto.rb,
lib/composio/api/event_logs_api.rb,
lib/composio/api/connections_api.rb,
lib/composio/models/get_logs_dto.rb,
lib/composio/models/logs_res_dto.rb,
lib/composio/api/integrations_api.rb,
lib/composio/models/app_query_dto.rb,
lib/composio/models/cli_query_dto.rb,
lib/composio/models/page_info_dto.rb,
lib/composio/models/action_details.rb,
lib/composio/models/logout_res_dto.rb,
lib/composio/models/member_res_dto.rb,
lib/composio/models/trigger_config.rb,
lib/composio/models/action_log_data.rb,
lib/composio/models/action_metadata.rb,
lib/composio/models/additional_info.rb,
lib/composio/models/api_key_res_dto.rb,
lib/composio/models/auth_config_dto.rb,
lib/composio/models/custom_auth_dto.rb,
lib/composio/models/fetch_query_dto.rb,
lib/composio/models/ingest_data_dto.rb,
lib/composio/models/trigger_res_dto.rb,
lib/composio/models/webhook_req_dto.rb,
lib/composio/models/app_list_res_dto.rb,
lib/composio/models/last_time_period.rb,
lib/composio/models/metadata_req_dto.rb,
lib/composio/models/redirect_uri_dto.rb,
lib/composio/models/session_info_dto.rb,
lib/composio/models/trigger_log_data.rb,
lib/composio/models/trigger_metadata.rb,
lib/composio/models/action_by_app_dto.rb,
lib/composio/models/actions_query_dto.rb,
lib/composio/models/add_tools_req_dto.rb,
lib/composio/models/connection_params.rb,
lib/composio/models/delete_row_apidto.rb,
lib/composio/models/get_logs_dto_type.rb,
lib/composio/models/sdk_error_res_dto.rb,
lib/composio/models/app_name_count_dto.rb,
lib/composio/models/get_logs_query_dto.rb,
lib/composio/models/magic_link_req_dto.rb,
lib/composio/models/magic_link_res_dto.rb,
lib/composio/models/metadata_query_dto.rb,
lib/composio/models/user_git_user_info.rb,
lib/composio/models/client_info_res_dto.rb,
lib/composio/models/get_logs_dto_status.rb,
lib/composio/models/member_info_res_dto.rb,
lib/composio/models/member_res_dto_role.rb,
lib/composio/models/time_period_req_dto.rb,
lib/composio/models/action_analytics_dto.rb,
lib/composio/models/action_by_status_dto.rb,
lib/composio/models/action_metadata_type.rb,
lib/composio/models/add_repo_url_req_dto.rb,
lib/composio/models/add_repo_url_res_dto.rb,
lib/composio/models/delete_tools_req_dto.rb,
lib/composio/models/delete_tools_res_dto.rb,
lib/composio/models/entity_query_req_dto.rb,
lib/composio/models/top_entities_res_dto.rb,
lib/composio/models/track_client_req_dto.rb,
lib/composio/models/track_client_res_dto.rb,
lib/composio/models/trigger_log_item_dto.rb,
lib/composio/models/trigger_logs_res_dto.rb,
lib/composio/models/trigger_metadata_dto.rb,
lib/composio/models/trigger_response_dto.rb,
lib/composio/models/actions_controller_v1.rb,
lib/composio/models/add_tools_request_dto.rb,
lib/composio/models/app_info_response_dto.rb,
lib/composio/models/client_dto_created_at.rb,
lib/composio/models/client_dto_updated_at.rb,
lib/composio/models/invite_member_req_dto.rb,
lib/composio/models/tools_execute_req_dto.rb,
lib/composio/models/trigger_metadata_type.rb,
lib/composio/models/update_member_req_dto.rb,
lib/composio/models/action_details_minimal.rb,
lib/composio/models/analytics_data_req_dto.rb,
lib/composio/models/analytics_data_res_dto.rb,
lib/composio/models/delete_api_key_req_dto.rb,
lib/composio/models/direct_execute_req_dto.rb,
lib/composio/models/execute_action_res_dto.rb,
lib/composio/models/get_connections_result.rb,
lib/composio/models/get_trigger_params_dto.rb,
lib/composio/models/single_trigger_res_dto.rb,
lib/composio/models/t_connection_count_dto.rb,
lib/composio/models/webhook_secret_res_dto.rb,
lib/composio/models/active_trigger_instance.rb,
lib/composio/models/active_triggers_res_dto.rb,
lib/composio/models/connector_list_item_dto.rb,
lib/composio/models/enable_trigger_body_dto.rb,
lib/composio/models/get_cli_session_res_dto.rb,
lib/composio/models/handle_trigger_body_dto.rb,
lib/composio/models/identify_client_req_dto.rb,
lib/composio/models/identify_client_res_dto.rb,
lib/composio/models/list_triggers_query_dto.rb,
lib/composio/models/patch_connector_req_dto.rb,
lib/composio/models/patch_connector_res_dto.rb,
lib/composio/models/proxy_execution_req_dto.rb,
lib/composio/models/single_app_info_res_dto.rb,
lib/composio/models/verify_cli_code_res_dto.rb,
lib/composio/models/action_execution_req_dto.rb,
lib/composio/models/action_execution_res_dto.rb,
lib/composio/models/connection_with_app_data.rb,
lib/composio/models/generate_api_key_req_dto.rb,
lib/composio/models/get_trigger_response_dto.rb,
lib/composio/models/ingest_data_response_dto.rb,
lib/composio/models/webhook_url_response_dto.rb,
lib/composio/models/actions_list_response_dto.rb,
lib/composio/models/analytics_entity_data_dto.rb,
lib/composio/models/connection_params_headers.rb,
lib/composio/models/enable_trigger_params_dto.rb,
lib/composio/models/expected_input_fields_dto.rb,
lib/composio/models/get_connections_query_dto.rb,
lib/composio/models/handle_trigger_params_dto.rb,
lib/composio/models/set_callback_url_body_dto.rb,
lib/composio/models/verify_magic_link_req_dto.rb,
lib/composio/models/verify_magic_link_res_dto.rb,
lib/composio/models/get_connector_info_res_dto.rb,
lib/composio/models/get_connector_list_res_dto.rb,
lib/composio/models/o_auth2_callback_query_dto.rb,
lib/composio/models/open_api_spec_list_res_dto.rb,
lib/composio/models/update_member_req_dto_role.rb,
lib/composio/models/verify_magic_link_data_dto.rb,
lib/composio/models/delete_api_key_response_dto.rb,
lib/composio/models/trigger_instance_params_dto.rb,
lib/composio/models/create_connector_payload_dto.rb,
lib/composio/models/generate_cli_session_req_dto.rb,
lib/composio/models/generate_cli_session_res_dto.rb,
lib/composio/models/get_connections_response_dto.rb,
lib/composio/models/initiate_connection_response.rb,
lib/composio/models/integrations_with_counts_dto.rb,
lib/composio/models/action_get_nla_inputs_req_dto.rb,
lib/composio/models/client_dto_last_subscribed_at.rb,
lib/composio/models/connection_params_for_account.rb,
lib/composio/models/get_active_triggers_query_dto.rb,
lib/composio/models/connected_account_response_dto.rb,
lib/composio/models/member_info_res_dto_created_at.rb,
lib/composio/models/switch_trigger_status_body_dto.rb,
lib/composio/models/action_proxy_request_config_dto.rb,
lib/composio/models/action_proxy_request_method_dto.rb,
lib/composio/models/client_unique_user_id_count_dto.rb,
lib/composio/models/create_checkout_session_req_dto.rb,
lib/composio/models/initiate_connection_payload_dto.rb,
lib/composio/models/triggers_enabled_toggle_req_dto.rb,
lib/composio/models/triggers_enabled_toggle_res_dto.rb,
lib/composio/models/get_connection_info_response_dto.rb,
lib/composio/models/switch_trigger_status_params_dto.rb,
lib/composio/models/trigger_toggle_info_response_dto.rb,
lib/composio/models/actions_minimal_list_response_dto.rb,
lib/composio/models/toggle_trigger_state_response_dto.rb,
lib/composio/models/connector_list_item_dto_created_at.rb,
lib/composio/models/connector_list_item_dto_updated_at.rb,
lib/composio/models/update_connection_labels_payload_dto.rb,
lib/composio/models/toggle_connected_account_response_dto.rb,
lib/composio/models/create_connector_payload_dto_use_composio_auth.rb

Overview

#Composio OpenAPI

#Composio SDK: Equip your agent with high-quality tools and build your real-world usecase

The version of the OpenAPI document: 1.0.0

Defined Under Namespace

Modules: ActionMetadataType, ClientDTOCreatedAt, ClientDTOLastSubscribedAt, ClientDTOUpdatedAt, ConnectorListItemDTOCreatedAt, ConnectorListItemDTOUpdatedAt, MemberInfoResDTOCreatedAt, TriggerMetadataType Classes: APIKeyResDTO, APIKeysApi, APIResponse, ActionAnalyticsDTO, ActionByAppDTO, ActionByStatusDTO, ActionDetails, ActionDetailsMinimal, ActionExecutionReqDTO, ActionExecutionResDto, ActionGetNLAInputsReqDTO, ActionLogData, ActionMetadata, ActionProxyRequestConfigDTO, ActionProxyRequestMethodDTO, ActionsApi, ActionsControllerV1, ActionsListResponseDTO, ActionsMinimalListResponseDTO, ActionsQueryDTO, ActiveTriggerInstance, ActiveTriggersResDTO, AddRepoURLReqDTO, AddRepoURLResDTO, AddToolsReqDTO, AddToolsRequestDTO, AdditionalInfo, AdminApi, AnalyticsApi, AnalyticsDataReqDTO, AnalyticsDataResDTO, AnalyticsEntityDataDTO, ApiClient, ApiClientCustom, ApiError, AppInfoResponseDto, AppListResDTO, AppNameCountDTO, AppQueryDTO, AppsApi, AuthApi, AuthConfigDTO, CLIApi, CLIQueryDTO, Client, ClientDTO, ClientInfoResDTO, ClientUniqueUserIdCountDTO, Configuration, ConnectedAccountResponseDTO, ConnectionParams, ConnectionParamsForAccount, ConnectionParamsHeaders, ConnectionWithAppData, ConnectionsApi, ConnectorListItemDTO, CreateCheckoutSessionReqDto, CreateConnectorPayloadDTO, CreateConnectorPayloadDTOUseComposioAuth, CustomAuthDTO, Data, DeleteAPIKeyReqDTO, DeleteAPIKeyResponseDTO, DeleteRowAPIDTO, DeleteToolsReqDTO, DeleteToolsResDTO, DirectExecuteReqDto, EnableTriggerBodyDTO, EnableTriggerParamsDTO, EntityQueryReqDTO, EventLogsApi, ExecuteActionResDTO, ExpectedInputFieldsDTO, FetchQueryDTO, GenerateAPIKeyReqDTO, GenerateCLISessionReqDTO, GenerateCLISessionResDTO, GetActiveTriggersQueryDTO, GetCLISessionResDTO, GetConnectionInfoResponseDTO, GetConnectionsQueryDto, GetConnectionsResponseDto, GetConnectionsResult, GetConnectorInfoResDTO, GetConnectorListResDTO, GetLogsDTO, GetLogsDtoStatus, GetLogsDtoType, GetLogsQueryDTO, GetTriggerParamsDTO, GetTriggerResponseDTO, HandleTriggerBodyDTO, HandleTriggerParamsDTO, IdentifyClientReqDTO, IdentifyClientResDTO, IngestDataDTO, IngestDataResponseDTO, InitiateConnectionPayloadDto, InitiateConnectionResponse, IntegrationsApi, IntegrationsWithCountsDTO, InviteMemberReqDTO, LastTimePeriod, ListTriggersQueryDTO, LogoutResDTO, LogsApi, LogsResDTO, MagicLinkReqDTO, MagicLinkResDTO, MemberInfoResDTO, MemberResDTO, MemberResDtoRole, Meta, MetaApp, MetadataQueryDTO, MetadataReqDTO, Method, ModelIn, OAuth2CallbackQueryDto, OpenAPISpecListResDTO, PageInfo, PageInfoDTO, Parameter, PatchConnectorReqDTO, PatchConnectorResDTO, PaymentApi, Plan, ProxyExecutionReqDTO, RedirectUriDTO, Role, SDKErrorResDTO, SessionInfoDTO, SetCallbackUrlBodyDTO, SingleAppInfoResDTO, SingleTriggerResDTO, State, Status, SwitchTriggerStatusBodyDTO, SwitchTriggerStatusParamsDTO, TConnectionCountDTO, Time, TimePeriodReqDTO, ToggleConnectedAccountResponseDTO, ToggleTriggerStateResponseDTO, ToolsExecuteReqDto, TopEntitiesResDTO, TrackClientReqDTO, TrackClientResDTO, TriggerConfig, TriggerInstanceParamsDTO, TriggerLogData, TriggerLogItemDTO, TriggerLogsResDTO, TriggerMetadata, TriggerMetadataDTO, TriggerResDTO, TriggerResponseDTO, TriggerToggleInfoResponseDTO, TriggersApi, TriggersEnabledToggleReqDTO, TriggersEnabledToggleResDTO, Type, UpdateConnectionLabelsPayloadDto, UpdateMemberReqDTO, UpdateMemberReqDtoRole, UserGitUserInfo, VerifyCLICodeResDTO, VerifyMagicLinkDataDTO, VerifyMagicLinkReqDTO, VerifyMagicLinkResDTO, WebhookReqDTO, WebhookSecretResDTO, WebhookURLResponseDTO

Constant Summary collapse

SENTINEL = 
Object.new
VERSION = 
'0.1.19'
CLI =

top-level client access to avoid having the user to insantiate their own API instances

CLIApi::new
Apps =

top-level client access to avoid having the user to insantiate their own API instances

AppsApi::new
Auth =

top-level client access to avoid having the user to insantiate their own API instances

AuthApi::new
Logs =

top-level client access to avoid having the user to insantiate their own API instances

LogsApi::new
Admin =

top-level client access to avoid having the user to insantiate their own API instances

AdminApi::new
Actions =

top-level client access to avoid having the user to insantiate their own API instances

ActionsApi::new
Payment =

top-level client access to avoid having the user to insantiate their own API instances

PaymentApi::new
APIKeys =

top-level client access to avoid having the user to insantiate their own API instances

APIKeysApi::new
Triggers =

top-level client access to avoid having the user to insantiate their own API instances

TriggersApi::new
Analytics =

top-level client access to avoid having the user to insantiate their own API instances

AnalyticsApi::new
EventLogs =

top-level client access to avoid having the user to insantiate their own API instances

EventLogsApi::new
Connections =

top-level client access to avoid having the user to insantiate their own API instances

ConnectionsApi::new
Integrations =

top-level client access to avoid having the user to insantiate their own API instances

IntegrationsApi::new

Class Method Summary collapse

Class Method Details

.api_key ⇒ Object

api key from OpenAPI spec



212
213
214
 
# File 'lib/composio.rb', line 212

def api_key
  @config.api_key
end

.api_key=(value) ⇒ Object 



216
217
218
 
# File 'lib/composio.rb', line 216

def api_key=(value)
  @config.api_key = value
end

.configure ⇒ Object

Customize default settings for the SDK using block.

Composio.configure do |config|
  config.host = "http://example.com"
end

If no block given, return the default Configuration object.



225
226
227
228
229
230
231
 
# File 'lib/composio.rb', line 225

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end

.host ⇒ Object 



204
205
206
 
# File 'lib/composio.rb', line 204

def host
  @config.host
end

.host=(value) ⇒ Object 



208
209
210
 
# File 'lib/composio.rb', line 208

def host=(value)
  @config.host = value
end