Class: Composio::ConnectionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConnectionsApi

Returns a new instance of ConnectionsApi.



15
16
17
 
# File 'lib/composio/api/connections_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/connections_api.rb', line 13

def api_client
  @api_client
end

Instance Method Details

#delete(connected_account_id:, extra: {}) ⇒ Object

Delete connection

Delete a connection

Parameters:

  • connected_account_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/connections_api.rb', line 25

def delete(connected_account_id:, extra: {})
  api_response = delete_with_http_info_impl(, extra)
  api_response.data
end

#delete_with_http_info(connected_account_id:, extra: {}) ⇒ Object

Delete connection

Delete a connection

Parameters:

  • connected_account_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/connections_api.rb', line 36

def delete_with_http_info(connected_account_id:, extra: {})
  delete_with_http_info_impl(, extra)
end

#disable(connected_account_id:, extra: {}) ⇒ Object

Disable connection

Disable a connection

Parameters:

  • connected_account_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/connections_api.rb', line 115

def disable(connected_account_id:, extra: {})
  api_response = disable_with_http_info_impl(, extra)
  api_response.data
end

#disable_with_http_info(connected_account_id:, extra: {}) ⇒ Object

Disable connection

Disable a connection

Parameters:

  • connected_account_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/connections_api.rb', line 126

def disable_with_http_info(connected_account_id:, extra: {})
  disable_with_http_info_impl(, extra)
end

#enable(connected_account_id:, extra: {}) ⇒ Object

Enable connection

Enable a connection

Parameters:

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

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



205
206
207
208
 
# File 'lib/composio/api/connections_api.rb', line 205

def enable(connected_account_id:, extra: {})
  api_response = enable_with_http_info_impl(, extra)
  api_response.data
end

#enable_with_http_info(connected_account_id:, extra: {}) ⇒ Object

Enable connection

Enable a connection

Parameters:

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

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



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

def enable_with_http_info(connected_account_id:, extra: {})
  enable_with_http_info_impl(, extra)
end

#get(connected_account_id:, extra: {}) ⇒ Object

Get connection

Parameters:

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

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



293
294
295
296
 
# File 'lib/composio/api/connections_api.rb', line 293

def get(connected_account_id:, extra: {})
  api_response = get_with_http_info_impl(, extra)
  api_response.data
end

#get_info(connected_account_id:, extra: {}) ⇒ Object

Get connection info

Get connection info

Parameters:

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

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



379
380
381
382
 
# File 'lib/composio/api/connections_api.rb', line 379

def get_info(connected_account_id:, extra: {})
  api_response = get_info_with_http_info_impl(, extra)
  api_response.data
end

#get_info_with_http_info(connected_account_id:, extra: {}) ⇒ Object

Get connection info

Get connection info

Parameters:

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

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



390
391
392
 
# File 'lib/composio/api/connections_api.rb', line 390

def get_info_with_http_info(connected_account_id:, extra: {})
  get_info_with_http_info_impl(, extra)
end

#get_with_http_info(connected_account_id:, extra: {}) ⇒ Object

Get connection

Parameters:

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

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



302
303
304
 
# File 'lib/composio/api/connections_api.rb', line 302

def get_with_http_info(connected_account_id:, extra: {})
  get_with_http_info_impl(, extra)
end

#initiate(data:, integration_id:, redirect_uri: SENTINEL, user_uuid: SENTINEL, entity_id: SENTINEL, labels: SENTINEL, extra: {}) ⇒ Object

Initiate connection

Parameters:

  • data (Object)
  • integration_id (String)
  • redirect_uri (String) (defaults to: SENTINEL)
  • user_uuid (String) (defaults to: SENTINEL)
  • entity_id (String) (defaults to: SENTINEL)
  • labels (Array<String>) (defaults to: SENTINEL)
  • body (InitiateConnectionPayloadDto)
  • extra (Hash) (defaults to: {}) —

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



473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/composio/api/connections_api.rb', line 473

def initiate(data:, integration_id:, redirect_uri: SENTINEL, user_uuid: SENTINEL, entity_id: SENTINEL, labels: SENTINEL, extra: {})
  _body = {}
  _body[:data] = data if data != SENTINEL
  _body[:integrationId] = integration_id if integration_id != SENTINEL
  _body[:redirectUri] = redirect_uri if redirect_uri != SENTINEL
  _body[:userUuid] = user_uuid if user_uuid != SENTINEL
  _body[:entityId] = entity_id if entity_id != SENTINEL
  _body[:labels] = labels if labels != SENTINEL
  extra[:initiate_connection_payload_dto] = _body if !_body.empty?
  api_response = initiate_with_http_info_impl(extra)
  api_response.data
end

#initiate_with_http_info(data:, integration_id:, redirect_uri: SENTINEL, user_uuid: SENTINEL, entity_id: SENTINEL, labels: SENTINEL, extra: {}) ⇒ Object

Initiate connection

Parameters:

  • data (Object)
  • integration_id (String)
  • redirect_uri (String) (defaults to: SENTINEL)
  • user_uuid (String) (defaults to: SENTINEL)
  • entity_id (String) (defaults to: SENTINEL)
  • labels (Array<String>) (defaults to: SENTINEL)
  • body (InitiateConnectionPayloadDto)
  • extra (Hash) (defaults to: {}) —

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



496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/composio/api/connections_api.rb', line 496

def initiate_with_http_info(data:, integration_id:, redirect_uri: SENTINEL, user_uuid: SENTINEL, entity_id: SENTINEL, labels: SENTINEL, extra: {})
  _body = {}
  _body[:data] = data if data != SENTINEL
  _body[:integrationId] = integration_id if integration_id != SENTINEL
  _body[:redirectUri] = redirect_uri if redirect_uri != SENTINEL
  _body[:userUuid] = user_uuid if user_uuid != SENTINEL
  _body[:entityId] = entity_id if entity_id != SENTINEL
  _body[:labels] = labels if labels != SENTINEL
  extra[:initiate_connection_payload_dto] = _body if !_body.empty?
  initiate_with_http_info_impl(extra)
end

#list(page: SENTINEL, page_size: SENTINEL, app_names: SENTINEL, integration_id: SENTINEL, connection_id: SENTINEL, user_uuid: SENTINEL, show_active_only: SENTINEL, status: SENTINEL, show_disabled: SENTINEL, labels: SENTINEL, extra: {}) ⇒ Object

Get connections

Parameters:

  • page (Float) (defaults to: SENTINEL)
  • page_size (Float) (defaults to: SENTINEL)
  • app_names (String) (defaults to: SENTINEL)
  • integration_id (String) (defaults to: SENTINEL)
  • connection_id (String) (defaults to: SENTINEL)
  • user_uuid (String) (defaults to: SENTINEL)
  • show_active_only (Boolean) (defaults to: SENTINEL)
  • status (String) (defaults to: SENTINEL)
  • show_disabled (Boolean) (defaults to: SENTINEL)
  • labels (Array<String>) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

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



584
585
586
587
588
589
590
591
592
593
594
595
596
597
 
# File 'lib/composio/api/connections_api.rb', line 584

def list(page: SENTINEL, page_size: SENTINEL, app_names: SENTINEL, integration_id: SENTINEL, connection_id: SENTINEL, user_uuid: SENTINEL, show_active_only: SENTINEL, status: SENTINEL, show_disabled: SENTINEL, labels: SENTINEL, extra: {})
  extra[:page] = page if page != SENTINEL
  extra[:page_size] = page_size if page_size != SENTINEL
  extra[:app_names] = app_names if app_names != SENTINEL
  extra[:integration_id] = integration_id if integration_id != SENTINEL
  extra[:connection_id] = connection_id if connection_id != SENTINEL
  extra[:user_uuid] = user_uuid if user_uuid != SENTINEL
  extra[:show_active_only] = show_active_only if show_active_only != SENTINEL
  extra[:status] = status if status != SENTINEL
  extra[:show_disabled] = show_disabled if show_disabled != SENTINEL
  extra[:labels] = labels if labels != SENTINEL
  api_response = list_with_http_info_impl(extra)
  api_response.data
end

#list_with_http_info(page: SENTINEL, page_size: SENTINEL, app_names: SENTINEL, integration_id: SENTINEL, connection_id: SENTINEL, user_uuid: SENTINEL, show_active_only: SENTINEL, status: SENTINEL, show_disabled: SENTINEL, labels: SENTINEL, extra: {}) ⇒ Object

Get connections

Parameters:

  • page (Float) (defaults to: SENTINEL)
  • page_size (Float) (defaults to: SENTINEL)
  • app_names (String) (defaults to: SENTINEL)
  • integration_id (String) (defaults to: SENTINEL)
  • connection_id (String) (defaults to: SENTINEL)
  • user_uuid (String) (defaults to: SENTINEL)
  • show_active_only (Boolean) (defaults to: SENTINEL)
  • status (String) (defaults to: SENTINEL)
  • show_disabled (Boolean) (defaults to: SENTINEL)
  • labels (Array<String>) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

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



612
613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/composio/api/connections_api.rb', line 612

def list_with_http_info(page: SENTINEL, page_size: SENTINEL, app_names: SENTINEL, integration_id: SENTINEL, connection_id: SENTINEL, user_uuid: SENTINEL, show_active_only: SENTINEL, status: SENTINEL, show_disabled: SENTINEL, labels: SENTINEL, extra: {})
  extra[:page] = page if page != SENTINEL
  extra[:page_size] = page_size if page_size != SENTINEL
  extra[:app_names] = app_names if app_names != SENTINEL
  extra[:integration_id] = integration_id if integration_id != SENTINEL
  extra[:connection_id] = connection_id if connection_id != SENTINEL
  extra[:user_uuid] = user_uuid if user_uuid != SENTINEL
  extra[:show_active_only] = show_active_only if show_active_only != SENTINEL
  extra[:status] = status if status != SENTINEL
  extra[:show_disabled] = show_disabled if show_disabled != SENTINEL
  extra[:labels] = labels if labels != SENTINEL
  list_with_http_info_impl(extra)
end

#update_connection_data(labels:, connected_account_id:, extra: {}) ⇒ Object

Update connection data

Update connection data

Parameters:

  • labels (Array<String>)
  • connected_account_id (String)
  • body (UpdateConnectionLabelsPayloadDto)
  • extra (Hash) (defaults to: {}) —

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



720
721
722
723
724
725
726
 
# File 'lib/composio/api/connections_api.rb', line 720

def update_connection_data(labels:, connected_account_id:, extra: {})
  _body = {}
  _body[:labels] = labels if labels != SENTINEL
  extra[:update_connection_labels_payload_dto] = _body if !_body.empty?
  api_response = update_connection_data_with_http_info_impl(, extra)
  api_response.data
end

#update_connection_data_with_http_info(labels:, connected_account_id:, extra: {}) ⇒ Object

Update connection data

Update connection data

Parameters:

  • labels (Array<String>)
  • connected_account_id (String)
  • body (UpdateConnectionLabelsPayloadDto)
  • extra (Hash) (defaults to: {}) —

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



736
737
738
739
740
741
 
# File 'lib/composio/api/connections_api.rb', line 736

def update_connection_data_with_http_info(labels:, connected_account_id:, extra: {})
  _body = {}
  _body[:labels] = labels if labels != SENTINEL
  extra[:update_connection_labels_payload_dto] = _body if !_body.empty?
  update_connection_data_with_http_info_impl(, extra)
end