rustici_software_cloud_v2 1.1.0 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (147) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +355 -356
  4. data/lib/rustici_software_cloud_v2/api/about_api.rb +4 -4
  5. data/lib/rustici_software_cloud_v2/api/application_management_api.rb +190 -62
  6. data/lib/rustici_software_cloud_v2/api/authentication_api.rb +9 -17
  7. data/lib/rustici_software_cloud_v2/api/course_api.rb +903 -196
  8. data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +458 -268
  9. data/lib/rustici_software_cloud_v2/api/invitations_api.rb +212 -170
  10. data/lib/rustici_software_cloud_v2/api/learner_api.rb +48 -48
  11. data/lib/rustici_software_cloud_v2/api/ping_api.rb +2 -0
  12. data/lib/rustici_software_cloud_v2/api/registration_api.rb +255 -269
  13. data/lib/rustici_software_cloud_v2/api/reporting_api.rb +19 -23
  14. data/lib/rustici_software_cloud_v2/api/xapi_api.rb +81 -66
  15. data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +124 -55
  16. data/lib/rustici_software_cloud_v2/api_client.rb +2 -2
  17. data/lib/rustici_software_cloud_v2/configuration.rb +3 -3
  18. data/lib/rustici_software_cloud_v2/models/about_schema.rb +3 -1
  19. data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +8 -36
  20. data/lib/rustici_software_cloud_v2/models/application_info_schema.rb +234 -0
  21. data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +3 -1
  22. data/lib/rustici_software_cloud_v2/models/application_request_schema.rb +186 -0
  23. data/lib/rustici_software_cloud_v2/models/application_schema.rb +3 -1
  24. data/lib/rustici_software_cloud_v2/models/application_token.rb +3 -1
  25. data/lib/rustici_software_cloud_v2/models/asset_file_schema.rb +194 -0
  26. data/lib/rustici_software_cloud_v2/models/batch_tags_schema.rb +3 -1
  27. data/lib/rustici_software_cloud_v2/models/comment_schema.rb +3 -1
  28. data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +3 -1
  29. data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +5 -29
  30. data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +3 -1
  31. data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +4 -1
  32. data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +3 -1
  33. data/lib/rustici_software_cloud_v2/models/course_schema.rb +5 -29
  34. data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +2 -19
  35. data/lib/rustici_software_cloud_v2/models/create_dispatch_list_schema.rb +3 -1
  36. data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +4 -2
  37. data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +4 -2
  38. data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +4 -2
  39. data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +3 -1
  40. data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +3 -1
  41. data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +3 -1
  42. data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +3 -1
  43. data/lib/rustici_software_cloud_v2/models/credential_schema.rb +3 -1
  44. data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +3 -1
  45. data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +4 -2
  46. data/lib/rustici_software_cloud_v2/models/destination_schema.rb +3 -1
  47. data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +3 -1
  48. data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +4 -1
  49. data/lib/rustici_software_cloud_v2/models/dispatch_lti_info_schema.rb +221 -0
  50. data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +3 -1
  51. data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +43 -3
  52. data/lib/rustici_software_cloud_v2/models/enabled_schema.rb +3 -1
  53. data/lib/rustici_software_cloud_v2/models/file_list_item_schema.rb +205 -0
  54. data/lib/rustici_software_cloud_v2/models/file_list_schema.rb +187 -0
  55. data/lib/rustici_software_cloud_v2/models/import_asset_request_schema.rb +207 -0
  56. data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +29 -6
  57. data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +5 -29
  58. data/lib/rustici_software_cloud_v2/models/import_media_file_reference_request_schema.rb +216 -0
  59. data/lib/rustici_software_cloud_v2/models/import_request_schema.rb +195 -0
  60. data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +3 -1
  61. data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +3 -1
  62. data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +3 -1
  63. data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +5 -29
  64. data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +4 -1
  65. data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +3 -1
  66. data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +3 -1
  67. data/lib/rustici_software_cloud_v2/models/launch_auth_options_schema.rb +3 -1
  68. data/lib/rustici_software_cloud_v2/models/launch_auth_schema.rb +5 -29
  69. data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +3 -1
  70. data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +8 -36
  71. data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +5 -3
  72. data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +3 -1
  73. data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +3 -1
  74. data/lib/rustici_software_cloud_v2/models/learner_schema.rb +3 -1
  75. data/lib/rustici_software_cloud_v2/models/media_file_metadata_schema.rb +213 -0
  76. data/lib/rustici_software_cloud_v2/models/message_schema.rb +3 -1
  77. data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +10 -8
  78. data/lib/rustici_software_cloud_v2/models/objective_schema.rb +11 -43
  79. data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +3 -1
  80. data/lib/rustici_software_cloud_v2/models/ping_schema.rb +3 -1
  81. data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +8 -36
  82. data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +4 -1
  83. data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +5 -3
  84. data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb +215 -0
  85. data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +4 -1
  86. data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +6 -4
  87. data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +228 -0
  88. data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +4 -1
  89. data/lib/rustici_software_cloud_v2/models/registration_schema.rb +3 -1
  90. data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +3 -1
  91. data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +3 -1
  92. data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +3 -1
  93. data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +3 -1
  94. data/lib/rustici_software_cloud_v2/models/response_error.rb +3 -1
  95. data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +5 -29
  96. data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +8 -36
  97. data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +5 -29
  98. data/lib/rustici_software_cloud_v2/models/score_schema.rb +3 -1
  99. data/lib/rustici_software_cloud_v2/models/setting_item.rb +5 -29
  100. data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +3 -1
  101. data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +5 -29
  102. data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +3 -1
  103. data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +3 -1
  104. data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +3 -1
  105. data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +3 -1
  106. data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +3 -1
  107. data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +3 -1
  108. data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +3 -1
  109. data/lib/rustici_software_cloud_v2/models/title_schema.rb +3 -1
  110. data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +3 -1
  111. data/lib/rustici_software_cloud_v2/models/update_application_schema.rb +196 -0
  112. data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +15 -3
  113. data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +4 -1
  114. data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +3 -1
  115. data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +3 -1
  116. data/lib/rustici_software_cloud_v2/models/xapi_account.rb +3 -1
  117. data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +3 -1
  118. data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +3 -1
  119. data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +5 -29
  120. data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +3 -1
  121. data/lib/rustici_software_cloud_v2/models/xapi_context.rb +3 -1
  122. data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +3 -1
  123. data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +5 -29
  124. data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +5 -29
  125. data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +3 -1
  126. data/lib/rustici_software_cloud_v2/models/xapi_credential_put_schema.rb +3 -1
  127. data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +3 -1
  128. data/lib/rustici_software_cloud_v2/models/xapi_credentials_list_schema.rb +4 -1
  129. data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +3 -1
  130. data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +3 -1
  131. data/lib/rustici_software_cloud_v2/models/xapi_result.rb +3 -1
  132. data/lib/rustici_software_cloud_v2/models/xapi_score.rb +3 -1
  133. data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +3 -1
  134. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +3 -1
  135. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +3 -1
  136. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_put_schema.rb +3 -1
  137. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +3 -1
  138. data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +3 -1
  139. data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +3 -1
  140. data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +3 -1
  141. data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +3 -1
  142. data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +13 -1
  143. data/lib/rustici_software_cloud_v2/version.rb +1 -1
  144. data/lib/rustici_software_cloud_v2.rb +13 -0
  145. data/rustici_software_cloud_v2.gemspec +2 -1
  146. data/spec/api_client_spec.rb +17 -0
  147. metadata +35 -2
data/README.md CHANGED
@@ -7,389 +7,388 @@ REST API used for SCORM Cloud integrations.
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: 2.0
10
- - Package version: 1.1.0
10
+ - Package version: 2.0.0
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
 
13
13
  ## Installation
14
+ ### Gem
15
+ [rustici_software_cloud_v2](https://rubygems.org/gems/rustici_software_cloud_v2)
14
16
 
15
- ### Build a gem
16
-
17
- To build the Ruby code into a gem:
17
+ ### Local:
18
+ Build the Ruby code into a gem:
18
19
 
19
20
  ```shell
20
21
  gem build rustici_software_cloud_v2.gemspec
21
22
  ```
22
23
 
23
- Then either install the gem locally:
24
-
25
24
  ```shell
26
- gem install ./rustici_software_cloud_v2-1.1.0.gem
25
+ gem install ./rustici_software_cloud_v2-2.0.0.gem
27
26
  ```
28
- (for development, run `gem install --dev ./rustici_software_cloud_v2-1.1.0.gem` to install the development dependencies)
29
-
30
- or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
27
+ For development, run `gem install --dev ./rustici_software_cloud_v2-2.0.0.gem` to install the development dependencies
31
28
 
32
29
  Finally add this to the Gemfile:
33
30
 
34
- gem 'rustici_software_cloud_v2', '~> 1.1.0'
31
+ gem 'rustici_software_cloud_v2', '~> 2.0.0'
35
32
 
36
- ### Install from Git
33
+ ## Tips and Tricks
34
+ Working with headers will require calling the `WithHttpInfo` version of the function. This allows for grabbing the header directly from the response object:
35
+ ```ruby
36
+ # Note: This code is specifically designed to not modify any existing data
37
+ dispatch_api = RusticiSoftwareCloudV2::DispatchApi.new
38
+ response = dispatch_api.update_dispatches_with_http_info(RusticiSoftwareCloudV2::UpdateDispatchSchema.new, {since: Time.now.strftime('%Y-%m-%dT%H:%M:%S.%L') + 'Z'})
39
+ puts response[2]["X-Total-Count"]
40
+ ```
37
41
 
38
- 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:
42
+ ## Release 2.0.X:
43
+ Check the [changelog](https://cloud.scorm.com/docs/v2/reference/changelog/) for details of what has changed.
39
44
 
40
- gem 'rustici_software_cloud_v2', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
45
+ ## Sample Code
46
+ ```ruby
47
+ require 'rustici_software_cloud_v2'
48
+ require 'open-uri'
49
+ include RusticiSoftwareCloudV2
41
50
 
42
- ### Include the Ruby code directly
43
51
 
44
- Include the Ruby code directly using `-I` as follows:
52
+ # ScormCloud API credentials
53
+ # Note: These are not the same credentials used to log in to ScormCloud
54
+ APP_ID = 'APP_ID'
55
+ SECRET_KEY = 'SECRET_KEY'
45
56
 
46
- ```shell
47
- ruby -Ilib script.rb
48
- ```
57
+ # Sample values for data
58
+ COURSE_PATH = '/PATH/TO/COURSE/RunTimeAdvancedCalls_SCORM20043rdEdition.zip'
49
59
 
50
- ## Getting Started
60
+ COURSE_ID = 'RB_SAMPLE_COURSE'
61
+ LEARNER_ID = 'RB_SAMPLE_COURSE_LEARNER'
62
+ REGISTRATION_ID = 'RB_SAMPLE_COURSE_REGISTRATION'
51
63
 
52
- Please follow the [installation](#installation) procedure and then run the following code:
53
- ```ruby
54
- # Load the gem
55
- require 'rustici_software_cloud_v2'
64
+ # String used for output formatting
65
+ OUTPUT_BORDER = "---------------------------------------------------------\n\n"
56
66
 
57
- # Setup authorization
58
- RusticiSoftwareCloudV2.configure do |config|
59
- # Configure HTTP basic authorization: APP_NORMAL
60
- config.username = 'YOUR USERNAME'
61
- config.password = 'YOUR PASSWORD'
62
67
 
63
- # Configure OAuth2 access token for authorization: OAUTH
64
- config.access_token = 'YOUR ACCESS TOKEN'
65
- end
68
+ # This sample will consist of:
69
+ # 1. Creating a course.
70
+ # 2. Registering a learner for the course.
71
+ # 3. Building a link for the learner to take the course.
72
+ # 4. Getting the learner's progress after having taken the course.
73
+ # 5. Viewing all courses and registrations.
74
+ # 6. Deleting all of the data created via this sample.
75
+ #
76
+ # All input variables used in this sample are defined up above.
77
+ def main()
78
+ RusticiSoftwareCloudV2.configure do |config|
79
+ # Configure HTTP basic authorization: APP_NORMAL
80
+ config.username = APP_ID
81
+ config.password = SECRET_KEY
82
+ end
83
+
84
+ sc = ScormCloud_Ruby_Sample.new
85
+
86
+ begin
87
+ # Create a course and a registration
88
+ course_details = sc.create_course(COURSE_ID, COURSE_PATH)
89
+ sc.create_registration(COURSE_ID, LEARNER_ID, REGISTRATION_ID)
90
+
91
+ # Show details of the newly imported course
92
+ puts 'Newly Imported Course Details: '
93
+ puts course_details
94
+
95
+
96
+
97
+ # Create the registration launch link
98
+ launch_link = sc.build_launch_link(REGISTRATION_ID)
66
99
 
67
- api_instance = RusticiSoftwareCloudV2::AboutApi.new
100
+ # Show the launch link
101
+ puts OUTPUT_BORDER
102
+ puts "Launck Link: #{launch_link}"
103
+ puts 'Navigate to the url above to take the course. Hit enter once complete.'
104
+ gets
68
105
 
69
- begin
70
- #Get back the API version and application name.
71
- result = api_instance.get_about
72
- p result
73
- rescue RusticiSoftwareCloudV2::ApiError => e
74
- puts "Exception when calling AboutApi->get_about: #{e}"
106
+
107
+
108
+ # Get the results for the registration
109
+ registration_progress = sc.get_result_for_registration(REGISTRATION_ID)
110
+
111
+ # Show details of the registration progress
112
+ puts OUTPUT_BORDER
113
+ puts 'Registration Progress: '
114
+ puts registration_progress
115
+
116
+
117
+
118
+ # Get information about all the courses in ScormCloud
119
+ course_list = sc.get_all_courses()
120
+
121
+ # Show details of the courses
122
+ puts OUTPUT_BORDER
123
+ puts 'Course List: '
124
+ course_list.each do |course|
125
+ puts course
126
+ end
127
+
128
+
129
+
130
+ # Get information about all the registrations in ScormCloud
131
+ registration_list = sc.get_all_registrations()
132
+
133
+ # Show details of the registrations
134
+ puts OUTPUT_BORDER
135
+ puts 'Registration List: '
136
+ registration_list.each do |registration|
137
+ puts registration
138
+ end
139
+
140
+ rescue ApiError, ArgumentError => error
141
+ puts error
142
+
143
+ ensure
144
+ # Delete all the data created by this sample
145
+ sc.clean_up(COURSE_ID, REGISTRATION_ID)
146
+
147
+ end
75
148
  end
76
149
 
77
- ```
150
+ class ScormCloud_Ruby_Sample
151
+
152
+ # Sets the default OAuth token passed with all calls to the API.
153
+ #
154
+ # If a token is created with limited scope (i.e. read:registration),
155
+ # calls that require a different permission set will error. Either a
156
+ # new token needs to be generated with the correct scope, or the
157
+ # default access token can be reset to nil. This would cause the
158
+ # request to be made with basic auth credentials (appId/ secret key)
159
+ # instead.
160
+ #
161
+ # Additionally, you could create a new configuration object and set
162
+ # the token on that object instead of the default access token. This
163
+ # configuration would then be passed into the Api object:
164
+ #
165
+ # config = Configuration.new
166
+ # token_request = TokenRequestSchema.new({
167
+ # permissions: PermissionsSchema.new({
168
+ # scopes: [ "write:course", "read:course" ]
169
+ # }),
170
+ # expiry: (Time.now + 2 * 60).iso8601
171
+ # })
172
+ # config.access_token = app_management_api.create_token(token_request).result
173
+ # course_api = CourseApi.new(ApiClient.new(config))
174
+ #
175
+ # Any calls that would use this CourseApi instance would then have the
176
+ # write:course and read:course permissions passed automatically, but
177
+ # other instances would be unaffected and continue to use other means
178
+ # of authorization.
179
+ #
180
+ # @param [Array<String>] :scopes List of permissions for calls made with the token.
181
+ private def configure_oauth(scopes)
182
+ app_management_api = ApplicationManagementApi.new
183
+
184
+ # Set permissions and expiry time of the token
185
+ # The expiry expected for token request must be in ISO-8601 format
186
+ expiry = (Time.now + 2 * 60).iso8601
187
+ permissions = PermissionsSchema.new({ scopes: scopes })
188
+
189
+ # Make the request to get the OAuth token
190
+ token_request = TokenRequestSchema.new({ permissions: permissions, expiry: expiry })
191
+ token_result = app_management_api.create_token(token_request)
192
+
193
+ # Set the default access token used with further API requests.
194
+ # To remove the token, reset config.access_token back to nil
195
+ # before the next call.
196
+ RusticiSoftwareCloudV2.configure do |config|
197
+ config.access_token = token_result.result
198
+ end
199
+
200
+ nil
201
+ end
202
+
203
+ # Creates a course by uploading the course from your local machine.
204
+ # Courses are a package of content for a learner to consume.
205
+ #
206
+ # Other methods for importing a course exist. Check the documentation
207
+ # for additional ways of importing a course.
208
+ #
209
+ # @param [String] :course_id Id that will be used to identify the course.
210
+ # @param [String] :course_path Path to the course being uploaded.
211
+ # @return [CourseSchema] Detailed information about the newly uploaded course.
212
+ def create_course(course_id, course_path)
213
+ # (Optional) Further authenticate via OAuth token access
214
+ # configure_oauth([ "write:course", "read:course" ])
215
+
216
+ # This call will use OAuth with the "write:course" scope
217
+ # if configured. Otherwise the basic auth credentials will be used
218
+ course_api = CourseApi.new
219
+ job_id = course_api.create_upload_and_import_course_job(course_id, { file: open(course_path) })
220
+
221
+ # This call will use OAuth with the "read:course" scope
222
+ # if configured. Otherwise the basic auth credentials will be used
223
+ job_result = course_api.get_import_job_status(job_id.result)
224
+ while job_result.status == 'RUNNING'
225
+ sleep(1)
226
+ job_result = course_api.get_import_job_status(job_id.result)
227
+ end
228
+
229
+ if job_result.status == 'ERROR'
230
+ raise ArgumentError.new('Course is not properly formatted: ' + job_result.message)
231
+ end
232
+
233
+ job_result.import_result.course
234
+ end
235
+
236
+ # Creates a registration allowing the learner to consume the course
237
+ # content. A registration is the link between a learner and a single
238
+ # course.
239
+ #
240
+ # @param [String] :course_id Id of the course to register the learner for.
241
+ # @param [String] :learner_id Id that will be used to identify the learner.
242
+ # @param [String] :registration_id Id that will be used to identify the registration.
243
+ def create_registration(course_id, learner_id, registration_id)
244
+ # (Optional) Further authenticate via OAuth token access
245
+ # configure_oauth([ "write:registration" ])
246
+
247
+ registration_api = RegistrationApi.new
248
+ learner = LearnerSchema.new({ id: learner_id })
249
+ registration = CreateRegistrationSchema.new({ courseId: course_id, learner: learner, registrationId: registration_id })
250
+ registration_api.create_registration(registration)
251
+
252
+ nil
253
+ end
254
+
255
+ # Builds a url allowing the learner to access the course.
256
+ #
257
+ # This sample will build the launch link and print it out. It will then
258
+ # pause and wait for user input, allowing you to navigate to the course
259
+ # to generate sample learner progress. Once this step has been reached,
260
+ # hitting the enter key will continue program execution.
261
+ #
262
+ # @param [String] :registration_id Id of the registration the link is being built for.
263
+ # @return [String] Link for the learner to launch the course.
264
+ def build_launch_link(registration_id)
265
+ # (Optional) Further authenticate via OAuth token access
266
+ # configure_oauth([ "read:registration" ])
267
+
268
+ registration_api = RegistrationApi.new
269
+ settings = LaunchLinkRequestSchema.new({ redirectOnExitUrl: 'Message' })
270
+ launch_link = registration_api.build_registration_launch_link(registration_id, settings)
271
+
272
+ launch_link.launch_link
273
+ end
274
+
275
+ # Gets information about the progress of the registration.
276
+ #
277
+ # For the most up-to-date results, you should implement our postback
278
+ # mechanism. The basic premise is that any update to the registration
279
+ # would cause us to send the updated results to your system.
280
+ #
281
+ # More details can be found in the documentation:
282
+ # https://cloud.scorm.com/docs/v2/guides/postback/
283
+ #
284
+ # @param [String] :registration_id Id of the registration to get results for.
285
+ # @return [RegistrationSchema] Detailed information about the registration's progress.
286
+ def get_result_for_registration(registration_id)
287
+ # (Optional) Further authenticate via OAuth token access
288
+ # configure_oauth([ "read:registration" ])
289
+
290
+ registration_api = RegistrationApi.new
291
+ progress = registration_api.get_registration_progress(registration_id)
292
+
293
+ progress
294
+ end
295
+
296
+ # Gets information about all courses. The result received from the API
297
+ # call is a paginated list, meaning that additional calls are required
298
+ # to retrieve all the information from the API. This has already been
299
+ # accounted for in the sample.
300
+ #
301
+ # @return [Array<CourseSchema>] List of detailed information about all of the courses.
302
+ def get_all_courses()
303
+ # (Optional) Further authenticate via OAuth token access
304
+ # configure_oauth([ "read:course" ])
305
+
306
+ # Additional filters can be provided to this call to get a subset
307
+ # of all courses.
308
+ course_api = CourseApi.new
309
+ response = course_api.get_courses()
310
+
311
+ # This call is paginated, with a token provided if more results exist
312
+ course_list = response.courses
313
+ until response.more.nil?
314
+ response = course_api.get_courses({ more: response.more })
315
+ course_list += response.courses
316
+ end
317
+
318
+ course_list
319
+ end
320
+
321
+ # Gets information about the registration progress for all
322
+ # registrations. The result received from the API call is a paginated
323
+ # list, meaning that additional calls are required to retrieve all the
324
+ # information from the API. This has already been accounted for in the
325
+ # sample.
326
+ #
327
+ # This call can be quite time-consuming and tedious with lots of
328
+ # registrations. If you find yourself making lots of calls to this
329
+ # endpoint, it might be worthwhile to look into registration postbacks.
330
+ #
331
+ # More details can be found in the documentation:
332
+ # https://cloud.scorm.com/docs/v2/guides/postback/
333
+ #
334
+ # @return [Array<RegistrationSchema>] List of detailed information about all of the registrations.
335
+ def get_all_registrations()
336
+ # (Optional) Further authenticate via OAuth token access
337
+ # configure_oauth([ "read:registration" ])
338
+
339
+ # Additional filters can be provided to this call to get a subset
340
+ # of all registrations.
341
+ registration_api = RegistrationApi.new
342
+ response = registration_api.get_registrations()
343
+
344
+ # This call is paginated, with a token provided if more results exist
345
+ registration_list = response.registrations
346
+ until response.more.nil?
347
+ response = registration_api.get_registrations({ more: response.more })
348
+ registration_list += response.registrations
349
+ end
350
+
351
+ registration_list
352
+ end
353
+
354
+ # Deletes all of the data generated by this sample.
355
+ # This code is run even if the program has errored out, providing a
356
+ # "clean slate" for every run of this sample.
357
+ #
358
+ # It is not necessary to delete registrations if the course
359
+ # they belong to has been deleted. Deleting the course will
360
+ # automatically queue deletion of all registrations associated with
361
+ # the course. There will be a delay between when the course is deleted
362
+ # and when the registrations for the course have been removed. The
363
+ # registration deletion has been handled here to prevent scenarios
364
+ # where the registration hasn't been deleted yet by the time the
365
+ # sample has been rerun.
366
+ #
367
+ # @param [String] :course_id Id of the course to delete.
368
+ # @param [String] :registration_id Id of the registration to delete.
369
+ def clean_up(course_id, registration_id)
370
+ # (Optional) Further authenticate via OAuth token access
371
+ # configure_oauth([ "delete:course", "delete:registration" ])
372
+
373
+ # This call will use OAuth with the "delete:course" scope
374
+ # if configured. Otherwise the basic auth credentials will be used
375
+ course_api = CourseApi.new
376
+ course_api.delete_course(course_id)
377
+
378
+ # The code below is to prevent race conditions if the
379
+ # sample is run in quick successions.
380
+
381
+ # This call will use OAuth with the "delete:registration" scope
382
+ # if configured. Otherwise the basic auth credentials will be used
383
+ registration_api = RegistrationApi.new
384
+ registration_api.delete_registration(registration_id)
385
+
386
+ nil
387
+ end
388
+ end
78
389
 
79
- ## Documentation for API Endpoints
80
-
81
- All URIs are relative to *https://cloud.scorm.com/api/v2/*
82
-
83
- Class | Method | HTTP request | Description
84
- ------------ | ------------- | ------------- | -------------
85
- *RusticiSoftwareCloudV2::AboutApi* | [**get_about**](docs/AboutApi.md#get_about) | **GET** /about | Get back the API version and application name.
86
- *RusticiSoftwareCloudV2::ApplicationManagementApi* | [**create_application**](docs/ApplicationManagementApi.md#create_application) | **POST** /appManagement/applications |
87
- *RusticiSoftwareCloudV2::ApplicationManagementApi* | [**create_credential**](docs/ApplicationManagementApi.md#create_credential) | **POST** /appManagement/{childAppId}/credentials |
88
- *RusticiSoftwareCloudV2::ApplicationManagementApi* | [**create_token**](docs/ApplicationManagementApi.md#create_token) | **POST** /appManagement/token |
89
- *RusticiSoftwareCloudV2::ApplicationManagementApi* | [**delete_application**](docs/ApplicationManagementApi.md#delete_application) | **DELETE** /appManagement/applications/{childAppId} |
90
- *RusticiSoftwareCloudV2::ApplicationManagementApi* | [**delete_application_configuration_setting**](docs/ApplicationManagementApi.md#delete_application_configuration_setting) | **DELETE** /appManagement/configuration/{settingId} | Clears the `settingId` value for this level
91
- *RusticiSoftwareCloudV2::ApplicationManagementApi* | [**delete_credential**](docs/ApplicationManagementApi.md#delete_credential) | **DELETE** /appManagement/{childAppId}/credentials/{credentialId} |
92
- *RusticiSoftwareCloudV2::ApplicationManagementApi* | [**get_application_configuration**](docs/ApplicationManagementApi.md#get_application_configuration) | **GET** /appManagement/configuration |
93
- *RusticiSoftwareCloudV2::ApplicationManagementApi* | [**get_application_list**](docs/ApplicationManagementApi.md#get_application_list) | **GET** /appManagement/applications | Get a list of all applications for the realm.
94
- *RusticiSoftwareCloudV2::ApplicationManagementApi* | [**get_credentials**](docs/ApplicationManagementApi.md#get_credentials) | **GET** /appManagement/{childAppId}/credentials |
95
- *RusticiSoftwareCloudV2::ApplicationManagementApi* | [**set_application_configuration**](docs/ApplicationManagementApi.md#set_application_configuration) | **POST** /appManagement/configuration |
96
- *RusticiSoftwareCloudV2::ApplicationManagementApi* | [**update_credential**](docs/ApplicationManagementApi.md#update_credential) | **PUT** /appManagement/{childAppId}/credentials/{credentialId} |
97
- *RusticiSoftwareCloudV2::AuthenticationApi* | [**get_app_token**](docs/AuthenticationApi.md#get_app_token) | **POST** /oauth/authenticate/application/token | Authenticates for a oauth token
98
- *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.
99
- *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.
100
- *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.
101
- *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.
102
- *RusticiSoftwareCloudV2::CourseApi* | [**delete_course**](docs/CourseApi.md#delete_course) | **DELETE** /courses/{courseId} | Delete a course.
103
- *RusticiSoftwareCloudV2::CourseApi* | [**delete_course_configuration_setting**](docs/CourseApi.md#delete_course_configuration_setting) | **DELETE** /courses/{courseId}/configuration/{settingId} | Clear a course configuration.
104
- *RusticiSoftwareCloudV2::CourseApi* | [**delete_course_tags**](docs/CourseApi.md#delete_course_tags) | **DELETE** /courses/{courseId}/tags | Delete course tags.
105
- *RusticiSoftwareCloudV2::CourseApi* | [**delete_course_version**](docs/CourseApi.md#delete_course_version) | **DELETE** /courses/{courseId}/versions/{versionId} | Delete a course version.
106
- *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.
107
- *RusticiSoftwareCloudV2::CourseApi* | [**get_course**](docs/CourseApi.md#get_course) | **GET** /courses/{courseId} | Get course details.
108
- *RusticiSoftwareCloudV2::CourseApi* | [**get_course_configuration**](docs/CourseApi.md#get_course_configuration) | **GET** /courses/{courseId}/configuration | Get course configuration.
109
- *RusticiSoftwareCloudV2::CourseApi* | [**get_course_statements**](docs/CourseApi.md#get_course_statements) | **GET** /courses/{courseId}/xAPIStatements | Get course xAPI statements.
110
- *RusticiSoftwareCloudV2::CourseApi* | [**get_course_tags**](docs/CourseApi.md#get_course_tags) | **GET** /courses/{courseId}/tags | Get course tags.
111
- *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.
112
- *RusticiSoftwareCloudV2::CourseApi* | [**get_course_version_info**](docs/CourseApi.md#get_course_version_info) | **GET** /courses/{courseId}/versions/{versionId} | Get details on a course version.
113
- *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.
114
- *RusticiSoftwareCloudV2::CourseApi* | [**get_course_versions**](docs/CourseApi.md#get_course_versions) | **GET** /courses/{courseId}/versions | Get details on a course's versions.
115
- *RusticiSoftwareCloudV2::CourseApi* | [**get_courses**](docs/CourseApi.md#get_courses) | **GET** /courses | Get all courses.
116
- *RusticiSoftwareCloudV2::CourseApi* | [**get_import_job_status**](docs/CourseApi.md#get_import_job_status) | **GET** /courses/importJobs/{importJobId} | Get course import job status.
117
- *RusticiSoftwareCloudV2::CourseApi* | [**put_course_tags**](docs/CourseApi.md#put_course_tags) | **PUT** /courses/{courseId}/tags | Set course tags.
118
- *RusticiSoftwareCloudV2::CourseApi* | [**put_course_tags_batch**](docs/CourseApi.md#put_course_tags_batch) | **PUT** /courses/tags | Set tags on courses.
119
- *RusticiSoftwareCloudV2::CourseApi* | [**set_course_configuration**](docs/CourseApi.md#set_course_configuration) | **POST** /courses/{courseId}/configuration | Set course configuration.
120
- *RusticiSoftwareCloudV2::CourseApi* | [**set_course_title**](docs/CourseApi.md#set_course_title) | **PUT** /courses/{courseId}/title | Set the title of a course.
121
- *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.
122
- *RusticiSoftwareCloudV2::DispatchApi* | [**create_destinations**](docs/DispatchApi.md#create_destinations) | **POST** /dispatch/destinations | DestinationsByTenant
123
- *RusticiSoftwareCloudV2::DispatchApi* | [**create_dispatches**](docs/DispatchApi.md#create_dispatches) | **POST** /dispatch/dispatches | Create dispatches.
124
- *RusticiSoftwareCloudV2::DispatchApi* | [**delete_destination**](docs/DispatchApi.md#delete_destination) | **DELETE** /dispatch/destinations/{destinationId} | Delete destination
125
- *RusticiSoftwareCloudV2::DispatchApi* | [**delete_destination_dispatches**](docs/DispatchApi.md#delete_destination_dispatches) | **DELETE** /dispatch/destinations/{destinationId}/dispatches | Delete dispatches in destination
126
- *RusticiSoftwareCloudV2::DispatchApi* | [**delete_destination_tags**](docs/DispatchApi.md#delete_destination_tags) | **DELETE** /dispatch/destinations/{destinationId}/tags | Delete the tags for this destination
127
- *RusticiSoftwareCloudV2::DispatchApi* | [**delete_dispatch**](docs/DispatchApi.md#delete_dispatch) | **DELETE** /dispatch/dispatches/{dispatchId} | Delete the dispatch with `dispatchId`.
128
- *RusticiSoftwareCloudV2::DispatchApi* | [**delete_dispatch_postback_info**](docs/DispatchApi.md#delete_dispatch_postback_info) | **DELETE** /dispatch/dispatches/{dispatchId}/postback | DispatchesByTenantAndDispatchId
129
- *RusticiSoftwareCloudV2::DispatchApi* | [**delete_dispatch_tags**](docs/DispatchApi.md#delete_dispatch_tags) | **DELETE** /dispatch/dispatches/{dispatchId}/tags | Delete the tags for this dispatch.
130
- *RusticiSoftwareCloudV2::DispatchApi* | [**enable_registration_instancing**](docs/DispatchApi.md#enable_registration_instancing) | **POST** /dispatch/destinations/{destinationId}/dispatches/registrationInstancing | DestinationsDispatchesRegistrationInstancing
131
- *RusticiSoftwareCloudV2::DispatchApi* | [**get_destination**](docs/DispatchApi.md#get_destination) | **GET** /dispatch/destinations/{destinationId} | Get destination information by destinationId.
132
- *RusticiSoftwareCloudV2::DispatchApi* | [**get_destination_dispatch_registration_count**](docs/DispatchApi.md#get_destination_dispatch_registration_count) | **GET** /dispatch/destinations/{destinationId}/dispatches/registrationCount | DestinationsDispatchesRegistrationCount
133
- *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.
134
- *RusticiSoftwareCloudV2::DispatchApi* | [**get_destination_dispatches**](docs/DispatchApi.md#get_destination_dispatches) | **GET** /dispatch/destinations/{destinationId}/dispatches | Get a list of dispatches in this destination
135
- *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.
136
- *RusticiSoftwareCloudV2::DispatchApi* | [**get_destination_tags**](docs/DispatchApi.md#get_destination_tags) | **GET** /dispatch/destinations/{destinationId}/tags | Get the tags for this destination
137
- *RusticiSoftwareCloudV2::DispatchApi* | [**get_destinations**](docs/DispatchApi.md#get_destinations) | **GET** /dispatch/destinations | getAllDestinations
138
- *RusticiSoftwareCloudV2::DispatchApi* | [**get_dispatch**](docs/DispatchApi.md#get_dispatch) | **GET** /dispatch/dispatches/{dispatchId} | Get dispatch by id.
139
- *RusticiSoftwareCloudV2::DispatchApi* | [**get_dispatch_enabled**](docs/DispatchApi.md#get_dispatch_enabled) | **GET** /dispatch/dispatches/{dispatchId}/enabled | Get the `enabled` status for `dispatchId`.
140
- *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.
141
- *RusticiSoftwareCloudV2::DispatchApi* | [**get_dispatch_registration_count**](docs/DispatchApi.md#get_dispatch_registration_count) | **GET** /dispatch/dispatches/{dispatchId}/registrationCount | Get the registration count for `dispatchId`.
142
- *RusticiSoftwareCloudV2::DispatchApi* | [**get_dispatch_tags**](docs/DispatchApi.md#get_dispatch_tags) | **GET** /dispatch/dispatches/{dispatchId}/tags | Get the tags for this dispatch.
143
- *RusticiSoftwareCloudV2::DispatchApi* | [**get_dispatch_zip**](docs/DispatchApi.md#get_dispatch_zip) | **GET** /dispatch/dispatches/{dispatchId}/zip | Get the ZIP for the dispatchId.
144
- *RusticiSoftwareCloudV2::DispatchApi* | [**get_dispatches**](docs/DispatchApi.md#get_dispatches) | **GET** /dispatch/dispatches | All Dispatches in the system for an AppId
145
- *RusticiSoftwareCloudV2::DispatchApi* | [**put_destination_tags**](docs/DispatchApi.md#put_destination_tags) | **PUT** /dispatch/destinations/{destinationId}/tags | Set the tags for this destination
146
- *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
147
- *RusticiSoftwareCloudV2::DispatchApi* | [**put_dispatch_tags**](docs/DispatchApi.md#put_dispatch_tags) | **PUT** /dispatch/dispatches/{dispatchId}/tags | Set the tags for this dispatch.
148
- *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
149
- *RusticiSoftwareCloudV2::DispatchApi* | [**reset_destination_dispatch_registration_count**](docs/DispatchApi.md#reset_destination_dispatch_registration_count) | **DELETE** /dispatch/destinations/{destinationId}/dispatches/registrationCount | DestinationsDispatchesRegistrationCount
150
- *RusticiSoftwareCloudV2::DispatchApi* | [**reset_dispatch_registration_count**](docs/DispatchApi.md#reset_dispatch_registration_count) | **DELETE** /dispatch/dispatches/{dispatchId}/registrationCount | Reset registration count.
151
- *RusticiSoftwareCloudV2::DispatchApi* | [**set_destination**](docs/DispatchApi.md#set_destination) | **PUT** /dispatch/destinations/{destinationId} |
152
- *RusticiSoftwareCloudV2::DispatchApi* | [**set_destination_dispatch_enabled**](docs/DispatchApi.md#set_destination_dispatch_enabled) | **POST** /dispatch/destinations/{destinationId}/dispatches/enabled | DestinationsDispatchesEnabledByTenant
153
- *RusticiSoftwareCloudV2::DispatchApi* | [**set_dispatch_enabled**](docs/DispatchApi.md#set_dispatch_enabled) | **PUT** /dispatch/dispatches/{dispatchId}/enabled | Set the `enabled` status for `dispatchId`.
154
- *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.
155
- *RusticiSoftwareCloudV2::DispatchApi* | [**update_dispatch**](docs/DispatchApi.md#update_dispatch) | **PUT** /dispatch/dispatches/{dispatchId} | Update the dispatch with `dispatchId`.
156
- *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.
157
- *RusticiSoftwareCloudV2::InvitationsApi* | [**create_private_invitation**](docs/InvitationsApi.md#create_private_invitation) | **POST** /invitations/private | Create a private invitation to a course.
158
- *RusticiSoftwareCloudV2::InvitationsApi* | [**create_public_invitation**](docs/InvitationsApi.md#create_public_invitation) | **POST** /invitations/public | Create a publicly accessible invitation to a course.
159
- *RusticiSoftwareCloudV2::InvitationsApi* | [**delete_invitation_tags**](docs/InvitationsApi.md#delete_invitation_tags) | **DELETE** /invitations/{invitationId}/tags | Delete the tags for this invitation
160
- *RusticiSoftwareCloudV2::InvitationsApi* | [**get_all_invitations**](docs/InvitationsApi.md#get_all_invitations) | **GET** /invitations | Get a list of invitation summaries.
161
- *RusticiSoftwareCloudV2::InvitationsApi* | [**get_invitation_tags**](docs/InvitationsApi.md#get_invitation_tags) | **GET** /invitations/{invitationId}/tags | Get the tags for this invitation
162
- *RusticiSoftwareCloudV2::InvitationsApi* | [**get_private_invitation**](docs/InvitationsApi.md#get_private_invitation) | **GET** /invitations/private/{invitationId} | Get a information about a private invitation.
163
- *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.
164
- *RusticiSoftwareCloudV2::InvitationsApi* | [**get_private_invitations**](docs/InvitationsApi.md#get_private_invitations) | **GET** /invitations/private | Get a list of all private invitations.
165
- *RusticiSoftwareCloudV2::InvitationsApi* | [**get_private_user_invitations**](docs/InvitationsApi.md#get_private_user_invitations) | **GET** /invitations/private/{invitationId}/userInvitations | Get a list of user invitations.
166
- *RusticiSoftwareCloudV2::InvitationsApi* | [**get_public_invitation**](docs/InvitationsApi.md#get_public_invitation) | **GET** /invitations/public/{invitationId} | Get a information about a public invitation.
167
- *RusticiSoftwareCloudV2::InvitationsApi* | [**get_public_invitations**](docs/InvitationsApi.md#get_public_invitations) | **GET** /invitations/public | Get a list of all public invitations.
168
- *RusticiSoftwareCloudV2::InvitationsApi* | [**get_public_user_invitations**](docs/InvitationsApi.md#get_public_user_invitations) | **GET** /invitations/public/{invitationId}/userInvitations | Get a list of user invitations.
169
- *RusticiSoftwareCloudV2::InvitationsApi* | [**put_invitation_tags**](docs/InvitationsApi.md#put_invitation_tags) | **PUT** /invitations/{invitationId}/tags | Set the tags for this invitation
170
- *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
171
- *RusticiSoftwareCloudV2::InvitationsApi* | [**update_private_invitation**](docs/InvitationsApi.md#update_private_invitation) | **PUT** /invitations/private/{invitationId} | Update attributes of this invitation.
172
- *RusticiSoftwareCloudV2::InvitationsApi* | [**update_public_invitation**](docs/InvitationsApi.md#update_public_invitation) | **PUT** /invitations/public/{invitationId} | Update attributes of this invitation.
173
- *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.
174
- *RusticiSoftwareCloudV2::LearnerApi* | [**delete_learner_tags**](docs/LearnerApi.md#delete_learner_tags) | **DELETE** /learner/{learnerId}/tags | Delete the tags for this learner
175
- *RusticiSoftwareCloudV2::LearnerApi* | [**get_learner_tags**](docs/LearnerApi.md#get_learner_tags) | **GET** /learner/{learnerId}/tags | Get the tags for this learner
176
- *RusticiSoftwareCloudV2::LearnerApi* | [**put_learner_tags**](docs/LearnerApi.md#put_learner_tags) | **PUT** /learner/{learnerId}/tags | Set the tags for this learner
177
- *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
178
- *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.
179
- *RusticiSoftwareCloudV2::PingApi* | [**ping_app_id**](docs/PingApi.md#ping_app_id) | **GET** /ping |
180
- *RusticiSoftwareCloudV2::RegistrationApi* | [**build_registration_launch_link**](docs/RegistrationApi.md#build_registration_launch_link) | **POST** /registrations/{registrationId}/launchLink | Get registration launch link.
181
- *RusticiSoftwareCloudV2::RegistrationApi* | [**create_new_registration_instance**](docs/RegistrationApi.md#create_new_registration_instance) | **POST** /registrations/{registrationId}/instances |
182
- *RusticiSoftwareCloudV2::RegistrationApi* | [**create_registration**](docs/RegistrationApi.md#create_registration) | **POST** /registrations | Create a registration.
183
- *RusticiSoftwareCloudV2::RegistrationApi* | [**delete_registration**](docs/RegistrationApi.md#delete_registration) | **DELETE** /registrations/{registrationId} | Delete a registration.
184
- *RusticiSoftwareCloudV2::RegistrationApi* | [**delete_registration_configuration_setting**](docs/RegistrationApi.md#delete_registration_configuration_setting) | **DELETE** /registrations/{registrationId}/configuration/{settingId} | Clear a registration configuration.
185
- *RusticiSoftwareCloudV2::RegistrationApi* | [**delete_registration_global_data**](docs/RegistrationApi.md#delete_registration_global_data) | **DELETE** /registrations/{registrationId}/globalData | Delete the global data of a registration.
186
- *RusticiSoftwareCloudV2::RegistrationApi* | [**delete_registration_instance**](docs/RegistrationApi.md#delete_registration_instance) | **DELETE** /registrations/{registrationId}/instances/{instanceId} | Delete instance `instanceId` of `registrationId`.
187
- *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.
188
- *RusticiSoftwareCloudV2::RegistrationApi* | [**delete_registration_progress**](docs/RegistrationApi.md#delete_registration_progress) | **DELETE** /registrations/{registrationId}/progress | Reset a registration.
189
- *RusticiSoftwareCloudV2::RegistrationApi* | [**delete_registration_tags**](docs/RegistrationApi.md#delete_registration_tags) | **DELETE** /registrations/{registrationId}/tags | Delete tags from a registration.
190
- *RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration**](docs/RegistrationApi.md#get_registration) | **HEAD** /registrations/{registrationId} | See if a registration exists.
191
- *RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_configuration**](docs/RegistrationApi.md#get_registration_configuration) | **GET** /registrations/{registrationId}/configuration | Get registration configuration.
192
- *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.
193
- *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.
194
- *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.
195
- *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.
196
- *RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_instances**](docs/RegistrationApi.md#get_registration_instances) | **GET** /registrations/{registrationId}/instances | Get all instances of a registration.
197
- *RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_launch_history**](docs/RegistrationApi.md#get_registration_launch_history) | **GET** /registrations/{registrationId}/launchHistory | Get launch history for a registration.
198
- *RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_progress**](docs/RegistrationApi.md#get_registration_progress) | **GET** /registrations/{registrationId} | Get details of a registration.
199
- *RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_statements**](docs/RegistrationApi.md#get_registration_statements) | **GET** /registrations/{registrationId}/xAPIStatements | Get xAPI statements for a registration.
200
- *RusticiSoftwareCloudV2::RegistrationApi* | [**get_registration_tags**](docs/RegistrationApi.md#get_registration_tags) | **GET** /registrations/{registrationId}/tags | Get tags for a registration.
201
- *RusticiSoftwareCloudV2::RegistrationApi* | [**get_registrations**](docs/RegistrationApi.md#get_registrations) | **GET** /registrations | Get a list of all registrations.
202
- *RusticiSoftwareCloudV2::RegistrationApi* | [**put_registration_tags**](docs/RegistrationApi.md#put_registration_tags) | **PUT** /registrations/{registrationId}/tags | Set tags on a registration.
203
- *RusticiSoftwareCloudV2::RegistrationApi* | [**put_registration_tags_batch**](docs/RegistrationApi.md#put_registration_tags_batch) | **PUT** /registrations/tags | Set tags on registrations.
204
- *RusticiSoftwareCloudV2::RegistrationApi* | [**set_registration_configuration**](docs/RegistrationApi.md#set_registration_configuration) | **POST** /registrations/{registrationId}/configuration | Set registration configuration.
205
- *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.
206
- *RusticiSoftwareCloudV2::RegistrationApi* | [**test_registration_postback**](docs/RegistrationApi.md#test_registration_postback) | **POST** /registrations/postBackTest | Send a test postback with a provided configuration.
207
- *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
208
- *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
209
- *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
210
- *RusticiSoftwareCloudV2::XapiApi* | [**create_statement_pipe**](docs/XapiApi.md#create_statement_pipe) | **POST** /xapi/statementPipes | Create an xAPI statement pipe.
211
- *RusticiSoftwareCloudV2::XapiApi* | [**create_xapi_credential**](docs/XapiApi.md#create_xapi_credential) | **POST** /xapi/credentials | Create a xAPI credential.
212
- *RusticiSoftwareCloudV2::XapiApi* | [**delete_statement_pipe**](docs/XapiApi.md#delete_statement_pipe) | **DELETE** /xapi/statementPipes/{statementPipeId} | Deletes this xAPI pipe.
213
- *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
214
- *RusticiSoftwareCloudV2::XapiApi* | [**get_statement_pipe**](docs/XapiApi.md#get_statement_pipe) | **GET** /xapi/statementPipes/{statementPipeId} | Retrieves xAPI pipe for `xapiPipeId`
215
- *RusticiSoftwareCloudV2::XapiApi* | [**get_statement_pipes**](docs/XapiApi.md#get_statement_pipes) | **GET** /xapi/statementPipes | Get all of the xapiPipes for `appId`
216
- *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.
217
- *RusticiSoftwareCloudV2::XapiApi* | [**get_xapi_credentials**](docs/XapiApi.md#get_xapi_credentials) | **GET** /xapi/credentials | Get the list of xapiCredentials
218
- *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.
219
- *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
220
- *RusticiSoftwareCloudV2::ZoomiApi* | [**delete_application_zoomi_keys**](docs/ZoomiApi.md#delete_application_zoomi_keys) | **DELETE** /zoomi/key | Delete the keys for an application.
221
- *RusticiSoftwareCloudV2::ZoomiApi* | [**delete_zoomi_course**](docs/ZoomiApi.md#delete_zoomi_course) | **DELETE** /zoomi/course/{courseId}/version/{versionId} | Deletes the course in zoomi
222
- *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.
223
- *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.
224
- *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
225
- *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
226
- *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.
227
- *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.
228
-
229
-
230
- ## Documentation for Models
231
-
232
- - [RusticiSoftwareCloudV2::AboutSchema](docs/AboutSchema.md)
233
- - [RusticiSoftwareCloudV2::ActivityResultSchema](docs/ActivityResultSchema.md)
234
- - [RusticiSoftwareCloudV2::ApplicationListSchema](docs/ApplicationListSchema.md)
235
- - [RusticiSoftwareCloudV2::ApplicationSchema](docs/ApplicationSchema.md)
236
- - [RusticiSoftwareCloudV2::ApplicationToken](docs/ApplicationToken.md)
237
- - [RusticiSoftwareCloudV2::BatchTagsSchema](docs/BatchTagsSchema.md)
238
- - [RusticiSoftwareCloudV2::CommentSchema](docs/CommentSchema.md)
239
- - [RusticiSoftwareCloudV2::CompletionAmountSchema](docs/CompletionAmountSchema.md)
240
- - [RusticiSoftwareCloudV2::CourseActivitySchema](docs/CourseActivitySchema.md)
241
- - [RusticiSoftwareCloudV2::CourseListNonPagedSchema](docs/CourseListNonPagedSchema.md)
242
- - [RusticiSoftwareCloudV2::CourseListSchema](docs/CourseListSchema.md)
243
- - [RusticiSoftwareCloudV2::CourseReferenceSchema](docs/CourseReferenceSchema.md)
244
- - [RusticiSoftwareCloudV2::CourseSchema](docs/CourseSchema.md)
245
- - [RusticiSoftwareCloudV2::CreateDispatchIdSchema](docs/CreateDispatchIdSchema.md)
246
- - [RusticiSoftwareCloudV2::CreateDispatchListSchema](docs/CreateDispatchListSchema.md)
247
- - [RusticiSoftwareCloudV2::CreateDispatchSchema](docs/CreateDispatchSchema.md)
248
- - [RusticiSoftwareCloudV2::CreatePrivateInvitationSchema](docs/CreatePrivateInvitationSchema.md)
249
- - [RusticiSoftwareCloudV2::CreatePublicInvitationSchema](docs/CreatePublicInvitationSchema.md)
250
- - [RusticiSoftwareCloudV2::CreateRegistrationSchema](docs/CreateRegistrationSchema.md)
251
- - [RusticiSoftwareCloudV2::CredentialCreatedSchema](docs/CredentialCreatedSchema.md)
252
- - [RusticiSoftwareCloudV2::CredentialListSchema](docs/CredentialListSchema.md)
253
- - [RusticiSoftwareCloudV2::CredentialRequestSchema](docs/CredentialRequestSchema.md)
254
- - [RusticiSoftwareCloudV2::CredentialSchema](docs/CredentialSchema.md)
255
- - [RusticiSoftwareCloudV2::DestinationIdSchema](docs/DestinationIdSchema.md)
256
- - [RusticiSoftwareCloudV2::DestinationListSchema](docs/DestinationListSchema.md)
257
- - [RusticiSoftwareCloudV2::DestinationSchema](docs/DestinationSchema.md)
258
- - [RusticiSoftwareCloudV2::DispatchIdSchema](docs/DispatchIdSchema.md)
259
- - [RusticiSoftwareCloudV2::DispatchListSchema](docs/DispatchListSchema.md)
260
- - [RusticiSoftwareCloudV2::DispatchRegistrationCountSchema](docs/DispatchRegistrationCountSchema.md)
261
- - [RusticiSoftwareCloudV2::DispatchSchema](docs/DispatchSchema.md)
262
- - [RusticiSoftwareCloudV2::EnabledSchema](docs/EnabledSchema.md)
263
- - [RusticiSoftwareCloudV2::ImportFetchRequestSchema](docs/ImportFetchRequestSchema.md)
264
- - [RusticiSoftwareCloudV2::ImportJobResultSchema](docs/ImportJobResultSchema.md)
265
- - [RusticiSoftwareCloudV2::ImportResultSchema](docs/ImportResultSchema.md)
266
- - [RusticiSoftwareCloudV2::IntegerResultSchema](docs/IntegerResultSchema.md)
267
- - [RusticiSoftwareCloudV2::InvitationEmailSchema](docs/InvitationEmailSchema.md)
268
- - [RusticiSoftwareCloudV2::InvitationJobStatusSchema](docs/InvitationJobStatusSchema.md)
269
- - [RusticiSoftwareCloudV2::InvitationSummaryList](docs/InvitationSummaryList.md)
270
- - [RusticiSoftwareCloudV2::InvitationSummarySchema](docs/InvitationSummarySchema.md)
271
- - [RusticiSoftwareCloudV2::ItemValuePairSchema](docs/ItemValuePairSchema.md)
272
- - [RusticiSoftwareCloudV2::LaunchAuthOptionsSchema](docs/LaunchAuthOptionsSchema.md)
273
- - [RusticiSoftwareCloudV2::LaunchAuthSchema](docs/LaunchAuthSchema.md)
274
- - [RusticiSoftwareCloudV2::LaunchHistoryListSchema](docs/LaunchHistoryListSchema.md)
275
- - [RusticiSoftwareCloudV2::LaunchHistorySchema](docs/LaunchHistorySchema.md)
276
- - [RusticiSoftwareCloudV2::LaunchLinkRequestSchema](docs/LaunchLinkRequestSchema.md)
277
- - [RusticiSoftwareCloudV2::LaunchLinkSchema](docs/LaunchLinkSchema.md)
278
- - [RusticiSoftwareCloudV2::LearnerPreferenceSchema](docs/LearnerPreferenceSchema.md)
279
- - [RusticiSoftwareCloudV2::LearnerSchema](docs/LearnerSchema.md)
280
- - [RusticiSoftwareCloudV2::MessageSchema](docs/MessageSchema.md)
281
- - [RusticiSoftwareCloudV2::MetadataSchema](docs/MetadataSchema.md)
282
- - [RusticiSoftwareCloudV2::ObjectiveSchema](docs/ObjectiveSchema.md)
283
- - [RusticiSoftwareCloudV2::PermissionsSchema](docs/PermissionsSchema.md)
284
- - [RusticiSoftwareCloudV2::PingSchema](docs/PingSchema.md)
285
- - [RusticiSoftwareCloudV2::PostBackSchema](docs/PostBackSchema.md)
286
- - [RusticiSoftwareCloudV2::PrivateInvitationList](docs/PrivateInvitationList.md)
287
- - [RusticiSoftwareCloudV2::PrivateInvitationSchema](docs/PrivateInvitationSchema.md)
288
- - [RusticiSoftwareCloudV2::PublicInvitationList](docs/PublicInvitationList.md)
289
- - [RusticiSoftwareCloudV2::PublicInvitationSchema](docs/PublicInvitationSchema.md)
290
- - [RusticiSoftwareCloudV2::RegistrationCompletion](docs/RegistrationCompletion.md)
291
- - [RusticiSoftwareCloudV2::RegistrationListSchema](docs/RegistrationListSchema.md)
292
- - [RusticiSoftwareCloudV2::RegistrationSchema](docs/RegistrationSchema.md)
293
- - [RusticiSoftwareCloudV2::RegistrationSuccess](docs/RegistrationSuccess.md)
294
- - [RusticiSoftwareCloudV2::ReportageAccountInfoSchema](docs/ReportageAccountInfoSchema.md)
295
- - [RusticiSoftwareCloudV2::ReportageAccountInfoUsageSchema](docs/ReportageAccountInfoUsageSchema.md)
296
- - [RusticiSoftwareCloudV2::ReportageAuthTokenSchema](docs/ReportageAuthTokenSchema.md)
297
- - [RusticiSoftwareCloudV2::ReportageLinkSchema](docs/ReportageLinkSchema.md)
298
- - [RusticiSoftwareCloudV2::ResponseError](docs/ResponseError.md)
299
- - [RusticiSoftwareCloudV2::RuntimeInteractionSchema](docs/RuntimeInteractionSchema.md)
300
- - [RusticiSoftwareCloudV2::RuntimeObjectiveSchema](docs/RuntimeObjectiveSchema.md)
301
- - [RusticiSoftwareCloudV2::RuntimeSchema](docs/RuntimeSchema.md)
302
- - [RusticiSoftwareCloudV2::ScoreSchema](docs/ScoreSchema.md)
303
- - [RusticiSoftwareCloudV2::SettingItem](docs/SettingItem.md)
304
- - [RusticiSoftwareCloudV2::SettingListSchema](docs/SettingListSchema.md)
305
- - [RusticiSoftwareCloudV2::SettingMetadata](docs/SettingMetadata.md)
306
- - [RusticiSoftwareCloudV2::SettingValidValue](docs/SettingValidValue.md)
307
- - [RusticiSoftwareCloudV2::SettingsIndividualSchema](docs/SettingsIndividualSchema.md)
308
- - [RusticiSoftwareCloudV2::SettingsPostSchema](docs/SettingsPostSchema.md)
309
- - [RusticiSoftwareCloudV2::SharedDataEntrySchema](docs/SharedDataEntrySchema.md)
310
- - [RusticiSoftwareCloudV2::StaticPropertiesSchema](docs/StaticPropertiesSchema.md)
311
- - [RusticiSoftwareCloudV2::StringResultSchema](docs/StringResultSchema.md)
312
- - [RusticiSoftwareCloudV2::TagListSchema](docs/TagListSchema.md)
313
- - [RusticiSoftwareCloudV2::TitleSchema](docs/TitleSchema.md)
314
- - [RusticiSoftwareCloudV2::TokenRequestSchema](docs/TokenRequestSchema.md)
315
- - [RusticiSoftwareCloudV2::UpdateDispatchSchema](docs/UpdateDispatchSchema.md)
316
- - [RusticiSoftwareCloudV2::UserInvitationList](docs/UserInvitationList.md)
317
- - [RusticiSoftwareCloudV2::UserInvitationSchema](docs/UserInvitationSchema.md)
318
- - [RusticiSoftwareCloudV2::UserInvitationSchemaRegistrationReport](docs/UserInvitationSchemaRegistrationReport.md)
319
- - [RusticiSoftwareCloudV2::XapiAccount](docs/XapiAccount.md)
320
- - [RusticiSoftwareCloudV2::XapiActivity](docs/XapiActivity.md)
321
- - [RusticiSoftwareCloudV2::XapiActivityDefinition](docs/XapiActivityDefinition.md)
322
- - [RusticiSoftwareCloudV2::XapiAgentGroup](docs/XapiAgentGroup.md)
323
- - [RusticiSoftwareCloudV2::XapiAttachment](docs/XapiAttachment.md)
324
- - [RusticiSoftwareCloudV2::XapiContext](docs/XapiContext.md)
325
- - [RusticiSoftwareCloudV2::XapiContextActivity](docs/XapiContextActivity.md)
326
- - [RusticiSoftwareCloudV2::XapiCredentialAuthTypeSchema](docs/XapiCredentialAuthTypeSchema.md)
327
- - [RusticiSoftwareCloudV2::XapiCredentialPermissionsLevelSchema](docs/XapiCredentialPermissionsLevelSchema.md)
328
- - [RusticiSoftwareCloudV2::XapiCredentialPostSchema](docs/XapiCredentialPostSchema.md)
329
- - [RusticiSoftwareCloudV2::XapiCredentialPutSchema](docs/XapiCredentialPutSchema.md)
330
- - [RusticiSoftwareCloudV2::XapiCredentialSchema](docs/XapiCredentialSchema.md)
331
- - [RusticiSoftwareCloudV2::XapiCredentialsListSchema](docs/XapiCredentialsListSchema.md)
332
- - [RusticiSoftwareCloudV2::XapiEndpointSchema](docs/XapiEndpointSchema.md)
333
- - [RusticiSoftwareCloudV2::XapiInteractionComponent](docs/XapiInteractionComponent.md)
334
- - [RusticiSoftwareCloudV2::XapiResult](docs/XapiResult.md)
335
- - [RusticiSoftwareCloudV2::XapiScore](docs/XapiScore.md)
336
- - [RusticiSoftwareCloudV2::XapiStatement](docs/XapiStatement.md)
337
- - [RusticiSoftwareCloudV2::XapiStatementPipeListSchema](docs/XapiStatementPipeListSchema.md)
338
- - [RusticiSoftwareCloudV2::XapiStatementPipePostSchema](docs/XapiStatementPipePostSchema.md)
339
- - [RusticiSoftwareCloudV2::XapiStatementPipePutSchema](docs/XapiStatementPipePutSchema.md)
340
- - [RusticiSoftwareCloudV2::XapiStatementPipeSchema](docs/XapiStatementPipeSchema.md)
341
- - [RusticiSoftwareCloudV2::XapiStatementReference](docs/XapiStatementReference.md)
342
- - [RusticiSoftwareCloudV2::XapiStatementResult](docs/XapiStatementResult.md)
343
- - [RusticiSoftwareCloudV2::XapiVerb](docs/XapiVerb.md)
344
- - [RusticiSoftwareCloudV2::ZoomiCompanyId](docs/ZoomiCompanyId.md)
345
- - [RusticiSoftwareCloudV2::ZoomiCourseOptionsSchema](docs/ZoomiCourseOptionsSchema.md)
346
-
347
-
348
- ## Documentation for Authorization
349
-
350
-
351
- ### APP_MANAGEMENT
352
-
353
- - **Type**: HTTP basic authentication
354
-
355
- ### APP_NORMAL
356
-
357
- - **Type**: HTTP basic authentication
358
-
359
- ### OAUTH
360
-
361
- - **Type**: OAuth
362
- - **Flow**: application
363
- - **Authorization URL**:
364
- - **Scopes**:
365
- - read: Grants read access
366
- - write: Grants write access
367
- - delete: Grants deletion access
368
- - admin: Grants read, write, and account management access
369
- - read:course: Grants read access to course methods
370
- - write:course: Grants write access to course methods
371
- - delete:course: Grants deletion access to course methods
372
- - read:dispatch: Grants read access to dispatch methods
373
- - write:dispatch: Grants write access to dispatch methods
374
- - delete:dispatch: Grants deletion access to dispatch methods
375
- - read:invitation: Grants read access to invitation methods
376
- - write:invitation: Grants write access to invitation methods
377
- - delete:invitation: Grants deletion access to invitation methods
378
- - read:ping: Grants read access to the ping method
379
- - read:registration: Grants read access to registration methods
380
- - write:registration: Grants write access to registration methods
381
- - delete:registration: Grants deletion access to registration methods
382
- - read:reporting: Grants read access to reporting methods
383
- - read:xapicredential: Grants read access to xapi credential methods
384
- - write:xapicredential: Grants write access to xapi credential methods
385
- - delete:xapicredential: Grants deletion access to xapi credential methods
386
- - read:xapipipe: Grants read access to xapi pipe methods
387
- - write:xapipipe: Grants write access to xapi pipe methods
388
- - delete:xapipipe: Grants deletion access to xapi pipe methods
389
- - read:appmgmt: Grants read access to app management methods
390
- - write:appmgmt: Grants write access to app management methods
391
- - delete:appmgmt: Grants deletion access to app management methods
392
- - read:learner: Grants read access to the learner methods
393
- - write:learner: Grants write access to the learner methods
394
- - read:about: Grants read permission for the about method
390
+ if __FILE__ == $0
391
+ main
392
+ end
395
393
 
394
+ ```