Class: RusticiSoftwareCloudV2::ApplicationManagementApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ApplicationManagementApi

Returns a new instance of ApplicationManagementApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_application(application_request, opts = {}) ⇒ ApplicationSchema

Use the Application Management App to create a new Application Creates an application. Applications are how resources are grouped together in SCORM Cloud. Any courses, registrations, etc. will only be accessible via the credentials for the application they belong to. >Note: >Application IDs are unique in that we do not allow the user to supply a custom value for this field. The ID of the newly created application will be specified in the response from this method. >Note: >Each Realm has a special application called the **Application Management Application**. When using this special application’s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn’t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.

Parameters:

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

    the optional parameters

Returns:



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

def create_application(application_request, opts = {})
  data, _status_code, _headers = create_application_with_http_info(application_request, opts)
  data
end

#create_application_with_http_info(application_request, opts = {}) ⇒ Array<(ApplicationSchema, Fixnum, Hash)>

Use the Application Management App to create a new Application Creates an application. Applications are how resources are grouped together in SCORM Cloud. Any courses, registrations, etc. will only be accessible via the credentials for the application they belong to. &gt;Note: &gt;Application IDs are unique in that we do not allow the user to supply a custom value for this field. The ID of the newly created application will be specified in the response from this method. &gt;Note: &gt;Each Realm has a special application called the **Application Management Application**. When using this special application&#39;s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn&#39;t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.

Parameters:

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

    the optional parameters

Returns:

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

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

def create_application_with_http_info(application_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_application ...'
  end
  # verify the required parameter 'application_request' is set
  if application_request.nil?
    fail ArgumentError, "Missing the required parameter 'application_request' when calling ApplicationManagementApi.create_application"
  end
  # resource path
  local_var_path = '/appManagement/applications'

  # 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(application_request)
  auth_names = ['APP_MANAGEMENT', '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 => 'ApplicationSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApplicationManagementApi#create_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_credential(child_app_id, credential_request, opts = {}) ⇒ CredentialCreatedSchema

Use the Application Manager App to create a new secret key for an Application Creates a new credential (aka secret key) for use with the child application. The credential will be used alongside the ‘childAppId` for basic auth requests. >Note: >Each Realm has a special application called the **Application Management Application**. When using this special application’s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn’t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.

Parameters:

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

    the optional parameters

Returns:



82
83
84
85
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 82

def create_credential(child_app_id, credential_request, opts = {})
  data, _status_code, _headers = create_credential_with_http_info(child_app_id, credential_request, opts)
  data
end

#create_credential_with_http_info(child_app_id, credential_request, opts = {}) ⇒ Array<(CredentialCreatedSchema, Fixnum, Hash)>

Use the Application Manager App to create a new secret key for an Application Creates a new credential (aka secret key) for use with the child application. The credential will be used alongside the &#x60;childAppId&#x60; for basic auth requests. &gt;Note: &gt;Each Realm has a special application called the **Application Management Application**. When using this special application&#39;s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn&#39;t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.

Parameters:

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

    the optional parameters

Returns:

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

    CredentialCreatedSchema data, response status code and response headers



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 93

def create_credential_with_http_info(child_app_id, credential_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_credential ...'
  end
  # verify the required parameter 'child_app_id' is set
  if child_app_id.nil?
    fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.create_credential"
  end
  # verify the required parameter 'credential_request' is set
  if credential_request.nil?
    fail ArgumentError, "Missing the required parameter 'credential_request' when calling ApplicationManagementApi.create_credential"
  end
  # resource path
  local_var_path = '/appManagement/{childAppId}/credentials'.sub('{' + 'childAppId' + '}', child_app_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(credential_request)
  auth_names = ['APP_MANAGEMENT', '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 => 'CredentialCreatedSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApplicationManagementApi#create_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_token(token_request, opts = {}) ⇒ StringResultSchema

Obtain an OAuth token for scoped access to an Application Creates, signs and returns an OAuth2 token based on the provided permissions, if the credentials used to request the token have the permissions being requested. >Note: >The token is not stored and therefore can not be modified or deleted. The requested permissions are encoded in the token which is then signed.

Parameters:

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

    the optional parameters

Returns:



141
142
143
144
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 141

def create_token(token_request, opts = {})
  data, _status_code, _headers = create_token_with_http_info(token_request, opts)
  data
end

#create_token_with_http_info(token_request, opts = {}) ⇒ Array<(StringResultSchema, Fixnum, Hash)>

Obtain an OAuth token for scoped access to an Application Creates, signs and returns an OAuth2 token based on the provided permissions, if the credentials used to request the token have the permissions being requested. &gt;Note: &gt;The token is not stored and therefore can not be modified or deleted. The requested permissions are encoded in the token which is then signed.

Parameters:

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

    the optional parameters

Returns:

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

    StringResultSchema data, response status code and response headers



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 151

def create_token_with_http_info(token_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_token ...'
  end
  # verify the required parameter 'token_request' is set
  if token_request.nil?
    fail ArgumentError, "Missing the required parameter 'token_request' when calling ApplicationManagementApi.create_token"
  end
  # resource path
  local_var_path = '/appManagement/token'

  # 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(token_request)
  auth_names = ['APP_NORMAL']
  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: ApplicationManagementApi#create_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_application(child_app_id, opts = {}) ⇒ nil

Use the Application Management App to delete an Application Deletes the specified application. All content within an application must be removed in order to allow deletion. >Note: >Each Realm has a special application called the **Application Management Application**. When using this special application’s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn’t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


195
196
197
198
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 195

def delete_application(child_app_id, opts = {})
  delete_application_with_http_info(child_app_id, opts)
  nil
end

#delete_application_configuration_setting(setting_id, opts = {}) ⇒ nil

Delete a configuration setting explicitly set for an Application Clears the specified setting from the application. This causes the setting to inherit a value from a higher level (e.g. system default if deleting from application, application level if deleting from learning standard). If the configuration setting was not set at the application level it will continue to persist and will require deletion from the level it was set.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :learning_standard (String) —

    If specified, the request will be scoped to the provided learning standard.

  • :single_sco (BOOLEAN) —

    Required if &#x60;learningStandard&#x60; is specified. Scopes settings to either single or multi-SCO content.

Returns:

  • (nil) 


250
251
252
253
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 250

def delete_application_configuration_setting(setting_id, opts = {})
  delete_application_configuration_setting_with_http_info(setting_id, opts)
  nil
end

#delete_application_configuration_setting_with_http_info(setting_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a configuration setting explicitly set for an Application Clears the specified setting from the application. This causes the setting to inherit a value from a higher level (e.g. system default if deleting from application, application level if deleting from learning standard). If the configuration setting was not set at the application level it will continue to persist and will require deletion from the level it was set.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :learning_standard (String) —

    If specified, the request will be scoped to the provided learning standard.

  • :single_sco (BOOLEAN) —

    Required if &#x60;learningStandard&#x60; is specified. Scopes settings to either single or multi-SCO content.

Returns:

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

    nil, response status code and response headers



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

def delete_application_configuration_setting_with_http_info(setting_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.delete_application_configuration_setting ...'
  end
  # verify the required parameter 'setting_id' is set
  if setting_id.nil?
    fail ArgumentError, "Missing the required parameter 'setting_id' when calling ApplicationManagementApi.delete_application_configuration_setting"
  end
  # resource path
  local_var_path = '/appManagement/configuration/{settingId}'.sub('{' + 'settingId' + '}', setting_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'learningStandard'] = opts[:'learning_standard'] if !opts[:'learning_standard'].nil?
  query_params[:'singleSco'] = opts[:'single_sco'] if !opts[:'single_sco'].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(: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: ApplicationManagementApi#delete_application_configuration_setting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_application_with_http_info(child_app_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Use the Application Management App to delete an Application Deletes the specified application. All content within an application must be removed in order to allow deletion. &gt;Note: &gt;Each Realm has a special application called the **Application Management Application**. When using this special application&#39;s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn&#39;t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 205

def delete_application_with_http_info(child_app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.delete_application ...'
  end
  # verify the required parameter 'child_app_id' is set
  if child_app_id.nil?
    fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.delete_application"
  end
  # resource path
  local_var_path = '/appManagement/applications/{childAppId}'.sub('{' + 'childAppId' + '}', child_app_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_MANAGEMENT', '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: ApplicationManagementApi#delete_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_credential(child_app_id, credential_id, opts = {}) ⇒ nil

Use the Application Management App to delete a secret key from an Application Deletes a credential belonging to the child application. >Caution: >If the last secret key for an application is deleted it will not be able to use the SCORM Cloud API until another key is granted to it via ‘CreateCredential`. It may also disable some website privileges. >Note: >Each Realm has a special application called the **Application Management Application**. When using this special application’s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn’t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


308
309
310
311
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 308

def delete_credential(child_app_id, credential_id, opts = {})
  delete_credential_with_http_info(child_app_id, credential_id, opts)
  nil
end

#delete_credential_with_http_info(child_app_id, credential_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Use the Application Management App to delete a secret key from an Application Deletes a credential belonging to the child application. &gt;Caution: &gt;If the last secret key for an application is deleted it will not be able to use the SCORM Cloud API until another key is granted to it via &#x60;CreateCredential&#x60;. It may also disable some website privileges. &gt;Note: &gt;Each Realm has a special application called the **Application Management Application**. When using this special application&#39;s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn&#39;t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



319
320
321
322
323
324
325
326
327
328
329
330
331
332
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
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 319

def delete_credential_with_http_info(child_app_id, credential_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.delete_credential ...'
  end
  # verify the required parameter 'child_app_id' is set
  if child_app_id.nil?
    fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.delete_credential"
  end
  # verify the required parameter 'credential_id' is set
  if credential_id.nil?
    fail ArgumentError, "Missing the required parameter 'credential_id' when calling ApplicationManagementApi.delete_credential"
  end
  # resource path
  local_var_path = '/appManagement/{childAppId}/credentials/{credentialId}'.sub('{' + 'childAppId' + '}', child_app_id.to_s).sub('{' + 'credentialId' + '}', 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_MANAGEMENT', '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: ApplicationManagementApi#delete_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_application_configuration(opts = {}) ⇒ SettingListSchema

Get effective configuration settings for an Application Returns the effective configuration settings for the application. Configuration settings at the application level will apply to all items within that application (courses, registrations, etc.). If there is a configuration setting present at a more specific level (course, registration, etc.), that setting will override the one set at the application level. >Note: >This resource lists configuration for two groupings of content: >- ALL content in an application. This is achieved by leaving ‘learningStandard` and `singleSco` as `null`. Anything set at the learningStandard/singleSco level will take precedence over these settings. >- Content falling into a learningStandard/singleSco category. This allows setting more specific defaults for a particular learningStandard/singleSco combination. _Note: both `learningStandard` and `singleSco` must be provided, as this level is considered to be identified by those items joined._

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :learning_standard (String) —

    If specified, the request will be scoped to the provided learning standard.

  • :single_sco (BOOLEAN) —

    Required if &#x60;learningStandard&#x60; is specified. Scopes settings to either single or multi-SCO content.

  • :include_metadata (BOOLEAN) — default: default to false

Returns:



368
369
370
371
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 368

def get_application_configuration(opts = {})
  data, _status_code, _headers = get_application_configuration_with_http_info(opts)
  data
end

#get_application_configuration_with_http_info(opts = {}) ⇒ Array<(SettingListSchema, Fixnum, Hash)>

Get effective configuration settings for an Application Returns the effective configuration settings for the application. Configuration settings at the application level will apply to all items within that application (courses, registrations, etc.). If there is a configuration setting present at a more specific level (course, registration, etc.), that setting will override the one set at the application level. &gt;Note: &gt;This resource lists configuration for two groupings of content: &gt;- ALL content in an application. This is achieved by leaving &#x60;learningStandard&#x60; and &#x60;singleSco&#x60; as &#x60;null&#x60;. Anything set at the learningStandard/singleSco level will take precedence over these settings. &gt;- Content falling into a learningStandard/singleSco category. This allows setting more specific defaults for a particular learningStandard/singleSco combination. _Note: both &#x60;learningStandard&#x60; and &#x60;singleSco&#x60; must be provided, as this level is considered to be identified by those items joined._

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :learning_standard (String) —

    If specified, the request will be scoped to the provided learning standard.

  • :single_sco (BOOLEAN) —

    Required if &#x60;learningStandard&#x60; is specified. Scopes settings to either single or multi-SCO content.

  • :include_metadata (BOOLEAN)

Returns:

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

    SettingListSchema data, response status code and response headers



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 380

def get_application_configuration_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_application_configuration ...'
  end
  # resource path
  local_var_path = '/appManagement/configuration'

  # query parameters
  query_params = {}
  query_params[:'learningStandard'] = opts[:'learning_standard'] if !opts[:'learning_standard'].nil?
  query_params[:'singleSco'] = opts[:'single_sco'] if !opts[:'single_sco'].nil?
  query_params[:'includeMetadata'] = opts[:'include_metadata'] if !opts[:'include_metadata'].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 => 'SettingListSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApplicationManagementApi#get_application_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_application_info(child_app_id, opts = {}) ⇒ ApplicationInfoSchema

Use the Application Management App to get detailed information about an Application Returns detailed information about the application. This includes name, create date, and delete permissions. >Note: >Each Realm has a special application called the **Application Management Application**. When using this special application’s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn’t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_course_count (BOOLEAN) —

    Include a count of courses for the application. (default to false)

  • :include_registration_count (BOOLEAN) —

    Include a count of registrations created for the application during the current billing period. (default to false)

Returns:



425
426
427
428
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 425

def get_application_info(child_app_id, opts = {})
  data, _status_code, _headers = get_application_info_with_http_info(child_app_id, opts)
  data
end

#get_application_info_with_http_info(child_app_id, opts = {}) ⇒ Array<(ApplicationInfoSchema, Fixnum, Hash)>

Use the Application Management App to get detailed information about an Application Returns detailed information about the application. This includes name, create date, and delete permissions. &gt;Note: &gt;Each Realm has a special application called the **Application Management Application**. When using this special application&#39;s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn&#39;t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_course_count (BOOLEAN) —

    Include a count of courses for the application.

  • :include_registration_count (BOOLEAN) —

    Include a count of registrations created for the application during the current billing period.

Returns:

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

    ApplicationInfoSchema data, response status code and response headers



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
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 437

def get_application_info_with_http_info(child_app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_application_info ...'
  end
  # verify the required parameter 'child_app_id' is set
  if child_app_id.nil?
    fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.get_application_info"
  end
  # resource path
  local_var_path = '/appManagement/applications/{childAppId}'.sub('{' + 'childAppId' + '}', child_app_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeCourseCount'] = opts[:'include_course_count'] if !opts[:'include_course_count'].nil?
  query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].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_MANAGEMENT', '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 => 'ApplicationInfoSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApplicationManagementApi#get_application_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_application_list(opts = {}) ⇒ ApplicationListSchema

Use the Application Management App to get a list of Applications Returns a list of all applications which are in this Realm. >Note: >Each Realm has a special application called the **Application Management Application**. When using this special application’s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn’t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.

Parameters:

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

    the optional parameters

Returns:



482
483
484
485
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 482

def get_application_list(opts = {})
  data, _status_code, _headers = get_application_list_with_http_info(opts)
  data
end

#get_application_list_with_http_info(opts = {}) ⇒ Array<(ApplicationListSchema, Fixnum, Hash)>

Use the Application Management App to get a list of Applications Returns a list of all applications which are in this Realm. &gt;Note: &gt;Each Realm has a special application called the **Application Management Application**. When using this special application&#39;s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn&#39;t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.

Parameters:

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

    the optional parameters

Returns:

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

    ApplicationListSchema data, response status code and response headers



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

def get_application_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_application_list ...'
  end
  # resource path
  local_var_path = '/appManagement/applications'

  # 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_MANAGEMENT', '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 => 'ApplicationListSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApplicationManagementApi#get_application_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_credentials(child_app_id, opts = {}) ⇒ CredentialListSchema

Use the Application Manager App to get a list of secret keys for an Application Returns a list of all the credentials (aka secret keys) belonging to the child application. >Note: >Each Realm has a special application called the **Application Management Application**. When using this special application’s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn’t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.

Parameters:

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

    the optional parameters

Returns:



531
532
533
534
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 531

def get_credentials(child_app_id, opts = {})
  data, _status_code, _headers = get_credentials_with_http_info(child_app_id, opts)
  data
end

#get_credentials_with_http_info(child_app_id, opts = {}) ⇒ Array<(CredentialListSchema, Fixnum, Hash)>

Use the Application Manager App to get a list of secret keys for an Application Returns a list of all the credentials (aka secret keys) belonging to the child application. &gt;Note: &gt;Each Realm has a special application called the **Application Management Application**. When using this special application&#39;s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn&#39;t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.

Parameters:

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

    the optional parameters

Returns:

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

    CredentialListSchema data, response status code and response headers



541
542
543
544
545
546
547
548
549
550
551
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
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 541

def get_credentials_with_http_info(child_app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_credentials ...'
  end
  # verify the required parameter 'child_app_id' is set
  if child_app_id.nil?
    fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.get_credentials"
  end
  # resource path
  local_var_path = '/appManagement/{childAppId}/credentials'.sub('{' + 'childAppId' + '}', child_app_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_MANAGEMENT', '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 => 'CredentialListSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApplicationManagementApi#get_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_application_configuration(configuration_settings, opts = {}) ⇒ nil

Update configuration settings for an Application Updates configuration settings at the application level. This will explicitly set a value at the applicaiton level. These settings will affect all items within the application which do not have their own explicit configuration set. This can effectively be used to set application level defaults.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :learning_standard (String) —

    If specified, the request will be scoped to the provided learning standard.

  • :single_sco (BOOLEAN) —

    Required if &#x60;learningStandard&#x60; is specified. Scopes settings to either single or multi-SCO content.

Returns:

  • (nil) 


587
588
589
590
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 587

def set_application_configuration(configuration_settings, opts = {})
  set_application_configuration_with_http_info(configuration_settings, opts)
  nil
end

#set_application_configuration_with_http_info(configuration_settings, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update configuration settings for an Application Updates configuration settings at the application level. This will explicitly set a value at the applicaiton level. These settings will affect all items within the application which do not have their own explicit configuration set. This can effectively be used to set application level defaults.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :learning_standard (String) —

    If specified, the request will be scoped to the provided learning standard.

  • :single_sco (BOOLEAN) —

    Required if &#x60;learningStandard&#x60; is specified. Scopes settings to either single or multi-SCO content.

Returns:

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

    nil, response status code and response headers



599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 599

def set_application_configuration_with_http_info(configuration_settings, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.set_application_configuration ...'
  end
  # verify the required parameter 'configuration_settings' is set
  if configuration_settings.nil?
    fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling ApplicationManagementApi.set_application_configuration"
  end
  # resource path
  local_var_path = '/appManagement/configuration'

  # query parameters
  query_params = {}
  query_params[:'learningStandard'] = opts[:'learning_standard'] if !opts[:'learning_standard'].nil?
  query_params[:'singleSco'] = opts[:'single_sco'] if !opts[:'single_sco'].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 = @api_client.object_to_http_body(configuration_settings)
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApplicationManagementApi#set_application_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_application(child_app_id, application_properties, opts = {}) ⇒ nil

Use the Application Management App to update information about an Application Updates information about the application, such as the name and enabling/ disabling deletion operations for the application. >Note: >Each Realm has a special application called the **Application Management Application**. When using this special application’s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn’t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


645
646
647
648
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 645

def update_application(child_app_id, application_properties, opts = {})
  update_application_with_http_info(child_app_id, application_properties, opts)
  nil
end

#update_application_with_http_info(child_app_id, application_properties, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Use the Application Management App to update information about an Application Updates information about the application, such as the name and enabling/ disabling deletion operations for the application. &gt;Note: &gt;Each Realm has a special application called the **Application Management Application**. When using this special application&#39;s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn&#39;t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 656

def update_application_with_http_info(child_app_id, application_properties, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.update_application ...'
  end
  # verify the required parameter 'child_app_id' is set
  if child_app_id.nil?
    fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.update_application"
  end
  # verify the required parameter 'application_properties' is set
  if application_properties.nil?
    fail ArgumentError, "Missing the required parameter 'application_properties' when calling ApplicationManagementApi.update_application"
  end
  # resource path
  local_var_path = '/appManagement/applications/{childAppId}'.sub('{' + 'childAppId' + '}', child_app_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(application_properties)
  auth_names = ['APP_MANAGEMENT', '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: ApplicationManagementApi#update_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_credential(child_app_id, credential_id, credential_update, opts = {}) ⇒ nil

Use the Application Manager App to update an existing secret key for an Application Updates the name or status associated with the credential. Disabling a credential will cause it to no longer be valid for authorization through the API. >Caution: >If the last (or only) key for an application is disabled it may affect some website privileges. >Note: >Each Realm has a special application called the **Application Management Application**. When using this special application’s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn’t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.

Parameters:

  • child_app_id
  • credential_id
  • credential_update
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


705
706
707
708
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 705

def update_credential(child_app_id, credential_id, credential_update, opts = {})
  update_credential_with_http_info(child_app_id, credential_id, credential_update, opts)
  nil
end

#update_credential_with_http_info(child_app_id, credential_id, credential_update, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Use the Application Manager App to update an existing secret key for an Application Updates the name or status associated with the credential. Disabling a credential will cause it to no longer be valid for authorization through the API. &gt;Caution: &gt;If the last (or only) key for an application is disabled it may affect some website privileges. &gt;Note: &gt;Each Realm has a special application called the **Application Management Application**. When using this special application&#39;s credentials to authenticate with the API, you are able to perform actions on all the other applications within that Realm (and only those actions, this isn&#39;t a general purpose credential). You can list, add, update, and delete both applications and credentials with this API resource.

Parameters:

  • child_app_id
  • credential_id
  • credential_update
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
754
755
756
757
758
759
760
761
762
 
# File 'lib/rustici_software_cloud_v2/api/application_management_api.rb', line 717

def update_credential_with_http_info(child_app_id, credential_id, credential_update, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.update_credential ...'
  end
  # verify the required parameter 'child_app_id' is set
  if child_app_id.nil?
    fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.update_credential"
  end
  # verify the required parameter 'credential_id' is set
  if credential_id.nil?
    fail ArgumentError, "Missing the required parameter 'credential_id' when calling ApplicationManagementApi.update_credential"
  end
  # verify the required parameter 'credential_update' is set
  if credential_update.nil?
    fail ArgumentError, "Missing the required parameter 'credential_update' when calling ApplicationManagementApi.update_credential"
  end
  # resource path
  local_var_path = '/appManagement/{childAppId}/credentials/{credentialId}'.sub('{' + 'childAppId' + '}', child_app_id.to_s).sub('{' + 'credentialId' + '}', 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(credential_update)
  auth_names = ['APP_MANAGEMENT', '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: ApplicationManagementApi#update_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end