lib/composio/api/integrations_api.rb in composio-0.1.10 vs lib/composio/api/integrations_api.rb in composio-0.1.11
- old
+ new
@@ -16,19 +16,21 @@
@api_client = api_client
end
# Create connector
#
+ # Create a new connector
+ #
# @param name [String] Name of the connector
- # @param app_id [String] Application ID
# @param auth_scheme [String] Authentication scheme
+ # @param app_id [String] Application ID
# @param auth_config [AuthConfigDTO]
# @param use_composio_auth [CreateConnectorPayloadDTOUseComposioAuth]
# @param force_new_integration [Boolean] Flag to force new integration
# @param body [CreateConnectorPayloadDTO]
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
- def create_integration(name:, app_id:, auth_scheme: SENTINEL, auth_config: SENTINEL, use_composio_auth: SENTINEL, force_new_integration: SENTINEL, extra: {})
+ def create_integration(name:, auth_scheme:, app_id:, auth_config: SENTINEL, use_composio_auth: SENTINEL, force_new_integration: SENTINEL, extra: {})
_body = {}
_body[:name] = name if name != SENTINEL
_body[:authScheme] = auth_scheme if auth_scheme != SENTINEL
_body[:authConfig] = auth_config if auth_config != SENTINEL
_body[:useComposioAuth] = use_composio_auth if use_composio_auth != SENTINEL
@@ -39,19 +41,21 @@
api_response.data
end
# Create connector
#
+ # Create a new connector
+ #
# @param name [String] Name of the connector
- # @param app_id [String] Application ID
# @param auth_scheme [String] Authentication scheme
+ # @param app_id [String] Application ID
# @param auth_config [AuthConfigDTO]
# @param use_composio_auth [CreateConnectorPayloadDTOUseComposioAuth]
# @param force_new_integration [Boolean] Flag to force new integration
# @param body [CreateConnectorPayloadDTO]
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
- def create_integration_with_http_info(name:, app_id:, auth_scheme: SENTINEL, auth_config: SENTINEL, use_composio_auth: SENTINEL, force_new_integration: SENTINEL, extra: {})
+ def create_integration_with_http_info(name:, auth_scheme:, app_id:, auth_config: SENTINEL, use_composio_auth: SENTINEL, force_new_integration: SENTINEL, extra: {})
_body = {}
_body[:name] = name if name != SENTINEL
_body[:authScheme] = auth_scheme if auth_scheme != SENTINEL
_body[:authConfig] = auth_config if auth_config != SENTINEL
_body[:useComposioAuth] = use_composio_auth if use_composio_auth != SENTINEL
@@ -60,19 +64,21 @@
extra[:create_connector_payload_dto] = _body if !_body.empty?
create_integration_with_http_info_impl(extra)
end
# Create connector
+ # Create a new connector
# @param [Hash] opts the optional parameters
# @option opts [CreateConnectorPayloadDTO] :create_connector_payload_dto CreateConnectorPayloadDTO
# @return [GetConnectorInfoResDTO]
private def create_integration_impl(opts = {})
data, _status_code, _headers = create_integration_with_http_info(opts)
data
end
# Create connector
+ # Create a new connector
# @param [Hash] opts the optional parameters
# @option opts [CreateConnectorPayloadDTO] :create_connector_payload_dto CreateConnectorPayloadDTO
# @return [APIResponse] data is GetConnectorInfoResDTO, status code, headers and response
private def create_integration_with_http_info_impl(opts = {})
if @api_client.config.debugging
@@ -124,35 +130,41 @@
end
# Delete connector
#
+ # Delete a connector
+ #
# @param integration_id [String]
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
def delete_connector(integration_id:, extra: {})
api_response = delete_connector_with_http_info_impl(integration_id, extra)
api_response.data
end
# Delete connector
#
+ # Delete a connector
+ #
# @param integration_id [String]
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
def delete_connector_with_http_info(integration_id:, extra: {})
delete_connector_with_http_info_impl(integration_id, extra)
end
# Delete connector
+ # Delete a connector
# @param integration_id [String]
# @param [Hash] opts the optional parameters
# @return [DeleteRowAPIDTO]
private def delete_connector_impl(integration_id, opts = {})
data, _status_code, _headers = delete_connector_with_http_info(integration_id, opts)
data
end
# Delete connector
+ # Delete a connector
# @param integration_id [String]
# @param [Hash] opts the optional parameters
# @return [APIResponse] data is DeleteRowAPIDTO, status code, headers and response
private def delete_connector_with_http_info_impl(integration_id, opts = {})
if @api_client.config.debugging
@@ -208,35 +220,41 @@
end
# Get connector info
#
+ # Get connector info
+ #
# @param integration_id [String]
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
def get_connector_info(integration_id:, extra: {})
api_response = get_connector_info_with_http_info_impl(integration_id, extra)
api_response.data
end
# Get connector info
#
+ # Get connector info
+ #
# @param integration_id [String]
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
def get_connector_info_with_http_info(integration_id:, extra: {})
get_connector_info_with_http_info_impl(integration_id, extra)
end
# Get connector info
+ # Get connector info
# @param integration_id [String]
# @param [Hash] opts the optional parameters
# @return [GetConnectorInfoResDTO]
private def get_connector_info_impl(integration_id, opts = {})
data, _status_code, _headers = get_connector_info_with_http_info(integration_id, opts)
data
end
# Get connector info
+ # Get connector info
# @param integration_id [String]
# @param [Hash] opts the optional parameters
# @return [APIResponse] data is GetConnectorInfoResDTO, status code, headers and response
private def get_connector_info_with_http_info_impl(integration_id, opts = {})
if @api_client.config.debugging
@@ -292,32 +310,38 @@
end
# List all connectors
#
+ # List all connectors
+ #
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
def list_global_connectors(extra: {})
api_response = list_global_connectors_with_http_info_impl(extra)
api_response.data
end
# List all connectors
#
+ # List all connectors
+ #
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
def list_global_connectors_with_http_info(extra: {})
list_global_connectors_with_http_info_impl(extra)
end
# List all connectors
+ # List all connectors
# @param [Hash] opts the optional parameters
# @return [GetConnectorListResDTO]
private def list_global_connectors_impl(opts = {})
data, _status_code, _headers = list_global_connectors_with_http_info(opts)
data
end
# List all connectors
+ # List all connectors
# @param [Hash] opts the optional parameters
# @return [APIResponse] data is GetConnectorListResDTO, status code, headers and response
private def list_global_connectors_with_http_info_impl(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: IntegrationsApi.list_global_connectors ...'
@@ -363,10 +387,12 @@
end
# Modify connector
#
+ # Modify a connector
+ #
# @param integration_id [String]
# @param auth_config [Object] Authentication configuration for the connector
# @param enabled [Boolean] Flag to indicate if the connector is enabled
# @param body [PatchConnectorReqDTO]
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -379,10 +405,12 @@
api_response.data
end
# Modify connector
#
+ # Modify a connector
+ #
# @param integration_id [String]
# @param auth_config [Object] Authentication configuration for the connector
# @param enabled [Boolean] Flag to indicate if the connector is enabled
# @param body [PatchConnectorReqDTO]
# @param [Hash] extra additional parameters to pass along through :header_params, :query_params, or parameter name
@@ -393,19 +421,21 @@
extra[:patch_connector_req_dto] = _body if !_body.empty?
update_integration_with_http_info_impl(integration_id, extra)
end
# Modify connector
+ # Modify a connector
# @param integration_id [String]
# @param [Hash] opts the optional parameters
# @option opts [PatchConnectorReqDTO] :patch_connector_req_dto PatchConnectorReqDTO
# @return [PatchConnectorResDTO]
private def update_integration_impl(integration_id, opts = {})
data, _status_code, _headers = update_integration_with_http_info(integration_id, opts)
data
end
# Modify connector
+ # Modify a connector
# @param integration_id [String]
# @param [Hash] opts the optional parameters
# @option opts [PatchConnectorReqDTO] :patch_connector_req_dto PatchConnectorReqDTO
# @return [APIResponse] data is PatchConnectorResDTO, status code, headers and response
private def update_integration_with_http_info_impl(integration_id, opts = {})