rustici_software_cloud_v2 1.0.0beta → 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (268) hide show
  1. checksums.yaml +7 -0
  2. data/README.md +194 -88
  3. data/lib/rustici_software_cloud_v2/api/about_api.rb +71 -0
  4. data/lib/rustici_software_cloud_v2/api/application_management_api.rb +161 -97
  5. data/lib/rustici_software_cloud_v2/api/authentication_api.rb +13 -13
  6. data/lib/rustici_software_cloud_v2/api/course_api.rb +246 -260
  7. data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +1994 -0
  8. data/lib/rustici_software_cloud_v2/api/invitations_api.rb +964 -0
  9. data/lib/rustici_software_cloud_v2/api/learner_api.rb +296 -0
  10. data/lib/rustici_software_cloud_v2/api/ping_api.rb +10 -8
  11. data/lib/rustici_software_cloud_v2/api/registration_api.rb +379 -324
  12. data/lib/rustici_software_cloud_v2/api/reporting_api.rb +191 -0
  13. data/lib/rustici_software_cloud_v2/api/xapi_api.rb +555 -0
  14. data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +448 -0
  15. data/lib/rustici_software_cloud_v2/api_client.rb +2 -3
  16. data/lib/rustici_software_cloud_v2/api_error.rb +1 -2
  17. data/lib/rustici_software_cloud_v2/configuration.rb +9 -19
  18. data/lib/rustici_software_cloud_v2/models/about_schema.rb +196 -0
  19. data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +17 -14
  20. data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +12 -8
  21. data/lib/rustici_software_cloud_v2/models/application_schema.rb +12 -8
  22. data/lib/rustici_software_cloud_v2/models/application_token.rb +12 -8
  23. data/lib/rustici_software_cloud_v2/models/{course_tags_batch_schema.rb → batch_tags_schema.rb} +29 -23
  24. data/lib/rustici_software_cloud_v2/models/comment_schema.rb +12 -8
  25. data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +12 -8
  26. data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +14 -11
  27. data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +12 -8
  28. data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +12 -8
  29. data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +11 -8
  30. data/lib/rustici_software_cloud_v2/models/course_schema.rb +14 -11
  31. data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +225 -0
  32. data/lib/rustici_software_cloud_v2/models/{link_schema.rb → create_dispatch_list_schema.rb} +22 -21
  33. data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +308 -0
  34. data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +254 -0
  35. data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +252 -0
  36. data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +15 -11
  37. data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +12 -8
  38. data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +12 -8
  39. data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +12 -8
  40. data/lib/rustici_software_cloud_v2/models/credential_schema.rb +12 -8
  41. data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +197 -0
  42. data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +200 -0
  43. data/lib/rustici_software_cloud_v2/models/{setting_metadata_valid_values.rb → destination_schema.rb} +42 -31
  44. data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +196 -0
  45. data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +198 -0
  46. data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +196 -0
  47. data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +290 -0
  48. data/lib/rustici_software_cloud_v2/models/{tag_post_schema.rb → enabled_schema.rb} +24 -11
  49. data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +12 -9
  50. data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +14 -11
  51. data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +12 -8
  52. data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +13 -9
  53. data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +215 -0
  54. data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +253 -0
  55. data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +199 -0
  56. data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +227 -0
  57. data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +12 -8
  58. data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +12 -8
  59. data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +19 -16
  60. data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +17 -8
  61. data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +13 -9
  62. data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +12 -8
  63. data/lib/rustici_software_cloud_v2/models/learner_schema.rb +13 -9
  64. data/lib/rustici_software_cloud_v2/models/message_schema.rb +13 -9
  65. data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +12 -8
  66. data/lib/rustici_software_cloud_v2/models/objective_schema.rb +23 -20
  67. data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +12 -8
  68. data/lib/rustici_software_cloud_v2/models/ping_schema.rb +28 -20
  69. data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +33 -20
  70. data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +199 -0
  71. data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +266 -0
  72. data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +199 -0
  73. data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +289 -0
  74. data/lib/rustici_software_cloud_v2/models/registration_completion.rb +5 -14
  75. data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +13 -9
  76. data/lib/rustici_software_cloud_v2/models/registration_schema.rb +24 -9
  77. data/lib/rustici_software_cloud_v2/models/registration_success.rb +5 -14
  78. data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +259 -0
  79. data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +214 -0
  80. data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +196 -0
  81. data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +187 -0
  82. data/lib/rustici_software_cloud_v2/models/response_error.rb +13 -9
  83. data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +14 -11
  84. data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +19 -16
  85. data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +15 -12
  86. data/lib/rustici_software_cloud_v2/models/score_schema.rb +12 -8
  87. data/lib/rustici_software_cloud_v2/models/setting_item.rb +14 -11
  88. data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +13 -9
  89. data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +15 -12
  90. data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +12 -8
  91. data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +12 -8
  92. data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +12 -8
  93. data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +12 -8
  94. data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +12 -8
  95. data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +13 -9
  96. data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +12 -8
  97. data/lib/rustici_software_cloud_v2/models/title_schema.rb +12 -8
  98. data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +14 -10
  99. data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +258 -0
  100. data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +199 -0
  101. data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +236 -0
  102. data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +214 -0
  103. data/lib/rustici_software_cloud_v2/models/xapi_account.rb +13 -10
  104. data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +13 -10
  105. data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +14 -11
  106. data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +14 -12
  107. data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +18 -15
  108. data/lib/rustici_software_cloud_v2/models/xapi_context.rb +12 -9
  109. data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +11 -8
  110. data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +220 -0
  111. data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +220 -0
  112. data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +252 -0
  113. data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +266 -0
  114. data/lib/rustici_software_cloud_v2/models/{registration_tags_batch_schema.rb → xapi_credentials_list_schema.rb} +30 -31
  115. data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +205 -0
  116. data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +13 -10
  117. data/lib/rustici_software_cloud_v2/models/xapi_result.rb +12 -9
  118. data/lib/rustici_software_cloud_v2/models/xapi_score.rb +11 -8
  119. data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +11 -8
  120. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +194 -0
  121. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +196 -0
  122. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +241 -0
  123. data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +14 -11
  124. data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +12 -9
  125. data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +13 -10
  126. data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +187 -0
  127. data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +196 -0
  128. data/lib/rustici_software_cloud_v2/version.rb +2 -3
  129. data/lib/rustici_software_cloud_v2.rb +50 -6
  130. data/rustici_software_cloud_v2.gemspec +10 -11
  131. data/spec/api_client_spec.rb +1 -13
  132. data/spec/configuration_spec.rb +9 -10
  133. data/spec/spec_helper.rb +1 -13
  134. metadata +107 -271
  135. data/docs/ActivityResultSchema.md +0 -20
  136. data/docs/ApplicationListSchema.md +0 -8
  137. data/docs/ApplicationManagementApi.md +0 -570
  138. data/docs/ApplicationSchema.md +0 -9
  139. data/docs/ApplicationToken.md +0 -10
  140. data/docs/AuthenticationApi.md +0 -64
  141. data/docs/CommentSchema.md +0 -10
  142. data/docs/CompletionAmountSchema.md +0 -8
  143. data/docs/CourseActivitySchema.md +0 -15
  144. data/docs/CourseApi.md +0 -1459
  145. data/docs/CourseListNonPagedSchema.md +0 -8
  146. data/docs/CourseListSchema.md +0 -9
  147. data/docs/CourseReferenceSchema.md +0 -10
  148. data/docs/CourseSchema.md +0 -20
  149. data/docs/CourseTagsBatchSchema.md +0 -9
  150. data/docs/CreateRegistrationSchema.md +0 -17
  151. data/docs/CredentialCreatedSchema.md +0 -12
  152. data/docs/CredentialListSchema.md +0 -8
  153. data/docs/CredentialRequestSchema.md +0 -9
  154. data/docs/CredentialSchema.md +0 -12
  155. data/docs/ImportFetchRequestSchema.md +0 -8
  156. data/docs/ImportJobResultSchema.md +0 -11
  157. data/docs/ImportResultSchema.md +0 -11
  158. data/docs/IntegerResultSchema.md +0 -8
  159. data/docs/ItemValuePairSchema.md +0 -9
  160. data/docs/LaunchHistoryListSchema.md +0 -8
  161. data/docs/LaunchHistorySchema.md +0 -17
  162. data/docs/LaunchLinkRequestSchema.md +0 -17
  163. data/docs/LaunchLinkSchema.md +0 -8
  164. data/docs/LearnerPreferenceSchema.md +0 -11
  165. data/docs/LearnerSchema.md +0 -11
  166. data/docs/LinkSchema.md +0 -8
  167. data/docs/MessageSchema.md +0 -8
  168. data/docs/MetadataSchema.md +0 -14
  169. data/docs/ObjectiveSchema.md +0 -20
  170. data/docs/PermissionsSchema.md +0 -9
  171. data/docs/PingApi.md +0 -57
  172. data/docs/PingSchema.md +0 -8
  173. data/docs/PostBackSchema.md +0 -12
  174. data/docs/RegistrationApi.md +0 -1490
  175. data/docs/RegistrationCompletion.md +0 -7
  176. data/docs/RegistrationListSchema.md +0 -9
  177. data/docs/RegistrationSchema.md +0 -27
  178. data/docs/RegistrationSuccess.md +0 -7
  179. data/docs/RegistrationTagsBatchSchema.md +0 -9
  180. data/docs/ResponseError.md +0 -8
  181. data/docs/RuntimeInteractionSchema.md +0 -18
  182. data/docs/RuntimeObjectiveSchema.md +0 -16
  183. data/docs/RuntimeSchema.md +0 -27
  184. data/docs/ScoreSchema.md +0 -8
  185. data/docs/SettingItem.md +0 -12
  186. data/docs/SettingListSchema.md +0 -8
  187. data/docs/SettingMetadata.md +0 -15
  188. data/docs/SettingMetadataValidValues.md +0 -9
  189. data/docs/SettingValidValue.md +0 -9
  190. data/docs/SettingsIndividualSchema.md +0 -10
  191. data/docs/SettingsPostSchema.md +0 -8
  192. data/docs/SharedDataEntrySchema.md +0 -9
  193. data/docs/StaticPropertiesSchema.md +0 -13
  194. data/docs/StringResultSchema.md +0 -8
  195. data/docs/TagListSchema.md +0 -8
  196. data/docs/TagPostSchema.md +0 -7
  197. data/docs/TitleSchema.md +0 -8
  198. data/docs/TokenRequestSchema.md +0 -9
  199. data/docs/XapiAccount.md +0 -9
  200. data/docs/XapiActivity.md +0 -10
  201. data/docs/XapiActivityDefinition.md +0 -19
  202. data/docs/XapiAgentGroup.md +0 -14
  203. data/docs/XapiAttachment.md +0 -14
  204. data/docs/XapiContext.md +0 -16
  205. data/docs/XapiContextActivity.md +0 -11
  206. data/docs/XapiInteractionComponent.md +0 -9
  207. data/docs/XapiResult.md +0 -13
  208. data/docs/XapiScore.md +0 -11
  209. data/docs/XapiStatement.md +0 -20
  210. data/docs/XapiStatementReference.md +0 -9
  211. data/docs/XapiStatementResult.md +0 -9
  212. data/docs/XapiVerb.md +0 -9
  213. data/git_push.sh +0 -55
  214. data/spec/models/activity_result_schema_spec.rb +0 -133
  215. data/spec/models/application_list_schema_spec.rb +0 -53
  216. data/spec/models/application_schema_spec.rb +0 -59
  217. data/spec/models/application_token_spec.rb +0 -65
  218. data/spec/models/comment_schema_spec.rb +0 -65
  219. data/spec/models/completion_amount_schema_spec.rb +0 -53
  220. data/spec/models/course_activity_schema_spec.rb +0 -99
  221. data/spec/models/course_list_non_paged_schema_spec.rb +0 -53
  222. data/spec/models/course_list_schema_spec.rb +0 -59
  223. data/spec/models/course_reference_schema_spec.rb +0 -65
  224. data/spec/models/course_schema_spec.rb +0 -129
  225. data/spec/models/create_registration_schema_spec.rb +0 -107
  226. data/spec/models/credential_created_schema_spec.rb +0 -77
  227. data/spec/models/credential_list_schema_spec.rb +0 -53
  228. data/spec/models/credential_request_schema_spec.rb +0 -59
  229. data/spec/models/credential_schema_spec.rb +0 -77
  230. data/spec/models/import_fetch_request_schema_spec.rb +0 -53
  231. data/spec/models/import_job_result_schema_spec.rb +0 -75
  232. data/spec/models/import_result_schema_spec.rb +0 -71
  233. data/spec/models/integer_result_schema_spec.rb +0 -53
  234. data/spec/models/item_value_pair_schema_spec.rb +0 -59
  235. data/spec/models/launch_history_list_schema_spec.rb +0 -53
  236. data/spec/models/launch_history_schema_spec.rb +0 -115
  237. data/spec/models/launch_link_request_schema_spec.rb +0 -107
  238. data/spec/models/launch_link_schema_spec.rb +0 -53
  239. data/spec/models/learner_preference_schema_spec.rb +0 -71
  240. data/spec/models/learner_schema_spec.rb +0 -71
  241. data/spec/models/link_schema_spec.rb +0 -53
  242. data/spec/models/message_schema_spec.rb +0 -53
  243. data/spec/models/metadata_schema_spec.rb +0 -89
  244. data/spec/models/objective_schema_spec.rb +0 -137
  245. data/spec/models/permissions_schema_spec.rb +0 -59
  246. data/spec/models/ping_schema_spec.rb +0 -53
  247. data/spec/models/post_back_schema_spec.rb +0 -85
  248. data/spec/models/registration_completion_spec.rb +0 -47
  249. data/spec/models/registration_list_schema_spec.rb +0 -59
  250. data/spec/models/registration_schema_spec.rb +0 -167
  251. data/spec/models/registration_success_spec.rb +0 -47
  252. data/spec/models/response_error_spec.rb +0 -53
  253. data/spec/models/runtime_interaction_schema_spec.rb +0 -117
  254. data/spec/models/runtime_objective_schema_spec.rb +0 -109
  255. data/spec/models/runtime_schema_spec.rb +0 -171
  256. data/spec/models/score_schema_spec.rb +0 -53
  257. data/spec/models/setting_item_spec.rb +0 -81
  258. data/spec/models/setting_list_schema_spec.rb +0 -53
  259. data/spec/models/setting_metadata_spec.rb +0 -99
  260. data/spec/models/setting_metadata_valid_values_spec.rb +0 -59
  261. data/spec/models/settings_individual_schema_spec.rb +0 -65
  262. data/spec/models/settings_post_schema_spec.rb +0 -53
  263. data/spec/models/shared_data_entry_schema_spec.rb +0 -59
  264. data/spec/models/static_properties_schema_spec.rb +0 -83
  265. data/spec/models/string_result_schema_spec.rb +0 -53
  266. data/spec/models/title_schema_spec.rb +0 -53
  267. data/spec/models/token_request_schema_spec.rb +0 -59
  268. data/swagger-codegen.config +0 -11
data/docs/CourseListNonPagedSchema.md DELETED
@@ -1,8 +0,0 @@
1
- # RusticiSoftwareCloudV2::CourseListNonPagedSchema
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **courses** | [**Array<CourseSchema>**](CourseSchema.md) | | [optional]
7
-
8
-
data/docs/CourseListSchema.md DELETED
@@ -1,9 +0,0 @@
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
-
data/docs/CourseReferenceSchema.md DELETED
@@ -1,10 +0,0 @@
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
-
data/docs/CourseSchema.md DELETED
@@ -1,20 +0,0 @@
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
-
data/docs/CourseTagsBatchSchema.md DELETED
@@ -1,9 +0,0 @@
1
- # RusticiSoftwareCloudV2::CourseTagsBatchSchema
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **course_ids** | **Array<String>** | |
7
- **tags** | [**TagPostSchema**](TagPostSchema.md) | |
8
-
9
-
data/docs/CreateRegistrationSchema.md DELETED
@@ -1,17 +0,0 @@
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
-
data/docs/CredentialCreatedSchema.md DELETED
@@ -1,12 +0,0 @@
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
-
data/docs/CredentialListSchema.md DELETED
@@ -1,8 +0,0 @@
1
- # RusticiSoftwareCloudV2::CredentialListSchema
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **credentials** | [**Array<CredentialSchema>**](CredentialSchema.md) | | [optional]
7
-
8
-
data/docs/CredentialRequestSchema.md DELETED
@@ -1,9 +0,0 @@
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
-
data/docs/CredentialSchema.md DELETED
@@ -1,12 +0,0 @@
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
-
data/docs/ImportFetchRequestSchema.md DELETED
@@ -1,8 +0,0 @@
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
-
data/docs/ImportJobResultSchema.md DELETED
@@ -1,11 +0,0 @@
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
-
data/docs/ImportResultSchema.md DELETED
@@ -1,11 +0,0 @@
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
-
data/docs/IntegerResultSchema.md DELETED
@@ -1,8 +0,0 @@
1
- # RusticiSoftwareCloudV2::IntegerResultSchema
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **result** | **Integer** | |
7
-
8
-
data/docs/ItemValuePairSchema.md DELETED
@@ -1,9 +0,0 @@
1
- # RusticiSoftwareCloudV2::ItemValuePairSchema
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **item** | **String** | | [optional]
7
- **value** | **String** | | [optional]
8
-
9
-
data/docs/LaunchHistoryListSchema.md DELETED
@@ -1,8 +0,0 @@
1
- # RusticiSoftwareCloudV2::LaunchHistoryListSchema
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **launch_history** | [**Array<LaunchHistorySchema>**](LaunchHistorySchema.md) | | [optional]
7
-
8
-
data/docs/LaunchHistorySchema.md DELETED
@@ -1,17 +0,0 @@
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
-
data/docs/LaunchLinkRequestSchema.md DELETED
@@ -1,17 +0,0 @@
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
-
data/docs/LaunchLinkSchema.md DELETED
@@ -1,8 +0,0 @@
1
- # RusticiSoftwareCloudV2::LaunchLinkSchema
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **launch_link** | **String** | |
7
-
8
-
data/docs/LearnerPreferenceSchema.md DELETED
@@ -1,11 +0,0 @@
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
-
data/docs/LearnerSchema.md DELETED
@@ -1,11 +0,0 @@
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
-
data/docs/LinkSchema.md DELETED
@@ -1,8 +0,0 @@
1
- # RusticiSoftwareCloudV2::LinkSchema
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **link** | **String** | |
7
-
8
-
data/docs/MessageSchema.md DELETED
@@ -1,8 +0,0 @@
1
- # RusticiSoftwareCloudV2::MessageSchema
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **message** | **String** | |
7
-
8
-
data/docs/MetadataSchema.md DELETED
@@ -1,14 +0,0 @@
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
-
data/docs/ObjectiveSchema.md DELETED
@@ -1,20 +0,0 @@
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
-
data/docs/PermissionsSchema.md DELETED
@@ -1,9 +0,0 @@
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 DELETED
@@ -1,57 +0,0 @@
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
-
data/docs/PingSchema.md DELETED
@@ -1,8 +0,0 @@
1
- # RusticiSoftwareCloudV2::PingSchema
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **message** | **String** | |
7
-
8
-
data/docs/PostBackSchema.md DELETED
@@ -1,12 +0,0 @@
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
-