rustici_software_cloud_v2 2.1.0 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (162) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +4 -4
  3. data/lib/rustici_software_cloud_v2/api/about_api.rb +3 -1
  4. data/lib/rustici_software_cloud_v2/api/application_management_api.rb +100 -5
  5. data/lib/rustici_software_cloud_v2/api/authentication_api.rb +3 -1
  6. data/lib/rustici_software_cloud_v2/api/content_connectors_api.rb +6 -1
  7. data/lib/rustici_software_cloud_v2/api/course_api.rb +42 -1
  8. data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +53 -2
  9. data/lib/rustici_software_cloud_v2/api/invitations_api.rb +33 -1
  10. data/lib/rustici_software_cloud_v2/api/learner_api.rb +8 -1
  11. data/lib/rustici_software_cloud_v2/api/ping_api.rb +3 -1
  12. data/lib/rustici_software_cloud_v2/api/registration_api.rb +32 -1
  13. data/lib/rustici_software_cloud_v2/api/reporting_api.rb +5 -1
  14. data/lib/rustici_software_cloud_v2/api/xapi_api.rb +15 -1
  15. data/lib/rustici_software_cloud_v2/api/zoomi_api.rb +11 -1
  16. data/lib/rustici_software_cloud_v2/api_client.rb +3 -2
  17. data/lib/rustici_software_cloud_v2/api_error.rb +0 -1
  18. data/lib/rustici_software_cloud_v2/configuration.rb +0 -8
  19. data/lib/rustici_software_cloud_v2/models/about_schema.rb +1 -1
  20. data/lib/rustici_software_cloud_v2/models/activity_result_schema.rb +1 -1
  21. data/lib/rustici_software_cloud_v2/models/application_info_list_schema.rb +197 -0
  22. data/lib/rustici_software_cloud_v2/models/application_info_schema.rb +12 -2
  23. data/lib/rustici_software_cloud_v2/models/application_list_schema.rb +1 -1
  24. data/lib/rustici_software_cloud_v2/models/application_request_schema.rb +1 -1
  25. data/lib/rustici_software_cloud_v2/models/application_schema.rb +1 -1
  26. data/lib/rustici_software_cloud_v2/models/application_token.rb +1 -1
  27. data/lib/rustici_software_cloud_v2/models/asset_file_schema.rb +1 -1
  28. data/lib/rustici_software_cloud_v2/models/batch_tags_schema.rb +1 -1
  29. data/lib/rustici_software_cloud_v2/models/comment_schema.rb +1 -1
  30. data/lib/rustici_software_cloud_v2/models/completion_amount_schema.rb +1 -1
  31. data/lib/rustici_software_cloud_v2/models/connector_list_schema.rb +1 -1
  32. data/lib/rustici_software_cloud_v2/models/connector_schema.rb +1 -1
  33. data/lib/rustici_software_cloud_v2/models/course_activity_schema.rb +1 -1
  34. data/lib/rustici_software_cloud_v2/models/course_list_non_paged_schema.rb +1 -1
  35. data/lib/rustici_software_cloud_v2/models/course_list_schema.rb +1 -1
  36. data/lib/rustici_software_cloud_v2/models/course_reference_schema.rb +1 -1
  37. data/lib/rustici_software_cloud_v2/models/course_schema.rb +1 -1
  38. data/lib/rustici_software_cloud_v2/models/create_connector_schema.rb +1 -1
  39. data/lib/rustici_software_cloud_v2/models/create_dispatch_id_schema.rb +1 -1
  40. data/lib/rustici_software_cloud_v2/models/create_dispatch_list_schema.rb +1 -1
  41. data/lib/rustici_software_cloud_v2/models/create_dispatch_schema.rb +1 -1
  42. data/lib/rustici_software_cloud_v2/models/create_private_invitation_schema.rb +1 -1
  43. data/lib/rustici_software_cloud_v2/models/create_public_invitation_schema.rb +1 -1
  44. data/lib/rustici_software_cloud_v2/models/create_registration_schema.rb +1 -1
  45. data/lib/rustici_software_cloud_v2/models/credential_created_schema.rb +1 -1
  46. data/lib/rustici_software_cloud_v2/models/credential_list_schema.rb +1 -1
  47. data/lib/rustici_software_cloud_v2/models/credential_request_schema.rb +1 -1
  48. data/lib/rustici_software_cloud_v2/models/credential_schema.rb +1 -1
  49. data/lib/rustici_software_cloud_v2/models/destination_id_schema.rb +1 -1
  50. data/lib/rustici_software_cloud_v2/models/destination_list_schema.rb +1 -1
  51. data/lib/rustici_software_cloud_v2/models/destination_schema.rb +1 -1
  52. data/lib/rustici_software_cloud_v2/models/dispatch_id_schema.rb +1 -1
  53. data/lib/rustici_software_cloud_v2/models/dispatch_list_schema.rb +1 -1
  54. data/lib/rustici_software_cloud_v2/models/dispatch_lti13_info_schema.rb +1 -1
  55. data/lib/rustici_software_cloud_v2/models/dispatch_lti_info_schema.rb +1 -1
  56. data/lib/rustici_software_cloud_v2/models/dispatch_registration_count_schema.rb +1 -1
  57. data/lib/rustici_software_cloud_v2/models/dispatch_schema.rb +1 -1
  58. data/lib/rustici_software_cloud_v2/models/enabled_schema.rb +1 -1
  59. data/lib/rustici_software_cloud_v2/models/file_list_item_schema.rb +1 -1
  60. data/lib/rustici_software_cloud_v2/models/file_list_schema.rb +1 -1
  61. data/lib/rustici_software_cloud_v2/models/import_asset_request_schema.rb +1 -1
  62. data/lib/rustici_software_cloud_v2/models/import_connector_request_schema.rb +1 -1
  63. data/lib/rustici_software_cloud_v2/models/import_fetch_request_schema.rb +1 -1
  64. data/lib/rustici_software_cloud_v2/models/import_job_result_schema.rb +1 -1
  65. data/lib/rustici_software_cloud_v2/models/import_media_file_reference_request_schema.rb +1 -1
  66. data/lib/rustici_software_cloud_v2/models/import_request_schema.rb +1 -1
  67. data/lib/rustici_software_cloud_v2/models/import_result_schema.rb +1 -1
  68. data/lib/rustici_software_cloud_v2/models/integer_result_schema.rb +1 -1
  69. data/lib/rustici_software_cloud_v2/models/invitation_email_schema.rb +1 -1
  70. data/lib/rustici_software_cloud_v2/models/invitation_job_status_schema.rb +1 -1
  71. data/lib/rustici_software_cloud_v2/models/invitation_summary_list.rb +15 -18
  72. data/lib/rustici_software_cloud_v2/models/invitation_summary_schema.rb +1 -1
  73. data/lib/rustici_software_cloud_v2/models/item_value_pair_schema.rb +1 -1
  74. data/lib/rustici_software_cloud_v2/models/launch_auth_options_schema.rb +1 -1
  75. data/lib/rustici_software_cloud_v2/models/launch_auth_schema.rb +1 -1
  76. data/lib/rustici_software_cloud_v2/models/launch_history_list_schema.rb +1 -1
  77. data/lib/rustici_software_cloud_v2/models/launch_history_schema.rb +1 -1
  78. data/lib/rustici_software_cloud_v2/models/launch_link_request_schema.rb +1 -1
  79. data/lib/rustici_software_cloud_v2/models/launch_link_schema.rb +1 -1
  80. data/lib/rustici_software_cloud_v2/models/learner_preference_schema.rb +1 -1
  81. data/lib/rustici_software_cloud_v2/models/learner_schema.rb +1 -1
  82. data/lib/rustici_software_cloud_v2/models/lti13_platform_configuration_schema.rb +1 -1
  83. data/lib/rustici_software_cloud_v2/models/lti13_tool_configuration_schema.rb +1 -1
  84. data/lib/rustici_software_cloud_v2/models/media_file_metadata_schema.rb +1 -1
  85. data/lib/rustici_software_cloud_v2/models/message_schema.rb +1 -1
  86. data/lib/rustici_software_cloud_v2/models/metadata_schema.rb +1 -1
  87. data/lib/rustici_software_cloud_v2/models/objective_schema.rb +1 -1
  88. data/lib/rustici_software_cloud_v2/models/paginated_list.rb +186 -0
  89. data/lib/rustici_software_cloud_v2/models/permissions_schema.rb +1 -1
  90. data/lib/rustici_software_cloud_v2/models/ping_schema.rb +1 -1
  91. data/lib/rustici_software_cloud_v2/models/post_back_schema.rb +1 -1
  92. data/lib/rustici_software_cloud_v2/models/private_invitation_list.rb +15 -18
  93. data/lib/rustici_software_cloud_v2/models/private_invitation_schema.rb +1 -1
  94. data/lib/rustici_software_cloud_v2/models/private_invitation_update_schema.rb +1 -1
  95. data/lib/rustici_software_cloud_v2/models/public_invitation_list.rb +15 -18
  96. data/lib/rustici_software_cloud_v2/models/public_invitation_schema.rb +1 -1
  97. data/lib/rustici_software_cloud_v2/models/public_invitation_update_schema.rb +1 -1
  98. data/lib/rustici_software_cloud_v2/models/registration_completion.rb +1 -1
  99. data/lib/rustici_software_cloud_v2/models/registration_list_schema.rb +1 -1
  100. data/lib/rustici_software_cloud_v2/models/registration_schema.rb +1 -1
  101. data/lib/rustici_software_cloud_v2/models/registration_success.rb +1 -1
  102. data/lib/rustici_software_cloud_v2/models/reportage_account_info_schema.rb +1 -1
  103. data/lib/rustici_software_cloud_v2/models/reportage_account_info_usage_schema.rb +1 -1
  104. data/lib/rustici_software_cloud_v2/models/reportage_auth_token_schema.rb +1 -1
  105. data/lib/rustici_software_cloud_v2/models/reportage_link_schema.rb +1 -1
  106. data/lib/rustici_software_cloud_v2/models/response_error.rb +1 -1
  107. data/lib/rustici_software_cloud_v2/models/runtime_interaction_schema.rb +1 -1
  108. data/lib/rustici_software_cloud_v2/models/runtime_objective_schema.rb +1 -1
  109. data/lib/rustici_software_cloud_v2/models/runtime_schema.rb +1 -1
  110. data/lib/rustici_software_cloud_v2/models/score_schema.rb +1 -1
  111. data/lib/rustici_software_cloud_v2/models/setting_item.rb +1 -1
  112. data/lib/rustici_software_cloud_v2/models/setting_list_schema.rb +1 -1
  113. data/lib/rustici_software_cloud_v2/models/setting_metadata.rb +1 -1
  114. data/lib/rustici_software_cloud_v2/models/setting_valid_value.rb +1 -1
  115. data/lib/rustici_software_cloud_v2/models/settings_individual_schema.rb +1 -1
  116. data/lib/rustici_software_cloud_v2/models/settings_post_schema.rb +1 -1
  117. data/lib/rustici_software_cloud_v2/models/shared_data_entry_schema.rb +1 -1
  118. data/lib/rustici_software_cloud_v2/models/static_properties_schema.rb +1 -1
  119. data/lib/rustici_software_cloud_v2/models/string_result_schema.rb +1 -1
  120. data/lib/rustici_software_cloud_v2/models/tag_list_schema.rb +1 -1
  121. data/lib/rustici_software_cloud_v2/models/title_schema.rb +1 -1
  122. data/lib/rustici_software_cloud_v2/models/token_request_schema.rb +1 -1
  123. data/lib/rustici_software_cloud_v2/models/update_application_schema.rb +1 -1
  124. data/lib/rustici_software_cloud_v2/models/update_connector_schema.rb +1 -1
  125. data/lib/rustici_software_cloud_v2/models/update_dispatch_schema.rb +1 -1
  126. data/lib/rustici_software_cloud_v2/models/user_invitation_list.rb +15 -18
  127. data/lib/rustici_software_cloud_v2/models/user_invitation_schema.rb +1 -1
  128. data/lib/rustici_software_cloud_v2/models/user_invitation_schema_registration_report.rb +1 -1
  129. data/lib/rustici_software_cloud_v2/models/xapi_account.rb +1 -1
  130. data/lib/rustici_software_cloud_v2/models/xapi_activity.rb +1 -1
  131. data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb +1 -1
  132. data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb +1 -1
  133. data/lib/rustici_software_cloud_v2/models/xapi_attachment.rb +1 -1
  134. data/lib/rustici_software_cloud_v2/models/xapi_context.rb +1 -1
  135. data/lib/rustici_software_cloud_v2/models/xapi_context_activity.rb +1 -1
  136. data/lib/rustici_software_cloud_v2/models/xapi_credential_auth_type_schema.rb +1 -1
  137. data/lib/rustici_software_cloud_v2/models/xapi_credential_permissions_level_schema.rb +1 -1
  138. data/lib/rustici_software_cloud_v2/models/xapi_credential_post_schema.rb +1 -1
  139. data/lib/rustici_software_cloud_v2/models/xapi_credential_put_schema.rb +1 -1
  140. data/lib/rustici_software_cloud_v2/models/xapi_credential_schema.rb +1 -1
  141. data/lib/rustici_software_cloud_v2/models/xapi_credentials_list_schema.rb +1 -1
  142. data/lib/rustici_software_cloud_v2/models/xapi_endpoint_schema.rb +1 -1
  143. data/lib/rustici_software_cloud_v2/models/xapi_interaction_component.rb +1 -1
  144. data/lib/rustici_software_cloud_v2/models/xapi_result.rb +1 -1
  145. data/lib/rustici_software_cloud_v2/models/xapi_score.rb +1 -1
  146. data/lib/rustici_software_cloud_v2/models/xapi_statement.rb +1 -1
  147. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_list_schema.rb +1 -1
  148. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_post_schema.rb +1 -1
  149. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_put_schema.rb +1 -1
  150. data/lib/rustici_software_cloud_v2/models/xapi_statement_pipe_schema.rb +1 -1
  151. data/lib/rustici_software_cloud_v2/models/xapi_statement_reference.rb +1 -1
  152. data/lib/rustici_software_cloud_v2/models/xapi_statement_result.rb +1 -1
  153. data/lib/rustici_software_cloud_v2/models/xapi_verb.rb +1 -1
  154. data/lib/rustici_software_cloud_v2/models/zoomi_company_id.rb +1 -1
  155. data/lib/rustici_software_cloud_v2/models/zoomi_course_options_schema.rb +1 -1
  156. data/lib/rustici_software_cloud_v2/version.rb +1 -2
  157. data/lib/rustici_software_cloud_v2.rb +2 -1
  158. data/rustici_software_cloud_v2.gemspec +0 -1
  159. data/spec/api_client_spec.rb +0 -1
  160. data/spec/configuration_spec.rb +0 -1
  161. data/spec/spec_helper.rb +0 -1
  162. metadata +4 -2
@@ -6,7 +6,6 @@
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.27
10
9
 
11
10
  =end
12
11
 
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
19
18
  def initialize(api_client = ApiClient.default)
20
19
  @api_client = api_client
21
20
  end
21
+
22
+ extend Gem::Deprecate
23
+
22
24
  # Create a Private Invitation to a Course
23
25
  # Creates a private invitation job which sends emails with a link to the course. Invitations are meant as a way to provide access to your content. Registrations will be created from the provided email addresses. The email job will asynchronously send emails to those addresses inviting them to the course. When the learners visit the link in the email, the course will be launched with the already created registration. The private invitation ID can be used with GetPrivateInvitationJobStatus to view the status of the email job. >**Info:** >While invitations are a way to provide access to your content, the majority of use cases would be better suited by creating a registration and building a launch link with the registration endpoints instead. Invitations build upon registrations by grouping a set of registrations together and adding access control measures to said group. Invitations could be used to pass yearly compliance training to an entire company. Invitations also have an associated expiration date which determines when the course will no longer be launchable.
24
26
  # @param private_invitation_request
@@ -73,6 +75,7 @@ module RusticiSoftwareCloudV2
73
75
  end
74
76
  return data, status_code, headers
75
77
  end
78
+
76
79
  # Create a Public Invitation to a Course
77
80
  # Creates an invitation link to the course which can then be publicly distributed. Invitations are meant as a way to provide access to your content. When a learner visits the link, they will be prompted for name and email, a registration will be created from the information provided, and they will be redirected to the course. Since anyone visiting the link will create a registration, it is highly advised that you set the `registrationCap` parameter when calling this method. >**Info:** >While invitations are a way to provide access to your content, the majority of use cases would be better suited by creating a registration and building a launch link with the registration endpoints instead. Invitations build upon registrations by grouping a set of registrations together and adding access control measures to said group. Invitations could be used to pass yearly compliance training to an entire company. Invitations also have an associated expiration date which determines when the course will no longer be launchable.
78
81
  # @param public_invitation_request A description of the public invitation to be created.
@@ -127,6 +130,7 @@ module RusticiSoftwareCloudV2
127
130
  end
128
131
  return data, status_code, headers
129
132
  end
133
+
130
134
  # Delete tags from an Invitation
131
135
  # Deletes the specified tags from the invitation. Deleting tags that do not exist will still result in a success.
132
136
  # @param invitation_id
@@ -186,6 +190,7 @@ module RusticiSoftwareCloudV2
186
190
  end
187
191
  return data, status_code, headers
188
192
  end
193
+
189
194
  # Get a list of Invitations
190
195
  # Returns a list of invitations (both public and private). 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.
191
196
  # @param [Hash] opts the optional parameters
@@ -198,6 +203,7 @@ module RusticiSoftwareCloudV2
198
203
  # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to invitation_id)
199
204
  # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
200
205
  # @option opts [String] :more Pagination token returned as `more` property of multi page list requests
206
+ # @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the `more` token. (default to false)
201
207
  # @return [InvitationSummaryList]
202
208
  def get_all_invitations(opts = {})
203
209
  data, _status_code, _headers = get_all_invitations_with_http_info(opts)
@@ -216,6 +222,7 @@ module RusticiSoftwareCloudV2
216
222
  # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
217
223
  # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
218
224
  # @option opts [String] :more Pagination token returned as `more` property of multi page list requests
225
+ # @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the `more` token.
219
226
  # @return [Array<(InvitationSummaryList, Fixnum, Hash)>] InvitationSummaryList data, response status code and response headers
220
227
  def get_all_invitations_with_http_info(opts = {})
221
228
  if @api_client.config.debugging
@@ -235,6 +242,7 @@ module RusticiSoftwareCloudV2
235
242
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
236
243
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
237
244
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
245
+ query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
238
246
 
239
247
  # header parameters
240
248
  header_params = {}
@@ -261,6 +269,7 @@ module RusticiSoftwareCloudV2
261
269
  end
262
270
  return data, status_code, headers
263
271
  end
272
+
264
273
  # Get tags for an Invitation
265
274
  # Returns the tags for the invitation.
266
275
  # @param invitation_id
@@ -315,6 +324,7 @@ module RusticiSoftwareCloudV2
315
324
  end
316
325
  return data, status_code, headers
317
326
  end
327
+
318
328
  # Get detailed information about a Private Invitation
319
329
  # Returns detailed information about the private invitation. This includes the email sent, course ID, and whether new the invitation can still be launched or not.
320
330
  # @param invitation_id
@@ -372,6 +382,7 @@ module RusticiSoftwareCloudV2
372
382
  end
373
383
  return data, status_code, headers
374
384
  end
385
+
375
386
  # Get email job status for a Private Invitation
376
387
  # Check the status of a private invitation email job. This can be called incrementally to check the progress of the emails.
377
388
  # @param invitation_id
@@ -426,6 +437,7 @@ module RusticiSoftwareCloudV2
426
437
  end
427
438
  return data, status_code, headers
428
439
  end
440
+
429
441
  # Get a list of Private Invitations
430
442
  # Returns a list of private invitations. 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.
431
443
  # @param [Hash] opts the optional parameters
@@ -438,6 +450,7 @@ module RusticiSoftwareCloudV2
438
450
  # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to invitation_id)
439
451
  # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
440
452
  # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
453
+ # @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token. (default to false)
441
454
  # @return [PrivateInvitationList]
442
455
  def get_private_invitations(opts = {})
443
456
  data, _status_code, _headers = get_private_invitations_with_http_info(opts)
@@ -456,6 +469,7 @@ module RusticiSoftwareCloudV2
456
469
  # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
457
470
  # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
458
471
  # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
472
+ # @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token.
459
473
  # @return [Array<(PrivateInvitationList, Fixnum, Hash)>] PrivateInvitationList data, response status code and response headers
460
474
  def get_private_invitations_with_http_info(opts = {})
461
475
  if @api_client.config.debugging
@@ -475,6 +489,7 @@ module RusticiSoftwareCloudV2
475
489
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
476
490
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
477
491
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
492
+ query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
478
493
 
479
494
  # header parameters
480
495
  header_params = {}
@@ -501,6 +516,7 @@ module RusticiSoftwareCloudV2
501
516
  end
502
517
  return data, status_code, headers
503
518
  end
519
+
504
520
  # Get a list of Private User Invitations
505
521
  # Get a list of user who were invited to view the course. 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.
506
522
  # @param invitation_id
@@ -513,6 +529,7 @@ module RusticiSoftwareCloudV2
513
529
  # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
514
530
  # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
515
531
  # @option opts [BOOLEAN] :include_registration_report Optional flag to include basic registration information
532
+ # @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token. (default to false)
516
533
  # @return [UserInvitationList]
517
534
  def get_private_user_invitations(invitation_id, opts = {})
518
535
  data, _status_code, _headers = get_private_user_invitations_with_http_info(invitation_id, opts)
@@ -531,6 +548,7 @@ module RusticiSoftwareCloudV2
531
548
  # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
532
549
  # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
533
550
  # @option opts [BOOLEAN] :include_registration_report Optional flag to include basic registration information
551
+ # @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token.
534
552
  # @return [Array<(UserInvitationList, Fixnum, Hash)>] UserInvitationList data, response status code and response headers
535
553
  def get_private_user_invitations_with_http_info(invitation_id, opts = {})
536
554
  if @api_client.config.debugging
@@ -553,6 +571,7 @@ module RusticiSoftwareCloudV2
553
571
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
554
572
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
555
573
  query_params[:'includeRegistrationReport'] = opts[:'include_registration_report'] if !opts[:'include_registration_report'].nil?
574
+ query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
556
575
 
557
576
  # header parameters
558
577
  header_params = {}
@@ -579,6 +598,7 @@ module RusticiSoftwareCloudV2
579
598
  end
580
599
  return data, status_code, headers
581
600
  end
601
+
582
602
  # Get detailed information about a Public Invitation
583
603
  # Returns detailed information about the public invitation. This includes url, registration cap, and whether new learners can accept the invitation or not.
584
604
  # @param invitation_id
@@ -636,6 +656,7 @@ module RusticiSoftwareCloudV2
636
656
  end
637
657
  return data, status_code, headers
638
658
  end
659
+
639
660
  # Get a list of Public Invitations
640
661
  # Returns a list of public invitations. 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.
641
662
  # @param [Hash] opts the optional parameters
@@ -648,6 +669,7 @@ module RusticiSoftwareCloudV2
648
669
  # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to invitation_id)
649
670
  # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
650
671
  # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
672
+ # @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token. (default to false)
651
673
  # @return [PublicInvitationList]
652
674
  def get_public_invitations(opts = {})
653
675
  data, _status_code, _headers = get_public_invitations_with_http_info(opts)
@@ -666,6 +688,7 @@ module RusticiSoftwareCloudV2
666
688
  # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
667
689
  # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
668
690
  # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
691
+ # @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token.
669
692
  # @return [Array<(PublicInvitationList, Fixnum, Hash)>] PublicInvitationList data, response status code and response headers
670
693
  def get_public_invitations_with_http_info(opts = {})
671
694
  if @api_client.config.debugging
@@ -685,6 +708,7 @@ module RusticiSoftwareCloudV2
685
708
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
686
709
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
687
710
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
711
+ query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
688
712
 
689
713
  # header parameters
690
714
  header_params = {}
@@ -711,6 +735,7 @@ module RusticiSoftwareCloudV2
711
735
  end
712
736
  return data, status_code, headers
713
737
  end
738
+
714
739
  # Get a list of Public User Invitations
715
740
  # Returns a list of users who have visited the public invitation link. 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.
716
741
  # @param invitation_id
@@ -723,6 +748,7 @@ module RusticiSoftwareCloudV2
723
748
  # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
724
749
  # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
725
750
  # @option opts [BOOLEAN] :include_registration_report Optional flag to include basic registration information
751
+ # @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token. (default to false)
726
752
  # @return [UserInvitationList]
727
753
  def get_public_user_invitations(invitation_id, opts = {})
728
754
  data, _status_code, _headers = get_public_user_invitations_with_http_info(invitation_id, opts)
@@ -741,6 +767,7 @@ module RusticiSoftwareCloudV2
741
767
  # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
742
768
  # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
743
769
  # @option opts [BOOLEAN] :include_registration_report Optional flag to include basic registration information
770
+ # @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token.
744
771
  # @return [Array<(UserInvitationList, Fixnum, Hash)>] UserInvitationList data, response status code and response headers
745
772
  def get_public_user_invitations_with_http_info(invitation_id, opts = {})
746
773
  if @api_client.config.debugging
@@ -763,6 +790,7 @@ module RusticiSoftwareCloudV2
763
790
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
764
791
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
765
792
  query_params[:'includeRegistrationReport'] = opts[:'include_registration_report'] if !opts[:'include_registration_report'].nil?
793
+ query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
766
794
 
767
795
  # header parameters
768
796
  header_params = {}
@@ -789,6 +817,7 @@ module RusticiSoftwareCloudV2
789
817
  end
790
818
  return data, status_code, headers
791
819
  end
820
+
792
821
  # Add tags to an Invitation
793
822
  # Applies the provided tags to the invitation. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetInvitations).
794
823
  # @param invitation_id
@@ -848,6 +877,7 @@ module RusticiSoftwareCloudV2
848
877
  end
849
878
  return data, status_code, headers
850
879
  end
880
+
851
881
  # Add a group of tags to a group of Invitations
852
882
  # Applies all of the provided tags on all of the provided invitations. Both public and private invitations may be tagged via this operation. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetInvitations).
853
883
  # @param batch Array of ids, and array of tags for bulk tag operations
@@ -901,6 +931,7 @@ module RusticiSoftwareCloudV2
901
931
  end
902
932
  return data, status_code, headers
903
933
  end
934
+
904
935
  # Update information about a Private Invitation
905
936
  # Updates information about the private invitation, such as the expiration date and registration cap. Only non-null values that are provided will be updated.
906
937
  # @param invitation_id
@@ -961,6 +992,7 @@ module RusticiSoftwareCloudV2
961
992
  end
962
993
  return data, status_code, headers
963
994
  end
995
+
964
996
  # Update information about a Public Invitation
965
997
  # Updates information about the public invitation, such as the expiration date and registration cap. Only non-null values that are provided will be updated.
966
998
  # @param invitation_id
@@ -6,7 +6,6 @@
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.27
10
9
 
11
10
  =end
12
11
 
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
19
18
  def initialize(api_client = ApiClient.default)
20
19
  @api_client = api_client
21
20
  end
21
+
22
+ extend Gem::Deprecate
23
+
22
24
  # Deletes all PII for a learnerId
23
25
  # 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
26
  # @param learner_id The id of the learner
@@ -79,6 +81,7 @@ module RusticiSoftwareCloudV2
79
81
  end
80
82
  return data, status_code, headers
81
83
  end
84
+
82
85
  # Delete tags from a learnerId
83
86
  # Delete the specified tags from the learner. Deleting tags that do not exist will still result in a success.
84
87
  # @param learner_id The id of the learner
@@ -138,6 +141,7 @@ module RusticiSoftwareCloudV2
138
141
  end
139
142
  return data, status_code, headers
140
143
  end
144
+
141
145
  # Get tags for a learnerId
142
146
  # Returns the tags for the learner.
143
147
  # @param learner_id The id of the learner
@@ -192,6 +196,7 @@ module RusticiSoftwareCloudV2
192
196
  end
193
197
  return data, status_code, headers
194
198
  end
199
+
195
200
  # Add tags to a learnerId
196
201
  # 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
202
  # @param learner_id The id of the learner
@@ -251,6 +256,7 @@ module RusticiSoftwareCloudV2
251
256
  end
252
257
  return data, status_code, headers
253
258
  end
259
+
254
260
  # Add a group of tags to a group of learnerIds
255
261
  # 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
262
  # @param batch Array of ids, and array of tags for bulk tag operations
@@ -304,6 +310,7 @@ module RusticiSoftwareCloudV2
304
310
  end
305
311
  return data, status_code, headers
306
312
  end
313
+
307
314
  # Update all Registrations for a learnerId
308
315
  # 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
316
  # @param learner_id The id of the learner
@@ -6,7 +6,6 @@
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.27
10
9
 
11
10
  =end
12
11
 
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
19
18
  def initialize(api_client = ApiClient.default)
20
19
  @api_client = api_client
21
20
  end
21
+
22
+ extend Gem::Deprecate
23
+
22
24
  # Ping the API
23
25
  # Get back a message indicating that the API is working.
24
26
  # @param [Hash] opts the optional parameters
@@ -6,7 +6,6 @@
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.27
10
9
 
11
10
  =end
12
11
 
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
19
18
  def initialize(api_client = ApiClient.default)
20
19
  @api_client = api_client
21
20
  end
21
+
22
+ extend Gem::Deprecate
23
+
22
24
  # Get a launch link for a Registration
23
25
  # 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
26
  # @param registration_id
@@ -79,6 +81,7 @@ module RusticiSoftwareCloudV2
79
81
  end
80
82
  return data, status_code, headers
81
83
  end
84
+
82
85
  # Create a Registration Instance
83
86
  # 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
87
  # @param registration_id
@@ -132,6 +135,7 @@ module RusticiSoftwareCloudV2
132
135
  end
133
136
  return data, status_code, headers
134
137
  end
138
+
135
139
  # Create a Registration
136
140
  # 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.
137
141
  # @param registration
@@ -188,6 +192,7 @@ module RusticiSoftwareCloudV2
188
192
  end
189
193
  return data, status_code, headers
190
194
  end
195
+
191
196
  # Delete a Registration
192
197
  # Deletes the specified registration. >**Caution:** >This will also delete all instances of the registration.
193
198
  # @param registration_id
@@ -241,6 +246,7 @@ module RusticiSoftwareCloudV2
241
246
  end
242
247
  return data, status_code, headers
243
248
  end
249
+
244
250
  # Delete a configuration setting explicitly set for a Registration
245
251
  # 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
252
  # @param registration_id
@@ -300,6 +306,7 @@ module RusticiSoftwareCloudV2
300
306
  end
301
307
  return data, status_code, headers
302
308
  end
309
+
303
310
  # Reset global data for a Registration
304
311
  # 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
312
  # @param registration_id
@@ -353,6 +360,7 @@ module RusticiSoftwareCloudV2
353
360
  end
354
361
  return data, status_code, headers
355
362
  end
363
+
356
364
  # Delete a Registration Instance
357
365
  # 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
366
  # @param registration_id
@@ -412,6 +420,7 @@ module RusticiSoftwareCloudV2
412
420
  end
413
421
  return data, status_code, headers
414
422
  end
423
+
415
424
  # Delete a configuration setting explicitly set for a Registration Instance
416
425
  # 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
426
  # @param registration_id
@@ -477,6 +486,7 @@ module RusticiSoftwareCloudV2
477
486
  end
478
487
  return data, status_code, headers
479
488
  end
489
+
480
490
  # Reset a Registration
481
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.
482
492
  # @param registration_id
@@ -530,6 +540,7 @@ module RusticiSoftwareCloudV2
530
540
  end
531
541
  return data, status_code, headers
532
542
  end
543
+
533
544
  # Delete tags from a Registration
534
545
  # Deletes the specified tags from the registration. Deleting tags that do not exist will still result in a success.
535
546
  # @param registration_id
@@ -589,6 +600,7 @@ module RusticiSoftwareCloudV2
589
600
  end
590
601
  return data, status_code, headers
591
602
  end
603
+
592
604
  # Check that a Registration exists
593
605
  # 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
606
  # @param registration_id
@@ -642,6 +654,7 @@ module RusticiSoftwareCloudV2
642
654
  end
643
655
  return data, status_code, headers
644
656
  end
657
+
645
658
  # Get effective configuration settings for a Registration
646
659
  # 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
660
  # @param registration_id
@@ -699,6 +712,7 @@ module RusticiSoftwareCloudV2
699
712
  end
700
713
  return data, status_code, headers
701
714
  end
715
+
702
716
  # Get effective configuration settings for a Registration Instance
703
717
  # 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
718
  # @param registration_id
@@ -762,6 +776,7 @@ module RusticiSoftwareCloudV2
762
776
  end
763
777
  return data, status_code, headers
764
778
  end
779
+
765
780
  # Get launch history for a Registration Instance
766
781
  # Returns the launch history of the registration instance. This includes completion status, time taken, and pass/fail status.
767
782
  # @param registration_id
@@ -825,6 +840,7 @@ module RusticiSoftwareCloudV2
825
840
  end
826
841
  return data, status_code, headers
827
842
  end
843
+
828
844
  # Get detailed information about a Registration Instance
829
845
  # Returns detailed information about the registration instance. This includes completion status, time taken, score, and pass/fail status.
830
846
  # @param registration_id
@@ -894,6 +910,7 @@ module RusticiSoftwareCloudV2
894
910
  end
895
911
  return data, status_code, headers
896
912
  end
913
+
897
914
  # Get xAPI statements for a Registration Instance
898
915
  # Returns xAPI statements for the registration instance.
899
916
  # @param registration_id
@@ -963,6 +980,7 @@ module RusticiSoftwareCloudV2
963
980
  end
964
981
  return data, status_code, headers
965
982
  end
983
+
966
984
  # Get a list of a Registration's Instances
967
985
  # 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
986
  # @param registration_id
@@ -1035,6 +1053,7 @@ module RusticiSoftwareCloudV2
1035
1053
  end
1036
1054
  return data, status_code, headers
1037
1055
  end
1056
+
1038
1057
  # Get launch history for a Registration
1039
1058
  # Returns the launch history of the registration. This includes completion status, time taken, and pass/fail status.
1040
1059
  # @param registration_id
@@ -1092,6 +1111,7 @@ module RusticiSoftwareCloudV2
1092
1111
  end
1093
1112
  return data, status_code, headers
1094
1113
  end
1114
+
1095
1115
  # Get detailed information about a Registration
1096
1116
  # 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
1117
  # @param registration_id
@@ -1155,6 +1175,7 @@ module RusticiSoftwareCloudV2
1155
1175
  end
1156
1176
  return data, status_code, headers
1157
1177
  end
1178
+
1158
1179
  # Get xAPI statements for a Registration
1159
1180
  # Returns xAPI statements for the registration.
1160
1181
  # @param registration_id
@@ -1218,6 +1239,7 @@ module RusticiSoftwareCloudV2
1218
1239
  end
1219
1240
  return data, status_code, headers
1220
1241
  end
1242
+
1221
1243
  # Get tags for a Registration
1222
1244
  # Returns the tags for the registration.
1223
1245
  # @param registration_id
@@ -1272,6 +1294,7 @@ module RusticiSoftwareCloudV2
1272
1294
  end
1273
1295
  return data, status_code, headers
1274
1296
  end
1297
+
1275
1298
  # Get a list of Registrations
1276
1299
  # 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.
1277
1300
  # @param [Hash] opts the optional parameters
@@ -1288,6 +1311,7 @@ module RusticiSoftwareCloudV2
1288
1311
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results (default to false)
1289
1312
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results (default to false)
1290
1313
  # @option opts [BOOLEAN] :include_runtime Include runtime details in the results (default to false)
1314
+ # @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token. (default to false)
1291
1315
  # @return [RegistrationListSchema]
1292
1316
  def get_registrations(opts = {})
1293
1317
  data, _status_code, _headers = get_registrations_with_http_info(opts)
@@ -1310,6 +1334,7 @@ module RusticiSoftwareCloudV2
1310
1334
  # @option opts [BOOLEAN] :include_child_results Include information about each learning object, not just the top level in the results
1311
1335
  # @option opts [BOOLEAN] :include_interactions_and_objectives Include interactions and objectives in the results
1312
1336
  # @option opts [BOOLEAN] :include_runtime Include runtime details in the results
1337
+ # @option opts [BOOLEAN] :include_total_count Include the total count of results matching the provided filters as a header on the initial request. The header will not be present on subsequent requests resulting from passing the &#x60;more&#x60; token.
1313
1338
  # @return [Array<(RegistrationListSchema, Fixnum, Hash)>] RegistrationListSchema data, response status code and response headers
1314
1339
  def get_registrations_with_http_info(opts = {})
1315
1340
  if @api_client.config.debugging
@@ -1333,6 +1358,7 @@ module RusticiSoftwareCloudV2
1333
1358
  query_params[:'includeChildResults'] = opts[:'include_child_results'] if !opts[:'include_child_results'].nil?
1334
1359
  query_params[:'includeInteractionsAndObjectives'] = opts[:'include_interactions_and_objectives'] if !opts[:'include_interactions_and_objectives'].nil?
1335
1360
  query_params[:'includeRuntime'] = opts[:'include_runtime'] if !opts[:'include_runtime'].nil?
1361
+ query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
1336
1362
 
1337
1363
  # header parameters
1338
1364
  header_params = {}
@@ -1359,6 +1385,7 @@ module RusticiSoftwareCloudV2
1359
1385
  end
1360
1386
  return data, status_code, headers
1361
1387
  end
1388
+
1362
1389
  # Add tags to a Registration
1363
1390
  # 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
1391
  # @param registration_id
@@ -1418,6 +1445,7 @@ module RusticiSoftwareCloudV2
1418
1445
  end
1419
1446
  return data, status_code, headers
1420
1447
  end
1448
+
1421
1449
  # Add a group of tags to a group of Registrations
1422
1450
  # 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
1451
  # @param batch Array of ids, and array of tags for bulk tag operations
@@ -1471,6 +1499,7 @@ module RusticiSoftwareCloudV2
1471
1499
  end
1472
1500
  return data, status_code, headers
1473
1501
  end
1502
+
1474
1503
  # Update configuration settings for a Registration
1475
1504
  # 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
1505
  # @param registration_id
@@ -1530,6 +1559,7 @@ module RusticiSoftwareCloudV2
1530
1559
  end
1531
1560
  return data, status_code, headers
1532
1561
  end
1562
+
1533
1563
  # Update configuration settings for a Registration Instance
1534
1564
  # 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
1565
  # @param registration_id
@@ -1595,6 +1625,7 @@ module RusticiSoftwareCloudV2
1595
1625
  end
1596
1626
  return data, status_code, headers
1597
1627
  end
1628
+
1598
1629
  # Send a test postback with the provided configuration
1599
1630
  # Sends a postback with dummy data to the url specified. The postback will use additional information from the configuration provided with the request (e.g. a provided username/password will be sent along with the postback to allow for logging in to a secure page. The format of the data sent will differ depending on whether `httpbasic` or `form` is passed for `authType`. - With httpbasic, an authorization header will be sent with the base64 encoded credentials. The body will be JSON formatted data. - With form, the username and password will be sent in the body of the request along with the data. The whole body will be url encoded. >**Note:** >The data that will be sent to the provided url is the same format as the output of the GetRegistrationProgress endpoint.
1600
1631
  # @param post_back
@@ -6,7 +6,6 @@
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.27
10
9
 
11
10
  =end
12
11
 
@@ -19,6 +18,9 @@ module RusticiSoftwareCloudV2
19
18
  def initialize(api_client = ApiClient.default)
20
19
  @api_client = api_client
21
20
  end
21
+
22
+ extend Gem::Deprecate
23
+
22
24
  # Get account information
23
25
  # Returns all of the account information for the specified application.
24
26
  # @param [Hash] opts the optional parameters
@@ -67,6 +69,7 @@ module RusticiSoftwareCloudV2
67
69
  end
68
70
  return data, status_code, headers
69
71
  end
72
+
70
73
  # Get a Reportage session authentication token
71
74
  # Returns a session authentication token to use when launching Reportage.
72
75
  # @param nav_permission The navigation permissions for this Reportage session
@@ -125,6 +128,7 @@ module RusticiSoftwareCloudV2
125
128
  end
126
129
  return data, status_code, headers
127
130
  end
131
+
128
132
  # Get a link to a page in Reportage with the given permissions
129
133
  # Returns the link to use for viewing Reportage. In order to generate a link, GetReportageAuthToken will need to be called to generate an auth token with the necessary permissions.
130
134
  # @param auth The Reportage authentication token retrieved from a previous call to &#x60;GET reportageAuth&#x60;