Class: stcloud::AppsApi

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



16
17
18
 
# File 'lib/stcloud/api/apps_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/stcloud/api/apps_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#delete_using_delete1(any_state_app_id, opts = {}) ⇒ GenericMapBasedApiResponse

delete

Parameters:

  • any_state_app_id —

    anyStateAppId

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

    the optional parameters

Returns:



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

def delete_using_delete1(any_state_app_id, opts = {})
  data, _status_code, _headers = delete_using_delete1_with_http_info(any_state_app_id, opts)
  data
end

#delete_using_delete1_with_http_info(any_state_app_id, opts = {}) ⇒ Array<(GenericMapBasedApiResponse, Integer, Hash)>

delete

Parameters:

  • any_state_app_id —

    anyStateAppId

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

    the optional parameters

Returns:

  • (Array<(GenericMapBasedApiResponse, Integer, Hash)>) —

    GenericMapBasedApiResponse data, response status code and response headers



32
33
34
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
 
# File 'lib/stcloud/api/apps_api.rb', line 32

def delete_using_delete1_with_http_info(any_state_app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.delete_using_delete1 ...'
  end
  # verify the required parameter 'any_state_app_id' is set
  if @api_client.config.client_side_validation && any_state_app_id.nil?
    fail ArgumentError, "Missing the required parameter 'any_state_app_id' when calling AppsApi.delete_using_delete1"
  end
  # resource path
  local_var_path = '/users-web/api/v3/apps/{anyStateAppId}'.sub('{' + 'anyStateAppId' + '}', any_state_app_id.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[:body] 

  return_type = opts[:return_type] || 'GenericMapBasedApiResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#delete_using_delete1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_app_types_using_get(opts = {}) ⇒ AppTypesResponse

Get all App types supported for the account identified with apiKey

Parameters:

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

    the optional parameters

Returns:



76
77
78
79
 
# File 'lib/stcloud/api/apps_api.rb', line 76

def get_app_types_using_get(opts = {})
  data, _status_code, _headers = get_app_types_using_get_with_http_info(opts)
  data
end

#get_app_types_using_get_with_http_info(opts = {}) ⇒ Array<(AppTypesResponse, Integer, Hash)>

Get all App types supported for the account identified with apiKey

Parameters:

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

    the optional parameters

Returns:

  • (Array<(AppTypesResponse, Integer, Hash)>) —

    AppTypesResponse data, response status code and response headers



84
85
86
87
88
89
90
91
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
 
# File 'lib/stcloud/api/apps_api.rb', line 84

def get_app_types_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.get_app_types_using_get ...'
  end
  # resource path
  local_var_path = '/users-web/api/v3/apps/types'

  # 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[:body] 

  return_type = opts[:return_type] || 'AppTypesResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#get_app_types_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_using_get(any_state_app_id, opts = {}) ⇒ AppResponse

Gets defails for one particular App

Parameters:

  • any_state_app_id —

    anyStateAppId

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

    the optional parameters

Returns:



125
126
127
128
 
# File 'lib/stcloud/api/apps_api.rb', line 125

def get_using_get(any_state_app_id, opts = {})
  data, _status_code, _headers = get_using_get_with_http_info(any_state_app_id, opts)
  data
end

#get_using_get_with_http_info(any_state_app_id, opts = {}) ⇒ Array<(AppResponse, Integer, Hash)>

Gets defails for one particular App

Parameters:

  • any_state_app_id —

    anyStateAppId

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

    the optional parameters

Returns:

  • (Array<(AppResponse, Integer, Hash)>) —

    AppResponse data, response status code and response headers



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
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
 
# File 'lib/stcloud/api/apps_api.rb', line 134

def get_using_get_with_http_info(any_state_app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.get_using_get ...'
  end
  # verify the required parameter 'any_state_app_id' is set
  if @api_client.config.client_side_validation && any_state_app_id.nil?
    fail ArgumentError, "Missing the required parameter 'any_state_app_id' when calling AppsApi.get_using_get"
  end
  # resource path
  local_var_path = '/users-web/api/v3/apps/{anyStateAppId}'.sub('{' + 'anyStateAppId' + '}', any_state_app_id.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[:body] 

  return_type = opts[:return_type] || 'AppResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#get_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#invite_app_guests_using_post(body, opts = {}) ⇒ GenericMapBasedApiResponse

Invite guests to an app

Parameters:

  • body —

    For &#x60;app&#x60; and &#x60;apps&#x60; fields only &#x60;id&#x60; needs to be populated.Other fields can be left empty or with default values

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

    the optional parameters

Returns:



179
180
181
182
 
# File 'lib/stcloud/api/apps_api.rb', line 179

def invite_app_guests_using_post(body, opts = {})
  data, _status_code, _headers = invite_app_guests_using_post_with_http_info(body, opts)
  data
end

#invite_app_guests_using_post_with_http_info(body, opts = {}) ⇒ Array<(GenericMapBasedApiResponse, Integer, Hash)>

Invite guests to an app

Parameters:

  • body —

    For &#x60;app&#x60; and &#x60;apps&#x60; fields only &#x60;id&#x60; needs to be populated.Other fields can be left empty or with default values

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

    the optional parameters

Returns:

  • (Array<(GenericMapBasedApiResponse, Integer, Hash)>) —

    GenericMapBasedApiResponse data, response status code and response headers



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/stcloud/api/apps_api.rb', line 188

def invite_app_guests_using_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.invite_app_guests_using_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.invite_app_guests_using_post"
  end
  # resource path
  local_var_path = '/users-web/api/v3/apps/guests'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'GenericMapBasedApiResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#invite_app_guests_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_apps_users_using_get1(opts = {}) ⇒ AppsResponse

Get all users of apps accessible to this account

Parameters:

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

    the optional parameters

Returns:



234
235
236
237
 
# File 'lib/stcloud/api/apps_api.rb', line 234

def list_apps_users_using_get1(opts = {})
  data, _status_code, _headers = list_apps_users_using_get1_with_http_info(opts)
  data
end

#list_apps_users_using_get1_with_http_info(opts = {}) ⇒ Array<(AppsResponse, Integer, Hash)>

Get all users of apps accessible to this account

Parameters:

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

    the optional parameters

Returns:

  • (Array<(AppsResponse, Integer, Hash)>) —

    AppsResponse data, response status code and response headers



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/stcloud/api/apps_api.rb', line 242

def list_apps_users_using_get1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.list_apps_users_using_get1 ...'
  end
  # resource path
  local_var_path = '/users-web/api/v3/apps/users'

  # 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[:body] 

  return_type = opts[:return_type] || 'AppsResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#list_apps_users_using_get1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_using_get(opts = {}) ⇒ AppsResponse

Get all apps accessible by account identified with apiKey

Parameters:

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

    the optional parameters

Returns:



282
283
284
285
 
# File 'lib/stcloud/api/apps_api.rb', line 282

def list_using_get(opts = {})
  data, _status_code, _headers = list_using_get_with_http_info(opts)
  data
end

#list_using_get_with_http_info(opts = {}) ⇒ Array<(AppsResponse, Integer, Hash)>

Get all apps accessible by account identified with apiKey

Parameters:

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

    the optional parameters

Returns:

  • (Array<(AppsResponse, Integer, Hash)>) —

    AppsResponse data, response status code and response headers



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/stcloud/api/apps_api.rb', line 290

def list_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.list_using_get ...'
  end
  # resource path
  local_var_path = '/users-web/api/v3/apps'

  # 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[:body] 

  return_type = opts[:return_type] || 'AppsResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#list_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_description_using_put1(any_state_app_id, opts = {}) ⇒ AppResponse

Update description of the app App can be in any state

Parameters:

  • any_state_app_id —

    App Id

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

    the optional parameters

Options Hash (opts):

Returns:



333
334
335
336
 
# File 'lib/stcloud/api/apps_api.rb', line 333

def update_description_using_put1(any_state_app_id, opts = {})
  data, _status_code, _headers = update_description_using_put1_with_http_info(any_state_app_id, opts)
  data
end

#update_description_using_put1_with_http_info(any_state_app_id, opts = {}) ⇒ Array<(AppResponse, Integer, Hash)>

Update description of the app App can be in any state

Parameters:

  • any_state_app_id —

    App Id

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(AppResponse, Integer, Hash)>) —

    AppResponse data, response status code and response headers



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/stcloud/api/apps_api.rb', line 344

def update_description_using_put1_with_http_info(any_state_app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.update_description_using_put1 ...'
  end
  # verify the required parameter 'any_state_app_id' is set
  if @api_client.config.client_side_validation && any_state_app_id.nil?
    fail ArgumentError, "Missing the required parameter 'any_state_app_id' when calling AppsApi.update_description_using_put1"
  end
  # resource path
  local_var_path = '/users-web/api/v3/apps/{anyStateAppId}/description'.sub('{' + 'anyStateAppId' + '}', any_state_app_id.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 

  return_type = opts[:return_type] || 'AppResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#update_description_using_put1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_using_put3(body, any_state_app_id, opts = {}) ⇒ AppResponse

Update app App can be in any state

Parameters:

  • body —

    dto

  • any_state_app_id —

    App Id

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

    the optional parameters

Returns:



393
394
395
396
 
# File 'lib/stcloud/api/apps_api.rb', line 393

def update_using_put3(body, any_state_app_id, opts = {})
  data, _status_code, _headers = update_using_put3_with_http_info(body, any_state_app_id, opts)
  data
end

#update_using_put3_with_http_info(body, any_state_app_id, opts = {}) ⇒ Array<(AppResponse, Integer, Hash)>

Update app App can be in any state

Parameters:

  • body —

    dto

  • any_state_app_id —

    App Id

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

    the optional parameters

Returns:

  • (Array<(AppResponse, Integer, Hash)>) —

    AppResponse data, response status code and response headers



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/stcloud/api/apps_api.rb', line 404

def update_using_put3_with_http_info(body, any_state_app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.update_using_put3 ...'
  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.update_using_put3"
  end
  # verify the required parameter 'any_state_app_id' is set
  if @api_client.config.client_side_validation && any_state_app_id.nil?
    fail ArgumentError, "Missing the required parameter 'any_state_app_id' when calling AppsApi.update_using_put3"
  end
  # resource path
  local_var_path = '/users-web/api/v3/apps/{anyStateAppId}'.sub('{' + 'anyStateAppId' + '}', any_state_app_id.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'AppResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#update_using_put3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end