rustici_software_cloud_v2 2.0.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 +5 -5
  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 +241 -0
  7. data/lib/rustici_software_cloud_v2/api/course_api.rb +158 -3
  8. data/lib/rustici_software_cloud_v2/api/dispatch_api.rb +229 -3
  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 -1
  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 +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 +2 -2
  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 +2 -2
  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 +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 +32 -5
  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 +186 -0
  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 +207 -0
  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 +15 -6
  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 +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 +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 +11 -2
  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 +196 -0
  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 +11 -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 +14 -3
@@ -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.12
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 group of Destinations
23
25
  # Creates a group of destinations. A destination is a label used to identify an entity outside of SCORM Cloud, such as an LMS. Used in conjunction with dispatches to provide access control mechanisms for the courses distributed to the destination.
24
26
  # @param destinations_list
@@ -72,6 +74,7 @@ module RusticiSoftwareCloudV2
72
74
  end
73
75
  return data, status_code, headers
74
76
  end
77
+
75
78
  # Create a group of Dispatches
76
79
  # Creates a group of dispatches. Dispatches are the connection between a course and a destination. A dispatch zip package is a distributable course stub which, upon launch in a third-party LMS, will reference and launch the underlying course in SCORM Cloud. As an extension, dispatches allow for limiting access control even after the zip file has been given to the destination. >**Caution:** >Only one dispatch can exist for a given course-destination combination. If calling this method with the same course and destination supplied, the old one will be loaded for modification. An exception to this is if a dispatchId is passed in the body, the request will fail with a 400 response warning that the dispatch already exists. This is to prevent confusion over which dispatchId is to be used in future requests.
77
80
  # @param dispatch_list
@@ -125,6 +128,7 @@ module RusticiSoftwareCloudV2
125
128
  end
126
129
  return data, status_code, headers
127
130
  end
131
+
128
132
  # Delete a Destination
129
133
  # Deletes the specified destination. >**Caution:** >This will also delete all dispatches belonging to the destination.
130
134
  # @param destination_id Identifier for the destination
@@ -178,6 +182,7 @@ module RusticiSoftwareCloudV2
178
182
  end
179
183
  return data, status_code, headers
180
184
  end
185
+
181
186
  # Delete a Destination's Dispatches
182
187
  # Deletes all the dispatches from the destination. >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable.
183
188
  # @param destination_id Identifier for the destination
@@ -231,6 +236,7 @@ module RusticiSoftwareCloudV2
231
236
  end
232
237
  return data, status_code, headers
233
238
  end
239
+
234
240
  # Delete tags from a Destination
235
241
  # Deletes the specified tags from the destination. Deleting tags that do not exist will still result in a success.
236
242
  # @param destination_id Identifier for the destination
@@ -290,6 +296,7 @@ module RusticiSoftwareCloudV2
290
296
  end
291
297
  return data, status_code, headers
292
298
  end
299
+
293
300
  # Delete a Dispatch
294
301
  # Deletes the specified dispatch. >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable.
295
302
  # @param dispatch_id Identifier for the dispatch
@@ -343,6 +350,7 @@ module RusticiSoftwareCloudV2
343
350
  end
344
351
  return data, status_code, headers
345
352
  end
353
+
346
354
  # Delete postback information from a Dispatch
347
355
  # Clears the postback settings from the dispatch. This causes the postback settings to inherit a value from a higher level (e.g. application). If there is no setting at the application level, this will disable postbacks for the dispatch.
348
356
  # @param dispatch_id Identifier for the dispatch
@@ -396,6 +404,7 @@ module RusticiSoftwareCloudV2
396
404
  end
397
405
  return data, status_code, headers
398
406
  end
407
+
399
408
  # Delete tags from a Dispatch
400
409
  # Deletes the specified tags from the dispatch. Deleting tags that do not exist will still result in a success.
401
410
  # @param dispatch_id Identifier for the dispatch
@@ -455,6 +464,7 @@ module RusticiSoftwareCloudV2
455
464
  end
456
465
  return data, status_code, headers
457
466
  end
467
+
458
468
  # Delete a group of Dispatches
459
469
  # Deletes the specified group of dispatches. Can be filtered using the request parameters to provide a subset of results. >**Caution:** >This will invalidate any existing dispatch packages, rendering them unlaunchable. >**Note:** >One of the filter parameters (i.e. `courseId`, `since`/`until`, `tags`, or `filter`) needs to be provided. This is to prevent accidental deletion of all dispatches. If you do wish to update all dispatches, try setting the since parameter to a value prior to the creation of any dispatches. >**Info:** >If using one of our client libraries, refer to its README for additional information on how to work with the `X-Total-Count` header.
460
470
  # @param [Hash] opts the optional parameters
@@ -523,6 +533,7 @@ module RusticiSoftwareCloudV2
523
533
  end
524
534
  return data, status_code, headers
525
535
  end
536
+
526
537
  # Update registration instancing status for a Destination's Dispatches
527
538
  # Updates the restration instancing status for all dispatches distributed to the destination. Registration instancing is the default for dispatches, in order to support versioning of dispatches. A small portion of users may experience duplicate registrations with content dispatched to some LMS platforms. If you happen to be dispatching content to an LMS with this issue, disabling registration instancing here will resolve the problems. However, dispatch versioning will also be disabled.
528
539
  # @param destination_id Identifier for the destination
@@ -582,6 +593,7 @@ module RusticiSoftwareCloudV2
582
593
  end
583
594
  return data, status_code, headers
584
595
  end
596
+
585
597
  # Get detailed information about a Destination
586
598
  # Returns detailed information about the destination. This includes name, tags, and launchAuth information.
587
599
  # @param destination_id Identifier for the destination
@@ -636,6 +648,7 @@ module RusticiSoftwareCloudV2
636
648
  end
637
649
  return data, status_code, headers
638
650
  end
651
+
639
652
  # Get registration count for a Destination's Dispatches
640
653
  # Returns the registration count for all dispatches distributed to the destination. >**Note:** >The count here is a convenience counter. Since it has the capability of being reset, it may not match the actual billed registration count for a dispatch.
641
654
  # @param destination_id Identifier for the destination
@@ -690,6 +703,7 @@ module RusticiSoftwareCloudV2
690
703
  end
691
704
  return data, status_code, headers
692
705
  end
706
+
693
707
  # Download a zip file for a Destination's Dispatches
694
708
  # Downloads a zip file containing all of the dispatch packages for the destination. A dispatch zip package is a distributable course stub which, upon launch in a third-party LMS, will reference and launch the underlying course in SCORM Cloud.
695
709
  # @param destination_id Identifier for the destination
@@ -753,6 +767,7 @@ module RusticiSoftwareCloudV2
753
767
  end
754
768
  return data, status_code, headers
755
769
  end
770
+
756
771
  # Get a list of a Destination's Dispatches
757
772
  # Returns a list of dispatches belonging to the destination. Can be filtered using the request parameters to provide a subset of results. Using the `courseId` filter should only ever yield 0 or 1 results, as a dispatch is the intersection of a course and a destination. This can be useful for identifying if a certain course is dispatched to the destination. >**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.
758
773
  # @param destination_id Identifier for the destination
@@ -766,6 +781,7 @@ module RusticiSoftwareCloudV2
766
781
  # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to dispatch_id)
767
782
  # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
768
783
  # @option opts [String] :more Pagination token returned as `more` property of multi page list requests
784
+ # @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)
769
785
  # @return [DispatchListSchema]
770
786
  def get_destination_dispatches(destination_id, opts = {})
771
787
  data, _status_code, _headers = get_destination_dispatches_with_http_info(destination_id, opts)
@@ -785,6 +801,7 @@ module RusticiSoftwareCloudV2
785
801
  # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
786
802
  # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
787
803
  # @option opts [String] :more Pagination token returned as `more` property of multi page list requests
804
+ # @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.
788
805
  # @return [Array<(DispatchListSchema, Fixnum, Hash)>] DispatchListSchema data, response status code and response headers
789
806
  def get_destination_dispatches_with_http_info(destination_id, opts = {})
790
807
  if @api_client.config.debugging
@@ -808,6 +825,7 @@ module RusticiSoftwareCloudV2
808
825
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
809
826
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
810
827
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
828
+ query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
811
829
 
812
830
  # header parameters
813
831
  header_params = {}
@@ -834,6 +852,7 @@ module RusticiSoftwareCloudV2
834
852
  end
835
853
  return data, status_code, headers
836
854
  end
855
+
837
856
  # Get user PII hashing status for a Destination
838
857
  # Returns whether or not user PII hashing is enabled for the destination. Enabling it will cause all user PII to be hashed. Hashing PII will anonymize the learner data from the dispatched course. This will make looking up specific details about a learner difficult.
839
858
  # @param destination_id Identifier for the destination
@@ -888,6 +907,7 @@ module RusticiSoftwareCloudV2
888
907
  end
889
908
  return data, status_code, headers
890
909
  end
910
+
891
911
  # Get tags for a Destination
892
912
  # Returns the tags for the destination.
893
913
  # @param destination_id Identifier for the destination
@@ -942,6 +962,7 @@ module RusticiSoftwareCloudV2
942
962
  end
943
963
  return data, status_code, headers
944
964
  end
965
+
945
966
  # Get a list of Destinations
946
967
  # Returns a list of destinations. 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.
947
968
  # @param [Hash] opts the optional parameters
@@ -954,6 +975,7 @@ module RusticiSoftwareCloudV2
954
975
  # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to destination_id)
955
976
  # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
956
977
  # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
978
+ # @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)
957
979
  # @return [DestinationListSchema]
958
980
  def get_destinations(opts = {})
959
981
  data, _status_code, _headers = get_destinations_with_http_info(opts)
@@ -972,6 +994,7 @@ module RusticiSoftwareCloudV2
972
994
  # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
973
995
  # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
974
996
  # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
997
+ # @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.
975
998
  # @return [Array<(DestinationListSchema, Fixnum, Hash)>] DestinationListSchema data, response status code and response headers
976
999
  def get_destinations_with_http_info(opts = {})
977
1000
  if @api_client.config.debugging
@@ -991,6 +1014,7 @@ module RusticiSoftwareCloudV2
991
1014
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
992
1015
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
993
1016
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
1017
+ query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
994
1018
 
995
1019
  # header parameters
996
1020
  header_params = {}
@@ -1017,6 +1041,7 @@ module RusticiSoftwareCloudV2
1017
1041
  end
1018
1042
  return data, status_code, headers
1019
1043
  end
1044
+
1020
1045
  # Get detailed information about a Dispatch
1021
1046
  # Returns detailed information about the dispatch. This includes destination and course IDs, as well as registration count.
1022
1047
  # @param dispatch_id Identifier for the dispatch
@@ -1071,6 +1096,7 @@ module RusticiSoftwareCloudV2
1071
1096
  end
1072
1097
  return data, status_code, headers
1073
1098
  end
1099
+
1074
1100
  # Get enabled status of a Dispatch
1075
1101
  # Returns the enabled status for the dispatch. This is an access control measure allowing you to turn access to a previously distributed dispatch packages on or off.
1076
1102
  # @param dispatch_id Identifier for the dispatch
@@ -1125,6 +1151,7 @@ module RusticiSoftwareCloudV2
1125
1151
  end
1126
1152
  return data, status_code, headers
1127
1153
  end
1154
+
1128
1155
  # Get user PII hashing status for a Dispatch
1129
1156
  # Returns whether or not user PII hashing is enabled for the dispatch. Enabling it will cause all user PII to be hashed. Hashing PII will anonymize the learner data from the dispatched course. This will make looking up specific details about a learner difficult.
1130
1157
  # @param dispatch_id Identifier for the dispatch
@@ -1179,6 +1206,7 @@ module RusticiSoftwareCloudV2
1179
1206
  end
1180
1207
  return data, status_code, headers
1181
1208
  end
1209
+
1182
1210
  # Get registration count for a Dispatch
1183
1211
  # Returns the registration count for the dispatch, as well as the date and time of the last count reset, if any. >**Note:** >The count here is a convenience counter. Since it has the capability of being reset, it may not match the actual billed registration count for a dispatch.
1184
1212
  # @param dispatch_id Identifier for the dispatch
@@ -1233,6 +1261,7 @@ module RusticiSoftwareCloudV2
1233
1261
  end
1234
1262
  return data, status_code, headers
1235
1263
  end
1264
+
1236
1265
  # Get tags for a Dispatch
1237
1266
  # Returns the tags for the dispatch.
1238
1267
  # @param dispatch_id Identifier for the dispatch
@@ -1287,6 +1316,7 @@ module RusticiSoftwareCloudV2
1287
1316
  end
1288
1317
  return data, status_code, headers
1289
1318
  end
1319
+
1290
1320
  # Download a zip package for a Dispatch
1291
1321
  # Downloads a zip package for the dispatch. A dispatch zip package is a distributable course stub which, upon launch in a third-party LMS, will reference and launch the underlying course in SCORM Cloud. As an extension, dispatches allow for limiting access control even after the zip file has been given to the destination.
1292
1322
  # @param dispatch_id Identifier for the dispatch
@@ -1347,6 +1377,7 @@ module RusticiSoftwareCloudV2
1347
1377
  end
1348
1378
  return data, status_code, headers
1349
1379
  end
1380
+
1350
1381
  # Get a list of Dispatches
1351
1382
  # Returns a list of dispatches. Can be filtered using the request parameters to provide a subset of results. Using the `courseId` filter will allow for viewing which destinations the course has been dispatched to. >**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.
1352
1383
  # @param [Hash] opts the optional parameters
@@ -1359,6 +1390,7 @@ module RusticiSoftwareCloudV2
1359
1390
  # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter. (default to dispatch_id)
1360
1391
  # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results. (default to updated_asc)
1361
1392
  # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
1393
+ # @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)
1362
1394
  # @return [DispatchListSchema]
1363
1395
  def get_dispatches(opts = {})
1364
1396
  data, _status_code, _headers = get_dispatches_with_http_info(opts)
@@ -1377,6 +1409,7 @@ module RusticiSoftwareCloudV2
1377
1409
  # @option opts [String] :filter_by Optional enum parameter for specifying the field on which to run the filter.
1378
1410
  # @option opts [String] :order_by Optional enum parameter for specifying the field and order by which to sort the results.
1379
1411
  # @option opts [String] :more Pagination token returned as &#x60;more&#x60; property of multi page list requests
1412
+ # @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.
1380
1413
  # @return [Array<(DispatchListSchema, Fixnum, Hash)>] DispatchListSchema data, response status code and response headers
1381
1414
  def get_dispatches_with_http_info(opts = {})
1382
1415
  if @api_client.config.debugging
@@ -1396,6 +1429,7 @@ module RusticiSoftwareCloudV2
1396
1429
  query_params[:'filterBy'] = opts[:'filter_by'] if !opts[:'filter_by'].nil?
1397
1430
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
1398
1431
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
1432
+ query_params[:'includeTotalCount'] = opts[:'include_total_count'] if !opts[:'include_total_count'].nil?
1399
1433
 
1400
1434
  # header parameters
1401
1435
  header_params = {}
@@ -1422,7 +1456,185 @@ module RusticiSoftwareCloudV2
1422
1456
  end
1423
1457
  return data, status_code, headers
1424
1458
  end
1459
+
1460
+ # Get the information necessary to import this dispatch as a resource link according to the IMS LTI 1.3 specification.
1461
+ # Get the information necessary to import this dispatch as a resource link according to the IMS LTI 1.3 specification. The information from this call will be provided to the platform during the configuration step.
1462
+ # @param dispatch_id Identifier for the dispatch
1463
+ # @param [Hash] opts the optional parameters
1464
+ # @return [DispatchLti13InfoSchema]
1465
+ def get_lti13_dispatch(dispatch_id, opts = {})
1466
+ data, _status_code, _headers = get_lti13_dispatch_with_http_info(dispatch_id, opts)
1467
+ data
1468
+ end
1469
+
1470
+ # Get the information necessary to import this dispatch as a resource link according to the IMS LTI 1.3 specification.
1471
+ # Get the information necessary to import this dispatch as a resource link according to the IMS LTI 1.3 specification. The information from this call will be provided to the platform during the configuration step.
1472
+ # @param dispatch_id Identifier for the dispatch
1473
+ # @param [Hash] opts the optional parameters
1474
+ # @return [Array<(DispatchLti13InfoSchema, Fixnum, Hash)>] DispatchLti13InfoSchema data, response status code and response headers
1475
+ def get_lti13_dispatch_with_http_info(dispatch_id, opts = {})
1476
+ if @api_client.config.debugging
1477
+ @api_client.config.logger.debug 'Calling API: DispatchApi.get_lti13_dispatch ...'
1478
+ end
1479
+ # verify the required parameter 'dispatch_id' is set
1480
+ if dispatch_id.nil?
1481
+ fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_lti13_dispatch"
1482
+ end
1483
+ # resource path
1484
+ local_var_path = '/dispatch/dispatches/{dispatchId}/lti13'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
1485
+
1486
+ # query parameters
1487
+ query_params = {}
1488
+
1489
+ # header parameters
1490
+ header_params = {}
1491
+ # HTTP header 'Accept' (if needed)
1492
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1493
+ # HTTP header 'Content-Type'
1494
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1495
+
1496
+ # form parameters
1497
+ form_params = {}
1498
+
1499
+ # http body (model)
1500
+ post_body = nil
1501
+ auth_names = ['APP_NORMAL', 'OAUTH']
1502
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1503
+ :header_params => header_params,
1504
+ :query_params => query_params,
1505
+ :form_params => form_params,
1506
+ :body => post_body,
1507
+ :auth_names => auth_names,
1508
+ :return_type => 'DispatchLti13InfoSchema')
1509
+ if @api_client.config.debugging
1510
+ @api_client.config.logger.debug "API called: DispatchApi#get_lti13_dispatch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1511
+ end
1512
+ return data, status_code, headers
1513
+ end
1514
+
1515
+ # Launch this dispatch using the IMS LTI 1.3 specification.
1516
+ # Launch this dispatch using the IMS LTI 1.3 specification. This is the final step in the LTI 1.3 launch process, and is the request that redirects to the resource link (i.e. course).
1517
+ # @param dispatch_id Identifier for the dispatch
1518
+ # @param external_config External configuration object
1519
+ # @param jwt
1520
+ # @param [Hash] opts the optional parameters
1521
+ # @return [nil]
1522
+ def get_lti13_dispatch_launch(dispatch_id, external_config, jwt, opts = {})
1523
+ get_lti13_dispatch_launch_with_http_info(dispatch_id, external_config, jwt, opts)
1524
+ nil
1525
+ end
1526
+
1527
+ # Launch this dispatch using the IMS LTI 1.3 specification.
1528
+ # Launch this dispatch using the IMS LTI 1.3 specification. This is the final step in the LTI 1.3 launch process, and is the request that redirects to the resource link (i.e. course).
1529
+ # @param dispatch_id Identifier for the dispatch
1530
+ # @param external_config External configuration object
1531
+ # @param jwt
1532
+ # @param [Hash] opts the optional parameters
1533
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1534
+ def get_lti13_dispatch_launch_with_http_info(dispatch_id, external_config, jwt, opts = {})
1535
+ if @api_client.config.debugging
1536
+ @api_client.config.logger.debug 'Calling API: DispatchApi.get_lti13_dispatch_launch ...'
1537
+ end
1538
+ # verify the required parameter 'dispatch_id' is set
1539
+ if dispatch_id.nil?
1540
+ fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_lti13_dispatch_launch"
1541
+ end
1542
+ # verify the required parameter 'external_config' is set
1543
+ if external_config.nil?
1544
+ fail ArgumentError, "Missing the required parameter 'external_config' when calling DispatchApi.get_lti13_dispatch_launch"
1545
+ end
1546
+ # verify the required parameter 'jwt' is set
1547
+ if jwt.nil?
1548
+ fail ArgumentError, "Missing the required parameter 'jwt' when calling DispatchApi.get_lti13_dispatch_launch"
1549
+ end
1550
+ # resource path
1551
+ local_var_path = '/dispatch/dispatches/{dispatchId}/launches'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)
1552
+
1553
+ # query parameters
1554
+ query_params = {}
1555
+ query_params[:'externalConfig'] = external_config
1556
+ query_params[:'jwt'] = jwt
1557
+
1558
+ # header parameters
1559
+ header_params = {}
1560
+ # HTTP header 'Accept' (if needed)
1561
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1562
+ # HTTP header 'Content-Type'
1563
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1564
+
1565
+ # form parameters
1566
+ form_params = {}
1567
+
1568
+ # http body (model)
1569
+ post_body = nil
1570
+ auth_names = []
1571
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1572
+ :header_params => header_params,
1573
+ :query_params => query_params,
1574
+ :form_params => form_params,
1575
+ :body => post_body,
1576
+ :auth_names => auth_names)
1577
+ if @api_client.config.debugging
1578
+ @api_client.config.logger.debug "API called: DispatchApi#get_lti13_dispatch_launch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1579
+ end
1580
+ return data, status_code, headers
1581
+ end
1582
+
1583
+ # Get the information needed to configure a LTI 1.3 platform with the destination id `destinationId`
1584
+ # @param destination_id Identifier for the destination
1585
+ # @param [Hash] opts the optional parameters
1586
+ # @return [Lti13ToolConfigurationSchema]
1587
+ def get_lti13_tool_configuration_schema(destination_id, opts = {})
1588
+ data, _status_code, _headers = get_lti13_tool_configuration_schema_with_http_info(destination_id, opts)
1589
+ data
1590
+ end
1591
+
1592
+ # Get the information needed to configure a LTI 1.3 platform with the destination id &#x60;destinationId&#x60;
1593
+ # @param destination_id Identifier for the destination
1594
+ # @param [Hash] opts the optional parameters
1595
+ # @return [Array<(Lti13ToolConfigurationSchema, Fixnum, Hash)>] Lti13ToolConfigurationSchema data, response status code and response headers
1596
+ def get_lti13_tool_configuration_schema_with_http_info(destination_id, opts = {})
1597
+ if @api_client.config.debugging
1598
+ @api_client.config.logger.debug 'Calling API: DispatchApi.get_lti13_tool_configuration_schema ...'
1599
+ end
1600
+ # verify the required parameter 'destination_id' is set
1601
+ if destination_id.nil?
1602
+ fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_lti13_tool_configuration_schema"
1603
+ end
1604
+ # resource path
1605
+ local_var_path = '/dispatch/destinations/{destinationId}/lti13'.sub('{' + 'destinationId' + '}', destination_id.to_s)
1606
+
1607
+ # query parameters
1608
+ query_params = {}
1609
+
1610
+ # header parameters
1611
+ header_params = {}
1612
+ # HTTP header 'Accept' (if needed)
1613
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1614
+ # HTTP header 'Content-Type'
1615
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1616
+
1617
+ # form parameters
1618
+ form_params = {}
1619
+
1620
+ # http body (model)
1621
+ post_body = nil
1622
+ auth_names = ['APP_NORMAL', 'OAUTH']
1623
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1624
+ :header_params => header_params,
1625
+ :query_params => query_params,
1626
+ :form_params => form_params,
1627
+ :body => post_body,
1628
+ :auth_names => auth_names,
1629
+ :return_type => 'Lti13ToolConfigurationSchema')
1630
+ if @api_client.config.debugging
1631
+ @api_client.config.logger.debug "API called: DispatchApi#get_lti13_tool_configuration_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1632
+ end
1633
+ return data, status_code, headers
1634
+ end
1635
+
1425
1636
  # Get the information necessary to launch this dispatch using the IMS LTI 1.1 specification.
1637
+ # Retrieve the information needed to launch this dispatch using the IMS LTI 1.1 specification. This information is then provided to the platform so it can launch this dispatch.
1426
1638
  # @param dispatch_id Identifier for the dispatch
1427
1639
  # @param [Hash] opts the optional parameters
1428
1640
  # @return [DispatchLtiInfoSchema]
@@ -1432,6 +1644,7 @@ module RusticiSoftwareCloudV2
1432
1644
  end
1433
1645
 
1434
1646
  # Get the information necessary to launch this dispatch using the IMS LTI 1.1 specification.
1647
+ # Retrieve the information needed to launch this dispatch using the IMS LTI 1.1 specification. This information is then provided to the platform so it can launch this dispatch.
1435
1648
  # @param dispatch_id Identifier for the dispatch
1436
1649
  # @param [Hash] opts the optional parameters
1437
1650
  # @return [Array<(DispatchLtiInfoSchema, Fixnum, Hash)>] DispatchLtiInfoSchema data, response status code and response headers
@@ -1474,6 +1687,7 @@ module RusticiSoftwareCloudV2
1474
1687
  end
1475
1688
  return data, status_code, headers
1476
1689
  end
1690
+
1477
1691
  # Add tags to a Destination
1478
1692
  # Applies the provided tags to the destination. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDestinations).
1479
1693
  # @param destination_id Identifier for the destination
@@ -1533,6 +1747,7 @@ module RusticiSoftwareCloudV2
1533
1747
  end
1534
1748
  return data, status_code, headers
1535
1749
  end
1750
+
1536
1751
  # Add a group of tags to a group of Destinations
1537
1752
  # Applies all of the provided tags on all of the provided destinations. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDestinations).
1538
1753
  # @param batch Array of ids, and array of tags for bulk tag operations
@@ -1586,6 +1801,7 @@ module RusticiSoftwareCloudV2
1586
1801
  end
1587
1802
  return data, status_code, headers
1588
1803
  end
1804
+
1589
1805
  # Add tags to a Dispatch
1590
1806
  # Applies the provided tags to the dispatch. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDispatches).
1591
1807
  # @param dispatch_id Identifier for the dispatch
@@ -1645,6 +1861,7 @@ module RusticiSoftwareCloudV2
1645
1861
  end
1646
1862
  return data, status_code, headers
1647
1863
  end
1864
+
1648
1865
  # Add a group of tags to a group of Dispatches
1649
1866
  # Applies all of the provided tags on all of the provided dispatches. Tags are used to easily identify resources. Adding tags can enable more refined searches when making calls to certain endpoints (e.g. GetDispatches).
1650
1867
  # @param batch Array of ids, and array of tags for bulk tag operations
@@ -1698,6 +1915,7 @@ module RusticiSoftwareCloudV2
1698
1915
  end
1699
1916
  return data, status_code, headers
1700
1917
  end
1918
+
1701
1919
  # Reset registration counts for a Destination's Dispatches
1702
1920
  # Clears the registration count for all dispatches distributed to the destination. This resets the registration counter on the dispatch itself, but has no effect on the existing registrations. Can be used in situations where the license for the course material has been renewed.
1703
1921
  # @param destination_id Identifier for the destination
@@ -1751,6 +1969,7 @@ module RusticiSoftwareCloudV2
1751
1969
  end
1752
1970
  return data, status_code, headers
1753
1971
  end
1972
+
1754
1973
  # Reset registration count for a Dispatch
1755
1974
  # Clears the registration count for the dispatch. This resets the registration counter on the dispatch itself, but has no effect on the existing registrations. Can be used in situations where the license for the course material has been renewed.
1756
1975
  # @param dispatch_id Identifier for the dispatch
@@ -1804,8 +2023,9 @@ module RusticiSoftwareCloudV2
1804
2023
  end
1805
2024
  return data, status_code, headers
1806
2025
  end
2026
+
1807
2027
  # Create or update a Destination
1808
- # Creates or updates information about the destination. -If the destination is being created, a name should be provided in the DestinationSchema. If one is not present in the request an error will be thrown. -If the destination is instead being updated, only non-null values that are provided will be updated. You may also optionally supply the e-mail address of the user to be associated with this destination. This e-mail address should correspond to a SCORM Cloud user account.
2028
+ # Creates or updates information about the destination. -If the destination is being created, a name should be provided in the DestinationSchema. If one is not present in the request an error will be thrown. -If the destination is instead being updated, only non-null values that are provided will be updated. You may also optionally supply the e-mail address of the user to be associated with this destination. This e-mail address should correspond to a SCORM Cloud user account. >**Note:** >While the \"updated\" and \"created\" values are present in the destination schema, any attempts to manually change those values with SetDestination will be ignored.
1809
2029
  # @param destination_id Identifier for the destination
1810
2030
  # @param destination
1811
2031
  # @param [Hash] opts the optional parameters
@@ -1816,7 +2036,7 @@ module RusticiSoftwareCloudV2
1816
2036
  end
1817
2037
 
1818
2038
  # Create or update a Destination
1819
- # Creates or updates information about the destination. -If the destination is being created, a name should be provided in the DestinationSchema. If one is not present in the request an error will be thrown. -If the destination is instead being updated, only non-null values that are provided will be updated. You may also optionally supply the e-mail address of the user to be associated with this destination. This e-mail address should correspond to a SCORM Cloud user account.
2039
+ # Creates or updates information about the destination. -If the destination is being created, a name should be provided in the DestinationSchema. If one is not present in the request an error will be thrown. -If the destination is instead being updated, only non-null values that are provided will be updated. You may also optionally supply the e-mail address of the user to be associated with this destination. This e-mail address should correspond to a SCORM Cloud user account. &gt;**Note:** &gt;While the \&quot;updated\&quot; and \&quot;created\&quot; values are present in the destination schema, any attempts to manually change those values with SetDestination will be ignored.
1820
2040
  # @param destination_id Identifier for the destination
1821
2041
  # @param destination
1822
2042
  # @param [Hash] opts the optional parameters
@@ -1863,6 +2083,7 @@ module RusticiSoftwareCloudV2
1863
2083
  end
1864
2084
  return data, status_code, headers
1865
2085
  end
2086
+
1866
2087
  # Update enabled status for a Destination's Dispatches
1867
2088
  # Updates the enabled status for all dispatches distributed to the destination. This is an access control measure allowing you to turn access to a previously distributed dispatch packages on or off.
1868
2089
  # @param destination_id Identifier for the destination
@@ -1922,6 +2143,7 @@ module RusticiSoftwareCloudV2
1922
2143
  end
1923
2144
  return data, status_code, headers
1924
2145
  end
2146
+
1925
2147
  # Update enabled status for a Dispatch
1926
2148
  # Updates the enabled status for the dispatch. This is an access control measure allowing you to turn access to a previously distributed dispatch packages on or off.
1927
2149
  # @param dispatch_id Identifier for the dispatch
@@ -1981,6 +2203,7 @@ module RusticiSoftwareCloudV2
1981
2203
  end
1982
2204
  return data, status_code, headers
1983
2205
  end
2206
+
1984
2207
  # Update user PII hashing status for a Destination
1985
2208
  # Updates user PII hashing status for the destination. Enabling it will cause all user PII to be hashed. Hashing PII will anonymize the learner data from the dispatched course. This will make looking up specific details about a learner difficult.
1986
2209
  # @param destination_id Identifier for the destination
@@ -2040,6 +2263,7 @@ module RusticiSoftwareCloudV2
2040
2263
  end
2041
2264
  return data, status_code, headers
2042
2265
  end
2266
+
2043
2267
  # Update information about a Dispatch
2044
2268
  # Updates information about the dispatch, such as the expiration date and registration cap. Only non-null values that are provided will be updated.
2045
2269
  # @param dispatch_id Identifier for the dispatch
@@ -2099,6 +2323,7 @@ module RusticiSoftwareCloudV2
2099
2323
  end
2100
2324
  return data, status_code, headers
2101
2325
  end
2326
+
2102
2327
  # Update user PII hashing status for a Dispatch
2103
2328
  # Updates user PII hashing status for the dispatch. Enabling it will cause all user PII to be hashed. Hashing PII will anonymize the learner data from the dispatched course. This will make looking up specific details about a learner difficult.
2104
2329
  # @param dispatch_id Identifier for the dispatch
@@ -2158,6 +2383,7 @@ module RusticiSoftwareCloudV2
2158
2383
  end
2159
2384
  return data, status_code, headers
2160
2385
  end
2386
+
2161
2387
  # Update a group of Dispatches
2162
2388
  # Updates information about a group of dispatches, such as registration cap, expiration date, and postback information. Can be filtered using the request parameters to provide a subset of results. >**Note:** >One of the filter parameters (i.e. `courseId`, `since`/`until`, `tags`, or `filter`) needs to be provided. This is to prevent accidental modification of all dispatches. If you do wish to update all dispatches, try setting the since parameter to a value prior to the creation of any dispatches. >**Info:** >If using one of our client libraries, refer to its README for additional information on how to work with the `X-Total-Count` header.
2163
2389
  # @param dispatch_properties