rustici_software_cloud_v2 1.0.0beta

Sign up to get free protection for your applications and to get access to all the features.
Files changed (226) hide show
  1. data/Gemfile +7 -0
  2. data/LICENSE +201 -0
  3. data/README.md +283 -0
  4. data/Rakefile +8 -0
  5. data/docs/ActivityResultSchema.md +20 -0
  6. data/docs/ApplicationListSchema.md +8 -0
  7. data/docs/ApplicationManagementApi.md +570 -0
  8. data/docs/ApplicationSchema.md +9 -0
  9. data/docs/ApplicationToken.md +10 -0
  10. data/docs/AuthenticationApi.md +64 -0
  11. data/docs/CommentSchema.md +10 -0
  12. data/docs/CompletionAmountSchema.md +8 -0
  13. data/docs/CourseActivitySchema.md +15 -0
  14. data/docs/CourseApi.md +1459 -0
  15. data/docs/CourseListNonPagedSchema.md +8 -0
  16. data/docs/CourseListSchema.md +9 -0
  17. data/docs/CourseReferenceSchema.md +10 -0
  18. data/docs/CourseSchema.md +20 -0
  19. data/docs/CourseTagsBatchSchema.md +9 -0
  20. data/docs/CreateRegistrationSchema.md +17 -0
  21. data/docs/CredentialCreatedSchema.md +12 -0
  22. data/docs/CredentialListSchema.md +8 -0
  23. data/docs/CredentialRequestSchema.md +9 -0
  24. data/docs/CredentialSchema.md +12 -0
  25. data/docs/ImportFetchRequestSchema.md +8 -0
  26. data/docs/ImportJobResultSchema.md +11 -0
  27. data/docs/ImportResultSchema.md +11 -0
  28. data/docs/IntegerResultSchema.md +8 -0
  29. data/docs/ItemValuePairSchema.md +9 -0
  30. data/docs/LaunchHistoryListSchema.md +8 -0
  31. data/docs/LaunchHistorySchema.md +17 -0
  32. data/docs/LaunchLinkRequestSchema.md +17 -0
  33. data/docs/LaunchLinkSchema.md +8 -0
  34. data/docs/LearnerPreferenceSchema.md +11 -0
  35. data/docs/LearnerSchema.md +11 -0
  36. data/docs/LinkSchema.md +8 -0
  37. data/docs/MessageSchema.md +8 -0
  38. data/docs/MetadataSchema.md +14 -0
  39. data/docs/ObjectiveSchema.md +20 -0
  40. data/docs/PermissionsSchema.md +9 -0
  41. data/docs/PingApi.md +57 -0
  42. data/docs/PingSchema.md +8 -0
  43. data/docs/PostBackSchema.md +12 -0
  44. data/docs/RegistrationApi.md +1490 -0
  45. data/docs/RegistrationCompletion.md +7 -0
  46. data/docs/RegistrationListSchema.md +9 -0
  47. data/docs/RegistrationSchema.md +27 -0
  48. data/docs/RegistrationSuccess.md +7 -0
  49. data/docs/RegistrationTagsBatchSchema.md +9 -0
  50. data/docs/ResponseError.md +8 -0
  51. data/docs/RuntimeInteractionSchema.md +18 -0
  52. data/docs/RuntimeObjectiveSchema.md +16 -0
  53. data/docs/RuntimeSchema.md +27 -0
  54. data/docs/ScoreSchema.md +8 -0
  55. data/docs/SettingItem.md +12 -0
  56. data/docs/SettingListSchema.md +8 -0
  57. data/docs/SettingMetadata.md +15 -0
  58. data/docs/SettingMetadataValidValues.md +9 -0
  59. data/docs/SettingValidValue.md +9 -0
  60. data/docs/SettingsIndividualSchema.md +10 -0
  61. data/docs/SettingsPostSchema.md +8 -0
  62. data/docs/SharedDataEntrySchema.md +9 -0
  63. data/docs/StaticPropertiesSchema.md +13 -0
  64. data/docs/StringResultSchema.md +8 -0
  65. data/docs/TagListSchema.md +8 -0
  66. data/docs/TagPostSchema.md +7 -0
  67. data/docs/TitleSchema.md +8 -0
  68. data/docs/TokenRequestSchema.md +9 -0
  69. data/docs/XapiAccount.md +9 -0
  70. data/docs/XapiActivity.md +10 -0
  71. data/docs/XapiActivityDefinition.md +19 -0
  72. data/docs/XapiAgentGroup.md +14 -0
  73. data/docs/XapiAttachment.md +14 -0
  74. data/docs/XapiContext.md +16 -0
  75. data/docs/XapiContextActivity.md +11 -0
  76. data/docs/XapiInteractionComponent.md +9 -0
  77. data/docs/XapiResult.md +13 -0
  78. data/docs/XapiScore.md +11 -0
  79. data/docs/XapiStatement.md +20 -0
  80. data/docs/XapiStatementReference.md +9 -0
  81. data/docs/XapiStatementResult.md +9 -0
  82. data/docs/XapiVerb.md +9 -0
  83. data/git_push.sh +55 -0
  84. data/lib/rustici_software_cloud_v2.rb +116 -0
  85. data/lib/rustici_software_cloud_v2/api/application_management_api.rb +574 -0
  86. data/lib/rustici_software_cloud_v2/api/authentication_api.rb +87 -0
  87. data/lib/rustici_software_cloud_v2/api/course_api.rb +1469 -0
  88. data/lib/rustici_software_cloud_v2/api/ping_api.rb +69 -0
  89. data/lib/rustici_software_cloud_v2/api/registration_api.rb +1499 -0
  90. data/lib/rustici_software_cloud_v2/api_client.rb +389 -0
  91. data/lib/rustici_software_cloud_v2/api_error.rb +38 -0
  92. data/lib/rustici_software_cloud_v2/configuration.rb +237 -0
  93. data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +341 -0
  94. data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +185 -0
  95. data/lib/rustici_software_cloud_v2/models/application_schema.rb +194 -0
  96. data/lib/rustici_software_cloud_v2/models/application_token.rb +201 -0
  97. data/lib/rustici_software_cloud_v2/models/comment_schema.rb +201 -0
  98. data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +184 -0
  99. data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +289 -0
  100. data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +185 -0
  101. data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +194 -0
  102. data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +202 -0
  103. data/lib/rustici_software_cloud_v2/models/course_schema.rb +328 -0
  104. data/lib/rustici_software_cloud_v2/models/course_tags_batch_schema.rb +204 -0
  105. data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +287 -0
  106. data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +223 -0
  107. data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +185 -0
  108. data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +194 -0
  109. data/lib/rustici_software_cloud_v2/models/credential_schema.rb +223 -0
  110. data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +190 -0
  111. data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +244 -0
  112. data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +215 -0
  113. data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +188 -0
  114. data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +192 -0
  115. data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +185 -0
  116. data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +317 -0
  117. data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +282 -0
  118. data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +188 -0
  119. data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +210 -0
  120. data/lib/rustici_software_cloud_v2/models/learner_schema.rb +216 -0
  121. data/lib/rustici_software_cloud_v2/models/link_schema.rb +188 -0
  122. data/lib/rustici_software_cloud_v2/models/message_schema.rb +188 -0
  123. data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +239 -0
  124. data/lib/rustici_software_cloud_v2/models/objective_schema.rb +355 -0
  125. data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +195 -0
  126. data/lib/rustici_software_cloud_v2/models/ping_schema.rb +188 -0
  127. data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +273 -0
  128. data/lib/rustici_software_cloud_v2/models/registration_completion.rb +31 -0
  129. data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +199 -0
  130. data/lib/rustici_software_cloud_v2/models/registration_schema.rb +360 -0
  131. data/lib/rustici_software_cloud_v2/models/registration_success.rb +31 -0
  132. data/lib/rustici_software_cloud_v2/models/registration_tags_batch_schema.rb +204 -0
  133. data/lib/rustici_software_cloud_v2/models/response_error.rb +188 -0
  134. data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +311 -0
  135. data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +305 -0
  136. data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +398 -0
  137. data/lib/rustici_software_cloud_v2/models/score_schema.rb +184 -0
  138. data/lib/rustici_software_cloud_v2/models/setting_item.rb +256 -0
  139. data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +190 -0
  140. data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +294 -0
  141. data/lib/rustici_software_cloud_v2/models/setting_metadata_valid_values.rb +209 -0
  142. data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +193 -0
  143. data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +203 -0
  144. data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +185 -0
  145. data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +192 -0
  146. data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +228 -0
  147. data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +188 -0
  148. data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +185 -0
  149. data/lib/rustici_software_cloud_v2/models/tag_post_schema.rb +174 -0
  150. data/lib/rustici_software_cloud_v2/models/title_schema.rb +183 -0
  151. data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +203 -0
  152. data/lib/rustici_software_cloud_v2/models/xapi_account.rb +203 -0
  153. data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +209 -0
  154. data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +301 -0
  155. data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +279 -0
  156. data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +267 -0
  157. data/lib/rustici_software_cloud_v2/models/xapi_context.rb +258 -0
  158. data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +219 -0
  159. data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +200 -0
  160. data/lib/rustici_software_cloud_v2/models/xapi_result.rb +231 -0
  161. data/lib/rustici_software_cloud_v2/models/xapi_score.rb +211 -0
  162. data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +294 -0
  163. data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +205 -0
  164. data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +200 -0
  165. data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +200 -0
  166. data/lib/rustici_software_cloud_v2/version.rb +15 -0
  167. data/rustici_software_cloud_v2.gemspec +45 -0
  168. data/spec/api_client_spec.rb +237 -0
  169. data/spec/configuration_spec.rb +42 -0
  170. data/spec/models/activity_result_schema_spec.rb +133 -0
  171. data/spec/models/application_list_schema_spec.rb +53 -0
  172. data/spec/models/application_schema_spec.rb +59 -0
  173. data/spec/models/application_token_spec.rb +65 -0
  174. data/spec/models/comment_schema_spec.rb +65 -0
  175. data/spec/models/completion_amount_schema_spec.rb +53 -0
  176. data/spec/models/course_activity_schema_spec.rb +99 -0
  177. data/spec/models/course_list_non_paged_schema_spec.rb +53 -0
  178. data/spec/models/course_list_schema_spec.rb +59 -0
  179. data/spec/models/course_reference_schema_spec.rb +65 -0
  180. data/spec/models/course_schema_spec.rb +129 -0
  181. data/spec/models/create_registration_schema_spec.rb +107 -0
  182. data/spec/models/credential_created_schema_spec.rb +77 -0
  183. data/spec/models/credential_list_schema_spec.rb +53 -0
  184. data/spec/models/credential_request_schema_spec.rb +59 -0
  185. data/spec/models/credential_schema_spec.rb +77 -0
  186. data/spec/models/import_fetch_request_schema_spec.rb +53 -0
  187. data/spec/models/import_job_result_schema_spec.rb +75 -0
  188. data/spec/models/import_result_schema_spec.rb +71 -0
  189. data/spec/models/integer_result_schema_spec.rb +53 -0
  190. data/spec/models/item_value_pair_schema_spec.rb +59 -0
  191. data/spec/models/launch_history_list_schema_spec.rb +53 -0
  192. data/spec/models/launch_history_schema_spec.rb +115 -0
  193. data/spec/models/launch_link_request_schema_spec.rb +107 -0
  194. data/spec/models/launch_link_schema_spec.rb +53 -0
  195. data/spec/models/learner_preference_schema_spec.rb +71 -0
  196. data/spec/models/learner_schema_spec.rb +71 -0
  197. data/spec/models/link_schema_spec.rb +53 -0
  198. data/spec/models/message_schema_spec.rb +53 -0
  199. data/spec/models/metadata_schema_spec.rb +89 -0
  200. data/spec/models/objective_schema_spec.rb +137 -0
  201. data/spec/models/permissions_schema_spec.rb +59 -0
  202. data/spec/models/ping_schema_spec.rb +53 -0
  203. data/spec/models/post_back_schema_spec.rb +85 -0
  204. data/spec/models/registration_completion_spec.rb +47 -0
  205. data/spec/models/registration_list_schema_spec.rb +59 -0
  206. data/spec/models/registration_schema_spec.rb +167 -0
  207. data/spec/models/registration_success_spec.rb +47 -0
  208. data/spec/models/response_error_spec.rb +53 -0
  209. data/spec/models/runtime_interaction_schema_spec.rb +117 -0
  210. data/spec/models/runtime_objective_schema_spec.rb +109 -0
  211. data/spec/models/runtime_schema_spec.rb +171 -0
  212. data/spec/models/score_schema_spec.rb +53 -0
  213. data/spec/models/setting_item_spec.rb +81 -0
  214. data/spec/models/setting_list_schema_spec.rb +53 -0
  215. data/spec/models/setting_metadata_spec.rb +99 -0
  216. data/spec/models/setting_metadata_valid_values_spec.rb +59 -0
  217. data/spec/models/settings_individual_schema_spec.rb +65 -0
  218. data/spec/models/settings_post_schema_spec.rb +53 -0
  219. data/spec/models/shared_data_entry_schema_spec.rb +59 -0
  220. data/spec/models/static_properties_schema_spec.rb +83 -0
  221. data/spec/models/string_result_schema_spec.rb +53 -0
  222. data/spec/models/title_schema_spec.rb +53 -0
  223. data/spec/models/token_request_schema_spec.rb +59 -0
  224. data/spec/spec_helper.rb +122 -0
  225. data/swagger-codegen.config +11 -0
  226. metadata +526 -0
@@ -0,0 +1,8 @@
1
+ # RusticiSoftwareCloudV2::CourseListNonPagedSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **courses** | [**Array<CourseSchema>**](CourseSchema.md) | | [optional]
7
+
8
+
@@ -0,0 +1,9 @@
1
+ # RusticiSoftwareCloudV2::CourseListSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **courses** | [**Array<CourseSchema>**](CourseSchema.md) | | [optional]
7
+ **more** | **String** | | [optional]
8
+
9
+
@@ -0,0 +1,10 @@
1
+ # RusticiSoftwareCloudV2::CourseReferenceSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | | [optional]
7
+ **title** | **String** | | [optional]
8
+ **version** | **Integer** | | [optional]
9
+
10
+
@@ -0,0 +1,20 @@
1
+ # RusticiSoftwareCloudV2::CourseSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | | [optional]
7
+ **title** | **String** | | [optional]
8
+ **xapi_activity_id** | **String** | xAPI activity id associated with this course | [optional]
9
+ **created** | **DateTime** | | [optional]
10
+ **updated** | **DateTime** | | [optional]
11
+ **version** | **Integer** | | [optional]
12
+ **registration_count** | **Integer** | | [optional]
13
+ **activity_id** | **String** | | [optional]
14
+ **course_learning_standard** | **String** | | [optional]
15
+ **tags** | **Array<String>** | | [optional]
16
+ **dispatched** | **BOOLEAN** | | [optional]
17
+ **metadata** | [**MetadataSchema**](MetadataSchema.md) | | [optional]
18
+ **root_activity** | [**CourseActivitySchema**](CourseActivitySchema.md) | | [optional]
19
+
20
+
@@ -0,0 +1,9 @@
1
+ # RusticiSoftwareCloudV2::CourseTagsBatchSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **course_ids** | **Array<String>** | |
7
+ **tags** | [**TagPostSchema**](TagPostSchema.md) | |
8
+
9
+
@@ -0,0 +1,17 @@
1
+ # RusticiSoftwareCloudV2::CreateRegistrationSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **course_id** | **String** | |
7
+ **learner** | [**LearnerSchema**](LearnerSchema.md) | |
8
+ **registration_id** | **String** | |
9
+ **xapi_registration_id** | **String** | The xapiRegistrationId to be associated with this registration. If not specified, the system will assign an xapiRegistrationId. As per the xApi specification, this must be a UUID. | [optional]
10
+ **learner_tags** | **Array<String>** | | [optional]
11
+ **course_tags** | **Array<String>** | | [optional]
12
+ **registration_tags** | **Array<String>** | | [optional]
13
+ **post_back** | [**PostBackSchema**](PostBackSchema.md) | Specifies an optional override URL for which to post activity and status data in real time as the course is completed. By default all of these settings are read from your configuration. | [optional]
14
+ **initial_registration_state** | [**RegistrationSchema**](RegistrationSchema.md) | | [optional]
15
+ **initial_settings** | [**SettingsPostSchema**](SettingsPostSchema.md) | | [optional]
16
+
17
+
@@ -0,0 +1,12 @@
1
+ # RusticiSoftwareCloudV2::CredentialCreatedSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | id for this credential | [optional]
7
+ **name** | **String** | name for this credential | [optional]
8
+ **credential** | **String** | The newly created API credential | [optional]
9
+ **pens_credential** | **String** | The PENS key for this credential | [optional]
10
+ **status** | **String** | | [optional]
11
+
12
+
@@ -0,0 +1,8 @@
1
+ # RusticiSoftwareCloudV2::CredentialListSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **credentials** | [**Array<CredentialSchema>**](CredentialSchema.md) | | [optional]
7
+
8
+
@@ -0,0 +1,9 @@
1
+ # RusticiSoftwareCloudV2::CredentialRequestSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | name for this credential | [optional]
7
+ **active** | **BOOLEAN** | A flag denoting if the key is available for use. | [optional]
8
+
9
+
@@ -0,0 +1,12 @@
1
+ # RusticiSoftwareCloudV2::CredentialSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | id for this credential | [optional]
7
+ **name** | **String** | name for this credential | [optional]
8
+ **credential** | **String** | The newly created API credential | [optional]
9
+ **pens_credential** | **String** | The PENS key for this credential | [optional]
10
+ **status** | **String** | | [optional]
11
+
12
+
@@ -0,0 +1,8 @@
1
+ # RusticiSoftwareCloudV2::ImportFetchRequestSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **url** | **String** | URL path to the .zip package to download to import this course |
7
+
8
+
@@ -0,0 +1,11 @@
1
+ # RusticiSoftwareCloudV2::ImportJobResultSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **job_id** | **String** | | [optional]
7
+ **status** | **String** | | [optional]
8
+ **message** | **String** | | [optional]
9
+ **import_result** | [**ImportResultSchema**](ImportResultSchema.md) | | [optional]
10
+
11
+
@@ -0,0 +1,11 @@
1
+ # RusticiSoftwareCloudV2::ImportResultSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **web_path_to_course** | **String** | web path to this course | [optional]
7
+ **parser_warnings** | **Array<String>** | | [optional]
8
+ **course_languages** | **Array<String>** | | [optional]
9
+ **course** | [**CourseSchema**](CourseSchema.md) | | [optional]
10
+
11
+
@@ -0,0 +1,8 @@
1
+ # RusticiSoftwareCloudV2::IntegerResultSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **result** | **Integer** | |
7
+
8
+
@@ -0,0 +1,9 @@
1
+ # RusticiSoftwareCloudV2::ItemValuePairSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **item** | **String** | | [optional]
7
+ **value** | **String** | | [optional]
8
+
9
+
@@ -0,0 +1,8 @@
1
+ # RusticiSoftwareCloudV2::LaunchHistoryListSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **launch_history** | [**Array<LaunchHistorySchema>**](LaunchHistorySchema.md) | | [optional]
7
+
8
+
@@ -0,0 +1,17 @@
1
+ # RusticiSoftwareCloudV2::LaunchHistorySchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | | [optional]
7
+ **instance** | **Integer** | | [optional]
8
+ **score** | [**ScoreSchema**](ScoreSchema.md) | | [optional]
9
+ **completion_status** | **String** | | [optional] [default to 'UNKNOWN']
10
+ **success_status** | **String** | | [optional] [default to 'UNKNOWN']
11
+ **history_log** | **String** | | [optional]
12
+ **total_seconds_tracked** | **Float** | | [optional]
13
+ **launch_time** | **DateTime** | The time of the launch in UTC | [optional]
14
+ **exit_time** | **DateTime** | The time of the exit in UTC | [optional]
15
+ **last_runtime_update** | **DateTime** | The time of the last runtime update in UTC | [optional]
16
+
17
+
@@ -0,0 +1,17 @@
1
+ # RusticiSoftwareCloudV2::LaunchLinkRequestSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **expiry** | **Integer** | Number of seconds from now this link will expire in. Defaults to 120s. Range 10s:300s | [optional] [default to 120]
7
+ **redirect_on_exit_url** | **String** | The URL the application should redirect to when the learner exits a course. If not specified, configured value will be used. | [optional]
8
+ **tracking** | **BOOLEAN** | Should this launch be tracked? If false, Engine will avoid tracking to the extent possible for the standard being used. | [optional] [default to true]
9
+ **start_sco** | **String** | For SCORM, SCO identifier to override launch, overriding the normal sequencing. | [optional]
10
+ **culture** | **String** | This parameter should specify a culture code. If specified, and supported, the navigation and alerts in the player will be displayed in the associated language. If not specified, the locale of the user’s browser will be used. | [optional]
11
+ **css_url** | **String** | A Url pointing to custom css for the player to use. | [optional]
12
+ **learner_tags** | **Array<String>** | | [optional]
13
+ **course_tags** | **Array<String>** | | [optional]
14
+ **registration_tags** | **Array<String>** | | [optional]
15
+ **additionalvalues** | [**Array<ItemValuePairSchema>**](ItemValuePairSchema.md) | | [optional]
16
+
17
+
@@ -0,0 +1,8 @@
1
+ # RusticiSoftwareCloudV2::LaunchLinkSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **launch_link** | **String** | |
7
+
8
+
@@ -0,0 +1,11 @@
1
+ # RusticiSoftwareCloudV2::LearnerPreferenceSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **audio_level** | **Float** | | [optional]
7
+ **language** | **String** | | [optional]
8
+ **delivery_speed** | **Float** | | [optional]
9
+ **audio_captioning** | **Integer** | | [optional]
10
+
11
+
@@ -0,0 +1,11 @@
1
+ # RusticiSoftwareCloudV2::LearnerSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | |
7
+ **email** | **String** | Optional email address associated with the learner. | [optional]
8
+ **first_name** | **String** | | [optional]
9
+ **last_name** | **String** | | [optional]
10
+
11
+
@@ -0,0 +1,8 @@
1
+ # RusticiSoftwareCloudV2::LinkSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **link** | **String** | |
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # RusticiSoftwareCloudV2::MessageSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **message** | **String** | |
7
+
8
+
@@ -0,0 +1,14 @@
1
+ # RusticiSoftwareCloudV2::MetadataSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **title** | **String** | | [optional]
7
+ **title_language** | **String** | | [optional]
8
+ **description** | **String** | | [optional]
9
+ **description_language** | **String** | | [optional]
10
+ **duration** | **String** | | [optional]
11
+ **typicaltime** | **String** | | [optional]
12
+ **keywords** | **Array<String>** | | [optional]
13
+
14
+
@@ -0,0 +1,20 @@
1
+ # RusticiSoftwareCloudV2::ObjectiveSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | | [optional]
7
+ **primary** | **BOOLEAN** | | [optional]
8
+ **score** | [**ScoreSchema**](ScoreSchema.md) | | [optional]
9
+ **score_max** | **Float** | | [optional]
10
+ **score_min** | **Float** | | [optional]
11
+ **score_raw** | **Float** | | [optional]
12
+ **previous_score_scaled** | **Float** | | [optional]
13
+ **first_score_scaled** | **Float** | | [optional]
14
+ **progress_measure** | **Float** | | [optional]
15
+ **first_success_time_stamp** | **String** | | [optional]
16
+ **objective_completion** | **String** | | [optional] [default to 'UNKNOWN']
17
+ **objective_success** | **String** | | [optional] [default to 'UNKNOWN']
18
+ **previous_objective_success** | **String** | | [optional] [default to 'UNKNOWN']
19
+
20
+
@@ -0,0 +1,9 @@
1
+ # RusticiSoftwareCloudV2::PermissionsSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **scopes** | **Array<String>** | | [optional]
7
+ **application_name** | **String** | application these permissions apply to | [optional]
8
+
9
+
data/docs/PingApi.md ADDED
@@ -0,0 +1,57 @@
1
+ # RusticiSoftwareCloudV2::PingApi
2
+
3
+ All URIs are relative to *https://cloud.scorm.com/api/v2/*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**ping_app_id**](PingApi.md#ping_app_id) | **GET** /ping | Get back a message indicating that the API is working.
8
+
9
+
10
+ # **ping_app_id**
11
+ > PingSchema ping_app_id
12
+
13
+ Get back a message indicating that the API is working.
14
+
15
+ ### Example
16
+ ```ruby
17
+ # load the gem
18
+ require 'rustici_software_cloud_v2'
19
+ # setup authorization
20
+ RusticiSoftwareCloudV2.configure do |config|
21
+ # Configure HTTP basic authorization: APP_NORMAL
22
+ config.username = 'YOUR USERNAME'
23
+ config.password = 'YOUR PASSWORD'
24
+
25
+ # Configure OAuth2 access token for authorization: OAUTH
26
+ config.access_token = 'YOUR ACCESS TOKEN'
27
+ end
28
+
29
+ api_instance = RusticiSoftwareCloudV2::PingApi.new
30
+
31
+ begin
32
+ #Get back a message indicating that the API is working.
33
+ result = api_instance.ping_app_id
34
+ p result
35
+ rescue RusticiSoftwareCloudV2::ApiError => e
36
+ puts "Exception when calling PingApi->ping_app_id: #{e}"
37
+ end
38
+ ```
39
+
40
+ ### Parameters
41
+ This endpoint does not need any parameter.
42
+
43
+ ### Return type
44
+
45
+ [**PingSchema**](PingSchema.md)
46
+
47
+ ### Authorization
48
+
49
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
50
+
51
+ ### HTTP request headers
52
+
53
+ - **Content-Type**: application/json
54
+ - **Accept**: application/json
55
+
56
+
57
+
@@ -0,0 +1,8 @@
1
+ # RusticiSoftwareCloudV2::PingSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **message** | **String** | |
7
+
8
+
@@ -0,0 +1,12 @@
1
+ # RusticiSoftwareCloudV2::PostBackSchema
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **url** | **String** | | [optional]
7
+ **auth_type** | **String** | Optional parameter to specify how to authorize against the given postbackurl, can be 'form' or 'httpbasic'. If form authentication, the username and password for authentication are submitted as form fields 'username' and 'password', and the registration data as the form field 'data'. If httpbasic authentication is used, the username and password are placed in the standard Authorization HTTP header, and the registration data is the body of the message (sent as text/xml content type). This field is set to 'form' by default. | [optional] [default to 'UNDEFINED']
8
+ **user_name** | **String** | The user name to be used in authorizing the postback of data to the URL specified by postback url. | [optional]
9
+ **password** | **String** | The password to be used in authorizing the postback of data to the URL specified by postback url. | [optional]
10
+ **results_format** | **String** | This parameter allows you to specify a level of detail in the information that is posted back while the course is being taken. It may be one of three values: 'course' (course summary), 'activity' (activity summary, or 'full' (full detail), and is set to 'course' by default. The information will be posted as xml, and the format of that xml is specified below under the method 'getRegistrationResult' | [optional] [default to 'COURSE']
11
+
12
+
@@ -0,0 +1,1490 @@
1
+ # RusticiSoftwareCloudV2::RegistrationApi
2
+
3
+ All URIs are relative to *https://cloud.scorm.com/api/v2/*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**create_new_registration_instance**](RegistrationApi.md#create_new_registration_instance) | **POST** /registrations/{registrationId}/instances | Create a new instance for this registration specified by the registration ID
8
+ [**create_registration**](RegistrationApi.md#create_registration) | **POST** /registrations | Create a registration.
9
+ [**delete_registration**](RegistrationApi.md#delete_registration) | **DELETE** /registrations/{registrationId} | Delete `registrationId`
10
+ [**delete_registration_configuration_setting**](RegistrationApi.md#delete_registration_configuration_setting) | **DELETE** /registrations/{registrationId}/configuration/{settingId} | Clears the `settingId` value for this registration
11
+ [**delete_registration_instance_configuration_setting**](RegistrationApi.md#delete_registration_instance_configuration_setting) | **DELETE** /registrations/{registrationId}/instances/{instanceId}/configuration/{settingId} | Clears the `settingId` value for this registration instance
12
+ [**delete_registration_progress**](RegistrationApi.md#delete_registration_progress) | **DELETE** /registrations/{registrationId}/progress | Delete registration progress (clear registration)
13
+ [**delete_registration_tags**](RegistrationApi.md#delete_registration_tags) | **DELETE** /registrations/{registrationId}/tags | Delete tags for this registration
14
+ [**delete_registrations_global_data**](RegistrationApi.md#delete_registrations_global_data) | **DELETE** /registrations/{registrationId}/globalData | Delete global data associated with `registrationId`
15
+ [**get_registration_configuration**](RegistrationApi.md#get_registration_configuration) | **GET** /registrations/{registrationId}/configuration | Returns all configuration settings for this registration
16
+ [**get_registration_instance_configuration**](RegistrationApi.md#get_registration_instance_configuration) | **GET** /registrations/{registrationId}/instances/{instanceId}/configuration | Returns all configuration settings for this registration instance
17
+ [**get_registration_instance_launch_history**](RegistrationApi.md#get_registration_instance_launch_history) | **GET** /registrations/{registrationId}/instances/{instanceId}/launchHistory | Returns history of this registration's launches
18
+ [**get_registration_instance_progress**](RegistrationApi.md#get_registration_instance_progress) | **GET** /registrations/{registrationId}/instances/{instanceId} | Get registration progress for instance `instanceId` of `registrationId`
19
+ [**get_registration_instance_statements**](RegistrationApi.md#get_registration_instance_statements) | **GET** /registrations/{registrationId}/instances/{instanceId}/xAPIStatements | Get xAPI statements for instance `instanceId` of `registrationId`
20
+ [**get_registration_instances**](RegistrationApi.md#get_registration_instances) | **GET** /registrations/{registrationId}/instances | Get all the instances of this the registration specified by the registration ID
21
+ [**get_registration_launch_history**](RegistrationApi.md#get_registration_launch_history) | **GET** /registrations/{registrationId}/launchHistory | Returns history of this registration's launches
22
+ [**get_registration_launch_link**](RegistrationApi.md#get_registration_launch_link) | **POST** /registrations/{registrationId}/launchLink | Returns the link to use to launch this registration
23
+ [**get_registration_progress**](RegistrationApi.md#get_registration_progress) | **GET** /registrations/{registrationId} | Get registration progress for `registrationId`
24
+ [**get_registration_statements**](RegistrationApi.md#get_registration_statements) | **GET** /registrations/{registrationId}/xAPIStatements | Get xAPI statements for `registrationId`
25
+ [**get_registration_tags**](RegistrationApi.md#get_registration_tags) | **GET** /registrations/{registrationId}/tags | Get the tags for this registration
26
+ [**get_registrations**](RegistrationApi.md#get_registrations) | **GET** /registrations | Gets a list of registrations including a summary of the status of each registration.
27
+ [**put_registration_tags**](RegistrationApi.md#put_registration_tags) | **PUT** /registrations/{registrationId}/tags | Set the tags for this registration
28
+ [**put_registration_tags_batch**](RegistrationApi.md#put_registration_tags_batch) | **PUT** /registrations/tags | Sets all of the provided tags on all of the provided registrations
29
+ [**registration_exists**](RegistrationApi.md#registration_exists) | **HEAD** /registrations/{registrationId} | Does this registration exist?
30
+ [**set_registration_configuration**](RegistrationApi.md#set_registration_configuration) | **POST** /registrations/{registrationId}/configuration | Set configuration settings for this registration.
31
+ [**set_registration_instance_configuration**](RegistrationApi.md#set_registration_instance_configuration) | **POST** /registrations/{registrationId}/instances/{instanceId}/configuration | Set configuration settings for this registration instance.
32
+
33
+
34
+ # **create_new_registration_instance**
35
+ > create_new_registration_instance(registration_id, )
36
+
37
+ Create a new instance for this registration specified by the registration ID
38
+
39
+ ### Example
40
+ ```ruby
41
+ # load the gem
42
+ require 'rustici_software_cloud_v2'
43
+ # setup authorization
44
+ RusticiSoftwareCloudV2.configure do |config|
45
+ # Configure HTTP basic authorization: APP_NORMAL
46
+ config.username = 'YOUR USERNAME'
47
+ config.password = 'YOUR PASSWORD'
48
+
49
+ # Configure OAuth2 access token for authorization: OAUTH
50
+ config.access_token = 'YOUR ACCESS TOKEN'
51
+ end
52
+
53
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
54
+
55
+ registration_id = 'registration_id_example' # String | id for this registration
56
+
57
+
58
+ begin
59
+ #Create a new instance for this registration specified by the registration ID
60
+ api_instance.create_new_registration_instance(registration_id, )
61
+ rescue RusticiSoftwareCloudV2::ApiError => e
62
+ puts "Exception when calling RegistrationApi->create_new_registration_instance: #{e}"
63
+ end
64
+ ```
65
+
66
+ ### Parameters
67
+
68
+ Name | Type | Description | Notes
69
+ ------------- | ------------- | ------------- | -------------
70
+ **registration_id** | **String**| id for this registration |
71
+
72
+ ### Return type
73
+
74
+ nil (empty response body)
75
+
76
+ ### Authorization
77
+
78
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
79
+
80
+ ### HTTP request headers
81
+
82
+ - **Content-Type**: application/json
83
+ - **Accept**: application/json
84
+
85
+
86
+
87
+ # **create_registration**
88
+ > create_registration(registration, opts)
89
+
90
+ Create a registration.
91
+
92
+ ### Example
93
+ ```ruby
94
+ # load the gem
95
+ require 'rustici_software_cloud_v2'
96
+ # setup authorization
97
+ RusticiSoftwareCloudV2.configure do |config|
98
+ # Configure HTTP basic authorization: APP_NORMAL
99
+ config.username = 'YOUR USERNAME'
100
+ config.password = 'YOUR PASSWORD'
101
+
102
+ # Configure OAuth2 access token for authorization: OAUTH
103
+ config.access_token = 'YOUR ACCESS TOKEN'
104
+ end
105
+
106
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
107
+
108
+ registration = RusticiSoftwareCloudV2::CreateRegistrationSchema.new # CreateRegistrationSchema |
109
+
110
+ opts = {
111
+ course_version: 56 # Integer | The version of the course you want to create the registration for. Unless you have a reason for using this you probably do not need to.
112
+ }
113
+
114
+ begin
115
+ #Create a registration.
116
+ api_instance.create_registration(registration, opts)
117
+ rescue RusticiSoftwareCloudV2::ApiError => e
118
+ puts "Exception when calling RegistrationApi->create_registration: #{e}"
119
+ end
120
+ ```
121
+
122
+ ### Parameters
123
+
124
+ Name | Type | Description | Notes
125
+ ------------- | ------------- | ------------- | -------------
126
+ **registration** | [**CreateRegistrationSchema**](CreateRegistrationSchema.md)| |
127
+ **course_version** | **Integer**| The version of the course you want to create the registration for. Unless you have a reason for using this you probably do not need to. | [optional]
128
+
129
+ ### Return type
130
+
131
+ nil (empty response body)
132
+
133
+ ### Authorization
134
+
135
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
136
+
137
+ ### HTTP request headers
138
+
139
+ - **Content-Type**: application/json
140
+ - **Accept**: application/json
141
+
142
+
143
+
144
+ # **delete_registration**
145
+ > delete_registration(registration_id, )
146
+
147
+ Delete `registrationId`
148
+
149
+ ### Example
150
+ ```ruby
151
+ # load the gem
152
+ require 'rustici_software_cloud_v2'
153
+ # setup authorization
154
+ RusticiSoftwareCloudV2.configure do |config|
155
+ # Configure HTTP basic authorization: APP_NORMAL
156
+ config.username = 'YOUR USERNAME'
157
+ config.password = 'YOUR PASSWORD'
158
+
159
+ # Configure OAuth2 access token for authorization: OAUTH
160
+ config.access_token = 'YOUR ACCESS TOKEN'
161
+ end
162
+
163
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
164
+
165
+ registration_id = 'registration_id_example' # String | id for this registration
166
+
167
+
168
+ begin
169
+ #Delete `registrationId`
170
+ api_instance.delete_registration(registration_id, )
171
+ rescue RusticiSoftwareCloudV2::ApiError => e
172
+ puts "Exception when calling RegistrationApi->delete_registration: #{e}"
173
+ end
174
+ ```
175
+
176
+ ### Parameters
177
+
178
+ Name | Type | Description | Notes
179
+ ------------- | ------------- | ------------- | -------------
180
+ **registration_id** | **String**| id for this registration |
181
+
182
+ ### Return type
183
+
184
+ nil (empty response body)
185
+
186
+ ### Authorization
187
+
188
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
189
+
190
+ ### HTTP request headers
191
+
192
+ - **Content-Type**: application/json
193
+ - **Accept**: application/json
194
+
195
+
196
+
197
+ # **delete_registration_configuration_setting**
198
+ > delete_registration_configuration_setting(registration_id, setting_id)
199
+
200
+ Clears the `settingId` value for this registration
201
+
202
+ ### Example
203
+ ```ruby
204
+ # load the gem
205
+ require 'rustici_software_cloud_v2'
206
+ # setup authorization
207
+ RusticiSoftwareCloudV2.configure do |config|
208
+ # Configure HTTP basic authorization: APP_NORMAL
209
+ config.username = 'YOUR USERNAME'
210
+ config.password = 'YOUR PASSWORD'
211
+
212
+ # Configure OAuth2 access token for authorization: OAUTH
213
+ config.access_token = 'YOUR ACCESS TOKEN'
214
+ end
215
+
216
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
217
+
218
+ registration_id = 'registration_id_example' # String | id for this registration
219
+
220
+ setting_id = 'setting_id_example' # String |
221
+
222
+
223
+ begin
224
+ #Clears the `settingId` value for this registration
225
+ api_instance.delete_registration_configuration_setting(registration_id, setting_id)
226
+ rescue RusticiSoftwareCloudV2::ApiError => e
227
+ puts "Exception when calling RegistrationApi->delete_registration_configuration_setting: #{e}"
228
+ end
229
+ ```
230
+
231
+ ### Parameters
232
+
233
+ Name | Type | Description | Notes
234
+ ------------- | ------------- | ------------- | -------------
235
+ **registration_id** | **String**| id for this registration |
236
+ **setting_id** | **String**| |
237
+
238
+ ### Return type
239
+
240
+ nil (empty response body)
241
+
242
+ ### Authorization
243
+
244
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
245
+
246
+ ### HTTP request headers
247
+
248
+ - **Content-Type**: application/json
249
+ - **Accept**: application/json
250
+
251
+
252
+
253
+ # **delete_registration_instance_configuration_setting**
254
+ > delete_registration_instance_configuration_setting(registration_id, instance_id, setting_id)
255
+
256
+ Clears the `settingId` value for this registration instance
257
+
258
+ ### Example
259
+ ```ruby
260
+ # load the gem
261
+ require 'rustici_software_cloud_v2'
262
+ # setup authorization
263
+ RusticiSoftwareCloudV2.configure do |config|
264
+ # Configure HTTP basic authorization: APP_NORMAL
265
+ config.username = 'YOUR USERNAME'
266
+ config.password = 'YOUR PASSWORD'
267
+
268
+ # Configure OAuth2 access token for authorization: OAUTH
269
+ config.access_token = 'YOUR ACCESS TOKEN'
270
+ end
271
+
272
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
273
+
274
+ registration_id = 'registration_id_example' # String | id for this registration
275
+
276
+ instance_id = 56 # Integer | The instance of this registration
277
+
278
+ setting_id = 'setting_id_example' # String |
279
+
280
+
281
+ begin
282
+ #Clears the `settingId` value for this registration instance
283
+ api_instance.delete_registration_instance_configuration_setting(registration_id, instance_id, setting_id)
284
+ rescue RusticiSoftwareCloudV2::ApiError => e
285
+ puts "Exception when calling RegistrationApi->delete_registration_instance_configuration_setting: #{e}"
286
+ end
287
+ ```
288
+
289
+ ### Parameters
290
+
291
+ Name | Type | Description | Notes
292
+ ------------- | ------------- | ------------- | -------------
293
+ **registration_id** | **String**| id for this registration |
294
+ **instance_id** | **Integer**| The instance of this registration |
295
+ **setting_id** | **String**| |
296
+
297
+ ### Return type
298
+
299
+ nil (empty response body)
300
+
301
+ ### Authorization
302
+
303
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
304
+
305
+ ### HTTP request headers
306
+
307
+ - **Content-Type**: application/json
308
+ - **Accept**: application/json
309
+
310
+
311
+
312
+ # **delete_registration_progress**
313
+ > delete_registration_progress(registration_id, )
314
+
315
+ Delete registration progress (clear registration)
316
+
317
+ ### Example
318
+ ```ruby
319
+ # load the gem
320
+ require 'rustici_software_cloud_v2'
321
+ # setup authorization
322
+ RusticiSoftwareCloudV2.configure do |config|
323
+ # Configure HTTP basic authorization: APP_NORMAL
324
+ config.username = 'YOUR USERNAME'
325
+ config.password = 'YOUR PASSWORD'
326
+
327
+ # Configure OAuth2 access token for authorization: OAUTH
328
+ config.access_token = 'YOUR ACCESS TOKEN'
329
+ end
330
+
331
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
332
+
333
+ registration_id = 'registration_id_example' # String | id for this registration
334
+
335
+
336
+ begin
337
+ #Delete registration progress (clear registration)
338
+ api_instance.delete_registration_progress(registration_id, )
339
+ rescue RusticiSoftwareCloudV2::ApiError => e
340
+ puts "Exception when calling RegistrationApi->delete_registration_progress: #{e}"
341
+ end
342
+ ```
343
+
344
+ ### Parameters
345
+
346
+ Name | Type | Description | Notes
347
+ ------------- | ------------- | ------------- | -------------
348
+ **registration_id** | **String**| id for this registration |
349
+
350
+ ### Return type
351
+
352
+ nil (empty response body)
353
+
354
+ ### Authorization
355
+
356
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
357
+
358
+ ### HTTP request headers
359
+
360
+ - **Content-Type**: application/json
361
+ - **Accept**: application/json
362
+
363
+
364
+
365
+ # **delete_registration_tags**
366
+ > delete_registration_tags(registration_id, tags)
367
+
368
+ Delete tags for this registration
369
+
370
+ ### Example
371
+ ```ruby
372
+ # load the gem
373
+ require 'rustici_software_cloud_v2'
374
+ # setup authorization
375
+ RusticiSoftwareCloudV2.configure do |config|
376
+ # Configure HTTP basic authorization: APP_NORMAL
377
+ config.username = 'YOUR USERNAME'
378
+ config.password = 'YOUR PASSWORD'
379
+
380
+ # Configure OAuth2 access token for authorization: OAUTH
381
+ config.access_token = 'YOUR ACCESS TOKEN'
382
+ end
383
+
384
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
385
+
386
+ registration_id = 'registration_id_example' # String | id for this registration
387
+
388
+ tags = RusticiSoftwareCloudV2::TagListSchema.new # TagListSchema |
389
+
390
+
391
+ begin
392
+ #Delete tags for this registration
393
+ api_instance.delete_registration_tags(registration_id, tags)
394
+ rescue RusticiSoftwareCloudV2::ApiError => e
395
+ puts "Exception when calling RegistrationApi->delete_registration_tags: #{e}"
396
+ end
397
+ ```
398
+
399
+ ### Parameters
400
+
401
+ Name | Type | Description | Notes
402
+ ------------- | ------------- | ------------- | -------------
403
+ **registration_id** | **String**| id for this registration |
404
+ **tags** | [**TagListSchema**](TagListSchema.md)| |
405
+
406
+ ### Return type
407
+
408
+ nil (empty response body)
409
+
410
+ ### Authorization
411
+
412
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
413
+
414
+ ### HTTP request headers
415
+
416
+ - **Content-Type**: application/json
417
+ - **Accept**: application/json
418
+
419
+
420
+
421
+ # **delete_registrations_global_data**
422
+ > delete_registrations_global_data(registration_id, )
423
+
424
+ Delete global data associated with `registrationId`
425
+
426
+ ### Example
427
+ ```ruby
428
+ # load the gem
429
+ require 'rustici_software_cloud_v2'
430
+ # setup authorization
431
+ RusticiSoftwareCloudV2.configure do |config|
432
+ # Configure HTTP basic authorization: APP_NORMAL
433
+ config.username = 'YOUR USERNAME'
434
+ config.password = 'YOUR PASSWORD'
435
+
436
+ # Configure OAuth2 access token for authorization: OAUTH
437
+ config.access_token = 'YOUR ACCESS TOKEN'
438
+ end
439
+
440
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
441
+
442
+ registration_id = 'registration_id_example' # String | id for this registration
443
+
444
+
445
+ begin
446
+ #Delete global data associated with `registrationId`
447
+ api_instance.delete_registrations_global_data(registration_id, )
448
+ rescue RusticiSoftwareCloudV2::ApiError => e
449
+ puts "Exception when calling RegistrationApi->delete_registrations_global_data: #{e}"
450
+ end
451
+ ```
452
+
453
+ ### Parameters
454
+
455
+ Name | Type | Description | Notes
456
+ ------------- | ------------- | ------------- | -------------
457
+ **registration_id** | **String**| id for this registration |
458
+
459
+ ### Return type
460
+
461
+ nil (empty response body)
462
+
463
+ ### Authorization
464
+
465
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
466
+
467
+ ### HTTP request headers
468
+
469
+ - **Content-Type**: application/json
470
+ - **Accept**: application/json
471
+
472
+
473
+
474
+ # **get_registration_configuration**
475
+ > SettingListSchema get_registration_configuration(registration_id, , opts)
476
+
477
+ Returns all configuration settings for this registration
478
+
479
+ ### Example
480
+ ```ruby
481
+ # load the gem
482
+ require 'rustici_software_cloud_v2'
483
+ # setup authorization
484
+ RusticiSoftwareCloudV2.configure do |config|
485
+ # Configure HTTP basic authorization: APP_NORMAL
486
+ config.username = 'YOUR USERNAME'
487
+ config.password = 'YOUR PASSWORD'
488
+
489
+ # Configure OAuth2 access token for authorization: OAUTH
490
+ config.access_token = 'YOUR ACCESS TOKEN'
491
+ end
492
+
493
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
494
+
495
+ registration_id = 'registration_id_example' # String | id for this registration
496
+
497
+ opts = {
498
+ include_metadata: false # BOOLEAN |
499
+ }
500
+
501
+ begin
502
+ #Returns all configuration settings for this registration
503
+ result = api_instance.get_registration_configuration(registration_id, , opts)
504
+ p result
505
+ rescue RusticiSoftwareCloudV2::ApiError => e
506
+ puts "Exception when calling RegistrationApi->get_registration_configuration: #{e}"
507
+ end
508
+ ```
509
+
510
+ ### Parameters
511
+
512
+ Name | Type | Description | Notes
513
+ ------------- | ------------- | ------------- | -------------
514
+ **registration_id** | **String**| id for this registration |
515
+ **include_metadata** | **BOOLEAN**| | [optional] [default to false]
516
+
517
+ ### Return type
518
+
519
+ [**SettingListSchema**](SettingListSchema.md)
520
+
521
+ ### Authorization
522
+
523
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
524
+
525
+ ### HTTP request headers
526
+
527
+ - **Content-Type**: application/json
528
+ - **Accept**: application/json
529
+
530
+
531
+
532
+ # **get_registration_instance_configuration**
533
+ > SettingListSchema get_registration_instance_configuration(registration_id, instance_id, , opts)
534
+
535
+ Returns all configuration settings for this registration instance
536
+
537
+ ### Example
538
+ ```ruby
539
+ # load the gem
540
+ require 'rustici_software_cloud_v2'
541
+ # setup authorization
542
+ RusticiSoftwareCloudV2.configure do |config|
543
+ # Configure HTTP basic authorization: APP_NORMAL
544
+ config.username = 'YOUR USERNAME'
545
+ config.password = 'YOUR PASSWORD'
546
+
547
+ # Configure OAuth2 access token for authorization: OAUTH
548
+ config.access_token = 'YOUR ACCESS TOKEN'
549
+ end
550
+
551
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
552
+
553
+ registration_id = 'registration_id_example' # String | id for this registration
554
+
555
+ instance_id = 56 # Integer | The instance of this registration
556
+
557
+ opts = {
558
+ include_metadata: false # BOOLEAN |
559
+ }
560
+
561
+ begin
562
+ #Returns all configuration settings for this registration instance
563
+ result = api_instance.get_registration_instance_configuration(registration_id, instance_id, , opts)
564
+ p result
565
+ rescue RusticiSoftwareCloudV2::ApiError => e
566
+ puts "Exception when calling RegistrationApi->get_registration_instance_configuration: #{e}"
567
+ end
568
+ ```
569
+
570
+ ### Parameters
571
+
572
+ Name | Type | Description | Notes
573
+ ------------- | ------------- | ------------- | -------------
574
+ **registration_id** | **String**| id for this registration |
575
+ **instance_id** | **Integer**| The instance of this registration |
576
+ **include_metadata** | **BOOLEAN**| | [optional] [default to false]
577
+
578
+ ### Return type
579
+
580
+ [**SettingListSchema**](SettingListSchema.md)
581
+
582
+ ### Authorization
583
+
584
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
585
+
586
+ ### HTTP request headers
587
+
588
+ - **Content-Type**: application/json
589
+ - **Accept**: application/json
590
+
591
+
592
+
593
+ # **get_registration_instance_launch_history**
594
+ > LaunchHistoryListSchema get_registration_instance_launch_history(registration_id, instance_id, , opts)
595
+
596
+ Returns history of this registration's launches
597
+
598
+ ### Example
599
+ ```ruby
600
+ # load the gem
601
+ require 'rustici_software_cloud_v2'
602
+ # setup authorization
603
+ RusticiSoftwareCloudV2.configure do |config|
604
+ # Configure HTTP basic authorization: APP_NORMAL
605
+ config.username = 'YOUR USERNAME'
606
+ config.password = 'YOUR PASSWORD'
607
+
608
+ # Configure OAuth2 access token for authorization: OAUTH
609
+ config.access_token = 'YOUR ACCESS TOKEN'
610
+ end
611
+
612
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
613
+
614
+ registration_id = 'registration_id_example' # String | id for this registration
615
+
616
+ instance_id = 56 # Integer | The instance of this registration
617
+
618
+ opts = {
619
+ include_history_log: false # BOOLEAN | Whether to include the history log in the launch history
620
+ }
621
+
622
+ begin
623
+ #Returns history of this registration's launches
624
+ result = api_instance.get_registration_instance_launch_history(registration_id, instance_id, , opts)
625
+ p result
626
+ rescue RusticiSoftwareCloudV2::ApiError => e
627
+ puts "Exception when calling RegistrationApi->get_registration_instance_launch_history: #{e}"
628
+ end
629
+ ```
630
+
631
+ ### Parameters
632
+
633
+ Name | Type | Description | Notes
634
+ ------------- | ------------- | ------------- | -------------
635
+ **registration_id** | **String**| id for this registration |
636
+ **instance_id** | **Integer**| The instance of this registration |
637
+ **include_history_log** | **BOOLEAN**| Whether to include the history log in the launch history | [optional] [default to false]
638
+
639
+ ### Return type
640
+
641
+ [**LaunchHistoryListSchema**](LaunchHistoryListSchema.md)
642
+
643
+ ### Authorization
644
+
645
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
646
+
647
+ ### HTTP request headers
648
+
649
+ - **Content-Type**: application/json
650
+ - **Accept**: application/json
651
+
652
+
653
+
654
+ # **get_registration_instance_progress**
655
+ > RegistrationSchema get_registration_instance_progress(registration_id, instance_id, , opts)
656
+
657
+ Get registration progress for instance `instanceId` of `registrationId`
658
+
659
+ ### Example
660
+ ```ruby
661
+ # load the gem
662
+ require 'rustici_software_cloud_v2'
663
+ # setup authorization
664
+ RusticiSoftwareCloudV2.configure do |config|
665
+ # Configure HTTP basic authorization: APP_NORMAL
666
+ config.username = 'YOUR USERNAME'
667
+ config.password = 'YOUR PASSWORD'
668
+
669
+ # Configure OAuth2 access token for authorization: OAUTH
670
+ config.access_token = 'YOUR ACCESS TOKEN'
671
+ end
672
+
673
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
674
+
675
+ registration_id = 'registration_id_example' # String | id for this registration
676
+
677
+ instance_id = 56 # Integer | The instance of this registration
678
+
679
+ opts = {
680
+ include_child_results: false, # BOOLEAN | Include information about each learning object, not just the top level in the results
681
+ include_interactions_and_objectives: false, # BOOLEAN | Include interactions and objectives in the results
682
+ include_runtime: false # BOOLEAN | Include runtime details in the results
683
+ }
684
+
685
+ begin
686
+ #Get registration progress for instance `instanceId` of `registrationId`
687
+ result = api_instance.get_registration_instance_progress(registration_id, instance_id, , opts)
688
+ p result
689
+ rescue RusticiSoftwareCloudV2::ApiError => e
690
+ puts "Exception when calling RegistrationApi->get_registration_instance_progress: #{e}"
691
+ end
692
+ ```
693
+
694
+ ### Parameters
695
+
696
+ Name | Type | Description | Notes
697
+ ------------- | ------------- | ------------- | -------------
698
+ **registration_id** | **String**| id for this registration |
699
+ **instance_id** | **Integer**| The instance of this registration |
700
+ **include_child_results** | **BOOLEAN**| Include information about each learning object, not just the top level in the results | [optional] [default to false]
701
+ **include_interactions_and_objectives** | **BOOLEAN**| Include interactions and objectives in the results | [optional] [default to false]
702
+ **include_runtime** | **BOOLEAN**| Include runtime details in the results | [optional] [default to false]
703
+
704
+ ### Return type
705
+
706
+ [**RegistrationSchema**](RegistrationSchema.md)
707
+
708
+ ### Authorization
709
+
710
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
711
+
712
+ ### HTTP request headers
713
+
714
+ - **Content-Type**: application/json
715
+ - **Accept**: application/json
716
+
717
+
718
+
719
+ # **get_registration_instance_statements**
720
+ > XapiStatementResult get_registration_instance_statements(registration_id, instance_id, , opts)
721
+
722
+ Get xAPI statements for instance `instanceId` of `registrationId`
723
+
724
+ ### Example
725
+ ```ruby
726
+ # load the gem
727
+ require 'rustici_software_cloud_v2'
728
+ # setup authorization
729
+ RusticiSoftwareCloudV2.configure do |config|
730
+ # Configure HTTP basic authorization: APP_NORMAL
731
+ config.username = 'YOUR USERNAME'
732
+ config.password = 'YOUR PASSWORD'
733
+
734
+ # Configure OAuth2 access token for authorization: OAUTH
735
+ config.access_token = 'YOUR ACCESS TOKEN'
736
+ end
737
+
738
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
739
+
740
+ registration_id = 'registration_id_example' # String | id for this registration
741
+
742
+ instance_id = 56 # Integer | The instance of this registration
743
+
744
+ opts = {
745
+ since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
746
+ _until: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
747
+ more: 'more_example', # String | Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
748
+ }
749
+
750
+ begin
751
+ #Get xAPI statements for instance `instanceId` of `registrationId`
752
+ result = api_instance.get_registration_instance_statements(registration_id, instance_id, , opts)
753
+ p result
754
+ rescue RusticiSoftwareCloudV2::ApiError => e
755
+ puts "Exception when calling RegistrationApi->get_registration_instance_statements: #{e}"
756
+ end
757
+ ```
758
+
759
+ ### Parameters
760
+
761
+ Name | Type | Description | Notes
762
+ ------------- | ------------- | ------------- | -------------
763
+ **registration_id** | **String**| id for this registration |
764
+ **instance_id** | **Integer**| The instance of this registration |
765
+ **since** | **DateTime**| Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used. | [optional]
766
+ **_until** | **DateTime**| Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used. | [optional]
767
+ **more** | **String**| Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice. | [optional]
768
+
769
+ ### Return type
770
+
771
+ [**XapiStatementResult**](XapiStatementResult.md)
772
+
773
+ ### Authorization
774
+
775
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
776
+
777
+ ### HTTP request headers
778
+
779
+ - **Content-Type**: application/json
780
+ - **Accept**: application/json
781
+
782
+
783
+
784
+ # **get_registration_instances**
785
+ > RegistrationListSchema get_registration_instances(registration_id, , opts)
786
+
787
+ Get all the instances of this the registration specified by the registration ID
788
+
789
+ ### Example
790
+ ```ruby
791
+ # load the gem
792
+ require 'rustici_software_cloud_v2'
793
+ # setup authorization
794
+ RusticiSoftwareCloudV2.configure do |config|
795
+ # Configure HTTP basic authorization: APP_NORMAL
796
+ config.username = 'YOUR USERNAME'
797
+ config.password = 'YOUR PASSWORD'
798
+
799
+ # Configure OAuth2 access token for authorization: OAUTH
800
+ config.access_token = 'YOUR ACCESS TOKEN'
801
+ end
802
+
803
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
804
+
805
+ registration_id = 'registration_id_example' # String | id for this registration
806
+
807
+ opts = {
808
+ _until: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
809
+ since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
810
+ more: 'more_example', # String | Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
811
+ include_child_results: false, # BOOLEAN | Include information about each learning object, not just the top level in the results
812
+ include_interactions_and_objectives: false, # BOOLEAN | Include interactions and objectives in the results
813
+ include_runtime: false # BOOLEAN | Include runtime details in the results
814
+ }
815
+
816
+ begin
817
+ #Get all the instances of this the registration specified by the registration ID
818
+ result = api_instance.get_registration_instances(registration_id, , opts)
819
+ p result
820
+ rescue RusticiSoftwareCloudV2::ApiError => e
821
+ puts "Exception when calling RegistrationApi->get_registration_instances: #{e}"
822
+ end
823
+ ```
824
+
825
+ ### Parameters
826
+
827
+ Name | Type | Description | Notes
828
+ ------------- | ------------- | ------------- | -------------
829
+ **registration_id** | **String**| id for this registration |
830
+ **_until** | **DateTime**| Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used. | [optional]
831
+ **since** | **DateTime**| Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used. | [optional]
832
+ **more** | **String**| Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice. | [optional]
833
+ **include_child_results** | **BOOLEAN**| Include information about each learning object, not just the top level in the results | [optional] [default to false]
834
+ **include_interactions_and_objectives** | **BOOLEAN**| Include interactions and objectives in the results | [optional] [default to false]
835
+ **include_runtime** | **BOOLEAN**| Include runtime details in the results | [optional] [default to false]
836
+
837
+ ### Return type
838
+
839
+ [**RegistrationListSchema**](RegistrationListSchema.md)
840
+
841
+ ### Authorization
842
+
843
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
844
+
845
+ ### HTTP request headers
846
+
847
+ - **Content-Type**: application/json
848
+ - **Accept**: application/json
849
+
850
+
851
+
852
+ # **get_registration_launch_history**
853
+ > LaunchHistoryListSchema get_registration_launch_history(registration_id, , opts)
854
+
855
+ Returns history of this registration's launches
856
+
857
+ ### Example
858
+ ```ruby
859
+ # load the gem
860
+ require 'rustici_software_cloud_v2'
861
+ # setup authorization
862
+ RusticiSoftwareCloudV2.configure do |config|
863
+ # Configure HTTP basic authorization: APP_NORMAL
864
+ config.username = 'YOUR USERNAME'
865
+ config.password = 'YOUR PASSWORD'
866
+
867
+ # Configure OAuth2 access token for authorization: OAUTH
868
+ config.access_token = 'YOUR ACCESS TOKEN'
869
+ end
870
+
871
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
872
+
873
+ registration_id = 'registration_id_example' # String | id for this registration
874
+
875
+ opts = {
876
+ include_history_log: false # BOOLEAN | Whether to include the history log in the launch history
877
+ }
878
+
879
+ begin
880
+ #Returns history of this registration's launches
881
+ result = api_instance.get_registration_launch_history(registration_id, , opts)
882
+ p result
883
+ rescue RusticiSoftwareCloudV2::ApiError => e
884
+ puts "Exception when calling RegistrationApi->get_registration_launch_history: #{e}"
885
+ end
886
+ ```
887
+
888
+ ### Parameters
889
+
890
+ Name | Type | Description | Notes
891
+ ------------- | ------------- | ------------- | -------------
892
+ **registration_id** | **String**| id for this registration |
893
+ **include_history_log** | **BOOLEAN**| Whether to include the history log in the launch history | [optional] [default to false]
894
+
895
+ ### Return type
896
+
897
+ [**LaunchHistoryListSchema**](LaunchHistoryListSchema.md)
898
+
899
+ ### Authorization
900
+
901
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
902
+
903
+ ### HTTP request headers
904
+
905
+ - **Content-Type**: application/json
906
+ - **Accept**: application/json
907
+
908
+
909
+
910
+ # **get_registration_launch_link**
911
+ > LaunchLinkSchema get_registration_launch_link(registration_id, launch_link_request)
912
+
913
+ Returns the link to use to launch this registration
914
+
915
+ ### Example
916
+ ```ruby
917
+ # load the gem
918
+ require 'rustici_software_cloud_v2'
919
+ # setup authorization
920
+ RusticiSoftwareCloudV2.configure do |config|
921
+ # Configure HTTP basic authorization: APP_NORMAL
922
+ config.username = 'YOUR USERNAME'
923
+ config.password = 'YOUR PASSWORD'
924
+
925
+ # Configure OAuth2 access token for authorization: OAUTH
926
+ config.access_token = 'YOUR ACCESS TOKEN'
927
+ end
928
+
929
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
930
+
931
+ registration_id = 'registration_id_example' # String | id for this registration
932
+
933
+ launch_link_request = RusticiSoftwareCloudV2::LaunchLinkRequestSchema.new # LaunchLinkRequestSchema |
934
+
935
+
936
+ begin
937
+ #Returns the link to use to launch this registration
938
+ result = api_instance.get_registration_launch_link(registration_id, launch_link_request)
939
+ p result
940
+ rescue RusticiSoftwareCloudV2::ApiError => e
941
+ puts "Exception when calling RegistrationApi->get_registration_launch_link: #{e}"
942
+ end
943
+ ```
944
+
945
+ ### Parameters
946
+
947
+ Name | Type | Description | Notes
948
+ ------------- | ------------- | ------------- | -------------
949
+ **registration_id** | **String**| id for this registration |
950
+ **launch_link_request** | [**LaunchLinkRequestSchema**](LaunchLinkRequestSchema.md)| |
951
+
952
+ ### Return type
953
+
954
+ [**LaunchLinkSchema**](LaunchLinkSchema.md)
955
+
956
+ ### Authorization
957
+
958
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
959
+
960
+ ### HTTP request headers
961
+
962
+ - **Content-Type**: application/json
963
+ - **Accept**: application/json
964
+
965
+
966
+
967
+ # **get_registration_progress**
968
+ > RegistrationSchema get_registration_progress(registration_id, , opts)
969
+
970
+ Get registration progress for `registrationId`
971
+
972
+ ### Example
973
+ ```ruby
974
+ # load the gem
975
+ require 'rustici_software_cloud_v2'
976
+ # setup authorization
977
+ RusticiSoftwareCloudV2.configure do |config|
978
+ # Configure HTTP basic authorization: APP_NORMAL
979
+ config.username = 'YOUR USERNAME'
980
+ config.password = 'YOUR PASSWORD'
981
+
982
+ # Configure OAuth2 access token for authorization: OAUTH
983
+ config.access_token = 'YOUR ACCESS TOKEN'
984
+ end
985
+
986
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
987
+
988
+ registration_id = 'registration_id_example' # String | id for this registration
989
+
990
+ opts = {
991
+ include_child_results: false, # BOOLEAN | Include information about each learning object, not just the top level in the results
992
+ include_interactions_and_objectives: false, # BOOLEAN | Include interactions and objectives in the results
993
+ include_runtime: false # BOOLEAN | Include runtime details in the results
994
+ }
995
+
996
+ begin
997
+ #Get registration progress for `registrationId`
998
+ result = api_instance.get_registration_progress(registration_id, , opts)
999
+ p result
1000
+ rescue RusticiSoftwareCloudV2::ApiError => e
1001
+ puts "Exception when calling RegistrationApi->get_registration_progress: #{e}"
1002
+ end
1003
+ ```
1004
+
1005
+ ### Parameters
1006
+
1007
+ Name | Type | Description | Notes
1008
+ ------------- | ------------- | ------------- | -------------
1009
+ **registration_id** | **String**| id for this registration |
1010
+ **include_child_results** | **BOOLEAN**| Include information about each learning object, not just the top level in the results | [optional] [default to false]
1011
+ **include_interactions_and_objectives** | **BOOLEAN**| Include interactions and objectives in the results | [optional] [default to false]
1012
+ **include_runtime** | **BOOLEAN**| Include runtime details in the results | [optional] [default to false]
1013
+
1014
+ ### Return type
1015
+
1016
+ [**RegistrationSchema**](RegistrationSchema.md)
1017
+
1018
+ ### Authorization
1019
+
1020
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
1021
+
1022
+ ### HTTP request headers
1023
+
1024
+ - **Content-Type**: application/json
1025
+ - **Accept**: application/json
1026
+
1027
+
1028
+
1029
+ # **get_registration_statements**
1030
+ > XapiStatementResult get_registration_statements(registration_id, , opts)
1031
+
1032
+ Get xAPI statements for `registrationId`
1033
+
1034
+ ### Example
1035
+ ```ruby
1036
+ # load the gem
1037
+ require 'rustici_software_cloud_v2'
1038
+ # setup authorization
1039
+ RusticiSoftwareCloudV2.configure do |config|
1040
+ # Configure HTTP basic authorization: APP_NORMAL
1041
+ config.username = 'YOUR USERNAME'
1042
+ config.password = 'YOUR PASSWORD'
1043
+
1044
+ # Configure OAuth2 access token for authorization: OAUTH
1045
+ config.access_token = 'YOUR ACCESS TOKEN'
1046
+ end
1047
+
1048
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
1049
+
1050
+ registration_id = 'registration_id_example' # String | id for this registration
1051
+
1052
+ opts = {
1053
+ since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1054
+ _until: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1055
+ more: 'more_example', # String | Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
1056
+ }
1057
+
1058
+ begin
1059
+ #Get xAPI statements for `registrationId`
1060
+ result = api_instance.get_registration_statements(registration_id, , opts)
1061
+ p result
1062
+ rescue RusticiSoftwareCloudV2::ApiError => e
1063
+ puts "Exception when calling RegistrationApi->get_registration_statements: #{e}"
1064
+ end
1065
+ ```
1066
+
1067
+ ### Parameters
1068
+
1069
+ Name | Type | Description | Notes
1070
+ ------------- | ------------- | ------------- | -------------
1071
+ **registration_id** | **String**| id for this registration |
1072
+ **since** | **DateTime**| Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used. | [optional]
1073
+ **_until** | **DateTime**| Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used. | [optional]
1074
+ **more** | **String**| Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice. | [optional]
1075
+
1076
+ ### Return type
1077
+
1078
+ [**XapiStatementResult**](XapiStatementResult.md)
1079
+
1080
+ ### Authorization
1081
+
1082
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
1083
+
1084
+ ### HTTP request headers
1085
+
1086
+ - **Content-Type**: application/json
1087
+ - **Accept**: application/json
1088
+
1089
+
1090
+
1091
+ # **get_registration_tags**
1092
+ > TagListSchema get_registration_tags(registration_id, )
1093
+
1094
+ Get the tags for this registration
1095
+
1096
+ ### Example
1097
+ ```ruby
1098
+ # load the gem
1099
+ require 'rustici_software_cloud_v2'
1100
+ # setup authorization
1101
+ RusticiSoftwareCloudV2.configure do |config|
1102
+ # Configure HTTP basic authorization: APP_NORMAL
1103
+ config.username = 'YOUR USERNAME'
1104
+ config.password = 'YOUR PASSWORD'
1105
+
1106
+ # Configure OAuth2 access token for authorization: OAUTH
1107
+ config.access_token = 'YOUR ACCESS TOKEN'
1108
+ end
1109
+
1110
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
1111
+
1112
+ registration_id = 'registration_id_example' # String | id for this registration
1113
+
1114
+
1115
+ begin
1116
+ #Get the tags for this registration
1117
+ result = api_instance.get_registration_tags(registration_id, )
1118
+ p result
1119
+ rescue RusticiSoftwareCloudV2::ApiError => e
1120
+ puts "Exception when calling RegistrationApi->get_registration_tags: #{e}"
1121
+ end
1122
+ ```
1123
+
1124
+ ### Parameters
1125
+
1126
+ Name | Type | Description | Notes
1127
+ ------------- | ------------- | ------------- | -------------
1128
+ **registration_id** | **String**| id for this registration |
1129
+
1130
+ ### Return type
1131
+
1132
+ [**TagListSchema**](TagListSchema.md)
1133
+
1134
+ ### Authorization
1135
+
1136
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
1137
+
1138
+ ### HTTP request headers
1139
+
1140
+ - **Content-Type**: application/json
1141
+ - **Accept**: application/json
1142
+
1143
+
1144
+
1145
+ # **get_registrations**
1146
+ > RegistrationListSchema get_registrations(opts)
1147
+
1148
+ Gets a list of registrations including a summary of the status of each registration.
1149
+
1150
+ ### Example
1151
+ ```ruby
1152
+ # load the gem
1153
+ require 'rustici_software_cloud_v2'
1154
+ # setup authorization
1155
+ RusticiSoftwareCloudV2.configure do |config|
1156
+ # Configure HTTP basic authorization: APP_NORMAL
1157
+ config.username = 'YOUR USERNAME'
1158
+ config.password = 'YOUR PASSWORD'
1159
+
1160
+ # Configure OAuth2 access token for authorization: OAUTH
1161
+ config.access_token = 'YOUR ACCESS TOKEN'
1162
+ end
1163
+
1164
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
1165
+
1166
+ opts = {
1167
+ course_id: 'course_id_example', # String | Only registrations for the specified course id will be included.
1168
+ learner_id: 'learner_id_example', # String | Only registrations for the specified learner id will be included.
1169
+ since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1170
+ _until: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1171
+ more: 'more_example', # String | Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
1172
+ include_child_results: false, # BOOLEAN | Include information about each learning object, not just the top level in the results
1173
+ include_interactions_and_objectives: false, # BOOLEAN | Include interactions and objectives in the results
1174
+ include_runtime: false # BOOLEAN | Include runtime details in the results
1175
+ }
1176
+
1177
+ begin
1178
+ #Gets a list of registrations including a summary of the status of each registration.
1179
+ result = api_instance.get_registrations(opts)
1180
+ p result
1181
+ rescue RusticiSoftwareCloudV2::ApiError => e
1182
+ puts "Exception when calling RegistrationApi->get_registrations: #{e}"
1183
+ end
1184
+ ```
1185
+
1186
+ ### Parameters
1187
+
1188
+ Name | Type | Description | Notes
1189
+ ------------- | ------------- | ------------- | -------------
1190
+ **course_id** | **String**| Only registrations for the specified course id will be included. | [optional]
1191
+ **learner_id** | **String**| Only registrations for the specified learner id will be included. | [optional]
1192
+ **since** | **DateTime**| Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used. | [optional]
1193
+ **_until** | **DateTime**| Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used. | [optional]
1194
+ **more** | **String**| Value for this parameter will be provided in the 'more' property of registration lists, where needed. An opaque value, construction and parsing may change without notice. | [optional]
1195
+ **include_child_results** | **BOOLEAN**| Include information about each learning object, not just the top level in the results | [optional] [default to false]
1196
+ **include_interactions_and_objectives** | **BOOLEAN**| Include interactions and objectives in the results | [optional] [default to false]
1197
+ **include_runtime** | **BOOLEAN**| Include runtime details in the results | [optional] [default to false]
1198
+
1199
+ ### Return type
1200
+
1201
+ [**RegistrationListSchema**](RegistrationListSchema.md)
1202
+
1203
+ ### Authorization
1204
+
1205
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
1206
+
1207
+ ### HTTP request headers
1208
+
1209
+ - **Content-Type**: application/json
1210
+ - **Accept**: application/json
1211
+
1212
+
1213
+
1214
+ # **put_registration_tags**
1215
+ > put_registration_tags(registration_id, tags)
1216
+
1217
+ Set the tags for this registration
1218
+
1219
+ ### Example
1220
+ ```ruby
1221
+ # load the gem
1222
+ require 'rustici_software_cloud_v2'
1223
+ # setup authorization
1224
+ RusticiSoftwareCloudV2.configure do |config|
1225
+ # Configure HTTP basic authorization: APP_NORMAL
1226
+ config.username = 'YOUR USERNAME'
1227
+ config.password = 'YOUR PASSWORD'
1228
+
1229
+ # Configure OAuth2 access token for authorization: OAUTH
1230
+ config.access_token = 'YOUR ACCESS TOKEN'
1231
+ end
1232
+
1233
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
1234
+
1235
+ registration_id = 'registration_id_example' # String | id for this registration
1236
+
1237
+ tags = RusticiSoftwareCloudV2::TagListSchema.new # TagListSchema |
1238
+
1239
+
1240
+ begin
1241
+ #Set the tags for this registration
1242
+ api_instance.put_registration_tags(registration_id, tags)
1243
+ rescue RusticiSoftwareCloudV2::ApiError => e
1244
+ puts "Exception when calling RegistrationApi->put_registration_tags: #{e}"
1245
+ end
1246
+ ```
1247
+
1248
+ ### Parameters
1249
+
1250
+ Name | Type | Description | Notes
1251
+ ------------- | ------------- | ------------- | -------------
1252
+ **registration_id** | **String**| id for this registration |
1253
+ **tags** | [**TagListSchema**](TagListSchema.md)| |
1254
+
1255
+ ### Return type
1256
+
1257
+ nil (empty response body)
1258
+
1259
+ ### Authorization
1260
+
1261
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
1262
+
1263
+ ### HTTP request headers
1264
+
1265
+ - **Content-Type**: application/json
1266
+ - **Accept**: application/json
1267
+
1268
+
1269
+
1270
+ # **put_registration_tags_batch**
1271
+ > put_registration_tags_batch(batch)
1272
+
1273
+ Sets all of the provided tags on all of the provided registrations
1274
+
1275
+ ### Example
1276
+ ```ruby
1277
+ # load the gem
1278
+ require 'rustici_software_cloud_v2'
1279
+ # setup authorization
1280
+ RusticiSoftwareCloudV2.configure do |config|
1281
+ # Configure HTTP basic authorization: APP_NORMAL
1282
+ config.username = 'YOUR USERNAME'
1283
+ config.password = 'YOUR PASSWORD'
1284
+
1285
+ # Configure OAuth2 access token for authorization: OAUTH
1286
+ config.access_token = 'YOUR ACCESS TOKEN'
1287
+ end
1288
+
1289
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
1290
+
1291
+ batch = RusticiSoftwareCloudV2::RegistrationTagsBatchSchema.new # RegistrationTagsBatchSchema |
1292
+
1293
+
1294
+ begin
1295
+ #Sets all of the provided tags on all of the provided registrations
1296
+ api_instance.put_registration_tags_batch(batch)
1297
+ rescue RusticiSoftwareCloudV2::ApiError => e
1298
+ puts "Exception when calling RegistrationApi->put_registration_tags_batch: #{e}"
1299
+ end
1300
+ ```
1301
+
1302
+ ### Parameters
1303
+
1304
+ Name | Type | Description | Notes
1305
+ ------------- | ------------- | ------------- | -------------
1306
+ **batch** | [**RegistrationTagsBatchSchema**](RegistrationTagsBatchSchema.md)| |
1307
+
1308
+ ### Return type
1309
+
1310
+ nil (empty response body)
1311
+
1312
+ ### Authorization
1313
+
1314
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
1315
+
1316
+ ### HTTP request headers
1317
+
1318
+ - **Content-Type**: application/json
1319
+ - **Accept**: application/json
1320
+
1321
+
1322
+
1323
+ # **registration_exists**
1324
+ > registration_exists(registration_id, )
1325
+
1326
+ Does this registration exist?
1327
+
1328
+ ### Example
1329
+ ```ruby
1330
+ # load the gem
1331
+ require 'rustici_software_cloud_v2'
1332
+ # setup authorization
1333
+ RusticiSoftwareCloudV2.configure do |config|
1334
+ # Configure HTTP basic authorization: APP_NORMAL
1335
+ config.username = 'YOUR USERNAME'
1336
+ config.password = 'YOUR PASSWORD'
1337
+
1338
+ # Configure OAuth2 access token for authorization: OAUTH
1339
+ config.access_token = 'YOUR ACCESS TOKEN'
1340
+ end
1341
+
1342
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
1343
+
1344
+ registration_id = 'registration_id_example' # String | id for this registration
1345
+
1346
+
1347
+ begin
1348
+ #Does this registration exist?
1349
+ api_instance.registration_exists(registration_id, )
1350
+ rescue RusticiSoftwareCloudV2::ApiError => e
1351
+ puts "Exception when calling RegistrationApi->registration_exists: #{e}"
1352
+ end
1353
+ ```
1354
+
1355
+ ### Parameters
1356
+
1357
+ Name | Type | Description | Notes
1358
+ ------------- | ------------- | ------------- | -------------
1359
+ **registration_id** | **String**| id for this registration |
1360
+
1361
+ ### Return type
1362
+
1363
+ nil (empty response body)
1364
+
1365
+ ### Authorization
1366
+
1367
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
1368
+
1369
+ ### HTTP request headers
1370
+
1371
+ - **Content-Type**: application/json
1372
+ - **Accept**: application/json
1373
+
1374
+
1375
+
1376
+ # **set_registration_configuration**
1377
+ > set_registration_configuration(registration_id, configuration_settings)
1378
+
1379
+ Set configuration settings for this registration.
1380
+
1381
+ ### Example
1382
+ ```ruby
1383
+ # load the gem
1384
+ require 'rustici_software_cloud_v2'
1385
+ # setup authorization
1386
+ RusticiSoftwareCloudV2.configure do |config|
1387
+ # Configure HTTP basic authorization: APP_NORMAL
1388
+ config.username = 'YOUR USERNAME'
1389
+ config.password = 'YOUR PASSWORD'
1390
+
1391
+ # Configure OAuth2 access token for authorization: OAUTH
1392
+ config.access_token = 'YOUR ACCESS TOKEN'
1393
+ end
1394
+
1395
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
1396
+
1397
+ registration_id = 'registration_id_example' # String | id for this registration
1398
+
1399
+ configuration_settings = RusticiSoftwareCloudV2::SettingsPostSchema.new # SettingsPostSchema |
1400
+
1401
+
1402
+ begin
1403
+ #Set configuration settings for this registration.
1404
+ api_instance.set_registration_configuration(registration_id, configuration_settings)
1405
+ rescue RusticiSoftwareCloudV2::ApiError => e
1406
+ puts "Exception when calling RegistrationApi->set_registration_configuration: #{e}"
1407
+ end
1408
+ ```
1409
+
1410
+ ### Parameters
1411
+
1412
+ Name | Type | Description | Notes
1413
+ ------------- | ------------- | ------------- | -------------
1414
+ **registration_id** | **String**| id for this registration |
1415
+ **configuration_settings** | [**SettingsPostSchema**](SettingsPostSchema.md)| |
1416
+
1417
+ ### Return type
1418
+
1419
+ nil (empty response body)
1420
+
1421
+ ### Authorization
1422
+
1423
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
1424
+
1425
+ ### HTTP request headers
1426
+
1427
+ - **Content-Type**: application/json
1428
+ - **Accept**: application/json
1429
+
1430
+
1431
+
1432
+ # **set_registration_instance_configuration**
1433
+ > set_registration_instance_configuration(registration_id, instance_id, configuration_settings)
1434
+
1435
+ Set configuration settings for this registration instance.
1436
+
1437
+ ### Example
1438
+ ```ruby
1439
+ # load the gem
1440
+ require 'rustici_software_cloud_v2'
1441
+ # setup authorization
1442
+ RusticiSoftwareCloudV2.configure do |config|
1443
+ # Configure HTTP basic authorization: APP_NORMAL
1444
+ config.username = 'YOUR USERNAME'
1445
+ config.password = 'YOUR PASSWORD'
1446
+
1447
+ # Configure OAuth2 access token for authorization: OAUTH
1448
+ config.access_token = 'YOUR ACCESS TOKEN'
1449
+ end
1450
+
1451
+ api_instance = RusticiSoftwareCloudV2::RegistrationApi.new
1452
+
1453
+ registration_id = 'registration_id_example' # String | id for this registration
1454
+
1455
+ instance_id = 56 # Integer | The instance of this registration
1456
+
1457
+ configuration_settings = RusticiSoftwareCloudV2::SettingsPostSchema.new # SettingsPostSchema |
1458
+
1459
+
1460
+ begin
1461
+ #Set configuration settings for this registration instance.
1462
+ api_instance.set_registration_instance_configuration(registration_id, instance_id, configuration_settings)
1463
+ rescue RusticiSoftwareCloudV2::ApiError => e
1464
+ puts "Exception when calling RegistrationApi->set_registration_instance_configuration: #{e}"
1465
+ end
1466
+ ```
1467
+
1468
+ ### Parameters
1469
+
1470
+ Name | Type | Description | Notes
1471
+ ------------- | ------------- | ------------- | -------------
1472
+ **registration_id** | **String**| id for this registration |
1473
+ **instance_id** | **Integer**| The instance of this registration |
1474
+ **configuration_settings** | [**SettingsPostSchema**](SettingsPostSchema.md)| |
1475
+
1476
+ ### Return type
1477
+
1478
+ nil (empty response body)
1479
+
1480
+ ### Authorization
1481
+
1482
+ [APP_NORMAL](../README.md#APP_NORMAL), [OAUTH](../README.md#OAUTH)
1483
+
1484
+ ### HTTP request headers
1485
+
1486
+ - **Content-Type**: application/json
1487
+ - **Accept**: application/json
1488
+
1489
+
1490
+