Class: Fn::AppsApi

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



19
20
21
 
# File 'lib/fn_ruby/api/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/fn_ruby/api/apps_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#apps_app_delete(app, opts = {}) ⇒ nil

Delete an app. Delete an app.

Parameters:

  • app —

    Name of the app.

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

    the optional parameters

Returns:

  • (nil) 


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

def apps_app_delete(app, opts = {})
  apps_app_delete_with_http_info(app, opts)
  return nil
end

#apps_app_delete_with_http_info(app, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an app. Delete an app.

Parameters:

  • app —

    Name of the app.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/fn_ruby/api/apps_api.rb', line 38

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#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:



82
83
84
85
 
# File 'lib/fn_ruby/api/apps_api.rb', line 82

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



92
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
 
# File 'lib/fn_ruby/api/apps_api.rb', line 92

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
  if @api_client.config.client_side_validation && app.nil?
    fail ArgumentError, "Missing the required parameter 'app' when calling AppsApi.apps_app_get"
  end
  # resource path
  local_var_path = "/apps/{app}".sub('{' + 'app' + '}', app.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_patch(app, body, opts = {}) ⇒ AppWrapper

Updates an 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:



138
139
140
141
 
# File 'lib/fn_ruby/api/apps_api.rb', line 138

def apps_app_patch(app, body, opts = {})
  data, _status_code, _headers = apps_app_patch_with_http_info(app, body, opts)
  return data
end

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

Updates an 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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
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
 
# File 'lib/fn_ruby/api/apps_api.rb', line 149

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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(:PATCH, 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_patch\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, returned in alphabetical order.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String) —

    Cursor from previous response.next_cursor to begin results after, if any.

  • :per_page (Integer) —

    Number of results to return, defaults to 30. Max of 100.

Returns:



199
200
201
202
 
# File 'lib/fn_ruby/api/apps_api.rb', line 199

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, returned in alphabetical order.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String) —

    Cursor from previous response.next_cursor to begin results after, if any.

  • :per_page (Integer) —

    Number of results to return, defaults to 30. Max of 100.

Returns:

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

    AppsWrapper data, response status code and response headers



210
211
212
213
214
215
216
217
218
219
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
 
# File 'lib/fn_ruby/api/apps_api.rb', line 210

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"

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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:



253
254
255
256
 
# File 'lib/fn_ruby/api/apps_api.rb', line 253

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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/fn_ruby/api/apps_api.rb', line 263

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
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AppsApi.apps_post"
  end
  # resource path
  local_var_path = "/apps"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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