Class: Composio::AppsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AppsApi

Returns a new instance of AppsApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_open_api_spec_tool(id:, extra: {}) ⇒ Object

Delete open api spec tool

Parameters:

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

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



23
24
25
26
 
# File 'lib/composio/api/apps_api.rb', line 23

def delete_open_api_spec_tool(id:, extra: {})
  api_response = delete_open_api_spec_tool_with_http_info_impl(id, extra)
  api_response.data
end

#delete_open_api_spec_tool_with_http_info(id:, extra: {}) ⇒ Object

Delete open api spec tool

Parameters:

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

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



32
33
34
 
# File 'lib/composio/api/apps_api.rb', line 32

def delete_open_api_spec_tool_with_http_info(id:, extra: {})
  delete_open_api_spec_tool_with_http_info_impl(id, extra)
end

#get_details(app_name:, extra: {}) ⇒ Object

Get app

Get app details

Parameters:

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

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



109
110
111
112
 
# File 'lib/composio/api/apps_api.rb', line 109

def get_details(app_name:, extra: {})
  api_response = get_details_with_http_info_impl(app_name, extra)
  api_response.data
end

#get_details_with_http_info(app_name:, extra: {}) ⇒ Object

Get app

Get app details

Parameters:

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

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



120
121
122
 
# File 'lib/composio/api/apps_api.rb', line 120

def get_details_with_http_info(app_name:, extra: {})
  get_details_with_http_info_impl(app_name, extra)
end

#get_open_api_spec_status(id:, extra: {}) ⇒ Object

Get open api spec status

Parameters:

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

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



197
198
199
200
 
# File 'lib/composio/api/apps_api.rb', line 197

def get_open_api_spec_status(id:, extra: {})
  api_response = get_open_api_spec_status_with_http_info_impl(id, extra)
  api_response.data
end

#get_open_api_spec_status_with_http_info(id:, extra: {}) ⇒ Object

Get open api spec status

Parameters:

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

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



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

def get_open_api_spec_status_with_http_info(id:, extra: {})
  get_open_api_spec_status_with_http_info_impl(id, extra)
end

#list(category: SENTINEL, include_local: SENTINEL, extra: {}) ⇒ Object

Get apps

Retrieve a list of all applications based on query parameters.

Parameters:

  • category (String) (defaults to: SENTINEL)
  • include_local (String) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

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



284
285
286
287
288
289
 
# File 'lib/composio/api/apps_api.rb', line 284

def list(category: SENTINEL, include_local: SENTINEL, extra: {})
  extra[:category] = category if category != SENTINEL
  extra[:include_local] = include_local if include_local != SENTINEL
  api_response = list_with_http_info_impl(extra)
  api_response.data
end

#list_open_api_specs(extra: {}) ⇒ Object

Get opena api specs

Parameters:

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

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



371
372
373
374
 
# File 'lib/composio/api/apps_api.rb', line 371

def list_open_api_specs(extra: {})
  api_response = list_open_api_specs_with_http_info_impl(extra)
  api_response.data
end

#list_open_api_specs_with_http_info(extra: {}) ⇒ Object

Get opena api specs

Parameters:

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

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



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

def list_open_api_specs_with_http_info(extra: {})
  list_open_api_specs_with_http_info_impl(extra)
end

#list_with_http_info(category: SENTINEL, include_local: SENTINEL, extra: {}) ⇒ Object

Get apps

Retrieve a list of all applications based on query parameters.

Parameters:

  • category (String) (defaults to: SENTINEL)
  • include_local (String) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

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



298
299
300
301
302
 
# File 'lib/composio/api/apps_api.rb', line 298

def list_with_http_info(category: SENTINEL, include_local: SENTINEL, extra: {})
  extra[:category] = category if category != SENTINEL
  extra[:include_local] = include_local if include_local != SENTINEL
  list_with_http_info_impl(extra)
end

#send_email_to_client(admin_token: SENTINEL, body: SENTINEL, extra: {}) ⇒ Object

Send email to client

Parameters:

  • admin_token (String) (defaults to: SENTINEL)
  • body (Object) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

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



444
445
446
447
448
449
 
# File 'lib/composio/api/apps_api.rb', line 444

def send_email_to_client(admin_token: SENTINEL, body: SENTINEL, extra: {})
  extra[:body] = body if body != SENTINEL
  extra[:admin_token] = admin_token if admin_token != SENTINEL
  api_response = send_email_to_client_with_http_info_impl(extra)
  api_response.data
end

#send_email_to_client_with_http_info(admin_token: SENTINEL, body: SENTINEL, extra: {}) ⇒ Object

Send email to client

Parameters:

  • admin_token (String) (defaults to: SENTINEL)
  • body (Object) (defaults to: SENTINEL)
  • extra (Hash) (defaults to: {}) —

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



456
457
458
459
460
 
# File 'lib/composio/api/apps_api.rb', line 456

def send_email_to_client_with_http_info(admin_token: SENTINEL, body: SENTINEL, extra: {})
  extra[:body] = body if body != SENTINEL
  extra[:admin_token] = admin_token if admin_token != SENTINEL
  send_email_to_client_with_http_info_impl(extra)
end