rustici_software_cloud_v2 1.1.0 → 2.1.0

data/README.md

@@ -7,389 +7,388 @@ 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
-- Package version: 1.1.0
+- Package version: 2.1.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.1.0.gem
+gem install ./rustici_software_cloud_v2-2.1.0.gem
 ```
-(for development, run `gem install --dev ./rustici_software_cloud_v2-1.1.0.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.1.0.gem` to install the development dependencies
 
 Finally add this to the Gemfile:
 
-    gem 'rustici_software_cloud_v2', '~> 1.1.0'
+    gem 'rustici_software_cloud_v2', '~> 2.1.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:
+## Changelog:
+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"
 
-# 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
+# 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
+
+
+
+        # Create the registration launch link
+        launch_link = sc.build_launch_link(REGISTRATION_ID)
 
-api_instance = RusticiSoftwareCloudV2::AboutApi.new
+        # 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
-  #Get back the API version and application name. 
-  result = api_instance.get_about
-  p result
-rescue RusticiSoftwareCloudV2::ApiError => e
-  puts "Exception when calling AboutApi->get_about: #{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::AboutApi* | [**get_about**](docs/AboutApi.md#get_about) | **GET** /about | Get back the API version and application name. 
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**create_application**](docs/ApplicationManagementApi.md#create_application) | **POST** /appManagement/applications | 
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**create_credential**](docs/ApplicationManagementApi.md#create_credential) | **POST** /appManagement/{childAppId}/credentials | 
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**create_token**](docs/ApplicationManagementApi.md#create_token) | **POST** /appManagement/token | 
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**delete_application**](docs/ApplicationManagementApi.md#delete_application) | **DELETE** /appManagement/applications/{childAppId} | 
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**delete_application_configuration_setting**](docs/ApplicationManagementApi.md#delete_application_configuration_setting) | **DELETE** /appManagement/configuration/{settingId} | Clears the `settingId` value for this level 
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**delete_credential**](docs/ApplicationManagementApi.md#delete_credential) | **DELETE** /appManagement/{childAppId}/credentials/{credentialId} | 
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**get_application_configuration**](docs/ApplicationManagementApi.md#get_application_configuration) | **GET** /appManagement/configuration | 
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**get_application_list**](docs/ApplicationManagementApi.md#get_application_list) | **GET** /appManagement/applications | Get a list of all applications for the realm.
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**get_credentials**](docs/ApplicationManagementApi.md#get_credentials) | **GET** /appManagement/{childAppId}/credentials | 
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**set_application_configuration**](docs/ApplicationManagementApi.md#set_application_configuration) | **POST** /appManagement/configuration | 
-*RusticiSoftwareCloudV2::ApplicationManagementApi* | [**update_credential**](docs/ApplicationManagementApi.md#update_credential) | **PUT** /appManagement/{childAppId}/credentials/{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 | Get a link to preview a 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 | Get a link to preview a particular course version. 
-*RusticiSoftwareCloudV2::CourseApi* | [**create_fetch_and_import_course_job**](docs/CourseApi.md#create_fetch_and_import_course_job) | **POST** /courses/importJobs | 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 and import a course.
-*RusticiSoftwareCloudV2::CourseApi* | [**delete_course**](docs/CourseApi.md#delete_course) | **DELETE** /courses/{courseId} | Delete a course. 
-*RusticiSoftwareCloudV2::CourseApi* | [**delete_course_configuration_setting**](docs/CourseApi.md#delete_course_configuration_setting) | **DELETE** /courses/{courseId}/configuration/{settingId} | Clear a course configuration. 
-*RusticiSoftwareCloudV2::CourseApi* | [**delete_course_tags**](docs/CourseApi.md#delete_course_tags) | **DELETE** /courses/{courseId}/tags | Delete course tags. 
-*RusticiSoftwareCloudV2::CourseApi* | [**delete_course_version**](docs/CourseApi.md#delete_course_version) | **DELETE** /courses/{courseId}/versions/{versionId} | Delete a course version. 
-*RusticiSoftwareCloudV2::CourseApi* | [**delete_course_version_configuration_setting**](docs/CourseApi.md#delete_course_version_configuration_setting) | **DELETE** /courses/{courseId}/versions/{versionId}/configuration/{settingId} | Clear a configuration setting for a version of a course. 
-*RusticiSoftwareCloudV2::CourseApi* | [**get_course**](docs/CourseApi.md#get_course) | **GET** /courses/{courseId} | Get course details. 
-*RusticiSoftwareCloudV2::CourseApi* | [**get_course_configuration**](docs/CourseApi.md#get_course_configuration) | **GET** /courses/{courseId}/configuration | Get course configuration. 
-*RusticiSoftwareCloudV2::CourseApi* | [**get_course_statements**](docs/CourseApi.md#get_course_statements) | **GET** /courses/{courseId}/xAPIStatements | Get course xAPI statements. 
-*RusticiSoftwareCloudV2::CourseApi* | [**get_course_tags**](docs/CourseApi.md#get_course_tags) | **GET** /courses/{courseId}/tags | Get course tags. 
-*RusticiSoftwareCloudV2::CourseApi* | [**get_course_version_configuration**](docs/CourseApi.md#get_course_version_configuration) | **GET** /courses/{courseId}/versions/{versionId}/configuration | Get configuration for a version of a course. 
-*RusticiSoftwareCloudV2::CourseApi* | [**get_course_version_info**](docs/CourseApi.md#get_course_version_info) | **GET** /courses/{courseId}/versions/{versionId} | Get details on a course version. 
-*RusticiSoftwareCloudV2::CourseApi* | [**get_course_version_statements**](docs/CourseApi.md#get_course_version_statements) | **GET** /courses/{courseId}/versions/{versionId}/xAPIStatements | Get xAPI statements for a course version. 
-*RusticiSoftwareCloudV2::CourseApi* | [**get_course_versions**](docs/CourseApi.md#get_course_versions) | **GET** /courses/{courseId}/versions | Get details on a course's versions. 
-*RusticiSoftwareCloudV2::CourseApi* | [**get_courses**](docs/CourseApi.md#get_courses) | **GET** /courses | Get all courses. 
-*RusticiSoftwareCloudV2::CourseApi* | [**get_import_job_status**](docs/CourseApi.md#get_import_job_status) | **GET** /courses/importJobs/{importJobId} | Get course import job status. 
-*RusticiSoftwareCloudV2::CourseApi* | [**put_course_tags**](docs/CourseApi.md#put_course_tags) | **PUT** /courses/{courseId}/tags | Set course tags. 
-*RusticiSoftwareCloudV2::CourseApi* | [**put_course_tags_batch**](docs/CourseApi.md#put_course_tags_batch) | **PUT** /courses/tags | Set tags on courses. 
-*RusticiSoftwareCloudV2::CourseApi* | [**set_course_configuration**](docs/CourseApi.md#set_course_configuration) | **POST** /courses/{courseId}/configuration | Set course configuration. 
-*RusticiSoftwareCloudV2::CourseApi* | [**set_course_title**](docs/CourseApi.md#set_course_title) | **PUT** /courses/{courseId}/title | Set the title of a course. 
-*RusticiSoftwareCloudV2::CourseApi* | [**set_course_version_configuration**](docs/CourseApi.md#set_course_version_configuration) | **POST** /courses/{courseId}/versions/{versionId}/configuration | Set configuration for a version of a course. 
-*RusticiSoftwareCloudV2::DispatchApi* | [**create_destinations**](docs/DispatchApi.md#create_destinations) | **POST** /dispatch/destinations | DestinationsByTenant
-*RusticiSoftwareCloudV2::DispatchApi* | [**create_dispatches**](docs/DispatchApi.md#create_dispatches) | **POST** /dispatch/dispatches | Create dispatches.
-*RusticiSoftwareCloudV2::DispatchApi* | [**delete_destination**](docs/DispatchApi.md#delete_destination) | **DELETE** /dispatch/destinations/{destinationId} | Delete destination 
-*RusticiSoftwareCloudV2::DispatchApi* | [**delete_destination_dispatches**](docs/DispatchApi.md#delete_destination_dispatches) | **DELETE** /dispatch/destinations/{destinationId}/dispatches | Delete dispatches in destination 
-*RusticiSoftwareCloudV2::DispatchApi* | [**delete_destination_tags**](docs/DispatchApi.md#delete_destination_tags) | **DELETE** /dispatch/destinations/{destinationId}/tags | Delete the tags for this destination 
-*RusticiSoftwareCloudV2::DispatchApi* | [**delete_dispatch**](docs/DispatchApi.md#delete_dispatch) | **DELETE** /dispatch/dispatches/{dispatchId} | Delete the dispatch with `dispatchId`. 
-*RusticiSoftwareCloudV2::DispatchApi* | [**delete_dispatch_postback_info**](docs/DispatchApi.md#delete_dispatch_postback_info) | **DELETE** /dispatch/dispatches/{dispatchId}/postback | DispatchesByTenantAndDispatchId
-*RusticiSoftwareCloudV2::DispatchApi* | [**delete_dispatch_tags**](docs/DispatchApi.md#delete_dispatch_tags) | **DELETE** /dispatch/dispatches/{dispatchId}/tags | Delete the tags for this dispatch. 
-*RusticiSoftwareCloudV2::DispatchApi* | [**enable_registration_instancing**](docs/DispatchApi.md#enable_registration_instancing) | **POST** /dispatch/destinations/{destinationId}/dispatches/registrationInstancing | DestinationsDispatchesRegistrationInstancing
-*RusticiSoftwareCloudV2::DispatchApi* | [**get_destination**](docs/DispatchApi.md#get_destination) | **GET** /dispatch/destinations/{destinationId} | Get destination information by destinationId.
-*RusticiSoftwareCloudV2::DispatchApi* | [**get_destination_dispatch_registration_count**](docs/DispatchApi.md#get_destination_dispatch_registration_count) | **GET** /dispatch/destinations/{destinationId}/dispatches/registrationCount | DestinationsDispatchesRegistrationCount
-*RusticiSoftwareCloudV2::DispatchApi* | [**get_destination_dispatch_zip**](docs/DispatchApi.md#get_destination_dispatch_zip) | **GET** /dispatch/destinations/{destinationId}/dispatches/zip | Get a ZIP of related dispatches.
-*RusticiSoftwareCloudV2::DispatchApi* | [**get_destination_dispatches**](docs/DispatchApi.md#get_destination_dispatches) | **GET** /dispatch/destinations/{destinationId}/dispatches | Get a list of dispatches in this destination
-*RusticiSoftwareCloudV2::DispatchApi* | [**get_destination_hash_user_info**](docs/DispatchApi.md#get_destination_hash_user_info) | **GET** /dispatch/destinations/{destinationId}/dispatches/hashUserInfo | True if the destination is set to hash user info, or false if it is disabled.
-*RusticiSoftwareCloudV2::DispatchApi* | [**get_destination_tags**](docs/DispatchApi.md#get_destination_tags) | **GET** /dispatch/destinations/{destinationId}/tags | Get the tags for this destination 
-*RusticiSoftwareCloudV2::DispatchApi* | [**get_destinations**](docs/DispatchApi.md#get_destinations) | **GET** /dispatch/destinations | getAllDestinations
-*RusticiSoftwareCloudV2::DispatchApi* | [**get_dispatch**](docs/DispatchApi.md#get_dispatch) | **GET** /dispatch/dispatches/{dispatchId} | Get dispatch by id.
-*RusticiSoftwareCloudV2::DispatchApi* | [**get_dispatch_enabled**](docs/DispatchApi.md#get_dispatch_enabled) | **GET** /dispatch/dispatches/{dispatchId}/enabled | Get the `enabled` status for `dispatchId`. 
-*RusticiSoftwareCloudV2::DispatchApi* | [**get_dispatch_hash_user_info**](docs/DispatchApi.md#get_dispatch_hash_user_info) | **GET** /dispatch/dispatches/{dispatchId}/hashUserInfo | Get if this dispatch has PII hashing enabled.
-*RusticiSoftwareCloudV2::DispatchApi* | [**get_dispatch_registration_count**](docs/DispatchApi.md#get_dispatch_registration_count) | **GET** /dispatch/dispatches/{dispatchId}/registrationCount | Get the registration count for `dispatchId`. 
-*RusticiSoftwareCloudV2::DispatchApi* | [**get_dispatch_tags**](docs/DispatchApi.md#get_dispatch_tags) | **GET** /dispatch/dispatches/{dispatchId}/tags | Get the tags for this dispatch. 
-*RusticiSoftwareCloudV2::DispatchApi* | [**get_dispatch_zip**](docs/DispatchApi.md#get_dispatch_zip) | **GET** /dispatch/dispatches/{dispatchId}/zip | Get the ZIP for the dispatchId.
-*RusticiSoftwareCloudV2::DispatchApi* | [**get_dispatches**](docs/DispatchApi.md#get_dispatches) | **GET** /dispatch/dispatches | All Dispatches in the system for an AppId
-*RusticiSoftwareCloudV2::DispatchApi* | [**put_destination_tags**](docs/DispatchApi.md#put_destination_tags) | **PUT** /dispatch/destinations/{destinationId}/tags | Set the tags for this destination 
-*RusticiSoftwareCloudV2::DispatchApi* | [**put_destination_tags_batch**](docs/DispatchApi.md#put_destination_tags_batch) | **PUT** /dispatch/destinations/tags | Sets all of the provided tags on all of the provided destinations
-*RusticiSoftwareCloudV2::DispatchApi* | [**put_dispatch_tags**](docs/DispatchApi.md#put_dispatch_tags) | **PUT** /dispatch/dispatches/{dispatchId}/tags | Set the tags for this dispatch. 
-*RusticiSoftwareCloudV2::DispatchApi* | [**put_dispatch_tags_batch**](docs/DispatchApi.md#put_dispatch_tags_batch) | **PUT** /dispatch/dispatches/tags | Sets all of the provided tags on all of the provided dispatches 
-*RusticiSoftwareCloudV2::DispatchApi* | [**reset_destination_dispatch_registration_count**](docs/DispatchApi.md#reset_destination_dispatch_registration_count) | **DELETE** /dispatch/destinations/{destinationId}/dispatches/registrationCount | DestinationsDispatchesRegistrationCount
-*RusticiSoftwareCloudV2::DispatchApi* | [**reset_dispatch_registration_count**](docs/DispatchApi.md#reset_dispatch_registration_count) | **DELETE** /dispatch/dispatches/{dispatchId}/registrationCount | Reset registration count. 
-*RusticiSoftwareCloudV2::DispatchApi* | [**set_destination**](docs/DispatchApi.md#set_destination) | **PUT** /dispatch/destinations/{destinationId} | 
-*RusticiSoftwareCloudV2::DispatchApi* | [**set_destination_dispatch_enabled**](docs/DispatchApi.md#set_destination_dispatch_enabled) | **POST** /dispatch/destinations/{destinationId}/dispatches/enabled | DestinationsDispatchesEnabledByTenant
-*RusticiSoftwareCloudV2::DispatchApi* | [**set_dispatch_enabled**](docs/DispatchApi.md#set_dispatch_enabled) | **PUT** /dispatch/dispatches/{dispatchId}/enabled | Set the `enabled` status for `dispatchId`. 
-*RusticiSoftwareCloudV2::DispatchApi* | [**update_destination_hash_user_info**](docs/DispatchApi.md#update_destination_hash_user_info) | **PUT** /dispatch/destinations/{destinationId}/dispatches/hashUserInfo | Enable or disable hashing of the user info for the destination.
-*RusticiSoftwareCloudV2::DispatchApi* | [**update_dispatch**](docs/DispatchApi.md#update_dispatch) | **PUT** /dispatch/dispatches/{dispatchId} | Update the dispatch with `dispatchId`. 
-*RusticiSoftwareCloudV2::DispatchApi* | [**update_dispatch_hash_user_info**](docs/DispatchApi.md#update_dispatch_hash_user_info) | **PUT** /dispatch/dispatches/{dispatchId}/hashUserInfo | Enable or disable hashing of the user info for the dispatch.
-*RusticiSoftwareCloudV2::InvitationsApi* | [**create_private_invitation**](docs/InvitationsApi.md#create_private_invitation) | **POST** /invitations/private | Create a private invitation to a course.
-*RusticiSoftwareCloudV2::InvitationsApi* | [**create_public_invitation**](docs/InvitationsApi.md#create_public_invitation) | **POST** /invitations/public | Create a publicly accessible invitation to a course.
-*RusticiSoftwareCloudV2::InvitationsApi* | [**delete_invitation_tags**](docs/InvitationsApi.md#delete_invitation_tags) | **DELETE** /invitations/{invitationId}/tags | Delete the tags for this invitation 
-*RusticiSoftwareCloudV2::InvitationsApi* | [**get_all_invitations**](docs/InvitationsApi.md#get_all_invitations) | **GET** /invitations | Get a list of invitation summaries.
-*RusticiSoftwareCloudV2::InvitationsApi* | [**get_invitation_tags**](docs/InvitationsApi.md#get_invitation_tags) | **GET** /invitations/{invitationId}/tags | Get the tags for this invitation 
-*RusticiSoftwareCloudV2::InvitationsApi* | [**get_private_invitation**](docs/InvitationsApi.md#get_private_invitation) | **GET** /invitations/private/{invitationId} | Get a information about a private invitation.
-*RusticiSoftwareCloudV2::InvitationsApi* | [**get_private_invitation_job_status**](docs/InvitationsApi.md#get_private_invitation_job_status) | **GET** /invitations/private/{invitationId}/jobStatus | Get the status of an invitation job.
-*RusticiSoftwareCloudV2::InvitationsApi* | [**get_private_invitations**](docs/InvitationsApi.md#get_private_invitations) | **GET** /invitations/private | Get a list of all private invitations.
-*RusticiSoftwareCloudV2::InvitationsApi* | [**get_private_user_invitations**](docs/InvitationsApi.md#get_private_user_invitations) | **GET** /invitations/private/{invitationId}/userInvitations | Get a list of user invitations.
-*RusticiSoftwareCloudV2::InvitationsApi* | [**get_public_invitation**](docs/InvitationsApi.md#get_public_invitation) | **GET** /invitations/public/{invitationId} | Get a information about a public invitation.
-*RusticiSoftwareCloudV2::InvitationsApi* | [**get_public_invitations**](docs/InvitationsApi.md#get_public_invitations) | **GET** /invitations/public | Get a list of all public invitations.
-*RusticiSoftwareCloudV2::InvitationsApi* | [**get_public_user_invitations**](docs/InvitationsApi.md#get_public_user_invitations) | **GET** /invitations/public/{invitationId}/userInvitations | Get a list of user invitations.
-*RusticiSoftwareCloudV2::InvitationsApi* | [**put_invitation_tags**](docs/InvitationsApi.md#put_invitation_tags) | **PUT** /invitations/{invitationId}/tags | Set the tags for this invitation 
-*RusticiSoftwareCloudV2::InvitationsApi* | [**put_invitation_tags_batch**](docs/InvitationsApi.md#put_invitation_tags_batch) | **PUT** /invitations/tags | Sets all of the provided tags on all of the provided invitations 
-*RusticiSoftwareCloudV2::InvitationsApi* | [**update_private_invitation**](docs/InvitationsApi.md#update_private_invitation) | **PUT** /invitations/private/{invitationId} | Update attributes of this invitation.
-*RusticiSoftwareCloudV2::InvitationsApi* | [**update_public_invitation**](docs/InvitationsApi.md#update_public_invitation) | **PUT** /invitations/public/{invitationId} | Update attributes of this invitation.
-*RusticiSoftwareCloudV2::LearnerApi* | [**delete_all_learner_data**](docs/LearnerApi.md#delete_all_learner_data) | **POST** /learner/{learnerId}/delete-information | Deletes all of the information associated with a learner in an application, by learner id. 
-*RusticiSoftwareCloudV2::LearnerApi* | [**delete_learner_tags**](docs/LearnerApi.md#delete_learner_tags) | **DELETE** /learner/{learnerId}/tags | Delete the tags for this learner 
-*RusticiSoftwareCloudV2::LearnerApi* | [**get_learner_tags**](docs/LearnerApi.md#get_learner_tags) | **GET** /learner/{learnerId}/tags | Get the tags for this learner 
-*RusticiSoftwareCloudV2::LearnerApi* | [**put_learner_tags**](docs/LearnerApi.md#put_learner_tags) | **PUT** /learner/{learnerId}/tags | Set the tags for this learner 
-*RusticiSoftwareCloudV2::LearnerApi* | [**put_learner_tags_batch**](docs/LearnerApi.md#put_learner_tags_batch) | **PUT** /learner/tags | Sets all of the provided tags on all of the provided learners
-*RusticiSoftwareCloudV2::LearnerApi* | [**update_learner_info**](docs/LearnerApi.md#update_learner_info) | **POST** /learner/{learnerId}/updateInfo | Update a learner's info on all of their registrations.
-*RusticiSoftwareCloudV2::PingApi* | [**ping_app_id**](docs/PingApi.md#ping_app_id) | **GET** /ping | 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**build_registration_launch_link**](docs/RegistrationApi.md#build_registration_launch_link) | **POST** /registrations/{registrationId}/launchLink | Get registration launch link. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**create_new_registration_instance**](docs/RegistrationApi.md#create_new_registration_instance) | **POST** /registrations/{registrationId}/instances | 
-*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 a registration. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**delete_registration_configuration_setting**](docs/RegistrationApi.md#delete_registration_configuration_setting) | **DELETE** /registrations/{registrationId}/configuration/{settingId} | Clear a registration configuration. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**delete_registration_global_data**](docs/RegistrationApi.md#delete_registration_global_data) | **DELETE** /registrations/{registrationId}/globalData | Delete the global data of a registration. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**delete_registration_instance**](docs/RegistrationApi.md#delete_registration_instance) | **DELETE** /registrations/{registrationId}/instances/{instanceId} | Delete instance `instanceId` of `registrationId`. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**delete_registration_instance_configuration_setting**](docs/RegistrationApi.md#delete_registration_instance_configuration_setting) | **DELETE** /registrations/{registrationId}/instances/{instanceId}/configuration/{settingId} | Clear a configuration for an instance of a registration. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**delete_registration_progress**](docs/RegistrationApi.md#delete_registration_progress) | **DELETE** /registrations/{registrationId}/progress | Reset a registration. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**delete_registration_tags**](docs/RegistrationApi.md#delete_registration_tags) | **DELETE** /registrations/{registrationId}/tags | Delete tags from a registration. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration**](docs/RegistrationApi.md#get_registration) | **HEAD** /registrations/{registrationId} | See if a registration exists. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_configuration**](docs/RegistrationApi.md#get_registration_configuration) | **GET** /registrations/{registrationId}/configuration | Get registration configuration. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_instance_configuration**](docs/RegistrationApi.md#get_registration_instance_configuration) | **GET** /registrations/{registrationId}/instances/{instanceId}/configuration | Get configuration for instance of registration. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_instance_launch_history**](docs/RegistrationApi.md#get_registration_instance_launch_history) | **GET** /registrations/{registrationId}/instances/{instanceId}/launchHistory | Get launch history for an instance of a registration. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_instance_progress**](docs/RegistrationApi.md#get_registration_instance_progress) | **GET** /registrations/{registrationId}/instances/{instanceId} | Get details of an instance of a registration. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_instance_statements**](docs/RegistrationApi.md#get_registration_instance_statements) | **GET** /registrations/{registrationId}/instances/{instanceId}/xAPIStatements | Get xAPI statements for an instance of a registration. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_instances**](docs/RegistrationApi.md#get_registration_instances) | **GET** /registrations/{registrationId}/instances | Get all instances of a registration. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_launch_history**](docs/RegistrationApi.md#get_registration_launch_history) | **GET** /registrations/{registrationId}/launchHistory | Get launch history for a registration. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_progress**](docs/RegistrationApi.md#get_registration_progress) | **GET** /registrations/{registrationId} | Get details of a registration. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_statements**](docs/RegistrationApi.md#get_registration_statements) | **GET** /registrations/{registrationId}/xAPIStatements | Get xAPI statements for a registration. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_tags**](docs/RegistrationApi.md#get_registration_tags) | **GET** /registrations/{registrationId}/tags | Get tags for a registration. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**get_registrations**](docs/RegistrationApi.md#get_registrations) | **GET** /registrations | Get a list of all registrations. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**put_registration_tags**](docs/RegistrationApi.md#put_registration_tags) | **PUT** /registrations/{registrationId}/tags | Set tags on a registration. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**put_registration_tags_batch**](docs/RegistrationApi.md#put_registration_tags_batch) | **PUT** /registrations/tags | Set tags on registrations. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**set_registration_configuration**](docs/RegistrationApi.md#set_registration_configuration) | **POST** /registrations/{registrationId}/configuration | Set registration configuration. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**set_registration_instance_configuration**](docs/RegistrationApi.md#set_registration_instance_configuration) | **POST** /registrations/{registrationId}/instances/{instanceId}/configuration | Set configuration for instance of registration. 
-*RusticiSoftwareCloudV2::RegistrationApi* | [**test_registration_postback**](docs/RegistrationApi.md#test_registration_postback) | **POST** /registrations/postBackTest | Send a test postback with a provided configuration. 
-*RusticiSoftwareCloudV2::ReportingApi* | [**get_account_info**](docs/ReportingApi.md#get_account_info) | **GET** /reporting/accountInfo | Get all of the account information specified by the given app ID
-*RusticiSoftwareCloudV2::ReportingApi* | [**get_reportage_auth_token**](docs/ReportingApi.md#get_reportage_auth_token) | **GET** /reporting/reportageAuth | Get a session authentication token to use when launching Reportage
-*RusticiSoftwareCloudV2::ReportingApi* | [**get_reportage_link**](docs/ReportingApi.md#get_reportage_link) | **GET** /reporting/reportageLink | Get the link to a page in Reportage with the given authentication and permissions
-*RusticiSoftwareCloudV2::XapiApi* | [**create_statement_pipe**](docs/XapiApi.md#create_statement_pipe) | **POST** /xapi/statementPipes | Create an xAPI statement pipe.
-*RusticiSoftwareCloudV2::XapiApi* | [**create_xapi_credential**](docs/XapiApi.md#create_xapi_credential) | **POST** /xapi/credentials | Create a xAPI credential.
-*RusticiSoftwareCloudV2::XapiApi* | [**delete_statement_pipe**](docs/XapiApi.md#delete_statement_pipe) | **DELETE** /xapi/statementPipes/{statementPipeId} | Deletes this xAPI pipe.
-*RusticiSoftwareCloudV2::XapiApi* | [**delete_xapi_credential**](docs/XapiApi.md#delete_xapi_credential) | **DELETE** /xapi/credentials/{xapiCredentialId} | Deletes the xAPI credentials specified by the xAPI credentials id
-*RusticiSoftwareCloudV2::XapiApi* | [**get_statement_pipe**](docs/XapiApi.md#get_statement_pipe) | **GET** /xapi/statementPipes/{statementPipeId} | Retrieves xAPI pipe for `xapiPipeId`
-*RusticiSoftwareCloudV2::XapiApi* | [**get_statement_pipes**](docs/XapiApi.md#get_statement_pipes) | **GET** /xapi/statementPipes | Get all of the xapiPipes for `appId`
-*RusticiSoftwareCloudV2::XapiApi* | [**get_xapi_credential**](docs/XapiApi.md#get_xapi_credential) | **GET** /xapi/credentials/{xapiCredentialId} | Retrieves the xAPI credentials specified by the xAPI credentials id.
-*RusticiSoftwareCloudV2::XapiApi* | [**get_xapi_credentials**](docs/XapiApi.md#get_xapi_credentials) | **GET** /xapi/credentials | Get the list of xapiCredentials
-*RusticiSoftwareCloudV2::XapiApi* | [**set_statement_pipe**](docs/XapiApi.md#set_statement_pipe) | **PUT** /xapi/statementPipes/{statementPipeId} | Edit an existing xAPI pipe or create a new one.
-*RusticiSoftwareCloudV2::XapiApi* | [**set_xapi_credential**](docs/XapiApi.md#set_xapi_credential) | **PUT** /xapi/credentials/{xapiCredentialId} | Edit an existing xAPI credential or create a new one, specified by the xAPI credentials id
-*RusticiSoftwareCloudV2::ZoomiApi* | [**delete_application_zoomi_keys**](docs/ZoomiApi.md#delete_application_zoomi_keys) | **DELETE** /zoomi/key | Delete the keys for an application.
-*RusticiSoftwareCloudV2::ZoomiApi* | [**delete_zoomi_course**](docs/ZoomiApi.md#delete_zoomi_course) | **DELETE** /zoomi/course/{courseId}/version/{versionId} | Deletes the course in zoomi
-*RusticiSoftwareCloudV2::ZoomiApi* | [**get_application_zoomi_company_id**](docs/ZoomiApi.md#get_application_zoomi_company_id) | **GET** /zoomi | Gets the zoomi company id of an application.
-*RusticiSoftwareCloudV2::ZoomiApi* | [**get_application_zoomi_public_key**](docs/ZoomiApi.md#get_application_zoomi_public_key) | **GET** /zoomi/key | Gets the public key for an application.
-*RusticiSoftwareCloudV2::ZoomiApi* | [**get_course_zoomi_enabled**](docs/ZoomiApi.md#get_course_zoomi_enabled) | **GET** /zoomi/course/{courseId}/version/{versionId}/enabled | Gets the zoomi enabled value of a course
-*RusticiSoftwareCloudV2::ZoomiApi* | [**get_zoomi_course_status**](docs/ZoomiApi.md#get_zoomi_course_status) | **GET** /zoomi/course/{courseId}/version/{versionId} | Gets the status for a course and imports to Zoomi
-*RusticiSoftwareCloudV2::ZoomiApi* | [**set_application_zoomi_company_id**](docs/ZoomiApi.md#set_application_zoomi_company_id) | **PUT** /zoomi | Set the zoomi company id value of an application.
-*RusticiSoftwareCloudV2::ZoomiApi* | [**set_course_zoomi_enabled**](docs/ZoomiApi.md#set_course_zoomi_enabled) | **PUT** /zoomi/course/{courseId}/version/{versionId}/enabled | Set the zoomi enabled value of a course.
-
-
-## Documentation for Models
-
- - [RusticiSoftwareCloudV2::AboutSchema](docs/AboutSchema.md)
- - [RusticiSoftwareCloudV2::ActivityResultSchema](docs/ActivityResultSchema.md)
- - [RusticiSoftwareCloudV2::ApplicationListSchema](docs/ApplicationListSchema.md)
- - [RusticiSoftwareCloudV2::ApplicationSchema](docs/ApplicationSchema.md)
- - [RusticiSoftwareCloudV2::ApplicationToken](docs/ApplicationToken.md)
- - [RusticiSoftwareCloudV2::BatchTagsSchema](docs/BatchTagsSchema.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::CreateDispatchIdSchema](docs/CreateDispatchIdSchema.md)
- - [RusticiSoftwareCloudV2::CreateDispatchListSchema](docs/CreateDispatchListSchema.md)
- - [RusticiSoftwareCloudV2::CreateDispatchSchema](docs/CreateDispatchSchema.md)
- - [RusticiSoftwareCloudV2::CreatePrivateInvitationSchema](docs/CreatePrivateInvitationSchema.md)
- - [RusticiSoftwareCloudV2::CreatePublicInvitationSchema](docs/CreatePublicInvitationSchema.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::DestinationIdSchema](docs/DestinationIdSchema.md)
- - [RusticiSoftwareCloudV2::DestinationListSchema](docs/DestinationListSchema.md)
- - [RusticiSoftwareCloudV2::DestinationSchema](docs/DestinationSchema.md)
- - [RusticiSoftwareCloudV2::DispatchIdSchema](docs/DispatchIdSchema.md)
- - [RusticiSoftwareCloudV2::DispatchListSchema](docs/DispatchListSchema.md)
- - [RusticiSoftwareCloudV2::DispatchRegistrationCountSchema](docs/DispatchRegistrationCountSchema.md)
- - [RusticiSoftwareCloudV2::DispatchSchema](docs/DispatchSchema.md)
- - [RusticiSoftwareCloudV2::EnabledSchema](docs/EnabledSchema.md)
- - [RusticiSoftwareCloudV2::ImportFetchRequestSchema](docs/ImportFetchRequestSchema.md)
- - [RusticiSoftwareCloudV2::ImportJobResultSchema](docs/ImportJobResultSchema.md)
- - [RusticiSoftwareCloudV2::ImportResultSchema](docs/ImportResultSchema.md)
- - [RusticiSoftwareCloudV2::IntegerResultSchema](docs/IntegerResultSchema.md)
- - [RusticiSoftwareCloudV2::InvitationEmailSchema](docs/InvitationEmailSchema.md)
- - [RusticiSoftwareCloudV2::InvitationJobStatusSchema](docs/InvitationJobStatusSchema.md)
- - [RusticiSoftwareCloudV2::InvitationSummaryList](docs/InvitationSummaryList.md)
- - [RusticiSoftwareCloudV2::InvitationSummarySchema](docs/InvitationSummarySchema.md)
- - [RusticiSoftwareCloudV2::ItemValuePairSchema](docs/ItemValuePairSchema.md)
- - [RusticiSoftwareCloudV2::LaunchAuthOptionsSchema](docs/LaunchAuthOptionsSchema.md)
- - [RusticiSoftwareCloudV2::LaunchAuthSchema](docs/LaunchAuthSchema.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::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::PrivateInvitationList](docs/PrivateInvitationList.md)
- - [RusticiSoftwareCloudV2::PrivateInvitationSchema](docs/PrivateInvitationSchema.md)
- - [RusticiSoftwareCloudV2::PublicInvitationList](docs/PublicInvitationList.md)
- - [RusticiSoftwareCloudV2::PublicInvitationSchema](docs/PublicInvitationSchema.md)
- - [RusticiSoftwareCloudV2::RegistrationCompletion](docs/RegistrationCompletion.md)
- - [RusticiSoftwareCloudV2::RegistrationListSchema](docs/RegistrationListSchema.md)
- - [RusticiSoftwareCloudV2::RegistrationSchema](docs/RegistrationSchema.md)
- - [RusticiSoftwareCloudV2::RegistrationSuccess](docs/RegistrationSuccess.md)
- - [RusticiSoftwareCloudV2::ReportageAccountInfoSchema](docs/ReportageAccountInfoSchema.md)
- - [RusticiSoftwareCloudV2::ReportageAccountInfoUsageSchema](docs/ReportageAccountInfoUsageSchema.md)
- - [RusticiSoftwareCloudV2::ReportageAuthTokenSchema](docs/ReportageAuthTokenSchema.md)
- - [RusticiSoftwareCloudV2::ReportageLinkSchema](docs/ReportageLinkSchema.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::TitleSchema](docs/TitleSchema.md)
- - [RusticiSoftwareCloudV2::TokenRequestSchema](docs/TokenRequestSchema.md)
- - [RusticiSoftwareCloudV2::UpdateDispatchSchema](docs/UpdateDispatchSchema.md)
- - [RusticiSoftwareCloudV2::UserInvitationList](docs/UserInvitationList.md)
- - [RusticiSoftwareCloudV2::UserInvitationSchema](docs/UserInvitationSchema.md)
- - [RusticiSoftwareCloudV2::UserInvitationSchemaRegistrationReport](docs/UserInvitationSchemaRegistrationReport.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::XapiCredentialAuthTypeSchema](docs/XapiCredentialAuthTypeSchema.md)
- - [RusticiSoftwareCloudV2::XapiCredentialPermissionsLevelSchema](docs/XapiCredentialPermissionsLevelSchema.md)
- - [RusticiSoftwareCloudV2::XapiCredentialPostSchema](docs/XapiCredentialPostSchema.md)
- - [RusticiSoftwareCloudV2::XapiCredentialPutSchema](docs/XapiCredentialPutSchema.md)
- - [RusticiSoftwareCloudV2::XapiCredentialSchema](docs/XapiCredentialSchema.md)
- - [RusticiSoftwareCloudV2::XapiCredentialsListSchema](docs/XapiCredentialsListSchema.md)
- - [RusticiSoftwareCloudV2::XapiEndpointSchema](docs/XapiEndpointSchema.md)
- - [RusticiSoftwareCloudV2::XapiInteractionComponent](docs/XapiInteractionComponent.md)
- - [RusticiSoftwareCloudV2::XapiResult](docs/XapiResult.md)
- - [RusticiSoftwareCloudV2::XapiScore](docs/XapiScore.md)
- - [RusticiSoftwareCloudV2::XapiStatement](docs/XapiStatement.md)
- - [RusticiSoftwareCloudV2::XapiStatementPipeListSchema](docs/XapiStatementPipeListSchema.md)
- - [RusticiSoftwareCloudV2::XapiStatementPipePostSchema](docs/XapiStatementPipePostSchema.md)
- - [RusticiSoftwareCloudV2::XapiStatementPipePutSchema](docs/XapiStatementPipePutSchema.md)
- - [RusticiSoftwareCloudV2::XapiStatementPipeSchema](docs/XapiStatementPipeSchema.md)
- - [RusticiSoftwareCloudV2::XapiStatementReference](docs/XapiStatementReference.md)
- - [RusticiSoftwareCloudV2::XapiStatementResult](docs/XapiStatementResult.md)
- - [RusticiSoftwareCloudV2::XapiVerb](docs/XapiVerb.md)
- - [RusticiSoftwareCloudV2::ZoomiCompanyId](docs/ZoomiCompanyId.md)
- - [RusticiSoftwareCloudV2::ZoomiCourseOptionsSchema](docs/ZoomiCourseOptionsSchema.md)
-
-
-## Documentation for Authorization
-
-
-### APP_MANAGEMENT
-
-- **Type**: HTTP basic authentication
-
-### APP_NORMAL
-
-- **Type**: HTTP basic authentication
-
-### 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
-  - read:learner: Grants read access to the learner methods
-  - write:learner: Grants write access to the learner methods
-  - read:about: Grants read permission for the about method
+if __FILE__ == $0
+    main
+end
 
+```