rustici_software_cloud_v2 1.0.0beta → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (287) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +1 -1
  3. data/README.md +354 -243
  4. data/lib/rustici_software_cloud_v2/api/about_api.rb +71 -0
  5. data/lib/rustici_software_cloud_v2/api/application_management_api.rb +253 -63
  6. data/lib/rustici_software_cloud_v2/api/authentication_api.rb +11 -17
  7. data/lib/rustici_software_cloud_v2/api/course_api.rb +910 -160
  8. data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +2236 -0
  9. data/lib/rustici_software_cloud_v2/api/invitations_api.rb +1025 -0
  10. data/lib/rustici_software_cloud_v2/api/learner_api.rb +367 -0
  11. data/lib/rustici_software_cloud_v2/api/ping_api.rb +6 -4
  12. data/lib/rustici_software_cloud_v2/api/registration_api.rb +448 -295
  13. data/lib/rustici_software_cloud_v2/api/reporting_api.rb +191 -0
  14. data/lib/rustici_software_cloud_v2/api/xapi_api.rb +581 -0
  15. data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +528 -0
  16. data/lib/rustici_software_cloud_v2/api_client.rb +5 -5
  17. data/lib/rustici_software_cloud_v2/api_error.rb +2 -2
  18. data/lib/rustici_software_cloud_v2/configuration.rb +11 -20
  19. data/lib/rustici_software_cloud_v2/models/about_schema.rb +194 -0
  20. data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +10 -38
  21. data/lib/rustici_software_cloud_v2/models/application_info_schema.rb +234 -0
  22. data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +5 -3
  23. data/lib/rustici_software_cloud_v2/models/{link_schema.rb → application_request_schema.rb} +14 -16
  24. data/lib/rustici_software_cloud_v2/models/application_schema.rb +5 -3
  25. data/lib/rustici_software_cloud_v2/models/application_token.rb +5 -3
  26. data/lib/rustici_software_cloud_v2/models/asset_file_schema.rb +194 -0
  27. data/lib/rustici_software_cloud_v2/models/{course_tags_batch_schema.rb → batch_tags_schema.rb} +21 -17
  28. data/lib/rustici_software_cloud_v2/models/comment_schema.rb +5 -3
  29. data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +5 -3
  30. data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +7 -31
  31. data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +5 -3
  32. data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +6 -3
  33. data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +5 -3
  34. data/lib/rustici_software_cloud_v2/models/course_schema.rb +7 -31
  35. data/lib/rustici_software_cloud_v2/models/{registration_tags_batch_schema.rb → create_dispatch_id_schema.rb} +25 -25
  36. data/lib/rustici_software_cloud_v2/models/create_dispatch_list_schema.rb +187 -0
  37. data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +306 -0
  38. data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +252 -0
  39. data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +250 -0
  40. data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +5 -3
  41. data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +5 -3
  42. data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +5 -3
  43. data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +5 -3
  44. data/lib/rustici_software_cloud_v2/models/credential_schema.rb +5 -3
  45. data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +195 -0
  46. data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +198 -0
  47. data/lib/rustici_software_cloud_v2/models/destination_schema.rb +227 -0
  48. data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +194 -0
  49. data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +197 -0
  50. data/lib/rustici_software_cloud_v2/models/dispatch_lti_info_schema.rb +221 -0
  51. data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +194 -0
  52. data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +326 -0
  53. data/lib/rustici_software_cloud_v2/models/{tag_post_schema.rb → enabled_schema.rb} +17 -6
  54. data/lib/rustici_software_cloud_v2/models/file_list_item_schema.rb +205 -0
  55. data/lib/rustici_software_cloud_v2/models/file_list_schema.rb +187 -0
  56. data/lib/rustici_software_cloud_v2/models/import_asset_request_schema.rb +207 -0
  57. data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +31 -8
  58. data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +7 -31
  59. data/lib/rustici_software_cloud_v2/models/import_media_file_reference_request_schema.rb +216 -0
  60. data/lib/rustici_software_cloud_v2/models/import_request_schema.rb +195 -0
  61. data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +5 -3
  62. data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +5 -3
  63. data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +214 -0
  64. data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +226 -0
  65. data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +198 -0
  66. data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +225 -0
  67. data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +5 -3
  68. data/lib/rustici_software_cloud_v2/models/launch_auth_options_schema.rb +212 -0
  69. data/lib/rustici_software_cloud_v2/models/launch_auth_schema.rb +204 -0
  70. data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +5 -3
  71. data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +10 -38
  72. data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +25 -9
  73. data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +5 -3
  74. data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +5 -3
  75. data/lib/rustici_software_cloud_v2/models/learner_schema.rb +5 -3
  76. data/lib/rustici_software_cloud_v2/models/media_file_metadata_schema.rb +213 -0
  77. data/lib/rustici_software_cloud_v2/models/message_schema.rb +5 -3
  78. data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +12 -10
  79. data/lib/rustici_software_cloud_v2/models/objective_schema.rb +13 -45
  80. data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +5 -3
  81. data/lib/rustici_software_cloud_v2/models/ping_schema.rb +21 -15
  82. data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +24 -42
  83. data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +198 -0
  84. data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +264 -0
  85. data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb +215 -0
  86. data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +198 -0
  87. data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +287 -0
  88. data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +228 -0
  89. data/lib/rustici_software_cloud_v2/models/registration_completion.rb +2 -2
  90. data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +6 -3
  91. data/lib/rustici_software_cloud_v2/models/registration_schema.rb +17 -4
  92. data/lib/rustici_software_cloud_v2/models/registration_success.rb +2 -2
  93. data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +257 -0
  94. data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +212 -0
  95. data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +194 -0
  96. data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +185 -0
  97. data/lib/rustici_software_cloud_v2/models/response_error.rb +5 -3
  98. data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +7 -31
  99. data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +10 -38
  100. data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +7 -31
  101. data/lib/rustici_software_cloud_v2/models/score_schema.rb +5 -3
  102. data/lib/rustici_software_cloud_v2/models/setting_item.rb +7 -31
  103. data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +5 -3
  104. data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +7 -31
  105. data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +5 -3
  106. data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +5 -3
  107. data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +5 -3
  108. data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +5 -3
  109. data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +5 -3
  110. data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +5 -3
  111. data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +5 -3
  112. data/lib/rustici_software_cloud_v2/models/title_schema.rb +5 -3
  113. data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +5 -3
  114. data/lib/rustici_software_cloud_v2/models/update_application_schema.rb +196 -0
  115. data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +266 -0
  116. data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +198 -0
  117. data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +234 -0
  118. data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +213 -0
  119. data/lib/rustici_software_cloud_v2/models/xapi_account.rb +5 -3
  120. data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +5 -3
  121. data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +5 -3
  122. data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +7 -31
  123. data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +5 -3
  124. data/lib/rustici_software_cloud_v2/models/xapi_context.rb +5 -3
  125. data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +5 -3
  126. data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +193 -0
  127. data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +193 -0
  128. data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +255 -0
  129. data/lib/rustici_software_cloud_v2/models/xapi_credential_put_schema.rb +239 -0
  130. data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +264 -0
  131. data/lib/rustici_software_cloud_v2/models/xapi_credentials_list_schema.rb +202 -0
  132. data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +203 -0
  133. data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +5 -3
  134. data/lib/rustici_software_cloud_v2/models/xapi_result.rb +5 -3
  135. data/lib/rustici_software_cloud_v2/models/xapi_score.rb +5 -3
  136. data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +5 -3
  137. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +192 -0
  138. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +199 -0
  139. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_put_schema.rb +194 -0
  140. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +239 -0
  141. data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +5 -3
  142. data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +5 -3
  143. data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +5 -3
  144. data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +185 -0
  145. data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +204 -0
  146. data/lib/rustici_software_cloud_v2/version.rb +3 -3
  147. data/lib/rustici_software_cloud_v2.rb +68 -6
  148. data/rustici_software_cloud_v2.gemspec +8 -7
  149. data/spec/api_client_spec.rb +53 -47
  150. data/spec/configuration_spec.rb +2 -2
  151. data/spec/spec_helper.rb +2 -13
  152. metadata +142 -270
  153. data/docs/ActivityResultSchema.md +0 -20
  154. data/docs/ApplicationListSchema.md +0 -8
  155. data/docs/ApplicationManagementApi.md +0 -570
  156. data/docs/ApplicationSchema.md +0 -9
  157. data/docs/ApplicationToken.md +0 -10
  158. data/docs/AuthenticationApi.md +0 -64
  159. data/docs/CommentSchema.md +0 -10
  160. data/docs/CompletionAmountSchema.md +0 -8
  161. data/docs/CourseActivitySchema.md +0 -15
  162. data/docs/CourseApi.md +0 -1459
  163. data/docs/CourseListNonPagedSchema.md +0 -8
  164. data/docs/CourseListSchema.md +0 -9
  165. data/docs/CourseReferenceSchema.md +0 -10
  166. data/docs/CourseSchema.md +0 -20
  167. data/docs/CourseTagsBatchSchema.md +0 -9
  168. data/docs/CreateRegistrationSchema.md +0 -17
  169. data/docs/CredentialCreatedSchema.md +0 -12
  170. data/docs/CredentialListSchema.md +0 -8
  171. data/docs/CredentialRequestSchema.md +0 -9
  172. data/docs/CredentialSchema.md +0 -12
  173. data/docs/ImportFetchRequestSchema.md +0 -8
  174. data/docs/ImportJobResultSchema.md +0 -11
  175. data/docs/ImportResultSchema.md +0 -11
  176. data/docs/IntegerResultSchema.md +0 -8
  177. data/docs/ItemValuePairSchema.md +0 -9
  178. data/docs/LaunchHistoryListSchema.md +0 -8
  179. data/docs/LaunchHistorySchema.md +0 -17
  180. data/docs/LaunchLinkRequestSchema.md +0 -17
  181. data/docs/LaunchLinkSchema.md +0 -8
  182. data/docs/LearnerPreferenceSchema.md +0 -11
  183. data/docs/LearnerSchema.md +0 -11
  184. data/docs/LinkSchema.md +0 -8
  185. data/docs/MessageSchema.md +0 -8
  186. data/docs/MetadataSchema.md +0 -14
  187. data/docs/ObjectiveSchema.md +0 -20
  188. data/docs/PermissionsSchema.md +0 -9
  189. data/docs/PingApi.md +0 -57
  190. data/docs/PingSchema.md +0 -8
  191. data/docs/PostBackSchema.md +0 -12
  192. data/docs/RegistrationApi.md +0 -1490
  193. data/docs/RegistrationCompletion.md +0 -7
  194. data/docs/RegistrationListSchema.md +0 -9
  195. data/docs/RegistrationSchema.md +0 -27
  196. data/docs/RegistrationSuccess.md +0 -7
  197. data/docs/RegistrationTagsBatchSchema.md +0 -9
  198. data/docs/ResponseError.md +0 -8
  199. data/docs/RuntimeInteractionSchema.md +0 -18
  200. data/docs/RuntimeObjectiveSchema.md +0 -16
  201. data/docs/RuntimeSchema.md +0 -27
  202. data/docs/ScoreSchema.md +0 -8
  203. data/docs/SettingItem.md +0 -12
  204. data/docs/SettingListSchema.md +0 -8
  205. data/docs/SettingMetadata.md +0 -15
  206. data/docs/SettingMetadataValidValues.md +0 -9
  207. data/docs/SettingValidValue.md +0 -9
  208. data/docs/SettingsIndividualSchema.md +0 -10
  209. data/docs/SettingsPostSchema.md +0 -8
  210. data/docs/SharedDataEntrySchema.md +0 -9
  211. data/docs/StaticPropertiesSchema.md +0 -13
  212. data/docs/StringResultSchema.md +0 -8
  213. data/docs/TagListSchema.md +0 -8
  214. data/docs/TagPostSchema.md +0 -7
  215. data/docs/TitleSchema.md +0 -8
  216. data/docs/TokenRequestSchema.md +0 -9
  217. data/docs/XapiAccount.md +0 -9
  218. data/docs/XapiActivity.md +0 -10
  219. data/docs/XapiActivityDefinition.md +0 -19
  220. data/docs/XapiAgentGroup.md +0 -14
  221. data/docs/XapiAttachment.md +0 -14
  222. data/docs/XapiContext.md +0 -16
  223. data/docs/XapiContextActivity.md +0 -11
  224. data/docs/XapiInteractionComponent.md +0 -9
  225. data/docs/XapiResult.md +0 -13
  226. data/docs/XapiScore.md +0 -11
  227. data/docs/XapiStatement.md +0 -20
  228. data/docs/XapiStatementReference.md +0 -9
  229. data/docs/XapiStatementResult.md +0 -9
  230. data/docs/XapiVerb.md +0 -9
  231. data/git_push.sh +0 -55
  232. data/lib/rustici_software_cloud_v2/models/setting_metadata_valid_values.rb +0 -209
  233. data/spec/models/activity_result_schema_spec.rb +0 -133
  234. data/spec/models/application_list_schema_spec.rb +0 -53
  235. data/spec/models/application_schema_spec.rb +0 -59
  236. data/spec/models/application_token_spec.rb +0 -65
  237. data/spec/models/comment_schema_spec.rb +0 -65
  238. data/spec/models/completion_amount_schema_spec.rb +0 -53
  239. data/spec/models/course_activity_schema_spec.rb +0 -99
  240. data/spec/models/course_list_non_paged_schema_spec.rb +0 -53
  241. data/spec/models/course_list_schema_spec.rb +0 -59
  242. data/spec/models/course_reference_schema_spec.rb +0 -65
  243. data/spec/models/course_schema_spec.rb +0 -129
  244. data/spec/models/create_registration_schema_spec.rb +0 -107
  245. data/spec/models/credential_created_schema_spec.rb +0 -77
  246. data/spec/models/credential_list_schema_spec.rb +0 -53
  247. data/spec/models/credential_request_schema_spec.rb +0 -59
  248. data/spec/models/credential_schema_spec.rb +0 -77
  249. data/spec/models/import_fetch_request_schema_spec.rb +0 -53
  250. data/spec/models/import_job_result_schema_spec.rb +0 -75
  251. data/spec/models/import_result_schema_spec.rb +0 -71
  252. data/spec/models/integer_result_schema_spec.rb +0 -53
  253. data/spec/models/item_value_pair_schema_spec.rb +0 -59
  254. data/spec/models/launch_history_list_schema_spec.rb +0 -53
  255. data/spec/models/launch_history_schema_spec.rb +0 -115
  256. data/spec/models/launch_link_request_schema_spec.rb +0 -107
  257. data/spec/models/launch_link_schema_spec.rb +0 -53
  258. data/spec/models/learner_preference_schema_spec.rb +0 -71
  259. data/spec/models/learner_schema_spec.rb +0 -71
  260. data/spec/models/link_schema_spec.rb +0 -53
  261. data/spec/models/message_schema_spec.rb +0 -53
  262. data/spec/models/metadata_schema_spec.rb +0 -89
  263. data/spec/models/objective_schema_spec.rb +0 -137
  264. data/spec/models/permissions_schema_spec.rb +0 -59
  265. data/spec/models/ping_schema_spec.rb +0 -53
  266. data/spec/models/post_back_schema_spec.rb +0 -85
  267. data/spec/models/registration_completion_spec.rb +0 -47
  268. data/spec/models/registration_list_schema_spec.rb +0 -59
  269. data/spec/models/registration_schema_spec.rb +0 -167
  270. data/spec/models/registration_success_spec.rb +0 -47
  271. data/spec/models/response_error_spec.rb +0 -53
  272. data/spec/models/runtime_interaction_schema_spec.rb +0 -117
  273. data/spec/models/runtime_objective_schema_spec.rb +0 -109
  274. data/spec/models/runtime_schema_spec.rb +0 -171
  275. data/spec/models/score_schema_spec.rb +0 -53
  276. data/spec/models/setting_item_spec.rb +0 -81
  277. data/spec/models/setting_list_schema_spec.rb +0 -53
  278. data/spec/models/setting_metadata_spec.rb +0 -99
  279. data/spec/models/setting_metadata_valid_values_spec.rb +0 -59
  280. data/spec/models/settings_individual_schema_spec.rb +0 -65
  281. data/spec/models/settings_post_schema_spec.rb +0 -53
  282. data/spec/models/shared_data_entry_schema_spec.rb +0 -59
  283. data/spec/models/static_properties_schema_spec.rb +0 -83
  284. data/spec/models/string_result_schema_spec.rb +0 -53
  285. data/spec/models/title_schema_spec.rb +0 -53
  286. data/spec/models/token_request_schema_spec.rb +0 -59
  287. data/swagger-codegen.config +0 -11
@@ -3,10 +3,10 @@
3
3
 
4
4
  #REST API used for SCORM Cloud integrations.
5
5
 
6
- OpenAPI spec version: 2.0 beta
6
+ OpenAPI spec version: 2.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.4.3
9
+ Swagger Codegen version: 2.4.12
10
10
 
11
11
  =end
12
12
 
@@ -19,33 +19,33 @@ module RusticiSoftwareCloudV2
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Returns the launch link to use to preview this course
22
+ # Get a launch link to preview a Course
23
+ # Returns the launch link to use to preview the course. Course preview does not require an underlying registration. As such, no interactions will be tracked during the preview launch. Previews are meant to be a way to confirm the course looks and acts the way it should. >**Note:** >The cmi5 standard does not support the ability to preview a course. A launch link can be built for a cmi5 course, but visiting the link will result in an error page. More details can be found in this [article explaining the complications behind cmi5 preview launches](https://support.scorm.com/hc/en-us/articles/1260805676710).
23
24
  # @param course_id
24
25
  # @param launch_link_request
25
26
  # @param [Hash] opts the optional parameters
26
- # @option opts [String] :css_url
27
27
  # @return [LaunchLinkSchema]
28
28
  def build_course_preview_launch_link(course_id, launch_link_request, opts = {})
29
29
  data, _status_code, _headers = build_course_preview_launch_link_with_http_info(course_id, launch_link_request, opts)
30
30
  data
31
31
  end
32
32
 
33
- # Returns the launch link to use to preview this course
33
+ # Get a launch link to preview a Course
34
+ # Returns the launch link to use to preview the course. Course preview does not require an underlying registration. As such, no interactions will be tracked during the preview launch. Previews are meant to be a way to confirm the course looks and acts the way it should. >**Note:** >The cmi5 standard does not support the ability to preview a course. A launch link can be built for a cmi5 course, but visiting the link will result in an error page. More details can be found in this [article explaining the complications behind cmi5 preview launches](https://support.scorm.com/hc/en-us/articles/1260805676710).
34
35
  # @param course_id
35
36
  # @param launch_link_request
36
37
  # @param [Hash] opts the optional parameters
37
- # @option opts [String] :css_url
38
38
  # @return [Array<(LaunchLinkSchema, Fixnum, Hash)>] LaunchLinkSchema data, response status code and response headers
39
39
  def build_course_preview_launch_link_with_http_info(course_id, launch_link_request, opts = {})
40
40
  if @api_client.config.debugging
41
41
  @api_client.config.logger.debug 'Calling API: CourseApi.build_course_preview_launch_link ...'
42
42
  end
43
43
  # verify the required parameter 'course_id' is set
44
- if @api_client.config.client_side_validation && course_id.nil?
44
+ if course_id.nil?
45
45
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.build_course_preview_launch_link"
46
46
  end
47
47
  # verify the required parameter 'launch_link_request' is set
48
- if @api_client.config.client_side_validation && launch_link_request.nil?
48
+ if launch_link_request.nil?
49
49
  fail ArgumentError, "Missing the required parameter 'launch_link_request' when calling CourseApi.build_course_preview_launch_link"
50
50
  end
51
51
  # resource path
@@ -53,7 +53,6 @@ module RusticiSoftwareCloudV2
53
53
 
54
54
  # query parameters
55
55
  query_params = {}
56
- query_params[:'cssUrl'] = opts[:'css_url'] if !opts[:'css_url'].nil?
57
56
 
58
57
  # header parameters
59
58
  header_params = {}
@@ -80,9 +79,10 @@ module RusticiSoftwareCloudV2
80
79
  end
81
80
  return data, status_code, headers
82
81
  end
83
- # Returns the link to use to preview this course
82
+ # Get a launch link to preview a Course Version
83
+ # Returns the launch link to use to preview the course version. Course preview does not require an underlying registration. As such, no interactions will be tracked during the preview launch. Previews are meant to be a way to confirm the course looks and acts the way it should. >**Note:** >The cmi5 standard does not support the ability to preview a course. A launch link can be built for a cmi5 course, but visiting the link will result in an error page. More details can be found in this [article explaining the complications behind cmi5 preview launches](https://support.scorm.com/hc/en-us/articles/1260805676710).
84
84
  # @param course_id
85
- # @param version_id The course version
85
+ # @param version_id
86
86
  # @param launch_link_request
87
87
  # @param [Hash] opts the optional parameters
88
88
  # @return [LaunchLinkSchema]
@@ -91,9 +91,10 @@ module RusticiSoftwareCloudV2
91
91
  data
92
92
  end
93
93
 
94
- # Returns the link to use to preview this course
94
+ # Get a launch link to preview a Course Version
95
+ # Returns the launch link to use to preview the course version. Course preview does not require an underlying registration. As such, no interactions will be tracked during the preview launch. Previews are meant to be a way to confirm the course looks and acts the way it should. &gt;**Note:** &gt;The cmi5 standard does not support the ability to preview a course. A launch link can be built for a cmi5 course, but visiting the link will result in an error page. More details can be found in this [article explaining the complications behind cmi5 preview launches](https://support.scorm.com/hc/en-us/articles/1260805676710).
95
96
  # @param course_id
96
- # @param version_id The course version
97
+ # @param version_id
97
98
  # @param launch_link_request
98
99
  # @param [Hash] opts the optional parameters
99
100
  # @return [Array<(LaunchLinkSchema, Fixnum, Hash)>] LaunchLinkSchema data, response status code and response headers
@@ -102,15 +103,15 @@ module RusticiSoftwareCloudV2
102
103
  @api_client.config.logger.debug 'Calling API: CourseApi.build_course_preview_launch_link_with_version ...'
103
104
  end
104
105
  # verify the required parameter 'course_id' is set
105
- if @api_client.config.client_side_validation && course_id.nil?
106
+ if course_id.nil?
106
107
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.build_course_preview_launch_link_with_version"
107
108
  end
108
109
  # verify the required parameter 'version_id' is set
109
- if @api_client.config.client_side_validation && version_id.nil?
110
+ if version_id.nil?
110
111
  fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.build_course_preview_launch_link_with_version"
111
112
  end
112
113
  # verify the required parameter 'launch_link_request' is set
113
- if @api_client.config.client_side_validation && launch_link_request.nil?
114
+ if launch_link_request.nil?
114
115
  fail ArgumentError, "Missing the required parameter 'launch_link_request' when calling CourseApi.build_course_preview_launch_link_with_version"
115
116
  end
116
117
  # resource path
@@ -144,8 +145,8 @@ module RusticiSoftwareCloudV2
144
145
  end
145
146
  return data, status_code, headers
146
147
  end
147
- # Start a job to fetch and import a course.
148
- # An import job will be started to fetch and import the referenced file, and the import job ID will be returned. If the import is successful, the imported course will be registered using the courseId provided.\"
148
+ # Create a Course from a package fetched from an external source
149
+ # Creates a course from a package fetched and imported from the provided url. The package will be downloaded from the url and stored in SCORM Cloud. An import job ID will be returned, which can be used with GetImportJobStatus to view the status of the import. Courses represent the learning material a learner will progress through. >**Note:** >The import job ID used for calls to GetImportJobStatus are only valid for one week after the course import finishes.
149
150
  # @param course_id A unique identifier your application will use to identify the course after import. Your application is responsible both for generating this unique ID and for keeping track of the ID for later use.
150
151
  # @param import_request
151
152
  # @param [Hash] opts the optional parameters
@@ -157,8 +158,8 @@ module RusticiSoftwareCloudV2
157
158
  data
158
159
  end
159
160
 
160
- # Start a job to fetch and import a course.
161
- # An import job will be started to fetch and import the referenced file, and the import job ID will be returned. If the import is successful, the imported course will be registered using the courseId provided.\&quot;
161
+ # Create a Course from a package fetched from an external source
162
+ # Creates a course from a package fetched and imported from the provided url. The package will be downloaded from the url and stored in SCORM Cloud. An import job ID will be returned, which can be used with GetImportJobStatus to view the status of the import. Courses represent the learning material a learner will progress through. &gt;**Note:** &gt;The import job ID used for calls to GetImportJobStatus are only valid for one week after the course import finishes.
162
163
  # @param course_id A unique identifier your application will use to identify the course after import. Your application is responsible both for generating this unique ID and for keeping track of the ID for later use.
163
164
  # @param import_request
164
165
  # @param [Hash] opts the optional parameters
@@ -170,11 +171,11 @@ module RusticiSoftwareCloudV2
170
171
  @api_client.config.logger.debug 'Calling API: CourseApi.create_fetch_and_import_course_job ...'
171
172
  end
172
173
  # verify the required parameter 'course_id' is set
173
- if @api_client.config.client_side_validation && course_id.nil?
174
+ if course_id.nil?
174
175
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.create_fetch_and_import_course_job"
175
176
  end
176
177
  # verify the required parameter 'import_request' is set
177
- if @api_client.config.client_side_validation && import_request.nil?
178
+ if import_request.nil?
178
179
  fail ArgumentError, "Missing the required parameter 'import_request' when calling CourseApi.create_fetch_and_import_course_job"
179
180
  end
180
181
  # resource path
@@ -211,33 +212,104 @@ module RusticiSoftwareCloudV2
211
212
  end
212
213
  return data, status_code, headers
213
214
  end
214
- # Upload a course and start an import job for it.
215
- # An import job will be started to import the posted file, and the import job ID will be returned. If the import is successful, the imported course will be registered using the courseId provided.
215
+ # Create a Course from a fetched or referenced external media file
216
+ # Creates a course from one of two methods, fetchRequest or mediaFileReferenceRequest. In either case, an import job ID will be returned, which can be used with GetImportJobStatus to view the status of the import. Courses represent the learning material a learner will progress through. - A fetchRequest performs the same actions as CreateFetchAndImportCourseJob. A course will be created from a package fetched from the provided url. The package will be downloaded from the url and stored in SCORM Cloud. - A mediaFileReferenceRequest will not store the file in SCORM Cloud. Instead it will reference the media file at the time the learner needs to view the file from the provided url. >**Note:** >The import job ID used for calls to GetImportJobStatus are only valid for one week after the course import finishes. >**Info:** >Unless working with media files, it is typical to use one of the other two import methods. >- CreateUploadAndImportCourseJob would be used if the course is in your local file system. >- CreateFetchAndImportCourseJob would be better suited for situations where the course is uploaded remotely but is accessible via a public url.
217
+ # @param course_id A unique identifier your application will use to identify the course after import. Your application is responsible both for generating this unique ID and for keeping track of the ID for later use.
218
+ # @param import_request
219
+ # @param [Hash] opts the optional parameters
220
+ # @option opts [BOOLEAN] :may_create_new_version Is it OK to create a new version of this course? If this is set to false and the course already exists, the upload will fail. If true and the course already exists then a new version will be created. No effect if the course doesn&#39;t already exist. (default to false)
221
+ # @option opts [String] :postback_url An optional parameter that specifies a URL to send a postback to when the course has finished uploading.
222
+ # @return [StringResultSchema]
223
+ def create_no_upload_and_import_course_job(course_id, import_request, opts = {})
224
+ data, _status_code, _headers = create_no_upload_and_import_course_job_with_http_info(course_id, import_request, opts)
225
+ data
226
+ end
227
+
228
+ # Create a Course from a fetched or referenced external media file
229
+ # Creates a course from one of two methods, fetchRequest or mediaFileReferenceRequest. In either case, an import job ID will be returned, which can be used with GetImportJobStatus to view the status of the import. Courses represent the learning material a learner will progress through. - A fetchRequest performs the same actions as CreateFetchAndImportCourseJob. A course will be created from a package fetched from the provided url. The package will be downloaded from the url and stored in SCORM Cloud. - A mediaFileReferenceRequest will not store the file in SCORM Cloud. Instead it will reference the media file at the time the learner needs to view the file from the provided url. &gt;**Note:** &gt;The import job ID used for calls to GetImportJobStatus are only valid for one week after the course import finishes. &gt;**Info:** &gt;Unless working with media files, it is typical to use one of the other two import methods. &gt;- CreateUploadAndImportCourseJob would be used if the course is in your local file system. &gt;- CreateFetchAndImportCourseJob would be better suited for situations where the course is uploaded remotely but is accessible via a public url.
230
+ # @param course_id A unique identifier your application will use to identify the course after import. Your application is responsible both for generating this unique ID and for keeping track of the ID for later use.
231
+ # @param import_request
232
+ # @param [Hash] opts the optional parameters
233
+ # @option opts [BOOLEAN] :may_create_new_version Is it OK to create a new version of this course? If this is set to false and the course already exists, the upload will fail. If true and the course already exists then a new version will be created. No effect if the course doesn&#39;t already exist.
234
+ # @option opts [String] :postback_url An optional parameter that specifies a URL to send a postback to when the course has finished uploading.
235
+ # @return [Array<(StringResultSchema, Fixnum, Hash)>] StringResultSchema data, response status code and response headers
236
+ def create_no_upload_and_import_course_job_with_http_info(course_id, import_request, opts = {})
237
+ if @api_client.config.debugging
238
+ @api_client.config.logger.debug 'Calling API: CourseApi.create_no_upload_and_import_course_job ...'
239
+ end
240
+ # verify the required parameter 'course_id' is set
241
+ if course_id.nil?
242
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.create_no_upload_and_import_course_job"
243
+ end
244
+ # verify the required parameter 'import_request' is set
245
+ if import_request.nil?
246
+ fail ArgumentError, "Missing the required parameter 'import_request' when calling CourseApi.create_no_upload_and_import_course_job"
247
+ end
248
+ # resource path
249
+ local_var_path = '/courses/importJobs/noUpload'
250
+
251
+ # query parameters
252
+ query_params = {}
253
+ query_params[:'courseId'] = course_id
254
+ query_params[:'mayCreateNewVersion'] = opts[:'may_create_new_version'] if !opts[:'may_create_new_version'].nil?
255
+ query_params[:'postbackUrl'] = opts[:'postback_url'] if !opts[:'postback_url'].nil?
256
+
257
+ # header parameters
258
+ header_params = {}
259
+ # HTTP header 'Accept' (if needed)
260
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
261
+ # HTTP header 'Content-Type'
262
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
263
+
264
+ # form parameters
265
+ form_params = {}
266
+
267
+ # http body (model)
268
+ post_body = @api_client.object_to_http_body(import_request)
269
+ auth_names = ['APP_NORMAL', 'OAUTH']
270
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
271
+ :header_params => header_params,
272
+ :query_params => query_params,
273
+ :form_params => form_params,
274
+ :body => post_body,
275
+ :auth_names => auth_names,
276
+ :return_type => 'StringResultSchema')
277
+ if @api_client.config.debugging
278
+ @api_client.config.logger.debug "API called: CourseApi#create_no_upload_and_import_course_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
279
+ end
280
+ return data, status_code, headers
281
+ end
282
+ # Create a Course from an uploaded package
283
+ # Creates a course from a package uploaded from your file system. The package will be sent as part of the request and will be stored in SCORM Cloud. An import job ID will be returned, which can be used with GetImportJobStatus to view the status of the import. Courses represent the learning material a learner will progress through. >**Note:** >The import job ID used for calls to GetImportJobStatus are only valid for one week after the course import finishes.
216
284
  # @param course_id A unique identifier your application will use to identify the course after import. Your application is responsible both for generating this unique ID and for keeping track of the ID for later use.
217
285
  # @param [Hash] opts the optional parameters
218
286
  # @option opts [BOOLEAN] :may_create_new_version Is it OK to create a new version of this course? If this is set to false and the course already exists, the upload will fail. If true and the course already exists then a new version will be created. No effect if the course doesn&#39;t already exist. (default to false)
219
- # @option opts [File] :file The zip file of the course contents to import.
220
287
  # @option opts [String] :postback_url An optional parameter that specifies a URL to send a postback to when the course has finished uploading.
288
+ # @option opts [String] :uploaded_content_type The MIME type identifier for the content to be uploaded. This is required if uploading a media file (.pdf, .mp3, or .mp4). (default to application/zip)
289
+ # @option opts [String] :content_metadata Serialized &#39;mediaFileMetadata&#39; schema.
290
+ # @option opts [File] :file The zip file of the course contents to import.
221
291
  # @return [StringResultSchema]
222
292
  def create_upload_and_import_course_job(course_id, opts = {})
223
293
  data, _status_code, _headers = create_upload_and_import_course_job_with_http_info(course_id, opts)
224
294
  data
225
295
  end
226
296
 
227
- # Upload a course and start an import job for it.
228
- # An import job will be started to import the posted file, and the import job ID will be returned. If the import is successful, the imported course will be registered using the courseId provided.
297
+ # Create a Course from an uploaded package
298
+ # Creates a course from a package uploaded from your file system. The package will be sent as part of the request and will be stored in SCORM Cloud. An import job ID will be returned, which can be used with GetImportJobStatus to view the status of the import. Courses represent the learning material a learner will progress through. &gt;**Note:** &gt;The import job ID used for calls to GetImportJobStatus are only valid for one week after the course import finishes.
229
299
  # @param course_id A unique identifier your application will use to identify the course after import. Your application is responsible both for generating this unique ID and for keeping track of the ID for later use.
230
300
  # @param [Hash] opts the optional parameters
231
301
  # @option opts [BOOLEAN] :may_create_new_version Is it OK to create a new version of this course? If this is set to false and the course already exists, the upload will fail. If true and the course already exists then a new version will be created. No effect if the course doesn&#39;t already exist.
232
- # @option opts [File] :file The zip file of the course contents to import.
233
302
  # @option opts [String] :postback_url An optional parameter that specifies a URL to send a postback to when the course has finished uploading.
303
+ # @option opts [String] :uploaded_content_type The MIME type identifier for the content to be uploaded. This is required if uploading a media file (.pdf, .mp3, or .mp4).
304
+ # @option opts [String] :content_metadata Serialized &#39;mediaFileMetadata&#39; schema.
305
+ # @option opts [File] :file The zip file of the course contents to import.
234
306
  # @return [Array<(StringResultSchema, Fixnum, Hash)>] StringResultSchema data, response status code and response headers
235
307
  def create_upload_and_import_course_job_with_http_info(course_id, opts = {})
236
308
  if @api_client.config.debugging
237
309
  @api_client.config.logger.debug 'Calling API: CourseApi.create_upload_and_import_course_job ...'
238
310
  end
239
311
  # verify the required parameter 'course_id' is set
240
- if @api_client.config.client_side_validation && course_id.nil?
312
+ if course_id.nil?
241
313
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.create_upload_and_import_course_job"
242
314
  end
243
315
  # resource path
@@ -255,9 +327,11 @@ module RusticiSoftwareCloudV2
255
327
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
256
328
  # HTTP header 'Content-Type'
257
329
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
330
+ header_params[:'uploadedContentType'] = opts[:'uploaded_content_type'] if !opts[:'uploaded_content_type'].nil?
258
331
 
259
332
  # form parameters
260
333
  form_params = {}
334
+ form_params['contentMetadata'] = opts[:'content_metadata'] if !opts[:'content_metadata'].nil?
261
335
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
262
336
 
263
337
  # http body (model)
@@ -275,7 +349,8 @@ module RusticiSoftwareCloudV2
275
349
  end
276
350
  return data, status_code, headers
277
351
  end
278
- # Delete `courseId`
352
+ # Delete a Course
353
+ # Deletes the specified course. >**Caution:** >When a course is deleted, so is everything connected to the course. This includes: >- Registrations >- Invitations >- Dispatches >- Debug Logs
279
354
  # @param course_id
280
355
  # @param [Hash] opts the optional parameters
281
356
  # @return [nil]
@@ -284,7 +359,8 @@ module RusticiSoftwareCloudV2
284
359
  nil
285
360
  end
286
361
 
287
- # Delete &#x60;courseId&#x60;
362
+ # Delete a Course
363
+ # Deletes the specified course. &gt;**Caution:** &gt;When a course is deleted, so is everything connected to the course. This includes: &gt;- Registrations &gt;- Invitations &gt;- Dispatches &gt;- Debug Logs
288
364
  # @param course_id
289
365
  # @param [Hash] opts the optional parameters
290
366
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -293,7 +369,7 @@ module RusticiSoftwareCloudV2
293
369
  @api_client.config.logger.debug 'Calling API: CourseApi.delete_course ...'
294
370
  end
295
371
  # verify the required parameter 'course_id' is set
296
- if @api_client.config.client_side_validation && course_id.nil?
372
+ if course_id.nil?
297
373
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course"
298
374
  end
299
375
  # resource path
@@ -326,7 +402,68 @@ module RusticiSoftwareCloudV2
326
402
  end
327
403
  return data, status_code, headers
328
404
  end
329
- # Clears the `settingId` value for this course
405
+ # Delete an asset file from a Course
406
+ # Deletes the asset file at the specified relative path from the latest version of the course. GetCourseFileList can be used to find the relative path of the file. >**Caution:** >This may have unintended consequences if the asset is still being linked to in other files in the course. Make sure that other files relying on this asset are modified or removed as well. This can be done with the ImportCourseAssetFile or UploadCourseAssetFile endpoints.
407
+ # @param course_id
408
+ # @param relative_path Relative path of the asset within the course.
409
+ # @param [Hash] opts the optional parameters
410
+ # @return [nil]
411
+ def delete_course_asset(course_id, relative_path, opts = {})
412
+ delete_course_asset_with_http_info(course_id, relative_path, opts)
413
+ nil
414
+ end
415
+
416
+ # Delete an asset file from a Course
417
+ # Deletes the asset file at the specified relative path from the latest version of the course. GetCourseFileList can be used to find the relative path of the file. &gt;**Caution:** &gt;This may have unintended consequences if the asset is still being linked to in other files in the course. Make sure that other files relying on this asset are modified or removed as well. This can be done with the ImportCourseAssetFile or UploadCourseAssetFile endpoints.
418
+ # @param course_id
419
+ # @param relative_path Relative path of the asset within the course.
420
+ # @param [Hash] opts the optional parameters
421
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
422
+ def delete_course_asset_with_http_info(course_id, relative_path, opts = {})
423
+ if @api_client.config.debugging
424
+ @api_client.config.logger.debug 'Calling API: CourseApi.delete_course_asset ...'
425
+ end
426
+ # verify the required parameter 'course_id' is set
427
+ if course_id.nil?
428
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_asset"
429
+ end
430
+ # verify the required parameter 'relative_path' is set
431
+ if relative_path.nil?
432
+ fail ArgumentError, "Missing the required parameter 'relative_path' when calling CourseApi.delete_course_asset"
433
+ end
434
+ # resource path
435
+ local_var_path = '/courses/{courseId}/asset'.sub('{' + 'courseId' + '}', course_id.to_s)
436
+
437
+ # query parameters
438
+ query_params = {}
439
+ query_params[:'relativePath'] = relative_path
440
+
441
+ # header parameters
442
+ header_params = {}
443
+ # HTTP header 'Accept' (if needed)
444
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
445
+ # HTTP header 'Content-Type'
446
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
447
+
448
+ # form parameters
449
+ form_params = {}
450
+
451
+ # http body (model)
452
+ post_body = nil
453
+ auth_names = ['APP_NORMAL', 'OAUTH']
454
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
455
+ :header_params => header_params,
456
+ :query_params => query_params,
457
+ :form_params => form_params,
458
+ :body => post_body,
459
+ :auth_names => auth_names)
460
+ if @api_client.config.debugging
461
+ @api_client.config.logger.debug "API called: CourseApi#delete_course_asset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
462
+ end
463
+ return data, status_code, headers
464
+ end
465
+ # Delete a configuration setting explicitly set for a Course
466
+ # Clears the specified setting from the course. This causes the setting to inherit a value from a higher level (e.g. application). If the configuration setting was not set at the course level it will continue to persist and will require deletion from the level it was set.
330
467
  # @param course_id
331
468
  # @param setting_id
332
469
  # @param [Hash] opts the optional parameters
@@ -336,7 +473,8 @@ module RusticiSoftwareCloudV2
336
473
  nil
337
474
  end
338
475
 
339
- # Clears the &#x60;settingId&#x60; value for this course
476
+ # Delete a configuration setting explicitly set for a Course
477
+ # Clears the specified setting from the course. This causes the setting to inherit a value from a higher level (e.g. application). If the configuration setting was not set at the course level it will continue to persist and will require deletion from the level it was set.
340
478
  # @param course_id
341
479
  # @param setting_id
342
480
  # @param [Hash] opts the optional parameters
@@ -346,11 +484,11 @@ module RusticiSoftwareCloudV2
346
484
  @api_client.config.logger.debug 'Calling API: CourseApi.delete_course_configuration_setting ...'
347
485
  end
348
486
  # verify the required parameter 'course_id' is set
349
- if @api_client.config.client_side_validation && course_id.nil?
487
+ if course_id.nil?
350
488
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_configuration_setting"
351
489
  end
352
490
  # verify the required parameter 'setting_id' is set
353
- if @api_client.config.client_side_validation && setting_id.nil?
491
+ if setting_id.nil?
354
492
  fail ArgumentError, "Missing the required parameter 'setting_id' when calling CourseApi.delete_course_configuration_setting"
355
493
  end
356
494
  # resource path
@@ -383,7 +521,8 @@ module RusticiSoftwareCloudV2
383
521
  end
384
522
  return data, status_code, headers
385
523
  end
386
- # Delete tags for this course
524
+ # Delete tags from a Course
525
+ # Deletes the specified tags from the course. Deleting tags that do not exist will still result in a success.
387
526
  # @param course_id
388
527
  # @param tags
389
528
  # @param [Hash] opts the optional parameters
@@ -393,7 +532,8 @@ module RusticiSoftwareCloudV2
393
532
  nil
394
533
  end
395
534
 
396
- # Delete tags for this course
535
+ # Delete tags from a Course
536
+ # Deletes the specified tags from the course. Deleting tags that do not exist will still result in a success.
397
537
  # @param course_id
398
538
  # @param tags
399
539
  # @param [Hash] opts the optional parameters
@@ -403,11 +543,11 @@ module RusticiSoftwareCloudV2
403
543
  @api_client.config.logger.debug 'Calling API: CourseApi.delete_course_tags ...'
404
544
  end
405
545
  # verify the required parameter 'course_id' is set
406
- if @api_client.config.client_side_validation && course_id.nil?
546
+ if course_id.nil?
407
547
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_tags"
408
548
  end
409
549
  # verify the required parameter 'tags' is set
410
- if @api_client.config.client_side_validation && tags.nil?
550
+ if tags.nil?
411
551
  fail ArgumentError, "Missing the required parameter 'tags' when calling CourseApi.delete_course_tags"
412
552
  end
413
553
  # resource path
@@ -440,9 +580,10 @@ module RusticiSoftwareCloudV2
440
580
  end
441
581
  return data, status_code, headers
442
582
  end
443
- # Delete version `versionId` of `courseId`
583
+ # Delete a Course Version
584
+ # Deletes the specified version of the course. If deleting the last remaining version of the course, the course itself will be deleted and no longer accessible. >**Caution:** >When a course is deleted, so is everything connected to this course. This includes: >- Registrations >- Invitations >- Dispatches >- Debug Logs
444
585
  # @param course_id
445
- # @param version_id The course version
586
+ # @param version_id
446
587
  # @param [Hash] opts the optional parameters
447
588
  # @return [nil]
448
589
  def delete_course_version(course_id, version_id, opts = {})
@@ -450,9 +591,10 @@ module RusticiSoftwareCloudV2
450
591
  nil
451
592
  end
452
593
 
453
- # Delete version &#x60;versionId&#x60; of &#x60;courseId&#x60;
594
+ # Delete a Course Version
595
+ # Deletes the specified version of the course. If deleting the last remaining version of the course, the course itself will be deleted and no longer accessible. &gt;**Caution:** &gt;When a course is deleted, so is everything connected to this course. This includes: &gt;- Registrations &gt;- Invitations &gt;- Dispatches &gt;- Debug Logs
454
596
  # @param course_id
455
- # @param version_id The course version
597
+ # @param version_id
456
598
  # @param [Hash] opts the optional parameters
457
599
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
458
600
  def delete_course_version_with_http_info(course_id, version_id, opts = {})
@@ -460,11 +602,11 @@ module RusticiSoftwareCloudV2
460
602
  @api_client.config.logger.debug 'Calling API: CourseApi.delete_course_version ...'
461
603
  end
462
604
  # verify the required parameter 'course_id' is set
463
- if @api_client.config.client_side_validation && course_id.nil?
605
+ if course_id.nil?
464
606
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_version"
465
607
  end
466
608
  # verify the required parameter 'version_id' is set
467
- if @api_client.config.client_side_validation && version_id.nil?
609
+ if version_id.nil?
468
610
  fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.delete_course_version"
469
611
  end
470
612
  # resource path
@@ -497,9 +639,76 @@ module RusticiSoftwareCloudV2
497
639
  end
498
640
  return data, status_code, headers
499
641
  end
500
- # Clears the `settingId` value for this course and version.
642
+ # Delete an asset file from a Course Version
643
+ # Deletes the asset file at the specified relative path from the course version. GetCourseVersionFileList can be used to find the relative path of the file. >**Caution:** >This may have unintended consequences if the asset is still being linked to in other files in the course. Make sure that other files relying on this asset are modified or removed as well. This can be done with the ImportCourseVersionAssetFile or UploadCourseVersionAssetFile endpoints.
644
+ # @param course_id
645
+ # @param version_id
646
+ # @param relative_path Relative path of the asset within the course.
647
+ # @param [Hash] opts the optional parameters
648
+ # @return [nil]
649
+ def delete_course_version_asset(course_id, version_id, relative_path, opts = {})
650
+ delete_course_version_asset_with_http_info(course_id, version_id, relative_path, opts)
651
+ nil
652
+ end
653
+
654
+ # Delete an asset file from a Course Version
655
+ # Deletes the asset file at the specified relative path from the course version. GetCourseVersionFileList can be used to find the relative path of the file. &gt;**Caution:** &gt;This may have unintended consequences if the asset is still being linked to in other files in the course. Make sure that other files relying on this asset are modified or removed as well. This can be done with the ImportCourseVersionAssetFile or UploadCourseVersionAssetFile endpoints.
656
+ # @param course_id
657
+ # @param version_id
658
+ # @param relative_path Relative path of the asset within the course.
659
+ # @param [Hash] opts the optional parameters
660
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
661
+ def delete_course_version_asset_with_http_info(course_id, version_id, relative_path, opts = {})
662
+ if @api_client.config.debugging
663
+ @api_client.config.logger.debug 'Calling API: CourseApi.delete_course_version_asset ...'
664
+ end
665
+ # verify the required parameter 'course_id' is set
666
+ if course_id.nil?
667
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_version_asset"
668
+ end
669
+ # verify the required parameter 'version_id' is set
670
+ if version_id.nil?
671
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.delete_course_version_asset"
672
+ end
673
+ # verify the required parameter 'relative_path' is set
674
+ if relative_path.nil?
675
+ fail ArgumentError, "Missing the required parameter 'relative_path' when calling CourseApi.delete_course_version_asset"
676
+ end
677
+ # resource path
678
+ local_var_path = '/courses/{courseId}/versions/{versionId}/asset'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
679
+
680
+ # query parameters
681
+ query_params = {}
682
+ query_params[:'relativePath'] = relative_path
683
+
684
+ # header parameters
685
+ header_params = {}
686
+ # HTTP header 'Accept' (if needed)
687
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
688
+ # HTTP header 'Content-Type'
689
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
690
+
691
+ # form parameters
692
+ form_params = {}
693
+
694
+ # http body (model)
695
+ post_body = nil
696
+ auth_names = ['APP_NORMAL', 'OAUTH']
697
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
698
+ :header_params => header_params,
699
+ :query_params => query_params,
700
+ :form_params => form_params,
701
+ :body => post_body,
702
+ :auth_names => auth_names)
703
+ if @api_client.config.debugging
704
+ @api_client.config.logger.debug "API called: CourseApi#delete_course_version_asset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
705
+ end
706
+ return data, status_code, headers
707
+ end
708
+ # Delete a configuration setting explicitly set for a Course Version
709
+ # Clears the specified setting from the course version. This causes the setting to inherit a value from a higher level (e.g. application). If the configuration setting was not set at the course level it will continue to persist and will require deletion from the level it was set.
501
710
  # @param course_id
502
- # @param version_id The course version
711
+ # @param version_id
503
712
  # @param setting_id
504
713
  # @param [Hash] opts the optional parameters
505
714
  # @return [nil]
@@ -508,9 +717,10 @@ module RusticiSoftwareCloudV2
508
717
  nil
509
718
  end
510
719
 
511
- # Clears the &#x60;settingId&#x60; value for this course and version.
720
+ # Delete a configuration setting explicitly set for a Course Version
721
+ # Clears the specified setting from the course version. This causes the setting to inherit a value from a higher level (e.g. application). If the configuration setting was not set at the course level it will continue to persist and will require deletion from the level it was set.
512
722
  # @param course_id
513
- # @param version_id The course version
723
+ # @param version_id
514
724
  # @param setting_id
515
725
  # @param [Hash] opts the optional parameters
516
726
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -519,15 +729,15 @@ module RusticiSoftwareCloudV2
519
729
  @api_client.config.logger.debug 'Calling API: CourseApi.delete_course_version_configuration_setting ...'
520
730
  end
521
731
  # verify the required parameter 'course_id' is set
522
- if @api_client.config.client_side_validation && course_id.nil?
732
+ if course_id.nil?
523
733
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_version_configuration_setting"
524
734
  end
525
735
  # verify the required parameter 'version_id' is set
526
- if @api_client.config.client_side_validation && version_id.nil?
736
+ if version_id.nil?
527
737
  fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.delete_course_version_configuration_setting"
528
738
  end
529
739
  # verify the required parameter 'setting_id' is set
530
- if @api_client.config.client_side_validation && setting_id.nil?
740
+ if setting_id.nil?
531
741
  fail ArgumentError, "Missing the required parameter 'setting_id' when calling CourseApi.delete_course_version_configuration_setting"
532
742
  end
533
743
  # resource path
@@ -560,7 +770,8 @@ module RusticiSoftwareCloudV2
560
770
  end
561
771
  return data, status_code, headers
562
772
  end
563
- # Get information about `courseId`
773
+ # Get detailed information about a Course
774
+ # Returns detailed information about the course. This includes title, update date, learning standard, and version.
564
775
  # @param course_id
565
776
  # @param [Hash] opts the optional parameters
566
777
  # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
@@ -571,7 +782,8 @@ module RusticiSoftwareCloudV2
571
782
  data
572
783
  end
573
784
 
574
- # Get information about &#x60;courseId&#x60;
785
+ # Get detailed information about a Course
786
+ # Returns detailed information about the course. This includes title, update date, learning standard, and version.
575
787
  # @param course_id
576
788
  # @param [Hash] opts the optional parameters
577
789
  # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
@@ -582,7 +794,7 @@ module RusticiSoftwareCloudV2
582
794
  @api_client.config.logger.debug 'Calling API: CourseApi.get_course ...'
583
795
  end
584
796
  # verify the required parameter 'course_id' is set
585
- if @api_client.config.client_side_validation && course_id.nil?
797
+ if course_id.nil?
586
798
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course"
587
799
  end
588
800
  # resource path
@@ -618,7 +830,69 @@ module RusticiSoftwareCloudV2
618
830
  end
619
831
  return data, status_code, headers
620
832
  end
621
- # Returns all configuration settings for this course
833
+ # Download an asset file from a Course
834
+ # Downloads the asset file at the specified relative path from the latest version of the course. GetCourseFileList can be used to find the relative path of the file.
835
+ # @param course_id
836
+ # @param relative_path Relative path of the asset within the course.
837
+ # @param [Hash] opts the optional parameters
838
+ # @return [File]
839
+ def get_course_asset(course_id, relative_path, opts = {})
840
+ data, _status_code, _headers = get_course_asset_with_http_info(course_id, relative_path, opts)
841
+ data
842
+ end
843
+
844
+ # Download an asset file from a Course
845
+ # Downloads the asset file at the specified relative path from the latest version of the course. GetCourseFileList can be used to find the relative path of the file.
846
+ # @param course_id
847
+ # @param relative_path Relative path of the asset within the course.
848
+ # @param [Hash] opts the optional parameters
849
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
850
+ def get_course_asset_with_http_info(course_id, relative_path, opts = {})
851
+ if @api_client.config.debugging
852
+ @api_client.config.logger.debug 'Calling API: CourseApi.get_course_asset ...'
853
+ end
854
+ # verify the required parameter 'course_id' is set
855
+ if course_id.nil?
856
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_asset"
857
+ end
858
+ # verify the required parameter 'relative_path' is set
859
+ if relative_path.nil?
860
+ fail ArgumentError, "Missing the required parameter 'relative_path' when calling CourseApi.get_course_asset"
861
+ end
862
+ # resource path
863
+ local_var_path = '/courses/{courseId}/asset'.sub('{' + 'courseId' + '}', course_id.to_s)
864
+
865
+ # query parameters
866
+ query_params = {}
867
+ query_params[:'relativePath'] = relative_path
868
+
869
+ # header parameters
870
+ header_params = {}
871
+ # HTTP header 'Accept' (if needed)
872
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
873
+ # HTTP header 'Content-Type'
874
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
875
+
876
+ # form parameters
877
+ form_params = {}
878
+
879
+ # http body (model)
880
+ post_body = nil
881
+ auth_names = ['APP_NORMAL', 'OAUTH']
882
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
883
+ :header_params => header_params,
884
+ :query_params => query_params,
885
+ :form_params => form_params,
886
+ :body => post_body,
887
+ :auth_names => auth_names,
888
+ :return_type => 'File')
889
+ if @api_client.config.debugging
890
+ @api_client.config.logger.debug "API called: CourseApi#get_course_asset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
891
+ end
892
+ return data, status_code, headers
893
+ end
894
+ # Get effective configuration settings for a Course
895
+ # Returns the effective configuration settings for the course. If not set at the course level, the setting will inherit a value from a higher level (e.g. application). If there is a configuration setting present at a more specific level, that setting will override the one set at the course level.
622
896
  # @param course_id
623
897
  # @param [Hash] opts the optional parameters
624
898
  # @option opts [BOOLEAN] :include_metadata (default to false)
@@ -628,7 +902,8 @@ module RusticiSoftwareCloudV2
628
902
  data
629
903
  end
630
904
 
631
- # Returns all configuration settings for this course
905
+ # Get effective configuration settings for a Course
906
+ # Returns the effective configuration settings for the course. If not set at the course level, the setting will inherit a value from a higher level (e.g. application). If there is a configuration setting present at a more specific level, that setting will override the one set at the course level.
632
907
  # @param course_id
633
908
  # @param [Hash] opts the optional parameters
634
909
  # @option opts [BOOLEAN] :include_metadata
@@ -638,7 +913,7 @@ module RusticiSoftwareCloudV2
638
913
  @api_client.config.logger.debug 'Calling API: CourseApi.get_course_configuration ...'
639
914
  end
640
915
  # verify the required parameter 'course_id' is set
641
- if @api_client.config.client_side_validation && course_id.nil?
916
+ if course_id.nil?
642
917
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_configuration"
643
918
  end
644
919
  # resource path
@@ -673,33 +948,89 @@ module RusticiSoftwareCloudV2
673
948
  end
674
949
  return data, status_code, headers
675
950
  end
676
- # Get xAPI statements for `courseId`
951
+ # Get a list of asset files in a Course
952
+ # Returns a list of asset files in the course. Included will be the relative path to use for the other course asset manipulation calls.
953
+ # @param course_id
954
+ # @param [Hash] opts the optional parameters
955
+ # @return [FileListSchema]
956
+ def get_course_file_list(course_id, opts = {})
957
+ data, _status_code, _headers = get_course_file_list_with_http_info(course_id, opts)
958
+ data
959
+ end
960
+
961
+ # Get a list of asset files in a Course
962
+ # Returns a list of asset files in the course. Included will be the relative path to use for the other course asset manipulation calls.
963
+ # @param course_id
964
+ # @param [Hash] opts the optional parameters
965
+ # @return [Array<(FileListSchema, Fixnum, Hash)>] FileListSchema data, response status code and response headers
966
+ def get_course_file_list_with_http_info(course_id, opts = {})
967
+ if @api_client.config.debugging
968
+ @api_client.config.logger.debug 'Calling API: CourseApi.get_course_file_list ...'
969
+ end
970
+ # verify the required parameter 'course_id' is set
971
+ if course_id.nil?
972
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_file_list"
973
+ end
974
+ # resource path
975
+ local_var_path = '/courses/{courseId}/asset/list'.sub('{' + 'courseId' + '}', course_id.to_s)
976
+
977
+ # query parameters
978
+ query_params = {}
979
+
980
+ # header parameters
981
+ header_params = {}
982
+ # HTTP header 'Accept' (if needed)
983
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
984
+ # HTTP header 'Content-Type'
985
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
986
+
987
+ # form parameters
988
+ form_params = {}
989
+
990
+ # http body (model)
991
+ post_body = nil
992
+ auth_names = ['APP_NORMAL', 'OAUTH']
993
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
994
+ :header_params => header_params,
995
+ :query_params => query_params,
996
+ :form_params => form_params,
997
+ :body => post_body,
998
+ :auth_names => auth_names,
999
+ :return_type => 'FileListSchema')
1000
+ if @api_client.config.debugging
1001
+ @api_client.config.logger.debug "API called: CourseApi#get_course_file_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1002
+ end
1003
+ return data, status_code, headers
1004
+ end
1005
+ # Get xAPI statements for a Course
1006
+ # Returns xAPI statements for the course.
677
1007
  # @param course_id
678
1008
  # @param [Hash] opts the optional parameters
679
1009
  # @option opts [String] :learner_id Only entries for the specified learner id will be included.
680
- # @option opts [DateTime] :since 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.
681
- # @option opts [DateTime] :_until 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.
682
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
1010
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1011
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1012
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
683
1013
  # @return [XapiStatementResult]
684
1014
  def get_course_statements(course_id, opts = {})
685
1015
  data, _status_code, _headers = get_course_statements_with_http_info(course_id, opts)
686
1016
  data
687
1017
  end
688
1018
 
689
- # Get xAPI statements for &#x60;courseId&#x60;
1019
+ # Get xAPI statements for a Course
1020
+ # Returns xAPI statements for the course.
690
1021
  # @param course_id
691
1022
  # @param [Hash] opts the optional parameters
692
1023
  # @option opts [String] :learner_id Only entries for the specified learner id will be included.
693
- # @option opts [DateTime] :since 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.
694
- # @option opts [DateTime] :_until 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.
695
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
1024
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1025
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1026
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
696
1027
  # @return [Array<(XapiStatementResult, Fixnum, Hash)>] XapiStatementResult data, response status code and response headers
697
1028
  def get_course_statements_with_http_info(course_id, opts = {})
698
1029
  if @api_client.config.debugging
699
1030
  @api_client.config.logger.debug 'Calling API: CourseApi.get_course_statements ...'
700
1031
  end
701
1032
  # verify the required parameter 'course_id' is set
702
- if @api_client.config.client_side_validation && course_id.nil?
1033
+ if course_id.nil?
703
1034
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_statements"
704
1035
  end
705
1036
  # resource path
@@ -737,7 +1068,8 @@ module RusticiSoftwareCloudV2
737
1068
  end
738
1069
  return data, status_code, headers
739
1070
  end
740
- # Get the tags for this course
1071
+ # Get tags for a Course
1072
+ # Returns the tags for the course.
741
1073
  # @param course_id
742
1074
  # @param [Hash] opts the optional parameters
743
1075
  # @return [TagListSchema]
@@ -746,7 +1078,8 @@ module RusticiSoftwareCloudV2
746
1078
  data
747
1079
  end
748
1080
 
749
- # Get the tags for this course
1081
+ # Get tags for a Course
1082
+ # Returns the tags for the course.
750
1083
  # @param course_id
751
1084
  # @param [Hash] opts the optional parameters
752
1085
  # @return [Array<(TagListSchema, Fixnum, Hash)>] TagListSchema data, response status code and response headers
@@ -755,7 +1088,7 @@ module RusticiSoftwareCloudV2
755
1088
  @api_client.config.logger.debug 'Calling API: CourseApi.get_course_tags ...'
756
1089
  end
757
1090
  # verify the required parameter 'course_id' is set
758
- if @api_client.config.client_side_validation && course_id.nil?
1091
+ if course_id.nil?
759
1092
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_tags"
760
1093
  end
761
1094
  # resource path
@@ -789,9 +1122,77 @@ module RusticiSoftwareCloudV2
789
1122
  end
790
1123
  return data, status_code, headers
791
1124
  end
792
- # Returns all configuration settings for this course and version.
1125
+ # Download an asset file from a specific Course Version
1126
+ # Downloads the asset file at the provided relative path from the course version. GetCourseVersionFileList can be used to find the relative path of the file.
793
1127
  # @param course_id
794
- # @param version_id The course version
1128
+ # @param version_id
1129
+ # @param relative_path Relative path of the asset within the course.
1130
+ # @param [Hash] opts the optional parameters
1131
+ # @return [File]
1132
+ def get_course_version_asset(course_id, version_id, relative_path, opts = {})
1133
+ data, _status_code, _headers = get_course_version_asset_with_http_info(course_id, version_id, relative_path, opts)
1134
+ data
1135
+ end
1136
+
1137
+ # Download an asset file from a specific Course Version
1138
+ # Downloads the asset file at the provided relative path from the course version. GetCourseVersionFileList can be used to find the relative path of the file.
1139
+ # @param course_id
1140
+ # @param version_id
1141
+ # @param relative_path Relative path of the asset within the course.
1142
+ # @param [Hash] opts the optional parameters
1143
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
1144
+ def get_course_version_asset_with_http_info(course_id, version_id, relative_path, opts = {})
1145
+ if @api_client.config.debugging
1146
+ @api_client.config.logger.debug 'Calling API: CourseApi.get_course_version_asset ...'
1147
+ end
1148
+ # verify the required parameter 'course_id' is set
1149
+ if course_id.nil?
1150
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_asset"
1151
+ end
1152
+ # verify the required parameter 'version_id' is set
1153
+ if version_id.nil?
1154
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_course_version_asset"
1155
+ end
1156
+ # verify the required parameter 'relative_path' is set
1157
+ if relative_path.nil?
1158
+ fail ArgumentError, "Missing the required parameter 'relative_path' when calling CourseApi.get_course_version_asset"
1159
+ end
1160
+ # resource path
1161
+ local_var_path = '/courses/{courseId}/versions/{versionId}/asset'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
1162
+
1163
+ # query parameters
1164
+ query_params = {}
1165
+ query_params[:'relativePath'] = relative_path
1166
+
1167
+ # header parameters
1168
+ header_params = {}
1169
+ # HTTP header 'Accept' (if needed)
1170
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
1171
+ # HTTP header 'Content-Type'
1172
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1173
+
1174
+ # form parameters
1175
+ form_params = {}
1176
+
1177
+ # http body (model)
1178
+ post_body = nil
1179
+ auth_names = ['APP_NORMAL', 'OAUTH']
1180
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1181
+ :header_params => header_params,
1182
+ :query_params => query_params,
1183
+ :form_params => form_params,
1184
+ :body => post_body,
1185
+ :auth_names => auth_names,
1186
+ :return_type => 'File')
1187
+ if @api_client.config.debugging
1188
+ @api_client.config.logger.debug "API called: CourseApi#get_course_version_asset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1189
+ end
1190
+ return data, status_code, headers
1191
+ end
1192
+ # Get effective configuration settings for a Course Version
1193
+ # Returns the effective configuration settings for the course version. If not set at the course level, the setting will inherit a value from a higher level (e.g. application). If there is a configuration setting present at a more specific level, that setting will override the one set at the course level.
1194
+ # @param course_id
1195
+ # @param version_id
795
1196
  # @param [Hash] opts the optional parameters
796
1197
  # @option opts [BOOLEAN] :include_metadata (default to false)
797
1198
  # @return [SettingListSchema]
@@ -800,9 +1201,10 @@ module RusticiSoftwareCloudV2
800
1201
  data
801
1202
  end
802
1203
 
803
- # Returns all configuration settings for this course and version.
1204
+ # Get effective configuration settings for a Course Version
1205
+ # Returns the effective configuration settings for the course version. If not set at the course level, the setting will inherit a value from a higher level (e.g. application). If there is a configuration setting present at a more specific level, that setting will override the one set at the course level.
804
1206
  # @param course_id
805
- # @param version_id The course version
1207
+ # @param version_id
806
1208
  # @param [Hash] opts the optional parameters
807
1209
  # @option opts [BOOLEAN] :include_metadata
808
1210
  # @return [Array<(SettingListSchema, Fixnum, Hash)>] SettingListSchema data, response status code and response headers
@@ -811,11 +1213,11 @@ module RusticiSoftwareCloudV2
811
1213
  @api_client.config.logger.debug 'Calling API: CourseApi.get_course_version_configuration ...'
812
1214
  end
813
1215
  # verify the required parameter 'course_id' is set
814
- if @api_client.config.client_side_validation && course_id.nil?
1216
+ if course_id.nil?
815
1217
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_configuration"
816
1218
  end
817
1219
  # verify the required parameter 'version_id' is set
818
- if @api_client.config.client_side_validation && version_id.nil?
1220
+ if version_id.nil?
819
1221
  fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_course_version_configuration"
820
1222
  end
821
1223
  # resource path
@@ -850,9 +1252,70 @@ module RusticiSoftwareCloudV2
850
1252
  end
851
1253
  return data, status_code, headers
852
1254
  end
853
- # Get version `versionId` of `courseId`
1255
+ # Get a list of asset files in a Course Version
1256
+ # Returns a list of asset files in the course version. Included will be the relative path to use for the other course asset manipulation calls.
1257
+ # @param course_id
1258
+ # @param version_id
1259
+ # @param [Hash] opts the optional parameters
1260
+ # @return [FileListSchema]
1261
+ def get_course_version_file_list(course_id, version_id, opts = {})
1262
+ data, _status_code, _headers = get_course_version_file_list_with_http_info(course_id, version_id, opts)
1263
+ data
1264
+ end
1265
+
1266
+ # Get a list of asset files in a Course Version
1267
+ # Returns a list of asset files in the course version. Included will be the relative path to use for the other course asset manipulation calls.
1268
+ # @param course_id
1269
+ # @param version_id
1270
+ # @param [Hash] opts the optional parameters
1271
+ # @return [Array<(FileListSchema, Fixnum, Hash)>] FileListSchema data, response status code and response headers
1272
+ def get_course_version_file_list_with_http_info(course_id, version_id, opts = {})
1273
+ if @api_client.config.debugging
1274
+ @api_client.config.logger.debug 'Calling API: CourseApi.get_course_version_file_list ...'
1275
+ end
1276
+ # verify the required parameter 'course_id' is set
1277
+ if course_id.nil?
1278
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_file_list"
1279
+ end
1280
+ # verify the required parameter 'version_id' is set
1281
+ if version_id.nil?
1282
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_course_version_file_list"
1283
+ end
1284
+ # resource path
1285
+ local_var_path = '/courses/{courseId}/versions/{versionId}/asset/list'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
1286
+
1287
+ # query parameters
1288
+ query_params = {}
1289
+
1290
+ # header parameters
1291
+ header_params = {}
1292
+ # HTTP header 'Accept' (if needed)
1293
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1294
+ # HTTP header 'Content-Type'
1295
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1296
+
1297
+ # form parameters
1298
+ form_params = {}
1299
+
1300
+ # http body (model)
1301
+ post_body = nil
1302
+ auth_names = ['APP_NORMAL', 'OAUTH']
1303
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1304
+ :header_params => header_params,
1305
+ :query_params => query_params,
1306
+ :form_params => form_params,
1307
+ :body => post_body,
1308
+ :auth_names => auth_names,
1309
+ :return_type => 'FileListSchema')
1310
+ if @api_client.config.debugging
1311
+ @api_client.config.logger.debug "API called: CourseApi#get_course_version_file_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1312
+ end
1313
+ return data, status_code, headers
1314
+ end
1315
+ # Get detailed information about a Course Version
1316
+ # Returns detailed information about the course version. This includes update date and registration count (if optional value is passed in).
854
1317
  # @param course_id
855
- # @param version_id The course version
1318
+ # @param version_id
856
1319
  # @param [Hash] opts the optional parameters
857
1320
  # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
858
1321
  # @option opts [BOOLEAN] :include_course_metadata Include course metadata in the results. If the course has no metadata, adding this parameter has no effect. (default to false)
@@ -862,9 +1325,10 @@ module RusticiSoftwareCloudV2
862
1325
  data
863
1326
  end
864
1327
 
865
- # Get version &#x60;versionId&#x60; of &#x60;courseId&#x60;
1328
+ # Get detailed information about a Course Version
1329
+ # Returns detailed information about the course version. This includes update date and registration count (if optional value is passed in).
866
1330
  # @param course_id
867
- # @param version_id The course version
1331
+ # @param version_id
868
1332
  # @param [Hash] opts the optional parameters
869
1333
  # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
870
1334
  # @option opts [BOOLEAN] :include_course_metadata Include course metadata in the results. If the course has no metadata, adding this parameter has no effect.
@@ -874,11 +1338,11 @@ module RusticiSoftwareCloudV2
874
1338
  @api_client.config.logger.debug 'Calling API: CourseApi.get_course_version_info ...'
875
1339
  end
876
1340
  # verify the required parameter 'course_id' is set
877
- if @api_client.config.client_side_validation && course_id.nil?
1341
+ if course_id.nil?
878
1342
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_info"
879
1343
  end
880
1344
  # verify the required parameter 'version_id' is set
881
- if @api_client.config.client_side_validation && version_id.nil?
1345
+ if version_id.nil?
882
1346
  fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_course_version_info"
883
1347
  end
884
1348
  # resource path
@@ -914,39 +1378,41 @@ module RusticiSoftwareCloudV2
914
1378
  end
915
1379
  return data, status_code, headers
916
1380
  end
917
- # Get xAPI statements for version `versionId` of `courseId`
1381
+ # Get xAPI statements for a Course Version
1382
+ # Returns xAPI statements for the course version.
918
1383
  # @param course_id
919
- # @param version_id The course version
1384
+ # @param version_id
920
1385
  # @param [Hash] opts the optional parameters
921
1386
  # @option opts [String] :learner_id Only entries for the specified learner id will be included.
922
- # @option opts [DateTime] :since 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.
923
- # @option opts [DateTime] :_until 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.
924
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
1387
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1388
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1389
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
925
1390
  # @return [XapiStatementResult]
926
1391
  def get_course_version_statements(course_id, version_id, opts = {})
927
1392
  data, _status_code, _headers = get_course_version_statements_with_http_info(course_id, version_id, opts)
928
1393
  data
929
1394
  end
930
1395
 
931
- # Get xAPI statements for version &#x60;versionId&#x60; of &#x60;courseId&#x60;
1396
+ # Get xAPI statements for a Course Version
1397
+ # Returns xAPI statements for the course version.
932
1398
  # @param course_id
933
- # @param version_id The course version
1399
+ # @param version_id
934
1400
  # @param [Hash] opts the optional parameters
935
1401
  # @option opts [String] :learner_id Only entries for the specified learner id will be included.
936
- # @option opts [DateTime] :since 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.
937
- # @option opts [DateTime] :_until 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.
938
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
1402
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1403
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1404
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
939
1405
  # @return [Array<(XapiStatementResult, Fixnum, Hash)>] XapiStatementResult data, response status code and response headers
940
1406
  def get_course_version_statements_with_http_info(course_id, version_id, opts = {})
941
1407
  if @api_client.config.debugging
942
1408
  @api_client.config.logger.debug 'Calling API: CourseApi.get_course_version_statements ...'
943
1409
  end
944
1410
  # verify the required parameter 'course_id' is set
945
- if @api_client.config.client_side_validation && course_id.nil?
1411
+ if course_id.nil?
946
1412
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_statements"
947
1413
  end
948
1414
  # verify the required parameter 'version_id' is set
949
- if @api_client.config.client_side_validation && version_id.nil?
1415
+ if version_id.nil?
950
1416
  fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_course_version_statements"
951
1417
  end
952
1418
  # resource path
@@ -984,11 +1450,12 @@ module RusticiSoftwareCloudV2
984
1450
  end
985
1451
  return data, status_code, headers
986
1452
  end
987
- # Get all versions of `courseId`
1453
+ # Get a list of a Course's Versions
1454
+ # Returns information about all versions of the course. This can be useful to see information such as registration counts and modification times across the versions of a course.
988
1455
  # @param course_id
989
1456
  # @param [Hash] opts the optional parameters
990
- # @option opts [DateTime] :since 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.
991
- # @option opts [DateTime] :_until 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.
1457
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1458
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
992
1459
  # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
993
1460
  # @option opts [BOOLEAN] :include_course_metadata Include course metadata in the results. If the course has no metadata, adding this parameter has no effect. (default to false)
994
1461
  # @return [CourseListNonPagedSchema]
@@ -997,11 +1464,12 @@ module RusticiSoftwareCloudV2
997
1464
  data
998
1465
  end
999
1466
 
1000
- # Get all versions of &#x60;courseId&#x60;
1467
+ # Get a list of a Course&#39;s Versions
1468
+ # Returns information about all versions of the course. This can be useful to see information such as registration counts and modification times across the versions of a course.
1001
1469
  # @param course_id
1002
1470
  # @param [Hash] opts the optional parameters
1003
- # @option opts [DateTime] :since 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.
1004
- # @option opts [DateTime] :_until 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.
1471
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1472
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1005
1473
  # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
1006
1474
  # @option opts [BOOLEAN] :include_course_metadata Include course metadata in the results. If the course has no metadata, adding this parameter has no effect.
1007
1475
  # @return [Array<(CourseListNonPagedSchema, Fixnum, Hash)>] CourseListNonPagedSchema data, response status code and response headers
@@ -1010,7 +1478,7 @@ module RusticiSoftwareCloudV2
1010
1478
  @api_client.config.logger.debug 'Calling API: CourseApi.get_course_versions ...'
1011
1479
  end
1012
1480
  # verify the required parameter 'course_id' is set
1013
- if @api_client.config.client_side_validation && course_id.nil?
1481
+ if course_id.nil?
1014
1482
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_versions"
1015
1483
  end
1016
1484
  # resource path
@@ -1048,59 +1516,58 @@ module RusticiSoftwareCloudV2
1048
1516
  end
1049
1517
  return data, status_code, headers
1050
1518
  end
1051
- # Get all courses for `appId`
1519
+ # Get a list of Courses
1520
+ # Returns a list of courses. Can be filtered using the request parameters to provide a subset of results. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.
1052
1521
  # @param [Hash] opts the optional parameters
1053
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
1054
- # @option opts [DateTime] :since 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.
1055
- # @option opts [DateTime] :_until 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.
1522
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1523
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1524
+ # @option opts [String] :datetime_filter Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against (default to updated)
1525
+ # @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
1056
1526
  # @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
1057
- # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. Defaults to course_id.
1058
- # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. Defaults to creation_date_desc.
1059
- # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
1527
+ # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to course_id)
1528
+ # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to created_desc)
1529
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
1060
1530
  # @option opts [BOOLEAN] :include_course_metadata Include course metadata in the results. If the course has no metadata, adding this parameter has no effect. (default to false)
1061
- # @option opts [Array<String>] :tags
1531
+ # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
1062
1532
  # @return [CourseListSchema]
1063
1533
  def get_courses(opts = {})
1064
1534
  data, _status_code, _headers = get_courses_with_http_info(opts)
1065
1535
  data
1066
1536
  end
1067
1537
 
1068
- # Get all courses for &#x60;appId&#x60;
1538
+ # Get a list of Courses
1539
+ # Returns a list of courses. Can be filtered using the request parameters to provide a subset of results. &gt;**Note:** &gt;This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a &#x60;more&#x60; token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.
1069
1540
  # @param [Hash] opts the optional parameters
1070
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
1071
- # @option opts [DateTime] :since 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.
1072
- # @option opts [DateTime] :_until 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.
1541
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1542
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1543
+ # @option opts [String] :datetime_filter Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against
1544
+ # @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
1073
1545
  # @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
1074
- # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. Defaults to course_id.
1075
- # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. Defaults to creation_date_desc.
1076
- # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
1546
+ # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
1547
+ # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
1548
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
1077
1549
  # @option opts [BOOLEAN] :include_course_metadata Include course metadata in the results. If the course has no metadata, adding this parameter has no effect.
1078
- # @option opts [Array<String>] :tags
1550
+ # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
1079
1551
  # @return [Array<(CourseListSchema, Fixnum, Hash)>] CourseListSchema data, response status code and response headers
1080
1552
  def get_courses_with_http_info(opts = {})
1081
1553
  if @api_client.config.debugging
1082
1554
  @api_client.config.logger.debug 'Calling API: CourseApi.get_courses ...'
1083
1555
  end
1084
- if @api_client.config.client_side_validation && opts[:'filter_by'] && !['title', 'course_id', 'tags'].include?(opts[:'filter_by'])
1085
- fail ArgumentError, 'invalid value for "filter_by", must be one of title, course_id, tags'
1086
- end
1087
- if @api_client.config.client_side_validation && opts[:'order_by'] && !['title_asc', 'title_desc', 'creation_date_asc', 'creation_date_desc'].include?(opts[:'order_by'])
1088
- fail ArgumentError, 'invalid value for "order_by", must be one of title_asc, title_desc, creation_date_asc, creation_date_desc'
1089
- end
1090
1556
  # resource path
1091
1557
  local_var_path = '/courses'
1092
1558
 
1093
1559
  # query parameters
1094
1560
  query_params = {}
1095
- query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
1096
1561
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1097
1562
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
1563
+ query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
1564
+ query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
1098
1565
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
1099
1566
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
1100
1567
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
1101
- query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].nil?
1568
+ query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
1102
1569
  query_params[:'includeCourseMetadata'] = opts[:'include_course_metadata'] if !opts[:'include_course_metadata'].nil?
1103
- query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :ssv) if !opts[:'tags'].nil?
1570
+ query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].nil?
1104
1571
 
1105
1572
  # header parameters
1106
1573
  header_params = {}
@@ -1127,7 +1594,8 @@ module RusticiSoftwareCloudV2
1127
1594
  end
1128
1595
  return data, status_code, headers
1129
1596
  end
1130
- # Check the status of an import job.
1597
+ # Get import job status for a Course
1598
+ # Check the status of a course import. This can be called incrementally to check the progress of a call to any of the import options. >**Note:** >The import job ID used for calls to GetImportJobStatus are only valid for one week after the course import finishes.
1131
1599
  # @param import_job_id Id received when the import job was submitted to the importJobs resource.
1132
1600
  # @param [Hash] opts the optional parameters
1133
1601
  # @return [ImportJobResultSchema]
@@ -1136,7 +1604,8 @@ module RusticiSoftwareCloudV2
1136
1604
  data
1137
1605
  end
1138
1606
 
1139
- # Check the status of an import job.
1607
+ # Get import job status for a Course
1608
+ # Check the status of a course import. This can be called incrementally to check the progress of a call to any of the import options. &gt;**Note:** &gt;The import job ID used for calls to GetImportJobStatus are only valid for one week after the course import finishes.
1140
1609
  # @param import_job_id Id received when the import job was submitted to the importJobs resource.
1141
1610
  # @param [Hash] opts the optional parameters
1142
1611
  # @return [Array<(ImportJobResultSchema, Fixnum, Hash)>] ImportJobResultSchema data, response status code and response headers
@@ -1145,7 +1614,7 @@ module RusticiSoftwareCloudV2
1145
1614
  @api_client.config.logger.debug 'Calling API: CourseApi.get_import_job_status ...'
1146
1615
  end
1147
1616
  # verify the required parameter 'import_job_id' is set
1148
- if @api_client.config.client_side_validation && import_job_id.nil?
1617
+ if import_job_id.nil?
1149
1618
  fail ArgumentError, "Missing the required parameter 'import_job_id' when calling CourseApi.get_import_job_status"
1150
1619
  end
1151
1620
  # resource path
@@ -1179,7 +1648,140 @@ module RusticiSoftwareCloudV2
1179
1648
  end
1180
1649
  return data, status_code, headers
1181
1650
  end
1182
- # Set the tags for this course
1651
+ # Import an asset file for a Course
1652
+ # Creates or updates an asset file fetched from the provided url into the course. The file will be downloaded from the url and stored in SCORM Cloud. This is a useful way to modify the course structure without needing to reimport the whole course after you've made changes. >**Info:** >If the course structure is being heavily modified, consider creating a new version instead. This can be done by calling one of the course import jobs while passing true for `mayCreateNewVersion`.
1653
+ # @param course_id
1654
+ # @param asset_schema
1655
+ # @param [Hash] opts the optional parameters
1656
+ # @option opts [String] :update_asset_policy Describes how SCORM Cloud should handle importing asset files with respect to overwriting files. Valid values are &#39;reject&#39;, &#39;strict&#39;, and &#39;lax&#39;. A &#39;reject&#39; policy request will fail if the asset file already exists on the system (&#39;overwriting&#39; not allowed). A &#39;strict&#39; policy request will fail if the asset file does not already exist (&#39;overwriting&#39; is required). A &#39;lax&#39; policy request will not consider whether the file already exists (i.e., it will attempt to import in all cases). (default to lax)
1657
+ # @return [AssetFileSchema]
1658
+ def import_course_asset_file(course_id, asset_schema, opts = {})
1659
+ data, _status_code, _headers = import_course_asset_file_with_http_info(course_id, asset_schema, opts)
1660
+ data
1661
+ end
1662
+
1663
+ # Import an asset file for a Course
1664
+ # Creates or updates an asset file fetched from the provided url into the course. The file will be downloaded from the url and stored in SCORM Cloud. This is a useful way to modify the course structure without needing to reimport the whole course after you&#39;ve made changes. &gt;**Info:** &gt;If the course structure is being heavily modified, consider creating a new version instead. This can be done by calling one of the course import jobs while passing true for &#x60;mayCreateNewVersion&#x60;.
1665
+ # @param course_id
1666
+ # @param asset_schema
1667
+ # @param [Hash] opts the optional parameters
1668
+ # @option opts [String] :update_asset_policy Describes how SCORM Cloud should handle importing asset files with respect to overwriting files. Valid values are &#39;reject&#39;, &#39;strict&#39;, and &#39;lax&#39;. A &#39;reject&#39; policy request will fail if the asset file already exists on the system (&#39;overwriting&#39; not allowed). A &#39;strict&#39; policy request will fail if the asset file does not already exist (&#39;overwriting&#39; is required). A &#39;lax&#39; policy request will not consider whether the file already exists (i.e., it will attempt to import in all cases).
1669
+ # @return [Array<(AssetFileSchema, Fixnum, Hash)>] AssetFileSchema data, response status code and response headers
1670
+ def import_course_asset_file_with_http_info(course_id, asset_schema, opts = {})
1671
+ if @api_client.config.debugging
1672
+ @api_client.config.logger.debug 'Calling API: CourseApi.import_course_asset_file ...'
1673
+ end
1674
+ # verify the required parameter 'course_id' is set
1675
+ if course_id.nil?
1676
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.import_course_asset_file"
1677
+ end
1678
+ # verify the required parameter 'asset_schema' is set
1679
+ if asset_schema.nil?
1680
+ fail ArgumentError, "Missing the required parameter 'asset_schema' when calling CourseApi.import_course_asset_file"
1681
+ end
1682
+ # resource path
1683
+ local_var_path = '/courses/{courseId}/asset'.sub('{' + 'courseId' + '}', course_id.to_s)
1684
+
1685
+ # query parameters
1686
+ query_params = {}
1687
+ query_params[:'updateAssetPolicy'] = opts[:'update_asset_policy'] if !opts[:'update_asset_policy'].nil?
1688
+
1689
+ # header parameters
1690
+ header_params = {}
1691
+ # HTTP header 'Accept' (if needed)
1692
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1693
+ # HTTP header 'Content-Type'
1694
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1695
+
1696
+ # form parameters
1697
+ form_params = {}
1698
+
1699
+ # http body (model)
1700
+ post_body = @api_client.object_to_http_body(asset_schema)
1701
+ auth_names = ['APP_NORMAL', 'OAUTH']
1702
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1703
+ :header_params => header_params,
1704
+ :query_params => query_params,
1705
+ :form_params => form_params,
1706
+ :body => post_body,
1707
+ :auth_names => auth_names,
1708
+ :return_type => 'AssetFileSchema')
1709
+ if @api_client.config.debugging
1710
+ @api_client.config.logger.debug "API called: CourseApi#import_course_asset_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1711
+ end
1712
+ return data, status_code, headers
1713
+ end
1714
+ # Import an asset file for a Course Version
1715
+ # Creates or updates an asset file fetched from the provided url into the course version. The file will be downloaded from the url and stored in SCORM Cloud. This is a useful way to modify the course structure without needing to reimport the whole course after you've made changes. >**Info:** >If the course structure is being heavily modified, consider creating a new version instead. This can be done by calling one of the course import jobs while passing true for `mayCreateNewVersion`.
1716
+ # @param course_id
1717
+ # @param version_id
1718
+ # @param asset_schema
1719
+ # @param [Hash] opts the optional parameters
1720
+ # @option opts [String] :update_asset_policy Describes how SCORM Cloud should handle importing asset files with respect to overwriting files. Valid values are &#39;reject&#39;, &#39;strict&#39;, and &#39;lax&#39;. A &#39;reject&#39; policy request will fail if the asset file already exists on the system (&#39;overwriting&#39; not allowed). A &#39;strict&#39; policy request will fail if the asset file does not already exist (&#39;overwriting&#39; is required). A &#39;lax&#39; policy request will not consider whether the file already exists (i.e., it will attempt to import in all cases). (default to lax)
1721
+ # @return [AssetFileSchema]
1722
+ def import_course_version_asset_file(course_id, version_id, asset_schema, opts = {})
1723
+ data, _status_code, _headers = import_course_version_asset_file_with_http_info(course_id, version_id, asset_schema, opts)
1724
+ data
1725
+ end
1726
+
1727
+ # Import an asset file for a Course Version
1728
+ # Creates or updates an asset file fetched from the provided url into the course version. The file will be downloaded from the url and stored in SCORM Cloud. This is a useful way to modify the course structure without needing to reimport the whole course after you&#39;ve made changes. &gt;**Info:** &gt;If the course structure is being heavily modified, consider creating a new version instead. This can be done by calling one of the course import jobs while passing true for &#x60;mayCreateNewVersion&#x60;.
1729
+ # @param course_id
1730
+ # @param version_id
1731
+ # @param asset_schema
1732
+ # @param [Hash] opts the optional parameters
1733
+ # @option opts [String] :update_asset_policy Describes how SCORM Cloud should handle importing asset files with respect to overwriting files. Valid values are &#39;reject&#39;, &#39;strict&#39;, and &#39;lax&#39;. A &#39;reject&#39; policy request will fail if the asset file already exists on the system (&#39;overwriting&#39; not allowed). A &#39;strict&#39; policy request will fail if the asset file does not already exist (&#39;overwriting&#39; is required). A &#39;lax&#39; policy request will not consider whether the file already exists (i.e., it will attempt to import in all cases).
1734
+ # @return [Array<(AssetFileSchema, Fixnum, Hash)>] AssetFileSchema data, response status code and response headers
1735
+ def import_course_version_asset_file_with_http_info(course_id, version_id, asset_schema, opts = {})
1736
+ if @api_client.config.debugging
1737
+ @api_client.config.logger.debug 'Calling API: CourseApi.import_course_version_asset_file ...'
1738
+ end
1739
+ # verify the required parameter 'course_id' is set
1740
+ if course_id.nil?
1741
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.import_course_version_asset_file"
1742
+ end
1743
+ # verify the required parameter 'version_id' is set
1744
+ if version_id.nil?
1745
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.import_course_version_asset_file"
1746
+ end
1747
+ # verify the required parameter 'asset_schema' is set
1748
+ if asset_schema.nil?
1749
+ fail ArgumentError, "Missing the required parameter 'asset_schema' when calling CourseApi.import_course_version_asset_file"
1750
+ end
1751
+ # resource path
1752
+ local_var_path = '/courses/{courseId}/versions/{versionId}/asset'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
1753
+
1754
+ # query parameters
1755
+ query_params = {}
1756
+ query_params[:'updateAssetPolicy'] = opts[:'update_asset_policy'] if !opts[:'update_asset_policy'].nil?
1757
+
1758
+ # header parameters
1759
+ header_params = {}
1760
+ # HTTP header 'Accept' (if needed)
1761
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1762
+ # HTTP header 'Content-Type'
1763
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1764
+
1765
+ # form parameters
1766
+ form_params = {}
1767
+
1768
+ # http body (model)
1769
+ post_body = @api_client.object_to_http_body(asset_schema)
1770
+ auth_names = ['APP_NORMAL', 'OAUTH']
1771
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1772
+ :header_params => header_params,
1773
+ :query_params => query_params,
1774
+ :form_params => form_params,
1775
+ :body => post_body,
1776
+ :auth_names => auth_names,
1777
+ :return_type => 'AssetFileSchema')
1778
+ if @api_client.config.debugging
1779
+ @api_client.config.logger.debug "API called: CourseApi#import_course_version_asset_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1780
+ end
1781
+ return data, status_code, headers
1782
+ end
1783
+ # Add tags to a Course
1784
+ # Applies the provided tags to the course. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetCourses).
1183
1785
  # @param course_id
1184
1786
  # @param tags
1185
1787
  # @param [Hash] opts the optional parameters
@@ -1189,7 +1791,8 @@ module RusticiSoftwareCloudV2
1189
1791
  nil
1190
1792
  end
1191
1793
 
1192
- # Set the tags for this course
1794
+ # Add tags to a Course
1795
+ # Applies the provided tags to the course. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetCourses).
1193
1796
  # @param course_id
1194
1797
  # @param tags
1195
1798
  # @param [Hash] opts the optional parameters
@@ -1199,11 +1802,11 @@ module RusticiSoftwareCloudV2
1199
1802
  @api_client.config.logger.debug 'Calling API: CourseApi.put_course_tags ...'
1200
1803
  end
1201
1804
  # verify the required parameter 'course_id' is set
1202
- if @api_client.config.client_side_validation && course_id.nil?
1805
+ if course_id.nil?
1203
1806
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.put_course_tags"
1204
1807
  end
1205
1808
  # verify the required parameter 'tags' is set
1206
- if @api_client.config.client_side_validation && tags.nil?
1809
+ if tags.nil?
1207
1810
  fail ArgumentError, "Missing the required parameter 'tags' when calling CourseApi.put_course_tags"
1208
1811
  end
1209
1812
  # resource path
@@ -1236,8 +1839,9 @@ module RusticiSoftwareCloudV2
1236
1839
  end
1237
1840
  return data, status_code, headers
1238
1841
  end
1239
- # Sets all of the provided tags on all of the provided courses
1240
- # @param batch
1842
+ # Add a group of tags to a group of Courses
1843
+ # Applies all of the provided tags on all of the provided courses. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetCourses).
1844
+ # @param batch Array of ids, and array of tags for bulk tag operations
1241
1845
  # @param [Hash] opts the optional parameters
1242
1846
  # @return [nil]
1243
1847
  def put_course_tags_batch(batch, opts = {})
@@ -1245,8 +1849,9 @@ module RusticiSoftwareCloudV2
1245
1849
  nil
1246
1850
  end
1247
1851
 
1248
- # Sets all of the provided tags on all of the provided courses
1249
- # @param batch
1852
+ # Add a group of tags to a group of Courses
1853
+ # Applies all of the provided tags on all of the provided courses. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetCourses).
1854
+ # @param batch Array of ids, and array of tags for bulk tag operations
1250
1855
  # @param [Hash] opts the optional parameters
1251
1856
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1252
1857
  def put_course_tags_batch_with_http_info(batch, opts = {})
@@ -1254,7 +1859,7 @@ module RusticiSoftwareCloudV2
1254
1859
  @api_client.config.logger.debug 'Calling API: CourseApi.put_course_tags_batch ...'
1255
1860
  end
1256
1861
  # verify the required parameter 'batch' is set
1257
- if @api_client.config.client_side_validation && batch.nil?
1862
+ if batch.nil?
1258
1863
  fail ArgumentError, "Missing the required parameter 'batch' when calling CourseApi.put_course_tags_batch"
1259
1864
  end
1260
1865
  # resource path
@@ -1287,7 +1892,8 @@ module RusticiSoftwareCloudV2
1287
1892
  end
1288
1893
  return data, status_code, headers
1289
1894
  end
1290
- # Set configuration settings for this course.
1895
+ # Update configuration settings for a Course
1896
+ # Updates configuration settings at the course level. This will explicitly set a value at the course level and override any settings from a higher level. These settings will affect all items within the course which do not have their own explicit configuration set. This can effectively be used to set course level defaults.
1291
1897
  # @param course_id
1292
1898
  # @param configuration_settings
1293
1899
  # @param [Hash] opts the optional parameters
@@ -1297,7 +1903,8 @@ module RusticiSoftwareCloudV2
1297
1903
  nil
1298
1904
  end
1299
1905
 
1300
- # Set configuration settings for this course.
1906
+ # Update configuration settings for a Course
1907
+ # Updates configuration settings at the course level. This will explicitly set a value at the course level and override any settings from a higher level. These settings will affect all items within the course which do not have their own explicit configuration set. This can effectively be used to set course level defaults.
1301
1908
  # @param course_id
1302
1909
  # @param configuration_settings
1303
1910
  # @param [Hash] opts the optional parameters
@@ -1307,11 +1914,11 @@ module RusticiSoftwareCloudV2
1307
1914
  @api_client.config.logger.debug 'Calling API: CourseApi.set_course_configuration ...'
1308
1915
  end
1309
1916
  # verify the required parameter 'course_id' is set
1310
- if @api_client.config.client_side_validation && course_id.nil?
1917
+ if course_id.nil?
1311
1918
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.set_course_configuration"
1312
1919
  end
1313
1920
  # verify the required parameter 'configuration_settings' is set
1314
- if @api_client.config.client_side_validation && configuration_settings.nil?
1921
+ if configuration_settings.nil?
1315
1922
  fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling CourseApi.set_course_configuration"
1316
1923
  end
1317
1924
  # resource path
@@ -1344,31 +1951,33 @@ module RusticiSoftwareCloudV2
1344
1951
  end
1345
1952
  return data, status_code, headers
1346
1953
  end
1347
- # Sets the course title for `courseId`
1954
+ # Update title for a Course
1955
+ # Updates the title of the course.
1348
1956
  # @param course_id
1349
1957
  # @param title
1350
1958
  # @param [Hash] opts the optional parameters
1351
- # @return [String]
1959
+ # @return [nil]
1352
1960
  def set_course_title(course_id, title, opts = {})
1353
- data, _status_code, _headers = set_course_title_with_http_info(course_id, title, opts)
1354
- data
1961
+ set_course_title_with_http_info(course_id, title, opts)
1962
+ nil
1355
1963
  end
1356
1964
 
1357
- # Sets the course title for &#x60;courseId&#x60;
1965
+ # Update title for a Course
1966
+ # Updates the title of the course.
1358
1967
  # @param course_id
1359
1968
  # @param title
1360
1969
  # @param [Hash] opts the optional parameters
1361
- # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
1970
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1362
1971
  def set_course_title_with_http_info(course_id, title, opts = {})
1363
1972
  if @api_client.config.debugging
1364
1973
  @api_client.config.logger.debug 'Calling API: CourseApi.set_course_title ...'
1365
1974
  end
1366
1975
  # verify the required parameter 'course_id' is set
1367
- if @api_client.config.client_side_validation && course_id.nil?
1976
+ if course_id.nil?
1368
1977
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.set_course_title"
1369
1978
  end
1370
1979
  # verify the required parameter 'title' is set
1371
- if @api_client.config.client_side_validation && title.nil?
1980
+ if title.nil?
1372
1981
  fail ArgumentError, "Missing the required parameter 'title' when calling CourseApi.set_course_title"
1373
1982
  end
1374
1983
  # resource path
@@ -1395,16 +2004,16 @@ module RusticiSoftwareCloudV2
1395
2004
  :query_params => query_params,
1396
2005
  :form_params => form_params,
1397
2006
  :body => post_body,
1398
- :auth_names => auth_names,
1399
- :return_type => 'String')
2007
+ :auth_names => auth_names)
1400
2008
  if @api_client.config.debugging
1401
2009
  @api_client.config.logger.debug "API called: CourseApi#set_course_title\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1402
2010
  end
1403
2011
  return data, status_code, headers
1404
2012
  end
1405
- # Set configuration settings for this course and version.
2013
+ # Update configuration settings for a Course Version
2014
+ # Updates configuration settings at the course level. This will explicitly set a value at the course level and override any settings from a higher level. These settings will affect all items within the course which do not have their own explicit configuration set. This can effectively be used to set course level defaults.
1406
2015
  # @param course_id
1407
- # @param version_id The course version
2016
+ # @param version_id
1408
2017
  # @param configuration_settings
1409
2018
  # @param [Hash] opts the optional parameters
1410
2019
  # @return [nil]
@@ -1413,9 +2022,10 @@ module RusticiSoftwareCloudV2
1413
2022
  nil
1414
2023
  end
1415
2024
 
1416
- # Set configuration settings for this course and version.
2025
+ # Update configuration settings for a Course Version
2026
+ # Updates configuration settings at the course level. This will explicitly set a value at the course level and override any settings from a higher level. These settings will affect all items within the course which do not have their own explicit configuration set. This can effectively be used to set course level defaults.
1417
2027
  # @param course_id
1418
- # @param version_id The course version
2028
+ # @param version_id
1419
2029
  # @param configuration_settings
1420
2030
  # @param [Hash] opts the optional parameters
1421
2031
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -1424,15 +2034,15 @@ module RusticiSoftwareCloudV2
1424
2034
  @api_client.config.logger.debug 'Calling API: CourseApi.set_course_version_configuration ...'
1425
2035
  end
1426
2036
  # verify the required parameter 'course_id' is set
1427
- if @api_client.config.client_side_validation && course_id.nil?
2037
+ if course_id.nil?
1428
2038
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.set_course_version_configuration"
1429
2039
  end
1430
2040
  # verify the required parameter 'version_id' is set
1431
- if @api_client.config.client_side_validation && version_id.nil?
2041
+ if version_id.nil?
1432
2042
  fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.set_course_version_configuration"
1433
2043
  end
1434
2044
  # verify the required parameter 'configuration_settings' is set
1435
- if @api_client.config.client_side_validation && configuration_settings.nil?
2045
+ if configuration_settings.nil?
1436
2046
  fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling CourseApi.set_course_version_configuration"
1437
2047
  end
1438
2048
  # resource path
@@ -1465,5 +2075,145 @@ module RusticiSoftwareCloudV2
1465
2075
  end
1466
2076
  return data, status_code, headers
1467
2077
  end
2078
+ # Upload an asset file for a Course
2079
+ # Creates or updates an asset file uploaded from your file system into the course. The file will be sent as part of the request and will be stored in SCORM Cloud alongside the course. This is a useful way to modify the course structure without needing to reimport the whole course after you've made changes. >**Info:** >If the course structure is being heavily modified, consider creating a new version instead. This can be done by calling one of the course import jobs while passing true for `mayCreateNewVersion`.
2080
+ # @param course_id
2081
+ # @param destination Relative path from the course&#39;s base directory where the asset file will be uploaded. &#x60;/Etiquette/Course.html&#x60; will upload the file into the Etiquette folder of the course.
2082
+ # @param [Hash] opts the optional parameters
2083
+ # @option opts [File] :file The asset file to import into the course.
2084
+ # @option opts [String] :update_asset_policy Describes how SCORM Cloud should handle importing asset files with respect to overwriting files. Valid values are &#39;reject&#39;, &#39;strict&#39;, and &#39;lax&#39;. A &#39;reject&#39; policy request will fail if the asset file already exists on the system (&#39;overwriting&#39; not allowed). A &#39;strict&#39; policy request will fail if the asset file does not already exist (&#39;overwriting&#39; is required). A &#39;lax&#39; policy request will not consider whether the file already exists (i.e., it will attempt to import in all cases). (default to lax)
2085
+ # @return [AssetFileSchema]
2086
+ def upload_course_asset_file(course_id, destination, opts = {})
2087
+ data, _status_code, _headers = upload_course_asset_file_with_http_info(course_id, destination, opts)
2088
+ data
2089
+ end
2090
+
2091
+ # Upload an asset file for a Course
2092
+ # Creates or updates an asset file uploaded from your file system into the course. The file will be sent as part of the request and will be stored in SCORM Cloud alongside the course. This is a useful way to modify the course structure without needing to reimport the whole course after you&#39;ve made changes. &gt;**Info:** &gt;If the course structure is being heavily modified, consider creating a new version instead. This can be done by calling one of the course import jobs while passing true for &#x60;mayCreateNewVersion&#x60;.
2093
+ # @param course_id
2094
+ # @param destination Relative path from the course&#39;s base directory where the asset file will be uploaded. &#x60;/Etiquette/Course.html&#x60; will upload the file into the Etiquette folder of the course.
2095
+ # @param [Hash] opts the optional parameters
2096
+ # @option opts [File] :file The asset file to import into the course.
2097
+ # @option opts [String] :update_asset_policy Describes how SCORM Cloud should handle importing asset files with respect to overwriting files. Valid values are &#39;reject&#39;, &#39;strict&#39;, and &#39;lax&#39;. A &#39;reject&#39; policy request will fail if the asset file already exists on the system (&#39;overwriting&#39; not allowed). A &#39;strict&#39; policy request will fail if the asset file does not already exist (&#39;overwriting&#39; is required). A &#39;lax&#39; policy request will not consider whether the file already exists (i.e., it will attempt to import in all cases).
2098
+ # @return [Array<(AssetFileSchema, Fixnum, Hash)>] AssetFileSchema data, response status code and response headers
2099
+ def upload_course_asset_file_with_http_info(course_id, destination, opts = {})
2100
+ if @api_client.config.debugging
2101
+ @api_client.config.logger.debug 'Calling API: CourseApi.upload_course_asset_file ...'
2102
+ end
2103
+ # verify the required parameter 'course_id' is set
2104
+ if course_id.nil?
2105
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.upload_course_asset_file"
2106
+ end
2107
+ # verify the required parameter 'destination' is set
2108
+ if destination.nil?
2109
+ fail ArgumentError, "Missing the required parameter 'destination' when calling CourseApi.upload_course_asset_file"
2110
+ end
2111
+ # resource path
2112
+ local_var_path = '/courses/{courseId}/asset/upload'.sub('{' + 'courseId' + '}', course_id.to_s)
2113
+
2114
+ # query parameters
2115
+ query_params = {}
2116
+ query_params[:'updateAssetPolicy'] = opts[:'update_asset_policy'] if !opts[:'update_asset_policy'].nil?
2117
+
2118
+ # header parameters
2119
+ header_params = {}
2120
+ # HTTP header 'Accept' (if needed)
2121
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2122
+ # HTTP header 'Content-Type'
2123
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
2124
+
2125
+ # form parameters
2126
+ form_params = {}
2127
+ form_params['destination'] = destination
2128
+ form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
2129
+
2130
+ # http body (model)
2131
+ post_body = nil
2132
+ auth_names = ['APP_NORMAL', 'OAUTH']
2133
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2134
+ :header_params => header_params,
2135
+ :query_params => query_params,
2136
+ :form_params => form_params,
2137
+ :body => post_body,
2138
+ :auth_names => auth_names,
2139
+ :return_type => 'AssetFileSchema')
2140
+ if @api_client.config.debugging
2141
+ @api_client.config.logger.debug "API called: CourseApi#upload_course_asset_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2142
+ end
2143
+ return data, status_code, headers
2144
+ end
2145
+ # Upload an asset file for Course Version
2146
+ # Creates or updates an asset file uploaded from your file system into the course version. The file will be sent as part of the request and will be stored in SCORM Cloud alongside the course. This is a useful way to modify the course structure without needing to reimport the whole course after you've made changes. >**Info:** >If the course structure is being heavily modified, consider creating a new version instead. This can be done by calling one of the course import jobs while passing true for `mayCreateNewVersion`.
2147
+ # @param course_id
2148
+ # @param version_id
2149
+ # @param destination Relative path from the course&#39;s base directory where the asset file will be uploaded. &#x60;/Etiquette/Course.html&#x60; will upload the file into the Etiquette folder of the course.
2150
+ # @param [Hash] opts the optional parameters
2151
+ # @option opts [File] :file The asset file to import into the course.
2152
+ # @option opts [String] :update_asset_policy Describes how SCORM Cloud should handle importing asset files with respect to overwriting files. Valid values are &#39;reject&#39;, &#39;strict&#39;, and &#39;lax&#39;. A &#39;reject&#39; policy request will fail if the asset file already exists on the system (&#39;overwriting&#39; not allowed). A &#39;strict&#39; policy request will fail if the asset file does not already exist (&#39;overwriting&#39; is required). A &#39;lax&#39; policy request will not consider whether the file already exists (i.e., it will attempt to import in all cases). (default to lax)
2153
+ # @return [AssetFileSchema]
2154
+ def upload_course_version_asset_file(course_id, version_id, destination, opts = {})
2155
+ data, _status_code, _headers = upload_course_version_asset_file_with_http_info(course_id, version_id, destination, opts)
2156
+ data
2157
+ end
2158
+
2159
+ # Upload an asset file for Course Version
2160
+ # Creates or updates an asset file uploaded from your file system into the course version. The file will be sent as part of the request and will be stored in SCORM Cloud alongside the course. This is a useful way to modify the course structure without needing to reimport the whole course after you&#39;ve made changes. &gt;**Info:** &gt;If the course structure is being heavily modified, consider creating a new version instead. This can be done by calling one of the course import jobs while passing true for &#x60;mayCreateNewVersion&#x60;.
2161
+ # @param course_id
2162
+ # @param version_id
2163
+ # @param destination Relative path from the course&#39;s base directory where the asset file will be uploaded. &#x60;/Etiquette/Course.html&#x60; will upload the file into the Etiquette folder of the course.
2164
+ # @param [Hash] opts the optional parameters
2165
+ # @option opts [File] :file The asset file to import into the course.
2166
+ # @option opts [String] :update_asset_policy Describes how SCORM Cloud should handle importing asset files with respect to overwriting files. Valid values are &#39;reject&#39;, &#39;strict&#39;, and &#39;lax&#39;. A &#39;reject&#39; policy request will fail if the asset file already exists on the system (&#39;overwriting&#39; not allowed). A &#39;strict&#39; policy request will fail if the asset file does not already exist (&#39;overwriting&#39; is required). A &#39;lax&#39; policy request will not consider whether the file already exists (i.e., it will attempt to import in all cases).
2167
+ # @return [Array<(AssetFileSchema, Fixnum, Hash)>] AssetFileSchema data, response status code and response headers
2168
+ def upload_course_version_asset_file_with_http_info(course_id, version_id, destination, opts = {})
2169
+ if @api_client.config.debugging
2170
+ @api_client.config.logger.debug 'Calling API: CourseApi.upload_course_version_asset_file ...'
2171
+ end
2172
+ # verify the required parameter 'course_id' is set
2173
+ if course_id.nil?
2174
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.upload_course_version_asset_file"
2175
+ end
2176
+ # verify the required parameter 'version_id' is set
2177
+ if version_id.nil?
2178
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.upload_course_version_asset_file"
2179
+ end
2180
+ # verify the required parameter 'destination' is set
2181
+ if destination.nil?
2182
+ fail ArgumentError, "Missing the required parameter 'destination' when calling CourseApi.upload_course_version_asset_file"
2183
+ end
2184
+ # resource path
2185
+ local_var_path = '/courses/{courseId}/versions/{versionId}/asset/upload'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
2186
+
2187
+ # query parameters
2188
+ query_params = {}
2189
+ query_params[:'updateAssetPolicy'] = opts[:'update_asset_policy'] if !opts[:'update_asset_policy'].nil?
2190
+
2191
+ # header parameters
2192
+ header_params = {}
2193
+ # HTTP header 'Accept' (if needed)
2194
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2195
+ # HTTP header 'Content-Type'
2196
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
2197
+
2198
+ # form parameters
2199
+ form_params = {}
2200
+ form_params['destination'] = destination
2201
+ form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
2202
+
2203
+ # http body (model)
2204
+ post_body = nil
2205
+ auth_names = ['APP_NORMAL', 'OAUTH']
2206
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2207
+ :header_params => header_params,
2208
+ :query_params => query_params,
2209
+ :form_params => form_params,
2210
+ :body => post_body,
2211
+ :auth_names => auth_names,
2212
+ :return_type => 'AssetFileSchema')
2213
+ if @api_client.config.debugging
2214
+ @api_client.config.logger.debug "API called: CourseApi#upload_course_version_asset_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2215
+ end
2216
+ return data, status_code, headers
2217
+ end
1468
2218
  end
1469
2219
  end