rustici_software_cloud_v2 1.0.0beta → 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (268) hide show
  1. checksums.yaml +7 -0
  2. data/README.md +194 -88
  3. data/lib/rustici_software_cloud_v2/api/about_api.rb +71 -0
  4. data/lib/rustici_software_cloud_v2/api/application_management_api.rb +161 -97
  5. data/lib/rustici_software_cloud_v2/api/authentication_api.rb +13 -13
  6. data/lib/rustici_software_cloud_v2/api/course_api.rb +246 -260
  7. data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +1994 -0
  8. data/lib/rustici_software_cloud_v2/api/invitations_api.rb +964 -0
  9. data/lib/rustici_software_cloud_v2/api/learner_api.rb +296 -0
  10. data/lib/rustici_software_cloud_v2/api/ping_api.rb +10 -8
  11. data/lib/rustici_software_cloud_v2/api/registration_api.rb +379 -324
  12. data/lib/rustici_software_cloud_v2/api/reporting_api.rb +191 -0
  13. data/lib/rustici_software_cloud_v2/api/xapi_api.rb +555 -0
  14. data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +448 -0
  15. data/lib/rustici_software_cloud_v2/api_client.rb +2 -3
  16. data/lib/rustici_software_cloud_v2/api_error.rb +1 -2
  17. data/lib/rustici_software_cloud_v2/configuration.rb +9 -19
  18. data/lib/rustici_software_cloud_v2/models/about_schema.rb +196 -0
  19. data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +17 -14
  20. data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +12 -8
  21. data/lib/rustici_software_cloud_v2/models/application_schema.rb +12 -8
  22. data/lib/rustici_software_cloud_v2/models/application_token.rb +12 -8
  23. data/lib/rustici_software_cloud_v2/models/{course_tags_batch_schema.rb → batch_tags_schema.rb} +29 -23
  24. data/lib/rustici_software_cloud_v2/models/comment_schema.rb +12 -8
  25. data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +12 -8
  26. data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +14 -11
  27. data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +12 -8
  28. data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +12 -8
  29. data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +11 -8
  30. data/lib/rustici_software_cloud_v2/models/course_schema.rb +14 -11
  31. data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +225 -0
  32. data/lib/rustici_software_cloud_v2/models/{link_schema.rb → create_dispatch_list_schema.rb} +22 -21
  33. data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +308 -0
  34. data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +254 -0
  35. data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +252 -0
  36. data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +15 -11
  37. data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +12 -8
  38. data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +12 -8
  39. data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +12 -8
  40. data/lib/rustici_software_cloud_v2/models/credential_schema.rb +12 -8
  41. data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +197 -0
  42. data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +200 -0
  43. data/lib/rustici_software_cloud_v2/models/{setting_metadata_valid_values.rb → destination_schema.rb} +42 -31
  44. data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +196 -0
  45. data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +198 -0
  46. data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +196 -0
  47. data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +290 -0
  48. data/lib/rustici_software_cloud_v2/models/{tag_post_schema.rb → enabled_schema.rb} +24 -11
  49. data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +12 -9
  50. data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +14 -11
  51. data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +12 -8
  52. data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +13 -9
  53. data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +215 -0
  54. data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +253 -0
  55. data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +199 -0
  56. data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +227 -0
  57. data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +12 -8
  58. data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +12 -8
  59. data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +19 -16
  60. data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +17 -8
  61. data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +13 -9
  62. data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +12 -8
  63. data/lib/rustici_software_cloud_v2/models/learner_schema.rb +13 -9
  64. data/lib/rustici_software_cloud_v2/models/message_schema.rb +13 -9
  65. data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +12 -8
  66. data/lib/rustici_software_cloud_v2/models/objective_schema.rb +23 -20
  67. data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +12 -8
  68. data/lib/rustici_software_cloud_v2/models/ping_schema.rb +28 -20
  69. data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +33 -20
  70. data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +199 -0
  71. data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +266 -0
  72. data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +199 -0
  73. data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +289 -0
  74. data/lib/rustici_software_cloud_v2/models/registration_completion.rb +5 -14
  75. data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +13 -9
  76. data/lib/rustici_software_cloud_v2/models/registration_schema.rb +24 -9
  77. data/lib/rustici_software_cloud_v2/models/registration_success.rb +5 -14
  78. data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +259 -0
  79. data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +214 -0
  80. data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +196 -0
  81. data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +187 -0
  82. data/lib/rustici_software_cloud_v2/models/response_error.rb +13 -9
  83. data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +14 -11
  84. data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +19 -16
  85. data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +15 -12
  86. data/lib/rustici_software_cloud_v2/models/score_schema.rb +12 -8
  87. data/lib/rustici_software_cloud_v2/models/setting_item.rb +14 -11
  88. data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +13 -9
  89. data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +15 -12
  90. data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +12 -8
  91. data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +12 -8
  92. data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +12 -8
  93. data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +12 -8
  94. data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +12 -8
  95. data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +13 -9
  96. data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +12 -8
  97. data/lib/rustici_software_cloud_v2/models/title_schema.rb +12 -8
  98. data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +14 -10
  99. data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +258 -0
  100. data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +199 -0
  101. data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +236 -0
  102. data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +214 -0
  103. data/lib/rustici_software_cloud_v2/models/xapi_account.rb +13 -10
  104. data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +13 -10
  105. data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +14 -11
  106. data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +14 -12
  107. data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +18 -15
  108. data/lib/rustici_software_cloud_v2/models/xapi_context.rb +12 -9
  109. data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +11 -8
  110. data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +220 -0
  111. data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +220 -0
  112. data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +252 -0
  113. data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +266 -0
  114. data/lib/rustici_software_cloud_v2/models/{registration_tags_batch_schema.rb → xapi_credentials_list_schema.rb} +30 -31
  115. data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +205 -0
  116. data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +13 -10
  117. data/lib/rustici_software_cloud_v2/models/xapi_result.rb +12 -9
  118. data/lib/rustici_software_cloud_v2/models/xapi_score.rb +11 -8
  119. data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +11 -8
  120. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +194 -0
  121. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +196 -0
  122. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +241 -0
  123. data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +14 -11
  124. data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +12 -9
  125. data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +13 -10
  126. data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +187 -0
  127. data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +196 -0
  128. data/lib/rustici_software_cloud_v2/version.rb +2 -3
  129. data/lib/rustici_software_cloud_v2.rb +50 -6
  130. data/rustici_software_cloud_v2.gemspec +10 -11
  131. data/spec/api_client_spec.rb +1 -13
  132. data/spec/configuration_spec.rb +9 -10
  133. data/spec/spec_helper.rb +1 -13
  134. metadata +107 -271
  135. data/docs/ActivityResultSchema.md +0 -20
  136. data/docs/ApplicationListSchema.md +0 -8
  137. data/docs/ApplicationManagementApi.md +0 -570
  138. data/docs/ApplicationSchema.md +0 -9
  139. data/docs/ApplicationToken.md +0 -10
  140. data/docs/AuthenticationApi.md +0 -64
  141. data/docs/CommentSchema.md +0 -10
  142. data/docs/CompletionAmountSchema.md +0 -8
  143. data/docs/CourseActivitySchema.md +0 -15
  144. data/docs/CourseApi.md +0 -1459
  145. data/docs/CourseListNonPagedSchema.md +0 -8
  146. data/docs/CourseListSchema.md +0 -9
  147. data/docs/CourseReferenceSchema.md +0 -10
  148. data/docs/CourseSchema.md +0 -20
  149. data/docs/CourseTagsBatchSchema.md +0 -9
  150. data/docs/CreateRegistrationSchema.md +0 -17
  151. data/docs/CredentialCreatedSchema.md +0 -12
  152. data/docs/CredentialListSchema.md +0 -8
  153. data/docs/CredentialRequestSchema.md +0 -9
  154. data/docs/CredentialSchema.md +0 -12
  155. data/docs/ImportFetchRequestSchema.md +0 -8
  156. data/docs/ImportJobResultSchema.md +0 -11
  157. data/docs/ImportResultSchema.md +0 -11
  158. data/docs/IntegerResultSchema.md +0 -8
  159. data/docs/ItemValuePairSchema.md +0 -9
  160. data/docs/LaunchHistoryListSchema.md +0 -8
  161. data/docs/LaunchHistorySchema.md +0 -17
  162. data/docs/LaunchLinkRequestSchema.md +0 -17
  163. data/docs/LaunchLinkSchema.md +0 -8
  164. data/docs/LearnerPreferenceSchema.md +0 -11
  165. data/docs/LearnerSchema.md +0 -11
  166. data/docs/LinkSchema.md +0 -8
  167. data/docs/MessageSchema.md +0 -8
  168. data/docs/MetadataSchema.md +0 -14
  169. data/docs/ObjectiveSchema.md +0 -20
  170. data/docs/PermissionsSchema.md +0 -9
  171. data/docs/PingApi.md +0 -57
  172. data/docs/PingSchema.md +0 -8
  173. data/docs/PostBackSchema.md +0 -12
  174. data/docs/RegistrationApi.md +0 -1490
  175. data/docs/RegistrationCompletion.md +0 -7
  176. data/docs/RegistrationListSchema.md +0 -9
  177. data/docs/RegistrationSchema.md +0 -27
  178. data/docs/RegistrationSuccess.md +0 -7
  179. data/docs/RegistrationTagsBatchSchema.md +0 -9
  180. data/docs/ResponseError.md +0 -8
  181. data/docs/RuntimeInteractionSchema.md +0 -18
  182. data/docs/RuntimeObjectiveSchema.md +0 -16
  183. data/docs/RuntimeSchema.md +0 -27
  184. data/docs/ScoreSchema.md +0 -8
  185. data/docs/SettingItem.md +0 -12
  186. data/docs/SettingListSchema.md +0 -8
  187. data/docs/SettingMetadata.md +0 -15
  188. data/docs/SettingMetadataValidValues.md +0 -9
  189. data/docs/SettingValidValue.md +0 -9
  190. data/docs/SettingsIndividualSchema.md +0 -10
  191. data/docs/SettingsPostSchema.md +0 -8
  192. data/docs/SharedDataEntrySchema.md +0 -9
  193. data/docs/StaticPropertiesSchema.md +0 -13
  194. data/docs/StringResultSchema.md +0 -8
  195. data/docs/TagListSchema.md +0 -8
  196. data/docs/TagPostSchema.md +0 -7
  197. data/docs/TitleSchema.md +0 -8
  198. data/docs/TokenRequestSchema.md +0 -9
  199. data/docs/XapiAccount.md +0 -9
  200. data/docs/XapiActivity.md +0 -10
  201. data/docs/XapiActivityDefinition.md +0 -19
  202. data/docs/XapiAgentGroup.md +0 -14
  203. data/docs/XapiAttachment.md +0 -14
  204. data/docs/XapiContext.md +0 -16
  205. data/docs/XapiContextActivity.md +0 -11
  206. data/docs/XapiInteractionComponent.md +0 -9
  207. data/docs/XapiResult.md +0 -13
  208. data/docs/XapiScore.md +0 -11
  209. data/docs/XapiStatement.md +0 -20
  210. data/docs/XapiStatementReference.md +0 -9
  211. data/docs/XapiStatementResult.md +0 -9
  212. data/docs/XapiVerb.md +0 -9
  213. data/git_push.sh +0 -55
  214. data/spec/models/activity_result_schema_spec.rb +0 -133
  215. data/spec/models/application_list_schema_spec.rb +0 -53
  216. data/spec/models/application_schema_spec.rb +0 -59
  217. data/spec/models/application_token_spec.rb +0 -65
  218. data/spec/models/comment_schema_spec.rb +0 -65
  219. data/spec/models/completion_amount_schema_spec.rb +0 -53
  220. data/spec/models/course_activity_schema_spec.rb +0 -99
  221. data/spec/models/course_list_non_paged_schema_spec.rb +0 -53
  222. data/spec/models/course_list_schema_spec.rb +0 -59
  223. data/spec/models/course_reference_schema_spec.rb +0 -65
  224. data/spec/models/course_schema_spec.rb +0 -129
  225. data/spec/models/create_registration_schema_spec.rb +0 -107
  226. data/spec/models/credential_created_schema_spec.rb +0 -77
  227. data/spec/models/credential_list_schema_spec.rb +0 -53
  228. data/spec/models/credential_request_schema_spec.rb +0 -59
  229. data/spec/models/credential_schema_spec.rb +0 -77
  230. data/spec/models/import_fetch_request_schema_spec.rb +0 -53
  231. data/spec/models/import_job_result_schema_spec.rb +0 -75
  232. data/spec/models/import_result_schema_spec.rb +0 -71
  233. data/spec/models/integer_result_schema_spec.rb +0 -53
  234. data/spec/models/item_value_pair_schema_spec.rb +0 -59
  235. data/spec/models/launch_history_list_schema_spec.rb +0 -53
  236. data/spec/models/launch_history_schema_spec.rb +0 -115
  237. data/spec/models/launch_link_request_schema_spec.rb +0 -107
  238. data/spec/models/launch_link_schema_spec.rb +0 -53
  239. data/spec/models/learner_preference_schema_spec.rb +0 -71
  240. data/spec/models/learner_schema_spec.rb +0 -71
  241. data/spec/models/link_schema_spec.rb +0 -53
  242. data/spec/models/message_schema_spec.rb +0 -53
  243. data/spec/models/metadata_schema_spec.rb +0 -89
  244. data/spec/models/objective_schema_spec.rb +0 -137
  245. data/spec/models/permissions_schema_spec.rb +0 -59
  246. data/spec/models/ping_schema_spec.rb +0 -53
  247. data/spec/models/post_back_schema_spec.rb +0 -85
  248. data/spec/models/registration_completion_spec.rb +0 -47
  249. data/spec/models/registration_list_schema_spec.rb +0 -59
  250. data/spec/models/registration_schema_spec.rb +0 -167
  251. data/spec/models/registration_success_spec.rb +0 -47
  252. data/spec/models/response_error_spec.rb +0 -53
  253. data/spec/models/runtime_interaction_schema_spec.rb +0 -117
  254. data/spec/models/runtime_objective_schema_spec.rb +0 -109
  255. data/spec/models/runtime_schema_spec.rb +0 -171
  256. data/spec/models/score_schema_spec.rb +0 -53
  257. data/spec/models/setting_item_spec.rb +0 -81
  258. data/spec/models/setting_list_schema_spec.rb +0 -53
  259. data/spec/models/setting_metadata_spec.rb +0 -99
  260. data/spec/models/setting_metadata_valid_values_spec.rb +0 -59
  261. data/spec/models/settings_individual_schema_spec.rb +0 -65
  262. data/spec/models/settings_post_schema_spec.rb +0 -53
  263. data/spec/models/shared_data_entry_schema_spec.rb +0 -59
  264. data/spec/models/static_properties_schema_spec.rb +0 -83
  265. data/spec/models/string_result_schema_spec.rb +0 -53
  266. data/spec/models/title_schema_spec.rb +0 -53
  267. data/spec/models/token_request_schema_spec.rb +0 -59
  268. data/swagger-codegen.config +0 -11
@@ -3,14 +3,13 @@
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
10
9
 
11
10
  =end
12
11
 
13
- require 'uri'
12
+ require "uri"
14
13
 
15
14
  module RusticiSoftwareCloudV2
16
15
  class RegistrationApi
@@ -19,29 +18,87 @@ module RusticiSoftwareCloudV2
19
18
  def initialize(api_client = ApiClient.default)
20
19
  @api_client = api_client
21
20
  end
22
- # Create a new instance for this registration specified by the registration ID
21
+
22
+ # Get registration launch link.
23
+ # Returns the link to use to launch this registration.
24
+ # @param registration_id id for this registration
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
+ return data
31
+ end
32
+
33
+ # Get registration launch link.
34
+ # Returns the link to use to launch this registration.
35
+ # @param registration_id id for this registration
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
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.build_registration_launch_link" if registration_id.nil?
45
+ # verify the required parameter 'launch_link_request' is set
46
+ fail ArgumentError, "Missing the required parameter 'launch_link_request' when calling RegistrationApi.build_registration_launch_link" if launch_link_request.nil?
47
+ # resource path
48
+ local_var_path = "/registrations/{registrationId}/launchLink".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)
49
+
50
+ # query parameters
51
+ query_params = {}
52
+
53
+ # header parameters
54
+ header_params = {}
55
+ # HTTP header 'Accept' (if needed)
56
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
57
+ # HTTP header 'Content-Type'
58
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
59
+
60
+ # form parameters
61
+ form_params = {}
62
+
63
+ # http body (model)
64
+ post_body = @api_client.object_to_http_body(launch_link_request)
65
+ auth_names = ['APP_NORMAL', 'OAUTH']
66
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
67
+ :header_params => header_params,
68
+ :query_params => query_params,
69
+ :form_params => form_params,
70
+ :body => post_body,
71
+ :auth_names => auth_names,
72
+ :return_type => 'LaunchLinkSchema')
73
+ if @api_client.config.debugging
74
+ @api_client.config.logger.debug "API called: RegistrationApi#build_registration_launch_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
75
+ end
76
+ return data, status_code, headers
77
+ end
78
+
79
+ #
80
+ # Create a new instance for this registration specified by the registration ID.
23
81
  # @param registration_id id for this registration
24
82
  # @param [Hash] opts the optional parameters
25
83
  # @return [nil]
26
84
  def create_new_registration_instance(registration_id, opts = {})
27
85
  create_new_registration_instance_with_http_info(registration_id, opts)
28
- nil
86
+ return nil
29
87
  end
30
88
 
31
- # Create a new instance for this registration specified by the registration ID
89
+ #
90
+ # Create a new instance for this registration specified by the registration ID.
32
91
  # @param registration_id id for this registration
33
92
  # @param [Hash] opts the optional parameters
34
93
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
35
94
  def create_new_registration_instance_with_http_info(registration_id, opts = {})
36
95
  if @api_client.config.debugging
37
- @api_client.config.logger.debug 'Calling API: RegistrationApi.create_new_registration_instance ...'
96
+ @api_client.config.logger.debug "Calling API: RegistrationApi.create_new_registration_instance ..."
38
97
  end
39
98
  # verify the required parameter 'registration_id' is set
40
- if @api_client.config.client_side_validation && registration_id.nil?
41
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.create_new_registration_instance"
42
- end
99
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.create_new_registration_instance" if registration_id.nil?
43
100
  # resource path
44
- local_var_path = '/registrations/{registrationId}/instances'.sub('{' + 'registrationId' + '}', registration_id.to_s)
101
+ local_var_path = "/registrations/{registrationId}/instances".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)
45
102
 
46
103
  # query parameters
47
104
  query_params = {}
@@ -70,31 +127,32 @@ module RusticiSoftwareCloudV2
70
127
  end
71
128
  return data, status_code, headers
72
129
  end
73
- # Create a registration.
130
+
131
+ # Create a registration.
132
+ # This method is used to create a new registration. A registration will contain a few pieces of information such as a learner name, a learner id, and optionally, information about where activity data should be posted (for client consumption), as well as a way to specify simple authentication schemes for posting said data. 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
133
  # @param registration
75
134
  # @param [Hash] opts the optional parameters
76
135
  # @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.
77
136
  # @return [nil]
78
137
  def create_registration(registration, opts = {})
79
138
  create_registration_with_http_info(registration, opts)
80
- nil
139
+ return nil
81
140
  end
82
141
 
83
- # Create a registration.
142
+ # Create a registration.
143
+ # This method is used to create a new registration. A registration will contain a few pieces of information such as a learner name, a learner id, and optionally, information about where activity data should be posted (for client consumption), as well as a way to specify simple authentication schemes for posting said data. 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.
84
144
  # @param registration
85
145
  # @param [Hash] opts the optional parameters
86
146
  # @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.
87
147
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
88
148
  def create_registration_with_http_info(registration, opts = {})
89
149
  if @api_client.config.debugging
90
- @api_client.config.logger.debug 'Calling API: RegistrationApi.create_registration ...'
150
+ @api_client.config.logger.debug "Calling API: RegistrationApi.create_registration ..."
91
151
  end
92
152
  # verify the required parameter 'registration' is set
93
- if @api_client.config.client_side_validation && registration.nil?
94
- fail ArgumentError, "Missing the required parameter 'registration' when calling RegistrationApi.create_registration"
95
- end
153
+ fail ArgumentError, "Missing the required parameter 'registration' when calling RegistrationApi.create_registration" if registration.nil?
96
154
  # resource path
97
- local_var_path = '/registrations'
155
+ local_var_path = "/registrations".sub('{format}','json')
98
156
 
99
157
  # query parameters
100
158
  query_params = {}
@@ -124,29 +182,30 @@ module RusticiSoftwareCloudV2
124
182
  end
125
183
  return data, status_code, headers
126
184
  end
127
- # Delete `registrationId`
185
+
186
+ # Delete a registration.
187
+ # Delete `registrationId`. This includes all instances of this registration.
128
188
  # @param registration_id id for this registration
129
189
  # @param [Hash] opts the optional parameters
130
190
  # @return [nil]
131
191
  def delete_registration(registration_id, opts = {})
132
192
  delete_registration_with_http_info(registration_id, opts)
133
- nil
193
+ return nil
134
194
  end
135
195
 
136
- # Delete &#x60;registrationId&#x60;
196
+ # Delete a registration.
197
+ # Delete &#x60;registrationId&#x60;. This includes all instances of this registration.
137
198
  # @param registration_id id for this registration
138
199
  # @param [Hash] opts the optional parameters
139
200
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
140
201
  def delete_registration_with_http_info(registration_id, opts = {})
141
202
  if @api_client.config.debugging
142
- @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration ...'
203
+ @api_client.config.logger.debug "Calling API: RegistrationApi.delete_registration ..."
143
204
  end
144
205
  # verify the required parameter 'registration_id' is set
145
- if @api_client.config.client_side_validation && registration_id.nil?
146
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration"
147
- end
206
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration" if registration_id.nil?
148
207
  # resource path
149
- local_var_path = '/registrations/{registrationId}'.sub('{' + 'registrationId' + '}', registration_id.to_s)
208
+ local_var_path = "/registrations/{registrationId}".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)
150
209
 
151
210
  # query parameters
152
211
  query_params = {}
@@ -175,35 +234,34 @@ module RusticiSoftwareCloudV2
175
234
  end
176
235
  return data, status_code, headers
177
236
  end
178
- # Clears the `settingId` value for this registration
237
+
238
+ # Clear a registration configuration.
239
+ # Clears the `settingId` value for this registration. The effective value will become the value at the next level which has an explicit value set. Possibilities are course, application, or default.
179
240
  # @param registration_id id for this registration
180
241
  # @param setting_id
181
242
  # @param [Hash] opts the optional parameters
182
243
  # @return [nil]
183
244
  def delete_registration_configuration_setting(registration_id, setting_id, opts = {})
184
245
  delete_registration_configuration_setting_with_http_info(registration_id, setting_id, opts)
185
- nil
246
+ return nil
186
247
  end
187
248
 
188
- # Clears the &#x60;settingId&#x60; value for this registration
249
+ # Clear a registration configuration.
250
+ # Clears the &#x60;settingId&#x60; value for this registration. The effective value will become the value at the next level which has an explicit value set. Possibilities are course, application, or default.
189
251
  # @param registration_id id for this registration
190
252
  # @param setting_id
191
253
  # @param [Hash] opts the optional parameters
192
254
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
193
255
  def delete_registration_configuration_setting_with_http_info(registration_id, setting_id, opts = {})
194
256
  if @api_client.config.debugging
195
- @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_configuration_setting ...'
257
+ @api_client.config.logger.debug "Calling API: RegistrationApi.delete_registration_configuration_setting ..."
196
258
  end
197
259
  # verify the required parameter 'registration_id' is set
198
- if @api_client.config.client_side_validation && registration_id.nil?
199
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_configuration_setting"
200
- end
260
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_configuration_setting" if registration_id.nil?
201
261
  # verify the required parameter 'setting_id' is set
202
- if @api_client.config.client_side_validation && setting_id.nil?
203
- fail ArgumentError, "Missing the required parameter 'setting_id' when calling RegistrationApi.delete_registration_configuration_setting"
204
- end
262
+ fail ArgumentError, "Missing the required parameter 'setting_id' when calling RegistrationApi.delete_registration_configuration_setting" if setting_id.nil?
205
263
  # resource path
206
- local_var_path = '/registrations/{registrationId}/configuration/{settingId}'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'settingId' + '}', setting_id.to_s)
264
+ local_var_path = "/registrations/{registrationId}/configuration/{settingId}".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'settingId' + '}', setting_id.to_s)
207
265
 
208
266
  # query parameters
209
267
  query_params = {}
@@ -232,7 +290,61 @@ module RusticiSoftwareCloudV2
232
290
  end
233
291
  return data, status_code, headers
234
292
  end
235
- # Clears the `settingId` value for this registration instance
293
+
294
+ # Delete the global data of a registration.
295
+ # Delete global data associated with `registrationId`'. Calling this method will reset all global objectives associated with this registration, if any exist.
296
+ # @param registration_id id for this registration
297
+ # @param [Hash] opts the optional parameters
298
+ # @return [nil]
299
+ def delete_registration_global_data(registration_id, opts = {})
300
+ delete_registration_global_data_with_http_info(registration_id, opts)
301
+ return nil
302
+ end
303
+
304
+ # Delete the global data of a registration.
305
+ # Delete global data associated with &#x60;registrationId&#x60;&#39;. Calling this method will reset all global objectives associated with this registration, if any exist.
306
+ # @param registration_id id for this registration
307
+ # @param [Hash] opts the optional parameters
308
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
309
+ def delete_registration_global_data_with_http_info(registration_id, opts = {})
310
+ if @api_client.config.debugging
311
+ @api_client.config.logger.debug "Calling API: RegistrationApi.delete_registration_global_data ..."
312
+ end
313
+ # verify the required parameter 'registration_id' is set
314
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_global_data" if registration_id.nil?
315
+ # resource path
316
+ local_var_path = "/registrations/{registrationId}/globalData".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)
317
+
318
+ # query parameters
319
+ query_params = {}
320
+
321
+ # header parameters
322
+ header_params = {}
323
+ # HTTP header 'Accept' (if needed)
324
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
325
+ # HTTP header 'Content-Type'
326
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
327
+
328
+ # form parameters
329
+ form_params = {}
330
+
331
+ # http body (model)
332
+ post_body = nil
333
+ auth_names = ['APP_NORMAL', 'OAUTH']
334
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
335
+ :header_params => header_params,
336
+ :query_params => query_params,
337
+ :form_params => form_params,
338
+ :body => post_body,
339
+ :auth_names => auth_names)
340
+ if @api_client.config.debugging
341
+ @api_client.config.logger.debug "API called: RegistrationApi#delete_registration_global_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
342
+ end
343
+ return data, status_code, headers
344
+ end
345
+
346
+ # Clear a configuration for an instance of a registration.
347
+ # Clears the `settingId` value for this registration instance.
236
348
  # @param registration_id id for this registration
237
349
  # @param instance_id The instance of this registration
238
350
  # @param setting_id
@@ -240,10 +352,11 @@ module RusticiSoftwareCloudV2
240
352
  # @return [nil]
241
353
  def delete_registration_instance_configuration_setting(registration_id, instance_id, setting_id, opts = {})
242
354
  delete_registration_instance_configuration_setting_with_http_info(registration_id, instance_id, setting_id, opts)
243
- nil
355
+ return nil
244
356
  end
245
357
 
246
- # Clears the &#x60;settingId&#x60; value for this registration instance
358
+ # Clear a configuration for an instance of a registration.
359
+ # Clears the &#x60;settingId&#x60; value for this registration instance.
247
360
  # @param registration_id id for this registration
248
361
  # @param instance_id The instance of this registration
249
362
  # @param setting_id
@@ -251,26 +364,20 @@ module RusticiSoftwareCloudV2
251
364
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
252
365
  def delete_registration_instance_configuration_setting_with_http_info(registration_id, instance_id, setting_id, opts = {})
253
366
  if @api_client.config.debugging
254
- @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_instance_configuration_setting ...'
367
+ @api_client.config.logger.debug "Calling API: RegistrationApi.delete_registration_instance_configuration_setting ..."
255
368
  end
256
369
  # verify the required parameter 'registration_id' is set
257
- if @api_client.config.client_side_validation && registration_id.nil?
258
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_instance_configuration_setting"
259
- end
370
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_instance_configuration_setting" if registration_id.nil?
260
371
  # verify the required parameter 'instance_id' is set
261
- if @api_client.config.client_side_validation && instance_id.nil?
262
- fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.delete_registration_instance_configuration_setting"
263
- end
264
- if @api_client.config.client_side_validation && instance_id < 0
372
+ fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.delete_registration_instance_configuration_setting" if instance_id.nil?
373
+ if instance_id < 0
265
374
  fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.delete_registration_instance_configuration_setting, must be greater than or equal to 0.'
266
375
  end
267
376
 
268
377
  # verify the required parameter 'setting_id' is set
269
- if @api_client.config.client_side_validation && setting_id.nil?
270
- fail ArgumentError, "Missing the required parameter 'setting_id' when calling RegistrationApi.delete_registration_instance_configuration_setting"
271
- end
378
+ fail ArgumentError, "Missing the required parameter 'setting_id' when calling RegistrationApi.delete_registration_instance_configuration_setting" if setting_id.nil?
272
379
  # resource path
273
- local_var_path = '/registrations/{registrationId}/instances/{instanceId}/configuration/{settingId}'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s).sub('{' + 'settingId' + '}', setting_id.to_s)
380
+ local_var_path = "/registrations/{registrationId}/instances/{instanceId}/configuration/{settingId}".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s).sub('{' + 'settingId' + '}', setting_id.to_s)
274
381
 
275
382
  # query parameters
276
383
  query_params = {}
@@ -299,29 +406,30 @@ module RusticiSoftwareCloudV2
299
406
  end
300
407
  return data, status_code, headers
301
408
  end
302
- # Delete registration progress (clear registration)
409
+
410
+ # Reset a registration.
411
+ # This method will reset the specified registration. This is essentially the same as deleting and recreating the registration, and as such, will delete all the data associated with the registration (including launch history, etc.). If the course for which the registration is registered has multiple versions, the registration being reset will automatically be registered for the latest version.
303
412
  # @param registration_id id for this registration
304
413
  # @param [Hash] opts the optional parameters
305
414
  # @return [nil]
306
415
  def delete_registration_progress(registration_id, opts = {})
307
416
  delete_registration_progress_with_http_info(registration_id, opts)
308
- nil
417
+ return nil
309
418
  end
310
419
 
311
- # Delete registration progress (clear registration)
420
+ # Reset a registration.
421
+ # This method will reset the specified registration. This is essentially the same as deleting and recreating the registration, and as such, will delete all the data associated with the registration (including launch history, etc.). If the course for which the registration is registered has multiple versions, the registration being reset will automatically be registered for the latest version.
312
422
  # @param registration_id id for this registration
313
423
  # @param [Hash] opts the optional parameters
314
424
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
315
425
  def delete_registration_progress_with_http_info(registration_id, opts = {})
316
426
  if @api_client.config.debugging
317
- @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_progress ...'
427
+ @api_client.config.logger.debug "Calling API: RegistrationApi.delete_registration_progress ..."
318
428
  end
319
429
  # verify the required parameter 'registration_id' is set
320
- if @api_client.config.client_side_validation && registration_id.nil?
321
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_progress"
322
- end
430
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_progress" if registration_id.nil?
323
431
  # resource path
324
- local_var_path = '/registrations/{registrationId}/progress'.sub('{' + 'registrationId' + '}', registration_id.to_s)
432
+ local_var_path = "/registrations/{registrationId}/progress".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)
325
433
 
326
434
  # query parameters
327
435
  query_params = {}
@@ -350,35 +458,34 @@ module RusticiSoftwareCloudV2
350
458
  end
351
459
  return data, status_code, headers
352
460
  end
353
- # Delete tags for this registration
461
+
462
+ # Delete tags from a registration.
463
+ # Delete the provided tags for this registration.
354
464
  # @param registration_id id for this registration
355
465
  # @param tags
356
466
  # @param [Hash] opts the optional parameters
357
467
  # @return [nil]
358
468
  def delete_registration_tags(registration_id, tags, opts = {})
359
469
  delete_registration_tags_with_http_info(registration_id, tags, opts)
360
- nil
470
+ return nil
361
471
  end
362
472
 
363
- # Delete tags for this registration
473
+ # Delete tags from a registration.
474
+ # Delete the provided tags for this registration.
364
475
  # @param registration_id id for this registration
365
476
  # @param tags
366
477
  # @param [Hash] opts the optional parameters
367
478
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
368
479
  def delete_registration_tags_with_http_info(registration_id, tags, opts = {})
369
480
  if @api_client.config.debugging
370
- @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_tags ...'
481
+ @api_client.config.logger.debug "Calling API: RegistrationApi.delete_registration_tags ..."
371
482
  end
372
483
  # verify the required parameter 'registration_id' is set
373
- if @api_client.config.client_side_validation && registration_id.nil?
374
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_tags"
375
- end
484
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_tags" if registration_id.nil?
376
485
  # verify the required parameter 'tags' is set
377
- if @api_client.config.client_side_validation && tags.nil?
378
- fail ArgumentError, "Missing the required parameter 'tags' when calling RegistrationApi.delete_registration_tags"
379
- end
486
+ fail ArgumentError, "Missing the required parameter 'tags' when calling RegistrationApi.delete_registration_tags" if tags.nil?
380
487
  # resource path
381
- local_var_path = '/registrations/{registrationId}/tags'.sub('{' + 'registrationId' + '}', registration_id.to_s)
488
+ local_var_path = "/registrations/{registrationId}/tags".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)
382
489
 
383
490
  # query parameters
384
491
  query_params = {}
@@ -407,29 +514,30 @@ module RusticiSoftwareCloudV2
407
514
  end
408
515
  return data, status_code, headers
409
516
  end
410
- # Delete global data associated with `registrationId`
517
+
518
+ # See if a registration exists.
519
+ # This method is meant to check if a registration with `registrationId` exists in the system.
411
520
  # @param registration_id id for this registration
412
521
  # @param [Hash] opts the optional parameters
413
522
  # @return [nil]
414
- def delete_registrations_global_data(registration_id, opts = {})
415
- delete_registrations_global_data_with_http_info(registration_id, opts)
416
- nil
523
+ def get_registration(registration_id, opts = {})
524
+ get_registration_with_http_info(registration_id, opts)
525
+ return nil
417
526
  end
418
527
 
419
- # Delete global data associated with &#x60;registrationId&#x60;
528
+ # See if a registration exists.
529
+ # This method is meant to check if a registration with &#x60;registrationId&#x60; exists in the system.
420
530
  # @param registration_id id for this registration
421
531
  # @param [Hash] opts the optional parameters
422
532
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
423
- def delete_registrations_global_data_with_http_info(registration_id, opts = {})
533
+ def get_registration_with_http_info(registration_id, opts = {})
424
534
  if @api_client.config.debugging
425
- @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registrations_global_data ...'
535
+ @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration ..."
426
536
  end
427
537
  # 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"
430
- end
538
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration" if registration_id.nil?
431
539
  # resource path
432
- local_var_path = '/registrations/{registrationId}/globalData'.sub('{' + 'registrationId' + '}', registration_id.to_s)
540
+ local_var_path = "/registrations/{registrationId}".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)
433
541
 
434
542
  # query parameters
435
543
  query_params = {}
@@ -447,42 +555,43 @@ module RusticiSoftwareCloudV2
447
555
  # http body (model)
448
556
  post_body = nil
449
557
  auth_names = ['APP_NORMAL', 'OAUTH']
450
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
558
+ data, status_code, headers = @api_client.call_api(:HEAD, local_var_path,
451
559
  :header_params => header_params,
452
560
  :query_params => query_params,
453
561
  :form_params => form_params,
454
562
  :body => post_body,
455
563
  :auth_names => auth_names)
456
564
  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}"
565
+ @api_client.config.logger.debug "API called: RegistrationApi#get_registration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
458
566
  end
459
567
  return data, status_code, headers
460
568
  end
461
- # Returns all configuration settings for this registration
569
+
570
+ # Get registration configuration.
571
+ # Returns all configuration settings for this registration.
462
572
  # @param registration_id id for this registration
463
573
  # @param [Hash] opts the optional parameters
464
574
  # @option opts [BOOLEAN] :include_metadata (default to false)
465
575
  # @return [SettingListSchema]
466
576
  def get_registration_configuration(registration_id, opts = {})
467
577
  data, _status_code, _headers = get_registration_configuration_with_http_info(registration_id, opts)
468
- data
578
+ return data
469
579
  end
470
580
 
471
- # Returns all configuration settings for this registration
581
+ # Get registration configuration.
582
+ # Returns all configuration settings for this registration.
472
583
  # @param registration_id id for this registration
473
584
  # @param [Hash] opts the optional parameters
474
585
  # @option opts [BOOLEAN] :include_metadata
475
586
  # @return [Array<(SettingListSchema, Fixnum, Hash)>] SettingListSchema data, response status code and response headers
476
587
  def get_registration_configuration_with_http_info(registration_id, opts = {})
477
588
  if @api_client.config.debugging
478
- @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_configuration ...'
589
+ @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_configuration ..."
479
590
  end
480
591
  # verify the required parameter 'registration_id' is set
481
- if @api_client.config.client_side_validation && registration_id.nil?
482
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_configuration"
483
- end
592
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_configuration" if registration_id.nil?
484
593
  # resource path
485
- local_var_path = '/registrations/{registrationId}/configuration'.sub('{' + 'registrationId' + '}', registration_id.to_s)
594
+ local_var_path = "/registrations/{registrationId}/configuration".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)
486
595
 
487
596
  # query parameters
488
597
  query_params = {}
@@ -513,7 +622,9 @@ module RusticiSoftwareCloudV2
513
622
  end
514
623
  return data, status_code, headers
515
624
  end
516
- # Returns all configuration settings for this registration instance
625
+
626
+ # Get configuration for instance of registration.
627
+ # Returns all configuration settings for this registration instance.
517
628
  # @param registration_id id for this registration
518
629
  # @param instance_id The instance of this registration
519
630
  # @param [Hash] opts the optional parameters
@@ -521,10 +632,11 @@ module RusticiSoftwareCloudV2
521
632
  # @return [SettingListSchema]
522
633
  def get_registration_instance_configuration(registration_id, instance_id, opts = {})
523
634
  data, _status_code, _headers = get_registration_instance_configuration_with_http_info(registration_id, instance_id, opts)
524
- data
635
+ return data
525
636
  end
526
637
 
527
- # Returns all configuration settings for this registration instance
638
+ # Get configuration for instance of registration.
639
+ # Returns all configuration settings for this registration instance.
528
640
  # @param registration_id id for this registration
529
641
  # @param instance_id The instance of this registration
530
642
  # @param [Hash] opts the optional parameters
@@ -532,22 +644,18 @@ module RusticiSoftwareCloudV2
532
644
  # @return [Array<(SettingListSchema, Fixnum, Hash)>] SettingListSchema data, response status code and response headers
533
645
  def get_registration_instance_configuration_with_http_info(registration_id, instance_id, opts = {})
534
646
  if @api_client.config.debugging
535
- @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_configuration ...'
647
+ @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_instance_configuration ..."
536
648
  end
537
649
  # verify the required parameter 'registration_id' is set
538
- if @api_client.config.client_side_validation && registration_id.nil?
539
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_configuration"
540
- end
650
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_configuration" if registration_id.nil?
541
651
  # verify the required parameter 'instance_id' is set
542
- if @api_client.config.client_side_validation && instance_id.nil?
543
- fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_configuration"
544
- end
545
- if @api_client.config.client_side_validation && instance_id < 0
652
+ fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_configuration" if instance_id.nil?
653
+ if instance_id < 0
546
654
  fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_configuration, must be greater than or equal to 0.'
547
655
  end
548
656
 
549
657
  # resource path
550
- local_var_path = '/registrations/{registrationId}/instances/{instanceId}/configuration'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
658
+ local_var_path = "/registrations/{registrationId}/instances/{instanceId}/configuration".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
551
659
 
552
660
  # query parameters
553
661
  query_params = {}
@@ -578,7 +686,9 @@ module RusticiSoftwareCloudV2
578
686
  end
579
687
  return data, status_code, headers
580
688
  end
581
- # Returns history of this registration's launches
689
+
690
+ # Get launch history for an instance of a registration.
691
+ # Returns history of the launches of the specified instance of this registration.
582
692
  # @param registration_id id for this registration
583
693
  # @param instance_id The instance of this registration
584
694
  # @param [Hash] opts the optional parameters
@@ -586,10 +696,11 @@ module RusticiSoftwareCloudV2
586
696
  # @return [LaunchHistoryListSchema]
587
697
  def get_registration_instance_launch_history(registration_id, instance_id, opts = {})
588
698
  data, _status_code, _headers = get_registration_instance_launch_history_with_http_info(registration_id, instance_id, opts)
589
- data
699
+ return data
590
700
  end
591
701
 
592
- # Returns history of this registration&#39;s launches
702
+ # Get launch history for an instance of a registration.
703
+ # Returns history of the launches of the specified instance of this registration.
593
704
  # @param registration_id id for this registration
594
705
  # @param instance_id The instance of this registration
595
706
  # @param [Hash] opts the optional parameters
@@ -597,22 +708,18 @@ module RusticiSoftwareCloudV2
597
708
  # @return [Array<(LaunchHistoryListSchema, Fixnum, Hash)>] LaunchHistoryListSchema data, response status code and response headers
598
709
  def get_registration_instance_launch_history_with_http_info(registration_id, instance_id, opts = {})
599
710
  if @api_client.config.debugging
600
- @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_launch_history ...'
711
+ @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_instance_launch_history ..."
601
712
  end
602
713
  # verify the required parameter 'registration_id' is set
603
- if @api_client.config.client_side_validation && registration_id.nil?
604
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_launch_history"
605
- end
714
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_launch_history" if registration_id.nil?
606
715
  # verify the required parameter 'instance_id' is set
607
- if @api_client.config.client_side_validation && instance_id.nil?
608
- fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_launch_history"
609
- end
610
- if @api_client.config.client_side_validation && instance_id < 0
716
+ fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_launch_history" if instance_id.nil?
717
+ if instance_id < 0
611
718
  fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_launch_history, must be greater than or equal to 0.'
612
719
  end
613
720
 
614
721
  # resource path
615
- local_var_path = '/registrations/{registrationId}/instances/{instanceId}/launchHistory'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
722
+ local_var_path = "/registrations/{registrationId}/instances/{instanceId}/launchHistory".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
616
723
 
617
724
  # query parameters
618
725
  query_params = {}
@@ -643,7 +750,9 @@ module RusticiSoftwareCloudV2
643
750
  end
644
751
  return data, status_code, headers
645
752
  end
646
- # Get registration progress for instance `instanceId` of `registrationId`
753
+
754
+ # Get details of an instance of a registration.
755
+ # Get registration progress for instance `instanceId` of `registrationId`'
647
756
  # @param registration_id id for this registration
648
757
  # @param instance_id The instance of this registration
649
758
  # @param [Hash] opts the optional parameters
@@ -653,10 +762,11 @@ module RusticiSoftwareCloudV2
653
762
  # @return [RegistrationSchema]
654
763
  def get_registration_instance_progress(registration_id, instance_id, opts = {})
655
764
  data, _status_code, _headers = get_registration_instance_progress_with_http_info(registration_id, instance_id, opts)
656
- data
765
+ return data
657
766
  end
658
767
 
659
- # Get registration progress for instance &#x60;instanceId&#x60; of &#x60;registrationId&#x60;
768
+ # Get details of an instance of a registration.
769
+ # Get registration progress for instance &#x60;instanceId&#x60; of &#x60;registrationId&#x60;&#39;
660
770
  # @param registration_id id for this registration
661
771
  # @param instance_id The instance of this registration
662
772
  # @param [Hash] opts the optional parameters
@@ -666,22 +776,18 @@ module RusticiSoftwareCloudV2
666
776
  # @return [Array<(RegistrationSchema, Fixnum, Hash)>] RegistrationSchema data, response status code and response headers
667
777
  def get_registration_instance_progress_with_http_info(registration_id, instance_id, opts = {})
668
778
  if @api_client.config.debugging
669
- @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_progress ...'
779
+ @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_instance_progress ..."
670
780
  end
671
781
  # verify the required parameter 'registration_id' is set
672
- if @api_client.config.client_side_validation && registration_id.nil?
673
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_progress"
674
- end
782
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_progress" if registration_id.nil?
675
783
  # verify the required parameter 'instance_id' is set
676
- if @api_client.config.client_side_validation && instance_id.nil?
677
- fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_progress"
678
- end
679
- if @api_client.config.client_side_validation && instance_id < 0
784
+ fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_progress" if instance_id.nil?
785
+ if instance_id < 0
680
786
  fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_progress, must be greater than or equal to 0.'
681
787
  end
682
788
 
683
789
  # resource path
684
- local_var_path = '/registrations/{registrationId}/instances/{instanceId}'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
790
+ local_var_path = "/registrations/{registrationId}/instances/{instanceId}".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
685
791
 
686
792
  # query parameters
687
793
  query_params = {}
@@ -714,7 +820,9 @@ module RusticiSoftwareCloudV2
714
820
  end
715
821
  return data, status_code, headers
716
822
  end
717
- # Get xAPI statements for instance `instanceId` of `registrationId`
823
+
824
+ # Get xAPI statements for an instance of a registration.
825
+ # Get xAPI statements for instance `instanceId` of `registrationId`.
718
826
  # @param registration_id id for this registration
719
827
  # @param instance_id The instance of this registration
720
828
  # @param [Hash] opts the optional parameters
@@ -724,10 +832,11 @@ module RusticiSoftwareCloudV2
724
832
  # @return [XapiStatementResult]
725
833
  def get_registration_instance_statements(registration_id, instance_id, opts = {})
726
834
  data, _status_code, _headers = get_registration_instance_statements_with_http_info(registration_id, instance_id, opts)
727
- data
835
+ return data
728
836
  end
729
837
 
730
- # Get xAPI statements for instance &#x60;instanceId&#x60; of &#x60;registrationId&#x60;
838
+ # Get xAPI statements for an instance of a registration.
839
+ # Get xAPI statements for instance &#x60;instanceId&#x60; of &#x60;registrationId&#x60;.
731
840
  # @param registration_id id for this registration
732
841
  # @param instance_id The instance of this registration
733
842
  # @param [Hash] opts the optional parameters
@@ -737,22 +846,18 @@ module RusticiSoftwareCloudV2
737
846
  # @return [Array<(XapiStatementResult, Fixnum, Hash)>] XapiStatementResult data, response status code and response headers
738
847
  def get_registration_instance_statements_with_http_info(registration_id, instance_id, opts = {})
739
848
  if @api_client.config.debugging
740
- @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_statements ...'
849
+ @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_instance_statements ..."
741
850
  end
742
851
  # verify the required parameter 'registration_id' is set
743
- if @api_client.config.client_side_validation && registration_id.nil?
744
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_statements"
745
- end
852
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_statements" if registration_id.nil?
746
853
  # verify the required parameter 'instance_id' is set
747
- if @api_client.config.client_side_validation && instance_id.nil?
748
- fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_statements"
749
- end
750
- if @api_client.config.client_side_validation && instance_id < 0
854
+ fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_statements" if instance_id.nil?
855
+ if instance_id < 0
751
856
  fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_statements, must be greater than or equal to 0.'
752
857
  end
753
858
 
754
859
  # resource path
755
- local_var_path = '/registrations/{registrationId}/instances/{instanceId}/xAPIStatements'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
860
+ local_var_path = "/registrations/{registrationId}/instances/{instanceId}/xAPIStatements".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
756
861
 
757
862
  # query parameters
758
863
  query_params = {}
@@ -785,7 +890,9 @@ module RusticiSoftwareCloudV2
785
890
  end
786
891
  return data, status_code, headers
787
892
  end
788
- # Get all the instances of this the registration specified by the registration ID
893
+
894
+ # Get all instances of a registration.
895
+ # Get all the instances of this the registration specified by the registration ID
789
896
  # @param registration_id id for this registration
790
897
  # @param [Hash] opts the optional parameters
791
898
  # @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.
@@ -797,10 +904,11 @@ module RusticiSoftwareCloudV2
797
904
  # @return [RegistrationListSchema]
798
905
  def get_registration_instances(registration_id, opts = {})
799
906
  data, _status_code, _headers = get_registration_instances_with_http_info(registration_id, opts)
800
- data
907
+ return data
801
908
  end
802
909
 
803
- # Get all the instances of this the registration specified by the registration ID
910
+ # Get all instances of a registration.
911
+ # Get all the instances of this the registration specified by the registration ID
804
912
  # @param registration_id id for this registration
805
913
  # @param [Hash] opts the optional parameters
806
914
  # @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.
@@ -812,14 +920,12 @@ module RusticiSoftwareCloudV2
812
920
  # @return [Array<(RegistrationListSchema, Fixnum, Hash)>] RegistrationListSchema data, response status code and response headers
813
921
  def get_registration_instances_with_http_info(registration_id, opts = {})
814
922
  if @api_client.config.debugging
815
- @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instances ...'
923
+ @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_instances ..."
816
924
  end
817
925
  # verify the required parameter 'registration_id' is set
818
- if @api_client.config.client_side_validation && registration_id.nil?
819
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instances"
820
- end
926
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instances" if registration_id.nil?
821
927
  # resource path
822
- local_var_path = '/registrations/{registrationId}/instances'.sub('{' + 'registrationId' + '}', registration_id.to_s)
928
+ local_var_path = "/registrations/{registrationId}/instances".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)
823
929
 
824
930
  # query parameters
825
931
  query_params = {}
@@ -855,31 +961,32 @@ module RusticiSoftwareCloudV2
855
961
  end
856
962
  return data, status_code, headers
857
963
  end
858
- # Returns history of this registration's launches
964
+
965
+ # Get launch history for a registration.
966
+ # Returns history of this registration's launches.
859
967
  # @param registration_id id for this registration
860
968
  # @param [Hash] opts the optional parameters
861
969
  # @option opts [BOOLEAN] :include_history_log Whether to include the history log in the launch history (default to false)
862
970
  # @return [LaunchHistoryListSchema]
863
971
  def get_registration_launch_history(registration_id, opts = {})
864
972
  data, _status_code, _headers = get_registration_launch_history_with_http_info(registration_id, opts)
865
- data
973
+ return data
866
974
  end
867
975
 
868
- # Returns history of this registration&#39;s launches
976
+ # Get launch history for a registration.
977
+ # Returns history of this registration&#39;s launches.
869
978
  # @param registration_id id for this registration
870
979
  # @param [Hash] opts the optional parameters
871
980
  # @option opts [BOOLEAN] :include_history_log Whether to include the history log in the launch history
872
981
  # @return [Array<(LaunchHistoryListSchema, Fixnum, Hash)>] LaunchHistoryListSchema data, response status code and response headers
873
982
  def get_registration_launch_history_with_http_info(registration_id, opts = {})
874
983
  if @api_client.config.debugging
875
- @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_launch_history ...'
984
+ @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_launch_history ..."
876
985
  end
877
986
  # verify the required parameter 'registration_id' is set
878
- if @api_client.config.client_side_validation && registration_id.nil?
879
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_launch_history"
880
- end
987
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_launch_history" if registration_id.nil?
881
988
  # resource path
882
- local_var_path = '/registrations/{registrationId}/launchHistory'.sub('{' + 'registrationId' + '}', registration_id.to_s)
989
+ local_var_path = "/registrations/{registrationId}/launchHistory".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)
883
990
 
884
991
  # query parameters
885
992
  query_params = {}
@@ -910,65 +1017,9 @@ module RusticiSoftwareCloudV2
910
1017
  end
911
1018
  return data, status_code, headers
912
1019
  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
1020
 
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`
1021
+ # Get details of a registration.
1022
+ # Get detailed information about the latest instance of `registrationId`. Additional detail may be obtained by using the optional query parameters.
972
1023
  # @param registration_id id for this registration
973
1024
  # @param [Hash] opts the optional parameters
974
1025
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results (default to false)
@@ -977,10 +1028,11 @@ module RusticiSoftwareCloudV2
977
1028
  # @return [RegistrationSchema]
978
1029
  def get_registration_progress(registration_id, opts = {})
979
1030
  data, _status_code, _headers = get_registration_progress_with_http_info(registration_id, opts)
980
- data
1031
+ return data
981
1032
  end
982
1033
 
983
- # Get registration progress for &#x60;registrationId&#x60;
1034
+ # Get details of a registration.
1035
+ # Get detailed information about the latest instance of &#x60;registrationId&#x60;. Additional detail may be obtained by using the optional query parameters.
984
1036
  # @param registration_id id for this registration
985
1037
  # @param [Hash] opts the optional parameters
986
1038
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results
@@ -989,14 +1041,12 @@ module RusticiSoftwareCloudV2
989
1041
  # @return [Array<(RegistrationSchema, Fixnum, Hash)>] RegistrationSchema data, response status code and response headers
990
1042
  def get_registration_progress_with_http_info(registration_id, opts = {})
991
1043
  if @api_client.config.debugging
992
- @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_progress ...'
1044
+ @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_progress ..."
993
1045
  end
994
1046
  # verify the required parameter 'registration_id' is set
995
- if @api_client.config.client_side_validation && registration_id.nil?
996
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_progress"
997
- end
1047
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_progress" if registration_id.nil?
998
1048
  # resource path
999
- local_var_path = '/registrations/{registrationId}'.sub('{' + 'registrationId' + '}', registration_id.to_s)
1049
+ local_var_path = "/registrations/{registrationId}".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)
1000
1050
 
1001
1051
  # query parameters
1002
1052
  query_params = {}
@@ -1029,7 +1079,9 @@ module RusticiSoftwareCloudV2
1029
1079
  end
1030
1080
  return data, status_code, headers
1031
1081
  end
1032
- # Get xAPI statements for `registrationId`
1082
+
1083
+ # Get xAPI statements for a registration.
1084
+ # Get xAPI statements for `registrationId`.
1033
1085
  # @param registration_id id for this registration
1034
1086
  # @param [Hash] opts the optional parameters
1035
1087
  # @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.
@@ -1038,10 +1090,11 @@ module RusticiSoftwareCloudV2
1038
1090
  # @return [XapiStatementResult]
1039
1091
  def get_registration_statements(registration_id, opts = {})
1040
1092
  data, _status_code, _headers = get_registration_statements_with_http_info(registration_id, opts)
1041
- data
1093
+ return data
1042
1094
  end
1043
1095
 
1044
- # Get xAPI statements for &#x60;registrationId&#x60;
1096
+ # Get xAPI statements for a registration.
1097
+ # Get xAPI statements for &#x60;registrationId&#x60;.
1045
1098
  # @param registration_id id for this registration
1046
1099
  # @param [Hash] opts the optional parameters
1047
1100
  # @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.
@@ -1050,14 +1103,12 @@ module RusticiSoftwareCloudV2
1050
1103
  # @return [Array<(XapiStatementResult, Fixnum, Hash)>] XapiStatementResult data, response status code and response headers
1051
1104
  def get_registration_statements_with_http_info(registration_id, opts = {})
1052
1105
  if @api_client.config.debugging
1053
- @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_statements ...'
1106
+ @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_statements ..."
1054
1107
  end
1055
1108
  # verify the required parameter 'registration_id' is set
1056
- if @api_client.config.client_side_validation && registration_id.nil?
1057
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_statements"
1058
- end
1109
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_statements" if registration_id.nil?
1059
1110
  # resource path
1060
- local_var_path = '/registrations/{registrationId}/xAPIStatements'.sub('{' + 'registrationId' + '}', registration_id.to_s)
1111
+ local_var_path = "/registrations/{registrationId}/xAPIStatements".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)
1061
1112
 
1062
1113
  # query parameters
1063
1114
  query_params = {}
@@ -1090,29 +1141,30 @@ module RusticiSoftwareCloudV2
1090
1141
  end
1091
1142
  return data, status_code, headers
1092
1143
  end
1093
- # Get the tags for this registration
1144
+
1145
+ # Get tags for a registration.
1146
+ # Get a list of the tags applied to this registration.
1094
1147
  # @param registration_id id for this registration
1095
1148
  # @param [Hash] opts the optional parameters
1096
1149
  # @return [TagListSchema]
1097
1150
  def get_registration_tags(registration_id, opts = {})
1098
1151
  data, _status_code, _headers = get_registration_tags_with_http_info(registration_id, opts)
1099
- data
1152
+ return data
1100
1153
  end
1101
1154
 
1102
- # Get the tags for this registration
1155
+ # Get tags for a registration.
1156
+ # Get a list of the tags applied to this registration.
1103
1157
  # @param registration_id id for this registration
1104
1158
  # @param [Hash] opts the optional parameters
1105
1159
  # @return [Array<(TagListSchema, Fixnum, Hash)>] TagListSchema data, response status code and response headers
1106
1160
  def get_registration_tags_with_http_info(registration_id, opts = {})
1107
1161
  if @api_client.config.debugging
1108
- @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_tags ...'
1162
+ @api_client.config.logger.debug "Calling API: RegistrationApi.get_registration_tags ..."
1109
1163
  end
1110
1164
  # verify the required parameter 'registration_id' is set
1111
- if @api_client.config.client_side_validation && registration_id.nil?
1112
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_tags"
1113
- end
1165
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_tags" if registration_id.nil?
1114
1166
  # resource path
1115
- local_var_path = '/registrations/{registrationId}/tags'.sub('{' + 'registrationId' + '}', registration_id.to_s)
1167
+ local_var_path = "/registrations/{registrationId}/tags".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)
1116
1168
 
1117
1169
  # query parameters
1118
1170
  query_params = {}
@@ -1142,7 +1194,9 @@ module RusticiSoftwareCloudV2
1142
1194
  end
1143
1195
  return data, status_code, headers
1144
1196
  end
1145
- # Gets a list of registrations including a summary of the status of each registration.
1197
+
1198
+ # Get a list of all registrations.
1199
+ # Gets a list of registrations including a summary of the status of each registration.
1146
1200
  # @param [Hash] opts the optional parameters
1147
1201
  # @option opts [String] :course_id Only registrations for the specified course id will be included.
1148
1202
  # @option opts [String] :learner_id Only registrations for the specified learner id will be included.
@@ -1152,13 +1206,15 @@ module RusticiSoftwareCloudV2
1152
1206
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results (default to false)
1153
1207
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results (default to false)
1154
1208
  # @option opts [BOOLEAN] :include_runtime Include runtime details in the results (default to false)
1209
+ # @option opts [Array<String>] :tags
1155
1210
  # @return [RegistrationListSchema]
1156
1211
  def get_registrations(opts = {})
1157
1212
  data, _status_code, _headers = get_registrations_with_http_info(opts)
1158
- data
1213
+ return data
1159
1214
  end
1160
1215
 
1161
- # Gets a list of registrations including a summary of the status of each registration.
1216
+ # Get a list of all registrations.
1217
+ # Gets a list of registrations including a summary of the status of each registration.
1162
1218
  # @param [Hash] opts the optional parameters
1163
1219
  # @option opts [String] :course_id Only registrations for the specified course id will be included.
1164
1220
  # @option opts [String] :learner_id Only registrations for the specified learner id will be included.
@@ -1168,13 +1224,14 @@ module RusticiSoftwareCloudV2
1168
1224
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results
1169
1225
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results
1170
1226
  # @option opts [BOOLEAN] :include_runtime Include runtime details in the results
1227
+ # @option opts [Array<String>] :tags
1171
1228
  # @return [Array<(RegistrationListSchema, Fixnum, Hash)>] RegistrationListSchema data, response status code and response headers
1172
1229
  def get_registrations_with_http_info(opts = {})
1173
1230
  if @api_client.config.debugging
1174
- @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registrations ...'
1231
+ @api_client.config.logger.debug "Calling API: RegistrationApi.get_registrations ..."
1175
1232
  end
1176
1233
  # resource path
1177
- local_var_path = '/registrations'
1234
+ local_var_path = "/registrations".sub('{format}','json')
1178
1235
 
1179
1236
  # query parameters
1180
1237
  query_params = {}
@@ -1186,6 +1243,7 @@ module RusticiSoftwareCloudV2
1186
1243
  query_params[:'includeChildResults'] = opts[:'include_child_results'] if !opts[:'include_child_results'].nil?
1187
1244
  query_params[:'includeInteractionsAndObjectives'] = opts[:'include_interactions_and_objectives'] if !opts[:'include_interactions_and_objectives'].nil?
1188
1245
  query_params[:'includeRuntime'] = opts[:'include_runtime'] if !opts[:'include_runtime'].nil?
1246
+ query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
1189
1247
 
1190
1248
  # header parameters
1191
1249
  header_params = {}
@@ -1212,35 +1270,34 @@ module RusticiSoftwareCloudV2
1212
1270
  end
1213
1271
  return data, status_code, headers
1214
1272
  end
1215
- # Set the tags for this registration
1273
+
1274
+ # Set tags on a registration.
1275
+ # Set the tags for this registration. Note: any tags currently on this registration will be overwritten with the new array of tags.
1216
1276
  # @param registration_id id for this registration
1217
1277
  # @param tags
1218
1278
  # @param [Hash] opts the optional parameters
1219
1279
  # @return [nil]
1220
1280
  def put_registration_tags(registration_id, tags, opts = {})
1221
1281
  put_registration_tags_with_http_info(registration_id, tags, opts)
1222
- nil
1282
+ return nil
1223
1283
  end
1224
1284
 
1225
- # Set the tags for this registration
1285
+ # Set tags on a registration.
1286
+ # Set the tags for this registration. Note: any tags currently on this registration will be overwritten with the new array of tags.
1226
1287
  # @param registration_id id for this registration
1227
1288
  # @param tags
1228
1289
  # @param [Hash] opts the optional parameters
1229
1290
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1230
1291
  def put_registration_tags_with_http_info(registration_id, tags, opts = {})
1231
1292
  if @api_client.config.debugging
1232
- @api_client.config.logger.debug 'Calling API: RegistrationApi.put_registration_tags ...'
1293
+ @api_client.config.logger.debug "Calling API: RegistrationApi.put_registration_tags ..."
1233
1294
  end
1234
1295
  # verify the required parameter 'registration_id' is set
1235
- if @api_client.config.client_side_validation && registration_id.nil?
1236
- fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.put_registration_tags"
1237
- end
1296
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.put_registration_tags" if registration_id.nil?
1238
1297
  # verify the required parameter 'tags' is set
1239
- if @api_client.config.client_side_validation && tags.nil?
1240
- fail ArgumentError, "Missing the required parameter 'tags' when calling RegistrationApi.put_registration_tags"
1241
- end
1298
+ fail ArgumentError, "Missing the required parameter 'tags' when calling RegistrationApi.put_registration_tags" if tags.nil?
1242
1299
  # resource path
1243
- local_var_path = '/registrations/{registrationId}/tags'.sub('{' + 'registrationId' + '}', registration_id.to_s)
1300
+ local_var_path = "/registrations/{registrationId}/tags".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)
1244
1301
 
1245
1302
  # query parameters
1246
1303
  query_params = {}
@@ -1269,29 +1326,30 @@ module RusticiSoftwareCloudV2
1269
1326
  end
1270
1327
  return data, status_code, headers
1271
1328
  end
1272
- # Sets all of the provided tags on all of the provided registrations
1273
- # @param batch
1329
+
1330
+ # Set tags on registrations.
1331
+ # Sets all of the provided tags on all of the provided registrations.
1332
+ # @param batch Object representing an array of ids to apply an array of tags to.
1274
1333
  # @param [Hash] opts the optional parameters
1275
1334
  # @return [nil]
1276
1335
  def put_registration_tags_batch(batch, opts = {})
1277
1336
  put_registration_tags_batch_with_http_info(batch, opts)
1278
- nil
1337
+ return nil
1279
1338
  end
1280
1339
 
1281
- # Sets all of the provided tags on all of the provided registrations
1282
- # @param batch
1340
+ # Set tags on registrations.
1341
+ # Sets all of the provided tags on all of the provided registrations.
1342
+ # @param batch Object representing an array of ids to apply an array of tags to.
1283
1343
  # @param [Hash] opts the optional parameters
1284
1344
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1285
1345
  def put_registration_tags_batch_with_http_info(batch, opts = {})
1286
1346
  if @api_client.config.debugging
1287
- @api_client.config.logger.debug 'Calling API: RegistrationApi.put_registration_tags_batch ...'
1347
+ @api_client.config.logger.debug "Calling API: RegistrationApi.put_registration_tags_batch ..."
1288
1348
  end
1289
1349
  # verify the required parameter 'batch' is set
1290
- if @api_client.config.client_side_validation && batch.nil?
1291
- fail ArgumentError, "Missing the required parameter 'batch' when calling RegistrationApi.put_registration_tags_batch"
1292
- end
1350
+ fail ArgumentError, "Missing the required parameter 'batch' when calling RegistrationApi.put_registration_tags_batch" if batch.nil?
1293
1351
  # resource path
1294
- local_var_path = '/registrations/tags'
1352
+ local_var_path = "/registrations/tags".sub('{format}','json')
1295
1353
 
1296
1354
  # query parameters
1297
1355
  query_params = {}
@@ -1320,29 +1378,34 @@ module RusticiSoftwareCloudV2
1320
1378
  end
1321
1379
  return data, status_code, headers
1322
1380
  end
1323
- # Does this registration exist?
1381
+
1382
+ # Set registration configuration.
1383
+ # Set configuration settings for this registration.
1324
1384
  # @param registration_id id for this registration
1385
+ # @param configuration_settings
1325
1386
  # @param [Hash] opts the optional parameters
1326
1387
  # @return [nil]
1327
- def registration_exists(registration_id, opts = {})
1328
- registration_exists_with_http_info(registration_id, opts)
1329
- nil
1388
+ def set_registration_configuration(registration_id, configuration_settings, opts = {})
1389
+ set_registration_configuration_with_http_info(registration_id, configuration_settings, opts)
1390
+ return nil
1330
1391
  end
1331
1392
 
1332
- # Does this registration exist?
1393
+ # Set registration configuration.
1394
+ # Set configuration settings for this registration.
1333
1395
  # @param registration_id id for this registration
1396
+ # @param configuration_settings
1334
1397
  # @param [Hash] opts the optional parameters
1335
1398
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1336
- def registration_exists_with_http_info(registration_id, opts = {})
1399
+ def set_registration_configuration_with_http_info(registration_id, configuration_settings, opts = {})
1337
1400
  if @api_client.config.debugging
1338
- @api_client.config.logger.debug 'Calling API: RegistrationApi.registration_exists ...'
1401
+ @api_client.config.logger.debug "Calling API: RegistrationApi.set_registration_configuration ..."
1339
1402
  end
1340
1403
  # 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"
1343
- end
1404
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.set_registration_configuration" if registration_id.nil?
1405
+ # verify the required parameter 'configuration_settings' is set
1406
+ fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling RegistrationApi.set_registration_configuration" if configuration_settings.nil?
1344
1407
  # resource path
1345
- local_var_path = '/registrations/{registrationId}'.sub('{' + 'registrationId' + '}', registration_id.to_s)
1408
+ local_var_path = "/registrations/{registrationId}/configuration".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s)
1346
1409
 
1347
1410
  # query parameters
1348
1411
  query_params = {}
@@ -1358,48 +1421,55 @@ module RusticiSoftwareCloudV2
1358
1421
  form_params = {}
1359
1422
 
1360
1423
  # http body (model)
1361
- post_body = nil
1424
+ post_body = @api_client.object_to_http_body(configuration_settings)
1362
1425
  auth_names = ['APP_NORMAL', 'OAUTH']
1363
- data, status_code, headers = @api_client.call_api(:HEAD, local_var_path,
1426
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1364
1427
  :header_params => header_params,
1365
1428
  :query_params => query_params,
1366
1429
  :form_params => form_params,
1367
1430
  :body => post_body,
1368
1431
  :auth_names => auth_names)
1369
1432
  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}"
1433
+ @api_client.config.logger.debug "API called: RegistrationApi#set_registration_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1371
1434
  end
1372
1435
  return data, status_code, headers
1373
1436
  end
1374
- # Set configuration settings for this registration.
1437
+
1438
+ # Set configuration for instance of registration.
1439
+ # Set configuration settings for this registration instance.
1375
1440
  # @param registration_id id for this registration
1441
+ # @param instance_id The instance of this registration
1376
1442
  # @param configuration_settings
1377
1443
  # @param [Hash] opts the optional parameters
1378
1444
  # @return [nil]
1379
- def set_registration_configuration(registration_id, configuration_settings, opts = {})
1380
- set_registration_configuration_with_http_info(registration_id, configuration_settings, opts)
1381
- nil
1445
+ def set_registration_instance_configuration(registration_id, instance_id, configuration_settings, opts = {})
1446
+ set_registration_instance_configuration_with_http_info(registration_id, instance_id, configuration_settings, opts)
1447
+ return nil
1382
1448
  end
1383
1449
 
1384
- # Set configuration settings for this registration.
1450
+ # Set configuration for instance of registration.
1451
+ # Set configuration settings for this registration instance.
1385
1452
  # @param registration_id id for this registration
1453
+ # @param instance_id The instance of this registration
1386
1454
  # @param configuration_settings
1387
1455
  # @param [Hash] opts the optional parameters
1388
1456
  # @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 = {})
1457
+ def set_registration_instance_configuration_with_http_info(registration_id, instance_id, configuration_settings, opts = {})
1390
1458
  if @api_client.config.debugging
1391
- @api_client.config.logger.debug 'Calling API: RegistrationApi.set_registration_configuration ...'
1459
+ @api_client.config.logger.debug "Calling API: RegistrationApi.set_registration_instance_configuration ..."
1392
1460
  end
1393
1461
  # 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"
1462
+ fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.set_registration_instance_configuration" if registration_id.nil?
1463
+ # verify the required parameter 'instance_id' is set
1464
+ fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.set_registration_instance_configuration" if instance_id.nil?
1465
+ if instance_id < 0
1466
+ fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.set_registration_instance_configuration, must be greater than or equal to 0.'
1396
1467
  end
1468
+
1397
1469
  # 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"
1400
- end
1470
+ fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling RegistrationApi.set_registration_instance_configuration" if configuration_settings.nil?
1401
1471
  # resource path
1402
- local_var_path = '/registrations/{registrationId}/configuration'.sub('{' + 'registrationId' + '}', registration_id.to_s)
1472
+ local_var_path = "/registrations/{registrationId}/instances/{instanceId}/configuration".sub('{format}','json').sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
1403
1473
 
1404
1474
  # query parameters
1405
1475
  query_params = {}
@@ -1424,49 +1494,34 @@ module RusticiSoftwareCloudV2
1424
1494
  :body => post_body,
1425
1495
  :auth_names => auth_names)
1426
1496
  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}"
1497
+ @api_client.config.logger.debug "API called: RegistrationApi#set_registration_instance_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1428
1498
  end
1429
1499
  return data, status_code, headers
1430
1500
  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
1501
+
1502
+ # Send a test postback with a provided configuration.
1503
+ # This method will allow testing a postback configuration that you provide by sending dummy data to the url specified, with the format you specify.
1504
+ # @param post_back
1435
1505
  # @param [Hash] opts the optional parameters
1436
1506
  # @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)
1439
- nil
1507
+ def test_registration_postback(post_back, opts = {})
1508
+ test_registration_postback_with_http_info(post_back, opts)
1509
+ return nil
1440
1510
  end
1441
1511
 
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
1512
+ # Send a test postback with a provided configuration.
1513
+ # This method will allow testing a postback configuration that you provide by sending dummy data to the url specified, with the format you specify.
1514
+ # @param post_back
1446
1515
  # @param [Hash] opts the optional parameters
1447
1516
  # @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 = {})
1517
+ def test_registration_postback_with_http_info(post_back, opts = {})
1449
1518
  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"
1459
- 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"
1519
+ @api_client.config.logger.debug "Calling API: RegistrationApi.test_registration_postback ..."
1467
1520
  end
1521
+ # verify the required parameter 'post_back' is set
1522
+ fail ArgumentError, "Missing the required parameter 'post_back' when calling RegistrationApi.test_registration_postback" if post_back.nil?
1468
1523
  # resource path
1469
- local_var_path = '/registrations/{registrationId}/instances/{instanceId}/configuration'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
1524
+ local_var_path = "/registrations/postBackTest".sub('{format}','json')
1470
1525
 
1471
1526
  # query parameters
1472
1527
  query_params = {}
@@ -1482,7 +1537,7 @@ module RusticiSoftwareCloudV2
1482
1537
  form_params = {}
1483
1538
 
1484
1539
  # http body (model)
1485
- post_body = @api_client.object_to_http_body(configuration_settings)
1540
+ post_body = @api_client.object_to_http_body(post_back)
1486
1541
  auth_names = ['APP_NORMAL', 'OAUTH']
1487
1542
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1488
1543
  :header_params => header_params,
@@ -1491,7 +1546,7 @@ module RusticiSoftwareCloudV2
1491
1546
  :body => post_body,
1492
1547
  :auth_names => auth_names)
1493
1548
  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}"
1549
+ @api_client.config.logger.debug "API called: RegistrationApi#test_registration_postback\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1495
1550
  end
1496
1551
  return data, status_code, headers
1497
1552
  end