rustici_software_cloud_v2 1.0.0beta → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76a614b52e38306b7ef49b804c9d53209e8ad854f4e74a11cd2092be1638180b
+  data.tar.gz: cda1d65a0e1ee135dd3905169a2fdbdd1a92155e271efbe24e9555cb9edde962
+SHA512:
+  metadata.gz: aeca3f98049127435943a6d120e86d1aa9a97b09d0ff826c62806000f5f53e2ab580359b3ce682aca846e2555642bfbf0e3e0bf4623bbb182054a0a2c35b63a2
+  data.tar.gz: 2aa262cd225e5bf1ec2d36b132839cdfaf7e6435b061403cc2dc5252df8ffea7bad38fcfbca5dc2db24afa59ea7f51b74502fd29dd2d5da167effb14c719d361

data/Gemfile

@@ -3,5 +3,5 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rake', '~> 12.0.0'
+  gem 'rake', '~> 12.3.3'
 end

data/README.md

@@ -6,278 +6,389 @@ REST API used for SCORM Cloud integrations.
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: 2.0 beta
-- Package version: 1.0.0-beta
+- API version: 2.0
+- Package version: 2.0.0
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
+### Gem
+[rustici_software_cloud_v2](https://rubygems.org/gems/rustici_software_cloud_v2)
 
-### Build a gem
-
-To build the Ruby code into a gem:
+### Local:
+Build the Ruby code into a gem:
 
 ```shell
 gem build rustici_software_cloud_v2.gemspec
 ```
 
-Then either install the gem locally:
-
 ```shell
-gem install ./rustici_software_cloud_v2-1.0.0-beta.gem
+gem install ./rustici_software_cloud_v2-2.0.0.gem
 ```
-(for development, run `gem install --dev ./rustici_software_cloud_v2-1.0.0-beta.gem` to install the development dependencies)
-
-or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+For development, run `gem install --dev ./rustici_software_cloud_v2-2.0.0.gem` to install the development dependencies
 
 Finally add this to the Gemfile:
 
-    gem 'rustici_software_cloud_v2', '~> 1.0.0-beta'
+    gem 'rustici_software_cloud_v2', '~> 2.0.0'
 
-### Install from Git
+## Tips and Tricks
+Working with headers will require calling the `WithHttpInfo` version of the function. This allows for grabbing the header directly from the response object:
+```ruby
+# Note: This code is specifically designed to not modify any existing data
+dispatch_api = RusticiSoftwareCloudV2::DispatchApi.new
+response = dispatch_api.update_dispatches_with_http_info(RusticiSoftwareCloudV2::UpdateDispatchSchema.new, {since: Time.now.strftime('%Y-%m-%dT%H:%M:%S.%L') + 'Z'})
+puts response[2]["X-Total-Count"]
+```
 
-If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+## Release 2.0.X:
+Check the [changelog](https://cloud.scorm.com/docs/v2/reference/changelog/) for details of what has changed.
 
-    gem 'rustici_software_cloud_v2', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+## Sample Code
+```ruby
+require 'rustici_software_cloud_v2'
+require 'open-uri'
+include RusticiSoftwareCloudV2
 
-### Include the Ruby code directly
 
-Include the Ruby code directly using `-I` as follows:
+# ScormCloud API credentials
+# Note: These are not the same credentials used to log in to ScormCloud
+APP_ID = 'APP_ID'
+SECRET_KEY = 'SECRET_KEY'
 
-```shell
-ruby -Ilib script.rb
-```
+# Sample values for data
+COURSE_PATH = '/PATH/TO/COURSE/RunTimeAdvancedCalls_SCORM20043rdEdition.zip'
 
-## Getting Started
+COURSE_ID = 'RB_SAMPLE_COURSE'
+LEARNER_ID = 'RB_SAMPLE_COURSE_LEARNER'
+REGISTRATION_ID = 'RB_SAMPLE_COURSE_REGISTRATION'
 
-Please follow the [installation](#installation) procedure and then run the following code:
-```ruby
-# Load the gem
-require 'rustici_software_cloud_v2'
+# String used for output formatting
+OUTPUT_BORDER = "---------------------------------------------------------\n\n"
+
+
+# This sample will consist of:
+# 1. Creating a course.
+# 2. Registering a learner for the course.
+# 3. Building a link for the learner to take the course.
+# 4. Getting the learner's progress after having taken the course.
+# 5. Viewing all courses and registrations.
+# 6. Deleting all of the data created via this sample.
+#
+# All input variables used in this sample are defined up above.
+def main()
+    RusticiSoftwareCloudV2.configure do |config|
+        # Configure HTTP basic authorization: APP_NORMAL
+        config.username = APP_ID
+        config.password = SECRET_KEY
+    end
+
+    sc = ScormCloud_Ruby_Sample.new
+
+    begin
+        # Create a course and a registration
+        course_details = sc.create_course(COURSE_ID, COURSE_PATH)
+        sc.create_registration(COURSE_ID, LEARNER_ID, REGISTRATION_ID)
+
+        # Show details of the newly imported course
+        puts 'Newly Imported Course Details: '
+        puts course_details
 
-# Setup authorization
-RusticiSoftwareCloudV2.configure do |config|
-  # Configure HTTP basic authorization: APP_NORMAL
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
 
-  # Configure OAuth2 access token for authorization: OAUTH
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
 
-api_instance = RusticiSoftwareCloudV2::ApplicationManagementApi.new
+        # Create the registration launch link
+        launch_link = sc.build_launch_link(REGISTRATION_ID)
 
-application_name = 'application_name_example' # String | 
+        # Show the launch link
+        puts OUTPUT_BORDER
+        puts "Launck Link: #{launch_link}"
+        puts 'Navigate to the url above to take the course. Hit enter once complete.'
+        gets
 
 
-begin
-  #Create a new application
-  result = api_instance.create_application(application_name)
-  p result
-rescue RusticiSoftwareCloudV2::ApiError => e
-  puts "Exception when calling ApplicationManagementApi->create_application: #{e}"
+
+        # Get the results for the registration
+        registration_progress = sc.get_result_for_registration(REGISTRATION_ID)
+
+        # Show details of the registration progress
+        puts OUTPUT_BORDER
+        puts 'Registration Progress: '
+        puts registration_progress
+
+
+
+        # Get information about all the courses in ScormCloud
+        course_list = sc.get_all_courses()
+
+        # Show details of the courses
+        puts OUTPUT_BORDER
+        puts 'Course List: '
+        course_list.each do |course|
+            puts course
+        end
+
+
+
+        # Get information about all the registrations in ScormCloud
+        registration_list = sc.get_all_registrations()
+
+        # Show details of the registrations
+        puts OUTPUT_BORDER
+        puts 'Registration List: '
+        registration_list.each do |registration|
+            puts registration
+        end
+
+    rescue ApiError, ArgumentError => error
+        puts error
+
+    ensure
+        # Delete all the data created by this sample
+        sc.clean_up(COURSE_ID, REGISTRATION_ID)
+
+    end
 end
 
-```
+class ScormCloud_Ruby_Sample
+
+    # Sets the default OAuth token passed with all calls to the API.
+    #
+    # If a token is created with limited scope (i.e. read:registration),
+    # calls that require a different permission set will error. Either a
+    # new token needs to be generated with the correct scope, or the
+    # default access token can be reset to nil. This would cause the
+    # request to be made with basic auth credentials (appId/ secret key)
+    # instead.
+    #
+    # Additionally, you could create a new configuration object and set
+    # the token on that object instead of the default access token. This
+    # configuration would then be passed into the Api object:
+    #
+    # config = Configuration.new
+    # token_request = TokenRequestSchema.new({
+    #     permissions: PermissionsSchema.new({
+    #         scopes: [ "write:course", "read:course" ]
+    #     }),
+    #     expiry: (Time.now + 2 * 60).iso8601
+    # })
+    # config.access_token = app_management_api.create_token(token_request).result
+    # course_api = CourseApi.new(ApiClient.new(config))
+    #
+    # Any calls that would use this CourseApi instance would then have the
+    # write:course and read:course permissions passed automatically, but
+    # other instances would be unaffected and continue to use other means
+    # of authorization.
+    #
+    # @param [Array<String>] :scopes List of permissions for calls made with the token.
+    private def configure_oauth(scopes)
+        app_management_api = ApplicationManagementApi.new
+
+        # Set permissions and expiry time of the token
+        # The expiry expected for token request must be in ISO-8601 format
+        expiry = (Time.now + 2 * 60).iso8601
+        permissions = PermissionsSchema.new({ scopes: scopes })
+
+        # Make the request to get the OAuth token
+        token_request = TokenRequestSchema.new({ permissions: permissions, expiry: expiry })
+        token_result = app_management_api.create_token(token_request)
+
+        # Set the default access token used with further API requests.
+        # To remove the token, reset config.access_token back to nil
+        # before the next call.
+        RusticiSoftwareCloudV2.configure do |config|
+            config.access_token = token_result.result
+        end
+
+        nil
+    end
+
+    # Creates a course by uploading the course from your local machine.
+    # Courses are a package of content for a learner to consume.
+    #
+    # Other methods for importing a course exist. Check the documentation
+    # for additional ways of importing a course.
+    #
+    # @param [String] :course_id Id that will be used to identify the course.
+    # @param [String] :course_path Path to the course being uploaded.
+    # @return [CourseSchema] Detailed information about the newly uploaded course.
+    def create_course(course_id, course_path)
+        # (Optional) Further authenticate via OAuth token access
+        # configure_oauth([ "write:course", "read:course" ])
+
+        # This call will use OAuth with the "write:course" scope
+        # if configured.  Otherwise the basic auth credentials will be used
+        course_api = CourseApi.new
+        job_id = course_api.create_upload_and_import_course_job(course_id, { file: open(course_path) })
+
+        # This call will use OAuth with the "read:course" scope
+        # if configured.  Otherwise the basic auth credentials will be used
+        job_result = course_api.get_import_job_status(job_id.result)
+        while job_result.status == 'RUNNING'
+            sleep(1)
+            job_result = course_api.get_import_job_status(job_id.result)
+        end
+
+        if job_result.status == 'ERROR'
+            raise ArgumentError.new('Course is not properly formatted: ' + job_result.message)
+        end
+
+        job_result.import_result.course
+    end
+
+    # Creates a registration allowing the learner to consume the course
+    # content. A registration is the link between a learner and a single
+    # course.
+    #
+    # @param [String] :course_id Id of the course to register the learner for.
+    # @param [String] :learner_id Id that will be used to identify the learner.
+    # @param [String] :registration_id Id that will be used to identify the registration.
+    def create_registration(course_id, learner_id, registration_id)
+        # (Optional) Further authenticate via OAuth token access
+        # configure_oauth([ "write:registration" ])
+
+        registration_api = RegistrationApi.new
+        learner = LearnerSchema.new({ id: learner_id })
+        registration = CreateRegistrationSchema.new({ courseId: course_id, learner: learner, registrationId: registration_id })
+        registration_api.create_registration(registration)
+
+        nil
+    end
+
+    # Builds a url allowing the learner to access the course.
+    #
+    # This sample will build the launch link and print it out. It will then
+    # pause and wait for user input, allowing you to navigate to the course
+    # to generate sample learner progress. Once this step has been reached,
+    # hitting the enter key will continue program execution.
+    #
+    # @param [String] :registration_id Id of the registration the link is being built for.
+    # @return [String] Link for the learner to launch the course.
+    def build_launch_link(registration_id)
+        # (Optional) Further authenticate via OAuth token access
+        # configure_oauth([ "read:registration" ])
+
+        registration_api = RegistrationApi.new
+        settings = LaunchLinkRequestSchema.new({ redirectOnExitUrl: 'Message' })
+        launch_link = registration_api.build_registration_launch_link(registration_id, settings)
+
+        launch_link.launch_link
+    end
+
+    # Gets information about the progress of the registration.
+    #
+    # For the most up-to-date results, you should implement our postback
+    # mechanism. The basic premise is that any update to the registration
+    # would cause us to send the updated results to your system.
+    #
+    # More details can be found in the documentation:
+    # https://cloud.scorm.com/docs/v2/guides/postback/
+    #
+    # @param [String] :registration_id Id of the registration to get results for.
+    # @return [RegistrationSchema] Detailed information about the registration's progress.
+    def get_result_for_registration(registration_id)
+        # (Optional) Further authenticate via OAuth token access
+        # configure_oauth([ "read:registration" ])
+
+        registration_api = RegistrationApi.new
+        progress = registration_api.get_registration_progress(registration_id)
+
+        progress
+    end
+
+    # Gets information about all courses. The result received from the API
+    # call is a paginated list, meaning that additional calls are required
+    # to retrieve all the information from the API. This has already been
+    # accounted for in the sample.
+    #
+    # @return [Array<CourseSchema>] List of detailed information about all of the courses.
+    def get_all_courses()
+        # (Optional) Further authenticate via OAuth token access
+        # configure_oauth([ "read:course" ])
+
+        # Additional filters can be provided to this call to get a subset
+        # of all courses.
+        course_api = CourseApi.new
+        response = course_api.get_courses()
+
+        # This call is paginated, with a token provided if more results exist
+        course_list = response.courses
+        until response.more.nil?
+            response = course_api.get_courses({ more: response.more })
+            course_list += response.courses
+        end
+
+        course_list
+    end
+
+    # Gets information about the registration progress for all
+    # registrations. The result received from the API call is a paginated
+    # list, meaning that additional calls are required to retrieve all the
+    # information from the API. This has already been accounted for in the
+    # sample.
+    #
+    # This call can be quite time-consuming and tedious with lots of
+    # registrations. If you find yourself making lots of calls to this
+    # endpoint, it might be worthwhile to look into registration postbacks.
+    #
+    # More details can be found in the documentation:
+    # https://cloud.scorm.com/docs/v2/guides/postback/
+    #
+    # @return [Array<RegistrationSchema>] List of detailed information about all of the registrations.
+    def get_all_registrations()
+        # (Optional) Further authenticate via OAuth token access
+        # configure_oauth([ "read:registration" ])
+
+        # Additional filters can be provided to this call to get a subset
+        # of all registrations.
+        registration_api = RegistrationApi.new
+        response = registration_api.get_registrations()
+
+        # This call is paginated, with a token provided if more results exist
+        registration_list = response.registrations
+        until response.more.nil?
+            response = registration_api.get_registrations({ more: response.more })
+            registration_list += response.registrations
+        end
+
+        registration_list
+    end
+
+    # Deletes all of the data generated by this sample.
+    # This code is run even if the program has errored out, providing a
+    # "clean slate" for every run of this sample.
+    #
+    # It is not necessary to delete registrations if the course
+    # they belong to has been deleted. Deleting the course will
+    # automatically queue deletion of all registrations associated with
+    # the course. There will be a delay between when the course is deleted
+    # and when the registrations for the course have been removed. The
+    # registration deletion has been handled here to prevent scenarios
+    # where the registration hasn't been deleted yet by the time the
+    # sample has been rerun.
+    #
+    # @param [String] :course_id Id of the course to delete.
+    # @param [String] :registration_id Id of the registration to delete.
+    def clean_up(course_id, registration_id)
+        # (Optional) Further authenticate via OAuth token access
+        # configure_oauth([ "delete:course", "delete:registration" ])
+
+        # This call will use OAuth with the "delete:course" scope
+        # if configured.  Otherwise the basic auth credentials will be used
+        course_api = CourseApi.new
+        course_api.delete_course(course_id)
+
+        # The code below is to prevent race conditions if the
+        # sample is run in quick successions.
+
+        # This call will use OAuth with the "delete:registration" scope
+        # if configured.  Otherwise the basic auth credentials will be used
+        registration_api = RegistrationApi.new
+        registration_api.delete_registration(registration_id)
+
+        nil
+    end
+end
 
-## Documentation for API Endpoints
-
-All URIs are relative to *https://cloud.scorm.com/api/v2/*
-
-Class | Method | HTTP request | Description
------------- | ------------- | ------------- | -------------
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**create_application**](docs/ApplicationManagementApi.md#create_application) | **PUT** /appManagement/applications/{applicationName} | Create a new application
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**create_credential**](docs/ApplicationManagementApi.md#create_credential) | **POST** /appManagement/{childAppId}/credentials | Create credential
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**create_token**](docs/ApplicationManagementApi.md#create_token) | **POST** /appManagement/token | Create token
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**delete_application**](docs/ApplicationManagementApi.md#delete_application) | **DELETE** /appManagement/applications/{childAppId} | Delete an application.  If the application contains content, it must first be manually removed before calling this method, else an error will be thrown.
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**delete_credential**](docs/ApplicationManagementApi.md#delete_credential) | **DELETE** /appManagement/{childAppId}/credentials/{credentialId} | Removes `credentialId` credentials
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**get_application_configuration**](docs/ApplicationManagementApi.md#get_application_configuration) | **GET** /appManagement/configuration | Returns all configuration settings for this level
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**get_application_list**](docs/ApplicationManagementApi.md#get_application_list) | **GET** /appManagement/applications | Get list of all applications in this realm.
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**get_credentials**](docs/ApplicationManagementApi.md#get_credentials) | **GET** /appManagement/{childAppId}/credentials | List of credentials
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**set_application_configuration**](docs/ApplicationManagementApi.md#set_application_configuration) | **POST** /appManagement/configuration | Set configuration settings for this level.
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**update_credential**](docs/ApplicationManagementApi.md#update_credential) | **PUT** /appManagement/{childAppId}/credentials/{credentialId} | Update the name or status associated with `credentialId`
-*RusticiSoftwareCloudV2::AuthenticationApi* | [**get_app_token**](docs/AuthenticationApi.md#get_app_token) | **POST** /oauth/authenticate/application/token | Authenticates for a oauth token
-*RusticiSoftwareCloudV2::CourseApi* | [**build_course_preview_launch_link**](docs/CourseApi.md#build_course_preview_launch_link) | **POST** /courses/{courseId}/preview | Returns the launch link to use to preview this course
-*RusticiSoftwareCloudV2::CourseApi* | [**build_course_preview_launch_link_with_version**](docs/CourseApi.md#build_course_preview_launch_link_with_version) | **POST** /courses/{courseId}/versions/{versionId}/preview | Returns the link to use to preview this course
-*RusticiSoftwareCloudV2::CourseApi* | [**create_fetch_and_import_course_job**](docs/CourseApi.md#create_fetch_and_import_course_job) | **POST** /courses/importJobs | Start a job to fetch and import a course.
-*RusticiSoftwareCloudV2::CourseApi* | [**create_upload_and_import_course_job**](docs/CourseApi.md#create_upload_and_import_course_job) | **POST** /courses/importJobs/upload | Upload a course and start an import job for it.
-*RusticiSoftwareCloudV2::CourseApi* | [**delete_course**](docs/CourseApi.md#delete_course) | **DELETE** /courses/{courseId} | Delete `courseId`
-*RusticiSoftwareCloudV2::CourseApi* | [**delete_course_configuration_setting**](docs/CourseApi.md#delete_course_configuration_setting) | **DELETE** /courses/{courseId}/configuration/{settingId} | Clears the `settingId` value for this course
-*RusticiSoftwareCloudV2::CourseApi* | [**delete_course_tags**](docs/CourseApi.md#delete_course_tags) | **DELETE** /courses/{courseId}/tags | Delete tags for this course
-*RusticiSoftwareCloudV2::CourseApi* | [**delete_course_version**](docs/CourseApi.md#delete_course_version) | **DELETE** /courses/{courseId}/versions/{versionId} | Delete version `versionId` of `courseId`
-*RusticiSoftwareCloudV2::CourseApi* | [**delete_course_version_configuration_setting**](docs/CourseApi.md#delete_course_version_configuration_setting) | **DELETE** /courses/{courseId}/versions/{versionId}/configuration/{settingId} | Clears the `settingId` value for this course and version.
-*RusticiSoftwareCloudV2::CourseApi* | [**get_course**](docs/CourseApi.md#get_course) | **GET** /courses/{courseId} | Get information about `courseId`
-*RusticiSoftwareCloudV2::CourseApi* | [**get_course_configuration**](docs/CourseApi.md#get_course_configuration) | **GET** /courses/{courseId}/configuration | Returns all configuration settings for this course
-*RusticiSoftwareCloudV2::CourseApi* | [**get_course_statements**](docs/CourseApi.md#get_course_statements) | **GET** /courses/{courseId}/xAPIStatements | Get xAPI statements for `courseId`
-*RusticiSoftwareCloudV2::CourseApi* | [**get_course_tags**](docs/CourseApi.md#get_course_tags) | **GET** /courses/{courseId}/tags | Get the tags for this course
-*RusticiSoftwareCloudV2::CourseApi* | [**get_course_version_configuration**](docs/CourseApi.md#get_course_version_configuration) | **GET** /courses/{courseId}/versions/{versionId}/configuration | Returns all configuration settings for this course and version.
-*RusticiSoftwareCloudV2::CourseApi* | [**get_course_version_info**](docs/CourseApi.md#get_course_version_info) | **GET** /courses/{courseId}/versions/{versionId} | Get version `versionId` of `courseId`
-*RusticiSoftwareCloudV2::CourseApi* | [**get_course_version_statements**](docs/CourseApi.md#get_course_version_statements) | **GET** /courses/{courseId}/versions/{versionId}/xAPIStatements | Get xAPI statements for version `versionId` of `courseId`
-*RusticiSoftwareCloudV2::CourseApi* | [**get_course_versions**](docs/CourseApi.md#get_course_versions) | **GET** /courses/{courseId}/versions | Get all versions of `courseId`
-*RusticiSoftwareCloudV2::CourseApi* | [**get_courses**](docs/CourseApi.md#get_courses) | **GET** /courses | Get all courses for `appId`
-*RusticiSoftwareCloudV2::CourseApi* | [**get_import_job_status**](docs/CourseApi.md#get_import_job_status) | **GET** /courses/importJobs/{importJobId} | Check the status of an import job.
-*RusticiSoftwareCloudV2::CourseApi* | [**put_course_tags**](docs/CourseApi.md#put_course_tags) | **PUT** /courses/{courseId}/tags | Set the tags for this course
-*RusticiSoftwareCloudV2::CourseApi* | [**put_course_tags_batch**](docs/CourseApi.md#put_course_tags_batch) | **PUT** /courses/tags | Sets all of the provided tags on all of the provided courses
-*RusticiSoftwareCloudV2::CourseApi* | [**set_course_configuration**](docs/CourseApi.md#set_course_configuration) | **POST** /courses/{courseId}/configuration | Set configuration settings for this course.
-*RusticiSoftwareCloudV2::CourseApi* | [**set_course_title**](docs/CourseApi.md#set_course_title) | **PUT** /courses/{courseId}/title | Sets the course title for `courseId`
-*RusticiSoftwareCloudV2::CourseApi* | [**set_course_version_configuration**](docs/CourseApi.md#set_course_version_configuration) | **POST** /courses/{courseId}/versions/{versionId}/configuration | Set configuration settings for this course and version.
-*RusticiSoftwareCloudV2::PingApi* | [**ping_app_id**](docs/PingApi.md#ping_app_id) | **GET** /ping | Get back a message indicating that the API is working.
-*RusticiSoftwareCloudV2::RegistrationApi* | [**create_new_registration_instance**](docs/RegistrationApi.md#create_new_registration_instance) | **POST** /registrations/{registrationId}/instances | Create a new instance for this registration specified by the registration ID
-*RusticiSoftwareCloudV2::RegistrationApi* | [**create_registration**](docs/RegistrationApi.md#create_registration) | **POST** /registrations | Create a registration.
-*RusticiSoftwareCloudV2::RegistrationApi* | [**delete_registration**](docs/RegistrationApi.md#delete_registration) | **DELETE** /registrations/{registrationId} | Delete `registrationId`
-*RusticiSoftwareCloudV2::RegistrationApi* | [**delete_registration_configuration_setting**](docs/RegistrationApi.md#delete_registration_configuration_setting) | **DELETE** /registrations/{registrationId}/configuration/{settingId} | Clears the `settingId` value for this registration
-*RusticiSoftwareCloudV2::RegistrationApi* | [**delete_registration_instance_configuration_setting**](docs/RegistrationApi.md#delete_registration_instance_configuration_setting) | **DELETE** /registrations/{registrationId}/instances/{instanceId}/configuration/{settingId} | Clears the `settingId` value for this registration instance
-*RusticiSoftwareCloudV2::RegistrationApi* | [**delete_registration_progress**](docs/RegistrationApi.md#delete_registration_progress) | **DELETE** /registrations/{registrationId}/progress | Delete registration progress (clear registration)
-*RusticiSoftwareCloudV2::RegistrationApi* | [**delete_registration_tags**](docs/RegistrationApi.md#delete_registration_tags) | **DELETE** /registrations/{registrationId}/tags | Delete tags for this registration
-*RusticiSoftwareCloudV2::RegistrationApi* | [**delete_registrations_global_data**](docs/RegistrationApi.md#delete_registrations_global_data) | **DELETE** /registrations/{registrationId}/globalData | Delete global data associated with `registrationId`
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_configuration**](docs/RegistrationApi.md#get_registration_configuration) | **GET** /registrations/{registrationId}/configuration | Returns all configuration settings for this registration
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_instance_configuration**](docs/RegistrationApi.md#get_registration_instance_configuration) | **GET** /registrations/{registrationId}/instances/{instanceId}/configuration | Returns all configuration settings for this registration instance
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_instance_launch_history**](docs/RegistrationApi.md#get_registration_instance_launch_history) | **GET** /registrations/{registrationId}/instances/{instanceId}/launchHistory | Returns history of this registration's launches
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_instance_progress**](docs/RegistrationApi.md#get_registration_instance_progress) | **GET** /registrations/{registrationId}/instances/{instanceId} | Get registration progress for instance `instanceId` of `registrationId`
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_instance_statements**](docs/RegistrationApi.md#get_registration_instance_statements) | **GET** /registrations/{registrationId}/instances/{instanceId}/xAPIStatements | Get xAPI statements for instance `instanceId` of `registrationId`
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_instances**](docs/RegistrationApi.md#get_registration_instances) | **GET** /registrations/{registrationId}/instances | Get all the instances of this the registration specified by the registration ID
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_launch_history**](docs/RegistrationApi.md#get_registration_launch_history) | **GET** /registrations/{registrationId}/launchHistory | Returns history of this registration's launches
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_launch_link**](docs/RegistrationApi.md#get_registration_launch_link) | **POST** /registrations/{registrationId}/launchLink | Returns the link to use to launch this registration
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_progress**](docs/RegistrationApi.md#get_registration_progress) | **GET** /registrations/{registrationId} | Get registration progress for `registrationId`
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_statements**](docs/RegistrationApi.md#get_registration_statements) | **GET** /registrations/{registrationId}/xAPIStatements | Get xAPI statements for `registrationId`
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_tags**](docs/RegistrationApi.md#get_registration_tags) | **GET** /registrations/{registrationId}/tags | Get the tags for this registration
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registrations**](docs/RegistrationApi.md#get_registrations) | **GET** /registrations | Gets a list of registrations including a summary of the status of each registration.
-*RusticiSoftwareCloudV2::RegistrationApi* | [**put_registration_tags**](docs/RegistrationApi.md#put_registration_tags) | **PUT** /registrations/{registrationId}/tags | Set the tags for this registration
-*RusticiSoftwareCloudV2::RegistrationApi* | [**put_registration_tags_batch**](docs/RegistrationApi.md#put_registration_tags_batch) | **PUT** /registrations/tags | Sets all of the provided tags on all of the provided registrations
-*RusticiSoftwareCloudV2::RegistrationApi* | [**registration_exists**](docs/RegistrationApi.md#registration_exists) | **HEAD** /registrations/{registrationId} | Does this registration exist?
-*RusticiSoftwareCloudV2::RegistrationApi* | [**set_registration_configuration**](docs/RegistrationApi.md#set_registration_configuration) | **POST** /registrations/{registrationId}/configuration | Set configuration settings for this registration.
-*RusticiSoftwareCloudV2::RegistrationApi* | [**set_registration_instance_configuration**](docs/RegistrationApi.md#set_registration_instance_configuration) | **POST** /registrations/{registrationId}/instances/{instanceId}/configuration | Set configuration settings for this registration instance.
-
-
-## Documentation for Models
-
- - [RusticiSoftwareCloudV2::ActivityResultSchema](docs/ActivityResultSchema.md)
- - [RusticiSoftwareCloudV2::ApplicationListSchema](docs/ApplicationListSchema.md)
- - [RusticiSoftwareCloudV2::ApplicationSchema](docs/ApplicationSchema.md)
- - [RusticiSoftwareCloudV2::ApplicationToken](docs/ApplicationToken.md)
- - [RusticiSoftwareCloudV2::CommentSchema](docs/CommentSchema.md)
- - [RusticiSoftwareCloudV2::CompletionAmountSchema](docs/CompletionAmountSchema.md)
- - [RusticiSoftwareCloudV2::CourseActivitySchema](docs/CourseActivitySchema.md)
- - [RusticiSoftwareCloudV2::CourseListNonPagedSchema](docs/CourseListNonPagedSchema.md)
- - [RusticiSoftwareCloudV2::CourseListSchema](docs/CourseListSchema.md)
- - [RusticiSoftwareCloudV2::CourseReferenceSchema](docs/CourseReferenceSchema.md)
- - [RusticiSoftwareCloudV2::CourseSchema](docs/CourseSchema.md)
- - [RusticiSoftwareCloudV2::CourseTagsBatchSchema](docs/CourseTagsBatchSchema.md)
- - [RusticiSoftwareCloudV2::CreateRegistrationSchema](docs/CreateRegistrationSchema.md)
- - [RusticiSoftwareCloudV2::CredentialCreatedSchema](docs/CredentialCreatedSchema.md)
- - [RusticiSoftwareCloudV2::CredentialListSchema](docs/CredentialListSchema.md)
- - [RusticiSoftwareCloudV2::CredentialRequestSchema](docs/CredentialRequestSchema.md)
- - [RusticiSoftwareCloudV2::CredentialSchema](docs/CredentialSchema.md)
- - [RusticiSoftwareCloudV2::ImportFetchRequestSchema](docs/ImportFetchRequestSchema.md)
- - [RusticiSoftwareCloudV2::ImportJobResultSchema](docs/ImportJobResultSchema.md)
- - [RusticiSoftwareCloudV2::ImportResultSchema](docs/ImportResultSchema.md)
- - [RusticiSoftwareCloudV2::IntegerResultSchema](docs/IntegerResultSchema.md)
- - [RusticiSoftwareCloudV2::ItemValuePairSchema](docs/ItemValuePairSchema.md)
- - [RusticiSoftwareCloudV2::LaunchHistoryListSchema](docs/LaunchHistoryListSchema.md)
- - [RusticiSoftwareCloudV2::LaunchHistorySchema](docs/LaunchHistorySchema.md)
- - [RusticiSoftwareCloudV2::LaunchLinkRequestSchema](docs/LaunchLinkRequestSchema.md)
- - [RusticiSoftwareCloudV2::LaunchLinkSchema](docs/LaunchLinkSchema.md)
- - [RusticiSoftwareCloudV2::LearnerPreferenceSchema](docs/LearnerPreferenceSchema.md)
- - [RusticiSoftwareCloudV2::LearnerSchema](docs/LearnerSchema.md)
- - [RusticiSoftwareCloudV2::LinkSchema](docs/LinkSchema.md)
- - [RusticiSoftwareCloudV2::MessageSchema](docs/MessageSchema.md)
- - [RusticiSoftwareCloudV2::MetadataSchema](docs/MetadataSchema.md)
- - [RusticiSoftwareCloudV2::ObjectiveSchema](docs/ObjectiveSchema.md)
- - [RusticiSoftwareCloudV2::PermissionsSchema](docs/PermissionsSchema.md)
- - [RusticiSoftwareCloudV2::PingSchema](docs/PingSchema.md)
- - [RusticiSoftwareCloudV2::PostBackSchema](docs/PostBackSchema.md)
- - [RusticiSoftwareCloudV2::RegistrationCompletion](docs/RegistrationCompletion.md)
- - [RusticiSoftwareCloudV2::RegistrationListSchema](docs/RegistrationListSchema.md)
- - [RusticiSoftwareCloudV2::RegistrationSchema](docs/RegistrationSchema.md)
- - [RusticiSoftwareCloudV2::RegistrationSuccess](docs/RegistrationSuccess.md)
- - [RusticiSoftwareCloudV2::RegistrationTagsBatchSchema](docs/RegistrationTagsBatchSchema.md)
- - [RusticiSoftwareCloudV2::ResponseError](docs/ResponseError.md)
- - [RusticiSoftwareCloudV2::RuntimeInteractionSchema](docs/RuntimeInteractionSchema.md)
- - [RusticiSoftwareCloudV2::RuntimeObjectiveSchema](docs/RuntimeObjectiveSchema.md)
- - [RusticiSoftwareCloudV2::RuntimeSchema](docs/RuntimeSchema.md)
- - [RusticiSoftwareCloudV2::ScoreSchema](docs/ScoreSchema.md)
- - [RusticiSoftwareCloudV2::SettingItem](docs/SettingItem.md)
- - [RusticiSoftwareCloudV2::SettingListSchema](docs/SettingListSchema.md)
- - [RusticiSoftwareCloudV2::SettingMetadata](docs/SettingMetadata.md)
- - [RusticiSoftwareCloudV2::SettingValidValue](docs/SettingValidValue.md)
- - [RusticiSoftwareCloudV2::SettingsIndividualSchema](docs/SettingsIndividualSchema.md)
- - [RusticiSoftwareCloudV2::SettingsPostSchema](docs/SettingsPostSchema.md)
- - [RusticiSoftwareCloudV2::SharedDataEntrySchema](docs/SharedDataEntrySchema.md)
- - [RusticiSoftwareCloudV2::StaticPropertiesSchema](docs/StaticPropertiesSchema.md)
- - [RusticiSoftwareCloudV2::StringResultSchema](docs/StringResultSchema.md)
- - [RusticiSoftwareCloudV2::TagListSchema](docs/TagListSchema.md)
- - [RusticiSoftwareCloudV2::TagPostSchema](docs/TagPostSchema.md)
- - [RusticiSoftwareCloudV2::TitleSchema](docs/TitleSchema.md)
- - [RusticiSoftwareCloudV2::TokenRequestSchema](docs/TokenRequestSchema.md)
- - [RusticiSoftwareCloudV2::XapiAccount](docs/XapiAccount.md)
- - [RusticiSoftwareCloudV2::XapiActivity](docs/XapiActivity.md)
- - [RusticiSoftwareCloudV2::XapiActivityDefinition](docs/XapiActivityDefinition.md)
- - [RusticiSoftwareCloudV2::XapiAgentGroup](docs/XapiAgentGroup.md)
- - [RusticiSoftwareCloudV2::XapiAttachment](docs/XapiAttachment.md)
- - [RusticiSoftwareCloudV2::XapiContext](docs/XapiContext.md)
- - [RusticiSoftwareCloudV2::XapiContextActivity](docs/XapiContextActivity.md)
- - [RusticiSoftwareCloudV2::XapiInteractionComponent](docs/XapiInteractionComponent.md)
- - [RusticiSoftwareCloudV2::XapiResult](docs/XapiResult.md)
- - [RusticiSoftwareCloudV2::XapiScore](docs/XapiScore.md)
- - [RusticiSoftwareCloudV2::XapiStatement](docs/XapiStatement.md)
- - [RusticiSoftwareCloudV2::XapiStatementReference](docs/XapiStatementReference.md)
- - [RusticiSoftwareCloudV2::XapiStatementResult](docs/XapiStatementResult.md)
- - [RusticiSoftwareCloudV2::XapiVerb](docs/XapiVerb.md)
-
-
-## Documentation for Authorization
-
-
-### APP_MANAGEMENT
-
-- **Type**: HTTP basic authentication
-
-### APP_NORMAL
-
-- **Type**: HTTP basic authentication
-
-### LAUNCH_TOKEN
-
-- **Type**: API key
-- **API key parameter name**: launchToken
-- **Location**: URL query string
-
-### OAUTH
-
-- **Type**: OAuth
-- **Flow**: application
-- **Authorization URL**: 
-- **Scopes**: 
-  - read: Grants read access
-  - write: Grants write access
-  - delete: Grants deletion access
-  - admin: Grants read, write, and account management access
-  - read:course: Grants read access to course methods
-  - write:course: Grants write access to course methods
-  - delete:course: Grants deletion access to course methods
-  - read:dispatch: Grants read access to dispatch methods
-  - write:dispatch: Grants write access to dispatch methods
-  - delete:dispatch: Grants deletion access to dispatch methods
-  - read:invitation: Grants read access to invitation methods
-  - write:invitation: Grants write access to invitation methods
-  - delete:invitation: Grants deletion access to invitation methods
-  - read:ping: Grants read access to the ping method
-  - read:registration: Grants read access to registration methods
-  - write:registration: Grants write access to registration methods
-  - delete:registration: Grants deletion access to registration methods
-  - read:reporting: Grants read access to reporting methods
-  - read:xapicredential: Grants read access to xapi credential methods
-  - write:xapicredential: Grants write access to xapi credential methods
-  - delete:xapicredential: Grants deletion access to xapi credential methods
-  - read:xapipipe: Grants read access to xapi pipe methods
-  - write:xapipipe: Grants write access to xapi pipe methods
-  - delete:xapipipe: Grants deletion access to xapi pipe methods
-  - read:appmgmt: Grants read access to app management methods
-  - write:appmgmt: Grants write access to app management methods
-  - delete:appmgmt: Grants deletion access to app management methods
-
-### URL_TOKEN
-
-- **Type**: API key
-- **API key parameter name**: authtoken
-- **Location**: URL query string
+if __FILE__ == $0
+    main
+end
 
+```