rustici_software_cloud_v2 2.0.0 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (162) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/lib/rustici_software_cloud_v2/api/about_api.rb +3 -1
  4. data/lib/rustici_software_cloud_v2/api/application_management_api.rb +100 -5
  5. data/lib/rustici_software_cloud_v2/api/authentication_api.rb +3 -1
  6. data/lib/rustici_software_cloud_v2/api/content_connectors_api.rb +241 -0
  7. data/lib/rustici_software_cloud_v2/api/course_api.rb +158 -3
  8. data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +229 -3
  9. data/lib/rustici_software_cloud_v2/api/invitations_api.rb +33 -1
  10. data/lib/rustici_software_cloud_v2/api/learner_api.rb +8 -1
  11. data/lib/rustici_software_cloud_v2/api/ping_api.rb +3 -1
  12. data/lib/rustici_software_cloud_v2/api/registration_api.rb +32 -1
  13. data/lib/rustici_software_cloud_v2/api/reporting_api.rb +5 -1
  14. data/lib/rustici_software_cloud_v2/api/xapi_api.rb +15 -1
  15. data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +11 -1
  16. data/lib/rustici_software_cloud_v2/api_client.rb +3 -2
  17. data/lib/rustici_software_cloud_v2/api_error.rb +0 -1
  18. data/lib/rustici_software_cloud_v2/configuration.rb +0 -1
  19. data/lib/rustici_software_cloud_v2/models/about_schema.rb +1 -1
  20. data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +1 -1
  21. data/lib/rustici_software_cloud_v2/models/application_info_list_schema.rb +197 -0
  22. data/lib/rustici_software_cloud_v2/models/application_info_schema.rb +12 -2
  23. data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +1 -1
  24. data/lib/rustici_software_cloud_v2/models/application_request_schema.rb +1 -1
  25. data/lib/rustici_software_cloud_v2/models/application_schema.rb +1 -1
  26. data/lib/rustici_software_cloud_v2/models/application_token.rb +1 -1
  27. data/lib/rustici_software_cloud_v2/models/asset_file_schema.rb +1 -1
  28. data/lib/rustici_software_cloud_v2/models/batch_tags_schema.rb +1 -1
  29. data/lib/rustici_software_cloud_v2/models/comment_schema.rb +1 -1
  30. data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +1 -1
  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 +2 -2
  34. data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +1 -1
  35. data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +1 -1
  36. data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +1 -1
  37. data/lib/rustici_software_cloud_v2/models/course_schema.rb +2 -2
  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 +1 -1
  40. data/lib/rustici_software_cloud_v2/models/create_dispatch_list_schema.rb +1 -1
  41. data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +1 -1
  42. data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +1 -1
  43. data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +1 -1
  44. data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +1 -1
  45. data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +1 -1
  46. data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +1 -1
  47. data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +1 -1
  48. data/lib/rustici_software_cloud_v2/models/credential_schema.rb +1 -1
  49. data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +1 -1
  50. data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +1 -1
  51. data/lib/rustici_software_cloud_v2/models/destination_schema.rb +32 -5
  52. data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +1 -1
  53. data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +1 -1
  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 +1 -1
  56. data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +1 -1
  57. data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +1 -1
  58. data/lib/rustici_software_cloud_v2/models/enabled_schema.rb +1 -1
  59. data/lib/rustici_software_cloud_v2/models/file_list_item_schema.rb +1 -1
  60. data/lib/rustici_software_cloud_v2/models/file_list_schema.rb +1 -1
  61. data/lib/rustici_software_cloud_v2/models/import_asset_request_schema.rb +1 -1
  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 +1 -1
  64. data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +1 -1
  65. data/lib/rustici_software_cloud_v2/models/import_media_file_reference_request_schema.rb +1 -1
  66. data/lib/rustici_software_cloud_v2/models/import_request_schema.rb +15 -6
  67. data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +1 -1
  68. data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +1 -1
  69. data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +1 -1
  70. data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +1 -1
  71. data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +15 -18
  72. data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +1 -1
  73. data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +1 -1
  74. data/lib/rustici_software_cloud_v2/models/launch_auth_options_schema.rb +1 -1
  75. data/lib/rustici_software_cloud_v2/models/launch_auth_schema.rb +1 -1
  76. data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +1 -1
  77. data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +1 -1
  78. data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +1 -1
  79. data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +1 -1
  80. data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +1 -1
  81. data/lib/rustici_software_cloud_v2/models/learner_schema.rb +1 -1
  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 +1 -1
  85. data/lib/rustici_software_cloud_v2/models/message_schema.rb +1 -1
  86. data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +1 -1
  87. data/lib/rustici_software_cloud_v2/models/objective_schema.rb +1 -1
  88. data/lib/rustici_software_cloud_v2/models/paginated_list.rb +186 -0
  89. data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +1 -1
  90. data/lib/rustici_software_cloud_v2/models/ping_schema.rb +1 -1
  91. data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +1 -1
  92. data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +15 -18
  93. data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +1 -1
  94. data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb +1 -1
  95. data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +15 -18
  96. data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +11 -2
  97. data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +1 -1
  98. data/lib/rustici_software_cloud_v2/models/registration_completion.rb +1 -1
  99. data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +1 -1
  100. data/lib/rustici_software_cloud_v2/models/registration_schema.rb +1 -1
  101. data/lib/rustici_software_cloud_v2/models/registration_success.rb +1 -1
  102. data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +1 -1
  103. data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +1 -1
  104. data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +1 -1
  105. data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +1 -1
  106. data/lib/rustici_software_cloud_v2/models/response_error.rb +1 -1
  107. data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +1 -1
  108. data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +1 -1
  109. data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +1 -1
  110. data/lib/rustici_software_cloud_v2/models/score_schema.rb +1 -1
  111. data/lib/rustici_software_cloud_v2/models/setting_item.rb +1 -1
  112. data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +1 -1
  113. data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +1 -1
  114. data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +1 -1
  115. data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +1 -1
  116. data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +1 -1
  117. data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +1 -1
  118. data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +1 -1
  119. data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +1 -1
  120. data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +1 -1
  121. data/lib/rustici_software_cloud_v2/models/title_schema.rb +1 -1
  122. data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +1 -1
  123. data/lib/rustici_software_cloud_v2/models/update_application_schema.rb +1 -1
  124. data/lib/rustici_software_cloud_v2/models/update_connector_schema.rb +196 -0
  125. data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +1 -1
  126. data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +15 -18
  127. data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +1 -1
  128. data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +1 -1
  129. data/lib/rustici_software_cloud_v2/models/xapi_account.rb +1 -1
  130. data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +1 -1
  131. data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +1 -1
  132. data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +1 -1
  133. data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +1 -1
  134. data/lib/rustici_software_cloud_v2/models/xapi_context.rb +1 -1
  135. data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +1 -1
  136. data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +1 -1
  137. data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +1 -1
  138. data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +1 -1
  139. data/lib/rustici_software_cloud_v2/models/xapi_credential_put_schema.rb +1 -1
  140. data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +1 -1
  141. data/lib/rustici_software_cloud_v2/models/xapi_credentials_list_schema.rb +1 -1
  142. data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +1 -1
  143. data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +1 -1
  144. data/lib/rustici_software_cloud_v2/models/xapi_result.rb +1 -1
  145. data/lib/rustici_software_cloud_v2/models/xapi_score.rb +1 -1
  146. data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +1 -1
  147. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +1 -1
  148. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +1 -1
  149. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_put_schema.rb +1 -1
  150. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +1 -1
  151. data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +1 -1
  152. data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +1 -1
  153. data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +1 -1
  154. data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +1 -1
  155. data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +1 -1
  156. data/lib/rustici_software_cloud_v2/version.rb +1 -2
  157. data/lib/rustici_software_cloud_v2.rb +11 -1
  158. data/rustici_software_cloud_v2.gemspec +0 -1
  159. data/spec/api_client_spec.rb +0 -1
  160. data/spec/configuration_spec.rb +0 -1
  161. data/spec/spec_helper.rb +0 -1
  162. metadata +14 -3
@@ -6,7 +6,6 @@
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
10
9
 
11
10
  =end
12
11
 
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
19
18
  def initialize(api_client = ApiClient.default)
20
19
  @api_client = api_client
21
20
  end
21
+
22
+ extend Gem::Deprecate
23
+
22
24
  # Get a launch link to preview a Course
23
25
  # 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
26
  # @param course_id
@@ -79,6 +81,7 @@ module RusticiSoftwareCloudV2
79
81
  end
80
82
  return data, status_code, headers
81
83
  end
84
+
82
85
  # Get a launch link to preview a Course Version
83
86
  # Returns the launch link to use to preview the course version. Course preview does not require an underlying registration. As such, no interactions will be tracked during the preview launch. Previews are meant to be a way to confirm the course looks and acts the way it should. >**Note:** >The cmi5 standard does not support the ability to preview a course. A launch link can be built for a cmi5 course, but visiting the link will result in an error page. More details can be found in this [article explaining the complications behind cmi5 preview launches](https://support.scorm.com/hc/en-us/articles/1260805676710).
84
87
  # @param course_id
@@ -145,6 +148,7 @@ module RusticiSoftwareCloudV2
145
148
  end
146
149
  return data, status_code, headers
147
150
  end
151
+
148
152
  # Create a Course from a package fetched from an external source
149
153
  # 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.
150
154
  # @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.
@@ -212,8 +216,9 @@ module RusticiSoftwareCloudV2
212
216
  end
213
217
  return data, status_code, headers
214
218
  end
219
+
215
220
  # Create a Course from a fetched or referenced external media file
216
- # Creates a course from one of two methods, fetchRequest or mediaFileReferenceRequest. In either case, an import job ID will be returned, which can be used with GetImportJobStatus to view the status of the import. Courses represent the learning material a learner will progress through. - A fetchRequest performs the same actions as CreateFetchAndImportCourseJob. A course will be created from a package fetched from the provided url. The package will be downloaded from the url and stored in SCORM Cloud. - A mediaFileReferenceRequest will not store the file in SCORM Cloud. Instead it will reference the media file at the time the learner needs to view the file from the provided url. >**Note:** >The import job ID used for calls to GetImportJobStatus are only valid for one week after the course import finishes. >**Info:** >Unless working with media files, it is typical to use one of the other two import methods. >- CreateUploadAndImportCourseJob would be used if the course is in your local file system. >- CreateFetchAndImportCourseJob would be better suited for situations where the course is uploaded remotely but is accessible via a public url.
221
+ # 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
222
  # @param course_id A unique identifier your application will use to identify the course after import. Your application is responsible both for generating this unique ID and for keeping track of the ID for later use.
218
223
  # @param import_request
219
224
  # @param [Hash] opts the optional parameters
@@ -226,7 +231,7 @@ module RusticiSoftwareCloudV2
226
231
  end
227
232
 
228
233
  # Create a Course from a fetched or referenced external media file
229
- # Creates a course from one of two methods, fetchRequest or mediaFileReferenceRequest. In either case, an import job ID will be returned, which can be used with GetImportJobStatus to view the status of the import. Courses represent the learning material a learner will progress through. - A fetchRequest performs the same actions as CreateFetchAndImportCourseJob. A course will be created from a package fetched from the provided url. The package will be downloaded from the url and stored in SCORM Cloud. - A mediaFileReferenceRequest will not store the file in SCORM Cloud. Instead it will reference the media file at the time the learner needs to view the file from the provided url. >**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.
234
+ # 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.
230
235
  # @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
236
  # @param import_request
232
237
  # @param [Hash] opts the optional parameters
@@ -279,6 +284,7 @@ module RusticiSoftwareCloudV2
279
284
  end
280
285
  return data, status_code, headers
281
286
  end
287
+
282
288
  # Create a Course from an uploaded package
283
289
  # 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.
284
290
  # @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.
@@ -349,6 +355,7 @@ module RusticiSoftwareCloudV2
349
355
  end
350
356
  return data, status_code, headers
351
357
  end
358
+
352
359
  # Delete a Course
353
360
  # Deletes the specified course. >**Caution:** >When a course is deleted, so is everything connected to the course. This includes: >- Registrations >- Invitations >- Dispatches >- Debug Logs
354
361
  # @param course_id
@@ -402,6 +409,7 @@ module RusticiSoftwareCloudV2
402
409
  end
403
410
  return data, status_code, headers
404
411
  end
412
+
405
413
  # Delete an asset file from a Course
406
414
  # 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
415
  # @param course_id
@@ -462,6 +470,7 @@ module RusticiSoftwareCloudV2
462
470
  end
463
471
  return data, status_code, headers
464
472
  end
473
+
465
474
  # Delete a configuration setting explicitly set for a Course
466
475
  # 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.
467
476
  # @param course_id
@@ -521,6 +530,7 @@ module RusticiSoftwareCloudV2
521
530
  end
522
531
  return data, status_code, headers
523
532
  end
533
+
524
534
  # Delete tags from a Course
525
535
  # Deletes the specified tags from the course. Deleting tags that do not exist will still result in a success.
526
536
  # @param course_id
@@ -580,6 +590,7 @@ module RusticiSoftwareCloudV2
580
590
  end
581
591
  return data, status_code, headers
582
592
  end
593
+
583
594
  # Delete a Course Version
584
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. >**Caution:** >When a course is deleted, so is everything connected to this course. This includes: >- Registrations >- Invitations >- Dispatches >- Debug Logs
585
596
  # @param course_id
@@ -639,6 +650,7 @@ module RusticiSoftwareCloudV2
639
650
  end
640
651
  return data, status_code, headers
641
652
  end
653
+
642
654
  # Delete an asset file from a Course Version
643
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. >**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
656
  # @param course_id
@@ -705,6 +717,7 @@ module RusticiSoftwareCloudV2
705
717
  end
706
718
  return data, status_code, headers
707
719
  end
720
+
708
721
  # Delete a configuration setting explicitly set for a Course Version
709
722
  # 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.
710
723
  # @param course_id
@@ -770,6 +783,7 @@ module RusticiSoftwareCloudV2
770
783
  end
771
784
  return data, status_code, headers
772
785
  end
786
+
773
787
  # Get detailed information about a Course
774
788
  # Returns detailed information about the course. This includes title, update date, learning standard, and version.
775
789
  # @param course_id
@@ -830,6 +844,7 @@ module RusticiSoftwareCloudV2
830
844
  end
831
845
  return data, status_code, headers
832
846
  end
847
+
833
848
  # Download an asset file from a Course
834
849
  # 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
850
  # @param course_id
@@ -891,6 +906,7 @@ module RusticiSoftwareCloudV2
891
906
  end
892
907
  return data, status_code, headers
893
908
  end
909
+
894
910
  # Get effective configuration settings for a Course
895
911
  # 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.
896
912
  # @param course_id
@@ -948,6 +964,7 @@ module RusticiSoftwareCloudV2
948
964
  end
949
965
  return data, status_code, headers
950
966
  end
967
+
951
968
  # Get a list of asset files in a Course
952
969
  # 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
970
  # @param course_id
@@ -1002,6 +1019,7 @@ module RusticiSoftwareCloudV2
1002
1019
  end
1003
1020
  return data, status_code, headers
1004
1021
  end
1022
+
1005
1023
  # Get xAPI statements for a Course
1006
1024
  # Returns xAPI statements for the course.
1007
1025
  # @param course_id
@@ -1068,6 +1086,7 @@ module RusticiSoftwareCloudV2
1068
1086
  end
1069
1087
  return data, status_code, headers
1070
1088
  end
1089
+
1071
1090
  # Get tags for a Course
1072
1091
  # Returns the tags for the course.
1073
1092
  # @param course_id
@@ -1122,6 +1141,7 @@ module RusticiSoftwareCloudV2
1122
1141
  end
1123
1142
  return data, status_code, headers
1124
1143
  end
1144
+
1125
1145
  # Download an asset file from a specific Course Version
1126
1146
  # 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.
1127
1147
  # @param course_id
@@ -1189,6 +1209,7 @@ module RusticiSoftwareCloudV2
1189
1209
  end
1190
1210
  return data, status_code, headers
1191
1211
  end
1212
+
1192
1213
  # Get effective configuration settings for a Course Version
1193
1214
  # Returns the effective configuration settings for the course version. If not set at the course level, the setting will inherit a value from a higher level (e.g. application). If there is a configuration setting present at a more specific level, that setting will override the one set at the course level.
1194
1215
  # @param course_id
@@ -1252,6 +1273,7 @@ module RusticiSoftwareCloudV2
1252
1273
  end
1253
1274
  return data, status_code, headers
1254
1275
  end
1276
+
1255
1277
  # Get a list of asset files in a Course Version
1256
1278
  # 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
1279
  # @param course_id
@@ -1312,6 +1334,7 @@ module RusticiSoftwareCloudV2
1312
1334
  end
1313
1335
  return data, status_code, headers
1314
1336
  end
1337
+
1315
1338
  # Get detailed information about a Course Version
1316
1339
  # Returns detailed information about the course version. This includes update date and registration count (if optional value is passed in).
1317
1340
  # @param course_id
@@ -1378,6 +1401,7 @@ module RusticiSoftwareCloudV2
1378
1401
  end
1379
1402
  return data, status_code, headers
1380
1403
  end
1404
+
1381
1405
  # Get xAPI statements for a Course Version
1382
1406
  # Returns xAPI statements for the course version.
1383
1407
  # @param course_id
@@ -1450,6 +1474,7 @@ module RusticiSoftwareCloudV2
1450
1474
  end
1451
1475
  return data, status_code, headers
1452
1476
  end
1477
+
1453
1478
  # Get a list of a Course's Versions
1454
1479
  # 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.
1455
1480
  # @param course_id
@@ -1516,6 +1541,62 @@ module RusticiSoftwareCloudV2
1516
1541
  end
1517
1542
  return data, status_code, headers
1518
1543
  end
1544
+
1545
+ # Download a zip package for a Course
1546
+ # 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.
1547
+ # @param course_id
1548
+ # @param [Hash] opts the optional parameters
1549
+ # @return [File]
1550
+ def get_course_zip(course_id, opts = {})
1551
+ data, _status_code, _headers = get_course_zip_with_http_info(course_id, opts)
1552
+ data
1553
+ end
1554
+
1555
+ # Download a zip package for a Course
1556
+ # 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.
1557
+ # @param course_id
1558
+ # @param [Hash] opts the optional parameters
1559
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
1560
+ def get_course_zip_with_http_info(course_id, opts = {})
1561
+ if @api_client.config.debugging
1562
+ @api_client.config.logger.debug 'Calling API: CourseApi.get_course_zip ...'
1563
+ end
1564
+ # verify the required parameter 'course_id' is set
1565
+ if course_id.nil?
1566
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_course_zip"
1567
+ end
1568
+ # resource path
1569
+ local_var_path = '/courses/{courseId}/zip'.sub('{' + 'courseId' + '}', course_id.to_s)
1570
+
1571
+ # query parameters
1572
+ query_params = {}
1573
+
1574
+ # header parameters
1575
+ header_params = {}
1576
+ # HTTP header 'Accept' (if needed)
1577
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1578
+ # HTTP header 'Content-Type'
1579
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1580
+
1581
+ # form parameters
1582
+ form_params = {}
1583
+
1584
+ # http body (model)
1585
+ post_body = nil
1586
+ auth_names = ['APP_NORMAL', 'OAUTH']
1587
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1588
+ :header_params => header_params,
1589
+ :query_params => query_params,
1590
+ :form_params => form_params,
1591
+ :body => post_body,
1592
+ :auth_names => auth_names,
1593
+ :return_type => 'File')
1594
+ if @api_client.config.debugging
1595
+ @api_client.config.logger.debug "API called: CourseApi#get_course_zip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1596
+ end
1597
+ return data, status_code, headers
1598
+ end
1599
+
1519
1600
  # Get a list of Courses
1520
1601
  # 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.
1521
1602
  # @param [Hash] opts the optional parameters
@@ -1529,6 +1610,7 @@ module RusticiSoftwareCloudV2
1529
1610
  # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
1530
1611
  # @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)
1531
1612
  # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
1613
+ # @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token. (default to false)
1532
1614
  # @return [CourseListSchema]
1533
1615
  def get_courses(opts = {})
1534
1616
  data, _status_code, _headers = get_courses_with_http_info(opts)
@@ -1548,6 +1630,7 @@ module RusticiSoftwareCloudV2
1548
1630
  # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
1549
1631
  # @option opts [BOOLEAN] :include_course_metadata Include course metadata in the results. If the course has no metadata, adding this parameter has no effect.
1550
1632
  # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
1633
+ # @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token.
1551
1634
  # @return [Array<(CourseListSchema, Fixnum, Hash)>] CourseListSchema data, response status code and response headers
1552
1635
  def get_courses_with_http_info(opts = {})
1553
1636
  if @api_client.config.debugging
@@ -1568,6 +1651,7 @@ module RusticiSoftwareCloudV2
1568
1651
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
1569
1652
  query_params[:'includeCourseMetadata'] = opts[:'include_course_metadata'] if !opts[:'include_course_metadata'].nil?
1570
1653
  query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].nil?
1654
+ query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
1571
1655
 
1572
1656
  # header parameters
1573
1657
  header_params = {}
@@ -1594,6 +1678,7 @@ module RusticiSoftwareCloudV2
1594
1678
  end
1595
1679
  return data, status_code, headers
1596
1680
  end
1681
+
1597
1682
  # Get import job status for a Course
1598
1683
  # 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.
1599
1684
  # @param import_job_id Id received when the import job was submitted to the importJobs resource.
@@ -1648,6 +1733,68 @@ module RusticiSoftwareCloudV2
1648
1733
  end
1649
1734
  return data, status_code, headers
1650
1735
  end
1736
+
1737
+ # Download a zip package for a Course Version
1738
+ # 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.
1739
+ # @param course_id
1740
+ # @param version_id
1741
+ # @param [Hash] opts the optional parameters
1742
+ # @return [File]
1743
+ def get_versioned_course_zip(course_id, version_id, opts = {})
1744
+ data, _status_code, _headers = get_versioned_course_zip_with_http_info(course_id, version_id, opts)
1745
+ data
1746
+ end
1747
+
1748
+ # Download a zip package for a Course Version
1749
+ # 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.
1750
+ # @param course_id
1751
+ # @param version_id
1752
+ # @param [Hash] opts the optional parameters
1753
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
1754
+ def get_versioned_course_zip_with_http_info(course_id, version_id, opts = {})
1755
+ if @api_client.config.debugging
1756
+ @api_client.config.logger.debug 'Calling API: CourseApi.get_versioned_course_zip ...'
1757
+ end
1758
+ # verify the required parameter 'course_id' is set
1759
+ if course_id.nil?
1760
+ fail ArgumentError, "Missing the required parameter 'course_id' when calling CourseApi.get_versioned_course_zip"
1761
+ end
1762
+ # verify the required parameter 'version_id' is set
1763
+ if version_id.nil?
1764
+ fail ArgumentError, "Missing the required parameter 'version_id' when calling CourseApi.get_versioned_course_zip"
1765
+ end
1766
+ # resource path
1767
+ local_var_path = '/courses/{courseId}/versions/{versionId}/zip'.sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)
1768
+
1769
+ # query parameters
1770
+ query_params = {}
1771
+
1772
+ # header parameters
1773
+ header_params = {}
1774
+ # HTTP header 'Accept' (if needed)
1775
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1776
+ # HTTP header 'Content-Type'
1777
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1778
+
1779
+ # form parameters
1780
+ form_params = {}
1781
+
1782
+ # http body (model)
1783
+ post_body = nil
1784
+ auth_names = ['APP_NORMAL', 'OAUTH']
1785
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1786
+ :header_params => header_params,
1787
+ :query_params => query_params,
1788
+ :form_params => form_params,
1789
+ :body => post_body,
1790
+ :auth_names => auth_names,
1791
+ :return_type => 'File')
1792
+ if @api_client.config.debugging
1793
+ @api_client.config.logger.debug "API called: CourseApi#get_versioned_course_zip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1794
+ end
1795
+ return data, status_code, headers
1796
+ end
1797
+
1651
1798
  # Import an asset file for a Course
1652
1799
  # Creates or updates an asset file fetched from the provided url into the course. The file will be downloaded from the url and stored in SCORM Cloud. This is a useful way to modify the course structure without needing to reimport the whole course after you've made changes. >**Info:** >If the course structure is being heavily modified, consider creating a new version instead. This can be done by calling one of the course import jobs while passing true for `mayCreateNewVersion`.
1653
1800
  # @param course_id
@@ -1711,6 +1858,7 @@ module RusticiSoftwareCloudV2
1711
1858
  end
1712
1859
  return data, status_code, headers
1713
1860
  end
1861
+
1714
1862
  # Import an asset file for a Course Version
1715
1863
  # Creates or updates an asset file fetched from the provided url into the course version. The file will be downloaded from the url and stored in SCORM Cloud. This is a useful way to modify the course structure without needing to reimport the whole course after you've made changes. >**Info:** >If the course structure is being heavily modified, consider creating a new version instead. This can be done by calling one of the course import jobs while passing true for `mayCreateNewVersion`.
1716
1864
  # @param course_id
@@ -1780,6 +1928,7 @@ module RusticiSoftwareCloudV2
1780
1928
  end
1781
1929
  return data, status_code, headers
1782
1930
  end
1931
+
1783
1932
  # Add tags to a Course
1784
1933
  # 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).
1785
1934
  # @param course_id
@@ -1839,6 +1988,7 @@ module RusticiSoftwareCloudV2
1839
1988
  end
1840
1989
  return data, status_code, headers
1841
1990
  end
1991
+
1842
1992
  # Add a group of tags to a group of Courses
1843
1993
  # Applies all of the provided tags on all of the provided courses. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetCourses).
1844
1994
  # @param batch Array of ids, and array of tags for bulk tag operations
@@ -1892,6 +2042,7 @@ module RusticiSoftwareCloudV2
1892
2042
  end
1893
2043
  return data, status_code, headers
1894
2044
  end
2045
+
1895
2046
  # Update configuration settings for a Course
1896
2047
  # 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.
1897
2048
  # @param course_id
@@ -1951,6 +2102,7 @@ module RusticiSoftwareCloudV2
1951
2102
  end
1952
2103
  return data, status_code, headers
1953
2104
  end
2105
+
1954
2106
  # Update title for a Course
1955
2107
  # Updates the title of the course.
1956
2108
  # @param course_id
@@ -2010,6 +2162,7 @@ module RusticiSoftwareCloudV2
2010
2162
  end
2011
2163
  return data, status_code, headers
2012
2164
  end
2165
+
2013
2166
  # Update configuration settings for a Course Version
2014
2167
  # 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.
2015
2168
  # @param course_id
@@ -2075,6 +2228,7 @@ module RusticiSoftwareCloudV2
2075
2228
  end
2076
2229
  return data, status_code, headers
2077
2230
  end
2231
+
2078
2232
  # Upload an asset file for a Course
2079
2233
  # Creates or updates an asset file uploaded from your file system into the course. The file will be sent as part of the request and will be stored in SCORM Cloud alongside the course. This is a useful way to modify the course structure without needing to reimport the whole course after you've made changes. >**Info:** >If the course structure is being heavily modified, consider creating a new version instead. This can be done by calling one of the course import jobs while passing true for `mayCreateNewVersion`.
2080
2234
  # @param course_id
@@ -2142,6 +2296,7 @@ module RusticiSoftwareCloudV2
2142
2296
  end
2143
2297
  return data, status_code, headers
2144
2298
  end
2299
+
2145
2300
  # Upload an asset file for Course Version
2146
2301
  # Creates or updates an asset file uploaded from your file system into the course version. The file will be sent as part of the request and will be stored in SCORM Cloud alongside the course. This is a useful way to modify the course structure without needing to reimport the whole course after you've made changes. >**Info:** >If the course structure is being heavily modified, consider creating a new version instead. This can be done by calling one of the course import jobs while passing true for `mayCreateNewVersion`.
2147
2302
  # @param course_id