Class: IronFunctions::AppsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/iron_functions/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.



30
31
32
 
# File 'lib/iron_functions/api/apps_api.rb', line 30

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/iron_functions/api/apps_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#apps_app_get(app, opts = {}) ⇒ AppWrapper

Get information for a app. This gives more details about a app, such as statistics.

Parameters:

  • app —

    name of the app.

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

    the optional parameters

Returns:



39
40
41
42
 
# File 'lib/iron_functions/api/apps_api.rb', line 39

def apps_app_get(app, opts = {})
  data, _status_code, _headers = apps_app_get_with_http_info(app, opts)
  return data
end

#apps_app_get_with_http_info(app, opts = {}) ⇒ Array<(AppWrapper, Fixnum, Hash)>

Get information for a app. This gives more details about a app, such as statistics.

Parameters:

  • app —

    name of the app.

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

    the optional parameters

Returns:

  • (Array<(AppWrapper, Fixnum, Hash)>) —

    AppWrapper data, response status code and response headers



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
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/iron_functions/api/apps_api.rb', line 49

def apps_app_get_with_http_info(app, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AppsApi.apps_app_get ..."
  end
  # verify the required parameter 'app' is set
  fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.apps_app_get" if app.nil?
  # resource path
  local_var_path = "/apps/{app}".sub('{format}','json').sub('{' + 'app' + '}', app.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AppWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#apps_app_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#apps_app_put(app, body, opts = {}) ⇒ AppWrapper

Create/update a app. You can set app level settings here.

Parameters:

  • app —

    name of the app.

  • body —

    App to post.

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

    the optional parameters

Returns:



97
98
99
100
 
# File 'lib/iron_functions/api/apps_api.rb', line 97

def apps_app_put(app, body, opts = {})
  data, _status_code, _headers = apps_app_put_with_http_info(app, body, opts)
  return data
end

#apps_app_put_with_http_info(app, body, opts = {}) ⇒ Array<(AppWrapper, Fixnum, Hash)>

Create/update a app. You can set app level settings here.

Parameters:

  • app —

    name of the app.

  • body —

    App to post.

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

    the optional parameters

Returns:

  • (Array<(AppWrapper, Fixnum, Hash)>) —

    AppWrapper data, response status code and response headers



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
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/iron_functions/api/apps_api.rb', line 108

def apps_app_put_with_http_info(app, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AppsApi.apps_app_put ..."
  end
  # verify the required parameter 'app' is set
  fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.apps_app_put" if app.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling AppsApi.apps_app_put" if body.nil?
  # resource path
  local_var_path = "/apps/{app}".sub('{format}','json').sub('{' + 'app' + '}', app.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AppWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#apps_app_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#apps_get(opts = {}) ⇒ AppsWrapper

Get all app names. Get a list of all the apps in the system.

Parameters:

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

    the optional parameters

Returns:



156
157
158
159
 
# File 'lib/iron_functions/api/apps_api.rb', line 156

def apps_get(opts = {})
  data, _status_code, _headers = apps_get_with_http_info(opts)
  return data
end

#apps_get_with_http_info(opts = {}) ⇒ Array<(AppsWrapper, Fixnum, Hash)>

Get all app names. Get a list of all the apps in the system.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(AppsWrapper, Fixnum, Hash)>) —

    AppsWrapper data, response status code and response headers



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/iron_functions/api/apps_api.rb', line 165

def apps_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AppsApi.apps_get ..."
  end
  # resource path
  local_var_path = "/apps".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AppsWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#apps_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#apps_post(body, opts = {}) ⇒ AppWrapper

Post new app Insert a new app

Parameters:

  • body —

    App to post.

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

    the optional parameters

Returns:



210
211
212
213
 
# File 'lib/iron_functions/api/apps_api.rb', line 210

def apps_post(body, opts = {})
  data, _status_code, _headers = apps_post_with_http_info(body, opts)
  return data
end

#apps_post_with_http_info(body, opts = {}) ⇒ Array<(AppWrapper, Fixnum, Hash)>

Post new app Insert a new app

Parameters:

  • body —

    App to post.

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

    the optional parameters

Returns:

  • (Array<(AppWrapper, Fixnum, Hash)>) —

    AppWrapper data, response status code and response headers



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/iron_functions/api/apps_api.rb', line 220

def apps_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AppsApi.apps_post ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling AppsApi.apps_post" if body.nil?
  # resource path
  local_var_path = "/apps".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AppWrapper')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#apps_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end