Class: Composio::TriggersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/composio/api/triggers_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TriggersApi

Returns a new instance of TriggersApi.



15
16
17
 
# File 'lib/composio/api/triggers_api.rb', line 15

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



13
14
15
 
# File 'lib/composio/api/triggers_api.rb', line 13

def api_client
  @api_client
end

Instance Method Details

#delete_trigger_instance(trigger_instance_id:, extra: {}) ⇒ Object

Delete trigger

Deletes a specified trigger instance.

Parameters:

  • trigger_instance_id (String)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



25
26
27
28
 
# File 'lib/composio/api/triggers_api.rb', line 25

def delete_trigger_instance(trigger_instance_id:, extra: {})
  api_response = delete_trigger_instance_with_http_info_impl(trigger_instance_id, extra)
  api_response.data
end

#delete_trigger_instance_with_http_info(trigger_instance_id:, extra: {}) ⇒ Object

Delete trigger

Deletes a specified trigger instance.

Parameters:

  • trigger_instance_id (String)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



36
37
38
 
# File 'lib/composio/api/triggers_api.rb', line 36

def delete_trigger_instance_with_http_info(trigger_instance_id:, extra: {})
  delete_trigger_instance_with_http_info_impl(trigger_instance_id, extra)
end

#disable_trigger_instance(trigger_instance_id:, extra: {}) ⇒ Object

Disable trigger

Disables a specified trigger instance.

Parameters:

  • trigger_instance_id (String)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



115
116
117
118
 
# File 'lib/composio/api/triggers_api.rb', line 115

def disable_trigger_instance(trigger_instance_id:, extra: {})
  api_response = disable_trigger_instance_with_http_info_impl(trigger_instance_id, extra)
  api_response.data
end

#disable_trigger_instance_with_http_info(trigger_instance_id:, extra: {}) ⇒ Object

Disable trigger

Disables a specified trigger instance.

Parameters:

  • trigger_instance_id (String)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



126
127
128
 
# File 'lib/composio/api/triggers_api.rb', line 126

def disable_trigger_instance_with_http_info(trigger_instance_id:, extra: {})
  disable_trigger_instance_with_http_info_impl(trigger_instance_id, extra)
end

#enable(trigger_config:, connected_account_id:, trigger_name:, verify_host: SENTINEL, extra: {}) ⇒ Object

Enable trigger

Enables a trigger for a connected account and specific trigger name.

Parameters:

  • trigger_config (Object) —

    The trigger configuration

  • connected_account_id (String)
  • trigger_name (String)
  • verify_host (String) (defaults to: SENTINEL) —

    The verify host

  • body (EnableTriggerBodyDTO)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



209
210
211
212
213
214
215
216
 
# File 'lib/composio/api/triggers_api.rb', line 209

def enable(trigger_config:, connected_account_id:, trigger_name:, verify_host: SENTINEL, extra: {})
  _body = {}
  _body[:triggerConfig] = trigger_config if trigger_config != SENTINEL
  _body[:verifyHost] = verify_host if verify_host != SENTINEL
  extra[:enable_trigger_body_dto] = _body if !_body.empty?
  api_response = enable_with_http_info_impl(, trigger_name, extra)
  api_response.data
end

#enable_with_http_info(trigger_config:, connected_account_id:, trigger_name:, verify_host: SENTINEL, extra: {}) ⇒ Object

Enable trigger

Enables a trigger for a connected account and specific trigger name.

Parameters:

  • trigger_config (Object) —

    The trigger configuration

  • connected_account_id (String)
  • trigger_name (String)
  • verify_host (String) (defaults to: SENTINEL) —

    The verify host

  • body (EnableTriggerBodyDTO)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



228
229
230
231
232
233
234
 
# File 'lib/composio/api/triggers_api.rb', line 228

def enable_with_http_info(trigger_config:, connected_account_id:, trigger_name:, verify_host: SENTINEL, extra: {})
  _body = {}
  _body[:triggerConfig] = trigger_config if trigger_config != SENTINEL
  _body[:verifyHost] = verify_host if verify_host != SENTINEL
  extra[:enable_trigger_body_dto] = _body if !_body.empty?
  enable_with_http_info_impl(, trigger_name, extra)
end

#get_active_triggers(connected_account_ids: SENTINEL, integration_ids: SENTINEL, trigger_ids: SENTINEL, trigger_names: SENTINEL, page: SENTINEL, limit: SENTINEL, show_disabled: SENTINEL, extra: {}) ⇒ Object

Get active triggers

Lists active triggers based on query parameters.

Parameters:

  • connected_account_ids (String) (defaults to: SENTINEL)
  • integration_ids (String) (defaults to: SENTINEL)
  • trigger_ids (String) (defaults to: SENTINEL)
  • trigger_names (String) (defaults to: SENTINEL)
  • page (Float) (defaults to: SENTINEL)
  • limit (Float) (defaults to: SENTINEL)
  • show_disabled (Boolean) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/composio/api/triggers_api.rb', line 335

def get_active_triggers(connected_account_ids: SENTINEL, integration_ids: SENTINEL, trigger_ids: SENTINEL, trigger_names: SENTINEL, page: SENTINEL, limit: SENTINEL, show_disabled: SENTINEL, extra: {})
  extra[:connected_account_ids] =  if  != SENTINEL
  extra[:integration_ids] = integration_ids if integration_ids != SENTINEL
  extra[:trigger_ids] = trigger_ids if trigger_ids != SENTINEL
  extra[:trigger_names] = trigger_names if trigger_names != SENTINEL
  extra[:page] = page if page != SENTINEL
  extra[:limit] = limit if limit != SENTINEL
  extra[:show_disabled] = show_disabled if show_disabled != SENTINEL
  api_response = get_active_triggers_with_http_info_impl(extra)
  api_response.data
end

#get_active_triggers_with_http_info(connected_account_ids: SENTINEL, integration_ids: SENTINEL, trigger_ids: SENTINEL, trigger_names: SENTINEL, page: SENTINEL, limit: SENTINEL, show_disabled: SENTINEL, extra: {}) ⇒ Object

Get active triggers

Lists active triggers based on query parameters.

Parameters:

  • connected_account_ids (String) (defaults to: SENTINEL)
  • integration_ids (String) (defaults to: SENTINEL)
  • trigger_ids (String) (defaults to: SENTINEL)
  • trigger_names (String) (defaults to: SENTINEL)
  • page (Float) (defaults to: SENTINEL)
  • limit (Float) (defaults to: SENTINEL)
  • show_disabled (Boolean) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



359
360
361
362
363
364
365
366
367
368
 
# File 'lib/composio/api/triggers_api.rb', line 359

def get_active_triggers_with_http_info(connected_account_ids: SENTINEL, integration_ids: SENTINEL, trigger_ids: SENTINEL, trigger_names: SENTINEL, page: SENTINEL, limit: SENTINEL, show_disabled: SENTINEL, extra: {})
  extra[:connected_account_ids] =  if  != SENTINEL
  extra[:integration_ids] = integration_ids if integration_ids != SENTINEL
  extra[:trigger_ids] = trigger_ids if trigger_ids != SENTINEL
  extra[:trigger_names] = trigger_names if trigger_names != SENTINEL
  extra[:page] = page if page != SENTINEL
  extra[:limit] = limit if limit != SENTINEL
  extra[:show_disabled] = show_disabled if show_disabled != SENTINEL
  get_active_triggers_with_http_info_impl(extra)
end

#get_callback_url(extra: {}) ⇒ Object

Get webhook url

Retrieves the universal callback URL set for the client.

Parameters:

  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



454
455
456
457
 
# File 'lib/composio/api/triggers_api.rb', line 454

def get_callback_url(extra: {})
  api_response = get_callback_url_with_http_info_impl(extra)
  api_response.data
end

#get_callback_url_with_http_info(extra: {}) ⇒ Object

Get webhook url

Retrieves the universal callback URL set for the client.

Parameters:

  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



464
465
466
 
# File 'lib/composio/api/triggers_api.rb', line 464

def get_callback_url_with_http_info(extra: {})
  get_callback_url_with_http_info_impl(extra)
end

#get_logs_based_on_connection_and_integration_details(connection_id: SENTINEL, integration_id: SENTINEL, page: SENTINEL, limit: SENTINEL, extra: {}) ⇒ Object

Get logs

Fetches logs based on connection and integration details.

Parameters:

  • connection_id (String) (defaults to: SENTINEL)
  • integration_id (String) (defaults to: SENTINEL)
  • page (Float) (defaults to: SENTINEL)
  • limit (Float) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



535
536
537
538
539
540
541
542
 
# File 'lib/composio/api/triggers_api.rb', line 535

def get_logs_based_on_connection_and_integration_details(connection_id: SENTINEL, integration_id: SENTINEL, page: SENTINEL, limit: SENTINEL, extra: {})
  extra[:connection_id] = connection_id if connection_id != SENTINEL
  extra[:integration_id] = integration_id if integration_id != SENTINEL
  extra[:page] = page if page != SENTINEL
  extra[:limit] = limit if limit != SENTINEL
  api_response = get_logs_based_on_connection_and_integration_details_with_http_info_impl(extra)
  api_response.data
end

#get_logs_based_on_connection_and_integration_details_with_http_info(connection_id: SENTINEL, integration_id: SENTINEL, page: SENTINEL, limit: SENTINEL, extra: {}) ⇒ Object

Get logs

Fetches logs based on connection and integration details.

Parameters:

  • connection_id (String) (defaults to: SENTINEL)
  • integration_id (String) (defaults to: SENTINEL)
  • page (Float) (defaults to: SENTINEL)
  • limit (Float) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



553
554
555
556
557
558
559
 
# File 'lib/composio/api/triggers_api.rb', line 553

def get_logs_based_on_connection_and_integration_details_with_http_info(connection_id: SENTINEL, integration_id: SENTINEL, page: SENTINEL, limit: SENTINEL, extra: {})
  extra[:connection_id] = connection_id if connection_id != SENTINEL
  extra[:integration_id] = integration_id if integration_id != SENTINEL
  extra[:page] = page if page != SENTINEL
  extra[:limit] = limit if limit != SENTINEL
  get_logs_based_on_connection_and_integration_details_with_http_info_impl(extra)
end

#get_trigger_info(trigger_name:, extra: {}) ⇒ Object

Get trigger info

Get Trigger Info

Parameters:

  • trigger_name (String)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



637
638
639
640
 
# File 'lib/composio/api/triggers_api.rb', line 637

def get_trigger_info(trigger_name:, extra: {})
  api_response = get_trigger_info_with_http_info_impl(trigger_name, extra)
  api_response.data
end

#get_trigger_info_with_http_info(trigger_name:, extra: {}) ⇒ Object

Get trigger info

Get Trigger Info

Parameters:

  • trigger_name (String)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



648
649
650
 
# File 'lib/composio/api/triggers_api.rb', line 648

def get_trigger_info_with_http_info(trigger_name:, extra: {})
  get_trigger_info_with_http_info_impl(trigger_name, extra)
end

#list(app_names: SENTINEL, connected_account_ids: SENTINEL, trigger_ids: SENTINEL, integration_ids: SENTINEL, show_enabled_only: SENTINEL, extra: {}) ⇒ Object

List triggers

List triggers

Parameters:

  • app_names (String) (defaults to: SENTINEL)
  • connected_account_ids (String) (defaults to: SENTINEL)
  • trigger_ids (String) (defaults to: SENTINEL)
  • integration_ids (String) (defaults to: SENTINEL)
  • show_enabled_only (Boolean) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



731
732
733
734
735
736
737
738
739
 
# File 'lib/composio/api/triggers_api.rb', line 731

def list(app_names: SENTINEL, connected_account_ids: SENTINEL, trigger_ids: SENTINEL, integration_ids: SENTINEL, show_enabled_only: SENTINEL, extra: {})
  extra[:app_names] = app_names if app_names != SENTINEL
  extra[:connected_account_ids] =  if  != SENTINEL
  extra[:trigger_ids] = trigger_ids if trigger_ids != SENTINEL
  extra[:integration_ids] = integration_ids if integration_ids != SENTINEL
  extra[:show_enabled_only] = show_enabled_only if show_enabled_only != SENTINEL
  api_response = list_with_http_info_impl(extra)
  api_response.data
end

#list_with_http_info(app_names: SENTINEL, connected_account_ids: SENTINEL, trigger_ids: SENTINEL, integration_ids: SENTINEL, show_enabled_only: SENTINEL, extra: {}) ⇒ Object

List triggers

List triggers

Parameters:

  • app_names (String) (defaults to: SENTINEL)
  • connected_account_ids (String) (defaults to: SENTINEL)
  • trigger_ids (String) (defaults to: SENTINEL)
  • integration_ids (String) (defaults to: SENTINEL)
  • show_enabled_only (Boolean) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



751
752
753
754
755
756
757
758
 
# File 'lib/composio/api/triggers_api.rb', line 751

def list_with_http_info(app_names: SENTINEL, connected_account_ids: SENTINEL, trigger_ids: SENTINEL, integration_ids: SENTINEL, show_enabled_only: SENTINEL, extra: {})
  extra[:app_names] = app_names if app_names != SENTINEL
  extra[:connected_account_ids] =  if  != SENTINEL
  extra[:trigger_ids] = trigger_ids if trigger_ids != SENTINEL
  extra[:integration_ids] = integration_ids if integration_ids != SENTINEL
  extra[:show_enabled_only] = show_enabled_only if show_enabled_only != SENTINEL
  list_with_http_info_impl(extra)
end

#set_callback_url(callback_url:, extra: {}) ⇒ Object

Set callback url

Sets a universal callback URL for the client.

Parameters:

  • callback_url (String) —

    The callback URL

  • body (SetCallbackUrlBodyDTO)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



840
841
842
843
844
845
846
 
# File 'lib/composio/api/triggers_api.rb', line 840

def set_callback_url(callback_url:, extra: {})
  _body = {}
  _body[:callbackURL] = callback_url if callback_url != SENTINEL
  extra[:set_callback_url_body_dto] = _body if !_body.empty?
  api_response = set_callback_url_with_http_info_impl(extra)
  api_response.data
end

#set_callback_url_with_http_info(callback_url:, extra: {}) ⇒ Object

Set callback url

Sets a universal callback URL for the client.

Parameters:

  • callback_url (String) —

    The callback URL

  • body (SetCallbackUrlBodyDTO)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



855
856
857
858
859
860
 
# File 'lib/composio/api/triggers_api.rb', line 855

def set_callback_url_with_http_info(callback_url:, extra: {})
  _body = {}
  _body[:callbackURL] = callback_url if callback_url != SENTINEL
  extra[:set_callback_url_body_dto] = _body if !_body.empty?
  set_callback_url_with_http_info_impl(extra)
end

#switch_instance_status(enabled:, trigger_id:, extra: {}) ⇒ Object

Switch trigger instance status

Switches the status of a trigger instance.

Parameters:

  • enabled (Boolean) —

    The new enabled status of the trigger

  • trigger_id (String)
  • body (SwitchTriggerStatusBodyDTO)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



935
936
937
938
939
940
941
 
# File 'lib/composio/api/triggers_api.rb', line 935

def switch_instance_status(enabled:, trigger_id:, extra: {})
  _body = {}
  _body[:enabled] = enabled if enabled != SENTINEL
  extra[:switch_trigger_status_body_dto] = _body if !_body.empty?
  api_response = switch_instance_status_with_http_info_impl(trigger_id, extra)
  api_response.data
end

#switch_instance_status_with_http_info(enabled:, trigger_id:, extra: {}) ⇒ Object

Switch trigger instance status

Switches the status of a trigger instance.

Parameters:

  • enabled (Boolean) —

    The new enabled status of the trigger

  • trigger_id (String)
  • body (SwitchTriggerStatusBodyDTO)
  • extra (Hash) (defaults to: {}) —

    additional parameters to pass along through :header_params, :query_params, or parameter name



951
952
953
954
955
956
 
# File 'lib/composio/api/triggers_api.rb', line 951

def switch_instance_status_with_http_info(enabled:, trigger_id:, extra: {})
  _body = {}
  _body[:enabled] = enabled if enabled != SENTINEL
  extra[:switch_trigger_status_body_dto] = _body if !_body.empty?
  switch_instance_status_with_http_info_impl(trigger_id, extra)
end