Class: EmbedWorkflow::AvailableAppsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/embed_workflow/api/available_apps_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AvailableAppsApi

Returns a new instance of AvailableAppsApi.



19
20
21
 
# File 'lib/embed_workflow/api/available_apps_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/embed_workflow/api/available_apps_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#list_available_apps(**opts) ⇒ ListAvailableApps200Response

List available apps

Parameters:

  • opts (Hash) —

    the optional parameters

Options Hash (**opts):

  • :exclude_installed (String) —

    Exclude already installed apps

Returns:



26
27
28
29
 
# File 'lib/embed_workflow/api/available_apps_api.rb', line 26

def list_available_apps(**opts)
  data, _status_code, _headers = list_available_apps_with_http_info(opts)
  data
end

#list_available_apps_with_http_info(opts = {}) ⇒ Array<(ListAvailableApps200Response, Integer, Hash)>

List available apps

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :exclude_installed (String) —

    Exclude already installed apps

Returns:



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/embed_workflow/api/available_apps_api.rb', line 35

def list_available_apps_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AvailableAppsApi.list_available_apps ...'
  end
  # resource path
  local_var_path = '/api/v1/available_apps'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'exclude_installed'] = opts[:'exclude_installed'] if !opts[:'exclude_installed'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListAvailableApps200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer']

  new_options = opts.merge(
    :operation => :"AvailableAppsApi.list_available_apps",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AvailableAppsApi#list_available_apps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retrieve_available_app(app_identifier:, **opts) ⇒ RetrieveAvailableApp200Response

Retrieve available app

Parameters:

  • app_identifier (String) —

    App indentifier

  • opts (Hash) —

    the optional parameters

Returns:



84
85
86
87
 
# File 'lib/embed_workflow/api/available_apps_api.rb', line 84

def retrieve_available_app(app_identifier:, **opts)
  data, _status_code, _headers = retrieve_available_app_with_http_info(app_identifier, opts)
  data
end

#retrieve_available_app_with_http_info(app_identifier, opts = {}) ⇒ Array<(RetrieveAvailableApp200Response, Integer, Hash)>

Retrieve available app

Parameters:

  • app_identifier (String) —

    App indentifier

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

    the optional parameters

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/embed_workflow/api/available_apps_api.rb', line 93

def retrieve_available_app_with_http_info(app_identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AvailableAppsApi.retrieve_available_app ...'
  end
  # verify the required parameter 'app_identifier' is set
  if @api_client.config.client_side_validation && app_identifier.nil?
    fail ArgumentError, "Missing the required parameter 'app_identifier' when calling AvailableAppsApi.retrieve_available_app"
  end
  # resource path
  local_var_path = '/api/v1/available_apps/{app_identifier}'.sub('{' + 'app_identifier' + '}', CGI.escape(app_identifier.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'RetrieveAvailableApp200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearer']

  new_options = opts.merge(
    :operation => :"AvailableAppsApi.retrieve_available_app",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AvailableAppsApi#retrieve_available_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end