Class: Spatio::AppsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/spatio-sdk/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/spatio-sdk/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/spatio-sdk/api/apps_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_app(create_app_request, opts = {}) ⇒ App

Register a prototype app (project_path is the on-disk root).

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 26

def create_app(create_app_request, opts = {})
  data, _status_code, _headers = create_app_with_http_info(create_app_request, opts)
  data
end

#create_app_with_http_info(create_app_request, opts = {}) ⇒ Array<(App, Integer, Hash)>

Register a prototype app (project_path is the on-disk root).

Parameters:

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

    the optional parameters

Returns:

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

    App data, response status code and response headers



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
79
80
81
82
83
84
85
86
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 35

def create_app_with_http_info(create_app_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.create_app ...'
  end
  # verify the required parameter 'create_app_request' is set
  if @api_client.config.client_side_validation && create_app_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_app_request' when calling AppsApi.create_app"
  end
  # resource path
  local_var_path = '/v1/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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

  new_options = opts.merge(
    :operation => :"AppsApi.create_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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#create_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_app(id, opts = {}) ⇒ nil

Delete an app.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


92
93
94
95
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 92

def delete_app(id, opts = {})
  delete_app_with_http_info(id, opts)
  nil
end

#delete_app_file(id, path, opts = {}) ⇒ nil

Delete one file inside the app’s project directory.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


154
155
156
157
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 154

def delete_app_file(id, path, opts = {})
  delete_app_file_with_http_info(id, path, opts)
  nil
end

#delete_app_file_with_http_info(id, path, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete one file inside the app&#39;s project directory.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 164

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"AppsApi.delete_app_file",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#delete_app_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_app_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an app.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
140
141
142
143
144
145
146
147
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 101

def delete_app_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.delete_app ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AppsApi.delete_app"
  end
  # resource path
  local_var_path = '/v1/apps/{id}'.sub('{id}', CGI.escape(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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"AppsApi.delete_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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#delete_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_app(id, opts = {}) ⇒ App

Fetch an app.

Parameters:

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

    the optional parameters

Returns:



221
222
223
224
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 221

def get_app(id, opts = {})
  data, _status_code, _headers = get_app_with_http_info(id, opts)
  data
end

#get_app_with_http_info(id, opts = {}) ⇒ Array<(App, Integer, Hash)>

Fetch an app.

Parameters:

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

    the optional parameters

Returns:

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

    App data, response status code and response headers



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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 230

def get_app_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.get_app ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AppsApi.get_app"
  end
  # resource path
  local_var_path = '/v1/apps/{id}'.sub('{id}', CGI.escape(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']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"AppsApi.get_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: AppsApi#get_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_app_files(id, opts = {}) ⇒ AppFileListResponse

List files inside the app’s project directory.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :path (String)

Returns:



283
284
285
286
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 283

def list_app_files(id, opts = {})
  data, _status_code, _headers = list_app_files_with_http_info(id, opts)
  data
end

#list_app_files_with_http_info(id, opts = {}) ⇒ Array<(AppFileListResponse, Integer, Hash)>

List files inside the app&#39;s project directory.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :path (String)

Returns:

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

    AppFileListResponse data, response status code and response headers



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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 293

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

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"AppsApi.list_app_files",
    :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: AppsApi#list_app_files\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_apps(opts = {}) ⇒ AppListResponse

List the caller’s prototype apps.

Parameters:

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

    the optional parameters

Returns:



345
346
347
348
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 345

def list_apps(opts = {})
  data, _status_code, _headers = list_apps_with_http_info(opts)
  data
end

#list_apps_with_http_info(opts = {}) ⇒ Array<(AppListResponse, Integer, Hash)>

List the caller&#39;s prototype apps.

Parameters:

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

    the optional parameters

Returns:

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

    AppListResponse data, response status code and response headers



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
387
388
389
390
391
392
393
394
395
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 353

def list_apps_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.list_apps ...'
  end
  # resource path
  local_var_path = '/v1/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']) unless header_params['Accept']

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

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

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

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

  new_options = opts.merge(
    :operation => :"AppsApi.list_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: AppsApi#list_apps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read_app_file(id, path, opts = {}) ⇒ AppFileContentResponse

Read one file inside the app’s project directory. Path is traversal-checked; returns 400 if it escapes project root.

Parameters:

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

    the optional parameters

Returns:



402
403
404
405
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 402

def read_app_file(id, path, opts = {})
  data, _status_code, _headers = read_app_file_with_http_info(id, path, opts)
  data
end

#read_app_file_with_http_info(id, path, opts = {}) ⇒ Array<(AppFileContentResponse, Integer, Hash)>

Read one file inside the app&#39;s project directory. Path is traversal-checked; returns 400 if it escapes project root.

Parameters:

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

    the optional parameters

Returns:

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

    AppFileContentResponse data, response status code and response headers



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
451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 412

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

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

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"AppsApi.read_app_file",
    :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: AppsApi#read_app_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_app(id, update_app_request, opts = {}) ⇒ App

Update an app.

Parameters:

  • id (String)
  • update_app_request (UpdateAppRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



470
471
472
473
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 470

def update_app(id, update_app_request, opts = {})
  data, _status_code, _headers = update_app_with_http_info(id, update_app_request, opts)
  data
end

#update_app_with_http_info(id, update_app_request, opts = {}) ⇒ Array<(App, Integer, Hash)>

Update an app.

Parameters:

  • id (String)
  • update_app_request (UpdateAppRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    App data, response status code and response headers



480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 480

def update_app_with_http_info(id, update_app_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.update_app ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AppsApi.update_app"
  end
  # verify the required parameter 'update_app_request' is set
  if @api_client.config.client_side_validation && update_app_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_app_request' when calling AppsApi.update_app"
  end
  # resource path
  local_var_path = '/v1/apps/{id}'.sub('{id}', CGI.escape(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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

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

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

  new_options = opts.merge(
    :operation => :"AppsApi.update_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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#update_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workspace_create_app(org, workspace, request_body, opts = {}) ⇒ Hash<String, Object>

Parameters:

  • org (String)
  • workspace (String)
  • request_body (Hash<String, Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Hash<String, Object>) 


542
543
544
545
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 542

def workspace_create_app(org, workspace, request_body, opts = {})
  data, _status_code, _headers = workspace_create_app_with_http_info(org, workspace, request_body, opts)
  data
end

#workspace_create_app_with_http_info(org, workspace, request_body, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Returns Hash<String, Object> data, response status code and response headers.

Parameters:

  • org (String)
  • workspace (String)
  • request_body (Hash<String, Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 552

def workspace_create_app_with_http_info(org, workspace, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.workspace_create_app ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling AppsApi.workspace_create_app"
  end
  # verify the required parameter 'workspace' is set
  if @api_client.config.client_side_validation && workspace.nil?
    fail ArgumentError, "Missing the required parameter 'workspace' when calling AppsApi.workspace_create_app"
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling AppsApi.workspace_create_app"
  end
  # resource path
  local_var_path = '/v1/organizations/{org}/workspaces/{workspace}/apps'.sub('{org}', CGI.escape(org.to_s)).sub('{workspace}', CGI.escape(workspace.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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

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

  new_options = opts.merge(
    :operation => :"AppsApi.workspace_create_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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#workspace_create_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workspace_delete_app(org, workspace, id, opts = {}) ⇒ nil

Parameters:

  • org (String)
  • workspace (String)
  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


618
619
620
621
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 618

def workspace_delete_app(org, workspace, id, opts = {})
  workspace_delete_app_with_http_info(org, workspace, id, opts)
  nil
end

#workspace_delete_app_with_http_info(org, workspace, id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • org (String)
  • workspace (String)
  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 628

def workspace_delete_app_with_http_info(org, workspace, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.workspace_delete_app ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling AppsApi.workspace_delete_app"
  end
  # verify the required parameter 'workspace' is set
  if @api_client.config.client_side_validation && workspace.nil?
    fail ArgumentError, "Missing the required parameter 'workspace' when calling AppsApi.workspace_delete_app"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AppsApi.workspace_delete_app"
  end
  # resource path
  local_var_path = '/v1/organizations/{org}/workspaces/{workspace}/apps/{id}'.sub('{org}', CGI.escape(org.to_s)).sub('{workspace}', CGI.escape(workspace.to_s)).sub('{id}', CGI.escape(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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"AppsApi.workspace_delete_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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#workspace_delete_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workspace_get_app(org, workspace, id, opts = {}) ⇒ Hash<String, Object>

Parameters:

  • org (String)
  • workspace (String)
  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Hash<String, Object>) 


689
690
691
692
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 689

def workspace_get_app(org, workspace, id, opts = {})
  data, _status_code, _headers = workspace_get_app_with_http_info(org, workspace, id, opts)
  data
end

#workspace_get_app_with_http_info(org, workspace, id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Returns Hash<String, Object> data, response status code and response headers.

Parameters:

  • org (String)
  • workspace (String)
  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 699

def workspace_get_app_with_http_info(org, workspace, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.workspace_get_app ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling AppsApi.workspace_get_app"
  end
  # verify the required parameter 'workspace' is set
  if @api_client.config.client_side_validation && workspace.nil?
    fail ArgumentError, "Missing the required parameter 'workspace' when calling AppsApi.workspace_get_app"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AppsApi.workspace_get_app"
  end
  # resource path
  local_var_path = '/v1/organizations/{org}/workspaces/{workspace}/apps/{id}'.sub('{org}', CGI.escape(org.to_s)).sub('{workspace}', CGI.escape(workspace.to_s)).sub('{id}', CGI.escape(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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

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

  new_options = opts.merge(
    :operation => :"AppsApi.workspace_get_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: AppsApi#workspace_get_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workspace_list_apps(org, workspace, opts = {}) ⇒ Hash<String, Object>

Parameters:

  • org (String)
  • workspace (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Hash<String, Object>) 


759
760
761
762
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 759

def workspace_list_apps(org, workspace, opts = {})
  data, _status_code, _headers = workspace_list_apps_with_http_info(org, workspace, opts)
  data
end

#workspace_list_apps_with_http_info(org, workspace, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Returns Hash<String, Object> data, response status code and response headers.

Parameters:

  • org (String)
  • workspace (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 768

def workspace_list_apps_with_http_info(org, workspace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.workspace_list_apps ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling AppsApi.workspace_list_apps"
  end
  # verify the required parameter 'workspace' is set
  if @api_client.config.client_side_validation && workspace.nil?
    fail ArgumentError, "Missing the required parameter 'workspace' when calling AppsApi.workspace_list_apps"
  end
  # resource path
  local_var_path = '/v1/organizations/{org}/workspaces/{workspace}/apps'.sub('{org}', CGI.escape(org.to_s)).sub('{workspace}', CGI.escape(workspace.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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

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

  new_options = opts.merge(
    :operation => :"AppsApi.workspace_list_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: AppsApi#workspace_list_apps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#workspace_update_app(org, workspace, id, request_body, opts = {}) ⇒ Hash<String, Object>

Parameters:

  • org (String)
  • workspace (String)
  • id (String)
  • request_body (Hash<String, Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Hash<String, Object>) 


826
827
828
829
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 826

def workspace_update_app(org, workspace, id, request_body, opts = {})
  data, _status_code, _headers = workspace_update_app_with_http_info(org, workspace, id, request_body, opts)
  data
end

#workspace_update_app_with_http_info(org, workspace, id, request_body, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Returns Hash<String, Object> data, response status code and response headers.

Parameters:

  • org (String)
  • workspace (String)
  • id (String)
  • request_body (Hash<String, Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 837

def workspace_update_app_with_http_info(org, workspace, id, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.workspace_update_app ...'
  end
  # verify the required parameter 'org' is set
  if @api_client.config.client_side_validation && org.nil?
    fail ArgumentError, "Missing the required parameter 'org' when calling AppsApi.workspace_update_app"
  end
  # verify the required parameter 'workspace' is set
  if @api_client.config.client_side_validation && workspace.nil?
    fail ArgumentError, "Missing the required parameter 'workspace' when calling AppsApi.workspace_update_app"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AppsApi.workspace_update_app"
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling AppsApi.workspace_update_app"
  end
  # resource path
  local_var_path = '/v1/organizations/{org}/workspaces/{workspace}/apps/{id}'.sub('{org}', CGI.escape(org.to_s)).sub('{workspace}', CGI.escape(workspace.to_s)).sub('{id}', CGI.escape(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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

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

  new_options = opts.merge(
    :operation => :"AppsApi.workspace_update_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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#workspace_update_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#write_app_file(id, write_app_file_request, opts = {}) ⇒ nil

Write one file inside the app’s project directory.

Parameters:

  • id (String)
  • write_app_file_request (WriteAppFileRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


907
908
909
910
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 907

def write_app_file(id, write_app_file_request, opts = {})
  write_app_file_with_http_info(id, write_app_file_request, opts)
  nil
end

#write_app_file_with_http_info(id, write_app_file_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Write one file inside the app&#39;s project directory.

Parameters:

  • id (String)
  • write_app_file_request (WriteAppFileRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
 
# File 'lib/spatio-sdk/api/apps_api.rb', line 917

def write_app_file_with_http_info(id, write_app_file_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AppsApi.write_app_file ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AppsApi.write_app_file"
  end
  # verify the required parameter 'write_app_file_request' is set
  if @api_client.config.client_side_validation && write_app_file_request.nil?
    fail ArgumentError, "Missing the required parameter 'write_app_file_request' when calling AppsApi.write_app_file"
  end
  # resource path
  local_var_path = '/v1/apps/{id}/file'.sub('{id}', CGI.escape(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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"AppsApi.write_app_file",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AppsApi#write_app_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end