rustici_software_cloud_v2 1.1.0 → 2.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (161) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +355 -356
  4. data/lib/rustici_software_cloud_v2/api/about_api.rb +5 -5
  5. data/lib/rustici_software_cloud_v2/api/application_management_api.rb +191 -63
  6. data/lib/rustici_software_cloud_v2/api/authentication_api.rb +10 -18
  7. data/lib/rustici_software_cloud_v2/api/content_connectors_api.rb +236 -0
  8. data/lib/rustici_software_cloud_v2/api/course_api.rb +1046 -225
  9. data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +634 -269
  10. data/lib/rustici_software_cloud_v2/api/invitations_api.rb +213 -171
  11. data/lib/rustici_software_cloud_v2/api/learner_api.rb +49 -49
  12. data/lib/rustici_software_cloud_v2/api/ping_api.rb +3 -1
  13. data/lib/rustici_software_cloud_v2/api/registration_api.rb +256 -270
  14. data/lib/rustici_software_cloud_v2/api/reporting_api.rb +20 -24
  15. data/lib/rustici_software_cloud_v2/api/xapi_api.rb +82 -67
  16. data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +125 -56
  17. data/lib/rustici_software_cloud_v2/api_client.rb +3 -3
  18. data/lib/rustici_software_cloud_v2/api_error.rb +1 -1
  19. data/lib/rustici_software_cloud_v2/configuration.rb +11 -4
  20. data/lib/rustici_software_cloud_v2/models/about_schema.rb +4 -2
  21. data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +9 -37
  22. data/lib/rustici_software_cloud_v2/models/application_info_schema.rb +234 -0
  23. data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +4 -2
  24. data/lib/rustici_software_cloud_v2/models/application_request_schema.rb +186 -0
  25. data/lib/rustici_software_cloud_v2/models/application_schema.rb +4 -2
  26. data/lib/rustici_software_cloud_v2/models/application_token.rb +4 -2
  27. data/lib/rustici_software_cloud_v2/models/asset_file_schema.rb +194 -0
  28. data/lib/rustici_software_cloud_v2/models/batch_tags_schema.rb +4 -2
  29. data/lib/rustici_software_cloud_v2/models/comment_schema.rb +4 -2
  30. data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +4 -2
  31. data/lib/rustici_software_cloud_v2/models/connector_list_schema.rb +188 -0
  32. data/lib/rustici_software_cloud_v2/models/connector_schema.rb +226 -0
  33. data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +7 -31
  34. data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +4 -2
  35. data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +5 -2
  36. data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +4 -2
  37. data/lib/rustici_software_cloud_v2/models/course_schema.rb +6 -30
  38. data/lib/rustici_software_cloud_v2/models/create_connector_schema.rb +218 -0
  39. data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +3 -20
  40. data/lib/rustici_software_cloud_v2/models/create_dispatch_list_schema.rb +4 -2
  41. data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +5 -3
  42. data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +5 -3
  43. data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +5 -3
  44. data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +4 -2
  45. data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +4 -2
  46. data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +4 -2
  47. data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +4 -2
  48. data/lib/rustici_software_cloud_v2/models/credential_schema.rb +4 -2
  49. data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +4 -2
  50. data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +5 -3
  51. data/lib/rustici_software_cloud_v2/models/destination_schema.rb +35 -6
  52. data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +4 -2
  53. data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +5 -2
  54. data/lib/rustici_software_cloud_v2/models/dispatch_lti13_info_schema.rb +186 -0
  55. data/lib/rustici_software_cloud_v2/models/dispatch_lti_info_schema.rb +221 -0
  56. data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +4 -2
  57. data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +44 -4
  58. data/lib/rustici_software_cloud_v2/models/enabled_schema.rb +4 -2
  59. data/lib/rustici_software_cloud_v2/models/file_list_item_schema.rb +205 -0
  60. data/lib/rustici_software_cloud_v2/models/file_list_schema.rb +187 -0
  61. data/lib/rustici_software_cloud_v2/models/import_asset_request_schema.rb +207 -0
  62. data/lib/rustici_software_cloud_v2/models/import_connector_request_schema.rb +207 -0
  63. data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +30 -7
  64. data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +6 -30
  65. data/lib/rustici_software_cloud_v2/models/import_media_file_reference_request_schema.rb +216 -0
  66. data/lib/rustici_software_cloud_v2/models/import_request_schema.rb +204 -0
  67. data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +4 -2
  68. data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +4 -2
  69. data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +4 -2
  70. data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +6 -30
  71. data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +5 -2
  72. data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +4 -2
  73. data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +4 -2
  74. data/lib/rustici_software_cloud_v2/models/launch_auth_options_schema.rb +4 -2
  75. data/lib/rustici_software_cloud_v2/models/launch_auth_schema.rb +6 -30
  76. data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +4 -2
  77. data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +9 -37
  78. data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +6 -4
  79. data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +4 -2
  80. data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +4 -2
  81. data/lib/rustici_software_cloud_v2/models/learner_schema.rb +4 -2
  82. data/lib/rustici_software_cloud_v2/models/lti13_platform_configuration_schema.rb +261 -0
  83. data/lib/rustici_software_cloud_v2/models/lti13_tool_configuration_schema.rb +236 -0
  84. data/lib/rustici_software_cloud_v2/models/media_file_metadata_schema.rb +213 -0
  85. data/lib/rustici_software_cloud_v2/models/message_schema.rb +4 -2
  86. data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +11 -9
  87. data/lib/rustici_software_cloud_v2/models/objective_schema.rb +12 -44
  88. data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +4 -2
  89. data/lib/rustici_software_cloud_v2/models/ping_schema.rb +4 -2
  90. data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +9 -37
  91. data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +5 -2
  92. data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +6 -4
  93. data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb +215 -0
  94. data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +5 -2
  95. data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +17 -6
  96. data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +228 -0
  97. data/lib/rustici_software_cloud_v2/models/registration_completion.rb +1 -1
  98. data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +5 -2
  99. data/lib/rustici_software_cloud_v2/models/registration_schema.rb +4 -2
  100. data/lib/rustici_software_cloud_v2/models/registration_success.rb +1 -1
  101. data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +4 -2
  102. data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +4 -2
  103. data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +4 -2
  104. data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +4 -2
  105. data/lib/rustici_software_cloud_v2/models/response_error.rb +4 -2
  106. data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +6 -30
  107. data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +9 -37
  108. data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +6 -30
  109. data/lib/rustici_software_cloud_v2/models/score_schema.rb +4 -2
  110. data/lib/rustici_software_cloud_v2/models/setting_item.rb +6 -30
  111. data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +4 -2
  112. data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +6 -30
  113. data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +4 -2
  114. data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +4 -2
  115. data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +4 -2
  116. data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +4 -2
  117. data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +4 -2
  118. data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +4 -2
  119. data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +4 -2
  120. data/lib/rustici_software_cloud_v2/models/title_schema.rb +4 -2
  121. data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +4 -2
  122. data/lib/rustici_software_cloud_v2/models/update_application_schema.rb +196 -0
  123. data/lib/rustici_software_cloud_v2/models/update_connector_schema.rb +196 -0
  124. data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +16 -4
  125. data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +5 -2
  126. data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +4 -2
  127. data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +4 -2
  128. data/lib/rustici_software_cloud_v2/models/xapi_account.rb +4 -2
  129. data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +4 -2
  130. data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +4 -2
  131. data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +6 -30
  132. data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +4 -2
  133. data/lib/rustici_software_cloud_v2/models/xapi_context.rb +4 -2
  134. data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +4 -2
  135. data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +6 -30
  136. data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +6 -30
  137. data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +4 -2
  138. data/lib/rustici_software_cloud_v2/models/xapi_credential_put_schema.rb +4 -2
  139. data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +4 -2
  140. data/lib/rustici_software_cloud_v2/models/xapi_credentials_list_schema.rb +5 -2
  141. data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +4 -2
  142. data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +4 -2
  143. data/lib/rustici_software_cloud_v2/models/xapi_result.rb +4 -2
  144. data/lib/rustici_software_cloud_v2/models/xapi_score.rb +4 -2
  145. data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +4 -2
  146. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +4 -2
  147. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +4 -2
  148. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_put_schema.rb +4 -2
  149. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +4 -2
  150. data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +4 -2
  151. data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +4 -2
  152. data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +4 -2
  153. data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +4 -2
  154. data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +14 -2
  155. data/lib/rustici_software_cloud_v2/version.rb +2 -2
  156. data/lib/rustici_software_cloud_v2.rb +23 -1
  157. data/rustici_software_cloud_v2.gemspec +3 -2
  158. data/spec/api_client_spec.rb +18 -1
  159. data/spec/configuration_spec.rb +1 -1
  160. data/spec/spec_helper.rb +1 -1
  161. metadata +45 -3
@@ -6,7 +6,7 @@
6
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.12
9
+ Swagger Codegen version: 2.4.27
10
10
 
11
11
  =end
12
12
 
@@ -19,35 +19,33 @@ module RusticiSoftwareCloudV2
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Get a link to preview a course.
23
- # 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).
24
24
  # @param course_id
25
25
  # @param launch_link_request
26
26
  # @param [Hash] opts the optional parameters
27
- # @option opts [String] :css_url
28
27
  # @return [LaunchLinkSchema]
29
28
  def build_course_preview_launch_link(course_id, launch_link_request, opts = {})
30
29
  data, _status_code, _headers = build_course_preview_launch_link_with_http_info(course_id, launch_link_request, opts)
31
30
  data
32
31
  end
33
32
 
34
- # Get a link to preview a course.
35
- # 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).
36
35
  # @param course_id
37
36
  # @param launch_link_request
38
37
  # @param [Hash] opts the optional parameters
39
- # @option opts [String] :css_url
40
38
  # @return [Array<(LaunchLinkSchema, Fixnum, Hash)>] LaunchLinkSchema data, response status code and response headers
41
39
  def build_course_preview_launch_link_with_http_info(course_id, launch_link_request, opts = {})
42
40
  if @api_client.config.debugging
43
41
  @api_client.config.logger.debug 'Calling API: CourseApi.build_course_preview_launch_link ...'
44
42
  end
45
43
  # verify the required parameter 'course_id' is set
46
- if @api_client.config.client_side_validation && course_id.nil?
44
+ if course_id.nil?
47
45
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.build_course_preview_launch_link"
48
46
  end
49
47
  # verify the required parameter 'launch_link_request' is set
50
- if @api_client.config.client_side_validation && launch_link_request.nil?
48
+ if launch_link_request.nil?
51
49
  fail ArgumentError, "Missing the required parameter 'launch_link_request' when calling CourseApi.build_course_preview_launch_link"
52
50
  end
53
51
  # resource path
@@ -55,7 +53,6 @@ module RusticiSoftwareCloudV2
55
53
 
56
54
  # query parameters
57
55
  query_params = {}
58
- query_params[:'cssUrl'] = opts[:'css_url'] if !opts[:'css_url'].nil?
59
56
 
60
57
  # header parameters
61
58
  header_params = {}
@@ -82,10 +79,10 @@ module RusticiSoftwareCloudV2
82
79
  end
83
80
  return data, status_code, headers
84
81
  end
85
- # Get a link to preview a particular course version.
86
- # Returns the link to use to preview a particular version of a 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).
87
84
  # @param course_id
88
- # @param version_id The course version
85
+ # @param version_id
89
86
  # @param launch_link_request
90
87
  # @param [Hash] opts the optional parameters
91
88
  # @return [LaunchLinkSchema]
@@ -94,10 +91,10 @@ module RusticiSoftwareCloudV2
94
91
  data
95
92
  end
96
93
 
97
- # Get a link to preview a particular course version.
98
- # Returns the link to use to preview a particular version of a 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).
99
96
  # @param course_id
100
- # @param version_id The course version
97
+ # @param version_id
101
98
  # @param launch_link_request
102
99
  # @param [Hash] opts the optional parameters
103
100
  # @return [Array<(LaunchLinkSchema, Fixnum, Hash)>] LaunchLinkSchema data, response status code and response headers
@@ -106,15 +103,15 @@ module RusticiSoftwareCloudV2
106
103
  @api_client.config.logger.debug 'Calling API: CourseApi.build_course_preview_launch_link_with_version ...'
107
104
  end
108
105
  # verify the required parameter 'course_id' is set
109
- if @api_client.config.client_side_validation && course_id.nil?
106
+ if course_id.nil?
110
107
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.build_course_preview_launch_link_with_version"
111
108
  end
112
109
  # verify the required parameter 'version_id' is set
113
- if @api_client.config.client_side_validation && version_id.nil?
110
+ if version_id.nil?
114
111
  fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.build_course_preview_launch_link_with_version"
115
112
  end
116
113
  # verify the required parameter 'launch_link_request' is set
117
- if @api_client.config.client_side_validation && launch_link_request.nil?
114
+ if launch_link_request.nil?
118
115
  fail ArgumentError, "Missing the required parameter 'launch_link_request' when calling CourseApi.build_course_preview_launch_link_with_version"
119
116
  end
120
117
  # resource path
@@ -148,8 +145,8 @@ module RusticiSoftwareCloudV2
148
145
  end
149
146
  return data, status_code, headers
150
147
  end
151
- # Fetch and import a course.
152
- # 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.
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.
153
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.
154
151
  # @param import_request
155
152
  # @param [Hash] opts the optional parameters
@@ -161,8 +158,8 @@ module RusticiSoftwareCloudV2
161
158
  data
162
159
  end
163
160
 
164
- # Fetch and import a course.
165
- # 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.
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.
166
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.
167
164
  # @param import_request
168
165
  # @param [Hash] opts the optional parameters
@@ -174,11 +171,11 @@ module RusticiSoftwareCloudV2
174
171
  @api_client.config.logger.debug 'Calling API: CourseApi.create_fetch_and_import_course_job ...'
175
172
  end
176
173
  # verify the required parameter 'course_id' is set
177
- if @api_client.config.client_side_validation && course_id.nil?
174
+ if course_id.nil?
178
175
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.create_fetch_and_import_course_job"
179
176
  end
180
177
  # verify the required parameter 'import_request' is set
181
- if @api_client.config.client_side_validation && import_request.nil?
178
+ if import_request.nil?
182
179
  fail ArgumentError, "Missing the required parameter 'import_request' when calling CourseApi.create_fetch_and_import_course_job"
183
180
  end
184
181
  # resource path
@@ -215,33 +212,104 @@ module RusticiSoftwareCloudV2
215
212
  end
216
213
  return data, status_code, headers
217
214
  end
218
- # Upload and import a course.
219
- # 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.
215
+ # Create a Course from a fetched or referenced external media file
216
+ # Creates a course from one of the following methods: fetchRequest, mediaFileReferenceRequest, or connectorReferenceRequest. In all cases, 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. - A connectorReferenceRequest is used to import content from an external content connector, for example an LTI 1.3 tool. >**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 the following methods: fetchRequest, mediaFileReferenceRequest, or connectorReferenceRequest. In all cases, 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. - A connectorReferenceRequest is used to import content from an external content connector, for example an LTI 1.3 tool. &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.
220
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.
221
285
  # @param [Hash] opts the optional parameters
222
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)
223
287
  # @option opts [String] :postback_url An optional parameter that specifies a URL to send a postback to when the course has finished uploading.
224
- # @option opts [File] :file The zip file of the course contents to import.
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.
225
291
  # @return [StringResultSchema]
226
292
  def create_upload_and_import_course_job(course_id, opts = {})
227
293
  data, _status_code, _headers = create_upload_and_import_course_job_with_http_info(course_id, opts)
228
294
  data
229
295
  end
230
296
 
231
- # Upload and import a course.
232
- # 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.
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.
233
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.
234
300
  # @param [Hash] opts the optional parameters
235
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.
236
302
  # @option opts [String] :postback_url An optional parameter that specifies a URL to send a postback to when the course has finished uploading.
237
- # @option opts [File] :file The zip file of the course contents to import.
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.
238
306
  # @return [Array<(StringResultSchema, Fixnum, Hash)>] StringResultSchema data, response status code and response headers
239
307
  def create_upload_and_import_course_job_with_http_info(course_id, opts = {})
240
308
  if @api_client.config.debugging
241
309
  @api_client.config.logger.debug 'Calling API: CourseApi.create_upload_and_import_course_job ...'
242
310
  end
243
311
  # verify the required parameter 'course_id' is set
244
- if @api_client.config.client_side_validation && course_id.nil?
312
+ if course_id.nil?
245
313
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.create_upload_and_import_course_job"
246
314
  end
247
315
  # resource path
@@ -259,9 +327,11 @@ module RusticiSoftwareCloudV2
259
327
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
260
328
  # HTTP header 'Content-Type'
261
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?
262
331
 
263
332
  # form parameters
264
333
  form_params = {}
334
+ form_params['contentMetadata'] = opts[:'content_metadata'] if !opts[:'content_metadata'].nil?
265
335
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
266
336
 
267
337
  # http body (model)
@@ -279,8 +349,8 @@ module RusticiSoftwareCloudV2
279
349
  end
280
350
  return data, status_code, headers
281
351
  end
282
- # Delete a course.
283
- # Delete course identified by `courseId`. When a course is deleted, so is everything connected to this course. This includes: - Registrations - Invitations - Dispatches - Debug Logs
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
284
354
  # @param course_id
285
355
  # @param [Hash] opts the optional parameters
286
356
  # @return [nil]
@@ -289,8 +359,8 @@ module RusticiSoftwareCloudV2
289
359
  nil
290
360
  end
291
361
 
292
- # Delete a course.
293
- # 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
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
294
364
  # @param course_id
295
365
  # @param [Hash] opts the optional parameters
296
366
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -299,7 +369,7 @@ module RusticiSoftwareCloudV2
299
369
  @api_client.config.logger.debug 'Calling API: CourseApi.delete_course ...'
300
370
  end
301
371
  # verify the required parameter 'course_id' is set
302
- if @api_client.config.client_side_validation && course_id.nil?
372
+ if course_id.nil?
303
373
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course"
304
374
  end
305
375
  # resource path
@@ -332,8 +402,68 @@ module RusticiSoftwareCloudV2
332
402
  end
333
403
  return data, status_code, headers
334
404
  end
335
- # Clear a course configuration.
336
- # 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.
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.
337
467
  # @param course_id
338
468
  # @param setting_id
339
469
  # @param [Hash] opts the optional parameters
@@ -343,8 +473,8 @@ module RusticiSoftwareCloudV2
343
473
  nil
344
474
  end
345
475
 
346
- # Clear a course configuration.
347
- # 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.
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.
348
478
  # @param course_id
349
479
  # @param setting_id
350
480
  # @param [Hash] opts the optional parameters
@@ -354,11 +484,11 @@ module RusticiSoftwareCloudV2
354
484
  @api_client.config.logger.debug 'Calling API: CourseApi.delete_course_configuration_setting ...'
355
485
  end
356
486
  # verify the required parameter 'course_id' is set
357
- if @api_client.config.client_side_validation && course_id.nil?
487
+ if course_id.nil?
358
488
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_configuration_setting"
359
489
  end
360
490
  # verify the required parameter 'setting_id' is set
361
- if @api_client.config.client_side_validation && setting_id.nil?
491
+ if setting_id.nil?
362
492
  fail ArgumentError, "Missing the required parameter 'setting_id' when calling CourseApi.delete_course_configuration_setting"
363
493
  end
364
494
  # resource path
@@ -391,8 +521,8 @@ module RusticiSoftwareCloudV2
391
521
  end
392
522
  return data, status_code, headers
393
523
  end
394
- # Delete course tags.
395
- # Delete the provided tags from 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.
396
526
  # @param course_id
397
527
  # @param tags
398
528
  # @param [Hash] opts the optional parameters
@@ -402,8 +532,8 @@ module RusticiSoftwareCloudV2
402
532
  nil
403
533
  end
404
534
 
405
- # Delete course tags.
406
- # Delete the provided tags from 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.
407
537
  # @param course_id
408
538
  # @param tags
409
539
  # @param [Hash] opts the optional parameters
@@ -413,11 +543,11 @@ module RusticiSoftwareCloudV2
413
543
  @api_client.config.logger.debug 'Calling API: CourseApi.delete_course_tags ...'
414
544
  end
415
545
  # verify the required parameter 'course_id' is set
416
- if @api_client.config.client_side_validation && course_id.nil?
546
+ if course_id.nil?
417
547
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_tags"
418
548
  end
419
549
  # verify the required parameter 'tags' is set
420
- if @api_client.config.client_side_validation && tags.nil?
550
+ if tags.nil?
421
551
  fail ArgumentError, "Missing the required parameter 'tags' when calling CourseApi.delete_course_tags"
422
552
  end
423
553
  # resource path
@@ -450,10 +580,10 @@ module RusticiSoftwareCloudV2
450
580
  end
451
581
  return data, status_code, headers
452
582
  end
453
- # Delete a course version.
454
- # Delete `versionId` of `courseId`. If this is the last remaining version of this course, the course itself will be deleted and no longer accessible.
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
455
585
  # @param course_id
456
- # @param version_id The course version
586
+ # @param version_id
457
587
  # @param [Hash] opts the optional parameters
458
588
  # @return [nil]
459
589
  def delete_course_version(course_id, version_id, opts = {})
@@ -461,10 +591,10 @@ module RusticiSoftwareCloudV2
461
591
  nil
462
592
  end
463
593
 
464
- # Delete a course version.
465
- # 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.
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
466
596
  # @param course_id
467
- # @param version_id The course version
597
+ # @param version_id
468
598
  # @param [Hash] opts the optional parameters
469
599
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
470
600
  def delete_course_version_with_http_info(course_id, version_id, opts = {})
@@ -472,11 +602,11 @@ module RusticiSoftwareCloudV2
472
602
  @api_client.config.logger.debug 'Calling API: CourseApi.delete_course_version ...'
473
603
  end
474
604
  # verify the required parameter 'course_id' is set
475
- if @api_client.config.client_side_validation && course_id.nil?
605
+ if course_id.nil?
476
606
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_version"
477
607
  end
478
608
  # verify the required parameter 'version_id' is set
479
- if @api_client.config.client_side_validation && version_id.nil?
609
+ if version_id.nil?
480
610
  fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.delete_course_version"
481
611
  end
482
612
  # resource path
@@ -509,10 +639,76 @@ module RusticiSoftwareCloudV2
509
639
  end
510
640
  return data, status_code, headers
511
641
  end
512
- # Clear a configuration setting for a version of a course.
513
- # 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.
514
710
  # @param course_id
515
- # @param version_id The course version
711
+ # @param version_id
516
712
  # @param setting_id
517
713
  # @param [Hash] opts the optional parameters
518
714
  # @return [nil]
@@ -521,10 +717,10 @@ module RusticiSoftwareCloudV2
521
717
  nil
522
718
  end
523
719
 
524
- # Clear a configuration setting for a version of a course.
525
- # 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.
526
722
  # @param course_id
527
- # @param version_id The course version
723
+ # @param version_id
528
724
  # @param setting_id
529
725
  # @param [Hash] opts the optional parameters
530
726
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -533,15 +729,15 @@ module RusticiSoftwareCloudV2
533
729
  @api_client.config.logger.debug 'Calling API: CourseApi.delete_course_version_configuration_setting ...'
534
730
  end
535
731
  # verify the required parameter 'course_id' is set
536
- if @api_client.config.client_side_validation && course_id.nil?
732
+ if course_id.nil?
537
733
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.delete_course_version_configuration_setting"
538
734
  end
539
735
  # verify the required parameter 'version_id' is set
540
- if @api_client.config.client_side_validation && version_id.nil?
736
+ if version_id.nil?
541
737
  fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.delete_course_version_configuration_setting"
542
738
  end
543
739
  # verify the required parameter 'setting_id' is set
544
- if @api_client.config.client_side_validation && setting_id.nil?
740
+ if setting_id.nil?
545
741
  fail ArgumentError, "Missing the required parameter 'setting_id' when calling CourseApi.delete_course_version_configuration_setting"
546
742
  end
547
743
  # resource path
@@ -574,8 +770,8 @@ module RusticiSoftwareCloudV2
574
770
  end
575
771
  return data, status_code, headers
576
772
  end
577
- # Get course details.
578
- # Get detailed information about `courseId`. Futher detail can be obtained with the optional query parameters flags.
773
+ # Get detailed information about a Course
774
+ # Returns detailed information about the course. This includes title, update date, learning standard, and version.
579
775
  # @param course_id
580
776
  # @param [Hash] opts the optional parameters
581
777
  # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
@@ -586,8 +782,8 @@ module RusticiSoftwareCloudV2
586
782
  data
587
783
  end
588
784
 
589
- # Get course details.
590
- # Get detailed information about &#x60;courseId&#x60;. Futher detail can be obtained with the optional query parameters flags.
785
+ # Get detailed information about a Course
786
+ # Returns detailed information about the course. This includes title, update date, learning standard, and version.
591
787
  # @param course_id
592
788
  # @param [Hash] opts the optional parameters
593
789
  # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
@@ -598,7 +794,7 @@ module RusticiSoftwareCloudV2
598
794
  @api_client.config.logger.debug 'Calling API: CourseApi.get_course ...'
599
795
  end
600
796
  # verify the required parameter 'course_id' is set
601
- if @api_client.config.client_side_validation && course_id.nil?
797
+ if course_id.nil?
602
798
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course"
603
799
  end
604
800
  # resource path
@@ -634,8 +830,69 @@ module RusticiSoftwareCloudV2
634
830
  end
635
831
  return data, status_code, headers
636
832
  end
637
- # Get course configuration.
638
- # 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.
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.
639
896
  # @param course_id
640
897
  # @param [Hash] opts the optional parameters
641
898
  # @option opts [BOOLEAN] :include_metadata (default to false)
@@ -645,8 +902,8 @@ module RusticiSoftwareCloudV2
645
902
  data
646
903
  end
647
904
 
648
- # Get course configuration.
649
- # 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.
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.
650
907
  # @param course_id
651
908
  # @param [Hash] opts the optional parameters
652
909
  # @option opts [BOOLEAN] :include_metadata
@@ -656,7 +913,7 @@ module RusticiSoftwareCloudV2
656
913
  @api_client.config.logger.debug 'Calling API: CourseApi.get_course_configuration ...'
657
914
  end
658
915
  # verify the required parameter 'course_id' is set
659
- if @api_client.config.client_side_validation && course_id.nil?
916
+ if course_id.nil?
660
917
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_configuration"
661
918
  end
662
919
  # resource path
@@ -691,35 +948,89 @@ module RusticiSoftwareCloudV2
691
948
  end
692
949
  return data, status_code, headers
693
950
  end
694
- # Get course xAPI statements.
695
- # 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.
696
1007
  # @param course_id
697
1008
  # @param [Hash] opts the optional parameters
698
1009
  # @option opts [String] :learner_id Only entries for the specified learner id will be included.
699
- # @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.
700
- # @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.
701
- # @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
702
1013
  # @return [XapiStatementResult]
703
1014
  def get_course_statements(course_id, opts = {})
704
1015
  data, _status_code, _headers = get_course_statements_with_http_info(course_id, opts)
705
1016
  data
706
1017
  end
707
1018
 
708
- # Get course xAPI statements.
709
- # Get xAPI statements for &#x60;courseId&#x60;.
1019
+ # Get xAPI statements for a Course
1020
+ # Returns xAPI statements for the course.
710
1021
  # @param course_id
711
1022
  # @param [Hash] opts the optional parameters
712
1023
  # @option opts [String] :learner_id Only entries for the specified learner id will be included.
713
- # @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.
714
- # @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.
715
- # @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
716
1027
  # @return [Array<(XapiStatementResult, Fixnum, Hash)>] XapiStatementResult data, response status code and response headers
717
1028
  def get_course_statements_with_http_info(course_id, opts = {})
718
1029
  if @api_client.config.debugging
719
1030
  @api_client.config.logger.debug 'Calling API: CourseApi.get_course_statements ...'
720
1031
  end
721
1032
  # verify the required parameter 'course_id' is set
722
- if @api_client.config.client_side_validation && course_id.nil?
1033
+ if course_id.nil?
723
1034
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_statements"
724
1035
  end
725
1036
  # resource path
@@ -757,8 +1068,8 @@ module RusticiSoftwareCloudV2
757
1068
  end
758
1069
  return data, status_code, headers
759
1070
  end
760
- # Get course tags.
761
- # Get a list of the tags for this course.
1071
+ # Get tags for a Course
1072
+ # Returns the tags for the course.
762
1073
  # @param course_id
763
1074
  # @param [Hash] opts the optional parameters
764
1075
  # @return [TagListSchema]
@@ -767,8 +1078,8 @@ module RusticiSoftwareCloudV2
767
1078
  data
768
1079
  end
769
1080
 
770
- # Get course tags.
771
- # Get a list of the tags for this course.
1081
+ # Get tags for a Course
1082
+ # Returns the tags for the course.
772
1083
  # @param course_id
773
1084
  # @param [Hash] opts the optional parameters
774
1085
  # @return [Array<(TagListSchema, Fixnum, Hash)>] TagListSchema data, response status code and response headers
@@ -777,7 +1088,7 @@ module RusticiSoftwareCloudV2
777
1088
  @api_client.config.logger.debug 'Calling API: CourseApi.get_course_tags ...'
778
1089
  end
779
1090
  # verify the required parameter 'course_id' is set
780
- if @api_client.config.client_side_validation && course_id.nil?
1091
+ if course_id.nil?
781
1092
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_tags"
782
1093
  end
783
1094
  # resource path
@@ -811,48 +1122,52 @@ module RusticiSoftwareCloudV2
811
1122
  end
812
1123
  return data, status_code, headers
813
1124
  end
814
- # Get configuration for a version of a course.
815
- # 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.
816
1127
  # @param course_id
817
- # @param version_id The course version
1128
+ # @param version_id
1129
+ # @param relative_path Relative path of the asset within the course.
818
1130
  # @param [Hash] opts the optional parameters
819
- # @option opts [BOOLEAN] :include_metadata (default to false)
820
- # @return [SettingListSchema]
821
- def get_course_version_configuration(course_id, version_id, opts = {})
822
- data, _status_code, _headers = get_course_version_configuration_with_http_info(course_id, version_id, opts)
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)
823
1134
  data
824
1135
  end
825
1136
 
826
- # Get configuration for a version of a course.
827
- # Returns all configuration settings for this course and version.
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.
828
1139
  # @param course_id
829
- # @param version_id The course version
1140
+ # @param version_id
1141
+ # @param relative_path Relative path of the asset within the course.
830
1142
  # @param [Hash] opts the optional parameters
831
- # @option opts [BOOLEAN] :include_metadata
832
- # @return [Array<(SettingListSchema, Fixnum, Hash)>] SettingListSchema data, response status code and response headers
833
- def get_course_version_configuration_with_http_info(course_id, version_id, opts = {})
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 = {})
834
1145
  if @api_client.config.debugging
835
- @api_client.config.logger.debug 'Calling API: CourseApi.get_course_version_configuration ...'
1146
+ @api_client.config.logger.debug 'Calling API: CourseApi.get_course_version_asset ...'
836
1147
  end
837
1148
  # verify the required parameter 'course_id' is set
838
- if @api_client.config.client_side_validation && course_id.nil?
839
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_configuration"
1149
+ if course_id.nil?
1150
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_asset"
840
1151
  end
841
1152
  # verify the required parameter 'version_id' is set
842
- if @api_client.config.client_side_validation && version_id.nil?
843
- fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_course_version_configuration"
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"
844
1159
  end
845
1160
  # resource path
846
- local_var_path = '/courses/{courseId}/versions/{versionId}/configuration'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
1161
+ local_var_path = '/courses/{courseId}/versions/{versionId}/asset'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
847
1162
 
848
1163
  # query parameters
849
1164
  query_params = {}
850
- query_params[:'includeMetadata'] = opts[:'include_metadata'] if !opts[:'include_metadata'].nil?
1165
+ query_params[:'relativePath'] = relative_path
851
1166
 
852
1167
  # header parameters
853
1168
  header_params = {}
854
1169
  # HTTP header 'Accept' (if needed)
855
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1170
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
856
1171
  # HTTP header 'Content-Type'
857
1172
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
858
1173
 
@@ -868,47 +1183,170 @@ module RusticiSoftwareCloudV2
868
1183
  :form_params => form_params,
869
1184
  :body => post_body,
870
1185
  :auth_names => auth_names,
871
- :return_type => 'SettingListSchema')
1186
+ :return_type => 'File')
872
1187
  if @api_client.config.debugging
873
- @api_client.config.logger.debug "API called: CourseApi#get_course_version_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1188
+ @api_client.config.logger.debug "API called: CourseApi#get_course_version_asset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
874
1189
  end
875
1190
  return data, status_code, headers
876
1191
  end
877
- # Get details on a course version.
878
- # Get specific version `versionId` of `courseId`
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.
879
1194
  # @param course_id
880
- # @param version_id The course version
1195
+ # @param version_id
881
1196
  # @param [Hash] opts the optional parameters
882
- # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
883
- # @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)
884
- # @return [CourseSchema]
885
- def get_course_version_info(course_id, version_id, opts = {})
886
- data, _status_code, _headers = get_course_version_info_with_http_info(course_id, version_id, opts)
1197
+ # @option opts [BOOLEAN] :include_metadata (default to false)
1198
+ # @return [SettingListSchema]
1199
+ def get_course_version_configuration(course_id, version_id, opts = {})
1200
+ data, _status_code, _headers = get_course_version_configuration_with_http_info(course_id, version_id, opts)
887
1201
  data
888
1202
  end
889
1203
 
890
- # Get details on a course version.
891
- # Get specific version &#x60;versionId&#x60; of &#x60;courseId&#x60;
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.
892
1206
  # @param course_id
893
- # @param version_id The course version
1207
+ # @param version_id
894
1208
  # @param [Hash] opts the optional parameters
895
- # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
896
- # @option opts [BOOLEAN] :include_course_metadata Include course metadata in the results. If the course has no metadata, adding this parameter has no effect.
897
- # @return [Array<(CourseSchema, Fixnum, Hash)>] CourseSchema data, response status code and response headers
898
- def get_course_version_info_with_http_info(course_id, version_id, opts = {})
1209
+ # @option opts [BOOLEAN] :include_metadata
1210
+ # @return [Array<(SettingListSchema, Fixnum, Hash)>] SettingListSchema data, response status code and response headers
1211
+ def get_course_version_configuration_with_http_info(course_id, version_id, opts = {})
899
1212
  if @api_client.config.debugging
900
- @api_client.config.logger.debug 'Calling API: CourseApi.get_course_version_info ...'
1213
+ @api_client.config.logger.debug 'Calling API: CourseApi.get_course_version_configuration ...'
901
1214
  end
902
1215
  # verify the required parameter 'course_id' is set
903
- if @api_client.config.client_side_validation && course_id.nil?
904
- fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_info"
1216
+ if course_id.nil?
1217
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_configuration"
905
1218
  end
906
1219
  # verify the required parameter 'version_id' is set
907
- if @api_client.config.client_side_validation && version_id.nil?
908
- fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_course_version_info"
1220
+ if version_id.nil?
1221
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_course_version_configuration"
909
1222
  end
910
1223
  # resource path
911
- local_var_path = '/courses/{courseId}/versions/{versionId}'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
1224
+ local_var_path = '/courses/{courseId}/versions/{versionId}/configuration'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
1225
+
1226
+ # query parameters
1227
+ query_params = {}
1228
+ query_params[:'includeMetadata'] = opts[:'include_metadata'] if !opts[:'include_metadata'].nil?
1229
+
1230
+ # header parameters
1231
+ header_params = {}
1232
+ # HTTP header 'Accept' (if needed)
1233
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1234
+ # HTTP header 'Content-Type'
1235
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1236
+
1237
+ # form parameters
1238
+ form_params = {}
1239
+
1240
+ # http body (model)
1241
+ post_body = nil
1242
+ auth_names = ['APP_NORMAL', 'OAUTH']
1243
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1244
+ :header_params => header_params,
1245
+ :query_params => query_params,
1246
+ :form_params => form_params,
1247
+ :body => post_body,
1248
+ :auth_names => auth_names,
1249
+ :return_type => 'SettingListSchema')
1250
+ if @api_client.config.debugging
1251
+ @api_client.config.logger.debug "API called: CourseApi#get_course_version_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1252
+ end
1253
+ return data, status_code, headers
1254
+ end
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).
1317
+ # @param course_id
1318
+ # @param version_id
1319
+ # @param [Hash] opts the optional parameters
1320
+ # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
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)
1322
+ # @return [CourseSchema]
1323
+ def get_course_version_info(course_id, version_id, opts = {})
1324
+ data, _status_code, _headers = get_course_version_info_with_http_info(course_id, version_id, opts)
1325
+ data
1326
+ end
1327
+
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).
1330
+ # @param course_id
1331
+ # @param version_id
1332
+ # @param [Hash] opts the optional parameters
1333
+ # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
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.
1335
+ # @return [Array<(CourseSchema, Fixnum, Hash)>] CourseSchema data, response status code and response headers
1336
+ def get_course_version_info_with_http_info(course_id, version_id, opts = {})
1337
+ if @api_client.config.debugging
1338
+ @api_client.config.logger.debug 'Calling API: CourseApi.get_course_version_info ...'
1339
+ end
1340
+ # verify the required parameter 'course_id' is set
1341
+ if course_id.nil?
1342
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_info"
1343
+ end
1344
+ # verify the required parameter 'version_id' is set
1345
+ if version_id.nil?
1346
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_course_version_info"
1347
+ end
1348
+ # resource path
1349
+ local_var_path = '/courses/{courseId}/versions/{versionId}'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
912
1350
 
913
1351
  # query parameters
914
1352
  query_params = {}
@@ -940,41 +1378,41 @@ module RusticiSoftwareCloudV2
940
1378
  end
941
1379
  return data, status_code, headers
942
1380
  end
943
- # Get xAPI statements for a course version.
944
- # Get xAPI statements for version `versionId` of `courseId`
1381
+ # Get xAPI statements for a Course Version
1382
+ # Returns xAPI statements for the course version.
945
1383
  # @param course_id
946
- # @param version_id The course version
1384
+ # @param version_id
947
1385
  # @param [Hash] opts the optional parameters
948
1386
  # @option opts [String] :learner_id Only entries for the specified learner id will be included.
949
- # @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.
950
- # @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.
951
- # @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
952
1390
  # @return [XapiStatementResult]
953
1391
  def get_course_version_statements(course_id, version_id, opts = {})
954
1392
  data, _status_code, _headers = get_course_version_statements_with_http_info(course_id, version_id, opts)
955
1393
  data
956
1394
  end
957
1395
 
958
- # Get xAPI statements for a course version.
959
- # 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.
960
1398
  # @param course_id
961
- # @param version_id The course version
1399
+ # @param version_id
962
1400
  # @param [Hash] opts the optional parameters
963
1401
  # @option opts [String] :learner_id Only entries for the specified learner id will be included.
964
- # @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.
965
- # @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.
966
- # @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
967
1405
  # @return [Array<(XapiStatementResult, Fixnum, Hash)>] XapiStatementResult data, response status code and response headers
968
1406
  def get_course_version_statements_with_http_info(course_id, version_id, opts = {})
969
1407
  if @api_client.config.debugging
970
1408
  @api_client.config.logger.debug 'Calling API: CourseApi.get_course_version_statements ...'
971
1409
  end
972
1410
  # verify the required parameter 'course_id' is set
973
- if @api_client.config.client_side_validation && course_id.nil?
1411
+ if course_id.nil?
974
1412
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_version_statements"
975
1413
  end
976
1414
  # verify the required parameter 'version_id' is set
977
- if @api_client.config.client_side_validation && version_id.nil?
1415
+ if version_id.nil?
978
1416
  fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_course_version_statements"
979
1417
  end
980
1418
  # resource path
@@ -1012,12 +1450,12 @@ module RusticiSoftwareCloudV2
1012
1450
  end
1013
1451
  return data, status_code, headers
1014
1452
  end
1015
- # Get details on a course's versions.
1016
- # 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.
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.
1017
1455
  # @param course_id
1018
1456
  # @param [Hash] opts the optional parameters
1019
- # @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.
1020
- # @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)
1021
1459
  # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
1022
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)
1023
1461
  # @return [CourseListNonPagedSchema]
@@ -1026,12 +1464,12 @@ module RusticiSoftwareCloudV2
1026
1464
  data
1027
1465
  end
1028
1466
 
1029
- # Get details on a course&#39;s versions.
1030
- # 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.
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.
1031
1469
  # @param course_id
1032
1470
  # @param [Hash] opts the optional parameters
1033
- # @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.
1034
- # @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)
1035
1473
  # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
1036
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.
1037
1475
  # @return [Array<(CourseListNonPagedSchema, Fixnum, Hash)>] CourseListNonPagedSchema data, response status code and response headers
@@ -1040,7 +1478,7 @@ module RusticiSoftwareCloudV2
1040
1478
  @api_client.config.logger.debug 'Calling API: CourseApi.get_course_versions ...'
1041
1479
  end
1042
1480
  # verify the required parameter 'course_id' is set
1043
- if @api_client.config.client_side_validation && course_id.nil?
1481
+ if course_id.nil?
1044
1482
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_versions"
1045
1483
  end
1046
1484
  # resource path
@@ -1078,61 +1516,112 @@ module RusticiSoftwareCloudV2
1078
1516
  end
1079
1517
  return data, status_code, headers
1080
1518
  end
1081
- # Get all courses.
1082
- # Get all courses for the `appId` which was used to authenticate this call.
1519
+ # Download a zip package for a Course
1520
+ # Downloads a zip package for the course. The course zip package contains all of the files (assets) needed for a learner to take the course. The returned zip will contain all of the files orginally uploaded with the course, as well as any modifications made through updating/ adding new assets. >**Info:** >If looking to retrieve a specific file from a course, use `GetCourseAsset` instead.
1521
+ # @param course_id
1083
1522
  # @param [Hash] opts the optional parameters
1084
- # @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.
1085
- # @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.
1086
- # @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.
1523
+ # @return [File]
1524
+ def get_course_zip(course_id, opts = {})
1525
+ data, _status_code, _headers = get_course_zip_with_http_info(course_id, opts)
1526
+ data
1527
+ end
1528
+
1529
+ # Download a zip package for a Course
1530
+ # Downloads a zip package for the course. The course zip package contains all of the files (assets) needed for a learner to take the course. The returned zip will contain all of the files orginally uploaded with the course, as well as any modifications made through updating/ adding new assets. &gt;**Info:** &gt;If looking to retrieve a specific file from a course, use &#x60;GetCourseAsset&#x60; instead.
1531
+ # @param course_id
1532
+ # @param [Hash] opts the optional parameters
1533
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
1534
+ def get_course_zip_with_http_info(course_id, opts = {})
1535
+ if @api_client.config.debugging
1536
+ @api_client.config.logger.debug 'Calling API: CourseApi.get_course_zip ...'
1537
+ end
1538
+ # verify the required parameter 'course_id' is set
1539
+ if course_id.nil?
1540
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_zip"
1541
+ end
1542
+ # resource path
1543
+ local_var_path = '/courses/{courseId}/zip'.sub('{' + 'courseId' + '}', course_id.to_s)
1544
+
1545
+ # query parameters
1546
+ query_params = {}
1547
+
1548
+ # header parameters
1549
+ header_params = {}
1550
+ # HTTP header 'Accept' (if needed)
1551
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1552
+ # HTTP header 'Content-Type'
1553
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1554
+
1555
+ # form parameters
1556
+ form_params = {}
1557
+
1558
+ # http body (model)
1559
+ post_body = nil
1560
+ auth_names = ['APP_NORMAL', 'OAUTH']
1561
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1562
+ :header_params => header_params,
1563
+ :query_params => query_params,
1564
+ :form_params => form_params,
1565
+ :body => post_body,
1566
+ :auth_names => auth_names,
1567
+ :return_type => 'File')
1568
+ if @api_client.config.debugging
1569
+ @api_client.config.logger.debug "API called: CourseApi#get_course_zip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1570
+ end
1571
+ return data, status_code, headers
1572
+ end
1573
+ # Get a list of Courses
1574
+ # 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.
1575
+ # @param [Hash] opts the optional parameters
1576
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1577
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1578
+ # @option opts [String] :datetime_filter Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against (default to updated)
1579
+ # @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
1087
1580
  # @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
1088
- # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. Defaults to course_id.
1089
- # @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.
1090
- # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
1581
+ # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to course_id)
1582
+ # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to created_desc)
1583
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
1091
1584
  # @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)
1092
- # @option opts [Array<String>] :tags
1585
+ # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
1093
1586
  # @return [CourseListSchema]
1094
1587
  def get_courses(opts = {})
1095
1588
  data, _status_code, _headers = get_courses_with_http_info(opts)
1096
1589
  data
1097
1590
  end
1098
1591
 
1099
- # Get all courses.
1100
- # Get all courses for the &#x60;appId&#x60; which was used to authenticate this call.
1592
+ # Get a list of Courses
1593
+ # 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.
1101
1594
  # @param [Hash] opts the optional parameters
1102
- # @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.
1103
- # @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.
1104
- # @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.
1595
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1596
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1597
+ # @option opts [String] :datetime_filter Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against
1598
+ # @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
1105
1599
  # @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
1106
- # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. Defaults to course_id.
1107
- # @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.
1108
- # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
1600
+ # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
1601
+ # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
1602
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
1109
1603
  # @option opts [BOOLEAN] :include_course_metadata Include course metadata in the results. If the course has no metadata, adding this parameter has no effect.
1110
- # @option opts [Array<String>] :tags
1604
+ # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
1111
1605
  # @return [Array<(CourseListSchema, Fixnum, Hash)>] CourseListSchema data, response status code and response headers
1112
1606
  def get_courses_with_http_info(opts = {})
1113
1607
  if @api_client.config.debugging
1114
1608
  @api_client.config.logger.debug 'Calling API: CourseApi.get_courses ...'
1115
1609
  end
1116
- if @api_client.config.client_side_validation && opts[:'filter_by'] && !['title', 'course_id', 'tags'].include?(opts[:'filter_by'])
1117
- fail ArgumentError, 'invalid value for "filter_by", must be one of title, course_id, tags'
1118
- end
1119
- if @api_client.config.client_side_validation && opts[:'order_by'] && !['title_asc', 'title_desc', 'creation_date_asc', 'creation_date_desc'].include?(opts[:'order_by'])
1120
- fail ArgumentError, 'invalid value for "order_by", must be one of title_asc, title_desc, creation_date_asc, creation_date_desc'
1121
- end
1122
1610
  # resource path
1123
1611
  local_var_path = '/courses'
1124
1612
 
1125
1613
  # query parameters
1126
1614
  query_params = {}
1127
- query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
1128
1615
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1129
1616
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
1617
+ query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
1618
+ query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
1130
1619
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
1131
1620
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
1132
1621
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
1133
- query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].nil?
1622
+ query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
1134
1623
  query_params[:'includeCourseMetadata'] = opts[:'include_course_metadata'] if !opts[:'include_course_metadata'].nil?
1135
- query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
1624
+ query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].nil?
1136
1625
 
1137
1626
  # header parameters
1138
1627
  header_params = {}
@@ -1159,8 +1648,8 @@ module RusticiSoftwareCloudV2
1159
1648
  end
1160
1649
  return data, status_code, headers
1161
1650
  end
1162
- # Get course import job status.
1163
- # 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.
1651
+ # Get import job status for a Course
1652
+ # 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.
1164
1653
  # @param import_job_id Id received when the import job was submitted to the importJobs resource.
1165
1654
  # @param [Hash] opts the optional parameters
1166
1655
  # @return [ImportJobResultSchema]
@@ -1169,8 +1658,8 @@ module RusticiSoftwareCloudV2
1169
1658
  data
1170
1659
  end
1171
1660
 
1172
- # Get course import job status.
1173
- # 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.
1661
+ # Get import job status for a Course
1662
+ # 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.
1174
1663
  # @param import_job_id Id received when the import job was submitted to the importJobs resource.
1175
1664
  # @param [Hash] opts the optional parameters
1176
1665
  # @return [Array<(ImportJobResultSchema, Fixnum, Hash)>] ImportJobResultSchema data, response status code and response headers
@@ -1179,7 +1668,7 @@ module RusticiSoftwareCloudV2
1179
1668
  @api_client.config.logger.debug 'Calling API: CourseApi.get_import_job_status ...'
1180
1669
  end
1181
1670
  # verify the required parameter 'import_job_id' is set
1182
- if @api_client.config.client_side_validation && import_job_id.nil?
1671
+ if import_job_id.nil?
1183
1672
  fail ArgumentError, "Missing the required parameter 'import_job_id' when calling CourseApi.get_import_job_status"
1184
1673
  end
1185
1674
  # resource path
@@ -1213,8 +1702,200 @@ module RusticiSoftwareCloudV2
1213
1702
  end
1214
1703
  return data, status_code, headers
1215
1704
  end
1216
- # Set course tags.
1217
- # Set the tags for this course. Note: any tags currently on this course will be overwritten with the new array of tags.
1705
+ # Download a zip package for a Course Version
1706
+ # Downloads a zip package for the course version. The course zip package contains all of the files (assets) needed for a learner to take the course. The returned zip will contain all of the files orginally uploaded with the course, as well as any modifications made through updating/ adding new assets. >**Info:** >If looking to retrieve a specific file from a course version, use `GetCourseVersionAsset` instead.
1707
+ # @param course_id
1708
+ # @param version_id
1709
+ # @param [Hash] opts the optional parameters
1710
+ # @return [File]
1711
+ def get_versioned_course_zip(course_id, version_id, opts = {})
1712
+ data, _status_code, _headers = get_versioned_course_zip_with_http_info(course_id, version_id, opts)
1713
+ data
1714
+ end
1715
+
1716
+ # Download a zip package for a Course Version
1717
+ # Downloads a zip package for the course version. The course zip package contains all of the files (assets) needed for a learner to take the course. The returned zip will contain all of the files orginally uploaded with the course, as well as any modifications made through updating/ adding new assets. &gt;**Info:** &gt;If looking to retrieve a specific file from a course version, use &#x60;GetCourseVersionAsset&#x60; instead.
1718
+ # @param course_id
1719
+ # @param version_id
1720
+ # @param [Hash] opts the optional parameters
1721
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
1722
+ def get_versioned_course_zip_with_http_info(course_id, version_id, opts = {})
1723
+ if @api_client.config.debugging
1724
+ @api_client.config.logger.debug 'Calling API: CourseApi.get_versioned_course_zip ...'
1725
+ end
1726
+ # verify the required parameter 'course_id' is set
1727
+ if course_id.nil?
1728
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_versioned_course_zip"
1729
+ end
1730
+ # verify the required parameter 'version_id' is set
1731
+ if version_id.nil?
1732
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_versioned_course_zip"
1733
+ end
1734
+ # resource path
1735
+ local_var_path = '/courses/{courseId}/versions/{versionId}/zip'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
1736
+
1737
+ # query parameters
1738
+ query_params = {}
1739
+
1740
+ # header parameters
1741
+ header_params = {}
1742
+ # HTTP header 'Accept' (if needed)
1743
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1744
+ # HTTP header 'Content-Type'
1745
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1746
+
1747
+ # form parameters
1748
+ form_params = {}
1749
+
1750
+ # http body (model)
1751
+ post_body = nil
1752
+ auth_names = ['APP_NORMAL', 'OAUTH']
1753
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1754
+ :header_params => header_params,
1755
+ :query_params => query_params,
1756
+ :form_params => form_params,
1757
+ :body => post_body,
1758
+ :auth_names => auth_names,
1759
+ :return_type => 'File')
1760
+ if @api_client.config.debugging
1761
+ @api_client.config.logger.debug "API called: CourseApi#get_versioned_course_zip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1762
+ end
1763
+ return data, status_code, headers
1764
+ end
1765
+ # Import an asset file for a Course
1766
+ # 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`.
1767
+ # @param course_id
1768
+ # @param asset_schema
1769
+ # @param [Hash] opts the optional parameters
1770
+ # @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)
1771
+ # @return [AssetFileSchema]
1772
+ def import_course_asset_file(course_id, asset_schema, opts = {})
1773
+ data, _status_code, _headers = import_course_asset_file_with_http_info(course_id, asset_schema, opts)
1774
+ data
1775
+ end
1776
+
1777
+ # Import an asset file for a Course
1778
+ # 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;.
1779
+ # @param course_id
1780
+ # @param asset_schema
1781
+ # @param [Hash] opts the optional parameters
1782
+ # @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).
1783
+ # @return [Array<(AssetFileSchema, Fixnum, Hash)>] AssetFileSchema data, response status code and response headers
1784
+ def import_course_asset_file_with_http_info(course_id, asset_schema, opts = {})
1785
+ if @api_client.config.debugging
1786
+ @api_client.config.logger.debug 'Calling API: CourseApi.import_course_asset_file ...'
1787
+ end
1788
+ # verify the required parameter 'course_id' is set
1789
+ if course_id.nil?
1790
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.import_course_asset_file"
1791
+ end
1792
+ # verify the required parameter 'asset_schema' is set
1793
+ if asset_schema.nil?
1794
+ fail ArgumentError, "Missing the required parameter 'asset_schema' when calling CourseApi.import_course_asset_file"
1795
+ end
1796
+ # resource path
1797
+ local_var_path = '/courses/{courseId}/asset'.sub('{' + 'courseId' + '}', course_id.to_s)
1798
+
1799
+ # query parameters
1800
+ query_params = {}
1801
+ query_params[:'updateAssetPolicy'] = opts[:'update_asset_policy'] if !opts[:'update_asset_policy'].nil?
1802
+
1803
+ # header parameters
1804
+ header_params = {}
1805
+ # HTTP header 'Accept' (if needed)
1806
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1807
+ # HTTP header 'Content-Type'
1808
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1809
+
1810
+ # form parameters
1811
+ form_params = {}
1812
+
1813
+ # http body (model)
1814
+ post_body = @api_client.object_to_http_body(asset_schema)
1815
+ auth_names = ['APP_NORMAL', 'OAUTH']
1816
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1817
+ :header_params => header_params,
1818
+ :query_params => query_params,
1819
+ :form_params => form_params,
1820
+ :body => post_body,
1821
+ :auth_names => auth_names,
1822
+ :return_type => 'AssetFileSchema')
1823
+ if @api_client.config.debugging
1824
+ @api_client.config.logger.debug "API called: CourseApi#import_course_asset_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1825
+ end
1826
+ return data, status_code, headers
1827
+ end
1828
+ # Import an asset file for a Course Version
1829
+ # 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`.
1830
+ # @param course_id
1831
+ # @param version_id
1832
+ # @param asset_schema
1833
+ # @param [Hash] opts the optional parameters
1834
+ # @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)
1835
+ # @return [AssetFileSchema]
1836
+ def import_course_version_asset_file(course_id, version_id, asset_schema, opts = {})
1837
+ data, _status_code, _headers = import_course_version_asset_file_with_http_info(course_id, version_id, asset_schema, opts)
1838
+ data
1839
+ end
1840
+
1841
+ # Import an asset file for a Course Version
1842
+ # 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;.
1843
+ # @param course_id
1844
+ # @param version_id
1845
+ # @param asset_schema
1846
+ # @param [Hash] opts the optional parameters
1847
+ # @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).
1848
+ # @return [Array<(AssetFileSchema, Fixnum, Hash)>] AssetFileSchema data, response status code and response headers
1849
+ def import_course_version_asset_file_with_http_info(course_id, version_id, asset_schema, opts = {})
1850
+ if @api_client.config.debugging
1851
+ @api_client.config.logger.debug 'Calling API: CourseApi.import_course_version_asset_file ...'
1852
+ end
1853
+ # verify the required parameter 'course_id' is set
1854
+ if course_id.nil?
1855
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.import_course_version_asset_file"
1856
+ end
1857
+ # verify the required parameter 'version_id' is set
1858
+ if version_id.nil?
1859
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.import_course_version_asset_file"
1860
+ end
1861
+ # verify the required parameter 'asset_schema' is set
1862
+ if asset_schema.nil?
1863
+ fail ArgumentError, "Missing the required parameter 'asset_schema' when calling CourseApi.import_course_version_asset_file"
1864
+ end
1865
+ # resource path
1866
+ local_var_path = '/courses/{courseId}/versions/{versionId}/asset'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
1867
+
1868
+ # query parameters
1869
+ query_params = {}
1870
+ query_params[:'updateAssetPolicy'] = opts[:'update_asset_policy'] if !opts[:'update_asset_policy'].nil?
1871
+
1872
+ # header parameters
1873
+ header_params = {}
1874
+ # HTTP header 'Accept' (if needed)
1875
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1876
+ # HTTP header 'Content-Type'
1877
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1878
+
1879
+ # form parameters
1880
+ form_params = {}
1881
+
1882
+ # http body (model)
1883
+ post_body = @api_client.object_to_http_body(asset_schema)
1884
+ auth_names = ['APP_NORMAL', 'OAUTH']
1885
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1886
+ :header_params => header_params,
1887
+ :query_params => query_params,
1888
+ :form_params => form_params,
1889
+ :body => post_body,
1890
+ :auth_names => auth_names,
1891
+ :return_type => 'AssetFileSchema')
1892
+ if @api_client.config.debugging
1893
+ @api_client.config.logger.debug "API called: CourseApi#import_course_version_asset_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1894
+ end
1895
+ return data, status_code, headers
1896
+ end
1897
+ # Add tags to a Course
1898
+ # 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).
1218
1899
  # @param course_id
1219
1900
  # @param tags
1220
1901
  # @param [Hash] opts the optional parameters
@@ -1224,8 +1905,8 @@ module RusticiSoftwareCloudV2
1224
1905
  nil
1225
1906
  end
1226
1907
 
1227
- # Set course tags.
1228
- # Set the tags for this course. Note: any tags currently on this course will be overwritten with the new array of tags.
1908
+ # Add tags to a Course
1909
+ # 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).
1229
1910
  # @param course_id
1230
1911
  # @param tags
1231
1912
  # @param [Hash] opts the optional parameters
@@ -1235,11 +1916,11 @@ module RusticiSoftwareCloudV2
1235
1916
  @api_client.config.logger.debug 'Calling API: CourseApi.put_course_tags ...'
1236
1917
  end
1237
1918
  # verify the required parameter 'course_id' is set
1238
- if @api_client.config.client_side_validation && course_id.nil?
1919
+ if course_id.nil?
1239
1920
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.put_course_tags"
1240
1921
  end
1241
1922
  # verify the required parameter 'tags' is set
1242
- if @api_client.config.client_side_validation && tags.nil?
1923
+ if tags.nil?
1243
1924
  fail ArgumentError, "Missing the required parameter 'tags' when calling CourseApi.put_course_tags"
1244
1925
  end
1245
1926
  # resource path
@@ -1272,9 +1953,9 @@ module RusticiSoftwareCloudV2
1272
1953
  end
1273
1954
  return data, status_code, headers
1274
1955
  end
1275
- # Set tags on courses.
1276
- # Sets all of the provided tags on all of the provided courses.
1277
- # @param batch Object representing an array of ids to apply an array of tags to.
1956
+ # Add a group of tags to a group of Courses
1957
+ # 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).
1958
+ # @param batch Array of ids, and array of tags for bulk tag operations
1278
1959
  # @param [Hash] opts the optional parameters
1279
1960
  # @return [nil]
1280
1961
  def put_course_tags_batch(batch, opts = {})
@@ -1282,9 +1963,9 @@ module RusticiSoftwareCloudV2
1282
1963
  nil
1283
1964
  end
1284
1965
 
1285
- # Set tags on courses.
1286
- # Sets all of the provided tags on all of the provided courses.
1287
- # @param batch Object representing an array of ids to apply an array of tags to.
1966
+ # Add a group of tags to a group of Courses
1967
+ # 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).
1968
+ # @param batch Array of ids, and array of tags for bulk tag operations
1288
1969
  # @param [Hash] opts the optional parameters
1289
1970
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1290
1971
  def put_course_tags_batch_with_http_info(batch, opts = {})
@@ -1292,7 +1973,7 @@ module RusticiSoftwareCloudV2
1292
1973
  @api_client.config.logger.debug 'Calling API: CourseApi.put_course_tags_batch ...'
1293
1974
  end
1294
1975
  # verify the required parameter 'batch' is set
1295
- if @api_client.config.client_side_validation && batch.nil?
1976
+ if batch.nil?
1296
1977
  fail ArgumentError, "Missing the required parameter 'batch' when calling CourseApi.put_course_tags_batch"
1297
1978
  end
1298
1979
  # resource path
@@ -1325,8 +2006,8 @@ module RusticiSoftwareCloudV2
1325
2006
  end
1326
2007
  return data, status_code, headers
1327
2008
  end
1328
- # Set course configuration.
1329
- # Set configuration settings for this course. Setting a value at this level will override any value which is set at the application level.
2009
+ # Update configuration settings for a Course
2010
+ # 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.
1330
2011
  # @param course_id
1331
2012
  # @param configuration_settings
1332
2013
  # @param [Hash] opts the optional parameters
@@ -1336,8 +2017,8 @@ module RusticiSoftwareCloudV2
1336
2017
  nil
1337
2018
  end
1338
2019
 
1339
- # Set course configuration.
1340
- # Set configuration settings for this course. Setting a value at this level will override any value which is set at the application level.
2020
+ # Update configuration settings for a Course
2021
+ # 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.
1341
2022
  # @param course_id
1342
2023
  # @param configuration_settings
1343
2024
  # @param [Hash] opts the optional parameters
@@ -1347,11 +2028,11 @@ module RusticiSoftwareCloudV2
1347
2028
  @api_client.config.logger.debug 'Calling API: CourseApi.set_course_configuration ...'
1348
2029
  end
1349
2030
  # verify the required parameter 'course_id' is set
1350
- if @api_client.config.client_side_validation && course_id.nil?
2031
+ if course_id.nil?
1351
2032
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.set_course_configuration"
1352
2033
  end
1353
2034
  # verify the required parameter 'configuration_settings' is set
1354
- if @api_client.config.client_side_validation && configuration_settings.nil?
2035
+ if configuration_settings.nil?
1355
2036
  fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling CourseApi.set_course_configuration"
1356
2037
  end
1357
2038
  # resource path
@@ -1384,8 +2065,8 @@ module RusticiSoftwareCloudV2
1384
2065
  end
1385
2066
  return data, status_code, headers
1386
2067
  end
1387
- # Set the title of a course.
1388
- # Sets the course title for the provided courseId.
2068
+ # Update title for a Course
2069
+ # Updates the title of the course.
1389
2070
  # @param course_id
1390
2071
  # @param title
1391
2072
  # @param [Hash] opts the optional parameters
@@ -1395,8 +2076,8 @@ module RusticiSoftwareCloudV2
1395
2076
  nil
1396
2077
  end
1397
2078
 
1398
- # Set the title of a course.
1399
- # Sets the course title for the provided courseId.
2079
+ # Update title for a Course
2080
+ # Updates the title of the course.
1400
2081
  # @param course_id
1401
2082
  # @param title
1402
2083
  # @param [Hash] opts the optional parameters
@@ -1406,11 +2087,11 @@ module RusticiSoftwareCloudV2
1406
2087
  @api_client.config.logger.debug 'Calling API: CourseApi.set_course_title ...'
1407
2088
  end
1408
2089
  # verify the required parameter 'course_id' is set
1409
- if @api_client.config.client_side_validation && course_id.nil?
2090
+ if course_id.nil?
1410
2091
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.set_course_title"
1411
2092
  end
1412
2093
  # verify the required parameter 'title' is set
1413
- if @api_client.config.client_side_validation && title.nil?
2094
+ if title.nil?
1414
2095
  fail ArgumentError, "Missing the required parameter 'title' when calling CourseApi.set_course_title"
1415
2096
  end
1416
2097
  # resource path
@@ -1443,10 +2124,10 @@ module RusticiSoftwareCloudV2
1443
2124
  end
1444
2125
  return data, status_code, headers
1445
2126
  end
1446
- # Set configuration for a version of a course.
1447
- # Set configuration settings for this course and version.
2127
+ # Update configuration settings for a Course Version
2128
+ # 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.
1448
2129
  # @param course_id
1449
- # @param version_id The course version
2130
+ # @param version_id
1450
2131
  # @param configuration_settings
1451
2132
  # @param [Hash] opts the optional parameters
1452
2133
  # @return [nil]
@@ -1455,10 +2136,10 @@ module RusticiSoftwareCloudV2
1455
2136
  nil
1456
2137
  end
1457
2138
 
1458
- # Set configuration for a version of a course.
1459
- # Set configuration settings for this course and version.
2139
+ # Update configuration settings for a Course Version
2140
+ # 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.
1460
2141
  # @param course_id
1461
- # @param version_id The course version
2142
+ # @param version_id
1462
2143
  # @param configuration_settings
1463
2144
  # @param [Hash] opts the optional parameters
1464
2145
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -1467,15 +2148,15 @@ module RusticiSoftwareCloudV2
1467
2148
  @api_client.config.logger.debug 'Calling API: CourseApi.set_course_version_configuration ...'
1468
2149
  end
1469
2150
  # verify the required parameter 'course_id' is set
1470
- if @api_client.config.client_side_validation && course_id.nil?
2151
+ if course_id.nil?
1471
2152
  fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.set_course_version_configuration"
1472
2153
  end
1473
2154
  # verify the required parameter 'version_id' is set
1474
- if @api_client.config.client_side_validation && version_id.nil?
2155
+ if version_id.nil?
1475
2156
  fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.set_course_version_configuration"
1476
2157
  end
1477
2158
  # verify the required parameter 'configuration_settings' is set
1478
- if @api_client.config.client_side_validation && configuration_settings.nil?
2159
+ if configuration_settings.nil?
1479
2160
  fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling CourseApi.set_course_version_configuration"
1480
2161
  end
1481
2162
  # resource path
@@ -1508,5 +2189,145 @@ module RusticiSoftwareCloudV2
1508
2189
  end
1509
2190
  return data, status_code, headers
1510
2191
  end
2192
+ # Upload an asset file for a Course
2193
+ # 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`.
2194
+ # @param course_id
2195
+ # @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.
2196
+ # @param [Hash] opts the optional parameters
2197
+ # @option opts [File] :file The asset file to import into the course.
2198
+ # @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)
2199
+ # @return [AssetFileSchema]
2200
+ def upload_course_asset_file(course_id, destination, opts = {})
2201
+ data, _status_code, _headers = upload_course_asset_file_with_http_info(course_id, destination, opts)
2202
+ data
2203
+ end
2204
+
2205
+ # Upload an asset file for a Course
2206
+ # 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;.
2207
+ # @param course_id
2208
+ # @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.
2209
+ # @param [Hash] opts the optional parameters
2210
+ # @option opts [File] :file The asset file to import into the course.
2211
+ # @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).
2212
+ # @return [Array<(AssetFileSchema, Fixnum, Hash)>] AssetFileSchema data, response status code and response headers
2213
+ def upload_course_asset_file_with_http_info(course_id, destination, opts = {})
2214
+ if @api_client.config.debugging
2215
+ @api_client.config.logger.debug 'Calling API: CourseApi.upload_course_asset_file ...'
2216
+ end
2217
+ # verify the required parameter 'course_id' is set
2218
+ if course_id.nil?
2219
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.upload_course_asset_file"
2220
+ end
2221
+ # verify the required parameter 'destination' is set
2222
+ if destination.nil?
2223
+ fail ArgumentError, "Missing the required parameter 'destination' when calling CourseApi.upload_course_asset_file"
2224
+ end
2225
+ # resource path
2226
+ local_var_path = '/courses/{courseId}/asset/upload'.sub('{' + 'courseId' + '}', course_id.to_s)
2227
+
2228
+ # query parameters
2229
+ query_params = {}
2230
+ query_params[:'updateAssetPolicy'] = opts[:'update_asset_policy'] if !opts[:'update_asset_policy'].nil?
2231
+
2232
+ # header parameters
2233
+ header_params = {}
2234
+ # HTTP header 'Accept' (if needed)
2235
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2236
+ # HTTP header 'Content-Type'
2237
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
2238
+
2239
+ # form parameters
2240
+ form_params = {}
2241
+ form_params['destination'] = destination
2242
+ form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
2243
+
2244
+ # http body (model)
2245
+ post_body = nil
2246
+ auth_names = ['APP_NORMAL', 'OAUTH']
2247
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2248
+ :header_params => header_params,
2249
+ :query_params => query_params,
2250
+ :form_params => form_params,
2251
+ :body => post_body,
2252
+ :auth_names => auth_names,
2253
+ :return_type => 'AssetFileSchema')
2254
+ if @api_client.config.debugging
2255
+ @api_client.config.logger.debug "API called: CourseApi#upload_course_asset_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2256
+ end
2257
+ return data, status_code, headers
2258
+ end
2259
+ # Upload an asset file for Course Version
2260
+ # 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`.
2261
+ # @param course_id
2262
+ # @param version_id
2263
+ # @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.
2264
+ # @param [Hash] opts the optional parameters
2265
+ # @option opts [File] :file The asset file to import into the course.
2266
+ # @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)
2267
+ # @return [AssetFileSchema]
2268
+ def upload_course_version_asset_file(course_id, version_id, destination, opts = {})
2269
+ data, _status_code, _headers = upload_course_version_asset_file_with_http_info(course_id, version_id, destination, opts)
2270
+ data
2271
+ end
2272
+
2273
+ # Upload an asset file for Course Version
2274
+ # 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;.
2275
+ # @param course_id
2276
+ # @param version_id
2277
+ # @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.
2278
+ # @param [Hash] opts the optional parameters
2279
+ # @option opts [File] :file The asset file to import into the course.
2280
+ # @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).
2281
+ # @return [Array<(AssetFileSchema, Fixnum, Hash)>] AssetFileSchema data, response status code and response headers
2282
+ def upload_course_version_asset_file_with_http_info(course_id, version_id, destination, opts = {})
2283
+ if @api_client.config.debugging
2284
+ @api_client.config.logger.debug 'Calling API: CourseApi.upload_course_version_asset_file ...'
2285
+ end
2286
+ # verify the required parameter 'course_id' is set
2287
+ if course_id.nil?
2288
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.upload_course_version_asset_file"
2289
+ end
2290
+ # verify the required parameter 'version_id' is set
2291
+ if version_id.nil?
2292
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.upload_course_version_asset_file"
2293
+ end
2294
+ # verify the required parameter 'destination' is set
2295
+ if destination.nil?
2296
+ fail ArgumentError, "Missing the required parameter 'destination' when calling CourseApi.upload_course_version_asset_file"
2297
+ end
2298
+ # resource path
2299
+ local_var_path = '/courses/{courseId}/versions/{versionId}/asset/upload'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
2300
+
2301
+ # query parameters
2302
+ query_params = {}
2303
+ query_params[:'updateAssetPolicy'] = opts[:'update_asset_policy'] if !opts[:'update_asset_policy'].nil?
2304
+
2305
+ # header parameters
2306
+ header_params = {}
2307
+ # HTTP header 'Accept' (if needed)
2308
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2309
+ # HTTP header 'Content-Type'
2310
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
2311
+
2312
+ # form parameters
2313
+ form_params = {}
2314
+ form_params['destination'] = destination
2315
+ form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
2316
+
2317
+ # http body (model)
2318
+ post_body = nil
2319
+ auth_names = ['APP_NORMAL', 'OAUTH']
2320
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2321
+ :header_params => header_params,
2322
+ :query_params => query_params,
2323
+ :form_params => form_params,
2324
+ :body => post_body,
2325
+ :auth_names => auth_names,
2326
+ :return_type => 'AssetFileSchema')
2327
+ if @api_client.config.debugging
2328
+ @api_client.config.logger.debug "API called: CourseApi#upload_course_version_asset_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2329
+ end
2330
+ return data, status_code, headers
2331
+ end
1511
2332
  end
1512
2333
  end