rustici_software_cloud_v2 1.1.0 → 2.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (161) 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 +5 -5
  5. data/lib/rustici_software_cloud_v2/api/application_management_api.rb +191 -63
  6. data/lib/rustici_software_cloud_v2/api/authentication_api.rb +10 -18
  7. data/lib/rustici_software_cloud_v2/api/content_connectors_api.rb +236 -0
  8. data/lib/rustici_software_cloud_v2/api/course_api.rb +1046 -225
  9. data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +634 -269
  10. data/lib/rustici_software_cloud_v2/api/invitations_api.rb +213 -171
  11. data/lib/rustici_software_cloud_v2/api/learner_api.rb +49 -49
  12. data/lib/rustici_software_cloud_v2/api/ping_api.rb +3 -1
  13. data/lib/rustici_software_cloud_v2/api/registration_api.rb +256 -270
  14. data/lib/rustici_software_cloud_v2/api/reporting_api.rb +20 -24
  15. data/lib/rustici_software_cloud_v2/api/xapi_api.rb +82 -67
  16. data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +125 -56
  17. data/lib/rustici_software_cloud_v2/api_client.rb +3 -3
  18. data/lib/rustici_software_cloud_v2/api_error.rb +1 -1
  19. data/lib/rustici_software_cloud_v2/configuration.rb +11 -4
  20. data/lib/rustici_software_cloud_v2/models/about_schema.rb +4 -2
  21. data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +9 -37
  22. data/lib/rustici_software_cloud_v2/models/application_info_schema.rb +234 -0
  23. data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +4 -2
  24. data/lib/rustici_software_cloud_v2/models/application_request_schema.rb +186 -0
  25. data/lib/rustici_software_cloud_v2/models/application_schema.rb +4 -2
  26. data/lib/rustici_software_cloud_v2/models/application_token.rb +4 -2
  27. data/lib/rustici_software_cloud_v2/models/asset_file_schema.rb +194 -0
  28. data/lib/rustici_software_cloud_v2/models/batch_tags_schema.rb +4 -2
  29. data/lib/rustici_software_cloud_v2/models/comment_schema.rb +4 -2
  30. data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +4 -2
  31. data/lib/rustici_software_cloud_v2/models/connector_list_schema.rb +188 -0
  32. data/lib/rustici_software_cloud_v2/models/connector_schema.rb +226 -0
  33. data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +7 -31
  34. data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +4 -2
  35. data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +5 -2
  36. data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +4 -2
  37. data/lib/rustici_software_cloud_v2/models/course_schema.rb +6 -30
  38. data/lib/rustici_software_cloud_v2/models/create_connector_schema.rb +218 -0
  39. data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +3 -20
  40. data/lib/rustici_software_cloud_v2/models/create_dispatch_list_schema.rb +4 -2
  41. data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +5 -3
  42. data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +5 -3
  43. data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +5 -3
  44. data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +4 -2
  45. data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +4 -2
  46. data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +4 -2
  47. data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +4 -2
  48. data/lib/rustici_software_cloud_v2/models/credential_schema.rb +4 -2
  49. data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +4 -2
  50. data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +5 -3
  51. data/lib/rustici_software_cloud_v2/models/destination_schema.rb +35 -6
  52. data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +4 -2
  53. data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +5 -2
  54. data/lib/rustici_software_cloud_v2/models/dispatch_lti13_info_schema.rb +186 -0
  55. data/lib/rustici_software_cloud_v2/models/dispatch_lti_info_schema.rb +221 -0
  56. data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +4 -2
  57. data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +44 -4
  58. data/lib/rustici_software_cloud_v2/models/enabled_schema.rb +4 -2
  59. data/lib/rustici_software_cloud_v2/models/file_list_item_schema.rb +205 -0
  60. data/lib/rustici_software_cloud_v2/models/file_list_schema.rb +187 -0
  61. data/lib/rustici_software_cloud_v2/models/import_asset_request_schema.rb +207 -0
  62. data/lib/rustici_software_cloud_v2/models/import_connector_request_schema.rb +207 -0
  63. data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +30 -7
  64. data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +6 -30
  65. data/lib/rustici_software_cloud_v2/models/import_media_file_reference_request_schema.rb +216 -0
  66. data/lib/rustici_software_cloud_v2/models/import_request_schema.rb +204 -0
  67. data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +4 -2
  68. data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +4 -2
  69. data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +4 -2
  70. data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +6 -30
  71. data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +5 -2
  72. data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +4 -2
  73. data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +4 -2
  74. data/lib/rustici_software_cloud_v2/models/launch_auth_options_schema.rb +4 -2
  75. data/lib/rustici_software_cloud_v2/models/launch_auth_schema.rb +6 -30
  76. data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +4 -2
  77. data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +9 -37
  78. data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +6 -4
  79. data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +4 -2
  80. data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +4 -2
  81. data/lib/rustici_software_cloud_v2/models/learner_schema.rb +4 -2
  82. data/lib/rustici_software_cloud_v2/models/lti13_platform_configuration_schema.rb +261 -0
  83. data/lib/rustici_software_cloud_v2/models/lti13_tool_configuration_schema.rb +236 -0
  84. data/lib/rustici_software_cloud_v2/models/media_file_metadata_schema.rb +213 -0
  85. data/lib/rustici_software_cloud_v2/models/message_schema.rb +4 -2
  86. data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +11 -9
  87. data/lib/rustici_software_cloud_v2/models/objective_schema.rb +12 -44
  88. data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +4 -2
  89. data/lib/rustici_software_cloud_v2/models/ping_schema.rb +4 -2
  90. data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +9 -37
  91. data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +5 -2
  92. data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +6 -4
  93. data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb +215 -0
  94. data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +5 -2
  95. data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +17 -6
  96. data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +228 -0
  97. data/lib/rustici_software_cloud_v2/models/registration_completion.rb +1 -1
  98. data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +5 -2
  99. data/lib/rustici_software_cloud_v2/models/registration_schema.rb +4 -2
  100. data/lib/rustici_software_cloud_v2/models/registration_success.rb +1 -1
  101. data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +4 -2
  102. data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +4 -2
  103. data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +4 -2
  104. data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +4 -2
  105. data/lib/rustici_software_cloud_v2/models/response_error.rb +4 -2
  106. data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +6 -30
  107. data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +9 -37
  108. data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +6 -30
  109. data/lib/rustici_software_cloud_v2/models/score_schema.rb +4 -2
  110. data/lib/rustici_software_cloud_v2/models/setting_item.rb +6 -30
  111. data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +4 -2
  112. data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +6 -30
  113. data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +4 -2
  114. data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +4 -2
  115. data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +4 -2
  116. data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +4 -2
  117. data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +4 -2
  118. data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +4 -2
  119. data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +4 -2
  120. data/lib/rustici_software_cloud_v2/models/title_schema.rb +4 -2
  121. data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +4 -2
  122. data/lib/rustici_software_cloud_v2/models/update_application_schema.rb +196 -0
  123. data/lib/rustici_software_cloud_v2/models/update_connector_schema.rb +196 -0
  124. data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +16 -4
  125. data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +5 -2
  126. data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +4 -2
  127. data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +4 -2
  128. data/lib/rustici_software_cloud_v2/models/xapi_account.rb +4 -2
  129. data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +4 -2
  130. data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +4 -2
  131. data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +6 -30
  132. data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +4 -2
  133. data/lib/rustici_software_cloud_v2/models/xapi_context.rb +4 -2
  134. data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +4 -2
  135. data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +6 -30
  136. data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +6 -30
  137. data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +4 -2
  138. data/lib/rustici_software_cloud_v2/models/xapi_credential_put_schema.rb +4 -2
  139. data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +4 -2
  140. data/lib/rustici_software_cloud_v2/models/xapi_credentials_list_schema.rb +5 -2
  141. data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +4 -2
  142. data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +4 -2
  143. data/lib/rustici_software_cloud_v2/models/xapi_result.rb +4 -2
  144. data/lib/rustici_software_cloud_v2/models/xapi_score.rb +4 -2
  145. data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +4 -2
  146. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +4 -2
  147. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +4 -2
  148. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_put_schema.rb +4 -2
  149. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +4 -2
  150. data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +4 -2
  151. data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +4 -2
  152. data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +4 -2
  153. data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +4 -2
  154. data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +14 -2
  155. data/lib/rustici_software_cloud_v2/version.rb +2 -2
  156. data/lib/rustici_software_cloud_v2.rb +23 -1
  157. data/rustici_software_cloud_v2.gemspec +3 -2
  158. data/spec/api_client_spec.rb +18 -1
  159. data/spec/configuration_spec.rb +1 -1
  160. data/spec/spec_helper.rb +1 -1
  161. metadata +45 -3
@@ -6,7 +6,7 @@
6
6
  OpenAPI spec version: 2.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.4.12
9
+ Swagger Codegen version: 2.4.27
10
10
 
11
11
  =end
12
12
 
@@ -19,10 +19,10 @@ module RusticiSoftwareCloudV2
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Deletes all of the information associated with a learner in an application, by learner id.
23
- # Deletes all of the information associated with a learner in an application, by learner id. This is meant for use with complying with GDPR requests from learners.
24
- # @param learner_id The id of the learner for which to remove all data from an application
25
- # @param user_email The email of the user initiating this request on behalf of the learner being deleted. This must be a valid primary email address for a SCORM Cloud realm which this application is in.
22
+ # Deletes all PII for a learnerId
23
+ # Deletes all of the PII information for the learner. This is meant for use with complying with GDPR requests from learners. >**Note:** >This method is asynchronous. A returned success status indicates a background process has been started, but there will still be a delay before the deletion of PII information takes place.
24
+ # @param learner_id The id of the learner
25
+ # @param user_email The email of the user initiating this request on behalf of the learner being deleted. This must be a valid primary email address for a SCORM Cloud realm which this application is in.
26
26
  # @param [Hash] opts the optional parameters
27
27
  # @return [nil]
28
28
  def delete_all_learner_data(learner_id, user_email, opts = {})
@@ -30,10 +30,10 @@ module RusticiSoftwareCloudV2
30
30
  nil
31
31
  end
32
32
 
33
- # Deletes all of the information associated with a learner in an application, by learner id.
34
- # Deletes all of the information associated with a learner in an application, by learner id. This is meant for use with complying with GDPR requests from learners.
35
- # @param learner_id The id of the learner for which to remove all data from an application
36
- # @param user_email The email of the user initiating this request on behalf of the learner being deleted. This must be a valid primary email address for a SCORM Cloud realm which this application is in.
33
+ # Deletes all PII for a learnerId
34
+ # Deletes all of the PII information for the learner. This is meant for use with complying with GDPR requests from learners. >**Note:** >This method is asynchronous. A returned success status indicates a background process has been started, but there will still be a delay before the deletion of PII information takes place.
35
+ # @param learner_id The id of the learner
36
+ # @param user_email The email of the user initiating this request on behalf of the learner being deleted. This must be a valid primary email address for a SCORM Cloud realm which this application is in.
37
37
  # @param [Hash] opts the optional parameters
38
38
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
39
39
  def delete_all_learner_data_with_http_info(learner_id, user_email, opts = {})
@@ -41,11 +41,11 @@ module RusticiSoftwareCloudV2
41
41
  @api_client.config.logger.debug 'Calling API: LearnerApi.delete_all_learner_data ...'
42
42
  end
43
43
  # verify the required parameter 'learner_id' is set
44
- if @api_client.config.client_side_validation && learner_id.nil?
44
+ if learner_id.nil?
45
45
  fail ArgumentError, "Missing the required parameter 'learner_id' when calling LearnerApi.delete_all_learner_data"
46
46
  end
47
47
  # verify the required parameter 'user_email' is set
48
- if @api_client.config.client_side_validation && user_email.nil?
48
+ if user_email.nil?
49
49
  fail ArgumentError, "Missing the required parameter 'user_email' when calling LearnerApi.delete_all_learner_data"
50
50
  end
51
51
  # resource path
@@ -79,9 +79,9 @@ module RusticiSoftwareCloudV2
79
79
  end
80
80
  return data, status_code, headers
81
81
  end
82
- # Delete the tags for this learner
83
- # Delete the tags for this learner
84
- # @param learner_id The id of the learner for which to remove all data from an application
82
+ # Delete tags from a learnerId
83
+ # Delete the specified tags from the learner. Deleting tags that do not exist will still result in a success.
84
+ # @param learner_id The id of the learner
85
85
  # @param tags
86
86
  # @param [Hash] opts the optional parameters
87
87
  # @return [nil]
@@ -90,9 +90,9 @@ module RusticiSoftwareCloudV2
90
90
  nil
91
91
  end
92
92
 
93
- # Delete the tags for this learner
94
- # Delete the tags for this learner
95
- # @param learner_id The id of the learner for which to remove all data from an application
93
+ # Delete tags from a learnerId
94
+ # Delete the specified tags from the learner. Deleting tags that do not exist will still result in a success.
95
+ # @param learner_id The id of the learner
96
96
  # @param tags
97
97
  # @param [Hash] opts the optional parameters
98
98
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -101,11 +101,11 @@ module RusticiSoftwareCloudV2
101
101
  @api_client.config.logger.debug 'Calling API: LearnerApi.delete_learner_tags ...'
102
102
  end
103
103
  # verify the required parameter 'learner_id' is set
104
- if @api_client.config.client_side_validation && learner_id.nil?
104
+ if learner_id.nil?
105
105
  fail ArgumentError, "Missing the required parameter 'learner_id' when calling LearnerApi.delete_learner_tags"
106
106
  end
107
107
  # verify the required parameter 'tags' is set
108
- if @api_client.config.client_side_validation && tags.nil?
108
+ if tags.nil?
109
109
  fail ArgumentError, "Missing the required parameter 'tags' when calling LearnerApi.delete_learner_tags"
110
110
  end
111
111
  # resource path
@@ -138,9 +138,9 @@ module RusticiSoftwareCloudV2
138
138
  end
139
139
  return data, status_code, headers
140
140
  end
141
- # Get the tags for this learner
142
- # Get the tags for this learner
143
- # @param learner_id The id of the learner for which to remove all data from an application
141
+ # Get tags for a learnerId
142
+ # Returns the tags for the learner.
143
+ # @param learner_id The id of the learner
144
144
  # @param [Hash] opts the optional parameters
145
145
  # @return [TagListSchema]
146
146
  def get_learner_tags(learner_id, opts = {})
@@ -148,9 +148,9 @@ module RusticiSoftwareCloudV2
148
148
  data
149
149
  end
150
150
 
151
- # Get the tags for this learner
152
- # Get the tags for this learner
153
- # @param learner_id The id of the learner for which to remove all data from an application
151
+ # Get tags for a learnerId
152
+ # Returns the tags for the learner.
153
+ # @param learner_id The id of the learner
154
154
  # @param [Hash] opts the optional parameters
155
155
  # @return [Array<(TagListSchema, Fixnum, Hash)>] TagListSchema data, response status code and response headers
156
156
  def get_learner_tags_with_http_info(learner_id, opts = {})
@@ -158,7 +158,7 @@ module RusticiSoftwareCloudV2
158
158
  @api_client.config.logger.debug 'Calling API: LearnerApi.get_learner_tags ...'
159
159
  end
160
160
  # verify the required parameter 'learner_id' is set
161
- if @api_client.config.client_side_validation && learner_id.nil?
161
+ if learner_id.nil?
162
162
  fail ArgumentError, "Missing the required parameter 'learner_id' when calling LearnerApi.get_learner_tags"
163
163
  end
164
164
  # resource path
@@ -192,9 +192,9 @@ module RusticiSoftwareCloudV2
192
192
  end
193
193
  return data, status_code, headers
194
194
  end
195
- # Set the tags for this learner
196
- # Set the tags for this learner
197
- # @param learner_id The id of the learner for which to remove all data from an application
195
+ # Add tags to a learnerId
196
+ # Applies the provided tags to the learner. Tags are used to easily identify resources. Adding tags can enable more refined searches when working with Reportage.
197
+ # @param learner_id The id of the learner
198
198
  # @param tags
199
199
  # @param [Hash] opts the optional parameters
200
200
  # @return [nil]
@@ -203,9 +203,9 @@ module RusticiSoftwareCloudV2
203
203
  nil
204
204
  end
205
205
 
206
- # Set the tags for this learner
207
- # Set the tags for this learner
208
- # @param learner_id The id of the learner for which to remove all data from an application
206
+ # Add tags to a learnerId
207
+ # Applies the provided tags to the learner. Tags are used to easily identify resources. Adding tags can enable more refined searches when working with Reportage.
208
+ # @param learner_id The id of the learner
209
209
  # @param tags
210
210
  # @param [Hash] opts the optional parameters
211
211
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -214,11 +214,11 @@ module RusticiSoftwareCloudV2
214
214
  @api_client.config.logger.debug 'Calling API: LearnerApi.put_learner_tags ...'
215
215
  end
216
216
  # verify the required parameter 'learner_id' is set
217
- if @api_client.config.client_side_validation && learner_id.nil?
217
+ if learner_id.nil?
218
218
  fail ArgumentError, "Missing the required parameter 'learner_id' when calling LearnerApi.put_learner_tags"
219
219
  end
220
220
  # verify the required parameter 'tags' is set
221
- if @api_client.config.client_side_validation && tags.nil?
221
+ if tags.nil?
222
222
  fail ArgumentError, "Missing the required parameter 'tags' when calling LearnerApi.put_learner_tags"
223
223
  end
224
224
  # resource path
@@ -251,9 +251,9 @@ module RusticiSoftwareCloudV2
251
251
  end
252
252
  return data, status_code, headers
253
253
  end
254
- # Sets all of the provided tags on all of the provided learners
255
- # Sets all of the provided tags on all of the provided learners
256
- # @param batch Object representing an array of ids to apply an array of tags to.
254
+ # Add a group of tags to a group of learnerIds
255
+ # Applies all of the provided tags on all of the provided learners. Tags are used to easily identify resources. Adding tags can enable more refined searches when working with Reportage.
256
+ # @param batch Array of ids, and array of tags for bulk tag operations
257
257
  # @param [Hash] opts the optional parameters
258
258
  # @return [nil]
259
259
  def put_learner_tags_batch(batch, opts = {})
@@ -261,9 +261,9 @@ module RusticiSoftwareCloudV2
261
261
  nil
262
262
  end
263
263
 
264
- # Sets all of the provided tags on all of the provided learners
265
- # Sets all of the provided tags on all of the provided learners
266
- # @param batch Object representing an array of ids to apply an array of tags to.
264
+ # Add a group of tags to a group of learnerIds
265
+ # Applies all of the provided tags on all of the provided learners. Tags are used to easily identify resources. Adding tags can enable more refined searches when working with Reportage.
266
+ # @param batch Array of ids, and array of tags for bulk tag operations
267
267
  # @param [Hash] opts the optional parameters
268
268
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
269
269
  def put_learner_tags_batch_with_http_info(batch, opts = {})
@@ -271,7 +271,7 @@ module RusticiSoftwareCloudV2
271
271
  @api_client.config.logger.debug 'Calling API: LearnerApi.put_learner_tags_batch ...'
272
272
  end
273
273
  # verify the required parameter 'batch' is set
274
- if @api_client.config.client_side_validation && batch.nil?
274
+ if batch.nil?
275
275
  fail ArgumentError, "Missing the required parameter 'batch' when calling LearnerApi.put_learner_tags_batch"
276
276
  end
277
277
  # resource path
@@ -304,9 +304,9 @@ module RusticiSoftwareCloudV2
304
304
  end
305
305
  return data, status_code, headers
306
306
  end
307
- # Update a learner's info on all of their registrations.
308
- # A learner in SCORM Cloud is not an entity on its own. In fact, learners only exist as information on individual registrations. This method will update the information on each of the registrations that the provided `learnerId` is attached to. You may update any of the values available in the LearnerSchema which is posted. Any values you do not wish to alter, omit from the post. Depending on the field, providing something like an empty string may have unintended consequences. Lastly, it's important to note that this method is asynchronous. A success status will be returned, and that signifies that a background process has been spun up to alter the learner's info. As such, you may find a short period of delay in seeing the changes shown on all registrations.
309
- # @param learner_id The id of the learner to be updated
307
+ # Update all Registrations for a learnerId
308
+ # Updates information about a group of registrations, such as learner email and name. A learner in SCORM Cloud is not an entity on its own. In fact, learners only exist as information on individual registrations. This method will update the information on each of the registrations that the provided `learnerId` is attached to. >**Caution:** >Providing an empty string will cause the value in SCORM Cloud to be set to empty. This may have unintended consequences with regards to functionality. >**Note:** >This method is asynchronous. A returned success status indicates a background process has been started, but there will still be a delay before the changes on the registrations take place.
309
+ # @param learner_id The id of the learner
310
310
  # @param learner_info
311
311
  # @param [Hash] opts the optional parameters
312
312
  # @return [nil]
@@ -315,9 +315,9 @@ module RusticiSoftwareCloudV2
315
315
  nil
316
316
  end
317
317
 
318
- # Update a learner&#39;s info on all of their registrations.
319
- # A learner in SCORM Cloud is not an entity on its own. In fact, learners only exist as information on individual registrations. This method will update the information on each of the registrations that the provided &#x60;learnerId&#x60; is attached to. You may update any of the values available in the LearnerSchema which is posted. Any values you do not wish to alter, omit from the post. Depending on the field, providing something like an empty string may have unintended consequences. Lastly, it&#39;s important to note that this method is asynchronous. A success status will be returned, and that signifies that a background process has been spun up to alter the learner&#39;s info. As such, you may find a short period of delay in seeing the changes shown on all registrations.
320
- # @param learner_id The id of the learner to be updated
318
+ # Update all Registrations for a learnerId
319
+ # Updates information about a group of registrations, such as learner email and name. A learner in SCORM Cloud is not an entity on its own. In fact, learners only exist as information on individual registrations. This method will update the information on each of the registrations that the provided &#x60;learnerId&#x60; is attached to. &gt;**Caution:** &gt;Providing an empty string will cause the value in SCORM Cloud to be set to empty. This may have unintended consequences with regards to functionality. &gt;**Note:** &gt;This method is asynchronous. A returned success status indicates a background process has been started, but there will still be a delay before the changes on the registrations take place.
320
+ # @param learner_id The id of the learner
321
321
  # @param learner_info
322
322
  # @param [Hash] opts the optional parameters
323
323
  # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -326,11 +326,11 @@ module RusticiSoftwareCloudV2
326
326
  @api_client.config.logger.debug 'Calling API: LearnerApi.update_learner_info ...'
327
327
  end
328
328
  # verify the required parameter 'learner_id' is set
329
- if @api_client.config.client_side_validation && learner_id.nil?
329
+ if learner_id.nil?
330
330
  fail ArgumentError, "Missing the required parameter 'learner_id' when calling LearnerApi.update_learner_info"
331
331
  end
332
332
  # verify the required parameter 'learner_info' is set
333
- if @api_client.config.client_side_validation && learner_info.nil?
333
+ if learner_info.nil?
334
334
  fail ArgumentError, "Missing the required parameter 'learner_info' when calling LearnerApi.update_learner_info"
335
335
  end
336
336
  # resource path
@@ -6,7 +6,7 @@
6
6
  OpenAPI spec version: 2.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.4.12
9
+ Swagger Codegen version: 2.4.27
10
10
 
11
11
  =end
12
12
 
@@ -19,6 +19,7 @@ module RusticiSoftwareCloudV2
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Ping the API
22
23
  # Get back a message indicating that the API is working.
23
24
  # @param [Hash] opts the optional parameters
24
25
  # @return [PingSchema]
@@ -27,6 +28,7 @@ module RusticiSoftwareCloudV2
27
28
  data
28
29
  end
29
30
 
31
+ # Ping the API
30
32
  # Get back a message indicating that the API is working.
31
33
  # @param [Hash] opts the optional parameters
32
34
  # @return [Array<(PingSchema, Fixnum, Hash)>] PingSchema data, response status code and response headers