rustici_software_cloud_v2 1.0.0beta → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (287) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +1 -1
  3. data/README.md +354 -243
  4. data/lib/rustici_software_cloud_v2/api/about_api.rb +71 -0
  5. data/lib/rustici_software_cloud_v2/api/application_management_api.rb +253 -63
  6. data/lib/rustici_software_cloud_v2/api/authentication_api.rb +11 -17
  7. data/lib/rustici_software_cloud_v2/api/course_api.rb +910 -160
  8. data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +2236 -0
  9. data/lib/rustici_software_cloud_v2/api/invitations_api.rb +1025 -0
  10. data/lib/rustici_software_cloud_v2/api/learner_api.rb +367 -0
  11. data/lib/rustici_software_cloud_v2/api/ping_api.rb +6 -4
  12. data/lib/rustici_software_cloud_v2/api/registration_api.rb +448 -295
  13. data/lib/rustici_software_cloud_v2/api/reporting_api.rb +191 -0
  14. data/lib/rustici_software_cloud_v2/api/xapi_api.rb +581 -0
  15. data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +528 -0
  16. data/lib/rustici_software_cloud_v2/api_client.rb +5 -5
  17. data/lib/rustici_software_cloud_v2/api_error.rb +2 -2
  18. data/lib/rustici_software_cloud_v2/configuration.rb +11 -20
  19. data/lib/rustici_software_cloud_v2/models/about_schema.rb +194 -0
  20. data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +10 -38
  21. data/lib/rustici_software_cloud_v2/models/application_info_schema.rb +234 -0
  22. data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +5 -3
  23. data/lib/rustici_software_cloud_v2/models/{link_schema.rb → application_request_schema.rb} +14 -16
  24. data/lib/rustici_software_cloud_v2/models/application_schema.rb +5 -3
  25. data/lib/rustici_software_cloud_v2/models/application_token.rb +5 -3
  26. data/lib/rustici_software_cloud_v2/models/asset_file_schema.rb +194 -0
  27. data/lib/rustici_software_cloud_v2/models/{course_tags_batch_schema.rb → batch_tags_schema.rb} +21 -17
  28. data/lib/rustici_software_cloud_v2/models/comment_schema.rb +5 -3
  29. data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +5 -3
  30. data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +7 -31
  31. data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +5 -3
  32. data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +6 -3
  33. data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +5 -3
  34. data/lib/rustici_software_cloud_v2/models/course_schema.rb +7 -31
  35. data/lib/rustici_software_cloud_v2/models/{registration_tags_batch_schema.rb → create_dispatch_id_schema.rb} +25 -25
  36. data/lib/rustici_software_cloud_v2/models/create_dispatch_list_schema.rb +187 -0
  37. data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +306 -0
  38. data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +252 -0
  39. data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +250 -0
  40. data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +5 -3
  41. data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +5 -3
  42. data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +5 -3
  43. data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +5 -3
  44. data/lib/rustici_software_cloud_v2/models/credential_schema.rb +5 -3
  45. data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +195 -0
  46. data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +198 -0
  47. data/lib/rustici_software_cloud_v2/models/destination_schema.rb +227 -0
  48. data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +194 -0
  49. data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +197 -0
  50. data/lib/rustici_software_cloud_v2/models/dispatch_lti_info_schema.rb +221 -0
  51. data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +194 -0
  52. data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +326 -0
  53. data/lib/rustici_software_cloud_v2/models/{tag_post_schema.rb → enabled_schema.rb} +17 -6
  54. data/lib/rustici_software_cloud_v2/models/file_list_item_schema.rb +205 -0
  55. data/lib/rustici_software_cloud_v2/models/file_list_schema.rb +187 -0
  56. data/lib/rustici_software_cloud_v2/models/import_asset_request_schema.rb +207 -0
  57. data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +31 -8
  58. data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +7 -31
  59. data/lib/rustici_software_cloud_v2/models/import_media_file_reference_request_schema.rb +216 -0
  60. data/lib/rustici_software_cloud_v2/models/import_request_schema.rb +195 -0
  61. data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +5 -3
  62. data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +5 -3
  63. data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +214 -0
  64. data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +226 -0
  65. data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +198 -0
  66. data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +225 -0
  67. data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +5 -3
  68. data/lib/rustici_software_cloud_v2/models/launch_auth_options_schema.rb +212 -0
  69. data/lib/rustici_software_cloud_v2/models/launch_auth_schema.rb +204 -0
  70. data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +5 -3
  71. data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +10 -38
  72. data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +25 -9
  73. data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +5 -3
  74. data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +5 -3
  75. data/lib/rustici_software_cloud_v2/models/learner_schema.rb +5 -3
  76. data/lib/rustici_software_cloud_v2/models/media_file_metadata_schema.rb +213 -0
  77. data/lib/rustici_software_cloud_v2/models/message_schema.rb +5 -3
  78. data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +12 -10
  79. data/lib/rustici_software_cloud_v2/models/objective_schema.rb +13 -45
  80. data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +5 -3
  81. data/lib/rustici_software_cloud_v2/models/ping_schema.rb +21 -15
  82. data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +24 -42
  83. data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +198 -0
  84. data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +264 -0
  85. data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb +215 -0
  86. data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +198 -0
  87. data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +287 -0
  88. data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +228 -0
  89. data/lib/rustici_software_cloud_v2/models/registration_completion.rb +2 -2
  90. data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +6 -3
  91. data/lib/rustici_software_cloud_v2/models/registration_schema.rb +17 -4
  92. data/lib/rustici_software_cloud_v2/models/registration_success.rb +2 -2
  93. data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +257 -0
  94. data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +212 -0
  95. data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +194 -0
  96. data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +185 -0
  97. data/lib/rustici_software_cloud_v2/models/response_error.rb +5 -3
  98. data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +7 -31
  99. data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +10 -38
  100. data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +7 -31
  101. data/lib/rustici_software_cloud_v2/models/score_schema.rb +5 -3
  102. data/lib/rustici_software_cloud_v2/models/setting_item.rb +7 -31
  103. data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +5 -3
  104. data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +7 -31
  105. data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +5 -3
  106. data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +5 -3
  107. data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +5 -3
  108. data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +5 -3
  109. data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +5 -3
  110. data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +5 -3
  111. data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +5 -3
  112. data/lib/rustici_software_cloud_v2/models/title_schema.rb +5 -3
  113. data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +5 -3
  114. data/lib/rustici_software_cloud_v2/models/update_application_schema.rb +196 -0
  115. data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +266 -0
  116. data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +198 -0
  117. data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +234 -0
  118. data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +213 -0
  119. data/lib/rustici_software_cloud_v2/models/xapi_account.rb +5 -3
  120. data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +5 -3
  121. data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +5 -3
  122. data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +7 -31
  123. data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +5 -3
  124. data/lib/rustici_software_cloud_v2/models/xapi_context.rb +5 -3
  125. data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +5 -3
  126. data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +193 -0
  127. data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +193 -0
  128. data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +255 -0
  129. data/lib/rustici_software_cloud_v2/models/xapi_credential_put_schema.rb +239 -0
  130. data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +264 -0
  131. data/lib/rustici_software_cloud_v2/models/xapi_credentials_list_schema.rb +202 -0
  132. data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +203 -0
  133. data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +5 -3
  134. data/lib/rustici_software_cloud_v2/models/xapi_result.rb +5 -3
  135. data/lib/rustici_software_cloud_v2/models/xapi_score.rb +5 -3
  136. data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +5 -3
  137. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +192 -0
  138. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +199 -0
  139. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_put_schema.rb +194 -0
  140. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +239 -0
  141. data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +5 -3
  142. data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +5 -3
  143. data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +5 -3
  144. data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +185 -0
  145. data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +204 -0
  146. data/lib/rustici_software_cloud_v2/version.rb +3 -3
  147. data/lib/rustici_software_cloud_v2.rb +68 -6
  148. data/rustici_software_cloud_v2.gemspec +8 -7
  149. data/spec/api_client_spec.rb +53 -47
  150. data/spec/configuration_spec.rb +2 -2
  151. data/spec/spec_helper.rb +2 -13
  152. metadata +142 -270
  153. data/docs/ActivityResultSchema.md +0 -20
  154. data/docs/ApplicationListSchema.md +0 -8
  155. data/docs/ApplicationManagementApi.md +0 -570
  156. data/docs/ApplicationSchema.md +0 -9
  157. data/docs/ApplicationToken.md +0 -10
  158. data/docs/AuthenticationApi.md +0 -64
  159. data/docs/CommentSchema.md +0 -10
  160. data/docs/CompletionAmountSchema.md +0 -8
  161. data/docs/CourseActivitySchema.md +0 -15
  162. data/docs/CourseApi.md +0 -1459
  163. data/docs/CourseListNonPagedSchema.md +0 -8
  164. data/docs/CourseListSchema.md +0 -9
  165. data/docs/CourseReferenceSchema.md +0 -10
  166. data/docs/CourseSchema.md +0 -20
  167. data/docs/CourseTagsBatchSchema.md +0 -9
  168. data/docs/CreateRegistrationSchema.md +0 -17
  169. data/docs/CredentialCreatedSchema.md +0 -12
  170. data/docs/CredentialListSchema.md +0 -8
  171. data/docs/CredentialRequestSchema.md +0 -9
  172. data/docs/CredentialSchema.md +0 -12
  173. data/docs/ImportFetchRequestSchema.md +0 -8
  174. data/docs/ImportJobResultSchema.md +0 -11
  175. data/docs/ImportResultSchema.md +0 -11
  176. data/docs/IntegerResultSchema.md +0 -8
  177. data/docs/ItemValuePairSchema.md +0 -9
  178. data/docs/LaunchHistoryListSchema.md +0 -8
  179. data/docs/LaunchHistorySchema.md +0 -17
  180. data/docs/LaunchLinkRequestSchema.md +0 -17
  181. data/docs/LaunchLinkSchema.md +0 -8
  182. data/docs/LearnerPreferenceSchema.md +0 -11
  183. data/docs/LearnerSchema.md +0 -11
  184. data/docs/LinkSchema.md +0 -8
  185. data/docs/MessageSchema.md +0 -8
  186. data/docs/MetadataSchema.md +0 -14
  187. data/docs/ObjectiveSchema.md +0 -20
  188. data/docs/PermissionsSchema.md +0 -9
  189. data/docs/PingApi.md +0 -57
  190. data/docs/PingSchema.md +0 -8
  191. data/docs/PostBackSchema.md +0 -12
  192. data/docs/RegistrationApi.md +0 -1490
  193. data/docs/RegistrationCompletion.md +0 -7
  194. data/docs/RegistrationListSchema.md +0 -9
  195. data/docs/RegistrationSchema.md +0 -27
  196. data/docs/RegistrationSuccess.md +0 -7
  197. data/docs/RegistrationTagsBatchSchema.md +0 -9
  198. data/docs/ResponseError.md +0 -8
  199. data/docs/RuntimeInteractionSchema.md +0 -18
  200. data/docs/RuntimeObjectiveSchema.md +0 -16
  201. data/docs/RuntimeSchema.md +0 -27
  202. data/docs/ScoreSchema.md +0 -8
  203. data/docs/SettingItem.md +0 -12
  204. data/docs/SettingListSchema.md +0 -8
  205. data/docs/SettingMetadata.md +0 -15
  206. data/docs/SettingMetadataValidValues.md +0 -9
  207. data/docs/SettingValidValue.md +0 -9
  208. data/docs/SettingsIndividualSchema.md +0 -10
  209. data/docs/SettingsPostSchema.md +0 -8
  210. data/docs/SharedDataEntrySchema.md +0 -9
  211. data/docs/StaticPropertiesSchema.md +0 -13
  212. data/docs/StringResultSchema.md +0 -8
  213. data/docs/TagListSchema.md +0 -8
  214. data/docs/TagPostSchema.md +0 -7
  215. data/docs/TitleSchema.md +0 -8
  216. data/docs/TokenRequestSchema.md +0 -9
  217. data/docs/XapiAccount.md +0 -9
  218. data/docs/XapiActivity.md +0 -10
  219. data/docs/XapiActivityDefinition.md +0 -19
  220. data/docs/XapiAgentGroup.md +0 -14
  221. data/docs/XapiAttachment.md +0 -14
  222. data/docs/XapiContext.md +0 -16
  223. data/docs/XapiContextActivity.md +0 -11
  224. data/docs/XapiInteractionComponent.md +0 -9
  225. data/docs/XapiResult.md +0 -13
  226. data/docs/XapiScore.md +0 -11
  227. data/docs/XapiStatement.md +0 -20
  228. data/docs/XapiStatementReference.md +0 -9
  229. data/docs/XapiStatementResult.md +0 -9
  230. data/docs/XapiVerb.md +0 -9
  231. data/git_push.sh +0 -55
  232. data/lib/rustici_software_cloud_v2/models/setting_metadata_valid_values.rb +0 -209
  233. data/spec/models/activity_result_schema_spec.rb +0 -133
  234. data/spec/models/application_list_schema_spec.rb +0 -53
  235. data/spec/models/application_schema_spec.rb +0 -59
  236. data/spec/models/application_token_spec.rb +0 -65
  237. data/spec/models/comment_schema_spec.rb +0 -65
  238. data/spec/models/completion_amount_schema_spec.rb +0 -53
  239. data/spec/models/course_activity_schema_spec.rb +0 -99
  240. data/spec/models/course_list_non_paged_schema_spec.rb +0 -53
  241. data/spec/models/course_list_schema_spec.rb +0 -59
  242. data/spec/models/course_reference_schema_spec.rb +0 -65
  243. data/spec/models/course_schema_spec.rb +0 -129
  244. data/spec/models/create_registration_schema_spec.rb +0 -107
  245. data/spec/models/credential_created_schema_spec.rb +0 -77
  246. data/spec/models/credential_list_schema_spec.rb +0 -53
  247. data/spec/models/credential_request_schema_spec.rb +0 -59
  248. data/spec/models/credential_schema_spec.rb +0 -77
  249. data/spec/models/import_fetch_request_schema_spec.rb +0 -53
  250. data/spec/models/import_job_result_schema_spec.rb +0 -75
  251. data/spec/models/import_result_schema_spec.rb +0 -71
  252. data/spec/models/integer_result_schema_spec.rb +0 -53
  253. data/spec/models/item_value_pair_schema_spec.rb +0 -59
  254. data/spec/models/launch_history_list_schema_spec.rb +0 -53
  255. data/spec/models/launch_history_schema_spec.rb +0 -115
  256. data/spec/models/launch_link_request_schema_spec.rb +0 -107
  257. data/spec/models/launch_link_schema_spec.rb +0 -53
  258. data/spec/models/learner_preference_schema_spec.rb +0 -71
  259. data/spec/models/learner_schema_spec.rb +0 -71
  260. data/spec/models/link_schema_spec.rb +0 -53
  261. data/spec/models/message_schema_spec.rb +0 -53
  262. data/spec/models/metadata_schema_spec.rb +0 -89
  263. data/spec/models/objective_schema_spec.rb +0 -137
  264. data/spec/models/permissions_schema_spec.rb +0 -59
  265. data/spec/models/ping_schema_spec.rb +0 -53
  266. data/spec/models/post_back_schema_spec.rb +0 -85
  267. data/spec/models/registration_completion_spec.rb +0 -47
  268. data/spec/models/registration_list_schema_spec.rb +0 -59
  269. data/spec/models/registration_schema_spec.rb +0 -167
  270. data/spec/models/registration_success_spec.rb +0 -47
  271. data/spec/models/response_error_spec.rb +0 -53
  272. data/spec/models/runtime_interaction_schema_spec.rb +0 -117
  273. data/spec/models/runtime_objective_schema_spec.rb +0 -109
  274. data/spec/models/runtime_schema_spec.rb +0 -171
  275. data/spec/models/score_schema_spec.rb +0 -53
  276. data/spec/models/setting_item_spec.rb +0 -81
  277. data/spec/models/setting_list_schema_spec.rb +0 -53
  278. data/spec/models/setting_metadata_spec.rb +0 -99
  279. data/spec/models/setting_metadata_valid_values_spec.rb +0 -59
  280. data/spec/models/settings_individual_schema_spec.rb +0 -65
  281. data/spec/models/settings_post_schema_spec.rb +0 -53
  282. data/spec/models/shared_data_entry_schema_spec.rb +0 -59
  283. data/spec/models/static_properties_schema_spec.rb +0 -83
  284. data/spec/models/string_result_schema_spec.rb +0 -53
  285. data/spec/models/title_schema_spec.rb +0 -53
  286. data/spec/models/token_request_schema_spec.rb +0 -59
  287. data/swagger-codegen.config +0 -11
@@ -3,10 +3,10 @@
3
3
 
4
4
  #REST API used for SCORM Cloud integrations.
5
5
 
6
- OpenAPI spec version: 2.0 beta
6
+ OpenAPI spec version: 2.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.4.3
9
+ Swagger Codegen version: 2.4.12
10
10
 
11
11
  =end
12
12
 
@@ -19,29 +19,31 @@ module RusticiSoftwareCloudV2
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Create a new application
23
- # @param application_name
22
+ # Use the Application Management App to create a new Application
23
+ # 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.
24
+ # @param application_request
24
25
  # @param [Hash] opts the optional parameters
25
26
  # @return [ApplicationSchema]
26
- def create_application(application_name, opts = {})
27
- data, _status_code, _headers = create_application_with_http_info(application_name, opts)
27
+ def create_application(application_request, opts = {})
28
+ data, _status_code, _headers = create_application_with_http_info(application_request, opts)
28
29
  data
29
30
  end
30
31
 
31
- # Create a new application
32
- # @param application_name
32
+ # Use the Application Management App to create a new Application
33
+ # 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.
34
+ # @param application_request
33
35
  # @param [Hash] opts the optional parameters
34
36
  # @return [Array<(ApplicationSchema, Fixnum, Hash)>] ApplicationSchema data, response status code and response headers
35
- def create_application_with_http_info(application_name, opts = {})
37
+ def create_application_with_http_info(application_request, opts = {})
36
38
  if @api_client.config.debugging
37
39
  @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_application ...'
38
40
  end
39
- # verify the required parameter 'application_name' is set
40
- if @api_client.config.client_side_validation && application_name.nil?
41
- fail ArgumentError, "Missing the required parameter 'application_name' when calling ApplicationManagementApi.create_application"
41
+ # verify the required parameter 'application_request' is set
42
+ if application_request.nil?
43
+ fail ArgumentError, "Missing the required parameter 'application_request' when calling ApplicationManagementApi.create_application"
42
44
  end
43
45
  # resource path
44
- local_var_path = '/appManagement/applications/{applicationName}'.sub('{' + 'applicationName' + '}', application_name.to_s)
46
+ local_var_path = '/appManagement/applications'
45
47
 
46
48
  # query parameters
47
49
  query_params = {}
@@ -57,9 +59,9 @@ module RusticiSoftwareCloudV2
57
59
  form_params = {}
58
60
 
59
61
  # http body (model)
60
- post_body = nil
61
- auth_names = ['APP_NORMAL', 'OAUTH']
62
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
62
+ post_body = @api_client.object_to_http_body(application_request)
63
+ auth_names = ['APP_MANAGEMENT', 'OAUTH']
64
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
63
65
  :header_params => header_params,
64
66
  :query_params => query_params,
65
67
  :form_params => form_params,
@@ -71,7 +73,8 @@ module RusticiSoftwareCloudV2
71
73
  end
72
74
  return data, status_code, headers
73
75
  end
74
- # Create credential
76
+ # Use the Application Manager App to create a new secret key for an Application
77
+ # 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.
75
78
  # @param child_app_id
76
79
  # @param credential_request
77
80
  # @param [Hash] opts the optional parameters
@@ -81,7 +84,8 @@ module RusticiSoftwareCloudV2
81
84
  data
82
85
  end
83
86
 
84
- # Create credential
87
+ # Use the Application Manager App to create a new secret key for an Application
88
+ # 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.
85
89
  # @param child_app_id
86
90
  # @param credential_request
87
91
  # @param [Hash] opts the optional parameters
@@ -91,11 +95,11 @@ module RusticiSoftwareCloudV2
91
95
  @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_credential ...'
92
96
  end
93
97
  # verify the required parameter 'child_app_id' is set
94
- if @api_client.config.client_side_validation && child_app_id.nil?
98
+ if child_app_id.nil?
95
99
  fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.create_credential"
96
100
  end
97
101
  # verify the required parameter 'credential_request' is set
98
- if @api_client.config.client_side_validation && credential_request.nil?
102
+ if credential_request.nil?
99
103
  fail ArgumentError, "Missing the required parameter 'credential_request' when calling ApplicationManagementApi.create_credential"
100
104
  end
101
105
  # resource path
@@ -116,7 +120,7 @@ module RusticiSoftwareCloudV2
116
120
 
117
121
  # http body (model)
118
122
  post_body = @api_client.object_to_http_body(credential_request)
119
- auth_names = ['APP_NORMAL', 'OAUTH']
123
+ auth_names = ['APP_MANAGEMENT', 'OAUTH']
120
124
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
121
125
  :header_params => header_params,
122
126
  :query_params => query_params,
@@ -129,8 +133,8 @@ module RusticiSoftwareCloudV2
129
133
  end
130
134
  return data, status_code, headers
131
135
  end
132
- # Create token
133
- # Creates, signs and returns a 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. As long as the secret used to create it is not changed the token will be valid until it expires.
136
+ # Obtain an OAuth token for scoped access to an Application
137
+ # 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.
134
138
  # @param token_request
135
139
  # @param [Hash] opts the optional parameters
136
140
  # @return [StringResultSchema]
@@ -139,8 +143,8 @@ module RusticiSoftwareCloudV2
139
143
  data
140
144
  end
141
145
 
142
- # Create token
143
- # Creates, signs and returns a 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. As long as the secret used to create it is not changed the token will be valid until it expires.
146
+ # Obtain an OAuth token for scoped access to an Application
147
+ # 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.
144
148
  # @param token_request
145
149
  # @param [Hash] opts the optional parameters
146
150
  # @return [Array<(StringResultSchema, Fixnum, Hash)>] StringResultSchema data, response status code and response headers
@@ -149,7 +153,7 @@ module RusticiSoftwareCloudV2
149
153
  @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.create_token ...'
150
154
  end
151
155
  # verify the required parameter 'token_request' is set
152
- if @api_client.config.client_side_validation && token_request.nil?
156
+ if token_request.nil?
153
157
  fail ArgumentError, "Missing the required parameter 'token_request' when calling ApplicationManagementApi.create_token"
154
158
  end
155
159
  # resource path
@@ -183,7 +187,8 @@ module RusticiSoftwareCloudV2
183
187
  end
184
188
  return data, status_code, headers
185
189
  end
186
- # Delete an application. If the application contains content, it must first be manually removed before calling this method, else an error will be thrown.
190
+ # Use the Application Management App to delete an Application
191
+ # 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.
187
192
  # @param child_app_id
188
193
  # @param [Hash] opts the optional parameters
189
194
  # @return [nil]
@@ -192,7 +197,8 @@ module RusticiSoftwareCloudV2
192
197
  nil
193
198
  end
194
199
 
195
- # Delete an application. If the application contains content, it must first be manually removed before calling this method, else an error will be thrown.
200
+ # Use the Application Management App to delete an Application
201
+ # 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.
196
202
  # @param child_app_id
197
203
  # @param [Hash] opts the optional parameters
198
204
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -201,7 +207,7 @@ module RusticiSoftwareCloudV2
201
207
  @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.delete_application ...'
202
208
  end
203
209
  # verify the required parameter 'child_app_id' is set
204
- if @api_client.config.client_side_validation && child_app_id.nil?
210
+ if child_app_id.nil?
205
211
  fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.delete_application"
206
212
  end
207
213
  # resource path
@@ -222,7 +228,7 @@ module RusticiSoftwareCloudV2
222
228
 
223
229
  # http body (model)
224
230
  post_body = nil
225
- auth_names = ['APP_NORMAL', 'OAUTH']
231
+ auth_names = ['APP_MANAGEMENT', 'OAUTH']
226
232
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
227
233
  :header_params => header_params,
228
234
  :query_params => query_params,
@@ -234,7 +240,67 @@ module RusticiSoftwareCloudV2
234
240
  end
235
241
  return data, status_code, headers
236
242
  end
237
- # Removes `credentialId` credentials
243
+ # Delete a configuration setting explicitly set for an Application
244
+ # 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.
245
+ # @param setting_id
246
+ # @param [Hash] opts the optional parameters
247
+ # @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
248
+ # @option opts [BOOLEAN] :single_sco Required if &#x60;learningStandard&#x60; is specified. Scopes settings to either single or multi-SCO content.
249
+ # @return [nil]
250
+ def delete_application_configuration_setting(setting_id, opts = {})
251
+ delete_application_configuration_setting_with_http_info(setting_id, opts)
252
+ nil
253
+ end
254
+
255
+ # Delete a configuration setting explicitly set for an Application
256
+ # 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.
257
+ # @param setting_id
258
+ # @param [Hash] opts the optional parameters
259
+ # @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
260
+ # @option opts [BOOLEAN] :single_sco Required if &#x60;learningStandard&#x60; is specified. Scopes settings to either single or multi-SCO content.
261
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
262
+ def delete_application_configuration_setting_with_http_info(setting_id, opts = {})
263
+ if @api_client.config.debugging
264
+ @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.delete_application_configuration_setting ...'
265
+ end
266
+ # verify the required parameter 'setting_id' is set
267
+ if setting_id.nil?
268
+ fail ArgumentError, "Missing the required parameter 'setting_id' when calling ApplicationManagementApi.delete_application_configuration_setting"
269
+ end
270
+ # resource path
271
+ local_var_path = '/appManagement/configuration/{settingId}'.sub('{' + 'settingId' + '}', setting_id.to_s)
272
+
273
+ # query parameters
274
+ query_params = {}
275
+ query_params[:'learningStandard'] = opts[:'learning_standard'] if !opts[:'learning_standard'].nil?
276
+ query_params[:'singleSco'] = opts[:'single_sco'] if !opts[:'single_sco'].nil?
277
+
278
+ # header parameters
279
+ header_params = {}
280
+ # HTTP header 'Accept' (if needed)
281
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
282
+ # HTTP header 'Content-Type'
283
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
284
+
285
+ # form parameters
286
+ form_params = {}
287
+
288
+ # http body (model)
289
+ post_body = nil
290
+ auth_names = ['APP_NORMAL', 'OAUTH']
291
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
292
+ :header_params => header_params,
293
+ :query_params => query_params,
294
+ :form_params => form_params,
295
+ :body => post_body,
296
+ :auth_names => auth_names)
297
+ if @api_client.config.debugging
298
+ @api_client.config.logger.debug "API called: ApplicationManagementApi#delete_application_configuration_setting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
299
+ end
300
+ return data, status_code, headers
301
+ end
302
+ # Use the Application Management App to delete a secret key from an Application
303
+ # 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.
238
304
  # @param child_app_id
239
305
  # @param credential_id
240
306
  # @param [Hash] opts the optional parameters
@@ -244,7 +310,8 @@ module RusticiSoftwareCloudV2
244
310
  nil
245
311
  end
246
312
 
247
- # Removes &#x60;credentialId&#x60; credentials
313
+ # Use the Application Management App to delete a secret key from an Application
314
+ # 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.
248
315
  # @param child_app_id
249
316
  # @param credential_id
250
317
  # @param [Hash] opts the optional parameters
@@ -254,11 +321,11 @@ module RusticiSoftwareCloudV2
254
321
  @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.delete_credential ...'
255
322
  end
256
323
  # verify the required parameter 'child_app_id' is set
257
- if @api_client.config.client_side_validation && child_app_id.nil?
324
+ if child_app_id.nil?
258
325
  fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.delete_credential"
259
326
  end
260
327
  # verify the required parameter 'credential_id' is set
261
- if @api_client.config.client_side_validation && credential_id.nil?
328
+ if credential_id.nil?
262
329
  fail ArgumentError, "Missing the required parameter 'credential_id' when calling ApplicationManagementApi.delete_credential"
263
330
  end
264
331
  # resource path
@@ -279,7 +346,7 @@ module RusticiSoftwareCloudV2
279
346
 
280
347
  # http body (model)
281
348
  post_body = nil
282
- auth_names = ['APP_NORMAL', 'OAUTH']
349
+ auth_names = ['APP_MANAGEMENT', 'OAUTH']
283
350
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
284
351
  :header_params => header_params,
285
352
  :query_params => query_params,
@@ -291,10 +358,11 @@ module RusticiSoftwareCloudV2
291
358
  end
292
359
  return data, status_code, headers
293
360
  end
294
- # Returns all configuration settings for this level
361
+ # Get effective configuration settings for an Application
362
+ # 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._
295
363
  # @param [Hash] opts the optional parameters
296
364
  # @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
297
- # @option opts [BOOLEAN] :single_sco Required if learningStandard is specified. Scopes settings to whether a package has only one SCO or assignable unit within it or not. To apply a configuration setting to a learning standard for single and multi-SCO content, it must be set for both scopes.
365
+ # @option opts [BOOLEAN] :single_sco Required if &#x60;learningStandard&#x60; is specified. Scopes settings to either single or multi-SCO content.
298
366
  # @option opts [BOOLEAN] :include_metadata (default to false)
299
367
  # @return [SettingListSchema]
300
368
  def get_application_configuration(opts = {})
@@ -302,19 +370,17 @@ module RusticiSoftwareCloudV2
302
370
  data
303
371
  end
304
372
 
305
- # Returns all configuration settings for this level
373
+ # Get effective configuration settings for an Application
374
+ # 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._
306
375
  # @param [Hash] opts the optional parameters
307
376
  # @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
308
- # @option opts [BOOLEAN] :single_sco Required if learningStandard is specified. Scopes settings to whether a package has only one SCO or assignable unit within it or not. To apply a configuration setting to a learning standard for single and multi-SCO content, it must be set for both scopes.
377
+ # @option opts [BOOLEAN] :single_sco Required if &#x60;learningStandard&#x60; is specified. Scopes settings to either single or multi-SCO content.
309
378
  # @option opts [BOOLEAN] :include_metadata
310
379
  # @return [Array<(SettingListSchema, Fixnum, Hash)>] SettingListSchema data, response status code and response headers
311
380
  def get_application_configuration_with_http_info(opts = {})
312
381
  if @api_client.config.debugging
313
382
  @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_application_configuration ...'
314
383
  end
315
- if @api_client.config.client_side_validation && opts[:'learning_standard'] && !['SCORM_11', 'SCORM_12', 'SCORM_2004_2ND_EDITION', 'SCORM_2004_3RD_EDITION', 'SCORM_2004_4TH_EDITION', 'AICC', 'XAPI', 'CMI5'].include?(opts[:'learning_standard'])
316
- fail ArgumentError, 'invalid value for "learning_standard", must be one of SCORM_11, SCORM_12, SCORM_2004_2ND_EDITION, SCORM_2004_3RD_EDITION, SCORM_2004_4TH_EDITION, AICC, XAPI, CMI5'
317
- end
318
384
  # resource path
319
385
  local_var_path = '/appManagement/configuration'
320
386
 
@@ -349,7 +415,68 @@ module RusticiSoftwareCloudV2
349
415
  end
350
416
  return data, status_code, headers
351
417
  end
352
- # Get list of all applications in this realm.
418
+ # Use the Application Management App to get detailed information about an Application
419
+ # 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.
420
+ # @param child_app_id
421
+ # @param [Hash] opts the optional parameters
422
+ # @option opts [BOOLEAN] :include_course_count Include a count of courses for the application. (default to false)
423
+ # @option opts [BOOLEAN] :include_registration_count Include a count of registrations created for the application during the current billing period. (default to false)
424
+ # @return [ApplicationInfoSchema]
425
+ def get_application_info(child_app_id, opts = {})
426
+ data, _status_code, _headers = get_application_info_with_http_info(child_app_id, opts)
427
+ data
428
+ end
429
+
430
+ # Use the Application Management App to get detailed information about an Application
431
+ # 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.
432
+ # @param child_app_id
433
+ # @param [Hash] opts the optional parameters
434
+ # @option opts [BOOLEAN] :include_course_count Include a count of courses for the application.
435
+ # @option opts [BOOLEAN] :include_registration_count Include a count of registrations created for the application during the current billing period.
436
+ # @return [Array<(ApplicationInfoSchema, Fixnum, Hash)>] ApplicationInfoSchema data, response status code and response headers
437
+ def get_application_info_with_http_info(child_app_id, opts = {})
438
+ if @api_client.config.debugging
439
+ @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_application_info ...'
440
+ end
441
+ # verify the required parameter 'child_app_id' is set
442
+ if child_app_id.nil?
443
+ fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.get_application_info"
444
+ end
445
+ # resource path
446
+ local_var_path = '/appManagement/applications/{childAppId}'.sub('{' + 'childAppId' + '}', child_app_id.to_s)
447
+
448
+ # query parameters
449
+ query_params = {}
450
+ query_params[:'includeCourseCount'] = opts[:'include_course_count'] if !opts[:'include_course_count'].nil?
451
+ query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].nil?
452
+
453
+ # header parameters
454
+ header_params = {}
455
+ # HTTP header 'Accept' (if needed)
456
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
457
+ # HTTP header 'Content-Type'
458
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
459
+
460
+ # form parameters
461
+ form_params = {}
462
+
463
+ # http body (model)
464
+ post_body = nil
465
+ auth_names = ['APP_MANAGEMENT', 'OAUTH']
466
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
467
+ :header_params => header_params,
468
+ :query_params => query_params,
469
+ :form_params => form_params,
470
+ :body => post_body,
471
+ :auth_names => auth_names,
472
+ :return_type => 'ApplicationInfoSchema')
473
+ if @api_client.config.debugging
474
+ @api_client.config.logger.debug "API called: ApplicationManagementApi#get_application_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
475
+ end
476
+ return data, status_code, headers
477
+ end
478
+ # Use the Application Management App to get a list of Applications
479
+ # 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.
353
480
  # @param [Hash] opts the optional parameters
354
481
  # @return [ApplicationListSchema]
355
482
  def get_application_list(opts = {})
@@ -357,7 +484,8 @@ module RusticiSoftwareCloudV2
357
484
  data
358
485
  end
359
486
 
360
- # Get list of all applications in this realm.
487
+ # Use the Application Management App to get a list of Applications
488
+ # 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.
361
489
  # @param [Hash] opts the optional parameters
362
490
  # @return [Array<(ApplicationListSchema, Fixnum, Hash)>] ApplicationListSchema data, response status code and response headers
363
491
  def get_application_list_with_http_info(opts = {})
@@ -382,7 +510,7 @@ module RusticiSoftwareCloudV2
382
510
 
383
511
  # http body (model)
384
512
  post_body = nil
385
- auth_names = ['APP_NORMAL', 'OAUTH']
513
+ auth_names = ['APP_MANAGEMENT', 'OAUTH']
386
514
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
387
515
  :header_params => header_params,
388
516
  :query_params => query_params,
@@ -395,7 +523,8 @@ module RusticiSoftwareCloudV2
395
523
  end
396
524
  return data, status_code, headers
397
525
  end
398
- # List of credentials
526
+ # Use the Application Manager App to get a list of secret keys for an Application
527
+ # 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.
399
528
  # @param child_app_id
400
529
  # @param [Hash] opts the optional parameters
401
530
  # @return [CredentialListSchema]
@@ -404,7 +533,8 @@ module RusticiSoftwareCloudV2
404
533
  data
405
534
  end
406
535
 
407
- # List of credentials
536
+ # Use the Application Manager App to get a list of secret keys for an Application
537
+ # 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.
408
538
  # @param child_app_id
409
539
  # @param [Hash] opts the optional parameters
410
540
  # @return [Array<(CredentialListSchema, Fixnum, Hash)>] CredentialListSchema data, response status code and response headers
@@ -413,7 +543,7 @@ module RusticiSoftwareCloudV2
413
543
  @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.get_credentials ...'
414
544
  end
415
545
  # verify the required parameter 'child_app_id' is set
416
- if @api_client.config.client_side_validation && child_app_id.nil?
546
+ if child_app_id.nil?
417
547
  fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.get_credentials"
418
548
  end
419
549
  # resource path
@@ -434,7 +564,7 @@ module RusticiSoftwareCloudV2
434
564
 
435
565
  # http body (model)
436
566
  post_body = nil
437
- auth_names = ['APP_NORMAL', 'OAUTH']
567
+ auth_names = ['APP_MANAGEMENT', 'OAUTH']
438
568
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
439
569
  :header_params => header_params,
440
570
  :query_params => query_params,
@@ -447,34 +577,33 @@ module RusticiSoftwareCloudV2
447
577
  end
448
578
  return data, status_code, headers
449
579
  end
450
- # Set configuration settings for this level.
580
+ # Update configuration settings for an Application
581
+ # 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.
451
582
  # @param configuration_settings
452
583
  # @param [Hash] opts the optional parameters
453
584
  # @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
454
- # @option opts [BOOLEAN] :single_sco Required if learningStandard is specified. Scopes settings to whether a package has only one SCO or assignable unit within it or not. To apply a configuration setting to a learning standard for single and multi-SCO content, it must be set for both scopes.
585
+ # @option opts [BOOLEAN] :single_sco Required if &#x60;learningStandard&#x60; is specified. Scopes settings to either single or multi-SCO content.
455
586
  # @return [nil]
456
587
  def set_application_configuration(configuration_settings, opts = {})
457
588
  set_application_configuration_with_http_info(configuration_settings, opts)
458
589
  nil
459
590
  end
460
591
 
461
- # Set configuration settings for this level.
592
+ # Update configuration settings for an Application
593
+ # 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.
462
594
  # @param configuration_settings
463
595
  # @param [Hash] opts the optional parameters
464
596
  # @option opts [String] :learning_standard If specified, the request will be scoped to the provided learning standard.
465
- # @option opts [BOOLEAN] :single_sco Required if learningStandard is specified. Scopes settings to whether a package has only one SCO or assignable unit within it or not. To apply a configuration setting to a learning standard for single and multi-SCO content, it must be set for both scopes.
597
+ # @option opts [BOOLEAN] :single_sco Required if &#x60;learningStandard&#x60; is specified. Scopes settings to either single or multi-SCO content.
466
598
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
467
599
  def set_application_configuration_with_http_info(configuration_settings, opts = {})
468
600
  if @api_client.config.debugging
469
601
  @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.set_application_configuration ...'
470
602
  end
471
603
  # verify the required parameter 'configuration_settings' is set
472
- if @api_client.config.client_side_validation && configuration_settings.nil?
604
+ if configuration_settings.nil?
473
605
  fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling ApplicationManagementApi.set_application_configuration"
474
606
  end
475
- if @api_client.config.client_side_validation && opts[:'learning_standard'] && !['SCORM_11', 'SCORM_12', 'SCORM_2004_2ND_EDITION', 'SCORM_2004_3RD_EDITION', 'SCORM_2004_4TH_EDITION', 'AICC', 'XAPI', 'CMI5'].include?(opts[:'learning_standard'])
476
- fail ArgumentError, 'invalid value for "learning_standard", must be one of SCORM_11, SCORM_12, SCORM_2004_2ND_EDITION, SCORM_2004_3RD_EDITION, SCORM_2004_4TH_EDITION, AICC, XAPI, CMI5'
477
- end
478
607
  # resource path
479
608
  local_var_path = '/appManagement/configuration'
480
609
 
@@ -507,7 +636,67 @@ module RusticiSoftwareCloudV2
507
636
  end
508
637
  return data, status_code, headers
509
638
  end
510
- # Update the name or status associated with `credentialId`
639
+ # Use the Application Management App to update information about an Application
640
+ # 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.
641
+ # @param child_app_id
642
+ # @param application_properties
643
+ # @param [Hash] opts the optional parameters
644
+ # @return [nil]
645
+ def update_application(child_app_id, application_properties, opts = {})
646
+ update_application_with_http_info(child_app_id, application_properties, opts)
647
+ nil
648
+ end
649
+
650
+ # Use the Application Management App to update information about an Application
651
+ # 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.
652
+ # @param child_app_id
653
+ # @param application_properties
654
+ # @param [Hash] opts the optional parameters
655
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
656
+ def update_application_with_http_info(child_app_id, application_properties, opts = {})
657
+ if @api_client.config.debugging
658
+ @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.update_application ...'
659
+ end
660
+ # verify the required parameter 'child_app_id' is set
661
+ if child_app_id.nil?
662
+ fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.update_application"
663
+ end
664
+ # verify the required parameter 'application_properties' is set
665
+ if application_properties.nil?
666
+ fail ArgumentError, "Missing the required parameter 'application_properties' when calling ApplicationManagementApi.update_application"
667
+ end
668
+ # resource path
669
+ local_var_path = '/appManagement/applications/{childAppId}'.sub('{' + 'childAppId' + '}', child_app_id.to_s)
670
+
671
+ # query parameters
672
+ query_params = {}
673
+
674
+ # header parameters
675
+ header_params = {}
676
+ # HTTP header 'Accept' (if needed)
677
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
678
+ # HTTP header 'Content-Type'
679
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
680
+
681
+ # form parameters
682
+ form_params = {}
683
+
684
+ # http body (model)
685
+ post_body = @api_client.object_to_http_body(application_properties)
686
+ auth_names = ['APP_MANAGEMENT', 'OAUTH']
687
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
688
+ :header_params => header_params,
689
+ :query_params => query_params,
690
+ :form_params => form_params,
691
+ :body => post_body,
692
+ :auth_names => auth_names)
693
+ if @api_client.config.debugging
694
+ @api_client.config.logger.debug "API called: ApplicationManagementApi#update_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
695
+ end
696
+ return data, status_code, headers
697
+ end
698
+ # Use the Application Manager App to update an existing secret key for an Application
699
+ # 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.
511
700
  # @param child_app_id
512
701
  # @param credential_id
513
702
  # @param credential_update
@@ -518,7 +707,8 @@ module RusticiSoftwareCloudV2
518
707
  nil
519
708
  end
520
709
 
521
- # Update the name or status associated with &#x60;credentialId&#x60;
710
+ # Use the Application Manager App to update an existing secret key for an Application
711
+ # 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.
522
712
  # @param child_app_id
523
713
  # @param credential_id
524
714
  # @param credential_update
@@ -529,15 +719,15 @@ module RusticiSoftwareCloudV2
529
719
  @api_client.config.logger.debug 'Calling API: ApplicationManagementApi.update_credential ...'
530
720
  end
531
721
  # verify the required parameter 'child_app_id' is set
532
- if @api_client.config.client_side_validation && child_app_id.nil?
722
+ if child_app_id.nil?
533
723
  fail ArgumentError, "Missing the required parameter 'child_app_id' when calling ApplicationManagementApi.update_credential"
534
724
  end
535
725
  # verify the required parameter 'credential_id' is set
536
- if @api_client.config.client_side_validation && credential_id.nil?
726
+ if credential_id.nil?
537
727
  fail ArgumentError, "Missing the required parameter 'credential_id' when calling ApplicationManagementApi.update_credential"
538
728
  end
539
729
  # verify the required parameter 'credential_update' is set
540
- if @api_client.config.client_side_validation && credential_update.nil?
730
+ if credential_update.nil?
541
731
  fail ArgumentError, "Missing the required parameter 'credential_update' when calling ApplicationManagementApi.update_credential"
542
732
  end
543
733
  # resource path
@@ -558,7 +748,7 @@ module RusticiSoftwareCloudV2
558
748
 
559
749
  # http body (model)
560
750
  post_body = @api_client.object_to_http_body(credential_update)
561
- auth_names = ['APP_NORMAL', 'OAUTH']
751
+ auth_names = ['APP_MANAGEMENT', 'OAUTH']
562
752
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
563
753
  :header_params => header_params,
564
754
  :query_params => query_params,