rustici_software_cloud_v2 1.0.0beta → 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (268) hide show
  1. checksums.yaml +7 -0
  2. data/README.md +194 -88
  3. data/lib/rustici_software_cloud_v2/api/about_api.rb +71 -0
  4. data/lib/rustici_software_cloud_v2/api/application_management_api.rb +161 -97
  5. data/lib/rustici_software_cloud_v2/api/authentication_api.rb +13 -13
  6. data/lib/rustici_software_cloud_v2/api/course_api.rb +246 -260
  7. data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +1994 -0
  8. data/lib/rustici_software_cloud_v2/api/invitations_api.rb +964 -0
  9. data/lib/rustici_software_cloud_v2/api/learner_api.rb +296 -0
  10. data/lib/rustici_software_cloud_v2/api/ping_api.rb +10 -8
  11. data/lib/rustici_software_cloud_v2/api/registration_api.rb +379 -324
  12. data/lib/rustici_software_cloud_v2/api/reporting_api.rb +191 -0
  13. data/lib/rustici_software_cloud_v2/api/xapi_api.rb +555 -0
  14. data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +448 -0
  15. data/lib/rustici_software_cloud_v2/api_client.rb +2 -3
  16. data/lib/rustici_software_cloud_v2/api_error.rb +1 -2
  17. data/lib/rustici_software_cloud_v2/configuration.rb +9 -19
  18. data/lib/rustici_software_cloud_v2/models/about_schema.rb +196 -0
  19. data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +17 -14
  20. data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +12 -8
  21. data/lib/rustici_software_cloud_v2/models/application_schema.rb +12 -8
  22. data/lib/rustici_software_cloud_v2/models/application_token.rb +12 -8
  23. data/lib/rustici_software_cloud_v2/models/{course_tags_batch_schema.rb → batch_tags_schema.rb} +29 -23
  24. data/lib/rustici_software_cloud_v2/models/comment_schema.rb +12 -8
  25. data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +12 -8
  26. data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +14 -11
  27. data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +12 -8
  28. data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +12 -8
  29. data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +11 -8
  30. data/lib/rustici_software_cloud_v2/models/course_schema.rb +14 -11
  31. data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +225 -0
  32. data/lib/rustici_software_cloud_v2/models/{link_schema.rb → create_dispatch_list_schema.rb} +22 -21
  33. data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +308 -0
  34. data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +254 -0
  35. data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +252 -0
  36. data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +15 -11
  37. data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +12 -8
  38. data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +12 -8
  39. data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +12 -8
  40. data/lib/rustici_software_cloud_v2/models/credential_schema.rb +12 -8
  41. data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +197 -0
  42. data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +200 -0
  43. data/lib/rustici_software_cloud_v2/models/{setting_metadata_valid_values.rb → destination_schema.rb} +42 -31
  44. data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +196 -0
  45. data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +198 -0
  46. data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +196 -0
  47. data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +290 -0
  48. data/lib/rustici_software_cloud_v2/models/{tag_post_schema.rb → enabled_schema.rb} +24 -11
  49. data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +12 -9
  50. data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +14 -11
  51. data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +12 -8
  52. data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +13 -9
  53. data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +215 -0
  54. data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +253 -0
  55. data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +199 -0
  56. data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +227 -0
  57. data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +12 -8
  58. data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +12 -8
  59. data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +19 -16
  60. data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +17 -8
  61. data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +13 -9
  62. data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +12 -8
  63. data/lib/rustici_software_cloud_v2/models/learner_schema.rb +13 -9
  64. data/lib/rustici_software_cloud_v2/models/message_schema.rb +13 -9
  65. data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +12 -8
  66. data/lib/rustici_software_cloud_v2/models/objective_schema.rb +23 -20
  67. data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +12 -8
  68. data/lib/rustici_software_cloud_v2/models/ping_schema.rb +28 -20
  69. data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +33 -20
  70. data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +199 -0
  71. data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +266 -0
  72. data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +199 -0
  73. data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +289 -0
  74. data/lib/rustici_software_cloud_v2/models/registration_completion.rb +5 -14
  75. data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +13 -9
  76. data/lib/rustici_software_cloud_v2/models/registration_schema.rb +24 -9
  77. data/lib/rustici_software_cloud_v2/models/registration_success.rb +5 -14
  78. data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +259 -0
  79. data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +214 -0
  80. data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +196 -0
  81. data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +187 -0
  82. data/lib/rustici_software_cloud_v2/models/response_error.rb +13 -9
  83. data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +14 -11
  84. data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +19 -16
  85. data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +15 -12
  86. data/lib/rustici_software_cloud_v2/models/score_schema.rb +12 -8
  87. data/lib/rustici_software_cloud_v2/models/setting_item.rb +14 -11
  88. data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +13 -9
  89. data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +15 -12
  90. data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +12 -8
  91. data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +12 -8
  92. data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +12 -8
  93. data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +12 -8
  94. data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +12 -8
  95. data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +13 -9
  96. data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +12 -8
  97. data/lib/rustici_software_cloud_v2/models/title_schema.rb +12 -8
  98. data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +14 -10
  99. data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +258 -0
  100. data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +199 -0
  101. data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +236 -0
  102. data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +214 -0
  103. data/lib/rustici_software_cloud_v2/models/xapi_account.rb +13 -10
  104. data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +13 -10
  105. data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +14 -11
  106. data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +14 -12
  107. data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +18 -15
  108. data/lib/rustici_software_cloud_v2/models/xapi_context.rb +12 -9
  109. data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +11 -8
  110. data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +220 -0
  111. data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +220 -0
  112. data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +252 -0
  113. data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +266 -0
  114. data/lib/rustici_software_cloud_v2/models/{registration_tags_batch_schema.rb → xapi_credentials_list_schema.rb} +30 -31
  115. data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +205 -0
  116. data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +13 -10
  117. data/lib/rustici_software_cloud_v2/models/xapi_result.rb +12 -9
  118. data/lib/rustici_software_cloud_v2/models/xapi_score.rb +11 -8
  119. data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +11 -8
  120. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +194 -0
  121. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +196 -0
  122. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +241 -0
  123. data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +14 -11
  124. data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +12 -9
  125. data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +13 -10
  126. data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +187 -0
  127. data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +196 -0
  128. data/lib/rustici_software_cloud_v2/version.rb +2 -3
  129. data/lib/rustici_software_cloud_v2.rb +50 -6
  130. data/rustici_software_cloud_v2.gemspec +10 -11
  131. data/spec/api_client_spec.rb +1 -13
  132. data/spec/configuration_spec.rb +9 -10
  133. data/spec/spec_helper.rb +1 -13
  134. metadata +107 -271
  135. data/docs/ActivityResultSchema.md +0 -20
  136. data/docs/ApplicationListSchema.md +0 -8
  137. data/docs/ApplicationManagementApi.md +0 -570
  138. data/docs/ApplicationSchema.md +0 -9
  139. data/docs/ApplicationToken.md +0 -10
  140. data/docs/AuthenticationApi.md +0 -64
  141. data/docs/CommentSchema.md +0 -10
  142. data/docs/CompletionAmountSchema.md +0 -8
  143. data/docs/CourseActivitySchema.md +0 -15
  144. data/docs/CourseApi.md +0 -1459
  145. data/docs/CourseListNonPagedSchema.md +0 -8
  146. data/docs/CourseListSchema.md +0 -9
  147. data/docs/CourseReferenceSchema.md +0 -10
  148. data/docs/CourseSchema.md +0 -20
  149. data/docs/CourseTagsBatchSchema.md +0 -9
  150. data/docs/CreateRegistrationSchema.md +0 -17
  151. data/docs/CredentialCreatedSchema.md +0 -12
  152. data/docs/CredentialListSchema.md +0 -8
  153. data/docs/CredentialRequestSchema.md +0 -9
  154. data/docs/CredentialSchema.md +0 -12
  155. data/docs/ImportFetchRequestSchema.md +0 -8
  156. data/docs/ImportJobResultSchema.md +0 -11
  157. data/docs/ImportResultSchema.md +0 -11
  158. data/docs/IntegerResultSchema.md +0 -8
  159. data/docs/ItemValuePairSchema.md +0 -9
  160. data/docs/LaunchHistoryListSchema.md +0 -8
  161. data/docs/LaunchHistorySchema.md +0 -17
  162. data/docs/LaunchLinkRequestSchema.md +0 -17
  163. data/docs/LaunchLinkSchema.md +0 -8
  164. data/docs/LearnerPreferenceSchema.md +0 -11
  165. data/docs/LearnerSchema.md +0 -11
  166. data/docs/LinkSchema.md +0 -8
  167. data/docs/MessageSchema.md +0 -8
  168. data/docs/MetadataSchema.md +0 -14
  169. data/docs/ObjectiveSchema.md +0 -20
  170. data/docs/PermissionsSchema.md +0 -9
  171. data/docs/PingApi.md +0 -57
  172. data/docs/PingSchema.md +0 -8
  173. data/docs/PostBackSchema.md +0 -12
  174. data/docs/RegistrationApi.md +0 -1490
  175. data/docs/RegistrationCompletion.md +0 -7
  176. data/docs/RegistrationListSchema.md +0 -9
  177. data/docs/RegistrationSchema.md +0 -27
  178. data/docs/RegistrationSuccess.md +0 -7
  179. data/docs/RegistrationTagsBatchSchema.md +0 -9
  180. data/docs/ResponseError.md +0 -8
  181. data/docs/RuntimeInteractionSchema.md +0 -18
  182. data/docs/RuntimeObjectiveSchema.md +0 -16
  183. data/docs/RuntimeSchema.md +0 -27
  184. data/docs/ScoreSchema.md +0 -8
  185. data/docs/SettingItem.md +0 -12
  186. data/docs/SettingListSchema.md +0 -8
  187. data/docs/SettingMetadata.md +0 -15
  188. data/docs/SettingMetadataValidValues.md +0 -9
  189. data/docs/SettingValidValue.md +0 -9
  190. data/docs/SettingsIndividualSchema.md +0 -10
  191. data/docs/SettingsPostSchema.md +0 -8
  192. data/docs/SharedDataEntrySchema.md +0 -9
  193. data/docs/StaticPropertiesSchema.md +0 -13
  194. data/docs/StringResultSchema.md +0 -8
  195. data/docs/TagListSchema.md +0 -8
  196. data/docs/TagPostSchema.md +0 -7
  197. data/docs/TitleSchema.md +0 -8
  198. data/docs/TokenRequestSchema.md +0 -9
  199. data/docs/XapiAccount.md +0 -9
  200. data/docs/XapiActivity.md +0 -10
  201. data/docs/XapiActivityDefinition.md +0 -19
  202. data/docs/XapiAgentGroup.md +0 -14
  203. data/docs/XapiAttachment.md +0 -14
  204. data/docs/XapiContext.md +0 -16
  205. data/docs/XapiContextActivity.md +0 -11
  206. data/docs/XapiInteractionComponent.md +0 -9
  207. data/docs/XapiResult.md +0 -13
  208. data/docs/XapiScore.md +0 -11
  209. data/docs/XapiStatement.md +0 -20
  210. data/docs/XapiStatementReference.md +0 -9
  211. data/docs/XapiStatementResult.md +0 -9
  212. data/docs/XapiVerb.md +0 -9
  213. data/git_push.sh +0 -55
  214. data/spec/models/activity_result_schema_spec.rb +0 -133
  215. data/spec/models/application_list_schema_spec.rb +0 -53
  216. data/spec/models/application_schema_spec.rb +0 -59
  217. data/spec/models/application_token_spec.rb +0 -65
  218. data/spec/models/comment_schema_spec.rb +0 -65
  219. data/spec/models/completion_amount_schema_spec.rb +0 -53
  220. data/spec/models/course_activity_schema_spec.rb +0 -99
  221. data/spec/models/course_list_non_paged_schema_spec.rb +0 -53
  222. data/spec/models/course_list_schema_spec.rb +0 -59
  223. data/spec/models/course_reference_schema_spec.rb +0 -65
  224. data/spec/models/course_schema_spec.rb +0 -129
  225. data/spec/models/create_registration_schema_spec.rb +0 -107
  226. data/spec/models/credential_created_schema_spec.rb +0 -77
  227. data/spec/models/credential_list_schema_spec.rb +0 -53
  228. data/spec/models/credential_request_schema_spec.rb +0 -59
  229. data/spec/models/credential_schema_spec.rb +0 -77
  230. data/spec/models/import_fetch_request_schema_spec.rb +0 -53
  231. data/spec/models/import_job_result_schema_spec.rb +0 -75
  232. data/spec/models/import_result_schema_spec.rb +0 -71
  233. data/spec/models/integer_result_schema_spec.rb +0 -53
  234. data/spec/models/item_value_pair_schema_spec.rb +0 -59
  235. data/spec/models/launch_history_list_schema_spec.rb +0 -53
  236. data/spec/models/launch_history_schema_spec.rb +0 -115
  237. data/spec/models/launch_link_request_schema_spec.rb +0 -107
  238. data/spec/models/launch_link_schema_spec.rb +0 -53
  239. data/spec/models/learner_preference_schema_spec.rb +0 -71
  240. data/spec/models/learner_schema_spec.rb +0 -71
  241. data/spec/models/link_schema_spec.rb +0 -53
  242. data/spec/models/message_schema_spec.rb +0 -53
  243. data/spec/models/metadata_schema_spec.rb +0 -89
  244. data/spec/models/objective_schema_spec.rb +0 -137
  245. data/spec/models/permissions_schema_spec.rb +0 -59
  246. data/spec/models/ping_schema_spec.rb +0 -53
  247. data/spec/models/post_back_schema_spec.rb +0 -85
  248. data/spec/models/registration_completion_spec.rb +0 -47
  249. data/spec/models/registration_list_schema_spec.rb +0 -59
  250. data/spec/models/registration_schema_spec.rb +0 -167
  251. data/spec/models/registration_success_spec.rb +0 -47
  252. data/spec/models/response_error_spec.rb +0 -53
  253. data/spec/models/runtime_interaction_schema_spec.rb +0 -117
  254. data/spec/models/runtime_objective_schema_spec.rb +0 -109
  255. data/spec/models/runtime_schema_spec.rb +0 -171
  256. data/spec/models/score_schema_spec.rb +0 -53
  257. data/spec/models/setting_item_spec.rb +0 -81
  258. data/spec/models/setting_list_schema_spec.rb +0 -53
  259. data/spec/models/setting_metadata_spec.rb +0 -99
  260. data/spec/models/setting_metadata_valid_values_spec.rb +0 -59
  261. data/spec/models/settings_individual_schema_spec.rb +0 -65
  262. data/spec/models/settings_post_schema_spec.rb +0 -53
  263. data/spec/models/shared_data_entry_schema_spec.rb +0 -59
  264. data/spec/models/static_properties_schema_spec.rb +0 -83
  265. data/spec/models/string_result_schema_spec.rb +0 -53
  266. data/spec/models/title_schema_spec.rb +0 -53
  267. data/spec/models/token_request_schema_spec.rb +0 -59
  268. data/swagger-codegen.config +0 -11
@@ -3,14 +3,13 @@
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
10
9
 
11
10
  =end
12
11
 
13
- require 'uri'
12
+ require "uri"
14
13
 
15
14
  module RusticiSoftwareCloudV2
16
15
  class CourseApi
@@ -19,7 +18,9 @@ module RusticiSoftwareCloudV2
19
18
  def initialize(api_client = ApiClient.default)
20
19
  @api_client = api_client
21
20
  end
22
- # Returns the launch link to use to preview this course
21
+
22
+ # Get a link to preview a course.
23
+ # Returns the launch link to use to preview this course.
23
24
  # @param course_id
24
25
  # @param launch_link_request
25
26
  # @param [Hash] opts the optional parameters
@@ -27,10 +28,11 @@ module RusticiSoftwareCloudV2
27
28
  # @return [LaunchLinkSchema]
28
29
  def build_course_preview_launch_link(course_id, launch_link_request, opts = {})
29
30
  data, _status_code, _headers = build_course_preview_launch_link_with_http_info(course_id, launch_link_request, opts)
30
- data
31
+ return data
31
32
  end
32
33
 
33
- # Returns the launch link to use to preview this course
34
+ # Get a link to preview a course.
35
+ # Returns the launch link to use to preview this course.
34
36
  # @param course_id
35
37
  # @param launch_link_request
36
38
  # @param [Hash] opts the optional parameters
@@ -38,18 +40,14 @@ module RusticiSoftwareCloudV2
38
40
  # @return [Array<(LaunchLinkSchema, Fixnum, Hash)>] LaunchLinkSchema data, response status code and response headers
39
41
  def build_course_preview_launch_link_with_http_info(course_id, launch_link_request, opts = {})
40
42
  if @api_client.config.debugging
41
- @api_client.config.logger.debug 'Calling API: CourseApi.build_course_preview_launch_link ...'
43
+ @api_client.config.logger.debug "Calling API: CourseApi.build_course_preview_launch_link ..."
42
44
  end
43
45
  # verify the required parameter 'course_id' is set
44
- if @api_client.config.client_side_validation && course_id.nil?
45
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.build_course_preview_launch_link"
46
- end
46
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.build_course_preview_launch_link" if course_id.nil?
47
47
  # verify the required parameter 'launch_link_request' is set
48
- if @api_client.config.client_side_validation && launch_link_request.nil?
49
- fail ArgumentError, "Missing the required parameter 'launch_link_request' when calling CourseApi.build_course_preview_launch_link"
50
- end
48
+ fail ArgumentError, "Missing the required parameter 'launch_link_request' when calling CourseApi.build_course_preview_launch_link" if launch_link_request.nil?
51
49
  # resource path
52
- local_var_path = '/courses/{courseId}/preview'.sub('{' + 'courseId' + '}', course_id.to_s)
50
+ local_var_path = "/courses/{courseId}/preview".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s)
53
51
 
54
52
  # query parameters
55
53
  query_params = {}
@@ -80,7 +78,9 @@ module RusticiSoftwareCloudV2
80
78
  end
81
79
  return data, status_code, headers
82
80
  end
83
- # Returns the link to use to preview this course
81
+
82
+ # Get a link to preview a particular course version.
83
+ # Returns the link to use to preview a particular version of a course.
84
84
  # @param course_id
85
85
  # @param version_id The course version
86
86
  # @param launch_link_request
@@ -88,10 +88,11 @@ module RusticiSoftwareCloudV2
88
88
  # @return [LaunchLinkSchema]
89
89
  def build_course_preview_launch_link_with_version(course_id, version_id, launch_link_request, opts = {})
90
90
  data, _status_code, _headers = build_course_preview_launch_link_with_version_with_http_info(course_id, version_id, launch_link_request, opts)
91
- data
91
+ return data
92
92
  end
93
93
 
94
- # Returns the link to use to preview this course
94
+ # Get a link to preview a particular course version.
95
+ # Returns the link to use to preview a particular version of a course.
95
96
  # @param course_id
96
97
  # @param version_id The course version
97
98
  # @param launch_link_request
@@ -99,22 +100,16 @@ module RusticiSoftwareCloudV2
99
100
  # @return [Array<(LaunchLinkSchema, Fixnum, Hash)>] LaunchLinkSchema data, response status code and response headers
100
101
  def build_course_preview_launch_link_with_version_with_http_info(course_id, version_id, launch_link_request, opts = {})
101
102
  if @api_client.config.debugging
102
- @api_client.config.logger.debug 'Calling API: CourseApi.build_course_preview_launch_link_with_version ...'
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
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.build_course_preview_launch_link_with_version"
107
- end
106
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.build_course_preview_launch_link_with_version" if course_id.nil?
108
107
  # verify the required parameter 'version_id' is set
109
- if @api_client.config.client_side_validation && version_id.nil?
110
- fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.build_course_preview_launch_link_with_version"
111
- end
108
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.build_course_preview_launch_link_with_version" if version_id.nil?
112
109
  # verify the required parameter 'launch_link_request' is set
113
- if @api_client.config.client_side_validation && launch_link_request.nil?
114
- fail ArgumentError, "Missing the required parameter 'launch_link_request' when calling CourseApi.build_course_preview_launch_link_with_version"
115
- end
110
+ fail ArgumentError, "Missing the required parameter 'launch_link_request' when calling CourseApi.build_course_preview_launch_link_with_version" if launch_link_request.nil?
116
111
  # resource path
117
- local_var_path = '/courses/{courseId}/versions/{versionId}/preview'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
112
+ local_var_path = "/courses/{courseId}/versions/{versionId}/preview".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
118
113
 
119
114
  # query parameters
120
115
  query_params = {}
@@ -144,8 +139,9 @@ module RusticiSoftwareCloudV2
144
139
  end
145
140
  return data, status_code, headers
146
141
  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.\"
142
+
143
+ # Fetch and import a course.
144
+ # 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. To check the progress of the import job, GetImportJobStatus should be called with the job ID returned from this call.
149
145
  # @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
146
  # @param import_request
151
147
  # @param [Hash] opts the optional parameters
@@ -154,11 +150,11 @@ module RusticiSoftwareCloudV2
154
150
  # @return [StringResultSchema]
155
151
  def create_fetch_and_import_course_job(course_id, import_request, opts = {})
156
152
  data, _status_code, _headers = create_fetch_and_import_course_job_with_http_info(course_id, import_request, opts)
157
- data
153
+ return data
158
154
  end
159
155
 
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;
156
+ # Fetch and import a course.
157
+ # 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. To check the progress of the import job, GetImportJobStatus should be called with the job ID returned from this call.
162
158
  # @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
159
  # @param import_request
164
160
  # @param [Hash] opts the optional parameters
@@ -167,18 +163,14 @@ module RusticiSoftwareCloudV2
167
163
  # @return [Array<(StringResultSchema, Fixnum, Hash)>] StringResultSchema data, response status code and response headers
168
164
  def create_fetch_and_import_course_job_with_http_info(course_id, import_request, opts = {})
169
165
  if @api_client.config.debugging
170
- @api_client.config.logger.debug 'Calling API: CourseApi.create_fetch_and_import_course_job ...'
166
+ @api_client.config.logger.debug "Calling API: CourseApi.create_fetch_and_import_course_job ..."
171
167
  end
172
168
  # verify the required parameter 'course_id' is set
173
- if @api_client.config.client_side_validation && course_id.nil?
174
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.create_fetch_and_import_course_job"
175
- end
169
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.create_fetch_and_import_course_job" if course_id.nil?
176
170
  # verify the required parameter 'import_request' is set
177
- if @api_client.config.client_side_validation && import_request.nil?
178
- fail ArgumentError, "Missing the required parameter 'import_request' when calling CourseApi.create_fetch_and_import_course_job"
179
- end
171
+ fail ArgumentError, "Missing the required parameter 'import_request' when calling CourseApi.create_fetch_and_import_course_job" if import_request.nil?
180
172
  # resource path
181
- local_var_path = '/courses/importJobs'
173
+ local_var_path = "/courses/importJobs".sub('{format}','json')
182
174
 
183
175
  # query parameters
184
176
  query_params = {}
@@ -211,37 +203,36 @@ module RusticiSoftwareCloudV2
211
203
  end
212
204
  return data, status_code, headers
213
205
  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.
206
+
207
+ # Upload and import a course.
208
+ # 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. To check the progress of the import job, GetImportJobStatus should be called with the job ID returned from this call.
216
209
  # @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
210
  # @param [Hash] opts the optional parameters
218
211
  # @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
212
  # @option opts [String] :postback_url An optional parameter that specifies a URL to send a postback to when the course has finished uploading.
213
+ # @option opts [File] :file The zip file of the course contents to import.
221
214
  # @return [StringResultSchema]
222
215
  def create_upload_and_import_course_job(course_id, opts = {})
223
216
  data, _status_code, _headers = create_upload_and_import_course_job_with_http_info(course_id, opts)
224
- data
217
+ return data
225
218
  end
226
219
 
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.
220
+ # Upload and import a course.
221
+ # 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. To check the progress of the import job, GetImportJobStatus should be called with the job ID returned from this call.
229
222
  # @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
223
  # @param [Hash] opts the optional parameters
231
224
  # @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
225
  # @option opts [String] :postback_url An optional parameter that specifies a URL to send a postback to when the course has finished uploading.
226
+ # @option opts [File] :file The zip file of the course contents to import.
234
227
  # @return [Array<(StringResultSchema, Fixnum, Hash)>] StringResultSchema data, response status code and response headers
235
228
  def create_upload_and_import_course_job_with_http_info(course_id, opts = {})
236
229
  if @api_client.config.debugging
237
- @api_client.config.logger.debug 'Calling API: CourseApi.create_upload_and_import_course_job ...'
230
+ @api_client.config.logger.debug "Calling API: CourseApi.create_upload_and_import_course_job ..."
238
231
  end
239
232
  # verify the required parameter 'course_id' is set
240
- if @api_client.config.client_side_validation && course_id.nil?
241
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.create_upload_and_import_course_job"
242
- end
233
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.create_upload_and_import_course_job" if course_id.nil?
243
234
  # resource path
244
- local_var_path = '/courses/importJobs/upload'
235
+ local_var_path = "/courses/importJobs/upload".sub('{format}','json')
245
236
 
246
237
  # query parameters
247
238
  query_params = {}
@@ -258,7 +249,7 @@ module RusticiSoftwareCloudV2
258
249
 
259
250
  # form parameters
260
251
  form_params = {}
261
- form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
252
+ form_params["file"] = opts[:'file'] if !opts[:'file'].nil?
262
253
 
263
254
  # http body (model)
264
255
  post_body = nil
@@ -275,29 +266,30 @@ module RusticiSoftwareCloudV2
275
266
  end
276
267
  return data, status_code, headers
277
268
  end
278
- # Delete `courseId`
269
+
270
+ # Delete a course.
271
+ # Delete course identified by `courseId`. When a course is deleted, so is everything connected to this course. This includes: - Registrations - Invitations - Dispatches - Debug Logs
279
272
  # @param course_id
280
273
  # @param [Hash] opts the optional parameters
281
274
  # @return [nil]
282
275
  def delete_course(course_id, opts = {})
283
276
  delete_course_with_http_info(course_id, opts)
284
- nil
277
+ return nil
285
278
  end
286
279
 
287
- # Delete &#x60;courseId&#x60;
280
+ # Delete a course.
281
+ # Delete course identified by &#x60;courseId&#x60;. When a course is deleted, so is everything connected to this course. This includes: - Registrations - Invitations - Dispatches - Debug Logs
288
282
  # @param course_id
289
283
  # @param [Hash] opts the optional parameters
290
284
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
291
285
  def delete_course_with_http_info(course_id, opts = {})
292
286
  if @api_client.config.debugging
293
- @api_client.config.logger.debug 'Calling API: CourseApi.delete_course ...'
287
+ @api_client.config.logger.debug "Calling API: CourseApi.delete_course ..."
294
288
  end
295
289
  # verify the required parameter 'course_id' is set
296
- if @api_client.config.client_side_validation && course_id.nil?
297
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course"
298
- end
290
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course" if course_id.nil?
299
291
  # resource path
300
- local_var_path = '/courses/{courseId}'.sub('{' + 'courseId' + '}', course_id.to_s)
292
+ local_var_path = "/courses/{courseId}".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s)
301
293
 
302
294
  # query parameters
303
295
  query_params = {}
@@ -326,35 +318,34 @@ module RusticiSoftwareCloudV2
326
318
  end
327
319
  return data, status_code, headers
328
320
  end
329
- # Clears the `settingId` value for this course
321
+
322
+ # Clear a course configuration.
323
+ # Clears the value of the given `settingId` for this course. The effective setting value will become any value set at the application level (if this value is set at the application level) or the default setting.
330
324
  # @param course_id
331
325
  # @param setting_id
332
326
  # @param [Hash] opts the optional parameters
333
327
  # @return [nil]
334
328
  def delete_course_configuration_setting(course_id, setting_id, opts = {})
335
329
  delete_course_configuration_setting_with_http_info(course_id, setting_id, opts)
336
- nil
330
+ return nil
337
331
  end
338
332
 
339
- # Clears the &#x60;settingId&#x60; value for this course
333
+ # Clear a course configuration.
334
+ # Clears the value of the given &#x60;settingId&#x60; for this course. The effective setting value will become any value set at the application level (if this value is set at the application level) or the default setting.
340
335
  # @param course_id
341
336
  # @param setting_id
342
337
  # @param [Hash] opts the optional parameters
343
338
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
344
339
  def delete_course_configuration_setting_with_http_info(course_id, setting_id, opts = {})
345
340
  if @api_client.config.debugging
346
- @api_client.config.logger.debug 'Calling API: CourseApi.delete_course_configuration_setting ...'
341
+ @api_client.config.logger.debug "Calling API: CourseApi.delete_course_configuration_setting ..."
347
342
  end
348
343
  # verify the required parameter 'course_id' is set
349
- if @api_client.config.client_side_validation && course_id.nil?
350
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_configuration_setting"
351
- end
344
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_configuration_setting" if course_id.nil?
352
345
  # verify the required parameter 'setting_id' is set
353
- if @api_client.config.client_side_validation && setting_id.nil?
354
- fail ArgumentError, "Missing the required parameter 'setting_id' when calling CourseApi.delete_course_configuration_setting"
355
- end
346
+ fail ArgumentError, "Missing the required parameter 'setting_id' when calling CourseApi.delete_course_configuration_setting" if setting_id.nil?
356
347
  # resource path
357
- local_var_path = '/courses/{courseId}/configuration/{settingId}'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'settingId' + '}', setting_id.to_s)
348
+ local_var_path = "/courses/{courseId}/configuration/{settingId}".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'settingId' + '}', setting_id.to_s)
358
349
 
359
350
  # query parameters
360
351
  query_params = {}
@@ -383,35 +374,34 @@ module RusticiSoftwareCloudV2
383
374
  end
384
375
  return data, status_code, headers
385
376
  end
386
- # Delete tags for this course
377
+
378
+ # Delete course tags.
379
+ # Delete the provided tags from this course.
387
380
  # @param course_id
388
381
  # @param tags
389
382
  # @param [Hash] opts the optional parameters
390
383
  # @return [nil]
391
384
  def delete_course_tags(course_id, tags, opts = {})
392
385
  delete_course_tags_with_http_info(course_id, tags, opts)
393
- nil
386
+ return nil
394
387
  end
395
388
 
396
- # Delete tags for this course
389
+ # Delete course tags.
390
+ # Delete the provided tags from this course.
397
391
  # @param course_id
398
392
  # @param tags
399
393
  # @param [Hash] opts the optional parameters
400
394
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
401
395
  def delete_course_tags_with_http_info(course_id, tags, opts = {})
402
396
  if @api_client.config.debugging
403
- @api_client.config.logger.debug 'Calling API: CourseApi.delete_course_tags ...'
397
+ @api_client.config.logger.debug "Calling API: CourseApi.delete_course_tags ..."
404
398
  end
405
399
  # verify the required parameter 'course_id' is set
406
- if @api_client.config.client_side_validation && course_id.nil?
407
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_tags"
408
- end
400
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_tags" if course_id.nil?
409
401
  # verify the required parameter 'tags' is set
410
- if @api_client.config.client_side_validation && tags.nil?
411
- fail ArgumentError, "Missing the required parameter 'tags' when calling CourseApi.delete_course_tags"
412
- end
402
+ fail ArgumentError, "Missing the required parameter 'tags' when calling CourseApi.delete_course_tags" if tags.nil?
413
403
  # resource path
414
- local_var_path = '/courses/{courseId}/tags'.sub('{' + 'courseId' + '}', course_id.to_s)
404
+ local_var_path = "/courses/{courseId}/tags".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s)
415
405
 
416
406
  # query parameters
417
407
  query_params = {}
@@ -440,35 +430,34 @@ module RusticiSoftwareCloudV2
440
430
  end
441
431
  return data, status_code, headers
442
432
  end
443
- # Delete version `versionId` of `courseId`
433
+
434
+ # Delete a course version.
435
+ # Delete `versionId` of `courseId`. If this is the last remaining version of this course, the course itself will be deleted and no longer accessible.
444
436
  # @param course_id
445
437
  # @param version_id The course version
446
438
  # @param [Hash] opts the optional parameters
447
439
  # @return [nil]
448
440
  def delete_course_version(course_id, version_id, opts = {})
449
441
  delete_course_version_with_http_info(course_id, version_id, opts)
450
- nil
442
+ return nil
451
443
  end
452
444
 
453
- # Delete version &#x60;versionId&#x60; of &#x60;courseId&#x60;
445
+ # Delete a course version.
446
+ # Delete &#x60;versionId&#x60; of &#x60;courseId&#x60;. If this is the last remaining version of this course, the course itself will be deleted and no longer accessible.
454
447
  # @param course_id
455
448
  # @param version_id The course version
456
449
  # @param [Hash] opts the optional parameters
457
450
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
458
451
  def delete_course_version_with_http_info(course_id, version_id, opts = {})
459
452
  if @api_client.config.debugging
460
- @api_client.config.logger.debug 'Calling API: CourseApi.delete_course_version ...'
453
+ @api_client.config.logger.debug "Calling API: CourseApi.delete_course_version ..."
461
454
  end
462
455
  # verify the required parameter 'course_id' is set
463
- if @api_client.config.client_side_validation && course_id.nil?
464
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_version"
465
- end
456
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_version" if course_id.nil?
466
457
  # verify the required parameter 'version_id' is set
467
- if @api_client.config.client_side_validation && version_id.nil?
468
- fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.delete_course_version"
469
- end
458
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.delete_course_version" if version_id.nil?
470
459
  # resource path
471
- local_var_path = '/courses/{courseId}/versions/{versionId}'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
460
+ local_var_path = "/courses/{courseId}/versions/{versionId}".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
472
461
 
473
462
  # query parameters
474
463
  query_params = {}
@@ -497,7 +486,9 @@ module RusticiSoftwareCloudV2
497
486
  end
498
487
  return data, status_code, headers
499
488
  end
500
- # Clears the `settingId` value for this course and version.
489
+
490
+ # Clear a configuration setting for a version of a course.
491
+ # Clears the `settingId` value for this course and version.
501
492
  # @param course_id
502
493
  # @param version_id The course version
503
494
  # @param setting_id
@@ -505,10 +496,11 @@ module RusticiSoftwareCloudV2
505
496
  # @return [nil]
506
497
  def delete_course_version_configuration_setting(course_id, version_id, setting_id, opts = {})
507
498
  delete_course_version_configuration_setting_with_http_info(course_id, version_id, setting_id, opts)
508
- nil
499
+ return nil
509
500
  end
510
501
 
511
- # Clears the &#x60;settingId&#x60; value for this course and version.
502
+ # Clear a configuration setting for a version of a course.
503
+ # Clears the &#x60;settingId&#x60; value for this course and version.
512
504
  # @param course_id
513
505
  # @param version_id The course version
514
506
  # @param setting_id
@@ -516,22 +508,16 @@ module RusticiSoftwareCloudV2
516
508
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
517
509
  def delete_course_version_configuration_setting_with_http_info(course_id, version_id, setting_id, opts = {})
518
510
  if @api_client.config.debugging
519
- @api_client.config.logger.debug 'Calling API: CourseApi.delete_course_version_configuration_setting ...'
511
+ @api_client.config.logger.debug "Calling API: CourseApi.delete_course_version_configuration_setting ..."
520
512
  end
521
513
  # verify the required parameter 'course_id' is set
522
- if @api_client.config.client_side_validation && course_id.nil?
523
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_version_configuration_setting"
524
- end
514
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_version_configuration_setting" if course_id.nil?
525
515
  # verify the required parameter 'version_id' is set
526
- if @api_client.config.client_side_validation && version_id.nil?
527
- fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.delete_course_version_configuration_setting"
528
- end
516
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.delete_course_version_configuration_setting" if version_id.nil?
529
517
  # verify the required parameter 'setting_id' is set
530
- if @api_client.config.client_side_validation && setting_id.nil?
531
- fail ArgumentError, "Missing the required parameter 'setting_id' when calling CourseApi.delete_course_version_configuration_setting"
532
- end
518
+ fail ArgumentError, "Missing the required parameter 'setting_id' when calling CourseApi.delete_course_version_configuration_setting" if setting_id.nil?
533
519
  # resource path
534
- local_var_path = '/courses/{courseId}/versions/{versionId}/configuration/{settingId}'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s).sub('{' + 'settingId' + '}', setting_id.to_s)
520
+ local_var_path = "/courses/{courseId}/versions/{versionId}/configuration/{settingId}".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s).sub('{' + 'settingId' + '}', setting_id.to_s)
535
521
 
536
522
  # query parameters
537
523
  query_params = {}
@@ -560,7 +546,9 @@ module RusticiSoftwareCloudV2
560
546
  end
561
547
  return data, status_code, headers
562
548
  end
563
- # Get information about `courseId`
549
+
550
+ # Get course details.
551
+ # Get detailed information about `courseId`. Futher detail can be obtained with the optional query parameters flags.
564
552
  # @param course_id
565
553
  # @param [Hash] opts the optional parameters
566
554
  # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
@@ -568,10 +556,11 @@ module RusticiSoftwareCloudV2
568
556
  # @return [CourseSchema]
569
557
  def get_course(course_id, opts = {})
570
558
  data, _status_code, _headers = get_course_with_http_info(course_id, opts)
571
- data
559
+ return data
572
560
  end
573
561
 
574
- # Get information about &#x60;courseId&#x60;
562
+ # Get course details.
563
+ # Get detailed information about &#x60;courseId&#x60;. Futher detail can be obtained with the optional query parameters flags.
575
564
  # @param course_id
576
565
  # @param [Hash] opts the optional parameters
577
566
  # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
@@ -579,14 +568,12 @@ module RusticiSoftwareCloudV2
579
568
  # @return [Array<(CourseSchema, Fixnum, Hash)>] CourseSchema data, response status code and response headers
580
569
  def get_course_with_http_info(course_id, opts = {})
581
570
  if @api_client.config.debugging
582
- @api_client.config.logger.debug 'Calling API: CourseApi.get_course ...'
571
+ @api_client.config.logger.debug "Calling API: CourseApi.get_course ..."
583
572
  end
584
573
  # verify the required parameter 'course_id' is set
585
- if @api_client.config.client_side_validation && course_id.nil?
586
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course"
587
- end
574
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course" if course_id.nil?
588
575
  # resource path
589
- local_var_path = '/courses/{courseId}'.sub('{' + 'courseId' + '}', course_id.to_s)
576
+ local_var_path = "/courses/{courseId}".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s)
590
577
 
591
578
  # query parameters
592
579
  query_params = {}
@@ -618,31 +605,32 @@ module RusticiSoftwareCloudV2
618
605
  end
619
606
  return data, status_code, headers
620
607
  end
621
- # Returns all configuration settings for this course
608
+
609
+ # Get course configuration.
610
+ # Returns all effective configuration settings for this course. For any setting which is not explicitly set at the course level, the effective value will be either the value set at the application level (if there is one) or the default value for the setting.
622
611
  # @param course_id
623
612
  # @param [Hash] opts the optional parameters
624
613
  # @option opts [BOOLEAN] :include_metadata (default to false)
625
614
  # @return [SettingListSchema]
626
615
  def get_course_configuration(course_id, opts = {})
627
616
  data, _status_code, _headers = get_course_configuration_with_http_info(course_id, opts)
628
- data
617
+ return data
629
618
  end
630
619
 
631
- # Returns all configuration settings for this course
620
+ # Get course configuration.
621
+ # Returns all effective configuration settings for this course. For any setting which is not explicitly set at the course level, the effective value will be either the value set at the application level (if there is one) or the default value for the setting.
632
622
  # @param course_id
633
623
  # @param [Hash] opts the optional parameters
634
624
  # @option opts [BOOLEAN] :include_metadata
635
625
  # @return [Array<(SettingListSchema, Fixnum, Hash)>] SettingListSchema data, response status code and response headers
636
626
  def get_course_configuration_with_http_info(course_id, opts = {})
637
627
  if @api_client.config.debugging
638
- @api_client.config.logger.debug 'Calling API: CourseApi.get_course_configuration ...'
628
+ @api_client.config.logger.debug "Calling API: CourseApi.get_course_configuration ..."
639
629
  end
640
630
  # verify the required parameter 'course_id' is set
641
- if @api_client.config.client_side_validation && course_id.nil?
642
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_configuration"
643
- end
631
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_configuration" if course_id.nil?
644
632
  # resource path
645
- local_var_path = '/courses/{courseId}/configuration'.sub('{' + 'courseId' + '}', course_id.to_s)
633
+ local_var_path = "/courses/{courseId}/configuration".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s)
646
634
 
647
635
  # query parameters
648
636
  query_params = {}
@@ -673,7 +661,9 @@ module RusticiSoftwareCloudV2
673
661
  end
674
662
  return data, status_code, headers
675
663
  end
676
- # Get xAPI statements for `courseId`
664
+
665
+ # Get course xAPI statements.
666
+ # Get xAPI statements for `courseId`.
677
667
  # @param course_id
678
668
  # @param [Hash] opts the optional parameters
679
669
  # @option opts [String] :learner_id Only entries for the specified learner id will be included.
@@ -683,10 +673,11 @@ module RusticiSoftwareCloudV2
683
673
  # @return [XapiStatementResult]
684
674
  def get_course_statements(course_id, opts = {})
685
675
  data, _status_code, _headers = get_course_statements_with_http_info(course_id, opts)
686
- data
676
+ return data
687
677
  end
688
678
 
689
- # Get xAPI statements for &#x60;courseId&#x60;
679
+ # Get course xAPI statements.
680
+ # Get xAPI statements for &#x60;courseId&#x60;.
690
681
  # @param course_id
691
682
  # @param [Hash] opts the optional parameters
692
683
  # @option opts [String] :learner_id Only entries for the specified learner id will be included.
@@ -696,14 +687,12 @@ module RusticiSoftwareCloudV2
696
687
  # @return [Array<(XapiStatementResult, Fixnum, Hash)>] XapiStatementResult data, response status code and response headers
697
688
  def get_course_statements_with_http_info(course_id, opts = {})
698
689
  if @api_client.config.debugging
699
- @api_client.config.logger.debug 'Calling API: CourseApi.get_course_statements ...'
690
+ @api_client.config.logger.debug "Calling API: CourseApi.get_course_statements ..."
700
691
  end
701
692
  # verify the required parameter 'course_id' is set
702
- if @api_client.config.client_side_validation && course_id.nil?
703
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_statements"
704
- end
693
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_statements" if course_id.nil?
705
694
  # resource path
706
- local_var_path = '/courses/{courseId}/xAPIStatements'.sub('{' + 'courseId' + '}', course_id.to_s)
695
+ local_var_path = "/courses/{courseId}/xAPIStatements".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s)
707
696
 
708
697
  # query parameters
709
698
  query_params = {}
@@ -737,29 +726,30 @@ module RusticiSoftwareCloudV2
737
726
  end
738
727
  return data, status_code, headers
739
728
  end
740
- # Get the tags for this course
729
+
730
+ # Get course tags.
731
+ # Get a list of the tags for this course.
741
732
  # @param course_id
742
733
  # @param [Hash] opts the optional parameters
743
734
  # @return [TagListSchema]
744
735
  def get_course_tags(course_id, opts = {})
745
736
  data, _status_code, _headers = get_course_tags_with_http_info(course_id, opts)
746
- data
737
+ return data
747
738
  end
748
739
 
749
- # Get the tags for this course
740
+ # Get course tags.
741
+ # Get a list of the tags for this course.
750
742
  # @param course_id
751
743
  # @param [Hash] opts the optional parameters
752
744
  # @return [Array<(TagListSchema, Fixnum, Hash)>] TagListSchema data, response status code and response headers
753
745
  def get_course_tags_with_http_info(course_id, opts = {})
754
746
  if @api_client.config.debugging
755
- @api_client.config.logger.debug 'Calling API: CourseApi.get_course_tags ...'
747
+ @api_client.config.logger.debug "Calling API: CourseApi.get_course_tags ..."
756
748
  end
757
749
  # verify the required parameter 'course_id' is set
758
- if @api_client.config.client_side_validation && course_id.nil?
759
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_tags"
760
- end
750
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_tags" if course_id.nil?
761
751
  # resource path
762
- local_var_path = '/courses/{courseId}/tags'.sub('{' + 'courseId' + '}', course_id.to_s)
752
+ local_var_path = "/courses/{courseId}/tags".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s)
763
753
 
764
754
  # query parameters
765
755
  query_params = {}
@@ -789,7 +779,9 @@ module RusticiSoftwareCloudV2
789
779
  end
790
780
  return data, status_code, headers
791
781
  end
792
- # Returns all configuration settings for this course and version.
782
+
783
+ # Get configuration for a version of a course.
784
+ # Returns all configuration settings for this course and version.
793
785
  # @param course_id
794
786
  # @param version_id The course version
795
787
  # @param [Hash] opts the optional parameters
@@ -797,10 +789,11 @@ module RusticiSoftwareCloudV2
797
789
  # @return [SettingListSchema]
798
790
  def get_course_version_configuration(course_id, version_id, opts = {})
799
791
  data, _status_code, _headers = get_course_version_configuration_with_http_info(course_id, version_id, opts)
800
- data
792
+ return data
801
793
  end
802
794
 
803
- # Returns all configuration settings for this course and version.
795
+ # Get configuration for a version of a course.
796
+ # Returns all configuration settings for this course and version.
804
797
  # @param course_id
805
798
  # @param version_id The course version
806
799
  # @param [Hash] opts the optional parameters
@@ -808,18 +801,14 @@ module RusticiSoftwareCloudV2
808
801
  # @return [Array<(SettingListSchema, Fixnum, Hash)>] SettingListSchema data, response status code and response headers
809
802
  def get_course_version_configuration_with_http_info(course_id, version_id, opts = {})
810
803
  if @api_client.config.debugging
811
- @api_client.config.logger.debug 'Calling API: CourseApi.get_course_version_configuration ...'
804
+ @api_client.config.logger.debug "Calling API: CourseApi.get_course_version_configuration ..."
812
805
  end
813
806
  # verify the required parameter 'course_id' is set
814
- if @api_client.config.client_side_validation && course_id.nil?
815
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_configuration"
816
- end
807
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_configuration" if course_id.nil?
817
808
  # verify the required parameter 'version_id' is set
818
- if @api_client.config.client_side_validation && version_id.nil?
819
- fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_course_version_configuration"
820
- end
809
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_course_version_configuration" if version_id.nil?
821
810
  # resource path
822
- local_var_path = '/courses/{courseId}/versions/{versionId}/configuration'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
811
+ local_var_path = "/courses/{courseId}/versions/{versionId}/configuration".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
823
812
 
824
813
  # query parameters
825
814
  query_params = {}
@@ -850,7 +839,9 @@ module RusticiSoftwareCloudV2
850
839
  end
851
840
  return data, status_code, headers
852
841
  end
853
- # Get version `versionId` of `courseId`
842
+
843
+ # Get details on a course version.
844
+ # Get specific version `versionId` of `courseId`
854
845
  # @param course_id
855
846
  # @param version_id The course version
856
847
  # @param [Hash] opts the optional parameters
@@ -859,10 +850,11 @@ module RusticiSoftwareCloudV2
859
850
  # @return [CourseSchema]
860
851
  def get_course_version_info(course_id, version_id, opts = {})
861
852
  data, _status_code, _headers = get_course_version_info_with_http_info(course_id, version_id, opts)
862
- data
853
+ return data
863
854
  end
864
855
 
865
- # Get version &#x60;versionId&#x60; of &#x60;courseId&#x60;
856
+ # Get details on a course version.
857
+ # Get specific version &#x60;versionId&#x60; of &#x60;courseId&#x60;
866
858
  # @param course_id
867
859
  # @param version_id The course version
868
860
  # @param [Hash] opts the optional parameters
@@ -871,18 +863,14 @@ module RusticiSoftwareCloudV2
871
863
  # @return [Array<(CourseSchema, Fixnum, Hash)>] CourseSchema data, response status code and response headers
872
864
  def get_course_version_info_with_http_info(course_id, version_id, opts = {})
873
865
  if @api_client.config.debugging
874
- @api_client.config.logger.debug 'Calling API: CourseApi.get_course_version_info ...'
866
+ @api_client.config.logger.debug "Calling API: CourseApi.get_course_version_info ..."
875
867
  end
876
868
  # verify the required parameter 'course_id' is set
877
- if @api_client.config.client_side_validation && course_id.nil?
878
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_info"
879
- end
869
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_info" if course_id.nil?
880
870
  # verify the required parameter 'version_id' is set
881
- if @api_client.config.client_side_validation && version_id.nil?
882
- fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_course_version_info"
883
- end
871
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_course_version_info" if version_id.nil?
884
872
  # resource path
885
- local_var_path = '/courses/{courseId}/versions/{versionId}'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
873
+ local_var_path = "/courses/{courseId}/versions/{versionId}".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
886
874
 
887
875
  # query parameters
888
876
  query_params = {}
@@ -914,7 +902,9 @@ module RusticiSoftwareCloudV2
914
902
  end
915
903
  return data, status_code, headers
916
904
  end
917
- # Get xAPI statements for version `versionId` of `courseId`
905
+
906
+ # Get xAPI statements for a course version.
907
+ # Get xAPI statements for version `versionId` of `courseId`
918
908
  # @param course_id
919
909
  # @param version_id The course version
920
910
  # @param [Hash] opts the optional parameters
@@ -925,10 +915,11 @@ module RusticiSoftwareCloudV2
925
915
  # @return [XapiStatementResult]
926
916
  def get_course_version_statements(course_id, version_id, opts = {})
927
917
  data, _status_code, _headers = get_course_version_statements_with_http_info(course_id, version_id, opts)
928
- data
918
+ return data
929
919
  end
930
920
 
931
- # Get xAPI statements for version &#x60;versionId&#x60; of &#x60;courseId&#x60;
921
+ # Get xAPI statements for a course version.
922
+ # Get xAPI statements for version &#x60;versionId&#x60; of &#x60;courseId&#x60;
932
923
  # @param course_id
933
924
  # @param version_id The course version
934
925
  # @param [Hash] opts the optional parameters
@@ -939,18 +930,14 @@ module RusticiSoftwareCloudV2
939
930
  # @return [Array<(XapiStatementResult, Fixnum, Hash)>] XapiStatementResult data, response status code and response headers
940
931
  def get_course_version_statements_with_http_info(course_id, version_id, opts = {})
941
932
  if @api_client.config.debugging
942
- @api_client.config.logger.debug 'Calling API: CourseApi.get_course_version_statements ...'
933
+ @api_client.config.logger.debug "Calling API: CourseApi.get_course_version_statements ..."
943
934
  end
944
935
  # verify the required parameter 'course_id' is set
945
- if @api_client.config.client_side_validation && course_id.nil?
946
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_statements"
947
- end
936
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_statements" if course_id.nil?
948
937
  # verify the required parameter 'version_id' is set
949
- if @api_client.config.client_side_validation && version_id.nil?
950
- fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_course_version_statements"
951
- end
938
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_course_version_statements" if version_id.nil?
952
939
  # resource path
953
- local_var_path = '/courses/{courseId}/versions/{versionId}/xAPIStatements'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
940
+ local_var_path = "/courses/{courseId}/versions/{versionId}/xAPIStatements".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
954
941
 
955
942
  # query parameters
956
943
  query_params = {}
@@ -984,7 +971,9 @@ module RusticiSoftwareCloudV2
984
971
  end
985
972
  return data, status_code, headers
986
973
  end
987
- # Get all versions of `courseId`
974
+
975
+ # Get details on a course's versions.
976
+ # Get information about all versions of `courseId`. This can be useful to see information such as registration counts and modification times across the versions of a course.
988
977
  # @param course_id
989
978
  # @param [Hash] opts the optional parameters
990
979
  # @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.
@@ -994,10 +983,11 @@ module RusticiSoftwareCloudV2
994
983
  # @return [CourseListNonPagedSchema]
995
984
  def get_course_versions(course_id, opts = {})
996
985
  data, _status_code, _headers = get_course_versions_with_http_info(course_id, opts)
997
- data
986
+ return data
998
987
  end
999
988
 
1000
- # Get all versions of &#x60;courseId&#x60;
989
+ # Get details on a course&#39;s versions.
990
+ # Get information about all versions of &#x60;courseId&#x60;. This can be useful to see information such as registration counts and modification times across the versions of a course.
1001
991
  # @param course_id
1002
992
  # @param [Hash] opts the optional parameters
1003
993
  # @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.
@@ -1007,14 +997,12 @@ module RusticiSoftwareCloudV2
1007
997
  # @return [Array<(CourseListNonPagedSchema, Fixnum, Hash)>] CourseListNonPagedSchema data, response status code and response headers
1008
998
  def get_course_versions_with_http_info(course_id, opts = {})
1009
999
  if @api_client.config.debugging
1010
- @api_client.config.logger.debug 'Calling API: CourseApi.get_course_versions ...'
1000
+ @api_client.config.logger.debug "Calling API: CourseApi.get_course_versions ..."
1011
1001
  end
1012
1002
  # verify the required parameter 'course_id' is set
1013
- if @api_client.config.client_side_validation && course_id.nil?
1014
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_versions"
1015
- end
1003
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_versions" if course_id.nil?
1016
1004
  # resource path
1017
- local_var_path = '/courses/{courseId}/versions'.sub('{' + 'courseId' + '}', course_id.to_s)
1005
+ local_var_path = "/courses/{courseId}/versions".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s)
1018
1006
 
1019
1007
  # query parameters
1020
1008
  query_params = {}
@@ -1048,7 +1036,9 @@ module RusticiSoftwareCloudV2
1048
1036
  end
1049
1037
  return data, status_code, headers
1050
1038
  end
1051
- # Get all courses for `appId`
1039
+
1040
+ # Get all courses.
1041
+ # Get all courses for the `appId` which was used to authenticate this call.
1052
1042
  # @param [Hash] opts the optional parameters
1053
1043
  # @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
1044
  # @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.
@@ -1062,10 +1052,11 @@ module RusticiSoftwareCloudV2
1062
1052
  # @return [CourseListSchema]
1063
1053
  def get_courses(opts = {})
1064
1054
  data, _status_code, _headers = get_courses_with_http_info(opts)
1065
- data
1055
+ return data
1066
1056
  end
1067
1057
 
1068
- # Get all courses for &#x60;appId&#x60;
1058
+ # Get all courses.
1059
+ # Get all courses for the &#x60;appId&#x60; which was used to authenticate this call.
1069
1060
  # @param [Hash] opts the optional parameters
1070
1061
  # @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
1062
  # @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.
@@ -1079,16 +1070,16 @@ module RusticiSoftwareCloudV2
1079
1070
  # @return [Array<(CourseListSchema, Fixnum, Hash)>] CourseListSchema data, response status code and response headers
1080
1071
  def get_courses_with_http_info(opts = {})
1081
1072
  if @api_client.config.debugging
1082
- @api_client.config.logger.debug 'Calling API: CourseApi.get_courses ...'
1073
+ @api_client.config.logger.debug "Calling API: CourseApi.get_courses ..."
1083
1074
  end
1084
- if @api_client.config.client_side_validation && opts[:'filter_by'] && !['title', 'course_id', 'tags'].include?(opts[:'filter_by'])
1075
+ if opts[:'filter_by'] && !['title', 'course_id', 'tags'].include?(opts[:'filter_by'])
1085
1076
  fail ArgumentError, 'invalid value for "filter_by", must be one of title, course_id, tags'
1086
1077
  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'])
1078
+ if opts[:'order_by'] && !['title_asc', 'title_desc', 'creation_date_asc', 'creation_date_desc'].include?(opts[:'order_by'])
1088
1079
  fail ArgumentError, 'invalid value for "order_by", must be one of title_asc, title_desc, creation_date_asc, creation_date_desc'
1089
1080
  end
1090
1081
  # resource path
1091
- local_var_path = '/courses'
1082
+ local_var_path = "/courses".sub('{format}','json')
1092
1083
 
1093
1084
  # query parameters
1094
1085
  query_params = {}
@@ -1100,7 +1091,7 @@ module RusticiSoftwareCloudV2
1100
1091
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
1101
1092
  query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].nil?
1102
1093
  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?
1094
+ query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
1104
1095
 
1105
1096
  # header parameters
1106
1097
  header_params = {}
@@ -1127,29 +1118,30 @@ module RusticiSoftwareCloudV2
1127
1118
  end
1128
1119
  return data, status_code, headers
1129
1120
  end
1130
- # Check the status of an import job.
1121
+
1122
+ # Get course import job status.
1123
+ # Check the status of an import job. This can be called incrementally to check to progress of a call to either of the import options.
1131
1124
  # @param import_job_id Id received when the import job was submitted to the importJobs resource.
1132
1125
  # @param [Hash] opts the optional parameters
1133
1126
  # @return [ImportJobResultSchema]
1134
1127
  def get_import_job_status(import_job_id, opts = {})
1135
1128
  data, _status_code, _headers = get_import_job_status_with_http_info(import_job_id, opts)
1136
- data
1129
+ return data
1137
1130
  end
1138
1131
 
1139
- # Check the status of an import job.
1132
+ # Get course import job status.
1133
+ # Check the status of an import job. This can be called incrementally to check to progress of a call to either of the import options.
1140
1134
  # @param import_job_id Id received when the import job was submitted to the importJobs resource.
1141
1135
  # @param [Hash] opts the optional parameters
1142
1136
  # @return [Array<(ImportJobResultSchema, Fixnum, Hash)>] ImportJobResultSchema data, response status code and response headers
1143
1137
  def get_import_job_status_with_http_info(import_job_id, opts = {})
1144
1138
  if @api_client.config.debugging
1145
- @api_client.config.logger.debug 'Calling API: CourseApi.get_import_job_status ...'
1139
+ @api_client.config.logger.debug "Calling API: CourseApi.get_import_job_status ..."
1146
1140
  end
1147
1141
  # verify the required parameter 'import_job_id' is set
1148
- if @api_client.config.client_side_validation && import_job_id.nil?
1149
- fail ArgumentError, "Missing the required parameter 'import_job_id' when calling CourseApi.get_import_job_status"
1150
- end
1142
+ fail ArgumentError, "Missing the required parameter 'import_job_id' when calling CourseApi.get_import_job_status" if import_job_id.nil?
1151
1143
  # resource path
1152
- local_var_path = '/courses/importJobs/{importJobId}'.sub('{' + 'importJobId' + '}', import_job_id.to_s)
1144
+ local_var_path = "/courses/importJobs/{importJobId}".sub('{format}','json').sub('{' + 'importJobId' + '}', import_job_id.to_s)
1153
1145
 
1154
1146
  # query parameters
1155
1147
  query_params = {}
@@ -1179,35 +1171,34 @@ module RusticiSoftwareCloudV2
1179
1171
  end
1180
1172
  return data, status_code, headers
1181
1173
  end
1182
- # Set the tags for this course
1174
+
1175
+ # Set course tags.
1176
+ # Set the tags for this course. Note: any tags currently on this course will be overwritten with the new array of tags.
1183
1177
  # @param course_id
1184
1178
  # @param tags
1185
1179
  # @param [Hash] opts the optional parameters
1186
1180
  # @return [nil]
1187
1181
  def put_course_tags(course_id, tags, opts = {})
1188
1182
  put_course_tags_with_http_info(course_id, tags, opts)
1189
- nil
1183
+ return nil
1190
1184
  end
1191
1185
 
1192
- # Set the tags for this course
1186
+ # Set course tags.
1187
+ # Set the tags for this course. Note: any tags currently on this course will be overwritten with the new array of tags.
1193
1188
  # @param course_id
1194
1189
  # @param tags
1195
1190
  # @param [Hash] opts the optional parameters
1196
1191
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1197
1192
  def put_course_tags_with_http_info(course_id, tags, opts = {})
1198
1193
  if @api_client.config.debugging
1199
- @api_client.config.logger.debug 'Calling API: CourseApi.put_course_tags ...'
1194
+ @api_client.config.logger.debug "Calling API: CourseApi.put_course_tags ..."
1200
1195
  end
1201
1196
  # verify the required parameter 'course_id' is set
1202
- if @api_client.config.client_side_validation && course_id.nil?
1203
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.put_course_tags"
1204
- end
1197
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.put_course_tags" if course_id.nil?
1205
1198
  # verify the required parameter 'tags' is set
1206
- if @api_client.config.client_side_validation && tags.nil?
1207
- fail ArgumentError, "Missing the required parameter 'tags' when calling CourseApi.put_course_tags"
1208
- end
1199
+ fail ArgumentError, "Missing the required parameter 'tags' when calling CourseApi.put_course_tags" if tags.nil?
1209
1200
  # resource path
1210
- local_var_path = '/courses/{courseId}/tags'.sub('{' + 'courseId' + '}', course_id.to_s)
1201
+ local_var_path = "/courses/{courseId}/tags".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s)
1211
1202
 
1212
1203
  # query parameters
1213
1204
  query_params = {}
@@ -1236,29 +1227,30 @@ module RusticiSoftwareCloudV2
1236
1227
  end
1237
1228
  return data, status_code, headers
1238
1229
  end
1239
- # Sets all of the provided tags on all of the provided courses
1240
- # @param batch
1230
+
1231
+ # Set tags on courses.
1232
+ # Sets all of the provided tags on all of the provided courses.
1233
+ # @param batch Object representing an array of ids to apply an array of tags to.
1241
1234
  # @param [Hash] opts the optional parameters
1242
1235
  # @return [nil]
1243
1236
  def put_course_tags_batch(batch, opts = {})
1244
1237
  put_course_tags_batch_with_http_info(batch, opts)
1245
- nil
1238
+ return nil
1246
1239
  end
1247
1240
 
1248
- # Sets all of the provided tags on all of the provided courses
1249
- # @param batch
1241
+ # Set tags on courses.
1242
+ # Sets all of the provided tags on all of the provided courses.
1243
+ # @param batch Object representing an array of ids to apply an array of tags to.
1250
1244
  # @param [Hash] opts the optional parameters
1251
1245
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1252
1246
  def put_course_tags_batch_with_http_info(batch, opts = {})
1253
1247
  if @api_client.config.debugging
1254
- @api_client.config.logger.debug 'Calling API: CourseApi.put_course_tags_batch ...'
1248
+ @api_client.config.logger.debug "Calling API: CourseApi.put_course_tags_batch ..."
1255
1249
  end
1256
1250
  # verify the required parameter 'batch' is set
1257
- if @api_client.config.client_side_validation && batch.nil?
1258
- fail ArgumentError, "Missing the required parameter 'batch' when calling CourseApi.put_course_tags_batch"
1259
- end
1251
+ fail ArgumentError, "Missing the required parameter 'batch' when calling CourseApi.put_course_tags_batch" if batch.nil?
1260
1252
  # resource path
1261
- local_var_path = '/courses/tags'
1253
+ local_var_path = "/courses/tags".sub('{format}','json')
1262
1254
 
1263
1255
  # query parameters
1264
1256
  query_params = {}
@@ -1287,35 +1279,34 @@ module RusticiSoftwareCloudV2
1287
1279
  end
1288
1280
  return data, status_code, headers
1289
1281
  end
1290
- # Set configuration settings for this course.
1282
+
1283
+ # Set course configuration.
1284
+ # Set configuration settings for this course. Setting a value at this level will override any value which is set at the application level.
1291
1285
  # @param course_id
1292
1286
  # @param configuration_settings
1293
1287
  # @param [Hash] opts the optional parameters
1294
1288
  # @return [nil]
1295
1289
  def set_course_configuration(course_id, configuration_settings, opts = {})
1296
1290
  set_course_configuration_with_http_info(course_id, configuration_settings, opts)
1297
- nil
1291
+ return nil
1298
1292
  end
1299
1293
 
1300
- # Set configuration settings for this course.
1294
+ # Set course configuration.
1295
+ # Set configuration settings for this course. Setting a value at this level will override any value which is set at the application level.
1301
1296
  # @param course_id
1302
1297
  # @param configuration_settings
1303
1298
  # @param [Hash] opts the optional parameters
1304
1299
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1305
1300
  def set_course_configuration_with_http_info(course_id, configuration_settings, opts = {})
1306
1301
  if @api_client.config.debugging
1307
- @api_client.config.logger.debug 'Calling API: CourseApi.set_course_configuration ...'
1302
+ @api_client.config.logger.debug "Calling API: CourseApi.set_course_configuration ..."
1308
1303
  end
1309
1304
  # verify the required parameter 'course_id' is set
1310
- if @api_client.config.client_side_validation && course_id.nil?
1311
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.set_course_configuration"
1312
- end
1305
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.set_course_configuration" if course_id.nil?
1313
1306
  # verify the required parameter 'configuration_settings' is set
1314
- if @api_client.config.client_side_validation && configuration_settings.nil?
1315
- fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling CourseApi.set_course_configuration"
1316
- end
1307
+ fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling CourseApi.set_course_configuration" if configuration_settings.nil?
1317
1308
  # resource path
1318
- local_var_path = '/courses/{courseId}/configuration'.sub('{' + 'courseId' + '}', course_id.to_s)
1309
+ local_var_path = "/courses/{courseId}/configuration".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s)
1319
1310
 
1320
1311
  # query parameters
1321
1312
  query_params = {}
@@ -1344,35 +1335,34 @@ module RusticiSoftwareCloudV2
1344
1335
  end
1345
1336
  return data, status_code, headers
1346
1337
  end
1347
- # Sets the course title for `courseId`
1338
+
1339
+ # Set the title of a course.
1340
+ # Sets the course title for the provided courseId.
1348
1341
  # @param course_id
1349
1342
  # @param title
1350
1343
  # @param [Hash] opts the optional parameters
1351
- # @return [String]
1344
+ # @return [nil]
1352
1345
  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
1346
+ set_course_title_with_http_info(course_id, title, opts)
1347
+ return nil
1355
1348
  end
1356
1349
 
1357
- # Sets the course title for &#x60;courseId&#x60;
1350
+ # Set the title of a course.
1351
+ # Sets the course title for the provided courseId.
1358
1352
  # @param course_id
1359
1353
  # @param title
1360
1354
  # @param [Hash] opts the optional parameters
1361
- # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
1355
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1362
1356
  def set_course_title_with_http_info(course_id, title, opts = {})
1363
1357
  if @api_client.config.debugging
1364
- @api_client.config.logger.debug 'Calling API: CourseApi.set_course_title ...'
1358
+ @api_client.config.logger.debug "Calling API: CourseApi.set_course_title ..."
1365
1359
  end
1366
1360
  # verify the required parameter 'course_id' is set
1367
- if @api_client.config.client_side_validation && course_id.nil?
1368
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.set_course_title"
1369
- end
1361
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.set_course_title" if course_id.nil?
1370
1362
  # verify the required parameter 'title' is set
1371
- if @api_client.config.client_side_validation && title.nil?
1372
- fail ArgumentError, "Missing the required parameter 'title' when calling CourseApi.set_course_title"
1373
- end
1363
+ fail ArgumentError, "Missing the required parameter 'title' when calling CourseApi.set_course_title" if title.nil?
1374
1364
  # resource path
1375
- local_var_path = '/courses/{courseId}/title'.sub('{' + 'courseId' + '}', course_id.to_s)
1365
+ local_var_path = "/courses/{courseId}/title".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s)
1376
1366
 
1377
1367
  # query parameters
1378
1368
  query_params = {}
@@ -1395,14 +1385,15 @@ module RusticiSoftwareCloudV2
1395
1385
  :query_params => query_params,
1396
1386
  :form_params => form_params,
1397
1387
  :body => post_body,
1398
- :auth_names => auth_names,
1399
- :return_type => 'String')
1388
+ :auth_names => auth_names)
1400
1389
  if @api_client.config.debugging
1401
1390
  @api_client.config.logger.debug "API called: CourseApi#set_course_title\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1402
1391
  end
1403
1392
  return data, status_code, headers
1404
1393
  end
1405
- # Set configuration settings for this course and version.
1394
+
1395
+ # Set configuration for a version of a course.
1396
+ # Set configuration settings for this course and version.
1406
1397
  # @param course_id
1407
1398
  # @param version_id The course version
1408
1399
  # @param configuration_settings
@@ -1410,10 +1401,11 @@ module RusticiSoftwareCloudV2
1410
1401
  # @return [nil]
1411
1402
  def set_course_version_configuration(course_id, version_id, configuration_settings, opts = {})
1412
1403
  set_course_version_configuration_with_http_info(course_id, version_id, configuration_settings, opts)
1413
- nil
1404
+ return nil
1414
1405
  end
1415
1406
 
1416
- # Set configuration settings for this course and version.
1407
+ # Set configuration for a version of a course.
1408
+ # Set configuration settings for this course and version.
1417
1409
  # @param course_id
1418
1410
  # @param version_id The course version
1419
1411
  # @param configuration_settings
@@ -1421,22 +1413,16 @@ module RusticiSoftwareCloudV2
1421
1413
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1422
1414
  def set_course_version_configuration_with_http_info(course_id, version_id, configuration_settings, opts = {})
1423
1415
  if @api_client.config.debugging
1424
- @api_client.config.logger.debug 'Calling API: CourseApi.set_course_version_configuration ...'
1416
+ @api_client.config.logger.debug "Calling API: CourseApi.set_course_version_configuration ..."
1425
1417
  end
1426
1418
  # verify the required parameter 'course_id' is set
1427
- if @api_client.config.client_side_validation && course_id.nil?
1428
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.set_course_version_configuration"
1429
- end
1419
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.set_course_version_configuration" if course_id.nil?
1430
1420
  # verify the required parameter 'version_id' is set
1431
- if @api_client.config.client_side_validation && version_id.nil?
1432
- fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.set_course_version_configuration"
1433
- end
1421
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.set_course_version_configuration" if version_id.nil?
1434
1422
  # verify the required parameter 'configuration_settings' is set
1435
- if @api_client.config.client_side_validation && configuration_settings.nil?
1436
- fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling CourseApi.set_course_version_configuration"
1437
- end
1423
+ fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling CourseApi.set_course_version_configuration" if configuration_settings.nil?
1438
1424
  # resource path
1439
- local_var_path = '/courses/{courseId}/versions/{versionId}/configuration'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
1425
+ local_var_path = "/courses/{courseId}/versions/{versionId}/configuration".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
1440
1426
 
1441
1427
  # query parameters
1442
1428
  query_params = {}