rustici_software_cloud_v2 1.0.0beta → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (287) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +1 -1
  3. data/README.md +354 -243
  4. data/lib/rustici_software_cloud_v2/api/about_api.rb +71 -0
  5. data/lib/rustici_software_cloud_v2/api/application_management_api.rb +253 -63
  6. data/lib/rustici_software_cloud_v2/api/authentication_api.rb +11 -17
  7. data/lib/rustici_software_cloud_v2/api/course_api.rb +910 -160
  8. data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +2236 -0
  9. data/lib/rustici_software_cloud_v2/api/invitations_api.rb +1025 -0
  10. data/lib/rustici_software_cloud_v2/api/learner_api.rb +367 -0
  11. data/lib/rustici_software_cloud_v2/api/ping_api.rb +6 -4
  12. data/lib/rustici_software_cloud_v2/api/registration_api.rb +448 -295
  13. data/lib/rustici_software_cloud_v2/api/reporting_api.rb +191 -0
  14. data/lib/rustici_software_cloud_v2/api/xapi_api.rb +581 -0
  15. data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +528 -0
  16. data/lib/rustici_software_cloud_v2/api_client.rb +5 -5
  17. data/lib/rustici_software_cloud_v2/api_error.rb +2 -2
  18. data/lib/rustici_software_cloud_v2/configuration.rb +11 -20
  19. data/lib/rustici_software_cloud_v2/models/about_schema.rb +194 -0
  20. data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +10 -38
  21. data/lib/rustici_software_cloud_v2/models/application_info_schema.rb +234 -0
  22. data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +5 -3
  23. data/lib/rustici_software_cloud_v2/models/{link_schema.rb → application_request_schema.rb} +14 -16
  24. data/lib/rustici_software_cloud_v2/models/application_schema.rb +5 -3
  25. data/lib/rustici_software_cloud_v2/models/application_token.rb +5 -3
  26. data/lib/rustici_software_cloud_v2/models/asset_file_schema.rb +194 -0
  27. data/lib/rustici_software_cloud_v2/models/{course_tags_batch_schema.rb → batch_tags_schema.rb} +21 -17
  28. data/lib/rustici_software_cloud_v2/models/comment_schema.rb +5 -3
  29. data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +5 -3
  30. data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +7 -31
  31. data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +5 -3
  32. data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +6 -3
  33. data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +5 -3
  34. data/lib/rustici_software_cloud_v2/models/course_schema.rb +7 -31
  35. data/lib/rustici_software_cloud_v2/models/{registration_tags_batch_schema.rb → create_dispatch_id_schema.rb} +25 -25
  36. data/lib/rustici_software_cloud_v2/models/create_dispatch_list_schema.rb +187 -0
  37. data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +306 -0
  38. data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +252 -0
  39. data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +250 -0
  40. data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +5 -3
  41. data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +5 -3
  42. data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +5 -3
  43. data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +5 -3
  44. data/lib/rustici_software_cloud_v2/models/credential_schema.rb +5 -3
  45. data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +195 -0
  46. data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +198 -0
  47. data/lib/rustici_software_cloud_v2/models/destination_schema.rb +227 -0
  48. data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +194 -0
  49. data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +197 -0
  50. data/lib/rustici_software_cloud_v2/models/dispatch_lti_info_schema.rb +221 -0
  51. data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +194 -0
  52. data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +326 -0
  53. data/lib/rustici_software_cloud_v2/models/{tag_post_schema.rb → enabled_schema.rb} +17 -6
  54. data/lib/rustici_software_cloud_v2/models/file_list_item_schema.rb +205 -0
  55. data/lib/rustici_software_cloud_v2/models/file_list_schema.rb +187 -0
  56. data/lib/rustici_software_cloud_v2/models/import_asset_request_schema.rb +207 -0
  57. data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +31 -8
  58. data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +7 -31
  59. data/lib/rustici_software_cloud_v2/models/import_media_file_reference_request_schema.rb +216 -0
  60. data/lib/rustici_software_cloud_v2/models/import_request_schema.rb +195 -0
  61. data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +5 -3
  62. data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +5 -3
  63. data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +214 -0
  64. data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +226 -0
  65. data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +198 -0
  66. data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +225 -0
  67. data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +5 -3
  68. data/lib/rustici_software_cloud_v2/models/launch_auth_options_schema.rb +212 -0
  69. data/lib/rustici_software_cloud_v2/models/launch_auth_schema.rb +204 -0
  70. data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +5 -3
  71. data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +10 -38
  72. data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +25 -9
  73. data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +5 -3
  74. data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +5 -3
  75. data/lib/rustici_software_cloud_v2/models/learner_schema.rb +5 -3
  76. data/lib/rustici_software_cloud_v2/models/media_file_metadata_schema.rb +213 -0
  77. data/lib/rustici_software_cloud_v2/models/message_schema.rb +5 -3
  78. data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +12 -10
  79. data/lib/rustici_software_cloud_v2/models/objective_schema.rb +13 -45
  80. data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +5 -3
  81. data/lib/rustici_software_cloud_v2/models/ping_schema.rb +21 -15
  82. data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +24 -42
  83. data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +198 -0
  84. data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +264 -0
  85. data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb +215 -0
  86. data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +198 -0
  87. data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +287 -0
  88. data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +228 -0
  89. data/lib/rustici_software_cloud_v2/models/registration_completion.rb +2 -2
  90. data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +6 -3
  91. data/lib/rustici_software_cloud_v2/models/registration_schema.rb +17 -4
  92. data/lib/rustici_software_cloud_v2/models/registration_success.rb +2 -2
  93. data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +257 -0
  94. data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +212 -0
  95. data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +194 -0
  96. data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +185 -0
  97. data/lib/rustici_software_cloud_v2/models/response_error.rb +5 -3
  98. data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +7 -31
  99. data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +10 -38
  100. data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +7 -31
  101. data/lib/rustici_software_cloud_v2/models/score_schema.rb +5 -3
  102. data/lib/rustici_software_cloud_v2/models/setting_item.rb +7 -31
  103. data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +5 -3
  104. data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +7 -31
  105. data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +5 -3
  106. data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +5 -3
  107. data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +5 -3
  108. data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +5 -3
  109. data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +5 -3
  110. data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +5 -3
  111. data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +5 -3
  112. data/lib/rustici_software_cloud_v2/models/title_schema.rb +5 -3
  113. data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +5 -3
  114. data/lib/rustici_software_cloud_v2/models/update_application_schema.rb +196 -0
  115. data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +266 -0
  116. data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +198 -0
  117. data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +234 -0
  118. data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +213 -0
  119. data/lib/rustici_software_cloud_v2/models/xapi_account.rb +5 -3
  120. data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +5 -3
  121. data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +5 -3
  122. data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +7 -31
  123. data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +5 -3
  124. data/lib/rustici_software_cloud_v2/models/xapi_context.rb +5 -3
  125. data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +5 -3
  126. data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +193 -0
  127. data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +193 -0
  128. data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +255 -0
  129. data/lib/rustici_software_cloud_v2/models/xapi_credential_put_schema.rb +239 -0
  130. data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +264 -0
  131. data/lib/rustici_software_cloud_v2/models/xapi_credentials_list_schema.rb +202 -0
  132. data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +203 -0
  133. data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +5 -3
  134. data/lib/rustici_software_cloud_v2/models/xapi_result.rb +5 -3
  135. data/lib/rustici_software_cloud_v2/models/xapi_score.rb +5 -3
  136. data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +5 -3
  137. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +192 -0
  138. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +199 -0
  139. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_put_schema.rb +194 -0
  140. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +239 -0
  141. data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +5 -3
  142. data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +5 -3
  143. data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +5 -3
  144. data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +185 -0
  145. data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +204 -0
  146. data/lib/rustici_software_cloud_v2/version.rb +3 -3
  147. data/lib/rustici_software_cloud_v2.rb +68 -6
  148. data/rustici_software_cloud_v2.gemspec +8 -7
  149. data/spec/api_client_spec.rb +53 -47
  150. data/spec/configuration_spec.rb +2 -2
  151. data/spec/spec_helper.rb +2 -13
  152. metadata +142 -270
  153. data/docs/ActivityResultSchema.md +0 -20
  154. data/docs/ApplicationListSchema.md +0 -8
  155. data/docs/ApplicationManagementApi.md +0 -570
  156. data/docs/ApplicationSchema.md +0 -9
  157. data/docs/ApplicationToken.md +0 -10
  158. data/docs/AuthenticationApi.md +0 -64
  159. data/docs/CommentSchema.md +0 -10
  160. data/docs/CompletionAmountSchema.md +0 -8
  161. data/docs/CourseActivitySchema.md +0 -15
  162. data/docs/CourseApi.md +0 -1459
  163. data/docs/CourseListNonPagedSchema.md +0 -8
  164. data/docs/CourseListSchema.md +0 -9
  165. data/docs/CourseReferenceSchema.md +0 -10
  166. data/docs/CourseSchema.md +0 -20
  167. data/docs/CourseTagsBatchSchema.md +0 -9
  168. data/docs/CreateRegistrationSchema.md +0 -17
  169. data/docs/CredentialCreatedSchema.md +0 -12
  170. data/docs/CredentialListSchema.md +0 -8
  171. data/docs/CredentialRequestSchema.md +0 -9
  172. data/docs/CredentialSchema.md +0 -12
  173. data/docs/ImportFetchRequestSchema.md +0 -8
  174. data/docs/ImportJobResultSchema.md +0 -11
  175. data/docs/ImportResultSchema.md +0 -11
  176. data/docs/IntegerResultSchema.md +0 -8
  177. data/docs/ItemValuePairSchema.md +0 -9
  178. data/docs/LaunchHistoryListSchema.md +0 -8
  179. data/docs/LaunchHistorySchema.md +0 -17
  180. data/docs/LaunchLinkRequestSchema.md +0 -17
  181. data/docs/LaunchLinkSchema.md +0 -8
  182. data/docs/LearnerPreferenceSchema.md +0 -11
  183. data/docs/LearnerSchema.md +0 -11
  184. data/docs/LinkSchema.md +0 -8
  185. data/docs/MessageSchema.md +0 -8
  186. data/docs/MetadataSchema.md +0 -14
  187. data/docs/ObjectiveSchema.md +0 -20
  188. data/docs/PermissionsSchema.md +0 -9
  189. data/docs/PingApi.md +0 -57
  190. data/docs/PingSchema.md +0 -8
  191. data/docs/PostBackSchema.md +0 -12
  192. data/docs/RegistrationApi.md +0 -1490
  193. data/docs/RegistrationCompletion.md +0 -7
  194. data/docs/RegistrationListSchema.md +0 -9
  195. data/docs/RegistrationSchema.md +0 -27
  196. data/docs/RegistrationSuccess.md +0 -7
  197. data/docs/RegistrationTagsBatchSchema.md +0 -9
  198. data/docs/ResponseError.md +0 -8
  199. data/docs/RuntimeInteractionSchema.md +0 -18
  200. data/docs/RuntimeObjectiveSchema.md +0 -16
  201. data/docs/RuntimeSchema.md +0 -27
  202. data/docs/ScoreSchema.md +0 -8
  203. data/docs/SettingItem.md +0 -12
  204. data/docs/SettingListSchema.md +0 -8
  205. data/docs/SettingMetadata.md +0 -15
  206. data/docs/SettingMetadataValidValues.md +0 -9
  207. data/docs/SettingValidValue.md +0 -9
  208. data/docs/SettingsIndividualSchema.md +0 -10
  209. data/docs/SettingsPostSchema.md +0 -8
  210. data/docs/SharedDataEntrySchema.md +0 -9
  211. data/docs/StaticPropertiesSchema.md +0 -13
  212. data/docs/StringResultSchema.md +0 -8
  213. data/docs/TagListSchema.md +0 -8
  214. data/docs/TagPostSchema.md +0 -7
  215. data/docs/TitleSchema.md +0 -8
  216. data/docs/TokenRequestSchema.md +0 -9
  217. data/docs/XapiAccount.md +0 -9
  218. data/docs/XapiActivity.md +0 -10
  219. data/docs/XapiActivityDefinition.md +0 -19
  220. data/docs/XapiAgentGroup.md +0 -14
  221. data/docs/XapiAttachment.md +0 -14
  222. data/docs/XapiContext.md +0 -16
  223. data/docs/XapiContextActivity.md +0 -11
  224. data/docs/XapiInteractionComponent.md +0 -9
  225. data/docs/XapiResult.md +0 -13
  226. data/docs/XapiScore.md +0 -11
  227. data/docs/XapiStatement.md +0 -20
  228. data/docs/XapiStatementReference.md +0 -9
  229. data/docs/XapiStatementResult.md +0 -9
  230. data/docs/XapiVerb.md +0 -9
  231. data/git_push.sh +0 -55
  232. data/lib/rustici_software_cloud_v2/models/setting_metadata_valid_values.rb +0 -209
  233. data/spec/models/activity_result_schema_spec.rb +0 -133
  234. data/spec/models/application_list_schema_spec.rb +0 -53
  235. data/spec/models/application_schema_spec.rb +0 -59
  236. data/spec/models/application_token_spec.rb +0 -65
  237. data/spec/models/comment_schema_spec.rb +0 -65
  238. data/spec/models/completion_amount_schema_spec.rb +0 -53
  239. data/spec/models/course_activity_schema_spec.rb +0 -99
  240. data/spec/models/course_list_non_paged_schema_spec.rb +0 -53
  241. data/spec/models/course_list_schema_spec.rb +0 -59
  242. data/spec/models/course_reference_schema_spec.rb +0 -65
  243. data/spec/models/course_schema_spec.rb +0 -129
  244. data/spec/models/create_registration_schema_spec.rb +0 -107
  245. data/spec/models/credential_created_schema_spec.rb +0 -77
  246. data/spec/models/credential_list_schema_spec.rb +0 -53
  247. data/spec/models/credential_request_schema_spec.rb +0 -59
  248. data/spec/models/credential_schema_spec.rb +0 -77
  249. data/spec/models/import_fetch_request_schema_spec.rb +0 -53
  250. data/spec/models/import_job_result_schema_spec.rb +0 -75
  251. data/spec/models/import_result_schema_spec.rb +0 -71
  252. data/spec/models/integer_result_schema_spec.rb +0 -53
  253. data/spec/models/item_value_pair_schema_spec.rb +0 -59
  254. data/spec/models/launch_history_list_schema_spec.rb +0 -53
  255. data/spec/models/launch_history_schema_spec.rb +0 -115
  256. data/spec/models/launch_link_request_schema_spec.rb +0 -107
  257. data/spec/models/launch_link_schema_spec.rb +0 -53
  258. data/spec/models/learner_preference_schema_spec.rb +0 -71
  259. data/spec/models/learner_schema_spec.rb +0 -71
  260. data/spec/models/link_schema_spec.rb +0 -53
  261. data/spec/models/message_schema_spec.rb +0 -53
  262. data/spec/models/metadata_schema_spec.rb +0 -89
  263. data/spec/models/objective_schema_spec.rb +0 -137
  264. data/spec/models/permissions_schema_spec.rb +0 -59
  265. data/spec/models/ping_schema_spec.rb +0 -53
  266. data/spec/models/post_back_schema_spec.rb +0 -85
  267. data/spec/models/registration_completion_spec.rb +0 -47
  268. data/spec/models/registration_list_schema_spec.rb +0 -59
  269. data/spec/models/registration_schema_spec.rb +0 -167
  270. data/spec/models/registration_success_spec.rb +0 -47
  271. data/spec/models/response_error_spec.rb +0 -53
  272. data/spec/models/runtime_interaction_schema_spec.rb +0 -117
  273. data/spec/models/runtime_objective_schema_spec.rb +0 -109
  274. data/spec/models/runtime_schema_spec.rb +0 -171
  275. data/spec/models/score_schema_spec.rb +0 -53
  276. data/spec/models/setting_item_spec.rb +0 -81
  277. data/spec/models/setting_list_schema_spec.rb +0 -53
  278. data/spec/models/setting_metadata_spec.rb +0 -99
  279. data/spec/models/setting_metadata_valid_values_spec.rb +0 -59
  280. data/spec/models/settings_individual_schema_spec.rb +0 -65
  281. data/spec/models/settings_post_schema_spec.rb +0 -53
  282. data/spec/models/shared_data_entry_schema_spec.rb +0 -59
  283. data/spec/models/static_properties_schema_spec.rb +0 -83
  284. data/spec/models/string_result_schema_spec.rb +0 -53
  285. data/spec/models/title_schema_spec.rb +0 -53
  286. data/spec/models/token_request_schema_spec.rb +0 -59
  287. data/swagger-codegen.config +0 -11
@@ -3,10 +3,10 @@
3
3
 
4
4
  #REST API used for SCORM Cloud integrations.
5
5
 
6
- OpenAPI spec version: 2.0 beta
6
+ OpenAPI spec version: 2.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.4.3
9
+ Swagger Codegen version: 2.4.12
10
10
 
11
11
  =end
12
12
 
@@ -19,8 +19,69 @@ module RusticiSoftwareCloudV2
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Create a new instance for this registration specified by the registration ID
23
- # @param registration_id id for this registration
22
+ # Get a launch link for a Registration
23
+ # Returns the launch link to use to launch the course for the registration. Launch links are meant as a way to provide access to your content. When a learner visits the link, the course will be launched and registration progress will start to be tracked.
24
+ # @param registration_id
25
+ # @param launch_link_request
26
+ # @param [Hash] opts the optional parameters
27
+ # @return [LaunchLinkSchema]
28
+ def build_registration_launch_link(registration_id, launch_link_request, opts = {})
29
+ data, _status_code, _headers = build_registration_launch_link_with_http_info(registration_id, launch_link_request, opts)
30
+ data
31
+ end
32
+
33
+ # Get a launch link for a Registration
34
+ # Returns the launch link to use to launch the course for the registration. Launch links are meant as a way to provide access to your content. When a learner visits the link, the course will be launched and registration progress will start to be tracked.
35
+ # @param registration_id
36
+ # @param launch_link_request
37
+ # @param [Hash] opts the optional parameters
38
+ # @return [Array<(LaunchLinkSchema, Fixnum, Hash)>] LaunchLinkSchema data, response status code and response headers
39
+ def build_registration_launch_link_with_http_info(registration_id, launch_link_request, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: RegistrationApi.build_registration_launch_link ...'
42
+ end
43
+ # verify the required parameter 'registration_id' is set
44
+ if registration_id.nil?
45
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.build_registration_launch_link"
46
+ end
47
+ # verify the required parameter 'launch_link_request' is set
48
+ if launch_link_request.nil?
49
+ fail ArgumentError, "Missing the required parameter 'launch_link_request' when calling RegistrationApi.build_registration_launch_link"
50
+ end
51
+ # resource path
52
+ local_var_path = '/registrations/{registrationId}/launchLink'.sub('{' + 'registrationId' + '}', registration_id.to_s)
53
+
54
+ # query parameters
55
+ query_params = {}
56
+
57
+ # header parameters
58
+ header_params = {}
59
+ # HTTP header 'Accept' (if needed)
60
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
61
+ # HTTP header 'Content-Type'
62
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
63
+
64
+ # form parameters
65
+ form_params = {}
66
+
67
+ # http body (model)
68
+ post_body = @api_client.object_to_http_body(launch_link_request)
69
+ auth_names = ['APP_NORMAL', 'OAUTH']
70
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
71
+ :header_params => header_params,
72
+ :query_params => query_params,
73
+ :form_params => form_params,
74
+ :body => post_body,
75
+ :auth_names => auth_names,
76
+ :return_type => 'LaunchLinkSchema')
77
+ if @api_client.config.debugging
78
+ @api_client.config.logger.debug "API called: RegistrationApi#build_registration_launch_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
79
+ end
80
+ return data, status_code, headers
81
+ end
82
+ # Create a Registration Instance
83
+ # Creates a new instance of the registration. Registration instances will be automatically created when a learner launches a new version of the course. This allows for tracking registration progress for each of the versions of the course the learner has taken. When the created registration instance is \"launched\", the course specified at creation time will be launched.
84
+ # @param registration_id
24
85
  # @param [Hash] opts the optional parameters
25
86
  # @return [nil]
26
87
  def create_new_registration_instance(registration_id, opts = {})
@@ -28,8 +89,9 @@ module RusticiSoftwareCloudV2
28
89
  nil
29
90
  end
30
91
 
31
- # Create a new instance for this registration specified by the registration ID
32
- # @param registration_id id for this registration
92
+ # Create a Registration Instance
93
+ # Creates a new instance of the registration. Registration instances will be automatically created when a learner launches a new version of the course. This allows for tracking registration progress for each of the versions of the course the learner has taken. When the created registration instance is \&quot;launched\&quot;, the course specified at creation time will be launched.
94
+ # @param registration_id
33
95
  # @param [Hash] opts the optional parameters
34
96
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
35
97
  def create_new_registration_instance_with_http_info(registration_id, opts = {})
@@ -37,7 +99,7 @@ module RusticiSoftwareCloudV2
37
99
  @api_client.config.logger.debug 'Calling API: RegistrationApi.create_new_registration_instance ...'
38
100
  end
39
101
  # verify the required parameter 'registration_id' is set
40
- if @api_client.config.client_side_validation && registration_id.nil?
102
+ if registration_id.nil?
41
103
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.create_new_registration_instance"
42
104
  end
43
105
  # resource path
@@ -70,27 +132,29 @@ module RusticiSoftwareCloudV2
70
132
  end
71
133
  return data, status_code, headers
72
134
  end
73
- # Create a registration.
135
+ # Create a Registration
136
+ # Creates a new registration. Registrations are the billable unit in SCORM Cloud, and represent a link between a learner and a course. A registration will contain a few pieces of information such as learner identifiers, the id of the course being registered for, and several other optional fields. A registration must be tied to a specific course at creation time. When the created registration is \"launched\", the course specified at creation time will be launched.
74
137
  # @param registration
75
138
  # @param [Hash] opts the optional parameters
76
- # @option opts [Integer] :course_version The version of the course you want to create the registration for. Unless you have a reason for using this you probably do not need to.
139
+ # @option opts [Integer] :course_version Unless you have a reason for using this you probably do not need to.
77
140
  # @return [nil]
78
141
  def create_registration(registration, opts = {})
79
142
  create_registration_with_http_info(registration, opts)
80
143
  nil
81
144
  end
82
145
 
83
- # Create a registration.
146
+ # Create a Registration
147
+ # Creates a new registration. Registrations are the billable unit in SCORM Cloud, and represent a link between a learner and a course. A registration will contain a few pieces of information such as learner identifiers, the id of the course being registered for, and several other optional fields. A registration must be tied to a specific course at creation time. When the created registration is \&quot;launched\&quot;, the course specified at creation time will be launched.
84
148
  # @param registration
85
149
  # @param [Hash] opts the optional parameters
86
- # @option opts [Integer] :course_version The version of the course you want to create the registration for. Unless you have a reason for using this you probably do not need to.
150
+ # @option opts [Integer] :course_version Unless you have a reason for using this you probably do not need to.
87
151
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
88
152
  def create_registration_with_http_info(registration, opts = {})
89
153
  if @api_client.config.debugging
90
154
  @api_client.config.logger.debug 'Calling API: RegistrationApi.create_registration ...'
91
155
  end
92
156
  # verify the required parameter 'registration' is set
93
- if @api_client.config.client_side_validation && registration.nil?
157
+ if registration.nil?
94
158
  fail ArgumentError, "Missing the required parameter 'registration' when calling RegistrationApi.create_registration"
95
159
  end
96
160
  # resource path
@@ -124,8 +188,9 @@ module RusticiSoftwareCloudV2
124
188
  end
125
189
  return data, status_code, headers
126
190
  end
127
- # Delete `registrationId`
128
- # @param registration_id id for this registration
191
+ # Delete a Registration
192
+ # Deletes the specified registration. >**Caution:** >This will also delete all instances of the registration.
193
+ # @param registration_id
129
194
  # @param [Hash] opts the optional parameters
130
195
  # @return [nil]
131
196
  def delete_registration(registration_id, opts = {})
@@ -133,8 +198,9 @@ module RusticiSoftwareCloudV2
133
198
  nil
134
199
  end
135
200
 
136
- # Delete &#x60;registrationId&#x60;
137
- # @param registration_id id for this registration
201
+ # Delete a Registration
202
+ # Deletes the specified registration. &gt;**Caution:** &gt;This will also delete all instances of the registration.
203
+ # @param registration_id
138
204
  # @param [Hash] opts the optional parameters
139
205
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
140
206
  def delete_registration_with_http_info(registration_id, opts = {})
@@ -142,7 +208,7 @@ module RusticiSoftwareCloudV2
142
208
  @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration ...'
143
209
  end
144
210
  # verify the required parameter 'registration_id' is set
145
- if @api_client.config.client_side_validation && registration_id.nil?
211
+ if registration_id.nil?
146
212
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration"
147
213
  end
148
214
  # resource path
@@ -175,8 +241,9 @@ module RusticiSoftwareCloudV2
175
241
  end
176
242
  return data, status_code, headers
177
243
  end
178
- # Clears the `settingId` value for this registration
179
- # @param registration_id id for this registration
244
+ # Delete a configuration setting explicitly set for a Registration
245
+ # Clears the specified setting from the registration. This causes the setting to inherit a value from a higher level (e.g. course). If the configuration setting was not set at the registration level it will continue to persist and will require deletion from the level it was set.
246
+ # @param registration_id
180
247
  # @param setting_id
181
248
  # @param [Hash] opts the optional parameters
182
249
  # @return [nil]
@@ -185,8 +252,9 @@ module RusticiSoftwareCloudV2
185
252
  nil
186
253
  end
187
254
 
188
- # Clears the &#x60;settingId&#x60; value for this registration
189
- # @param registration_id id for this registration
255
+ # Delete a configuration setting explicitly set for a Registration
256
+ # Clears the specified setting from the registration. This causes the setting to inherit a value from a higher level (e.g. course). If the configuration setting was not set at the registration level it will continue to persist and will require deletion from the level it was set.
257
+ # @param registration_id
190
258
  # @param setting_id
191
259
  # @param [Hash] opts the optional parameters
192
260
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -195,11 +263,11 @@ module RusticiSoftwareCloudV2
195
263
  @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_configuration_setting ...'
196
264
  end
197
265
  # verify the required parameter 'registration_id' is set
198
- if @api_client.config.client_side_validation && registration_id.nil?
266
+ if registration_id.nil?
199
267
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_configuration_setting"
200
268
  end
201
269
  # verify the required parameter 'setting_id' is set
202
- if @api_client.config.client_side_validation && setting_id.nil?
270
+ if setting_id.nil?
203
271
  fail ArgumentError, "Missing the required parameter 'setting_id' when calling RegistrationApi.delete_registration_configuration_setting"
204
272
  end
205
273
  # resource path
@@ -232,9 +300,122 @@ module RusticiSoftwareCloudV2
232
300
  end
233
301
  return data, status_code, headers
234
302
  end
235
- # Clears the `settingId` value for this registration instance
236
- # @param registration_id id for this registration
237
- # @param instance_id The instance of this registration
303
+ # Reset global data for a Registration
304
+ # Deletes the global data associated with the registration, but the registration itself will remain. This means any progress towards the global objectives will be removed.
305
+ # @param registration_id
306
+ # @param [Hash] opts the optional parameters
307
+ # @return [nil]
308
+ def delete_registration_global_data(registration_id, opts = {})
309
+ delete_registration_global_data_with_http_info(registration_id, opts)
310
+ nil
311
+ end
312
+
313
+ # Reset global data for a Registration
314
+ # Deletes the global data associated with the registration, but the registration itself will remain. This means any progress towards the global objectives will be removed.
315
+ # @param registration_id
316
+ # @param [Hash] opts the optional parameters
317
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
318
+ def delete_registration_global_data_with_http_info(registration_id, opts = {})
319
+ if @api_client.config.debugging
320
+ @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_global_data ...'
321
+ end
322
+ # verify the required parameter 'registration_id' is set
323
+ if registration_id.nil?
324
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_global_data"
325
+ end
326
+ # resource path
327
+ local_var_path = '/registrations/{registrationId}/globalData'.sub('{' + 'registrationId' + '}', registration_id.to_s)
328
+
329
+ # query parameters
330
+ query_params = {}
331
+
332
+ # header parameters
333
+ header_params = {}
334
+ # HTTP header 'Accept' (if needed)
335
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
336
+ # HTTP header 'Content-Type'
337
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
338
+
339
+ # form parameters
340
+ form_params = {}
341
+
342
+ # http body (model)
343
+ post_body = nil
344
+ auth_names = ['APP_NORMAL', 'OAUTH']
345
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
346
+ :header_params => header_params,
347
+ :query_params => query_params,
348
+ :form_params => form_params,
349
+ :body => post_body,
350
+ :auth_names => auth_names)
351
+ if @api_client.config.debugging
352
+ @api_client.config.logger.debug "API called: RegistrationApi#delete_registration_global_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
353
+ end
354
+ return data, status_code, headers
355
+ end
356
+ # Delete a Registration Instance
357
+ # Deletes the specified instance of the registration. If deleting the last remaining instance of the registration, the registration itself will be deleted along with any associated data.
358
+ # @param registration_id
359
+ # @param instance_id
360
+ # @param [Hash] opts the optional parameters
361
+ # @return [nil]
362
+ def delete_registration_instance(registration_id, instance_id, opts = {})
363
+ delete_registration_instance_with_http_info(registration_id, instance_id, opts)
364
+ nil
365
+ end
366
+
367
+ # Delete a Registration Instance
368
+ # Deletes the specified instance of the registration. If deleting the last remaining instance of the registration, the registration itself will be deleted along with any associated data.
369
+ # @param registration_id
370
+ # @param instance_id
371
+ # @param [Hash] opts the optional parameters
372
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
373
+ def delete_registration_instance_with_http_info(registration_id, instance_id, opts = {})
374
+ if @api_client.config.debugging
375
+ @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_instance ...'
376
+ end
377
+ # verify the required parameter 'registration_id' is set
378
+ if registration_id.nil?
379
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_instance"
380
+ end
381
+ # verify the required parameter 'instance_id' is set
382
+ if instance_id.nil?
383
+ fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.delete_registration_instance"
384
+ end
385
+ # resource path
386
+ local_var_path = '/registrations/{registrationId}/instances/{instanceId}'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
387
+
388
+ # query parameters
389
+ query_params = {}
390
+
391
+ # header parameters
392
+ header_params = {}
393
+ # HTTP header 'Accept' (if needed)
394
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
395
+ # HTTP header 'Content-Type'
396
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
397
+
398
+ # form parameters
399
+ form_params = {}
400
+
401
+ # http body (model)
402
+ post_body = nil
403
+ auth_names = ['APP_NORMAL', 'OAUTH']
404
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
405
+ :header_params => header_params,
406
+ :query_params => query_params,
407
+ :form_params => form_params,
408
+ :body => post_body,
409
+ :auth_names => auth_names)
410
+ if @api_client.config.debugging
411
+ @api_client.config.logger.debug "API called: RegistrationApi#delete_registration_instance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
412
+ end
413
+ return data, status_code, headers
414
+ end
415
+ # Delete a configuration setting explicitly set for a Registration Instance
416
+ # Clears the specified setting from the registration instance. This causes the setting to inherit a value from a higher level (e.g. course). If the configuration setting was not set at the registration level it will continue to persist and will require deletion from the level it was set.
417
+ # @param registration_id
418
+ # @param instance_id
238
419
  # @param setting_id
239
420
  # @param [Hash] opts the optional parameters
240
421
  # @return [nil]
@@ -243,9 +424,10 @@ module RusticiSoftwareCloudV2
243
424
  nil
244
425
  end
245
426
 
246
- # Clears the &#x60;settingId&#x60; value for this registration instance
247
- # @param registration_id id for this registration
248
- # @param instance_id The instance of this registration
427
+ # Delete a configuration setting explicitly set for a Registration Instance
428
+ # Clears the specified setting from the registration instance. This causes the setting to inherit a value from a higher level (e.g. course). If the configuration setting was not set at the registration level it will continue to persist and will require deletion from the level it was set.
429
+ # @param registration_id
430
+ # @param instance_id
249
431
  # @param setting_id
250
432
  # @param [Hash] opts the optional parameters
251
433
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -254,19 +436,15 @@ module RusticiSoftwareCloudV2
254
436
  @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_instance_configuration_setting ...'
255
437
  end
256
438
  # verify the required parameter 'registration_id' is set
257
- if @api_client.config.client_side_validation && registration_id.nil?
439
+ if registration_id.nil?
258
440
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_instance_configuration_setting"
259
441
  end
260
442
  # verify the required parameter 'instance_id' is set
261
- if @api_client.config.client_side_validation && instance_id.nil?
443
+ if instance_id.nil?
262
444
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.delete_registration_instance_configuration_setting"
263
445
  end
264
- if @api_client.config.client_side_validation && instance_id < 0
265
- fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.delete_registration_instance_configuration_setting, must be greater than or equal to 0.'
266
- end
267
-
268
446
  # verify the required parameter 'setting_id' is set
269
- if @api_client.config.client_side_validation && setting_id.nil?
447
+ if setting_id.nil?
270
448
  fail ArgumentError, "Missing the required parameter 'setting_id' when calling RegistrationApi.delete_registration_instance_configuration_setting"
271
449
  end
272
450
  # resource path
@@ -299,8 +477,9 @@ module RusticiSoftwareCloudV2
299
477
  end
300
478
  return data, status_code, headers
301
479
  end
302
- # Delete registration progress (clear registration)
303
- # @param registration_id id for this registration
480
+ # Reset a Registration
481
+ # Deletes the data associated with the registration, but the registration itself will remain. This means any of the launch history, and progress will be removed. After the data has been deleted, the registration will automatically register itself for the latest version of the course.
482
+ # @param registration_id
304
483
  # @param [Hash] opts the optional parameters
305
484
  # @return [nil]
306
485
  def delete_registration_progress(registration_id, opts = {})
@@ -308,8 +487,9 @@ module RusticiSoftwareCloudV2
308
487
  nil
309
488
  end
310
489
 
311
- # Delete registration progress (clear registration)
312
- # @param registration_id id for this registration
490
+ # Reset a Registration
491
+ # Deletes the data associated with the registration, but the registration itself will remain. This means any of the launch history, and progress will be removed. After the data has been deleted, the registration will automatically register itself for the latest version of the course.
492
+ # @param registration_id
313
493
  # @param [Hash] opts the optional parameters
314
494
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
315
495
  def delete_registration_progress_with_http_info(registration_id, opts = {})
@@ -317,7 +497,7 @@ module RusticiSoftwareCloudV2
317
497
  @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_progress ...'
318
498
  end
319
499
  # verify the required parameter 'registration_id' is set
320
- if @api_client.config.client_side_validation && registration_id.nil?
500
+ if registration_id.nil?
321
501
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_progress"
322
502
  end
323
503
  # resource path
@@ -350,8 +530,9 @@ module RusticiSoftwareCloudV2
350
530
  end
351
531
  return data, status_code, headers
352
532
  end
353
- # Delete tags for this registration
354
- # @param registration_id id for this registration
533
+ # Delete tags from a Registration
534
+ # Deletes the specified tags from the registration. Deleting tags that do not exist will still result in a success.
535
+ # @param registration_id
355
536
  # @param tags
356
537
  # @param [Hash] opts the optional parameters
357
538
  # @return [nil]
@@ -360,8 +541,9 @@ module RusticiSoftwareCloudV2
360
541
  nil
361
542
  end
362
543
 
363
- # Delete tags for this registration
364
- # @param registration_id id for this registration
544
+ # Delete tags from a Registration
545
+ # Deletes the specified tags from the registration. Deleting tags that do not exist will still result in a success.
546
+ # @param registration_id
365
547
  # @param tags
366
548
  # @param [Hash] opts the optional parameters
367
549
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -370,11 +552,11 @@ module RusticiSoftwareCloudV2
370
552
  @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_tags ...'
371
553
  end
372
554
  # verify the required parameter 'registration_id' is set
373
- if @api_client.config.client_side_validation && registration_id.nil?
555
+ if registration_id.nil?
374
556
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_tags"
375
557
  end
376
558
  # verify the required parameter 'tags' is set
377
- if @api_client.config.client_side_validation && tags.nil?
559
+ if tags.nil?
378
560
  fail ArgumentError, "Missing the required parameter 'tags' when calling RegistrationApi.delete_registration_tags"
379
561
  end
380
562
  # resource path
@@ -407,29 +589,31 @@ module RusticiSoftwareCloudV2
407
589
  end
408
590
  return data, status_code, headers
409
591
  end
410
- # Delete global data associated with `registrationId`
411
- # @param registration_id id for this registration
592
+ # Check that a Registration exists
593
+ # Checks that the registration exists within SCORM Cloud. >**Info:** >No registration data will be returned for this call. A successful `200` response indicates that the registration exists. If the registration does not exist, a `404` error will be returned instead. If you are looking for information about the registration, try calling `GetRegistrationProgress` instead.
594
+ # @param registration_id
412
595
  # @param [Hash] opts the optional parameters
413
596
  # @return [nil]
414
- def delete_registrations_global_data(registration_id, opts = {})
415
- delete_registrations_global_data_with_http_info(registration_id, opts)
597
+ def get_registration(registration_id, opts = {})
598
+ get_registration_with_http_info(registration_id, opts)
416
599
  nil
417
600
  end
418
601
 
419
- # Delete global data associated with &#x60;registrationId&#x60;
420
- # @param registration_id id for this registration
602
+ # Check that a Registration exists
603
+ # Checks that the registration exists within SCORM Cloud. &gt;**Info:** &gt;No registration data will be returned for this call. A successful &#x60;200&#x60; response indicates that the registration exists. If the registration does not exist, a &#x60;404&#x60; error will be returned instead. If you are looking for information about the registration, try calling &#x60;GetRegistrationProgress&#x60; instead.
604
+ # @param registration_id
421
605
  # @param [Hash] opts the optional parameters
422
606
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
423
- def delete_registrations_global_data_with_http_info(registration_id, opts = {})
607
+ def get_registration_with_http_info(registration_id, opts = {})
424
608
  if @api_client.config.debugging
425
- @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registrations_global_data ...'
609
+ @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration ...'
426
610
  end
427
611
  # verify the required parameter 'registration_id' is set
428
- if @api_client.config.client_side_validation && registration_id.nil?
429
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registrations_global_data"
612
+ if registration_id.nil?
613
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration"
430
614
  end
431
615
  # resource path
432
- local_var_path = '/registrations/{registrationId}/globalData'.sub('{' + 'registrationId' + '}', registration_id.to_s)
616
+ local_var_path = '/registrations/{registrationId}'.sub('{' + 'registrationId' + '}', registration_id.to_s)
433
617
 
434
618
  # query parameters
435
619
  query_params = {}
@@ -447,19 +631,20 @@ module RusticiSoftwareCloudV2
447
631
  # http body (model)
448
632
  post_body = nil
449
633
  auth_names = ['APP_NORMAL', 'OAUTH']
450
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
634
+ data, status_code, headers = @api_client.call_api(:HEAD, local_var_path,
451
635
  :header_params => header_params,
452
636
  :query_params => query_params,
453
637
  :form_params => form_params,
454
638
  :body => post_body,
455
639
  :auth_names => auth_names)
456
640
  if @api_client.config.debugging
457
- @api_client.config.logger.debug "API called: RegistrationApi#delete_registrations_global_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
641
+ @api_client.config.logger.debug "API called: RegistrationApi#get_registration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
458
642
  end
459
643
  return data, status_code, headers
460
644
  end
461
- # Returns all configuration settings for this registration
462
- # @param registration_id id for this registration
645
+ # Get effective configuration settings for a Registration
646
+ # Returns the effective configuration settings for the registration. If not set at the registration level, the setting will inherit a value from a higher level (e.g. course). Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
647
+ # @param registration_id
463
648
  # @param [Hash] opts the optional parameters
464
649
  # @option opts [BOOLEAN] :include_metadata (default to false)
465
650
  # @return [SettingListSchema]
@@ -468,8 +653,9 @@ module RusticiSoftwareCloudV2
468
653
  data
469
654
  end
470
655
 
471
- # Returns all configuration settings for this registration
472
- # @param registration_id id for this registration
656
+ # Get effective configuration settings for a Registration
657
+ # Returns the effective configuration settings for the registration. If not set at the registration level, the setting will inherit a value from a higher level (e.g. course). Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
658
+ # @param registration_id
473
659
  # @param [Hash] opts the optional parameters
474
660
  # @option opts [BOOLEAN] :include_metadata
475
661
  # @return [Array<(SettingListSchema, Fixnum, Hash)>] SettingListSchema data, response status code and response headers
@@ -478,7 +664,7 @@ module RusticiSoftwareCloudV2
478
664
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_configuration ...'
479
665
  end
480
666
  # verify the required parameter 'registration_id' is set
481
- if @api_client.config.client_side_validation && registration_id.nil?
667
+ if registration_id.nil?
482
668
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_configuration"
483
669
  end
484
670
  # resource path
@@ -513,9 +699,10 @@ module RusticiSoftwareCloudV2
513
699
  end
514
700
  return data, status_code, headers
515
701
  end
516
- # Returns all configuration settings for this registration instance
517
- # @param registration_id id for this registration
518
- # @param instance_id The instance of this registration
702
+ # Get effective configuration settings for a Registration Instance
703
+ # Returns the effective configuration settings for the registration instance. If not set at the registration level, the setting will inherit a value from a higher level (e.g. course). Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
704
+ # @param registration_id
705
+ # @param instance_id
519
706
  # @param [Hash] opts the optional parameters
520
707
  # @option opts [BOOLEAN] :include_metadata (default to false)
521
708
  # @return [SettingListSchema]
@@ -524,9 +711,10 @@ module RusticiSoftwareCloudV2
524
711
  data
525
712
  end
526
713
 
527
- # Returns all configuration settings for this registration instance
528
- # @param registration_id id for this registration
529
- # @param instance_id The instance of this registration
714
+ # Get effective configuration settings for a Registration Instance
715
+ # Returns the effective configuration settings for the registration instance. If not set at the registration level, the setting will inherit a value from a higher level (e.g. course). Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
716
+ # @param registration_id
717
+ # @param instance_id
530
718
  # @param [Hash] opts the optional parameters
531
719
  # @option opts [BOOLEAN] :include_metadata
532
720
  # @return [Array<(SettingListSchema, Fixnum, Hash)>] SettingListSchema data, response status code and response headers
@@ -535,17 +723,13 @@ module RusticiSoftwareCloudV2
535
723
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_configuration ...'
536
724
  end
537
725
  # verify the required parameter 'registration_id' is set
538
- if @api_client.config.client_side_validation && registration_id.nil?
726
+ if registration_id.nil?
539
727
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_configuration"
540
728
  end
541
729
  # verify the required parameter 'instance_id' is set
542
- if @api_client.config.client_side_validation && instance_id.nil?
730
+ if instance_id.nil?
543
731
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_configuration"
544
732
  end
545
- if @api_client.config.client_side_validation && instance_id < 0
546
- fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_configuration, must be greater than or equal to 0.'
547
- end
548
-
549
733
  # resource path
550
734
  local_var_path = '/registrations/{registrationId}/instances/{instanceId}/configuration'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
551
735
 
@@ -578,9 +762,10 @@ module RusticiSoftwareCloudV2
578
762
  end
579
763
  return data, status_code, headers
580
764
  end
581
- # Returns history of this registration's launches
582
- # @param registration_id id for this registration
583
- # @param instance_id The instance of this registration
765
+ # Get launch history for a Registration Instance
766
+ # Returns the launch history of the registration instance. This includes completion status, time taken, and pass/fail status.
767
+ # @param registration_id
768
+ # @param instance_id
584
769
  # @param [Hash] opts the optional parameters
585
770
  # @option opts [BOOLEAN] :include_history_log Whether to include the history log in the launch history (default to false)
586
771
  # @return [LaunchHistoryListSchema]
@@ -589,9 +774,10 @@ module RusticiSoftwareCloudV2
589
774
  data
590
775
  end
591
776
 
592
- # Returns history of this registration&#39;s launches
593
- # @param registration_id id for this registration
594
- # @param instance_id The instance of this registration
777
+ # Get launch history for a Registration Instance
778
+ # Returns the launch history of the registration instance. This includes completion status, time taken, and pass/fail status.
779
+ # @param registration_id
780
+ # @param instance_id
595
781
  # @param [Hash] opts the optional parameters
596
782
  # @option opts [BOOLEAN] :include_history_log Whether to include the history log in the launch history
597
783
  # @return [Array<(LaunchHistoryListSchema, Fixnum, Hash)>] LaunchHistoryListSchema data, response status code and response headers
@@ -600,17 +786,13 @@ module RusticiSoftwareCloudV2
600
786
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_launch_history ...'
601
787
  end
602
788
  # verify the required parameter 'registration_id' is set
603
- if @api_client.config.client_side_validation && registration_id.nil?
789
+ if registration_id.nil?
604
790
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_launch_history"
605
791
  end
606
792
  # verify the required parameter 'instance_id' is set
607
- if @api_client.config.client_side_validation && instance_id.nil?
793
+ if instance_id.nil?
608
794
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_launch_history"
609
795
  end
610
- if @api_client.config.client_side_validation && instance_id < 0
611
- fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_launch_history, must be greater than or equal to 0.'
612
- end
613
-
614
796
  # resource path
615
797
  local_var_path = '/registrations/{registrationId}/instances/{instanceId}/launchHistory'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
616
798
 
@@ -643,9 +825,10 @@ module RusticiSoftwareCloudV2
643
825
  end
644
826
  return data, status_code, headers
645
827
  end
646
- # Get registration progress for instance `instanceId` of `registrationId`
647
- # @param registration_id id for this registration
648
- # @param instance_id The instance of this registration
828
+ # Get detailed information about a Registration Instance
829
+ # Returns detailed information about the registration instance. This includes completion status, time taken, score, and pass/fail status.
830
+ # @param registration_id
831
+ # @param instance_id
649
832
  # @param [Hash] opts the optional parameters
650
833
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results (default to false)
651
834
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results (default to false)
@@ -656,9 +839,10 @@ module RusticiSoftwareCloudV2
656
839
  data
657
840
  end
658
841
 
659
- # Get registration progress for instance &#x60;instanceId&#x60; of &#x60;registrationId&#x60;
660
- # @param registration_id id for this registration
661
- # @param instance_id The instance of this registration
842
+ # Get detailed information about a Registration Instance
843
+ # Returns detailed information about the registration instance. This includes completion status, time taken, score, and pass/fail status.
844
+ # @param registration_id
845
+ # @param instance_id
662
846
  # @param [Hash] opts the optional parameters
663
847
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results
664
848
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results
@@ -669,17 +853,13 @@ module RusticiSoftwareCloudV2
669
853
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_progress ...'
670
854
  end
671
855
  # verify the required parameter 'registration_id' is set
672
- if @api_client.config.client_side_validation && registration_id.nil?
856
+ if registration_id.nil?
673
857
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_progress"
674
858
  end
675
859
  # verify the required parameter 'instance_id' is set
676
- if @api_client.config.client_side_validation && instance_id.nil?
860
+ if instance_id.nil?
677
861
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_progress"
678
862
  end
679
- if @api_client.config.client_side_validation && instance_id < 0
680
- fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_progress, must be greater than or equal to 0.'
681
- end
682
-
683
863
  # resource path
684
864
  local_var_path = '/registrations/{registrationId}/instances/{instanceId}'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
685
865
 
@@ -714,43 +894,41 @@ module RusticiSoftwareCloudV2
714
894
  end
715
895
  return data, status_code, headers
716
896
  end
717
- # Get xAPI statements for instance `instanceId` of `registrationId`
718
- # @param registration_id id for this registration
719
- # @param instance_id The instance of this registration
897
+ # Get xAPI statements for a Registration Instance
898
+ # Returns xAPI statements for the registration instance.
899
+ # @param registration_id
900
+ # @param instance_id
720
901
  # @param [Hash] opts the optional parameters
721
- # @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
722
- # @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
723
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
902
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
903
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
904
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
724
905
  # @return [XapiStatementResult]
725
906
  def get_registration_instance_statements(registration_id, instance_id, opts = {})
726
907
  data, _status_code, _headers = get_registration_instance_statements_with_http_info(registration_id, instance_id, opts)
727
908
  data
728
909
  end
729
910
 
730
- # Get xAPI statements for instance &#x60;instanceId&#x60; of &#x60;registrationId&#x60;
731
- # @param registration_id id for this registration
732
- # @param instance_id The instance of this registration
911
+ # Get xAPI statements for a Registration Instance
912
+ # Returns xAPI statements for the registration instance.
913
+ # @param registration_id
914
+ # @param instance_id
733
915
  # @param [Hash] opts the optional parameters
734
- # @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
735
- # @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
736
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
916
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
917
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
918
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
737
919
  # @return [Array<(XapiStatementResult, Fixnum, Hash)>] XapiStatementResult data, response status code and response headers
738
920
  def get_registration_instance_statements_with_http_info(registration_id, instance_id, opts = {})
739
921
  if @api_client.config.debugging
740
922
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_statements ...'
741
923
  end
742
924
  # verify the required parameter 'registration_id' is set
743
- if @api_client.config.client_side_validation && registration_id.nil?
925
+ if registration_id.nil?
744
926
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_statements"
745
927
  end
746
928
  # verify the required parameter 'instance_id' is set
747
- if @api_client.config.client_side_validation && instance_id.nil?
929
+ if instance_id.nil?
748
930
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_statements"
749
931
  end
750
- if @api_client.config.client_side_validation && instance_id < 0
751
- fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_statements, must be greater than or equal to 0.'
752
- end
753
-
754
932
  # resource path
755
933
  local_var_path = '/registrations/{registrationId}/instances/{instanceId}/xAPIStatements'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
756
934
 
@@ -785,12 +963,13 @@ module RusticiSoftwareCloudV2
785
963
  end
786
964
  return data, status_code, headers
787
965
  end
788
- # Get all the instances of this the registration specified by the registration ID
789
- # @param registration_id id for this registration
966
+ # Get a list of a Registration's Instances
967
+ # Returns information about all instances of the registration. This can be useful to see information such as registration progress across versions of a course.
968
+ # @param registration_id
790
969
  # @param [Hash] opts the optional parameters
791
- # @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
792
- # @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
793
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
970
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
971
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
972
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
794
973
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results (default to false)
795
974
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results (default to false)
796
975
  # @option opts [BOOLEAN] :include_runtime Include runtime details in the results (default to false)
@@ -800,12 +979,13 @@ module RusticiSoftwareCloudV2
800
979
  data
801
980
  end
802
981
 
803
- # Get all the instances of this the registration specified by the registration ID
804
- # @param registration_id id for this registration
982
+ # Get a list of a Registration&#39;s Instances
983
+ # Returns information about all instances of the registration. This can be useful to see information such as registration progress across versions of a course.
984
+ # @param registration_id
805
985
  # @param [Hash] opts the optional parameters
806
- # @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
807
- # @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
808
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
986
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
987
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
988
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
809
989
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results
810
990
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results
811
991
  # @option opts [BOOLEAN] :include_runtime Include runtime details in the results
@@ -815,7 +995,7 @@ module RusticiSoftwareCloudV2
815
995
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instances ...'
816
996
  end
817
997
  # verify the required parameter 'registration_id' is set
818
- if @api_client.config.client_side_validation && registration_id.nil?
998
+ if registration_id.nil?
819
999
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instances"
820
1000
  end
821
1001
  # resource path
@@ -855,8 +1035,9 @@ module RusticiSoftwareCloudV2
855
1035
  end
856
1036
  return data, status_code, headers
857
1037
  end
858
- # Returns history of this registration's launches
859
- # @param registration_id id for this registration
1038
+ # Get launch history for a Registration
1039
+ # Returns the launch history of the registration. This includes completion status, time taken, and pass/fail status.
1040
+ # @param registration_id
860
1041
  # @param [Hash] opts the optional parameters
861
1042
  # @option opts [BOOLEAN] :include_history_log Whether to include the history log in the launch history (default to false)
862
1043
  # @return [LaunchHistoryListSchema]
@@ -865,8 +1046,9 @@ module RusticiSoftwareCloudV2
865
1046
  data
866
1047
  end
867
1048
 
868
- # Returns history of this registration&#39;s launches
869
- # @param registration_id id for this registration
1049
+ # Get launch history for a Registration
1050
+ # Returns the launch history of the registration. This includes completion status, time taken, and pass/fail status.
1051
+ # @param registration_id
870
1052
  # @param [Hash] opts the optional parameters
871
1053
  # @option opts [BOOLEAN] :include_history_log Whether to include the history log in the launch history
872
1054
  # @return [Array<(LaunchHistoryListSchema, Fixnum, Hash)>] LaunchHistoryListSchema data, response status code and response headers
@@ -875,7 +1057,7 @@ module RusticiSoftwareCloudV2
875
1057
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_launch_history ...'
876
1058
  end
877
1059
  # verify the required parameter 'registration_id' is set
878
- if @api_client.config.client_side_validation && registration_id.nil?
1060
+ if registration_id.nil?
879
1061
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_launch_history"
880
1062
  end
881
1063
  # resource path
@@ -910,66 +1092,9 @@ module RusticiSoftwareCloudV2
910
1092
  end
911
1093
  return data, status_code, headers
912
1094
  end
913
- # Returns the link to use to launch this registration
914
- # @param registration_id id for this registration
915
- # @param launch_link_request
916
- # @param [Hash] opts the optional parameters
917
- # @return [LaunchLinkSchema]
918
- def get_registration_launch_link(registration_id, launch_link_request, opts = {})
919
- data, _status_code, _headers = get_registration_launch_link_with_http_info(registration_id, launch_link_request, opts)
920
- data
921
- end
922
-
923
- # Returns the link to use to launch this registration
924
- # @param registration_id id for this registration
925
- # @param launch_link_request
926
- # @param [Hash] opts the optional parameters
927
- # @return [Array<(LaunchLinkSchema, Fixnum, Hash)>] LaunchLinkSchema data, response status code and response headers
928
- def get_registration_launch_link_with_http_info(registration_id, launch_link_request, opts = {})
929
- if @api_client.config.debugging
930
- @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_launch_link ...'
931
- end
932
- # verify the required parameter 'registration_id' is set
933
- if @api_client.config.client_side_validation && registration_id.nil?
934
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_launch_link"
935
- end
936
- # verify the required parameter 'launch_link_request' is set
937
- if @api_client.config.client_side_validation && launch_link_request.nil?
938
- fail ArgumentError, "Missing the required parameter 'launch_link_request' when calling RegistrationApi.get_registration_launch_link"
939
- end
940
- # resource path
941
- local_var_path = '/registrations/{registrationId}/launchLink'.sub('{' + 'registrationId' + '}', registration_id.to_s)
942
-
943
- # query parameters
944
- query_params = {}
945
-
946
- # header parameters
947
- header_params = {}
948
- # HTTP header 'Accept' (if needed)
949
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
950
- # HTTP header 'Content-Type'
951
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
952
-
953
- # form parameters
954
- form_params = {}
955
-
956
- # http body (model)
957
- post_body = @api_client.object_to_http_body(launch_link_request)
958
- auth_names = ['APP_NORMAL', 'OAUTH']
959
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
960
- :header_params => header_params,
961
- :query_params => query_params,
962
- :form_params => form_params,
963
- :body => post_body,
964
- :auth_names => auth_names,
965
- :return_type => 'LaunchLinkSchema')
966
- if @api_client.config.debugging
967
- @api_client.config.logger.debug "API called: RegistrationApi#get_registration_launch_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
968
- end
969
- return data, status_code, headers
970
- end
971
- # Get registration progress for `registrationId`
972
- # @param registration_id id for this registration
1095
+ # Get detailed information about a Registration
1096
+ # Returns detailed information about the registration. This includes completion status, time taken, score, and pass/fail status. >**Info:** >If you find yourself making multiple calls to this endpoint, it may be worthwhile to utilize our [postback mechanism](https://cloud.scorm.com/docs/v2/guides/postback/) instead. The main premise is that you would set up an endpoint on your end, and when we detect a change to the registration progress: completion status, time taken, score, or pass/fail status, we would send a message to your system with the registration progress.
1097
+ # @param registration_id
973
1098
  # @param [Hash] opts the optional parameters
974
1099
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results (default to false)
975
1100
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results (default to false)
@@ -980,8 +1105,9 @@ module RusticiSoftwareCloudV2
980
1105
  data
981
1106
  end
982
1107
 
983
- # Get registration progress for &#x60;registrationId&#x60;
984
- # @param registration_id id for this registration
1108
+ # Get detailed information about a Registration
1109
+ # Returns detailed information about the registration. This includes completion status, time taken, score, and pass/fail status. &gt;**Info:** &gt;If you find yourself making multiple calls to this endpoint, it may be worthwhile to utilize our [postback mechanism](https://cloud.scorm.com/docs/v2/guides/postback/) instead. The main premise is that you would set up an endpoint on your end, and when we detect a change to the registration progress: completion status, time taken, score, or pass/fail status, we would send a message to your system with the registration progress.
1110
+ # @param registration_id
985
1111
  # @param [Hash] opts the optional parameters
986
1112
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results
987
1113
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results
@@ -992,7 +1118,7 @@ module RusticiSoftwareCloudV2
992
1118
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_progress ...'
993
1119
  end
994
1120
  # verify the required parameter 'registration_id' is set
995
- if @api_client.config.client_side_validation && registration_id.nil?
1121
+ if registration_id.nil?
996
1122
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_progress"
997
1123
  end
998
1124
  # resource path
@@ -1029,31 +1155,33 @@ module RusticiSoftwareCloudV2
1029
1155
  end
1030
1156
  return data, status_code, headers
1031
1157
  end
1032
- # Get xAPI statements for `registrationId`
1033
- # @param registration_id id for this registration
1158
+ # Get xAPI statements for a Registration
1159
+ # Returns xAPI statements for the registration.
1160
+ # @param registration_id
1034
1161
  # @param [Hash] opts the optional parameters
1035
- # @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1036
- # @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1037
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
1162
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1163
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1164
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
1038
1165
  # @return [XapiStatementResult]
1039
1166
  def get_registration_statements(registration_id, opts = {})
1040
1167
  data, _status_code, _headers = get_registration_statements_with_http_info(registration_id, opts)
1041
1168
  data
1042
1169
  end
1043
1170
 
1044
- # Get xAPI statements for &#x60;registrationId&#x60;
1045
- # @param registration_id id for this registration
1171
+ # Get xAPI statements for a Registration
1172
+ # Returns xAPI statements for the registration.
1173
+ # @param registration_id
1046
1174
  # @param [Hash] opts the optional parameters
1047
- # @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1048
- # @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1049
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
1175
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1176
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1177
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
1050
1178
  # @return [Array<(XapiStatementResult, Fixnum, Hash)>] XapiStatementResult data, response status code and response headers
1051
1179
  def get_registration_statements_with_http_info(registration_id, opts = {})
1052
1180
  if @api_client.config.debugging
1053
1181
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_statements ...'
1054
1182
  end
1055
1183
  # verify the required parameter 'registration_id' is set
1056
- if @api_client.config.client_side_validation && registration_id.nil?
1184
+ if registration_id.nil?
1057
1185
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_statements"
1058
1186
  end
1059
1187
  # resource path
@@ -1090,8 +1218,9 @@ module RusticiSoftwareCloudV2
1090
1218
  end
1091
1219
  return data, status_code, headers
1092
1220
  end
1093
- # Get the tags for this registration
1094
- # @param registration_id id for this registration
1221
+ # Get tags for a Registration
1222
+ # Returns the tags for the registration.
1223
+ # @param registration_id
1095
1224
  # @param [Hash] opts the optional parameters
1096
1225
  # @return [TagListSchema]
1097
1226
  def get_registration_tags(registration_id, opts = {})
@@ -1099,8 +1228,9 @@ module RusticiSoftwareCloudV2
1099
1228
  data
1100
1229
  end
1101
1230
 
1102
- # Get the tags for this registration
1103
- # @param registration_id id for this registration
1231
+ # Get tags for a Registration
1232
+ # Returns the tags for the registration.
1233
+ # @param registration_id
1104
1234
  # @param [Hash] opts the optional parameters
1105
1235
  # @return [Array<(TagListSchema, Fixnum, Hash)>] TagListSchema data, response status code and response headers
1106
1236
  def get_registration_tags_with_http_info(registration_id, opts = {})
@@ -1108,7 +1238,7 @@ module RusticiSoftwareCloudV2
1108
1238
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_tags ...'
1109
1239
  end
1110
1240
  # verify the required parameter 'registration_id' is set
1111
- if @api_client.config.client_side_validation && registration_id.nil?
1241
+ if registration_id.nil?
1112
1242
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_tags"
1113
1243
  end
1114
1244
  # resource path
@@ -1142,13 +1272,19 @@ module RusticiSoftwareCloudV2
1142
1272
  end
1143
1273
  return data, status_code, headers
1144
1274
  end
1145
- # Gets a list of registrations including a summary of the status of each registration.
1275
+ # Get a list of Registrations
1276
+ # Returns a list of registrations. Can be filtered using the request parameters to provide a subset of results. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request. >**Info:** >If you find yourself making multiple calls to this endpoint, it may be worthwhile to utilize our [postback mechanism](https://cloud.scorm.com/docs/v2/guides/postback/) instead. The main premise is that you would set up an endpoint on your end, and when we detect a change to the registration progress: completion status, time taken, score, or pass/fail status, we would send a message to your system with the registration progress.
1146
1277
  # @param [Hash] opts the optional parameters
1147
- # @option opts [String] :course_id Only registrations for the specified course id will be included.
1148
- # @option opts [String] :learner_id Only registrations for the specified learner id will be included.
1149
- # @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1150
- # @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1151
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
1278
+ # @option opts [String] :course_id Only retrieve resources having &#x60;courseId&#x60;
1279
+ # @option opts [String] :learner_id Only retrieve resources having &#x60;learnerId&#x60;
1280
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1281
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1282
+ # @option opts [String] :datetime_filter Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against (default to created)
1283
+ # @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
1284
+ # @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
1285
+ # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to registration_id)
1286
+ # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to created_desc)
1287
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
1152
1288
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results (default to false)
1153
1289
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results (default to false)
1154
1290
  # @option opts [BOOLEAN] :include_runtime Include runtime details in the results (default to false)
@@ -1158,13 +1294,19 @@ module RusticiSoftwareCloudV2
1158
1294
  data
1159
1295
  end
1160
1296
 
1161
- # Gets a list of registrations including a summary of the status of each registration.
1297
+ # Get a list of Registrations
1298
+ # Returns a list of registrations. Can be filtered using the request parameters to provide a subset of results. &gt;**Note:** &gt;This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a &#x60;more&#x60; token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request. &gt;**Info:** &gt;If you find yourself making multiple calls to this endpoint, it may be worthwhile to utilize our [postback mechanism](https://cloud.scorm.com/docs/v2/guides/postback/) instead. The main premise is that you would set up an endpoint on your end, and when we detect a change to the registration progress: completion status, time taken, score, or pass/fail status, we would send a message to your system with the registration progress.
1162
1299
  # @param [Hash] opts the optional parameters
1163
- # @option opts [String] :course_id Only registrations for the specified course id will be included.
1164
- # @option opts [String] :learner_id Only registrations for the specified learner id will be included.
1165
- # @option opts [DateTime] :since Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1166
- # @option opts [DateTime] :_until Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.
1167
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
1300
+ # @option opts [String] :course_id Only retrieve resources having &#x60;courseId&#x60;
1301
+ # @option opts [String] :learner_id Only retrieve resources having &#x60;learnerId&#x60;
1302
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1303
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1304
+ # @option opts [String] :datetime_filter Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against
1305
+ # @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
1306
+ # @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
1307
+ # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
1308
+ # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
1309
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
1168
1310
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results
1169
1311
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results
1170
1312
  # @option opts [BOOLEAN] :include_runtime Include runtime details in the results
@@ -1182,6 +1324,11 @@ module RusticiSoftwareCloudV2
1182
1324
  query_params[:'learnerId'] = opts[:'learner_id'] if !opts[:'learner_id'].nil?
1183
1325
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1184
1326
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
1327
+ query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
1328
+ query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
1329
+ query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
1330
+ query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
1331
+ query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
1185
1332
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
1186
1333
  query_params[:'includeChildResults'] = opts[:'include_child_results'] if !opts[:'include_child_results'].nil?
1187
1334
  query_params[:'includeInteractionsAndObjectives'] = opts[:'include_interactions_and_objectives'] if !opts[:'include_interactions_and_objectives'].nil?
@@ -1212,8 +1359,9 @@ module RusticiSoftwareCloudV2
1212
1359
  end
1213
1360
  return data, status_code, headers
1214
1361
  end
1215
- # Set the tags for this registration
1216
- # @param registration_id id for this registration
1362
+ # Add tags to a Registration
1363
+ # Applies the provided tags to the registration. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetRegistrations).
1364
+ # @param registration_id
1217
1365
  # @param tags
1218
1366
  # @param [Hash] opts the optional parameters
1219
1367
  # @return [nil]
@@ -1222,8 +1370,9 @@ module RusticiSoftwareCloudV2
1222
1370
  nil
1223
1371
  end
1224
1372
 
1225
- # Set the tags for this registration
1226
- # @param registration_id id for this registration
1373
+ # Add tags to a Registration
1374
+ # Applies the provided tags to the registration. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetRegistrations).
1375
+ # @param registration_id
1227
1376
  # @param tags
1228
1377
  # @param [Hash] opts the optional parameters
1229
1378
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -1232,11 +1381,11 @@ module RusticiSoftwareCloudV2
1232
1381
  @api_client.config.logger.debug 'Calling API: RegistrationApi.put_registration_tags ...'
1233
1382
  end
1234
1383
  # verify the required parameter 'registration_id' is set
1235
- if @api_client.config.client_side_validation && registration_id.nil?
1384
+ if registration_id.nil?
1236
1385
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.put_registration_tags"
1237
1386
  end
1238
1387
  # verify the required parameter 'tags' is set
1239
- if @api_client.config.client_side_validation && tags.nil?
1388
+ if tags.nil?
1240
1389
  fail ArgumentError, "Missing the required parameter 'tags' when calling RegistrationApi.put_registration_tags"
1241
1390
  end
1242
1391
  # resource path
@@ -1269,8 +1418,9 @@ module RusticiSoftwareCloudV2
1269
1418
  end
1270
1419
  return data, status_code, headers
1271
1420
  end
1272
- # Sets all of the provided tags on all of the provided registrations
1273
- # @param batch
1421
+ # Add a group of tags to a group of Registrations
1422
+ # Applies all of the provided tags on all of the provided registrations. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetRegistrations).
1423
+ # @param batch Array of ids, and array of tags for bulk tag operations
1274
1424
  # @param [Hash] opts the optional parameters
1275
1425
  # @return [nil]
1276
1426
  def put_registration_tags_batch(batch, opts = {})
@@ -1278,8 +1428,9 @@ module RusticiSoftwareCloudV2
1278
1428
  nil
1279
1429
  end
1280
1430
 
1281
- # Sets all of the provided tags on all of the provided registrations
1282
- # @param batch
1431
+ # Add a group of tags to a group of Registrations
1432
+ # Applies all of the provided tags on all of the provided registrations. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetRegistrations).
1433
+ # @param batch Array of ids, and array of tags for bulk tag operations
1283
1434
  # @param [Hash] opts the optional parameters
1284
1435
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1285
1436
  def put_registration_tags_batch_with_http_info(batch, opts = {})
@@ -1287,7 +1438,7 @@ module RusticiSoftwareCloudV2
1287
1438
  @api_client.config.logger.debug 'Calling API: RegistrationApi.put_registration_tags_batch ...'
1288
1439
  end
1289
1440
  # verify the required parameter 'batch' is set
1290
- if @api_client.config.client_side_validation && batch.nil?
1441
+ if batch.nil?
1291
1442
  fail ArgumentError, "Missing the required parameter 'batch' when calling RegistrationApi.put_registration_tags_batch"
1292
1443
  end
1293
1444
  # resource path
@@ -1320,29 +1471,37 @@ module RusticiSoftwareCloudV2
1320
1471
  end
1321
1472
  return data, status_code, headers
1322
1473
  end
1323
- # Does this registration exist?
1324
- # @param registration_id id for this registration
1474
+ # Update configuration settings for a Registration
1475
+ # Updates configuration settings at the registration level. This will explicitly set a value at the registration level and override any settings from a higher level. Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
1476
+ # @param registration_id
1477
+ # @param configuration_settings
1325
1478
  # @param [Hash] opts the optional parameters
1326
1479
  # @return [nil]
1327
- def registration_exists(registration_id, opts = {})
1328
- registration_exists_with_http_info(registration_id, opts)
1480
+ def set_registration_configuration(registration_id, configuration_settings, opts = {})
1481
+ set_registration_configuration_with_http_info(registration_id, configuration_settings, opts)
1329
1482
  nil
1330
1483
  end
1331
1484
 
1332
- # Does this registration exist?
1333
- # @param registration_id id for this registration
1485
+ # Update configuration settings for a Registration
1486
+ # Updates configuration settings at the registration level. This will explicitly set a value at the registration level and override any settings from a higher level. Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
1487
+ # @param registration_id
1488
+ # @param configuration_settings
1334
1489
  # @param [Hash] opts the optional parameters
1335
1490
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1336
- def registration_exists_with_http_info(registration_id, opts = {})
1491
+ def set_registration_configuration_with_http_info(registration_id, configuration_settings, opts = {})
1337
1492
  if @api_client.config.debugging
1338
- @api_client.config.logger.debug 'Calling API: RegistrationApi.registration_exists ...'
1493
+ @api_client.config.logger.debug 'Calling API: RegistrationApi.set_registration_configuration ...'
1339
1494
  end
1340
1495
  # verify the required parameter 'registration_id' is set
1341
- if @api_client.config.client_side_validation && registration_id.nil?
1342
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.registration_exists"
1496
+ if registration_id.nil?
1497
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.set_registration_configuration"
1498
+ end
1499
+ # verify the required parameter 'configuration_settings' is set
1500
+ if configuration_settings.nil?
1501
+ fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling RegistrationApi.set_registration_configuration"
1343
1502
  end
1344
1503
  # resource path
1345
- local_var_path = '/registrations/{registrationId}'.sub('{' + 'registrationId' + '}', registration_id.to_s)
1504
+ local_var_path = '/registrations/{registrationId}/configuration'.sub('{' + 'registrationId' + '}', registration_id.to_s)
1346
1505
 
1347
1506
  # query parameters
1348
1507
  query_params = {}
@@ -1358,48 +1517,56 @@ module RusticiSoftwareCloudV2
1358
1517
  form_params = {}
1359
1518
 
1360
1519
  # http body (model)
1361
- post_body = nil
1520
+ post_body = @api_client.object_to_http_body(configuration_settings)
1362
1521
  auth_names = ['APP_NORMAL', 'OAUTH']
1363
- data, status_code, headers = @api_client.call_api(:HEAD, local_var_path,
1522
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1364
1523
  :header_params => header_params,
1365
1524
  :query_params => query_params,
1366
1525
  :form_params => form_params,
1367
1526
  :body => post_body,
1368
1527
  :auth_names => auth_names)
1369
1528
  if @api_client.config.debugging
1370
- @api_client.config.logger.debug "API called: RegistrationApi#registration_exists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1529
+ @api_client.config.logger.debug "API called: RegistrationApi#set_registration_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1371
1530
  end
1372
1531
  return data, status_code, headers
1373
1532
  end
1374
- # Set configuration settings for this registration.
1375
- # @param registration_id id for this registration
1533
+ # Update configuration settings for a Registration Instance
1534
+ # Updates configuration settings at the registration level. This will explicitly set a value at the registration level and override any settings from a higher level. Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
1535
+ # @param registration_id
1536
+ # @param instance_id
1376
1537
  # @param configuration_settings
1377
1538
  # @param [Hash] opts the optional parameters
1378
1539
  # @return [nil]
1379
- def set_registration_configuration(registration_id, configuration_settings, opts = {})
1380
- set_registration_configuration_with_http_info(registration_id, configuration_settings, opts)
1540
+ def set_registration_instance_configuration(registration_id, instance_id, configuration_settings, opts = {})
1541
+ set_registration_instance_configuration_with_http_info(registration_id, instance_id, configuration_settings, opts)
1381
1542
  nil
1382
1543
  end
1383
1544
 
1384
- # Set configuration settings for this registration.
1385
- # @param registration_id id for this registration
1545
+ # Update configuration settings for a Registration Instance
1546
+ # Updates configuration settings at the registration level. This will explicitly set a value at the registration level and override any settings from a higher level. Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
1547
+ # @param registration_id
1548
+ # @param instance_id
1386
1549
  # @param configuration_settings
1387
1550
  # @param [Hash] opts the optional parameters
1388
1551
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1389
- def set_registration_configuration_with_http_info(registration_id, configuration_settings, opts = {})
1552
+ def set_registration_instance_configuration_with_http_info(registration_id, instance_id, configuration_settings, opts = {})
1390
1553
  if @api_client.config.debugging
1391
- @api_client.config.logger.debug 'Calling API: RegistrationApi.set_registration_configuration ...'
1554
+ @api_client.config.logger.debug 'Calling API: RegistrationApi.set_registration_instance_configuration ...'
1392
1555
  end
1393
1556
  # verify the required parameter 'registration_id' is set
1394
- if @api_client.config.client_side_validation && registration_id.nil?
1395
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.set_registration_configuration"
1557
+ if registration_id.nil?
1558
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.set_registration_instance_configuration"
1559
+ end
1560
+ # verify the required parameter 'instance_id' is set
1561
+ if instance_id.nil?
1562
+ fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.set_registration_instance_configuration"
1396
1563
  end
1397
1564
  # verify the required parameter 'configuration_settings' is set
1398
- if @api_client.config.client_side_validation && configuration_settings.nil?
1399
- fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling RegistrationApi.set_registration_configuration"
1565
+ if configuration_settings.nil?
1566
+ fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling RegistrationApi.set_registration_instance_configuration"
1400
1567
  end
1401
1568
  # resource path
1402
- local_var_path = '/registrations/{registrationId}/configuration'.sub('{' + 'registrationId' + '}', registration_id.to_s)
1569
+ local_var_path = '/registrations/{registrationId}/instances/{instanceId}/configuration'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
1403
1570
 
1404
1571
  # query parameters
1405
1572
  query_params = {}
@@ -1424,49 +1591,35 @@ module RusticiSoftwareCloudV2
1424
1591
  :body => post_body,
1425
1592
  :auth_names => auth_names)
1426
1593
  if @api_client.config.debugging
1427
- @api_client.config.logger.debug "API called: RegistrationApi#set_registration_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1594
+ @api_client.config.logger.debug "API called: RegistrationApi#set_registration_instance_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1428
1595
  end
1429
1596
  return data, status_code, headers
1430
1597
  end
1431
- # Set configuration settings for this registration instance.
1432
- # @param registration_id id for this registration
1433
- # @param instance_id The instance of this registration
1434
- # @param configuration_settings
1598
+ # Send a test postback with the provided configuration
1599
+ # Sends a postback with dummy data to the url specified. The postback will use additional information from the configuration provided with the request (e.g. a provided username/password will be sent along with the postback to allow for logging in to a secure page. The format of the data sent will differ depending on whether `httpbasic` or `form` is passed for `authType`. - With httpbasic, an authorization header will be sent with the base64 encoded credentials. The body will be JSON formatted data. - With form, the username and password will be sent in the body of the request along with the data. The whole body will be url encoded. >**Note:** >The data that will be sent to the provided url is the same format as the output of the GetRegistrationProgress endpoint.
1600
+ # @param post_back
1435
1601
  # @param [Hash] opts the optional parameters
1436
1602
  # @return [nil]
1437
- def set_registration_instance_configuration(registration_id, instance_id, configuration_settings, opts = {})
1438
- set_registration_instance_configuration_with_http_info(registration_id, instance_id, configuration_settings, opts)
1603
+ def test_registration_postback(post_back, opts = {})
1604
+ test_registration_postback_with_http_info(post_back, opts)
1439
1605
  nil
1440
1606
  end
1441
1607
 
1442
- # Set configuration settings for this registration instance.
1443
- # @param registration_id id for this registration
1444
- # @param instance_id The instance of this registration
1445
- # @param configuration_settings
1608
+ # Send a test postback with the provided configuration
1609
+ # Sends a postback with dummy data to the url specified. The postback will use additional information from the configuration provided with the request (e.g. a provided username/password will be sent along with the postback to allow for logging in to a secure page. The format of the data sent will differ depending on whether &#x60;httpbasic&#x60; or &#x60;form&#x60; is passed for &#x60;authType&#x60;. - With httpbasic, an authorization header will be sent with the base64 encoded credentials. The body will be JSON formatted data. - With form, the username and password will be sent in the body of the request along with the data. The whole body will be url encoded. &gt;**Note:** &gt;The data that will be sent to the provided url is the same format as the output of the GetRegistrationProgress endpoint.
1610
+ # @param post_back
1446
1611
  # @param [Hash] opts the optional parameters
1447
1612
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1448
- def set_registration_instance_configuration_with_http_info(registration_id, instance_id, configuration_settings, opts = {})
1613
+ def test_registration_postback_with_http_info(post_back, opts = {})
1449
1614
  if @api_client.config.debugging
1450
- @api_client.config.logger.debug 'Calling API: RegistrationApi.set_registration_instance_configuration ...'
1451
- end
1452
- # verify the required parameter 'registration_id' is set
1453
- if @api_client.config.client_side_validation && registration_id.nil?
1454
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.set_registration_instance_configuration"
1455
- end
1456
- # verify the required parameter 'instance_id' is set
1457
- if @api_client.config.client_side_validation && instance_id.nil?
1458
- fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.set_registration_instance_configuration"
1615
+ @api_client.config.logger.debug 'Calling API: RegistrationApi.test_registration_postback ...'
1459
1616
  end
1460
- if @api_client.config.client_side_validation && instance_id < 0
1461
- fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.set_registration_instance_configuration, must be greater than or equal to 0.'
1462
- end
1463
-
1464
- # verify the required parameter 'configuration_settings' is set
1465
- if @api_client.config.client_side_validation && configuration_settings.nil?
1466
- fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling RegistrationApi.set_registration_instance_configuration"
1617
+ # verify the required parameter 'post_back' is set
1618
+ if post_back.nil?
1619
+ fail ArgumentError, "Missing the required parameter 'post_back' when calling RegistrationApi.test_registration_postback"
1467
1620
  end
1468
1621
  # resource path
1469
- local_var_path = '/registrations/{registrationId}/instances/{instanceId}/configuration'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
1622
+ local_var_path = '/registrations/postBackTest'
1470
1623
 
1471
1624
  # query parameters
1472
1625
  query_params = {}
@@ -1482,7 +1635,7 @@ module RusticiSoftwareCloudV2
1482
1635
  form_params = {}
1483
1636
 
1484
1637
  # http body (model)
1485
- post_body = @api_client.object_to_http_body(configuration_settings)
1638
+ post_body = @api_client.object_to_http_body(post_back)
1486
1639
  auth_names = ['APP_NORMAL', 'OAUTH']
1487
1640
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1488
1641
  :header_params => header_params,
@@ -1491,7 +1644,7 @@ module RusticiSoftwareCloudV2
1491
1644
  :body => post_body,
1492
1645
  :auth_names => auth_names)
1493
1646
  if @api_client.config.debugging
1494
- @api_client.config.logger.debug "API called: RegistrationApi#set_registration_instance_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1647
+ @api_client.config.logger.debug "API called: RegistrationApi#test_registration_postback\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1495
1648
  end
1496
1649
  return data, status_code, headers
1497
1650
  end