rustici_software_cloud_v2 2.1.0 → 3.0.0

data/lib/rustici_software_cloud_v2/api/course_api.rb

@@ -6,7 +6,6 @@
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.27
 
 =end
 
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+
+    extend Gem::Deprecate
+
     # Get a launch link to preview a Course 
     # 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). 
     # @param course_id 
@@ -79,6 +81,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get a launch link to preview a Course Version 
     # 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). 
     # @param course_id 
@@ -145,6 +148,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Create a Course from a package fetched from an external source 
     # 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. 
     # @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,6 +216,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Create a Course from a fetched or referenced external media file 
     # 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. 
     # @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.
@@ -279,6 +284,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Create a Course from an uploaded package 
     # 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. 
     # @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
       end
       return data, status_code, headers
     end
+
     # Delete a Course 
     # Deletes the specified course.  >**Caution:** >When a course is deleted, so is everything connected to the course.  This includes: >- Registrations >- Invitations >- Dispatches >- Debug Logs 
     # @param course_id 
@@ -402,6 +409,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Delete an asset file from a Course 
     # 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. 
     # @param course_id 
@@ -462,6 +470,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Delete a configuration setting explicitly set for a Course 
     # 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. 
     # @param course_id 
@@ -521,6 +530,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Delete tags from a Course 
     # Deletes the specified tags from the course.  Deleting tags that do not exist will still result in a success. 
     # @param course_id 
@@ -580,6 +590,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Delete a Course Version 
     # 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 
     # @param course_id 
@@ -639,6 +650,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Delete an asset file from a Course Version 
     # 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. 
     # @param course_id 
@@ -705,6 +717,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Delete a configuration setting explicitly set for a Course Version 
     # 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. 
     # @param course_id 
@@ -770,6 +783,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get detailed information about a Course 
     # Returns detailed information about the course.  This includes title, update date, learning standard, and version. 
     # @param course_id 
@@ -830,6 +844,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Download an asset file from a Course 
     # 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. 
     # @param course_id 
@@ -891,6 +906,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get effective configuration settings for a Course 
     # 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. 
     # @param course_id 
@@ -948,6 +964,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get a list of asset files in a Course 
     # Returns a list of asset files in the course.  Included will be the relative path to use for the other course asset manipulation calls. 
     # @param course_id 
@@ -1002,6 +1019,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get xAPI statements for a Course 
     # Returns xAPI statements for the course. 
     # @param course_id 
@@ -1068,6 +1086,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get tags for a Course 
     # Returns the tags for the course. 
     # @param course_id 
@@ -1122,6 +1141,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Download an asset file from a specific Course Version 
     # 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. 
     # @param course_id 
@@ -1189,6 +1209,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get effective configuration settings for a Course Version 
     # 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. 
     # @param course_id 
@@ -1252,6 +1273,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get a list of asset files in a Course Version 
     # 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. 
     # @param course_id 
@@ -1312,6 +1334,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get detailed information about a Course Version 
     # Returns detailed information about the course version.  This includes update date and registration count (if optional value is passed in). 
     # @param course_id 
@@ -1378,6 +1401,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get xAPI statements for a Course Version 
     # Returns xAPI statements for the course version. 
     # @param course_id 
@@ -1450,6 +1474,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get a list of a Course's Versions 
     # 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. 
     # @param course_id 
@@ -1516,6 +1541,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Download a zip package for a Course 
     # 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. 
     # @param course_id 
@@ -1570,6 +1596,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get a list of Courses 
     # 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. 
     # @param [Hash] opts the optional parameters
@@ -1583,6 +1610,7 @@ module RusticiSoftwareCloudV2
     # @option opts [String] :more Pagination token returned as `more` property of multi page list requests
     # @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)
     # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results (default to false)
+    # @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 `more` token.  (default to false)
     # @return [CourseListSchema]
     def get_courses(opts = {})
       data, _status_code, _headers = get_courses_with_http_info(opts)
@@ -1602,6 +1630,7 @@ module RusticiSoftwareCloudV2
     # @option opts [String] :more Pagination token returned as `more` property of multi page list requests
     # @option opts [BOOLEAN] :include_course_metadata Include course metadata in the results. If the course has no metadata, adding this parameter has no effect.
     # @option opts [BOOLEAN] :include_registration_count Include the registration count in the results
+    # @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 `more` token. 
     # @return [Array<(CourseListSchema, Fixnum, Hash)>] CourseListSchema data, response status code and response headers
     def get_courses_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -1622,6 +1651,7 @@ module RusticiSoftwareCloudV2
       query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
       query_params[:'includeCourseMetadata'] = opts[:'include_course_metadata'] if !opts[:'include_course_metadata'].nil?
       query_params[:'includeRegistrationCount'] = opts[:'include_registration_count'] if !opts[:'include_registration_count'].nil?
+      query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
 
       # header parameters
       header_params = {}
@@ -1648,6 +1678,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Get import job status for a Course 
     # 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. 
     # @param import_job_id Id received when the import job was submitted to the importJobs resource.
@@ -1702,6 +1733,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Download a zip package for a Course Version 
     # 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. 
     # @param course_id 
@@ -1762,6 +1794,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Import an asset file for a Course 
     # 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`. 
     # @param course_id 
@@ -1825,6 +1858,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Import an asset file for a Course Version 
     # 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`. 
     # @param course_id 
@@ -1894,6 +1928,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Add tags to a Course 
     # 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). 
     # @param course_id 
@@ -1953,6 +1988,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Add a group of tags to a group of Courses 
     # 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). 
     # @param batch Array of ids, and array of tags for bulk tag operations
@@ -2006,6 +2042,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Update configuration settings for a Course 
     # 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. 
     # @param course_id 
@@ -2065,6 +2102,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Update title for a Course 
     # Updates the title of the course. 
     # @param course_id 
@@ -2124,6 +2162,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Update configuration settings for a Course Version 
     # 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. 
     # @param course_id 
@@ -2189,6 +2228,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Upload an asset file for a Course 
     # 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`. 
     # @param course_id 
@@ -2256,6 +2296,7 @@ module RusticiSoftwareCloudV2
       end
       return data, status_code, headers
     end
+
     # Upload an asset file for Course Version 
     # 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`. 
     # @param course_id