Class: RusticiSoftwareCloudV2::XapiApi

Inherits:
Object
  • Object
show all
Defined in:
lib/rustici_software_cloud_v2/api/xapi_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ XapiApi

Returns a new instance of XapiApi.



18
19
20
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 18

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#create_statement_pipe(xapi_statement_pipe, opts = {}) ⇒ StringResultSchema

Create an xAPI statement pipe. Create an xAPI statement pipe.

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 27

def create_statement_pipe(xapi_statement_pipe, opts = {})
  data, _status_code, _headers = create_statement_pipe_with_http_info(xapi_statement_pipe, opts)
  return data
end

#create_statement_pipe_with_http_info(xapi_statement_pipe, opts = {}) ⇒ Array<(StringResultSchema, Fixnum, Hash)>

Create an xAPI statement pipe. Create an xAPI statement pipe.

Parameters:

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

    the optional parameters

Returns:

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

    StringResultSchema data, response status code and response headers



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
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 37

def create_statement_pipe_with_http_info(xapi_statement_pipe, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: XapiApi.create_statement_pipe ..."
  end
  # verify the required parameter 'xapi_statement_pipe' is set
  fail ArgumentError, "Missing the required parameter 'xapi_statement_pipe' when calling XapiApi.create_statement_pipe" if xapi_statement_pipe.nil?
  # resource path
  local_var_path = "/xapi/statementPipes".sub('{format}','json')

  # 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(xapi_statement_pipe)
  auth_names = ['APP_NORMAL', 'OAUTH']
  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 => 'StringResultSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: XapiApi#create_statement_pipe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_xapi_credential(xapi_credential, opts = {}) ⇒ StringResultSchema

Create a xAPI credential. Create a xAPI credential.

Parameters:

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

    the optional parameters

Returns:



80
81
82
83
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 80

def create_xapi_credential(xapi_credential, opts = {})
  data, _status_code, _headers = create_xapi_credential_with_http_info(xapi_credential, opts)
  return data
end

#create_xapi_credential_with_http_info(xapi_credential, opts = {}) ⇒ Array<(StringResultSchema, Fixnum, Hash)>

Create a xAPI credential. Create a xAPI credential.

Parameters:

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

    the optional parameters

Returns:

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

    StringResultSchema data, response status code and response headers



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
121
122
123
124
125
126
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 90

def create_xapi_credential_with_http_info(xapi_credential, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: XapiApi.create_xapi_credential ..."
  end
  # verify the required parameter 'xapi_credential' is set
  fail ArgumentError, "Missing the required parameter 'xapi_credential' when calling XapiApi.create_xapi_credential" if xapi_credential.nil?
  # resource path
  local_var_path = "/xapi/credentials".sub('{format}','json')

  # 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(xapi_credential)
  auth_names = ['APP_NORMAL', 'OAUTH']
  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 => 'StringResultSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: XapiApi#create_xapi_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_statement_pipe(statement_pipe_id, opts = {}) ⇒ nil

Deletes this xAPI pipe. Caution: avoid re-creating a pipe with the same ID quickly after a delete. The old version could still be processing, in which case the new pipe could be updated improperly by the processor.

Parameters:

  • statement_pipe_id —

    id for this xAPI statement pipe

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

    the optional parameters

Returns:

  • (nil) 


133
134
135
136
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 133

def delete_statement_pipe(statement_pipe_id, opts = {})
  delete_statement_pipe_with_http_info(statement_pipe_id, opts)
  return nil
end

#delete_statement_pipe_with_http_info(statement_pipe_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Deletes this xAPI pipe. Caution: avoid re-creating a pipe with the same ID quickly after a delete. The old version could still be processing, in which case the new pipe could be updated improperly by the processor.

Parameters:

  • statement_pipe_id —

    id for this xAPI statement pipe

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
175
176
177
178
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 143

def delete_statement_pipe_with_http_info(statement_pipe_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: XapiApi.delete_statement_pipe ..."
  end
  # verify the required parameter 'statement_pipe_id' is set
  fail ArgumentError, "Missing the required parameter 'statement_pipe_id' when calling XapiApi.delete_statement_pipe" if statement_pipe_id.nil?
  # resource path
  local_var_path = "/xapi/statementPipes/{statementPipeId}".sub('{format}','json').sub('{' + 'statementPipeId' + '}', statement_pipe_id.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 = ['APP_NORMAL', 'OAUTH']
  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: XapiApi#delete_statement_pipe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_xapi_credential(xapi_credential_id, opts = {}) ⇒ nil

Deletes the xAPI credentials specified by the xAPI credentials id Deletes the xAPI credentials specified by the xAPI credentials id

Parameters:

  • xapi_credential_id —

    id for this xAPI credential

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

    the optional parameters

Returns:

  • (nil) 


185
186
187
188
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 185

def delete_xapi_credential(xapi_credential_id, opts = {})
  delete_xapi_credential_with_http_info(xapi_credential_id, opts)
  return nil
end

#delete_xapi_credential_with_http_info(xapi_credential_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Deletes the xAPI credentials specified by the xAPI credentials id Deletes the xAPI credentials specified by the xAPI credentials id

Parameters:

  • xapi_credential_id —

    id for this xAPI credential

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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/rustici_software_cloud_v2/api/xapi_api.rb', line 195

def delete_xapi_credential_with_http_info(xapi_credential_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: XapiApi.delete_xapi_credential ..."
  end
  # verify the required parameter 'xapi_credential_id' is set
  fail ArgumentError, "Missing the required parameter 'xapi_credential_id' when calling XapiApi.delete_xapi_credential" if xapi_credential_id.nil?
  # resource path
  local_var_path = "/xapi/credentials/{xapiCredentialId}".sub('{format}','json').sub('{' + 'xapiCredentialId' + '}', xapi_credential_id.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 = ['APP_NORMAL', 'OAUTH']
  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: XapiApi#delete_xapi_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_statement_pipe(statement_pipe_id, opts = {}) ⇒ XapiStatementPipeSchema

Retrieves xAPI pipe for ‘xapiPipeId` Retrieves xAPI pipe for `xapiPipeId`

Parameters:

  • statement_pipe_id —

    id for this xAPI statement pipe

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

    the optional parameters

Returns:



237
238
239
240
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 237

def get_statement_pipe(statement_pipe_id, opts = {})
  data, _status_code, _headers = get_statement_pipe_with_http_info(statement_pipe_id, opts)
  return data
end

#get_statement_pipe_with_http_info(statement_pipe_id, opts = {}) ⇒ Array<(XapiStatementPipeSchema, Fixnum, Hash)>

Retrieves xAPI pipe for &#x60;xapiPipeId&#x60; Retrieves xAPI pipe for &#x60;xapiPipeId&#x60;

Parameters:

  • statement_pipe_id —

    id for this xAPI statement pipe

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

    the optional parameters

Returns:

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

    XapiStatementPipeSchema data, response status code and response headers



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
279
280
281
282
283
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 247

def get_statement_pipe_with_http_info(statement_pipe_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: XapiApi.get_statement_pipe ..."
  end
  # verify the required parameter 'statement_pipe_id' is set
  fail ArgumentError, "Missing the required parameter 'statement_pipe_id' when calling XapiApi.get_statement_pipe" if statement_pipe_id.nil?
  # resource path
  local_var_path = "/xapi/statementPipes/{statementPipeId}".sub('{format}','json').sub('{' + 'statementPipeId' + '}', statement_pipe_id.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 = ['APP_NORMAL', 'OAUTH']
  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 => 'XapiStatementPipeSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: XapiApi#get_statement_pipe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_statement_pipes(opts = {}) ⇒ XapiStatementPipeListSchema

Get all of the xapiPipes for ‘appId` Get all of the xapiPipes for `appId`

Parameters:

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

    the optional parameters

Returns:



289
290
291
292
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 289

def get_statement_pipes(opts = {})
  data, _status_code, _headers = get_statement_pipes_with_http_info(opts)
  return data
end

#get_statement_pipes_with_http_info(opts = {}) ⇒ Array<(XapiStatementPipeListSchema, Fixnum, Hash)>

Get all of the xapiPipes for &#x60;appId&#x60; Get all of the xapiPipes for &#x60;appId&#x60;

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 298

def get_statement_pipes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: XapiApi.get_statement_pipes ..."
  end
  # resource path
  local_var_path = "/xapi/statementPipes".sub('{format}','json')

  # 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 = ['APP_NORMAL', 'OAUTH']
  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 => 'XapiStatementPipeListSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: XapiApi#get_statement_pipes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_xapi_credential(xapi_credential_id, opts = {}) ⇒ XapiCredentialSchema

Retrieves the xAPI credentials specified by the xAPI credentials id. Retrieves the xAPI credentials specified by the xAPI credentials id.

Parameters:

  • xapi_credential_id —

    id for this xAPI credential

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

    the optional parameters

Returns:



339
340
341
342
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 339

def get_xapi_credential(xapi_credential_id, opts = {})
  data, _status_code, _headers = get_xapi_credential_with_http_info(xapi_credential_id, opts)
  return data
end

#get_xapi_credential_with_http_info(xapi_credential_id, opts = {}) ⇒ Array<(XapiCredentialSchema, Fixnum, Hash)>

Retrieves the xAPI credentials specified by the xAPI credentials id. Retrieves the xAPI credentials specified by the xAPI credentials id.

Parameters:

  • xapi_credential_id —

    id for this xAPI credential

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

    the optional parameters

Returns:

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

    XapiCredentialSchema data, response status code and response headers



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
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 349

def get_xapi_credential_with_http_info(xapi_credential_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: XapiApi.get_xapi_credential ..."
  end
  # verify the required parameter 'xapi_credential_id' is set
  fail ArgumentError, "Missing the required parameter 'xapi_credential_id' when calling XapiApi.get_xapi_credential" if xapi_credential_id.nil?
  # resource path
  local_var_path = "/xapi/credentials/{xapiCredentialId}".sub('{format}','json').sub('{' + 'xapiCredentialId' + '}', xapi_credential_id.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 = ['APP_NORMAL', 'OAUTH']
  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 => 'XapiCredentialSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: XapiApi#get_xapi_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_xapi_credentials(opts = {}) ⇒ XapiCredentialsListSchema

Get the list of xapiCredentials Get the list of xapiCredentials

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime) —

    Only &lt;&lt;resourcePathName&gt;&gt; updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of &lt;&lt;resourcePathName&gt;&gt; lists, where needed. An opaque value, construction and parsing may change without notice.

Returns:



393
394
395
396
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 393

def get_xapi_credentials(opts = {})
  data, _status_code, _headers = get_xapi_credentials_with_http_info(opts)
  return data
end

#get_xapi_credentials_with_http_info(opts = {}) ⇒ Array<(XapiCredentialsListSchema, Fixnum, Hash)>

Get the list of xapiCredentials Get the list of xapiCredentials

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :since (DateTime) —

    Only &lt;&lt;resourcePathName&gt;&gt; updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of &lt;&lt;resourcePathName&gt;&gt; lists, where needed. An opaque value, construction and parsing may change without notice.

Returns:

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

    XapiCredentialsListSchema 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
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 404

def get_xapi_credentials_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: XapiApi.get_xapi_credentials ..."
  end
  # resource path
  local_var_path = "/xapi/credentials".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].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 = ['APP_NORMAL', 'OAUTH']
  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 => 'XapiCredentialsListSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: XapiApi#get_xapi_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_statement_pipe(statement_pipe_id, xapi_statement_pipe, opts = {}) ⇒ StringResultSchema

Edit an existing xAPI pipe or create a new one. Editing a pipe will cause it to start over and forward any statements it finds, even if the prior version of the pipe had already forwarded those statements. If the pipe being edited is currently being processed, the this request will fail with a status code of 409.

Parameters:

  • statement_pipe_id —

    id for this xAPI statement pipe

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

    the optional parameters

Returns:



448
449
450
451
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 448

def set_statement_pipe(statement_pipe_id, xapi_statement_pipe, opts = {})
  data, _status_code, _headers = set_statement_pipe_with_http_info(statement_pipe_id, xapi_statement_pipe, opts)
  return data
end

#set_statement_pipe_with_http_info(statement_pipe_id, xapi_statement_pipe, opts = {}) ⇒ Array<(StringResultSchema, Fixnum, Hash)>

Edit an existing xAPI pipe or create a new one. Editing a pipe will cause it to start over and forward any statements it finds, even if the prior version of the pipe had already forwarded those statements. If the pipe being edited is currently being processed, the this request will fail with a status code of 409.

Parameters:

  • statement_pipe_id —

    id for this xAPI statement pipe

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

    the optional parameters

Returns:

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

    StringResultSchema data, response status code and response headers



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 459

def set_statement_pipe_with_http_info(statement_pipe_id, xapi_statement_pipe, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: XapiApi.set_statement_pipe ..."
  end
  # verify the required parameter 'statement_pipe_id' is set
  fail ArgumentError, "Missing the required parameter 'statement_pipe_id' when calling XapiApi.set_statement_pipe" if statement_pipe_id.nil?
  # verify the required parameter 'xapi_statement_pipe' is set
  fail ArgumentError, "Missing the required parameter 'xapi_statement_pipe' when calling XapiApi.set_statement_pipe" if xapi_statement_pipe.nil?
  # resource path
  local_var_path = "/xapi/statementPipes/{statementPipeId}".sub('{format}','json').sub('{' + 'statementPipeId' + '}', statement_pipe_id.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(xapi_statement_pipe)
  auth_names = ['APP_NORMAL', 'OAUTH']
  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 => 'StringResultSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: XapiApi#set_statement_pipe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_xapi_credential(xapi_credential_id, xapi_credential, opts = {}) ⇒ nil

Edit an existing xAPI credential or create a new one, specified by the xAPI credentials id Edit an existing xAPI credential or create a new one, specified by the xAPI credentials id

Parameters:

  • xapi_credential_id —

    id for this xAPI credential

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

    the optional parameters

Returns:

  • (nil) 


505
506
507
508
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 505

def set_xapi_credential(xapi_credential_id, xapi_credential, opts = {})
  set_xapi_credential_with_http_info(xapi_credential_id, xapi_credential, opts)
  return nil
end

#set_xapi_credential_with_http_info(xapi_credential_id, xapi_credential, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Edit an existing xAPI credential or create a new one, specified by the xAPI credentials id Edit an existing xAPI credential or create a new one, specified by the xAPI credentials id

Parameters:

  • xapi_credential_id —

    id for this xAPI credential

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/rustici_software_cloud_v2/api/xapi_api.rb', line 516

def set_xapi_credential_with_http_info(xapi_credential_id, xapi_credential, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: XapiApi.set_xapi_credential ..."
  end
  # verify the required parameter 'xapi_credential_id' is set
  fail ArgumentError, "Missing the required parameter 'xapi_credential_id' when calling XapiApi.set_xapi_credential" if xapi_credential_id.nil?
  # verify the required parameter 'xapi_credential' is set
  fail ArgumentError, "Missing the required parameter 'xapi_credential' when calling XapiApi.set_xapi_credential" if xapi_credential.nil?
  # resource path
  local_var_path = "/xapi/credentials/{xapiCredentialId}".sub('{format}','json').sub('{' + 'xapiCredentialId' + '}', xapi_credential_id.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(xapi_credential)
  auth_names = ['APP_NORMAL', 'OAUTH']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: XapiApi#set_xapi_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end