rustici_software_cloud_v2 1.1.0 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (147) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +355 -356
  4. data/lib/rustici_software_cloud_v2/api/about_api.rb +4 -4
  5. data/lib/rustici_software_cloud_v2/api/application_management_api.rb +190 -62
  6. data/lib/rustici_software_cloud_v2/api/authentication_api.rb +9 -17
  7. data/lib/rustici_software_cloud_v2/api/course_api.rb +903 -196
  8. data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +458 -268
  9. data/lib/rustici_software_cloud_v2/api/invitations_api.rb +212 -170
  10. data/lib/rustici_software_cloud_v2/api/learner_api.rb +48 -48
  11. data/lib/rustici_software_cloud_v2/api/ping_api.rb +2 -0
  12. data/lib/rustici_software_cloud_v2/api/registration_api.rb +255 -269
  13. data/lib/rustici_software_cloud_v2/api/reporting_api.rb +19 -23
  14. data/lib/rustici_software_cloud_v2/api/xapi_api.rb +81 -66
  15. data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +124 -55
  16. data/lib/rustici_software_cloud_v2/api_client.rb +2 -2
  17. data/lib/rustici_software_cloud_v2/configuration.rb +3 -3
  18. data/lib/rustici_software_cloud_v2/models/about_schema.rb +3 -1
  19. data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +8 -36
  20. data/lib/rustici_software_cloud_v2/models/application_info_schema.rb +234 -0
  21. data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +3 -1
  22. data/lib/rustici_software_cloud_v2/models/application_request_schema.rb +186 -0
  23. data/lib/rustici_software_cloud_v2/models/application_schema.rb +3 -1
  24. data/lib/rustici_software_cloud_v2/models/application_token.rb +3 -1
  25. data/lib/rustici_software_cloud_v2/models/asset_file_schema.rb +194 -0
  26. data/lib/rustici_software_cloud_v2/models/batch_tags_schema.rb +3 -1
  27. data/lib/rustici_software_cloud_v2/models/comment_schema.rb +3 -1
  28. data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +3 -1
  29. data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +5 -29
  30. data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +3 -1
  31. data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +4 -1
  32. data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +3 -1
  33. data/lib/rustici_software_cloud_v2/models/course_schema.rb +5 -29
  34. data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +2 -19
  35. data/lib/rustici_software_cloud_v2/models/create_dispatch_list_schema.rb +3 -1
  36. data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +4 -2
  37. data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +4 -2
  38. data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +4 -2
  39. data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +3 -1
  40. data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +3 -1
  41. data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +3 -1
  42. data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +3 -1
  43. data/lib/rustici_software_cloud_v2/models/credential_schema.rb +3 -1
  44. data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +3 -1
  45. data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +4 -2
  46. data/lib/rustici_software_cloud_v2/models/destination_schema.rb +3 -1
  47. data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +3 -1
  48. data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +4 -1
  49. data/lib/rustici_software_cloud_v2/models/dispatch_lti_info_schema.rb +221 -0
  50. data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +3 -1
  51. data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +43 -3
  52. data/lib/rustici_software_cloud_v2/models/enabled_schema.rb +3 -1
  53. data/lib/rustici_software_cloud_v2/models/file_list_item_schema.rb +205 -0
  54. data/lib/rustici_software_cloud_v2/models/file_list_schema.rb +187 -0
  55. data/lib/rustici_software_cloud_v2/models/import_asset_request_schema.rb +207 -0
  56. data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +29 -6
  57. data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +5 -29
  58. data/lib/rustici_software_cloud_v2/models/import_media_file_reference_request_schema.rb +216 -0
  59. data/lib/rustici_software_cloud_v2/models/import_request_schema.rb +195 -0
  60. data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +3 -1
  61. data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +3 -1
  62. data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +3 -1
  63. data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +5 -29
  64. data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +4 -1
  65. data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +3 -1
  66. data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +3 -1
  67. data/lib/rustici_software_cloud_v2/models/launch_auth_options_schema.rb +3 -1
  68. data/lib/rustici_software_cloud_v2/models/launch_auth_schema.rb +5 -29
  69. data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +3 -1
  70. data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +8 -36
  71. data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +5 -3
  72. data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +3 -1
  73. data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +3 -1
  74. data/lib/rustici_software_cloud_v2/models/learner_schema.rb +3 -1
  75. data/lib/rustici_software_cloud_v2/models/media_file_metadata_schema.rb +213 -0
  76. data/lib/rustici_software_cloud_v2/models/message_schema.rb +3 -1
  77. data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +10 -8
  78. data/lib/rustici_software_cloud_v2/models/objective_schema.rb +11 -43
  79. data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +3 -1
  80. data/lib/rustici_software_cloud_v2/models/ping_schema.rb +3 -1
  81. data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +8 -36
  82. data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +4 -1
  83. data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +5 -3
  84. data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb +215 -0
  85. data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +4 -1
  86. data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +6 -4
  87. data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +228 -0
  88. data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +4 -1
  89. data/lib/rustici_software_cloud_v2/models/registration_schema.rb +3 -1
  90. data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +3 -1
  91. data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +3 -1
  92. data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +3 -1
  93. data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +3 -1
  94. data/lib/rustici_software_cloud_v2/models/response_error.rb +3 -1
  95. data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +5 -29
  96. data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +8 -36
  97. data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +5 -29
  98. data/lib/rustici_software_cloud_v2/models/score_schema.rb +3 -1
  99. data/lib/rustici_software_cloud_v2/models/setting_item.rb +5 -29
  100. data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +3 -1
  101. data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +5 -29
  102. data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +3 -1
  103. data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +3 -1
  104. data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +3 -1
  105. data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +3 -1
  106. data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +3 -1
  107. data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +3 -1
  108. data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +3 -1
  109. data/lib/rustici_software_cloud_v2/models/title_schema.rb +3 -1
  110. data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +3 -1
  111. data/lib/rustici_software_cloud_v2/models/update_application_schema.rb +196 -0
  112. data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +15 -3
  113. data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +4 -1
  114. data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +3 -1
  115. data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +3 -1
  116. data/lib/rustici_software_cloud_v2/models/xapi_account.rb +3 -1
  117. data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +3 -1
  118. data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +3 -1
  119. data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +5 -29
  120. data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +3 -1
  121. data/lib/rustici_software_cloud_v2/models/xapi_context.rb +3 -1
  122. data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +3 -1
  123. data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +5 -29
  124. data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +5 -29
  125. data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +3 -1
  126. data/lib/rustici_software_cloud_v2/models/xapi_credential_put_schema.rb +3 -1
  127. data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +3 -1
  128. data/lib/rustici_software_cloud_v2/models/xapi_credentials_list_schema.rb +4 -1
  129. data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +3 -1
  130. data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +3 -1
  131. data/lib/rustici_software_cloud_v2/models/xapi_result.rb +3 -1
  132. data/lib/rustici_software_cloud_v2/models/xapi_score.rb +3 -1
  133. data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +3 -1
  134. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +3 -1
  135. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +3 -1
  136. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_put_schema.rb +3 -1
  137. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +3 -1
  138. data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +3 -1
  139. data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +3 -1
  140. data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +3 -1
  141. data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +3 -1
  142. data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +13 -1
  143. data/lib/rustici_software_cloud_v2/version.rb +1 -1
  144. data/lib/rustici_software_cloud_v2.rb +13 -0
  145. data/rustici_software_cloud_v2.gemspec +2 -1
  146. data/spec/api_client_spec.rb +17 -0
  147. metadata +35 -2
@@ -19,9 +19,9 @@ module RusticiSoftwareCloudV2
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Get registration launch link.
23
- # Returns the link to use to launch this registration.
24
- # @param registration_id id for this registration
22
+ # Get a launch link for a Registration
23
+ # Returns the launch link to use to launch the course for the registration. Launch links are meant as a way to provide access to your content. When a learner visits the link, the course will be launched and registration progress will start to be tracked.
24
+ # @param registration_id
25
25
  # @param launch_link_request
26
26
  # @param [Hash] opts the optional parameters
27
27
  # @return [LaunchLinkSchema]
@@ -30,9 +30,9 @@ module RusticiSoftwareCloudV2
30
30
  data
31
31
  end
32
32
 
33
- # Get registration launch link.
34
- # Returns the link to use to launch this registration.
35
- # @param registration_id id for this registration
33
+ # Get a launch link for a Registration
34
+ # Returns the launch link to use to launch the course for the registration. Launch links are meant as a way to provide access to your content. When a learner visits the link, the course will be launched and registration progress will start to be tracked.
35
+ # @param registration_id
36
36
  # @param launch_link_request
37
37
  # @param [Hash] opts the optional parameters
38
38
  # @return [Array<(LaunchLinkSchema, Fixnum, Hash)>] LaunchLinkSchema data, response status code and response headers
@@ -41,11 +41,11 @@ module RusticiSoftwareCloudV2
41
41
  @api_client.config.logger.debug 'Calling API: RegistrationApi.build_registration_launch_link ...'
42
42
  end
43
43
  # verify the required parameter 'registration_id' is set
44
- if @api_client.config.client_side_validation && registration_id.nil?
44
+ if registration_id.nil?
45
45
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.build_registration_launch_link"
46
46
  end
47
47
  # verify the required parameter 'launch_link_request' is set
48
- if @api_client.config.client_side_validation && launch_link_request.nil?
48
+ if launch_link_request.nil?
49
49
  fail ArgumentError, "Missing the required parameter 'launch_link_request' when calling RegistrationApi.build_registration_launch_link"
50
50
  end
51
51
  # resource path
@@ -79,8 +79,9 @@ module RusticiSoftwareCloudV2
79
79
  end
80
80
  return data, status_code, headers
81
81
  end
82
- # Create a new instance for this registration specified by the registration ID.
83
- # @param registration_id id for this registration
82
+ # Create a Registration Instance
83
+ # Creates a new instance of the registration. Registration instances will be automatically created when a learner launches a new version of the course. This allows for tracking registration progress for each of the versions of the course the learner has taken. When the created registration instance is \"launched\", the course specified at creation time will be launched.
84
+ # @param registration_id
84
85
  # @param [Hash] opts the optional parameters
85
86
  # @return [nil]
86
87
  def create_new_registration_instance(registration_id, opts = {})
@@ -88,8 +89,9 @@ module RusticiSoftwareCloudV2
88
89
  nil
89
90
  end
90
91
 
91
- # Create a new instance for this registration specified by the registration ID.
92
- # @param registration_id id for this registration
92
+ # Create a Registration Instance
93
+ # Creates a new instance of the registration. Registration instances will be automatically created when a learner launches a new version of the course. This allows for tracking registration progress for each of the versions of the course the learner has taken. When the created registration instance is \&quot;launched\&quot;, the course specified at creation time will be launched.
94
+ # @param registration_id
93
95
  # @param [Hash] opts the optional parameters
94
96
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
95
97
  def create_new_registration_instance_with_http_info(registration_id, opts = {})
@@ -97,7 +99,7 @@ module RusticiSoftwareCloudV2
97
99
  @api_client.config.logger.debug 'Calling API: RegistrationApi.create_new_registration_instance ...'
98
100
  end
99
101
  # verify the required parameter 'registration_id' is set
100
- if @api_client.config.client_side_validation && registration_id.nil?
102
+ if registration_id.nil?
101
103
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.create_new_registration_instance"
102
104
  end
103
105
  # resource path
@@ -130,29 +132,29 @@ module RusticiSoftwareCloudV2
130
132
  end
131
133
  return data, status_code, headers
132
134
  end
133
- # Create a registration.
134
- # 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.
135
+ # Create a Registration
136
+ # Creates a new registration. Registrations are the billable unit in SCORM Cloud, and represent a link between a learner and a course. A registration will contain a few pieces of information such as learner identifiers, the id of the course being registered for, and several other optional fields. A registration must be tied to a specific course at creation time. When the created registration is \"launched\", the course specified at creation time will be launched.
135
137
  # @param registration
136
138
  # @param [Hash] opts the optional parameters
137
- # @option opts [Integer] :course_version The version of the course you want to create the registration for. Unless you have a reason for using this you probably do not need to.
139
+ # @option opts [Integer] :course_version Unless you have a reason for using this you probably do not need to.
138
140
  # @return [nil]
139
141
  def create_registration(registration, opts = {})
140
142
  create_registration_with_http_info(registration, opts)
141
143
  nil
142
144
  end
143
145
 
144
- # Create a registration.
145
- # 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.
146
+ # Create a Registration
147
+ # Creates a new registration. Registrations are the billable unit in SCORM Cloud, and represent a link between a learner and a course. A registration will contain a few pieces of information such as learner identifiers, the id of the course being registered for, and several other optional fields. A registration must be tied to a specific course at creation time. When the created registration is \&quot;launched\&quot;, the course specified at creation time will be launched.
146
148
  # @param registration
147
149
  # @param [Hash] opts the optional parameters
148
- # @option opts [Integer] :course_version The version of the course you want to create the registration for. Unless you have a reason for using this you probably do not need to.
150
+ # @option opts [Integer] :course_version Unless you have a reason for using this you probably do not need to.
149
151
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
150
152
  def create_registration_with_http_info(registration, opts = {})
151
153
  if @api_client.config.debugging
152
154
  @api_client.config.logger.debug 'Calling API: RegistrationApi.create_registration ...'
153
155
  end
154
156
  # verify the required parameter 'registration' is set
155
- if @api_client.config.client_side_validation && registration.nil?
157
+ if registration.nil?
156
158
  fail ArgumentError, "Missing the required parameter 'registration' when calling RegistrationApi.create_registration"
157
159
  end
158
160
  # resource path
@@ -186,9 +188,9 @@ module RusticiSoftwareCloudV2
186
188
  end
187
189
  return data, status_code, headers
188
190
  end
189
- # Delete a registration.
190
- # Delete `registrationId`. This includes all instances of this registration.
191
- # @param registration_id id for this registration
191
+ # Delete a Registration
192
+ # Deletes the specified registration. >**Caution:** >This will also delete all instances of the registration.
193
+ # @param registration_id
192
194
  # @param [Hash] opts the optional parameters
193
195
  # @return [nil]
194
196
  def delete_registration(registration_id, opts = {})
@@ -196,9 +198,9 @@ module RusticiSoftwareCloudV2
196
198
  nil
197
199
  end
198
200
 
199
- # Delete a registration.
200
- # Delete &#x60;registrationId&#x60;. This includes all instances of this registration.
201
- # @param registration_id id for this registration
201
+ # Delete a Registration
202
+ # Deletes the specified registration. &gt;**Caution:** &gt;This will also delete all instances of the registration.
203
+ # @param registration_id
202
204
  # @param [Hash] opts the optional parameters
203
205
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
204
206
  def delete_registration_with_http_info(registration_id, opts = {})
@@ -206,7 +208,7 @@ module RusticiSoftwareCloudV2
206
208
  @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration ...'
207
209
  end
208
210
  # verify the required parameter 'registration_id' is set
209
- if @api_client.config.client_side_validation && registration_id.nil?
211
+ if registration_id.nil?
210
212
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration"
211
213
  end
212
214
  # resource path
@@ -239,9 +241,9 @@ module RusticiSoftwareCloudV2
239
241
  end
240
242
  return data, status_code, headers
241
243
  end
242
- # Clear a registration configuration.
243
- # 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.
244
- # @param registration_id id for this registration
244
+ # Delete a configuration setting explicitly set for a Registration
245
+ # Clears the specified setting from the registration. This causes the setting to inherit a value from a higher level (e.g. course). If the configuration setting was not set at the registration level it will continue to persist and will require deletion from the level it was set.
246
+ # @param registration_id
245
247
  # @param setting_id
246
248
  # @param [Hash] opts the optional parameters
247
249
  # @return [nil]
@@ -250,9 +252,9 @@ module RusticiSoftwareCloudV2
250
252
  nil
251
253
  end
252
254
 
253
- # Clear a registration configuration.
254
- # 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.
255
- # @param registration_id id for this registration
255
+ # Delete a configuration setting explicitly set for a Registration
256
+ # Clears the specified setting from the registration. This causes the setting to inherit a value from a higher level (e.g. course). If the configuration setting was not set at the registration level it will continue to persist and will require deletion from the level it was set.
257
+ # @param registration_id
256
258
  # @param setting_id
257
259
  # @param [Hash] opts the optional parameters
258
260
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -261,11 +263,11 @@ module RusticiSoftwareCloudV2
261
263
  @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_configuration_setting ...'
262
264
  end
263
265
  # verify the required parameter 'registration_id' is set
264
- if @api_client.config.client_side_validation && registration_id.nil?
266
+ if registration_id.nil?
265
267
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_configuration_setting"
266
268
  end
267
269
  # verify the required parameter 'setting_id' is set
268
- if @api_client.config.client_side_validation && setting_id.nil?
270
+ if setting_id.nil?
269
271
  fail ArgumentError, "Missing the required parameter 'setting_id' when calling RegistrationApi.delete_registration_configuration_setting"
270
272
  end
271
273
  # resource path
@@ -298,9 +300,9 @@ module RusticiSoftwareCloudV2
298
300
  end
299
301
  return data, status_code, headers
300
302
  end
301
- # Delete the global data of a registration.
302
- # Delete global data associated with `registrationId`'. Calling this method will reset all global objectives associated with this registration, if any exist.
303
- # @param registration_id id for this registration
303
+ # Reset global data for a Registration
304
+ # Deletes the global data associated with the registration, but the registration itself will remain. This means any progress towards the global objectives will be removed.
305
+ # @param registration_id
304
306
  # @param [Hash] opts the optional parameters
305
307
  # @return [nil]
306
308
  def delete_registration_global_data(registration_id, opts = {})
@@ -308,9 +310,9 @@ module RusticiSoftwareCloudV2
308
310
  nil
309
311
  end
310
312
 
311
- # Delete the global data of a registration.
312
- # Delete global data associated with &#x60;registrationId&#x60;&#39;. Calling this method will reset all global objectives associated with this registration, if any exist.
313
- # @param registration_id id for this registration
313
+ # Reset global data for a Registration
314
+ # Deletes the global data associated with the registration, but the registration itself will remain. This means any progress towards the global objectives will be removed.
315
+ # @param registration_id
314
316
  # @param [Hash] opts the optional parameters
315
317
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
316
318
  def delete_registration_global_data_with_http_info(registration_id, opts = {})
@@ -318,7 +320,7 @@ module RusticiSoftwareCloudV2
318
320
  @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_global_data ...'
319
321
  end
320
322
  # verify the required parameter 'registration_id' is set
321
- if @api_client.config.client_side_validation && registration_id.nil?
323
+ if registration_id.nil?
322
324
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_global_data"
323
325
  end
324
326
  # resource path
@@ -351,10 +353,10 @@ module RusticiSoftwareCloudV2
351
353
  end
352
354
  return data, status_code, headers
353
355
  end
354
- # Delete instance `instanceId` of `registrationId`.
355
- # Delete instance `instanceId` of `registrationId`. If this is the only existing instance of this registration, the registration will be deleted in its entirety along with any associated data.
356
- # @param registration_id id for this registration
357
- # @param instance_id The instance of this registration
356
+ # Delete a Registration Instance
357
+ # Deletes the specified instance of the registration. If deleting the last remaining instance of the registration, the registration itself will be deleted along with any associated data.
358
+ # @param registration_id
359
+ # @param instance_id
358
360
  # @param [Hash] opts the optional parameters
359
361
  # @return [nil]
360
362
  def delete_registration_instance(registration_id, instance_id, opts = {})
@@ -362,10 +364,10 @@ module RusticiSoftwareCloudV2
362
364
  nil
363
365
  end
364
366
 
365
- # Delete instance &#x60;instanceId&#x60; of &#x60;registrationId&#x60;.
366
- # Delete instance &#x60;instanceId&#x60; of &#x60;registrationId&#x60;. If this is the only existing instance of this registration, the registration will be deleted in its entirety along with any associated data.
367
- # @param registration_id id for this registration
368
- # @param instance_id The instance of this registration
367
+ # Delete a Registration Instance
368
+ # Deletes the specified instance of the registration. If deleting the last remaining instance of the registration, the registration itself will be deleted along with any associated data.
369
+ # @param registration_id
370
+ # @param instance_id
369
371
  # @param [Hash] opts the optional parameters
370
372
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
371
373
  def delete_registration_instance_with_http_info(registration_id, instance_id, opts = {})
@@ -373,17 +375,13 @@ module RusticiSoftwareCloudV2
373
375
  @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_instance ...'
374
376
  end
375
377
  # verify the required parameter 'registration_id' is set
376
- if @api_client.config.client_side_validation && registration_id.nil?
378
+ if registration_id.nil?
377
379
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_instance"
378
380
  end
379
381
  # verify the required parameter 'instance_id' is set
380
- if @api_client.config.client_side_validation && instance_id.nil?
382
+ if instance_id.nil?
381
383
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.delete_registration_instance"
382
384
  end
383
- if @api_client.config.client_side_validation && instance_id < 0
384
- fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.delete_registration_instance, must be greater than or equal to 0.'
385
- end
386
-
387
385
  # resource path
388
386
  local_var_path = '/registrations/{registrationId}/instances/{instanceId}'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
389
387
 
@@ -414,10 +412,10 @@ module RusticiSoftwareCloudV2
414
412
  end
415
413
  return data, status_code, headers
416
414
  end
417
- # Clear a configuration for an instance of a registration.
418
- # Clears the `settingId` value for this registration instance.
419
- # @param registration_id id for this registration
420
- # @param instance_id The instance of this registration
415
+ # Delete a configuration setting explicitly set for a Registration Instance
416
+ # Clears the specified setting from the registration instance. This causes the setting to inherit a value from a higher level (e.g. course). If the configuration setting was not set at the registration level it will continue to persist and will require deletion from the level it was set.
417
+ # @param registration_id
418
+ # @param instance_id
421
419
  # @param setting_id
422
420
  # @param [Hash] opts the optional parameters
423
421
  # @return [nil]
@@ -426,10 +424,10 @@ module RusticiSoftwareCloudV2
426
424
  nil
427
425
  end
428
426
 
429
- # Clear a configuration for an instance of a registration.
430
- # Clears the &#x60;settingId&#x60; value for this registration instance.
431
- # @param registration_id id for this registration
432
- # @param instance_id The instance of this registration
427
+ # Delete a configuration setting explicitly set for a Registration Instance
428
+ # Clears the specified setting from the registration instance. This causes the setting to inherit a value from a higher level (e.g. course). If the configuration setting was not set at the registration level it will continue to persist and will require deletion from the level it was set.
429
+ # @param registration_id
430
+ # @param instance_id
433
431
  # @param setting_id
434
432
  # @param [Hash] opts the optional parameters
435
433
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -438,19 +436,15 @@ module RusticiSoftwareCloudV2
438
436
  @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_instance_configuration_setting ...'
439
437
  end
440
438
  # verify the required parameter 'registration_id' is set
441
- if @api_client.config.client_side_validation && registration_id.nil?
439
+ if registration_id.nil?
442
440
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_instance_configuration_setting"
443
441
  end
444
442
  # verify the required parameter 'instance_id' is set
445
- if @api_client.config.client_side_validation && instance_id.nil?
443
+ if instance_id.nil?
446
444
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.delete_registration_instance_configuration_setting"
447
445
  end
448
- if @api_client.config.client_side_validation && instance_id < 0
449
- fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.delete_registration_instance_configuration_setting, must be greater than or equal to 0.'
450
- end
451
-
452
446
  # verify the required parameter 'setting_id' is set
453
- if @api_client.config.client_side_validation && setting_id.nil?
447
+ if setting_id.nil?
454
448
  fail ArgumentError, "Missing the required parameter 'setting_id' when calling RegistrationApi.delete_registration_instance_configuration_setting"
455
449
  end
456
450
  # resource path
@@ -483,9 +477,9 @@ module RusticiSoftwareCloudV2
483
477
  end
484
478
  return data, status_code, headers
485
479
  end
486
- # Reset a registration.
487
- # 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.
488
- # @param registration_id id for this registration
480
+ # Reset a Registration
481
+ # Deletes the data associated with the registration, but the registration itself will remain. This means any of the launch history, and progress will be removed. After the data has been deleted, the registration will automatically register itself for the latest version of the course.
482
+ # @param registration_id
489
483
  # @param [Hash] opts the optional parameters
490
484
  # @return [nil]
491
485
  def delete_registration_progress(registration_id, opts = {})
@@ -493,9 +487,9 @@ module RusticiSoftwareCloudV2
493
487
  nil
494
488
  end
495
489
 
496
- # Reset a registration.
497
- # 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.
498
- # @param registration_id id for this registration
490
+ # Reset a Registration
491
+ # Deletes the data associated with the registration, but the registration itself will remain. This means any of the launch history, and progress will be removed. After the data has been deleted, the registration will automatically register itself for the latest version of the course.
492
+ # @param registration_id
499
493
  # @param [Hash] opts the optional parameters
500
494
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
501
495
  def delete_registration_progress_with_http_info(registration_id, opts = {})
@@ -503,7 +497,7 @@ module RusticiSoftwareCloudV2
503
497
  @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_progress ...'
504
498
  end
505
499
  # verify the required parameter 'registration_id' is set
506
- if @api_client.config.client_side_validation && registration_id.nil?
500
+ if registration_id.nil?
507
501
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_progress"
508
502
  end
509
503
  # resource path
@@ -536,9 +530,9 @@ module RusticiSoftwareCloudV2
536
530
  end
537
531
  return data, status_code, headers
538
532
  end
539
- # Delete tags from a registration.
540
- # Delete the provided tags for this registration.
541
- # @param registration_id id for this registration
533
+ # Delete tags from a Registration
534
+ # Deletes the specified tags from the registration. Deleting tags that do not exist will still result in a success.
535
+ # @param registration_id
542
536
  # @param tags
543
537
  # @param [Hash] opts the optional parameters
544
538
  # @return [nil]
@@ -547,9 +541,9 @@ module RusticiSoftwareCloudV2
547
541
  nil
548
542
  end
549
543
 
550
- # Delete tags from a registration.
551
- # Delete the provided tags for this registration.
552
- # @param registration_id id for this registration
544
+ # Delete tags from a Registration
545
+ # Deletes the specified tags from the registration. Deleting tags that do not exist will still result in a success.
546
+ # @param registration_id
553
547
  # @param tags
554
548
  # @param [Hash] opts the optional parameters
555
549
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -558,11 +552,11 @@ module RusticiSoftwareCloudV2
558
552
  @api_client.config.logger.debug 'Calling API: RegistrationApi.delete_registration_tags ...'
559
553
  end
560
554
  # verify the required parameter 'registration_id' is set
561
- if @api_client.config.client_side_validation && registration_id.nil?
555
+ if registration_id.nil?
562
556
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.delete_registration_tags"
563
557
  end
564
558
  # verify the required parameter 'tags' is set
565
- if @api_client.config.client_side_validation && tags.nil?
559
+ if tags.nil?
566
560
  fail ArgumentError, "Missing the required parameter 'tags' when calling RegistrationApi.delete_registration_tags"
567
561
  end
568
562
  # resource path
@@ -595,9 +589,9 @@ module RusticiSoftwareCloudV2
595
589
  end
596
590
  return data, status_code, headers
597
591
  end
598
- # See if a registration exists.
599
- # This method is meant to check if a registration with `registrationId` exists in the system.
600
- # @param registration_id id for this registration
592
+ # Check that a Registration exists
593
+ # Checks that the registration exists within SCORM Cloud. >**Info:** >No registration data will be returned for this call. A successful `200` response indicates that the registration exists. If the registration does not exist, a `404` error will be returned instead. If you are looking for information about the registration, try calling `GetRegistrationProgress` instead.
594
+ # @param registration_id
601
595
  # @param [Hash] opts the optional parameters
602
596
  # @return [nil]
603
597
  def get_registration(registration_id, opts = {})
@@ -605,9 +599,9 @@ module RusticiSoftwareCloudV2
605
599
  nil
606
600
  end
607
601
 
608
- # See if a registration exists.
609
- # This method is meant to check if a registration with &#x60;registrationId&#x60; exists in the system.
610
- # @param registration_id id for this registration
602
+ # Check that a Registration exists
603
+ # Checks that the registration exists within SCORM Cloud. &gt;**Info:** &gt;No registration data will be returned for this call. A successful &#x60;200&#x60; response indicates that the registration exists. If the registration does not exist, a &#x60;404&#x60; error will be returned instead. If you are looking for information about the registration, try calling &#x60;GetRegistrationProgress&#x60; instead.
604
+ # @param registration_id
611
605
  # @param [Hash] opts the optional parameters
612
606
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
613
607
  def get_registration_with_http_info(registration_id, opts = {})
@@ -615,7 +609,7 @@ module RusticiSoftwareCloudV2
615
609
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration ...'
616
610
  end
617
611
  # verify the required parameter 'registration_id' is set
618
- if @api_client.config.client_side_validation && registration_id.nil?
612
+ if registration_id.nil?
619
613
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration"
620
614
  end
621
615
  # resource path
@@ -648,9 +642,9 @@ module RusticiSoftwareCloudV2
648
642
  end
649
643
  return data, status_code, headers
650
644
  end
651
- # Get registration configuration.
652
- # Returns all configuration settings for this registration.
653
- # @param registration_id id for this registration
645
+ # Get effective configuration settings for a Registration
646
+ # Returns the effective configuration settings for the registration. If not set at the registration level, the setting will inherit a value from a higher level (e.g. course). Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
647
+ # @param registration_id
654
648
  # @param [Hash] opts the optional parameters
655
649
  # @option opts [BOOLEAN] :include_metadata (default to false)
656
650
  # @return [SettingListSchema]
@@ -659,9 +653,9 @@ module RusticiSoftwareCloudV2
659
653
  data
660
654
  end
661
655
 
662
- # Get registration configuration.
663
- # Returns all configuration settings for this registration.
664
- # @param registration_id id for this registration
656
+ # Get effective configuration settings for a Registration
657
+ # Returns the effective configuration settings for the registration. If not set at the registration level, the setting will inherit a value from a higher level (e.g. course). Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
658
+ # @param registration_id
665
659
  # @param [Hash] opts the optional parameters
666
660
  # @option opts [BOOLEAN] :include_metadata
667
661
  # @return [Array<(SettingListSchema, Fixnum, Hash)>] SettingListSchema data, response status code and response headers
@@ -670,7 +664,7 @@ module RusticiSoftwareCloudV2
670
664
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_configuration ...'
671
665
  end
672
666
  # verify the required parameter 'registration_id' is set
673
- if @api_client.config.client_side_validation && registration_id.nil?
667
+ if registration_id.nil?
674
668
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_configuration"
675
669
  end
676
670
  # resource path
@@ -705,10 +699,10 @@ module RusticiSoftwareCloudV2
705
699
  end
706
700
  return data, status_code, headers
707
701
  end
708
- # Get configuration for instance of registration.
709
- # Returns all configuration settings for this registration instance.
710
- # @param registration_id id for this registration
711
- # @param instance_id The instance of this registration
702
+ # Get effective configuration settings for a Registration Instance
703
+ # Returns the effective configuration settings for the registration instance. If not set at the registration level, the setting will inherit a value from a higher level (e.g. course). Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
704
+ # @param registration_id
705
+ # @param instance_id
712
706
  # @param [Hash] opts the optional parameters
713
707
  # @option opts [BOOLEAN] :include_metadata (default to false)
714
708
  # @return [SettingListSchema]
@@ -717,10 +711,10 @@ module RusticiSoftwareCloudV2
717
711
  data
718
712
  end
719
713
 
720
- # Get configuration for instance of registration.
721
- # Returns all configuration settings for this registration instance.
722
- # @param registration_id id for this registration
723
- # @param instance_id The instance of this registration
714
+ # Get effective configuration settings for a Registration Instance
715
+ # Returns the effective configuration settings for the registration instance. If not set at the registration level, the setting will inherit a value from a higher level (e.g. course). Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
716
+ # @param registration_id
717
+ # @param instance_id
724
718
  # @param [Hash] opts the optional parameters
725
719
  # @option opts [BOOLEAN] :include_metadata
726
720
  # @return [Array<(SettingListSchema, Fixnum, Hash)>] SettingListSchema data, response status code and response headers
@@ -729,17 +723,13 @@ module RusticiSoftwareCloudV2
729
723
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_configuration ...'
730
724
  end
731
725
  # verify the required parameter 'registration_id' is set
732
- if @api_client.config.client_side_validation && registration_id.nil?
726
+ if registration_id.nil?
733
727
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_configuration"
734
728
  end
735
729
  # verify the required parameter 'instance_id' is set
736
- if @api_client.config.client_side_validation && instance_id.nil?
730
+ if instance_id.nil?
737
731
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_configuration"
738
732
  end
739
- if @api_client.config.client_side_validation && instance_id < 0
740
- fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_configuration, must be greater than or equal to 0.'
741
- end
742
-
743
733
  # resource path
744
734
  local_var_path = '/registrations/{registrationId}/instances/{instanceId}/configuration'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
745
735
 
@@ -772,10 +762,10 @@ module RusticiSoftwareCloudV2
772
762
  end
773
763
  return data, status_code, headers
774
764
  end
775
- # Get launch history for an instance of a registration.
776
- # Returns history of the launches of the specified instance of this registration.
777
- # @param registration_id id for this registration
778
- # @param instance_id The instance of this registration
765
+ # Get launch history for a Registration Instance
766
+ # Returns the launch history of the registration instance. This includes completion status, time taken, and pass/fail status.
767
+ # @param registration_id
768
+ # @param instance_id
779
769
  # @param [Hash] opts the optional parameters
780
770
  # @option opts [BOOLEAN] :include_history_log Whether to include the history log in the launch history (default to false)
781
771
  # @return [LaunchHistoryListSchema]
@@ -784,10 +774,10 @@ module RusticiSoftwareCloudV2
784
774
  data
785
775
  end
786
776
 
787
- # Get launch history for an instance of a registration.
788
- # Returns history of the launches of the specified instance of this registration.
789
- # @param registration_id id for this registration
790
- # @param instance_id The instance of this registration
777
+ # Get launch history for a Registration Instance
778
+ # Returns the launch history of the registration instance. This includes completion status, time taken, and pass/fail status.
779
+ # @param registration_id
780
+ # @param instance_id
791
781
  # @param [Hash] opts the optional parameters
792
782
  # @option opts [BOOLEAN] :include_history_log Whether to include the history log in the launch history
793
783
  # @return [Array<(LaunchHistoryListSchema, Fixnum, Hash)>] LaunchHistoryListSchema data, response status code and response headers
@@ -796,17 +786,13 @@ module RusticiSoftwareCloudV2
796
786
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_launch_history ...'
797
787
  end
798
788
  # verify the required parameter 'registration_id' is set
799
- if @api_client.config.client_side_validation && registration_id.nil?
789
+ if registration_id.nil?
800
790
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_launch_history"
801
791
  end
802
792
  # verify the required parameter 'instance_id' is set
803
- if @api_client.config.client_side_validation && instance_id.nil?
793
+ if instance_id.nil?
804
794
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_launch_history"
805
795
  end
806
- if @api_client.config.client_side_validation && instance_id < 0
807
- fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_launch_history, must be greater than or equal to 0.'
808
- end
809
-
810
796
  # resource path
811
797
  local_var_path = '/registrations/{registrationId}/instances/{instanceId}/launchHistory'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
812
798
 
@@ -839,10 +825,10 @@ module RusticiSoftwareCloudV2
839
825
  end
840
826
  return data, status_code, headers
841
827
  end
842
- # Get details of an instance of a registration.
843
- # Get registration progress for instance `instanceId` of `registrationId`'
844
- # @param registration_id id for this registration
845
- # @param instance_id The instance of this registration
828
+ # Get detailed information about a Registration Instance
829
+ # Returns detailed information about the registration instance. This includes completion status, time taken, score, and pass/fail status.
830
+ # @param registration_id
831
+ # @param instance_id
846
832
  # @param [Hash] opts the optional parameters
847
833
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results (default to false)
848
834
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results (default to false)
@@ -853,10 +839,10 @@ module RusticiSoftwareCloudV2
853
839
  data
854
840
  end
855
841
 
856
- # Get details of an instance of a registration.
857
- # Get registration progress for instance &#x60;instanceId&#x60; of &#x60;registrationId&#x60;&#39;
858
- # @param registration_id id for this registration
859
- # @param instance_id The instance of this registration
842
+ # Get detailed information about a Registration Instance
843
+ # Returns detailed information about the registration instance. This includes completion status, time taken, score, and pass/fail status.
844
+ # @param registration_id
845
+ # @param instance_id
860
846
  # @param [Hash] opts the optional parameters
861
847
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results
862
848
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results
@@ -867,17 +853,13 @@ module RusticiSoftwareCloudV2
867
853
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_progress ...'
868
854
  end
869
855
  # verify the required parameter 'registration_id' is set
870
- if @api_client.config.client_side_validation && registration_id.nil?
856
+ if registration_id.nil?
871
857
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_progress"
872
858
  end
873
859
  # verify the required parameter 'instance_id' is set
874
- if @api_client.config.client_side_validation && instance_id.nil?
860
+ if instance_id.nil?
875
861
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_progress"
876
862
  end
877
- if @api_client.config.client_side_validation && instance_id < 0
878
- fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_progress, must be greater than or equal to 0.'
879
- end
880
-
881
863
  # resource path
882
864
  local_var_path = '/registrations/{registrationId}/instances/{instanceId}'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
883
865
 
@@ -912,45 +894,41 @@ module RusticiSoftwareCloudV2
912
894
  end
913
895
  return data, status_code, headers
914
896
  end
915
- # Get xAPI statements for an instance of a registration.
916
- # Get xAPI statements for instance `instanceId` of `registrationId`.
917
- # @param registration_id id for this registration
918
- # @param instance_id The instance of this registration
897
+ # Get xAPI statements for a Registration Instance
898
+ # Returns xAPI statements for the registration instance.
899
+ # @param registration_id
900
+ # @param instance_id
919
901
  # @param [Hash] opts the optional parameters
920
- # @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.
921
- # @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.
922
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
902
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
903
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
904
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
923
905
  # @return [XapiStatementResult]
924
906
  def get_registration_instance_statements(registration_id, instance_id, opts = {})
925
907
  data, _status_code, _headers = get_registration_instance_statements_with_http_info(registration_id, instance_id, opts)
926
908
  data
927
909
  end
928
910
 
929
- # Get xAPI statements for an instance of a registration.
930
- # Get xAPI statements for instance &#x60;instanceId&#x60; of &#x60;registrationId&#x60;.
931
- # @param registration_id id for this registration
932
- # @param instance_id The instance of this registration
911
+ # Get xAPI statements for a Registration Instance
912
+ # Returns xAPI statements for the registration instance.
913
+ # @param registration_id
914
+ # @param instance_id
933
915
  # @param [Hash] opts the optional parameters
934
- # @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.
935
- # @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.
936
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
916
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
917
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
918
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
937
919
  # @return [Array<(XapiStatementResult, Fixnum, Hash)>] XapiStatementResult data, response status code and response headers
938
920
  def get_registration_instance_statements_with_http_info(registration_id, instance_id, opts = {})
939
921
  if @api_client.config.debugging
940
922
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instance_statements ...'
941
923
  end
942
924
  # verify the required parameter 'registration_id' is set
943
- if @api_client.config.client_side_validation && registration_id.nil?
925
+ if registration_id.nil?
944
926
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instance_statements"
945
927
  end
946
928
  # verify the required parameter 'instance_id' is set
947
- if @api_client.config.client_side_validation && instance_id.nil?
929
+ if instance_id.nil?
948
930
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.get_registration_instance_statements"
949
931
  end
950
- if @api_client.config.client_side_validation && instance_id < 0
951
- fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.get_registration_instance_statements, must be greater than or equal to 0.'
952
- end
953
-
954
932
  # resource path
955
933
  local_var_path = '/registrations/{registrationId}/instances/{instanceId}/xAPIStatements'.sub('{' + 'registrationId' + '}', registration_id.to_s).sub('{' + 'instanceId' + '}', instance_id.to_s)
956
934
 
@@ -985,13 +963,13 @@ module RusticiSoftwareCloudV2
985
963
  end
986
964
  return data, status_code, headers
987
965
  end
988
- # Get all instances of a registration.
989
- # Get all the instances of this the registration specified by the registration ID
990
- # @param registration_id id for this registration
966
+ # Get a list of a Registration's Instances
967
+ # Returns information about all instances of the registration. This can be useful to see information such as registration progress across versions of a course.
968
+ # @param registration_id
991
969
  # @param [Hash] opts the optional parameters
992
- # @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.
993
- # @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.
994
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
970
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
971
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
972
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
995
973
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results (default to false)
996
974
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results (default to false)
997
975
  # @option opts [BOOLEAN] :include_runtime Include runtime details in the results (default to false)
@@ -1001,13 +979,13 @@ module RusticiSoftwareCloudV2
1001
979
  data
1002
980
  end
1003
981
 
1004
- # Get all instances of a registration.
1005
- # Get all the instances of this the registration specified by the registration ID
1006
- # @param registration_id id for this registration
982
+ # Get a list of a Registration&#39;s Instances
983
+ # Returns information about all instances of the registration. This can be useful to see information such as registration progress across versions of a course.
984
+ # @param registration_id
1007
985
  # @param [Hash] opts the optional parameters
1008
- # @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.
1009
- # @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.
1010
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
986
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
987
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
988
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
1011
989
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results
1012
990
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results
1013
991
  # @option opts [BOOLEAN] :include_runtime Include runtime details in the results
@@ -1017,7 +995,7 @@ module RusticiSoftwareCloudV2
1017
995
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_instances ...'
1018
996
  end
1019
997
  # verify the required parameter 'registration_id' is set
1020
- if @api_client.config.client_side_validation && registration_id.nil?
998
+ if registration_id.nil?
1021
999
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_instances"
1022
1000
  end
1023
1001
  # resource path
@@ -1057,9 +1035,9 @@ module RusticiSoftwareCloudV2
1057
1035
  end
1058
1036
  return data, status_code, headers
1059
1037
  end
1060
- # Get launch history for a registration.
1061
- # Returns history of this registration's launches.
1062
- # @param registration_id id for this registration
1038
+ # Get launch history for a Registration
1039
+ # Returns the launch history of the registration. This includes completion status, time taken, and pass/fail status.
1040
+ # @param registration_id
1063
1041
  # @param [Hash] opts the optional parameters
1064
1042
  # @option opts [BOOLEAN] :include_history_log Whether to include the history log in the launch history (default to false)
1065
1043
  # @return [LaunchHistoryListSchema]
@@ -1068,9 +1046,9 @@ module RusticiSoftwareCloudV2
1068
1046
  data
1069
1047
  end
1070
1048
 
1071
- # Get launch history for a registration.
1072
- # Returns history of this registration&#39;s launches.
1073
- # @param registration_id id for this registration
1049
+ # Get launch history for a Registration
1050
+ # Returns the launch history of the registration. This includes completion status, time taken, and pass/fail status.
1051
+ # @param registration_id
1074
1052
  # @param [Hash] opts the optional parameters
1075
1053
  # @option opts [BOOLEAN] :include_history_log Whether to include the history log in the launch history
1076
1054
  # @return [Array<(LaunchHistoryListSchema, Fixnum, Hash)>] LaunchHistoryListSchema data, response status code and response headers
@@ -1079,7 +1057,7 @@ module RusticiSoftwareCloudV2
1079
1057
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_launch_history ...'
1080
1058
  end
1081
1059
  # verify the required parameter 'registration_id' is set
1082
- if @api_client.config.client_side_validation && registration_id.nil?
1060
+ if registration_id.nil?
1083
1061
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_launch_history"
1084
1062
  end
1085
1063
  # resource path
@@ -1114,9 +1092,9 @@ module RusticiSoftwareCloudV2
1114
1092
  end
1115
1093
  return data, status_code, headers
1116
1094
  end
1117
- # Get details of a registration.
1118
- # Get detailed information about the latest instance of `registrationId`. Additional detail may be obtained by using the optional query parameters.
1119
- # @param registration_id id for this registration
1095
+ # Get detailed information about a Registration
1096
+ # Returns detailed information about the registration. This includes completion status, time taken, score, and pass/fail status. >**Info:** >If you find yourself making multiple calls to this endpoint, it may be worthwhile to utilize our [postback mechanism](https://cloud.scorm.com/docs/v2/guides/postback/) instead. The main premise is that you would set up an endpoint on your end, and when we detect a change to the registration progress: completion status, time taken, score, or pass/fail status, we would send a message to your system with the registration progress.
1097
+ # @param registration_id
1120
1098
  # @param [Hash] opts the optional parameters
1121
1099
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results (default to false)
1122
1100
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results (default to false)
@@ -1127,9 +1105,9 @@ module RusticiSoftwareCloudV2
1127
1105
  data
1128
1106
  end
1129
1107
 
1130
- # Get details of a registration.
1131
- # Get detailed information about the latest instance of &#x60;registrationId&#x60;. Additional detail may be obtained by using the optional query parameters.
1132
- # @param registration_id id for this registration
1108
+ # Get detailed information about a Registration
1109
+ # Returns detailed information about the registration. This includes completion status, time taken, score, and pass/fail status. &gt;**Info:** &gt;If you find yourself making multiple calls to this endpoint, it may be worthwhile to utilize our [postback mechanism](https://cloud.scorm.com/docs/v2/guides/postback/) instead. The main premise is that you would set up an endpoint on your end, and when we detect a change to the registration progress: completion status, time taken, score, or pass/fail status, we would send a message to your system with the registration progress.
1110
+ # @param registration_id
1133
1111
  # @param [Hash] opts the optional parameters
1134
1112
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results
1135
1113
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results
@@ -1140,7 +1118,7 @@ module RusticiSoftwareCloudV2
1140
1118
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_progress ...'
1141
1119
  end
1142
1120
  # verify the required parameter 'registration_id' is set
1143
- if @api_client.config.client_side_validation && registration_id.nil?
1121
+ if registration_id.nil?
1144
1122
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_progress"
1145
1123
  end
1146
1124
  # resource path
@@ -1177,33 +1155,33 @@ module RusticiSoftwareCloudV2
1177
1155
  end
1178
1156
  return data, status_code, headers
1179
1157
  end
1180
- # Get xAPI statements for a registration.
1181
- # Get xAPI statements for `registrationId`.
1182
- # @param registration_id id for this registration
1158
+ # Get xAPI statements for a Registration
1159
+ # Returns xAPI statements for the registration.
1160
+ # @param registration_id
1183
1161
  # @param [Hash] opts the optional parameters
1184
- # @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.
1185
- # @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.
1186
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
1162
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1163
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1164
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
1187
1165
  # @return [XapiStatementResult]
1188
1166
  def get_registration_statements(registration_id, opts = {})
1189
1167
  data, _status_code, _headers = get_registration_statements_with_http_info(registration_id, opts)
1190
1168
  data
1191
1169
  end
1192
1170
 
1193
- # Get xAPI statements for a registration.
1194
- # Get xAPI statements for &#x60;registrationId&#x60;.
1195
- # @param registration_id id for this registration
1171
+ # Get xAPI statements for a Registration
1172
+ # Returns xAPI statements for the registration.
1173
+ # @param registration_id
1196
1174
  # @param [Hash] opts the optional parameters
1197
- # @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.
1198
- # @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.
1199
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
1175
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1176
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1177
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
1200
1178
  # @return [Array<(XapiStatementResult, Fixnum, Hash)>] XapiStatementResult data, response status code and response headers
1201
1179
  def get_registration_statements_with_http_info(registration_id, opts = {})
1202
1180
  if @api_client.config.debugging
1203
1181
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_statements ...'
1204
1182
  end
1205
1183
  # verify the required parameter 'registration_id' is set
1206
- if @api_client.config.client_side_validation && registration_id.nil?
1184
+ if registration_id.nil?
1207
1185
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_statements"
1208
1186
  end
1209
1187
  # resource path
@@ -1240,9 +1218,9 @@ module RusticiSoftwareCloudV2
1240
1218
  end
1241
1219
  return data, status_code, headers
1242
1220
  end
1243
- # Get tags for a registration.
1244
- # Get a list of the tags applied to this registration.
1245
- # @param registration_id id for this registration
1221
+ # Get tags for a Registration
1222
+ # Returns the tags for the registration.
1223
+ # @param registration_id
1246
1224
  # @param [Hash] opts the optional parameters
1247
1225
  # @return [TagListSchema]
1248
1226
  def get_registration_tags(registration_id, opts = {})
@@ -1250,9 +1228,9 @@ module RusticiSoftwareCloudV2
1250
1228
  data
1251
1229
  end
1252
1230
 
1253
- # Get tags for a registration.
1254
- # Get a list of the tags applied to this registration.
1255
- # @param registration_id id for this registration
1231
+ # Get tags for a Registration
1232
+ # Returns the tags for the registration.
1233
+ # @param registration_id
1256
1234
  # @param [Hash] opts the optional parameters
1257
1235
  # @return [Array<(TagListSchema, Fixnum, Hash)>] TagListSchema data, response status code and response headers
1258
1236
  def get_registration_tags_with_http_info(registration_id, opts = {})
@@ -1260,7 +1238,7 @@ module RusticiSoftwareCloudV2
1260
1238
  @api_client.config.logger.debug 'Calling API: RegistrationApi.get_registration_tags ...'
1261
1239
  end
1262
1240
  # verify the required parameter 'registration_id' is set
1263
- if @api_client.config.client_side_validation && registration_id.nil?
1241
+ if registration_id.nil?
1264
1242
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.get_registration_tags"
1265
1243
  end
1266
1244
  # resource path
@@ -1294,36 +1272,44 @@ module RusticiSoftwareCloudV2
1294
1272
  end
1295
1273
  return data, status_code, headers
1296
1274
  end
1297
- # Get a list of all registrations.
1298
- # Gets a list of registrations including a summary of the status of each registration.
1275
+ # Get a list of Registrations
1276
+ # Returns a list of registrations. Can be filtered using the request parameters to provide a subset of results. >**Note:** >This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a `more` token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request. >**Info:** >If you find yourself making multiple calls to this endpoint, it may be worthwhile to utilize our [postback mechanism](https://cloud.scorm.com/docs/v2/guides/postback/) instead. The main premise is that you would set up an endpoint on your end, and when we detect a change to the registration progress: completion status, time taken, score, or pass/fail status, we would send a message to your system with the registration progress.
1299
1277
  # @param [Hash] opts the optional parameters
1300
- # @option opts [String] :course_id Only registrations for the specified course id will be included.
1301
- # @option opts [String] :learner_id Only registrations for the specified learner id will be included.
1302
- # @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.
1303
- # @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.
1304
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
1278
+ # @option opts [String] :course_id Only retrieve resources having &#x60;courseId&#x60;
1279
+ # @option opts [String] :learner_id Only retrieve resources having &#x60;learnerId&#x60;
1280
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1281
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1282
+ # @option opts [String] :datetime_filter Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against (default to created)
1283
+ # @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
1284
+ # @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
1285
+ # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to registration_id)
1286
+ # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to created_desc)
1287
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
1305
1288
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results (default to false)
1306
1289
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results (default to false)
1307
1290
  # @option opts [BOOLEAN] :include_runtime Include runtime details in the results (default to false)
1308
- # @option opts [Array<String>] :tags
1309
1291
  # @return [RegistrationListSchema]
1310
1292
  def get_registrations(opts = {})
1311
1293
  data, _status_code, _headers = get_registrations_with_http_info(opts)
1312
1294
  data
1313
1295
  end
1314
1296
 
1315
- # Get a list of all registrations.
1316
- # Gets a list of registrations including a summary of the status of each registration.
1297
+ # Get a list of Registrations
1298
+ # Returns a list of registrations. Can be filtered using the request parameters to provide a subset of results. &gt;**Note:** &gt;This request is paginated and will only provide a limited amount of resources at a time. If there are more results to be collected, a &#x60;more&#x60; token provided with the response which can be passed to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request. &gt;**Info:** &gt;If you find yourself making multiple calls to this endpoint, it may be worthwhile to utilize our [postback mechanism](https://cloud.scorm.com/docs/v2/guides/postback/) instead. The main premise is that you would set up an endpoint on your end, and when we detect a change to the registration progress: completion status, time taken, score, or pass/fail status, we would send a message to your system with the registration progress.
1317
1299
  # @param [Hash] opts the optional parameters
1318
- # @option opts [String] :course_id Only registrations for the specified course id will be included.
1319
- # @option opts [String] :learner_id Only registrations for the specified learner id will be included.
1320
- # @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.
1321
- # @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.
1322
- # @option opts [String] :more Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.
1300
+ # @option opts [String] :course_id Only retrieve resources having &#x60;courseId&#x60;
1301
+ # @option opts [String] :learner_id Only retrieve resources having &#x60;learnerId&#x60;
1302
+ # @option opts [DateTime] :since Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1303
+ # @option opts [DateTime] :_until Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)
1304
+ # @option opts [String] :datetime_filter Specifies field that &#x60;since&#x60; and &#x60;until&#x60; parameters are applied against
1305
+ # @option opts [Array<String>] :tags Filter items matching any tag provided (not all)
1306
+ # @option opts [String] :filter Optional string which filters results by a specified field (described by filterBy).
1307
+ # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
1308
+ # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
1309
+ # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
1323
1310
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results
1324
1311
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results
1325
1312
  # @option opts [BOOLEAN] :include_runtime Include runtime details in the results
1326
- # @option opts [Array<String>] :tags
1327
1313
  # @return [Array<(RegistrationListSchema, Fixnum, Hash)>] RegistrationListSchema data, response status code and response headers
1328
1314
  def get_registrations_with_http_info(opts = {})
1329
1315
  if @api_client.config.debugging
@@ -1338,11 +1324,15 @@ module RusticiSoftwareCloudV2
1338
1324
  query_params[:'learnerId'] = opts[:'learner_id'] if !opts[:'learner_id'].nil?
1339
1325
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1340
1326
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
1327
+ query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
1328
+ query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
1329
+ query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
1330
+ query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
1331
+ query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
1341
1332
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
1342
1333
  query_params[:'includeChildResults'] = opts[:'include_child_results'] if !opts[:'include_child_results'].nil?
1343
1334
  query_params[:'includeInteractionsAndObjectives'] = opts[:'include_interactions_and_objectives'] if !opts[:'include_interactions_and_objectives'].nil?
1344
1335
  query_params[:'includeRuntime'] = opts[:'include_runtime'] if !opts[:'include_runtime'].nil?
1345
- query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
1346
1336
 
1347
1337
  # header parameters
1348
1338
  header_params = {}
@@ -1369,9 +1359,9 @@ module RusticiSoftwareCloudV2
1369
1359
  end
1370
1360
  return data, status_code, headers
1371
1361
  end
1372
- # Set tags on a registration.
1373
- # Set the tags for this registration. Note: any tags currently on this registration will be overwritten with the new array of tags.
1374
- # @param registration_id id for this registration
1362
+ # Add tags to a Registration
1363
+ # Applies the provided tags to the registration. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetRegistrations).
1364
+ # @param registration_id
1375
1365
  # @param tags
1376
1366
  # @param [Hash] opts the optional parameters
1377
1367
  # @return [nil]
@@ -1380,9 +1370,9 @@ module RusticiSoftwareCloudV2
1380
1370
  nil
1381
1371
  end
1382
1372
 
1383
- # Set tags on a registration.
1384
- # Set the tags for this registration. Note: any tags currently on this registration will be overwritten with the new array of tags.
1385
- # @param registration_id id for this registration
1373
+ # Add tags to a Registration
1374
+ # Applies the provided tags to the registration. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetRegistrations).
1375
+ # @param registration_id
1386
1376
  # @param tags
1387
1377
  # @param [Hash] opts the optional parameters
1388
1378
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -1391,11 +1381,11 @@ module RusticiSoftwareCloudV2
1391
1381
  @api_client.config.logger.debug 'Calling API: RegistrationApi.put_registration_tags ...'
1392
1382
  end
1393
1383
  # verify the required parameter 'registration_id' is set
1394
- if @api_client.config.client_side_validation && registration_id.nil?
1384
+ if registration_id.nil?
1395
1385
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.put_registration_tags"
1396
1386
  end
1397
1387
  # verify the required parameter 'tags' is set
1398
- if @api_client.config.client_side_validation && tags.nil?
1388
+ if tags.nil?
1399
1389
  fail ArgumentError, "Missing the required parameter 'tags' when calling RegistrationApi.put_registration_tags"
1400
1390
  end
1401
1391
  # resource path
@@ -1428,9 +1418,9 @@ module RusticiSoftwareCloudV2
1428
1418
  end
1429
1419
  return data, status_code, headers
1430
1420
  end
1431
- # Set tags on registrations.
1432
- # Sets all of the provided tags on all of the provided registrations.
1433
- # @param batch Object representing an array of ids to apply an array of tags to.
1421
+ # Add a group of tags to a group of Registrations
1422
+ # Applies all of the provided tags on all of the provided registrations. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetRegistrations).
1423
+ # @param batch Array of ids, and array of tags for bulk tag operations
1434
1424
  # @param [Hash] opts the optional parameters
1435
1425
  # @return [nil]
1436
1426
  def put_registration_tags_batch(batch, opts = {})
@@ -1438,9 +1428,9 @@ module RusticiSoftwareCloudV2
1438
1428
  nil
1439
1429
  end
1440
1430
 
1441
- # Set tags on registrations.
1442
- # Sets all of the provided tags on all of the provided registrations.
1443
- # @param batch Object representing an array of ids to apply an array of tags to.
1431
+ # Add a group of tags to a group of Registrations
1432
+ # Applies all of the provided tags on all of the provided registrations. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetRegistrations).
1433
+ # @param batch Array of ids, and array of tags for bulk tag operations
1444
1434
  # @param [Hash] opts the optional parameters
1445
1435
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1446
1436
  def put_registration_tags_batch_with_http_info(batch, opts = {})
@@ -1448,7 +1438,7 @@ module RusticiSoftwareCloudV2
1448
1438
  @api_client.config.logger.debug 'Calling API: RegistrationApi.put_registration_tags_batch ...'
1449
1439
  end
1450
1440
  # verify the required parameter 'batch' is set
1451
- if @api_client.config.client_side_validation && batch.nil?
1441
+ if batch.nil?
1452
1442
  fail ArgumentError, "Missing the required parameter 'batch' when calling RegistrationApi.put_registration_tags_batch"
1453
1443
  end
1454
1444
  # resource path
@@ -1481,9 +1471,9 @@ module RusticiSoftwareCloudV2
1481
1471
  end
1482
1472
  return data, status_code, headers
1483
1473
  end
1484
- # Set registration configuration.
1485
- # Set configuration settings for this registration.
1486
- # @param registration_id id for this registration
1474
+ # Update configuration settings for a Registration
1475
+ # Updates configuration settings at the registration level. This will explicitly set a value at the registration level and override any settings from a higher level. Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
1476
+ # @param registration_id
1487
1477
  # @param configuration_settings
1488
1478
  # @param [Hash] opts the optional parameters
1489
1479
  # @return [nil]
@@ -1492,9 +1482,9 @@ module RusticiSoftwareCloudV2
1492
1482
  nil
1493
1483
  end
1494
1484
 
1495
- # Set registration configuration.
1496
- # Set configuration settings for this registration.
1497
- # @param registration_id id for this registration
1485
+ # Update configuration settings for a Registration
1486
+ # Updates configuration settings at the registration level. This will explicitly set a value at the registration level and override any settings from a higher level. Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
1487
+ # @param registration_id
1498
1488
  # @param configuration_settings
1499
1489
  # @param [Hash] opts the optional parameters
1500
1490
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -1503,11 +1493,11 @@ module RusticiSoftwareCloudV2
1503
1493
  @api_client.config.logger.debug 'Calling API: RegistrationApi.set_registration_configuration ...'
1504
1494
  end
1505
1495
  # verify the required parameter 'registration_id' is set
1506
- if @api_client.config.client_side_validation && registration_id.nil?
1496
+ if registration_id.nil?
1507
1497
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.set_registration_configuration"
1508
1498
  end
1509
1499
  # verify the required parameter 'configuration_settings' is set
1510
- if @api_client.config.client_side_validation && configuration_settings.nil?
1500
+ if configuration_settings.nil?
1511
1501
  fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling RegistrationApi.set_registration_configuration"
1512
1502
  end
1513
1503
  # resource path
@@ -1540,10 +1530,10 @@ module RusticiSoftwareCloudV2
1540
1530
  end
1541
1531
  return data, status_code, headers
1542
1532
  end
1543
- # Set configuration for instance of registration.
1544
- # Set configuration settings for this registration instance.
1545
- # @param registration_id id for this registration
1546
- # @param instance_id The instance of this registration
1533
+ # Update configuration settings for a Registration Instance
1534
+ # Updates configuration settings at the registration level. This will explicitly set a value at the registration level and override any settings from a higher level. Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
1535
+ # @param registration_id
1536
+ # @param instance_id
1547
1537
  # @param configuration_settings
1548
1538
  # @param [Hash] opts the optional parameters
1549
1539
  # @return [nil]
@@ -1552,10 +1542,10 @@ module RusticiSoftwareCloudV2
1552
1542
  nil
1553
1543
  end
1554
1544
 
1555
- # Set configuration for instance of registration.
1556
- # Set configuration settings for this registration instance.
1557
- # @param registration_id id for this registration
1558
- # @param instance_id The instance of this registration
1545
+ # Update configuration settings for a Registration Instance
1546
+ # Updates configuration settings at the registration level. This will explicitly set a value at the registration level and override any settings from a higher level. Registrations are the bottom most level in the configuration hierarchy, so the values present at the registration level will be what are used when a course is launched.
1547
+ # @param registration_id
1548
+ # @param instance_id
1559
1549
  # @param configuration_settings
1560
1550
  # @param [Hash] opts the optional parameters
1561
1551
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -1564,19 +1554,15 @@ module RusticiSoftwareCloudV2
1564
1554
  @api_client.config.logger.debug 'Calling API: RegistrationApi.set_registration_instance_configuration ...'
1565
1555
  end
1566
1556
  # verify the required parameter 'registration_id' is set
1567
- if @api_client.config.client_side_validation && registration_id.nil?
1557
+ if registration_id.nil?
1568
1558
  fail ArgumentError, "Missing the required parameter 'registration_id' when calling RegistrationApi.set_registration_instance_configuration"
1569
1559
  end
1570
1560
  # verify the required parameter 'instance_id' is set
1571
- if @api_client.config.client_side_validation && instance_id.nil?
1561
+ if instance_id.nil?
1572
1562
  fail ArgumentError, "Missing the required parameter 'instance_id' when calling RegistrationApi.set_registration_instance_configuration"
1573
1563
  end
1574
- if @api_client.config.client_side_validation && instance_id < 0
1575
- fail ArgumentError, 'invalid value for "instance_id" when calling RegistrationApi.set_registration_instance_configuration, must be greater than or equal to 0.'
1576
- end
1577
-
1578
1564
  # verify the required parameter 'configuration_settings' is set
1579
- if @api_client.config.client_side_validation && configuration_settings.nil?
1565
+ if configuration_settings.nil?
1580
1566
  fail ArgumentError, "Missing the required parameter 'configuration_settings' when calling RegistrationApi.set_registration_instance_configuration"
1581
1567
  end
1582
1568
  # resource path
@@ -1609,8 +1595,8 @@ module RusticiSoftwareCloudV2
1609
1595
  end
1610
1596
  return data, status_code, headers
1611
1597
  end
1612
- # Send a test postback with a provided configuration.
1613
- # This method will allow testing a postback configuration that you provide by sending dummy data to the url specified, with the format you specify.
1598
+ # Send a test postback with the provided configuration
1599
+ # Sends a postback with dummy data to the url specified. The postback will use additional information from the configuration provided with the request (e.g. a provided username/password will be sent along with the postback to allow for logging in to a secure page. The format of the data sent will differ depending on whether `httpbasic` or `form` is passed for `authType`. - With httpbasic, an authorization header will be sent with the base64 encoded credentials. The body will be JSON formatted data. - With form, the username and password will be sent in the body of the request along with the data. The whole body will be url encoded. >**Note:** >The data that will be sent to the provided url is the same format as the output of the GetRegistrationProgress endpoint.
1614
1600
  # @param post_back
1615
1601
  # @param [Hash] opts the optional parameters
1616
1602
  # @return [nil]
@@ -1619,8 +1605,8 @@ module RusticiSoftwareCloudV2
1619
1605
  nil
1620
1606
  end
1621
1607
 
1622
- # Send a test postback with a provided configuration.
1623
- # This method will allow testing a postback configuration that you provide by sending dummy data to the url specified, with the format you specify.
1608
+ # Send a test postback with the provided configuration
1609
+ # Sends a postback with dummy data to the url specified. The postback will use additional information from the configuration provided with the request (e.g. a provided username/password will be sent along with the postback to allow for logging in to a secure page. The format of the data sent will differ depending on whether &#x60;httpbasic&#x60; or &#x60;form&#x60; is passed for &#x60;authType&#x60;. - With httpbasic, an authorization header will be sent with the base64 encoded credentials. The body will be JSON formatted data. - With form, the username and password will be sent in the body of the request along with the data. The whole body will be url encoded. &gt;**Note:** &gt;The data that will be sent to the provided url is the same format as the output of the GetRegistrationProgress endpoint.
1624
1610
  # @param post_back
1625
1611
  # @param [Hash] opts the optional parameters
1626
1612
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -1629,7 +1615,7 @@ module RusticiSoftwareCloudV2
1629
1615
  @api_client.config.logger.debug 'Calling API: RegistrationApi.test_registration_postback ...'
1630
1616
  end
1631
1617
  # verify the required parameter 'post_back' is set
1632
- if @api_client.config.client_side_validation && post_back.nil?
1618
+ if post_back.nil?
1633
1619
  fail ArgumentError, "Missing the required parameter 'post_back' when calling RegistrationApi.test_registration_postback"
1634
1620
  end
1635
1621
  # resource path