Class: Spatio::ActionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/spatio-sdk/api/actions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ActionsApi

Returns a new instance of ActionsApi.



19
20
21
 
# File 'lib/spatio-sdk/api/actions_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/actions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#execute_action(execute_action_request, opts = {}) ⇒ ExecuteActionResponse

Renderer-side execute alias. The canonical endpoint is ‘POST /v1/agent/actions/execute`; this path delegates to the same handler.

Parameters:

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

    the optional parameters

Returns:



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

def execute_action(execute_action_request, opts = {})
  data, _status_code, _headers = execute_action_with_http_info(execute_action_request, opts)
  data
end

#execute_action_with_http_info(execute_action_request, opts = {}) ⇒ Array<(ExecuteActionResponse, Integer, Hash)>

Renderer-side execute alias. The canonical endpoint is &#x60;POST /v1/agent/actions/execute&#x60;; this path delegates to the same handler.

Parameters:

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

    the optional parameters

Returns:

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

    ExecuteActionResponse 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/actions_api.rb', line 35

def execute_action_with_http_info(execute_action_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionsApi.execute_action ...'
  end
  # verify the required parameter 'execute_action_request' is set
  if @api_client.config.client_side_validation && execute_action_request.nil?
    fail ArgumentError, "Missing the required parameter 'execute_action_request' when calling ActionsApi.execute_action"
  end
  # resource path
  local_var_path = '/v1/actions/execute'

  # 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(execute_action_request)

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

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

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

#get_core_action(id, opts = {}) ⇒ CoreAction

Fetch a single core action by id.

Parameters:

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

    the optional parameters

Returns:



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

def get_core_action(id, opts = {})
  data, _status_code, _headers = get_core_action_with_http_info(id, opts)
  data
end

#get_core_action_with_http_info(id, opts = {}) ⇒ Array<(CoreAction, Integer, Hash)>

Fetch a single core action by id.

Parameters:

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

    the optional parameters

Returns:

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

    CoreAction data, 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/actions_api.rb', line 101

def get_core_action_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionsApi.get_core_action ...'
  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 ActionsApi.get_core_action"
  end
  # resource path
  local_var_path = '/v1/actions/core/{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] || 'CoreAction'

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

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

#list_available_actions(opts = {}) ⇒ Array<ActionDescriptor>

List every action the agent platform exposes.

Parameters:

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

    the optional parameters

Returns:



152
153
154
155
 
# File 'lib/spatio-sdk/api/actions_api.rb', line 152

def list_available_actions(opts = {})
  data, _status_code, _headers = list_available_actions_with_http_info(opts)
  data
end

#list_available_actions_with_http_info(opts = {}) ⇒ Array<(Array<ActionDescriptor>, Integer, Hash)>

List every action the agent platform exposes.

Parameters:

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

    the optional parameters

Returns:

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

    Array<ActionDescriptor> data, response status code and response headers



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
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/spatio-sdk/api/actions_api.rb', line 160

def list_available_actions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionsApi.list_available_actions ...'
  end
  # resource path
  local_var_path = '/v1/actions/available'

  # 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] || 'Array<ActionDescriptor>'

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

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

#list_core_actions(opts = {}) ⇒ CoreActionListResponse

List renderer-curated "core actions" (command-palette + keybindings backing).

Parameters:

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

    the optional parameters

Returns:



207
208
209
210
 
# File 'lib/spatio-sdk/api/actions_api.rb', line 207

def list_core_actions(opts = {})
  data, _status_code, _headers = list_core_actions_with_http_info(opts)
  data
end

#list_core_actions_by_platform(platform, opts = {}) ⇒ CoreActionListResponse

Core actions filtered to one platform.

Parameters:

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

    the optional parameters

Returns:



263
264
265
266
 
# File 'lib/spatio-sdk/api/actions_api.rb', line 263

def list_core_actions_by_platform(platform, opts = {})
  data, _status_code, _headers = list_core_actions_by_platform_with_http_info(platform, opts)
  data
end

#list_core_actions_by_platform_with_http_info(platform, opts = {}) ⇒ Array<(CoreActionListResponse, Integer, Hash)>

Core actions filtered to one platform.

Parameters:

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

    the optional parameters

Returns:

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

    CoreActionListResponse data, response status code and response headers



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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/spatio-sdk/api/actions_api.rb', line 272

def list_core_actions_by_platform_with_http_info(platform, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionsApi.list_core_actions_by_platform ...'
  end
  # verify the required parameter 'platform' is set
  if @api_client.config.client_side_validation && platform.nil?
    fail ArgumentError, "Missing the required parameter 'platform' when calling ActionsApi.list_core_actions_by_platform"
  end
  # resource path
  local_var_path = '/v1/actions/core/platform/{platform}'.sub('{platform}', CGI.escape(platform.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] || 'CoreActionListResponse'

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

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

#list_core_actions_with_http_info(opts = {}) ⇒ Array<(CoreActionListResponse, Integer, Hash)>

List renderer-curated &quot;core actions&quot; (command-palette + keybindings backing).

Parameters:

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

    the optional parameters

Returns:

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

    CoreActionListResponse data, response status code and response headers



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
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/spatio-sdk/api/actions_api.rb', line 215

def list_core_actions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionsApi.list_core_actions ...'
  end
  # resource path
  local_var_path = '/v1/actions/core'

  # 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] || 'CoreActionListResponse'

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

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

#list_platform_actions(platform, opts = {}) ⇒ Array<ActionDescriptor>

List actions tagged for a specific platform (notes, mail, …).

Parameters:

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

    the optional parameters

Returns:



324
325
326
327
 
# File 'lib/spatio-sdk/api/actions_api.rb', line 324

def list_platform_actions(platform, opts = {})
  data, _status_code, _headers = list_platform_actions_with_http_info(platform, opts)
  data
end

#list_platform_actions_with_http_info(platform, opts = {}) ⇒ Array<(Array<ActionDescriptor>, Integer, Hash)>

List actions tagged for a specific platform (notes, mail, …).

Parameters:

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

    the optional parameters

Returns:

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

    Array<ActionDescriptor> data, response status code and response headers



333
334
335
336
337
338
339
340
341
342
343
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
 
# File 'lib/spatio-sdk/api/actions_api.rb', line 333

def list_platform_actions_with_http_info(platform, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ActionsApi.list_platform_actions ...'
  end
  # verify the required parameter 'platform' is set
  if @api_client.config.client_side_validation && platform.nil?
    fail ArgumentError, "Missing the required parameter 'platform' when calling ActionsApi.list_platform_actions"
  end
  # resource path
  local_var_path = '/v1/actions/platform/{platform}'.sub('{platform}', CGI.escape(platform.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] || 'Array<ActionDescriptor>'

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

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